source: branches/win64/lib/misc.lisp @ 8728

Last change on this file since 8728 was 8728, checked in by gb, 13 years ago

Will need some way to determine MACHINE-VERSION on windows ...

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 30.4 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 1994-2001 Digitool, Inc
4;;;   This file is part of OpenMCL. 
5;;;
6;;;   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with OpenMCL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with OpenMCL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   OpenMCL is referenced in the preamble as the "LIBRARY."
13;;;
14;;;   The LLGPL is also available online at
15;;;   http://opensource.franz.com/preamble.html
16
17(in-package "CCL")
18
19(eval-when (eval compile)
20  (require 'defstruct-macros))
21
22(defun short-site-name  ()
23  "Return a string with the abbreviated site name, or NIL if not known."
24  (or *short-site-name* "unspecified"))
25
26(defun long-site-name   ()
27  "Return a string with the long form of the site name, or NIL if not known."
28  (or *long-site-name* "unspecified"))
29
30(defun machine-instance ()
31  "Return a string giving the name of the local machine."
32  (%uname 1))
33
34
35(defun machine-type ()
36  "Returns a string describing the type of the local machine."
37  (%uname 4))
38
39
40
41(defloadvar *machine-version* nil)
42
43(defun machine-version ()
44  "Return a string describing the version of the computer hardware we
45are running on, or NIL if we can't find any useful information."
46  (or *machine-version*
47      (setq *machine-version*
48            #+darwin-target
49            (block darwin-machine-version
50              (%stack-block ((mib 8))
51                (setf (%get-long mib 0) #$CTL_HW
52                      (%get-long mib 4) #$HW_MODEL)
53                (%stack-block ((res 256)
54                               (reslen target::node-size))
55                  (setf (%get-byte res 0) 0
56                        (%get-natural reslen 0) 256)
57                  (if (zerop (#_sysctl mib 2 res reslen (%null-ptr) 0))
58                    (return-from darwin-machine-version (%get-cstring res))))))
59            #+linux-target
60            (with-open-file (f "/proc/cpuinfo" :if-does-not-exist nil)
61              (when f
62                (flet ((cpu-info-match (target line)
63                         (let* ((targetlen (length target))
64                                (linelen (length line)))
65                           (if (and (> linelen targetlen)
66                                    (string= target line
67                                             :end2 targetlen))
68                           (let* ((colonpos (position #\: line)))
69                             (when colonpos
70                               (string-trim " "
71                                            (subseq line (1+ colonpos)))))))))
72                  (do* ((line (read-line f nil nil)
73                              (read-line f nil nil))
74                        (target #+ppc-target "machine"
75                                #+x86-target "model name"))
76                       ((null line))
77                    (let* ((matched (cpu-info-match target line)))
78                      (when matched (return matched)))))))
79            #+freebsd-target
80            (%stack-block ((ret 512)
81                           (mib (* (record-length :uint))))
82              (setf (%get-unsigned-long mib 0)
83                    #$CTL_HW
84                    (%get-unsigned-long mib (record-length :uint))
85                    #$HW_MODEL)
86              (rlet ((oldsize :uint 512))
87                (if (eql 0 (#_sysctl mib 2 ret oldsize (%null-ptr) 0))
88                  (%get-cstring ret)
89                  1)))
90            #+windows-target
91            "fix this"
92            )))
93
94
95(defun software-type ()
96  "Return a string describing the supporting software."
97  (%uname 0))
98
99
100(defun software-version ()
101  "Return a string describing version of the supporting software, or NIL
102   if not available."
103  (%uname 2))
104
105
106
107
108
109
110
111;;; Yawn.
112
113
114
115(defmethod documentation (thing doc-id)
116  (%get-documentation thing doc-id))
117
118(defun set-documentation (thing doc-id new)
119  (setf (documentation thing doc-id) new))
120
121(defmethod (setf documentation) (new thing doc-id)
122  (%put-documentation thing doc-id new))
123
124
125(defmethod documentation ((symbol symbol) (doc-type (eql 'function)))
126  (let* ((def (fboundp symbol)))        ; FBOUNDP returns info about definition
127    (when def
128      (%get-documentation def t))))
129
130(defmethod (setf documentation) ((new t)
131                                 (symbol symbol)
132                                 (doc-type (eql 'function)))
133  (let* ((def (fboundp symbol)))        ; FBOUNDP returns info about definition
134    (when def
135      (%put-documentation def
136                          t
137                          new))
138    new))
139
140(defmethod documentation ((symbol symbol) (doc-type (eql 'setf)))
141  (call-next-method))
142
143(defmethod (setf documentation) ((new t)
144                                 (symbol symbol)
145                                 (doc-type (eql 'setf)))
146  (call-next-method))
147
148
149(defmethod documentation ((symbol symbol) (doc-type (eql 'variable)))
150  (call-next-method))
151
152(defmethod (setf documentation) ((new t)
153                                 (symbol symbol)
154                                 (doc-type (eql 'variable)))
155  (call-next-method))
156
157(defmethod documentation ((symbol symbol) (doc-type (eql 'compiler-macro)))
158  (call-next-method))
159
160(defmethod (setf documentation) ((new t)
161                                 (symbol symbol)
162                                 (doc-type (eql 'compiler-macro)))
163  (call-next-method))
164
165(defmethod documentation ((symbol symbol) (doc-type (eql 'type)))
166  (let* ((class (find-class symbol nil)))
167    (if class
168      (documentation class doc-type)
169      (call-next-method))))
170
171(defmethod (setf documentation) (new (symbol symbol) (doc-type (eql 'type)))
172  (let* ((class (find-class symbol nil)))
173    (if class
174      (setf (documentation class doc-type) new)
175      (call-next-method))))
176
177(defmethod documentation ((symbol symbol) (doc-type (eql 'method-combination)))
178  (let* ((mci (method-combination-info symbol)))
179    (if mci
180      (documentation mci doc-type))))
181
182(defmethod (setf documentation) ((new t)
183                                 (symbol symbol)
184                                 (doc-type (eql 'method-combination)))
185  (let* ((mci (method-combination-info symbol)))
186    (if mci
187      (setf (documentation mci doc-type) new))))
188
189
190(defmethod documentation ((symbol symbol) (doc-type (eql 'structure)))
191  (let* ((class (find-class symbol nil)))
192    (if (typep class 'structure-class)
193      (documentation class 'type)
194      (call-next-method))))
195
196(defmethod (setf documentation) ((new t)
197                                 (symbol symbol)
198                                 (doc-type (eql 'structure)))
199  (let* ((class (find-class symbol nil)))
200    (if (typep class 'structure-class)
201      (setf (documentation class 'type) new)
202      (call-next-method))))
203
204(defmethod documentation ((p package) (doc-type (eql 't)))
205  (call-next-method))
206
207(defmethod (setf documentation) ((new t) (p package) (doc-type (eql 't)))
208  (call-next-method))
209
210(defmethod documentation ((f function) (doc-type (eql 't)))
211  (call-next-method))
212
213(defmethod (setf documentation) ((new t) (f function) (doc-type (eql 't)))
214  (call-next-method))
215
216(defmethod documentation ((f function) (doc-type (eql 'function)))
217  (documentation f t))
218
219(defmethod (setf documentation) ((new t)
220                                 (f function)
221                                 (doc-type (eql 'function)))
222  (setf (documentation f t) new))
223
224(defmethod documentation ((l cons) (doc-type (eql 'function)))
225  (let* ((name (setf-function-spec-name l)))
226    (if name
227      (documentation name doc-type)
228      (%get-documentation l doc-type))))
229
230(defmethod (setf documentation) ((new t) (l cons) (doc-type (eql 'function)))
231  (let* ((name  (setf-function-spec-name l)))
232    (if name
233      (setf (documentation name doc-type) new)
234      (%put-documentation l doc-type new))))
235
236
237(defmethod documentation ((l cons) (doc-type (eql 'compiler-macro)))
238  (let* ((name (setf-function-spec-name l)))
239    (if name
240      (documentation name doc-type)
241      (%get-documentation l doc-type))))
242
243(defmethod (setf documentation) ((new t) (l cons) (doc-type (eql 'compiler-macr0)))
244  (let* ((name (setf-function-spec-name l)))
245    (if name
246      (setf (documentation name doc-type) new)
247      (%put-documentation l doc-type new))))
248
249
250(defmethod documentation ((m method-combination)
251                          (doc-type (eql 'method-combination)))
252  (call-next-method))
253
254(defmethod (setf documentation) ((new t)
255                                 (m method-combination)
256                                 (doc-type (eql 'method-combination)))
257  (call-next-method))
258
259(defmethod documentation ((m method-combination)
260                          (doc-type (eql t)))
261  (documentation m 'method-combination))
262
263(defmethod (setf documentation) ((new t)
264                                 (m method-combination)
265                                 (doc-type (eql t)))
266  (setf (documentation m 'method-combination) new))
267
268(defmethod documentation ((m standard-method)
269                          (doc-type (eql t)))
270  (call-next-method))
271
272(defmethod (setf documentation) ((new t)
273                                 (m standard-method)
274                                 (doc-type (eql t)))
275  (call-next-method))
276
277(defmethod documentation ((c standard-class) (doc-type (eql 'type)))
278  (call-next-method))
279
280(defmethod (setf documentation) ((new t)
281                                 (c standard-class)
282                                 (doc-type (eql 'type)))
283  (call-next-method))
284
285(defmethod documentation ((c standard-class) (doc-type (eql 't)))
286  (documentation c 'type))
287
288(defmethod (setf documentation) ((new t)
289                                 (c standard-class)
290                                 (doc-type (eql 't)))
291  (setf (documentation c 'type) new))
292
293(defmethod documentation ((c structure-class) (doc-type (eql 'type)))
294  (call-next-method))
295
296(defmethod (setf documentation) ((new t)
297                                 (c structure-class)
298                                 (doc-type (eql 'type)))
299  (call-next-method))
300
301(defmethod documentation ((c structure-class) (doc-type (eql 't)))
302  (documentation c 'type))
303
304(defmethod (setf documentation) ((new t)
305                                 (c structure-class)
306                                 (doc-type (eql 't)))
307  (setf (documentation c 'type) new))
308
309;;; This is now deprecated; things which call it should stop doing so.
310(defun set-documentation (symbol doc-type string)
311  (setf (documentation symbol doc-type) string))
312
313(defun set-function-info (symbol info)
314  (let* ((doc-string (if (consp info) (car info) info)))
315    (if (and *save-doc-strings* (stringp doc-string))
316      (set-documentation  symbol 'function doc-string)))
317  (let* ((cons (assq symbol *nx-globally-inline*))
318         (lambda-expression (if (consp info) (cdr info))))
319    (if (and (proclaimed-inline-p symbol)
320             (not (compiler-special-form-p symbol))
321             (lambda-expression-p lambda-expression)
322             (let* ((lambda-list (cadr lambda-expression)))
323               (and (not (memq '&lap lambda-list))
324                    (not (memq '&method lambda-list))
325                    (not (memq '&lexpr lambda-list)))))
326      (if cons 
327        (%rplacd cons lambda-expression)
328        (push (cons symbol lambda-expression) *nx-globally-inline*))
329      (if cons (setq *nx-globally-inline* (delete cons *nx-globally-inline*)))))
330  symbol)
331
332
333(setf (documentation 'if 'function)
334      "If Predicate Then [Else]
335  If Predicate evaluates to non-null, evaluate Then and returns its values,
336  otherwise evaluate Else and return its values. Else defaults to NIL.")
337
338(setf (documentation 'progn 'function)
339      "progn form*
340  Evaluates each FORM and returns the value(s) of the last FORM.")
341
342(defmethod documentation ((thing character-encoding) (doc-type (eql t)))
343  (character-encoding-documentation thing))
344
345(defmethod (setf documentation) (new (thing character-encoding) (doc-type (eql t)))
346  (check-type new (or null string))
347  (setf (character-encoding-documentation thing) new))
348
349(defmethod documentation ((thing symbol) (doc-type (eql 'character-encoding)))
350  (let* ((encoding (lookup-character-encoding (intern (string thing) :keyword))))
351    (when encoding
352      (documentation encoding t))))
353
354                                 
355
356
357#|
358(setf (documentation 'car 'variable) "Preferred brand of automobile")
359(documentation 'car 'variable)
360(setf (documentation 'foo 'structure) "the structure is grand.")
361(documentation 'foo 'structure)
362(setf (documentation 'foo 'variable) "the metasyntactic remarker")
363(documentation 'foo 'variable)
364(setf (documentation 'foo 'obscure) "no one really knows what it means")
365(documentation 'foo 'obscure)
366(setf (documentation 'foo 'structure) "the structure is solid")
367(documentation 'foo 'function)
368||#
369
370;;
371
372(defparameter *report-time-function* nil
373  "If non-NULL, should be a function which accepts the following
374   keyword arguments:
375   :FORM              the form that was executed
376   :RESULTS           a list of all values returned by the execution of FORM
377   :ELAPSED-TIME      total elapsed (real) time, in internal-time-units-per-second
378   :USER-TIME         elapsed user time, in internal-time-units-per-second
379   :SYSTEM-TIME       elapsed system time, in internal-time-units-per-second
380   :GC-TIME           total real time spent in the GC, in internal-time-units-per-second
381   :BYTES-ALLOCATED   total bytes allocated
382   :MINOR-PAGE-FAULTS minor page faults
383   :MAJOR-PAGE-FAULTS major page faults
384   :SWAPS             swaps")
385
386
387(defun standard-report-time (&key form results elapsed-time user-time
388                                  system-time gc-time bytes-allocated
389                                  minor-page-faults major-page-faults
390                                  swaps)
391  (let* ((s *trace-output*)
392         (units
393          (ecase internal-time-units-per-second
394            (1000000 "microseconds")
395            (1000  "milliseconds")))
396         (width
397          (ecase internal-time-units-per-second
398            (1000000 6)
399            (1000  3)))
400         (cpu-count (cpu-count)))
401    (format s "~&~S took ~:D ~a (~,vF seconds) to run ~%~20twith ~D available CPU core~P."
402            form elapsed-time units width (/ elapsed-time internal-time-units-per-second) cpu-count cpu-count)
403    (format s "~&During that period, ~:D ~a (~,vF seconds) were spent in user mode" user-time units width (/ user-time internal-time-units-per-second))
404    (format s "~&                    ~:D ~a (~,vF seconds) were spent in system mode" system-time units width(/ system-time internal-time-units-per-second))
405    (unless (eql gc-time 0)
406      (format s
407              "~%~:D ~a (~,vF seconds) was spent in GC."
408              gc-time units width (/ gc-time internal-time-units-per-second)))
409    (unless (eql 0 bytes-allocated)
410      (format s "~% ~:D bytes of memory allocated." bytes-allocated))
411    (when (or (> minor-page-faults 0)
412              (> major-page-faults 0)
413              (> swaps 0))
414      (format s
415              "~% ~:D minor page faults, ~:D major page faults, ~:D swaps."
416              minor-page-faults major-page-faults swaps))
417    (format s "~&")
418    (values-list results)))
419
420(defun report-time (form thunk)
421  (flet ((integer-size-in-bytes (i)
422           (if (typep i 'fixnum)
423             0
424             (* (logand (+ 2 (uvsize i)) (lognot 1)) 4))))
425    (rlet ((start :rusage)
426           (stop :rusage)
427           (timediff :timeval))
428      (let* ((initial-real-time (get-internal-real-time))
429             (initial-gc-time (gctime))
430             (initial-consed (total-bytes-allocated))           
431             (initial-overhead (integer-size-in-bytes initial-consed)))
432        (%%rusage start)
433        (let* ((results (multiple-value-list (funcall thunk))))
434          (declare (dynamic-extent results))
435          (%%rusage stop)         
436          (let* ((new-consed (total-bytes-allocated))               
437                 (bytes-consed
438                  (- new-consed (+ initial-overhead initial-consed)))
439                 (elapsed-real-time
440                  (- (get-internal-real-time) initial-real-time))
441                 (elapsed-gc-time (- (gctime) initial-gc-time))
442                 (elapsed-user-time
443                  (progn
444                    (%sub-timevals timediff
445                                   (pref stop :rusage.ru_utime)
446                                   (pref start :rusage.ru_utime))
447                    (ecase internal-time-units-per-second
448                      (1000000 (timeval->microseconds timediff))
449                      (1000 (timeval->milliseconds timediff)))))
450                 (elapsed-system-time
451                  (progn
452                    (%sub-timevals timediff
453                                   (pref stop :rusage.ru_stime)
454                                   (pref start :rusage.ru_stime))
455                    (ecase internal-time-units-per-second
456                      (1000000 (timeval->microseconds timediff))
457                      (1000 (timeval->milliseconds timediff)))))
458                 (elapsed-minor (- (pref stop :rusage.ru_minflt)
459                                   (pref start :rusage.ru_minflt)))
460                 (elapsed-major (- (pref stop :rusage.ru_majflt)
461                                   (pref start :rusage.ru_majflt)))
462                 (elapsed-swaps (- (pref stop :rusage.ru_nswap)
463                                   (pref start :rusage.ru_nswap))))
464            (funcall (or *report-time-function*
465                         #'standard-report-time)
466                     :form form
467                     :results results
468                     :elapsed-time elapsed-real-time
469                     :user-time elapsed-user-time
470                     :system-time elapsed-system-time
471                     :gc-time elapsed-gc-time
472                     :bytes-allocated bytes-consed
473                     :minor-page-faults elapsed-minor
474                     :major-page-faults elapsed-major
475                     :swaps elapsed-swaps)))))))
476
477
478
479
480;;; site names and machine-instance is in the init file.
481
482(defun add-feature (symbol)
483  "Not CL but should be."
484  (if (symbolp symbol)
485      (if (not (memq symbol *features*))
486          (setq *features* (cons symbol *features*)))))
487
488;;; (dotimes (i 5000) (declare (fixnum i)) (add-feature 'junk))
489
490
491
492
493;;; Misc string functions
494
495
496(defun string-left-trim (char-bag string &aux end)
497  "Given a set of characters (a list or string) and a string, returns
498  a copy of the string with the characters in the set removed from the
499  left end."
500  (setq string (string string))
501  (setq end (length string))
502  (do ((index 0 (%i+ index 1)))
503      ((or (eq index end) (not (find (aref string index) char-bag)))
504       (subseq string index end))))
505
506(defun string-right-trim (char-bag string &aux end)
507  "Given a set of characters (a list or string) and a string, returns
508  a copy of the string with the characters in the set removed from the
509  right end."
510  (setq string (string string))
511  (setq end (length string))
512  (do ((index (%i- end 1) (%i- index 1)))
513      ((or (%i< index 0) (not (find (aref string index) char-bag)))
514       (subseq string 0 (%i+ index 1)))))
515
516(defun string-trim (char-bag string &aux end)
517  "Given a set of characters (a list or string) and a string, returns a
518  copy of the string with the characters in the set removed from both
519  ends."
520  (setq string (string string))
521  (setq end (length string))
522  (let ((left-end) (right-end))
523     (do ((index 0 (%i+ index 1)))
524         ((or (eq index end) (not (find (aref string index) char-bag)))
525          (setq left-end index)))
526     (do ((index (%i- end 1) (%i- index 1)))
527         ((or (%i< index left-end) (not (find (aref string index) char-bag)))
528          (setq right-end index)))
529      (subseq string left-end (%i+ right-end 1))))
530
531
532
533(defun copy-symbol (symbol &optional (copy-props nil) &aux new-symbol def)
534  "Make and return a new uninterned symbol with the same print name
535  as SYMBOL. If COPY-PROPS is false, the new symbol is neither bound
536  nor fbound and has no properties, else it has a copy of SYMBOL's
537  function, value and property list."
538  (setq new-symbol (make-symbol (symbol-name symbol)))
539  (when copy-props
540      (when (boundp symbol)
541            (set new-symbol (symbol-value symbol)))
542      (when (setq def (fboundp symbol))
543            ;;;Shouldn't err out on macros/special forms.
544            (%fhave new-symbol def))
545      (set-symbol-plist new-symbol (copy-list (symbol-plist symbol))))
546  new-symbol)
547
548
549(defvar %gentemp-counter 0
550  "Counter for generating unique GENTEMP symbols.")
551
552(defun gentemp (&optional (prefix "T") (package *package*))
553  "Creates a new symbol interned in package PACKAGE with the given PREFIX."
554  (loop
555    (let* ((new-pname (%str-cat (ensure-simple-string prefix) 
556                                (%integer-to-string %gentemp-counter)))
557           (sym (find-symbol new-pname package)))
558      (if sym
559        (setq %gentemp-counter (%i+ %gentemp-counter 1))
560        (return (values (intern new-pname package))))))) ; 1 value.
561
562
563
564
565(defun add-gc-hook (hook-function &optional (which-hook :pre-gc))
566  (ecase which-hook
567    (:pre-gc
568     (pushnew hook-function *pre-gc-hook-list*)
569     (setq *pre-gc-hook* #'(lambda ()
570                             (dolist (hook *pre-gc-hook-list*)
571                               (funcall hook)))))
572    (:post-gc
573     (pushnew hook-function *post-gc-hook-list*)
574     (setq *post-gc-hook* #'(lambda ()
575                             (dolist (hook *post-gc-hook-list*)
576                               (funcall hook))))))
577  hook-function)
578
579(defun remove-gc-hook (hook-function &optional (which-hook :pre-gc))
580  (ecase which-hook
581    (:pre-gc
582     (unless (setq *pre-gc-hook-list* (delq hook-function *pre-gc-hook-list*))
583       (setq *pre-gc-hook* nil)))
584    (:post-gc
585     (unless (setq *post-gc-hook-list* (delq hook-function *post-gc-hook-list*))
586       (setq *post-gc-hook* nil)))))
587
588
589
590
591
592
593(defun find-method-by-names (name qualifiers specializers)
594  (let ((gf (fboundp name)))
595    (when gf
596      (if (not (standard-generic-function-p gf))
597        (error "~S is not a generic-function." gf)
598        (let ((methods (%gf-methods gf)))
599          (when methods
600            (let* ((spec-len (length (%method-specializers (car methods))))
601                   (new-specs (make-list spec-len :initial-element (find-class t))))
602              (declare (dynamic-extent new-specs))
603              (do ((specs specializers (cdr specs))
604                   (nspecs new-specs (cdr nspecs)))
605                  ((or (null specs) (null nspecs)))
606                (let ((s (car specs)))
607                  (rplaca nspecs (if (consp s) s (find-class s nil)))))
608              (find-method gf qualifiers new-specs nil))))))))
609
610
611
612(defun get-string-from-user (prompt)
613  (with-terminal-input
614      (format *query-io* "~&~a " prompt)
615    (force-output *query-io*)
616    (clear-input *query-io*)
617    (values (read-line *query-io*))))
618
619
620(defun select-item-from-list (list &key (window-title "Select one of the following")
621                                   (table-print-function #'prin1)
622                                   &allow-other-keys)
623  (block get-answer
624    (with-terminal-input
625      (format *query-io* "~a:~%" window-title)
626      (loop
627         (catch :redisplay
628           (do* ((l list (cdr l))
629                 (i 0 (1+ i))
630                 (item (car l) (car l)))
631                ((null l))
632             (declare (fixnum i))
633             (format *query-io* "~&  ~d: " i)
634             (funcall table-print-function item *query-io*))
635           (loop
636              (fresh-line *query-io*)
637              (let* ((string (get-string-from-user "Selection [number,q,r,?]:"))
638                     (value (ignore-errors
639                              (let* ((*package* *keyword-package*))
640                                (read-from-string string nil)))))
641                (cond ((eq value :q) (throw :cancel t))
642                      ((eq value :r) (throw :redisplay t))
643                      ((eq value :?) 
644                       (format *query-io* "~%Enter the number of the selection, ~%  r to redisplay, ~%  q to cancel or ~%  ? to show this message again."))
645                      ((and (typep value 'unsigned-byte)
646                            (< value (length list)))
647                       (return-from get-answer (list (nth value list))))))))))))
648
649;;; There should ideally be some way to override the UI (such as
650;;; it is ...) here.
651;;; More generally, this either
652;;;   a) shouldn't exist, or
653;;;   b) should do more sanity-checking
654(defun choose-file-dialog (&key file-types (prompt "File name:"))
655  (%choose-file-dialog t prompt file-types))
656
657(defun choose-new-file-dialog (&key prompt)
658  (%choose-file-dialog nil prompt nil))
659
660(defun %choose-file-dialog (must-exist prompt file-types)
661  (loop
662      (let* ((namestring (get-string-from-user prompt))
663             (pathname (ignore-errors (pathname namestring)))
664             (exists (and pathname (probe-file pathname))))
665        (when (and (if must-exist exists)
666                   (or (null file-types)
667                       (member (pathname-type pathname)
668                               file-types :test #'equal)))
669          (return pathname))
670        (if (not exists)
671          (format *query-io* "~&~s does not exist." namestring)
672          (format *query-io* "~&Type of ~s is not one of ~{~a~}"
673                  namestring file-types)))))
674
675(defparameter *overwrite-dialog-hook* nil)
676(defun overwrite-dialog (filename prompt)
677  (if *overwrite-dialog-hook*
678    (funcall *overwrite-dialog-hook* filename prompt)
679    t))
680
681;;; Might want to have some other entry for, e.g., the inspector
682;;; and to let it get its hands on the list header returned by
683;;; disassemble-ppc-function.  Maybe disassemble-ppc-function
684;;; should take care of "normalizing" the code-vector ?
685(defun disassemble (thing)
686  "Disassemble the compiled code associated with OBJECT, which can be a
687  function, a lambda expression, or a symbol with a function definition. If
688  it is not already compiled, the compiler is called to produce something to
689  disassemble."
690  (#+ppc-target ppc-xdisassemble
691   #+x8664-target x8664-xdisassemble
692   (require-type (function-for-disassembly thing) 'compiled-function)))
693
694(defun function-for-disassembly (thing)
695  (let* ((fun thing))
696    ;; CLHS says that DISASSEMBLE should signal a type error if its
697    ;; argument isn't a function designator.  Hard to imagine any
698    ;; code depending on that ...
699    ;;(when (typep fun 'standard-method) (setq fun (%method-function fun)))
700    (when (or (symbolp fun)
701              (and (consp fun) (neq (%car fun) 'lambda)))
702      (setq fun (fboundp thing))
703      (when (and (symbolp thing) (not (functionp fun)))
704        (setq fun (macro-function thing))))
705    (if (typep fun 'compiled-lexical-closure)
706        (setq fun (closure-function fun)))
707    (when (lambda-expression-p fun)
708      (setq fun (compile-named-function fun nil)))
709    fun))
710
711(%fhave 'df #'disassemble)
712
713(defun local-svn-revision ()
714  (or
715   ;; svn2cvs uses a .svnrev file to sync CVS and SVN; if present,
716   ;; it contains the svn revision in decimal.
717   (with-open-file (f "ccl:\\.svnrev" :direction :input :if-does-not-exist nil)
718     (when f (read f)))
719   (with-output-to-string (s)
720    (multiple-value-bind (status exit-code)
721        (external-process-status
722         (run-program "svnversion"  (list  (native-translated-namestring "ccl:") "/trunk/ccl"):output s))
723      (when (and (eq :exited status) (zerop exit-code))
724        (with-input-from-string (output (get-output-stream-string s))
725          (let* ((line (read-line output nil nil)))
726            (when (and line (parse-integer line :junk-allowed t) )
727              (return-from local-svn-revision line)))))))))
728
729
730;;; Scan the heap, collecting infomation on the primitive object types
731;;; found.  Report that information.
732
733(defun heap-utilization (&key (stream *debug-io*)
734                              (gc-first t))
735  (let* ((nconses 0)
736         (nvectors (make-array 256))
737         (vector-sizes (make-array 256))
738         (array-size-function (arch::target-array-data-size-function
739                               (backend-target-arch *host-backend*))))
740    (declare (type (simple-vector 256) nvectors vector-sizes)
741             (dynamic-extent nvectors vector-sizes))
742    (when gc-first (gc))
743    (%map-areas (lambda (thing)
744                  (if (consp thing)
745                    (incf nconses)
746                    (let* ((typecode (typecode thing)))
747                      (incf (aref nvectors typecode))
748                      (incf (aref vector-sizes typecode)
749                            (funcall array-size-function typecode (uvsize thing)))))))
750    (report-heap-utilization stream nconses nvectors vector-sizes)
751    (values)))
752
753(defvar *heap-utilization-vector-type-names*
754  (let* ((a (make-array 256)))
755    #+x8664-target
756    (dotimes (i 256)
757      (let* ((fulltag (logand i x8664::fulltagmask))
758             (names-vector
759              (cond ((= fulltag x8664::fulltag-nodeheader-0)
760                     *nodeheader-0-types*)
761                    ((= fulltag x8664::fulltag-nodeheader-1)
762                     *nodeheader-1-types*)
763                    ((= fulltag x8664::fulltag-immheader-0)
764                     *immheader-0-types*)
765                    ((= fulltag x8664::fulltag-immheader-1)
766                     *immheader-1-types*)
767                    ((= fulltag x8664::fulltag-immheader-2)
768                     *immheader-2-types*)))
769             (name (if names-vector
770                     (aref names-vector (ash i -4)))))
771        ;; Special-case a few things ...
772        (if (eq name 'symbol-vector)
773          (setq name 'symbol)
774          (if (eq name 'function-vector)
775            (setq name 'function)))
776        (setf (aref a i) name)))
777    #+ppc64-target
778    (dotimes (i 256)
779      (let* ((lowtag (logand i ppc64::lowtagmask)))
780        (setf (%svref a i)
781              (cond ((= lowtag ppc64::lowtag-immheader)
782                     (%svref *immheader-types* (ash i -2)))
783                    ((= lowtag ppc64::lowtag-nodeheader)
784                     (%svref *nodeheader-types* (ash i -2)))))))
785    #+ppc32-target
786    (dotimes (i 256)
787      (let* ((fulltag (logand i ppc32::fulltagmask)))
788        (setf (%svref a i)
789              (cond ((= fulltag ppc32::fulltag-immheader)
790                     (%svref *immheader-types* (ash i -3)))
791                    ((= fulltag ppc32::fulltag-nodeheader)
792                     (%svref *nodeheader-types* (ash i -3)))))))
793    a))
794
795 
796   
797(defun report-heap-utilization (out nconses nvectors vector-sizes)
798  (format out "~&Object type~42tCount~50tTotal Size in Bytes")
799  (format out "~&CONS~36t~12d~48t~16d" nconses (* nconses target::cons.size))
800  (dotimes (i (length nvectors))
801    (let* ((count (aref nvectors i))
802           (sizes (aref vector-sizes i)))
803      (unless (zerop count)
804        (format out "~&~a~36t~12d~48t~16d" (aref *heap-utilization-vector-type-names* i)  count sizes)))))
805                           
806;; The number of words to allocate for static conses when the user requests
807;; one and we don't have any left over
808(defparameter *static-cons-chunk* 1048576)
809
810(defun initialize-static-cons ()
811  "Activates collection of garbage conses in the static-conses
812   list and allocates initial static conses."
813  ; There might be a race here when multiple threads call this
814  ; function.  However, the discarded static conses will become
815  ; garbage and be added right back to the list.  No harm here
816  ; except for additional garbage collections.
817  (%set-kernel-global 'static-conses nil)
818  (allocate-static-conses))
819
820(defun allocate-static-conses ()
821  "Allocates some memory, freezes it and lets it become garbage.
822   This will add the memory to the list of free static conses."
823  (let ((l (make-array *static-cons-chunk*)))
824    (declare (ignore l))
825    (freeze))
826  (gc))
827
828(defun static-cons (car-value cdr-value)
829  "Allocates a cons cell that doesn't move on garbage collection,
830   and thus doesn't trigger re-hashing when used as a key in a hash
831   table.  Usage is equivalent to regular CONS."
832  (when (eq (%get-kernel-global 'static-conses) 0)
833    (initialize-static-cons))
834  (let ((cell (%atomic-pop-static-cons)))
835    (if cell
836      (progn
837        (setf (car cell) car-value)
838        (setf (cdr cell) cdr-value)
839        cell)
840      (progn
841        (allocate-static-conses)
842        (static-cons car-value cdr-value)))))
843       
844
845(defparameter *weak-gc-method-names*
846  '((:traditional . 0)
847    (:non-circular . 1)))
848
849
850(defun weak-gc-method ()
851  (or (car (rassoc (%get-kernel-global 'weak-gc-method)
852                   *weak-gc-method-names*))
853      :traditional))
854
855
856(defun (setf weak-gc-method) (name)
857  (setf (%get-kernel-global 'weak-gc-method)
858        (or (cdr (assoc name *weak-gc-method-names*))
859            0))
860  name)
Note: See TracBrowser for help on using the repository browser.