source: trunk/source/level-1/linux-files.lisp @ 8343

Last change on this file since 8343 was 8343, checked in by gz, 12 years ago

implement copy-file directly (rather than by run-program), add copy-file-attributes

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 53.5 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 (:compile-toplevel :execute)
20  #+linuxppc-target
21  (require "PPC-LINUX-SYSCALLS")
22  #+linuxx8664-target
23  (require "X8664-LINUX-SYSCALLS")
24  #+darwinppc-target
25  (require "DARWINPPC-SYSCALLS")
26  #+darwinx8664-target
27  (require "DARWINX8664-SYSCALLS")
28  #+(and freebsd-target x8664-target)
29  (require "X8664-FREEBSD-SYSCALLS")
30  )
31
32
33(defun get-foreign-namestring (pointer)
34  ;; On Darwin, foreign namestrings are encoded in UTF-8 and
35  ;; are canonically decomposed (NFD).  Use PRECOMPOSE-SIMPLE-STRING
36  ;; to ensure that the string is "precomposed" (NFC), like the
37  ;; rest of the world and most sane people would expect.
38  #+darwin-target
39  (precompose-simple-string (%get-utf-8-cstring pointer))
40  ;; On some other platforms, the namestring is assumed to
41  ;; be encoded according to the current locale's character
42  ;; encoding (though FreeBSD seems to be moving towards
43  ;; precomposed UTF-8.).
44  ;; In any case, the use if %GET-CSTRING here is wrong ...
45  #-darwin-target
46  (%get-cstring pointer))
47
48(defun nanoseconds (n)
49  (unless (and (typep n 'fixnum)
50               (>= (the fixnum n) 0))
51    (check-type n (real 0 #xffffffff)))
52  (multiple-value-bind (q r)
53      (floor n)
54    (if (zerop r)
55      (setq r 0)
56      (setq r (floor (* r 1000000000))))
57    (values q r)))
58
59(defun milliseconds (n)
60  (unless (and (typep n 'fixnum)
61               (>= (the fixnum n) 0))
62    (check-type n (real 0 #xffffffff)))
63  (multiple-value-bind (q r)
64      (floor n)
65    (if (zerop r)
66      (setq r 0)
67      (setq r (floor (* r 1000))))
68    (values q r)))
69
70(defun microseconds (n)
71  (unless (and (typep n 'fixnum)
72               (>= (the fixnum n) 0))
73    (check-type n (real 0 #xffffffff)))
74  (multiple-value-bind (q r)
75      (floor n)
76    (if (zerop r)
77      (setq r 0)
78      (setq r (floor (* r 1000000))))
79    (values q r)))
80
81(defun semaphore-value (s)
82  (if (istruct-typep s 'semaphore)
83    (semaphore.value s)
84    (semaphore-value (require-type s 'semaphore))))
85
86(defun %wait-on-semaphore-ptr (s seconds milliseconds &optional flag)
87  (if flag
88    (if (istruct-typep flag 'semaphore-notification)
89      (setf (semaphore-notification.status flag) nil)
90      (report-bad-arg flag 'semaphore-notification)))
91  (without-interrupts
92   (let* ((status (ff-call
93                   (%kernel-import target::kernel-import-wait-on-semaphore)
94                   :address s
95                   :unsigned seconds
96                   :unsigned milliseconds
97                   :signed))
98          (result (zerop status)))     
99     (declare (fixnum status))
100     (when flag (setf (semaphore-notification.status flag) result))
101     (values result status))))
102
103(defun %process-wait-on-semaphore-ptr (s seconds milliseconds &optional
104                                         (whostate "semaphore wait") flag)
105  (or (%wait-on-semaphore-ptr s 0 0 flag)
106      (with-process-whostate  (whostate)
107        (loop
108          (when (%wait-on-semaphore-ptr s seconds milliseconds flag)
109            (return))))))
110
111 
112(defun wait-on-semaphore (s &optional flag (whostate "semaphore wait"))
113  "Wait until the given semaphore has a positive count which can be
114atomically decremented."
115  (%process-wait-on-semaphore-ptr (semaphore-value s) #xffffff 0 whostate flag)
116  t)
117
118
119(defun %timed-wait-on-semaphore-ptr (semptr duration notification)
120  (or (%wait-on-semaphore-ptr semptr 0 0 notification)
121      (with-process-whostate ("Semaphore timed wait")
122        (multiple-value-bind (secs millis) (milliseconds duration)
123          (let* ((now (get-internal-real-time))
124                 (stop (+ now
125                          (* secs 1000)
126                          millis)))
127            (loop
128              (multiple-value-bind (success err)
129                  (progn
130                    (%wait-on-semaphore-ptr semptr secs millis notification))
131                (when success
132                  (return t))
133                (when (or (not (eql err #$EINTR))
134                          (>= (setq now (get-internal-real-time)) stop))
135                  (return nil))
136                (unless (zerop duration)
137                  (let* ((diff (- stop now)))
138                    (multiple-value-bind (remaining-seconds remaining-millis)
139                        (floor diff 1000)
140                      (setq secs remaining-seconds
141                            millis remaining-millis)))))))))))
142
143(defun timed-wait-on-semaphore (s duration &optional notification)
144  "Wait until the given semaphore has a postive count which can be
145atomically decremented, or until a timeout expires."
146  (%timed-wait-on-semaphore-ptr (semaphore-value s) duration notification))
147
148
149(defun %signal-semaphore-ptr (p)
150  (ff-call
151   (%kernel-import target::kernel-import-signal-semaphore)
152   :address p
153   :signed-fullword))
154
155(defun signal-semaphore (s)
156  "Atomically increment the count of a given semaphore."
157  (%signal-semaphore-ptr (semaphore-value s)))
158
159(defun %os-getcwd (buf bufsize)
160  ;; Return N < 0, if error
161  ;;        N < bufsize: success, string is of length n
162  ;;        N > bufsize: buffer needs to be larger.
163  (let* ((p (#_getcwd buf bufsize)))
164    (declare (dynamic-extent p))
165    (if (%null-ptr-p p)
166      (let* ((err (%get-errno)))
167        (if (eql err (- #$ERANGE))
168          (+ bufsize bufsize)
169          err))
170      (dotimes (i bufsize (+ bufsize bufsize))
171        (when (eql 0 (%get-byte buf i))
172          (return i))))))
173   
174   
175(defun current-directory-name ()
176  "Look up the current working directory of the OpenMCL process; unless
177it has been changed, this is the directory OpenMCL was started in."
178  (flet ((try-getting-dirname (bufsize)
179           (%stack-block ((buf bufsize))
180             (let* ((len (%os-getcwd buf bufsize)))
181               (cond ((< len 0) (%errno-disp len bufsize))
182                     ((< len bufsize)
183                      (setf (%get-unsigned-byte buf len) 0)
184                      (values (get-foreign-namestring buf) len))
185                     (t (values nil len)))))))
186    (do* ((string nil)
187          (len 64)
188          (bufsize len len))
189         ((multiple-value-setq (string len) (try-getting-dirname bufsize))
190          string))))
191
192
193(defun current-directory ()
194  (mac-default-directory))
195
196(defun (setf current-directory) (path)
197  (cwd path)
198  path)
199
200(defun cd (path)
201  (cwd path))
202
203(defmacro with-filename-cstrs (&rest rest)
204  `(#+darwin-target with-utf-8-cstrs #-darwin-target with-cstrs ,@rest))
205
206(defun %chdir (dirname)
207  (with-filename-cstrs ((dirname dirname))
208    (syscall syscalls::chdir dirname)))
209
210(defun %mkdir (name mode)
211  (let* ((name name)
212         (len (length name)))
213    (when (and (> len 0) (eql (char name (1- len)) #\/))
214      (setq name (subseq name 0 (1- len))))
215    (with-filename-cstrs ((name name))
216      (syscall syscalls::mkdir name mode))))
217
218(defun %rmdir (name)
219  (let* ((last (1- (length name))))
220    (with-filename-cstrs ((name name))
221      (when (and (>= last 0)
222                 (eql (%get-byte name last) (char-code #\/)))
223        (setf (%get-byte name last) 0))
224    (syscall syscalls::rmdir name))))
225
226
227(defun getenv (key)
228  "Look up the value of the environment variable named by name, in the
229OS environment."
230  (with-cstrs ((key (string key)))
231    (let* ((env-ptr (%null-ptr)))
232      (declare (dynamic-extent env-ptr))
233      (%setf-macptr env-ptr (#_getenv key))
234      (unless (%null-ptr-p env-ptr)
235        (%get-cstring env-ptr))))
236  )
237
238(defun setenv (key value &optional (overwrite t))
239  "Set the value of the environment variable named by name, in the OS
240environment. If there is no such environment variable, create it."
241  (with-cstrs ((ckey key)
242               (cvalue value))
243    (#_setenv ckey cvalue (if overwrite 1 0))))
244
245(defun setuid (uid)
246  "Attempt to change the current user ID (both real and effective);
247fails unless the OpenMCL process has super-user privileges or the ID
248given is that of the current user."
249  (syscall syscalls::setuid uid))
250
251(defun setgid (uid)
252  "Attempt to change the current group ID (both real and effective);
253fails unless the OpenMCL process has super-user privileges or the ID
254given is that of a group to which the current user belongs."
255  (syscall syscalls::setgid uid))
256 
257
258;;; On Linux, "stat" & friends are implemented in terms of deeper,
259;;; darker things that need to know what version of the stat buffer
260;;; they're talking about.
261
262(defun %stat-values (result stat)
263  (if (eql 0 (the fixnum result)) 
264      (values
265       t
266       (pref stat :stat.st_mode)
267       (pref stat :stat.st_size)
268       #+linux-target
269       (pref stat :stat.st_mtim.tv_sec)
270       #-linux-target
271       (pref stat :stat.st_mtimespec.tv_sec)
272       (pref stat :stat.st_ino)
273       (pref stat :stat.st_uid)
274       (pref stat :stat.st_blksize)
275       #+linux-target
276       (pref stat :stat.st_mtim.tv_usec)
277       #-linux-target
278       (round (pref stat :stat.st_mtimespec.tv_nsec) 1000)
279       (pref stat :stat.st_gid))
280      (values nil nil nil nil nil nil nil)))
281
282
283(defun %%stat (name stat)
284  (with-filename-cstrs ((cname name))
285    (%stat-values
286     #+linux-target
287     (#_ __xstat #$_STAT_VER_LINUX cname stat)
288     #-linux-target
289     (syscall syscalls::stat cname stat)
290     stat)))
291
292(defun %%fstat (fd stat)
293  (%stat-values
294   #+linux-target
295   (#_ __fxstat #$_STAT_VER_LINUX fd stat)
296   #-linux-target
297   (syscall syscalls::fstat fd stat)
298   stat))
299
300(defun %%lstat (name stat)
301  (with-filename-cstrs ((cname name))
302    (%stat-values
303     #+linux-target
304     (#_ __lxstat #$_STAT_VER_LINUX cname stat)
305     #-linux-target
306     (syscall syscalls::lstat cname stat)
307     stat)))
308
309
310;;; Returns: (values t mode size mtime inode uid blksize) on success,
311;;;          (values nil nil nil nil nil nil nil) otherwise
312;;; NAME should be a "native namestring", e.g,, have all lisp pathname
313;;; escaping removed.
314(defun %stat (name &optional link-p)
315  (rlet ((stat :stat))
316    (if link-p
317      (%%lstat name stat)
318      (%%stat name stat))))
319
320(defun %fstat (fd)
321  (rlet ((stat :stat))
322    (%%fstat fd stat)))
323
324
325(defun %file-kind (mode)
326  (when mode
327    (let* ((kind (logand mode #$S_IFMT)))
328      (cond ((eql kind #$S_IFDIR) :directory)
329            ((eql kind #$S_IFREG) :file)
330            ((eql kind #$S_IFLNK) :link)
331            ((eql kind #$S_IFIFO) :pipe)
332            ((eql kind #$S_IFSOCK) :socket)
333            ((eql kind #$S_IFCHR) :character-special)
334            (t :special)))))
335
336(defun %unix-file-kind (path &optional check-for-link)
337  (%file-kind (nth-value 1 (%stat (native-translated-namestring path) check-for-link))))
338
339(defun %unix-fd-kind (fd)
340  (if (isatty fd)
341    :tty
342    (%file-kind (nth-value 1 (%fstat fd)))))
343
344(defun %uts-string (result idx buf)
345  (if (eql 0 result)
346    (%get-cstring (%inc-ptr buf (* #+linux-target #$_UTSNAME_LENGTH
347                                   #+darwin-target #$_SYS_NAMELEN
348                                   #+freebsd-target #$SYS_NMLN idx)))
349    "unknown"))
350
351(defun try-hard-to-get-errno (err)
352  (when (eq err -1)
353    (let ((nerr (%get-errno)))
354      (unless (eq nerr 0) (setq err nerr))))
355  #+darwin-target
356  (when (eq err -1)
357    ;; Not thread safe, but what else can I do??
358    (let ((nerr (pref (foreign-symbol-address "_errno") :signed)))
359      (unless (eq nerr 0) (setq err nerr))))
360  err)
361
362(defun copy-file-attributes (source-path dest-path)
363  "Copy the mode, owner, group and modification time of source-path to dest-path.
364   Returns T if succeeded, NIL if some of the attributes couldn't be copied due to
365   permission problems.  Any other failures cause an error to be signalled"
366  (multiple-value-bind (win mode ignore mtime-sec ignore uid ignore mtime-usec gid)
367                       (%stat (native-translated-namestring source-path) t)
368    (declare (ignore ignore))
369    (unless win
370      (error "Cannot get attributes of ~s" source-path))
371    (with-filename-cstrs ((cnamestr (native-translated-namestring dest-path)))
372      (macrolet ((errchk (form)
373                   `(let ((err ,form))
374                      (unless (eql err 0)
375                        (setq win nil)
376                        ;; We need the real errno so we can tell if it's a permission
377                        ;; error or something else...
378                        (when (eql err -1)
379                          (setq err (try-hard-to-get-errno err)))
380                        (unless (eql err #$EPERM) (%errno-disp err dest-path))))))
381        (errchk (#_chmod cnamestr mode))
382        (errchk (%stack-block ((times (record-length (:array (:struct :timeval) 2))))
383                  (setf (pref times :timeval.tv_sec) mtime-sec)
384                  (setf (pref times :timeval.tv_usec) mtime-usec)
385                  (%incf-ptr times (record-length :timeval))
386                  (setf (pref times :timeval.tv_sec) mtime-sec)
387                  (setf (pref times :timeval.tv_usec) mtime-usec)
388                  (%incf-ptr times (- (record-length :timeval)))
389                  (#_utimes cnamestr times)))
390        (errchk (#_chown cnamestr uid gid))))
391    win))
392
393#+linux-target
394(defun %uname (idx)
395  (%stack-block ((buf (* #$_UTSNAME_LENGTH 6))) 
396    (%uts-string (syscall syscalls::uname buf) idx buf)))
397
398#+darwin-target
399(defun %uname (idx)
400  (%stack-block ((buf (* #$_SYS_NAMELEN 5)))
401    (%uts-string (#_uname buf) idx buf)))
402
403#+freebsd-target
404(defun %uname (idx)
405  (%stack-block ((buf (* #$SYS_NMLN 5)))
406    (%uts-string (#___xuname #$SYS_NMLN buf) idx buf)))
407
408(defun fd-dup (fd)
409  (syscall syscalls::dup fd))
410
411(defun fd-fsync (fd)
412  (syscall syscalls::fsync fd))
413
414(defun fd-get-flags (fd)
415  (syscall syscalls::fcntl fd #$F_GETFL))
416
417(defun fd-set-flags (fd new)
418  (syscall syscalls::fcntl fd #$F_SETFL new))
419
420(defun fd-set-flag (fd mask)
421  (let* ((old (fd-get-flags fd)))
422    (if (< old 0)
423      old
424      (fd-set-flags fd (logior old mask)))))
425
426(defun fd-clear-flag (fd mask)
427  (let* ((old (fd-get-flags fd)))
428    (if (< old 0) 
429      old
430      (fd-set-flags fd (logandc2 old mask)))))
431
432
433;;; Assume that any quoting's been removed already.
434(defun tilde-expand (namestring)
435  (let* ((len (length namestring)))
436    (if (or (zerop len)
437            (not (eql (schar namestring 0) #\~)))
438      namestring
439      (if (or (= len 1)
440              (eql (schar namestring 1) #\/))
441        (concatenate 'string (get-user-home-dir (getuid)) (if (= len 1) "/" (subseq namestring 1)))
442        (let* ((slash-pos (position #\/ namestring))
443               (user-name (subseq namestring 1 slash-pos))
444               (uid (or (get-uid-from-name user-name)
445                        (error "Unknown user ~s in namestring ~s" user-name namestring))))
446          (concatenate 'string (get-user-home-dir uid) (if slash-pos (subseq namestring slash-pos) "/")))))))
447
448                     
449   
450;;; This doesn't seem to exist on VxWorks.  It's a POSIX
451;;; function AFAIK, so the source should be somewhere ...
452
453(defun %realpath (namestring)
454  (when (zerop (length namestring))
455    (setq namestring (current-directory-name)))
456  (%stack-block ((resultbuf #$PATH_MAX))
457    (with-filename-cstrs ((name namestring #|(tilde-expand namestring)|#))
458      (let* ((result (#_realpath name resultbuf)))
459        (declare (dynamic-extent result))
460        (unless (%null-ptr-p result)
461          (get-foreign-namestring result))))))
462
463;;; Return fully resolved pathname & file kind, or (values nil nil)
464
465(defun %probe-file-x (namestring)
466  (let* ((realpath (%realpath namestring))
467         (kind (if realpath (%unix-file-kind realpath))))
468    (if kind
469      (values realpath kind)
470      (values nil nil))))
471
472(defun timeval->milliseconds (tv)
473    (+ (* 1000 (pref tv :timeval.tv_sec)) (round (pref tv :timeval.tv_usec) 1000)))
474
475(defun timeval->microseconds (tv)
476    (+ (* 1000000 (pref tv :timeval.tv_sec)) (pref tv :timeval.tv_usec)))
477
478(defun %add-timevals (result a b)
479  (let* ((seconds (+ (pref a :timeval.tv_sec) (pref b :timeval.tv_sec)))
480         (micros (+ (pref a :timeval.tv_usec) (pref b :timeval.tv_usec))))
481    (if (>= micros 1000000)
482      (setq seconds (1+ seconds) micros (- micros 1000000)))
483    (setf (pref result :timeval.tv_sec) seconds
484          (pref result :timeval.tv_usec) micros)
485    result))
486
487(defun %sub-timevals (result a b)
488  (let* ((seconds (- (pref a :timeval.tv_sec) (pref b :timeval.tv_sec)))
489         (micros (- (pref a :timeval.tv_usec) (pref b :timeval.tv_usec))))
490    (if (< micros 0)
491      (setq seconds (1- seconds) micros (+ micros 1000000)))
492    (setf (pref result :timeval.tv_sec) seconds
493          (pref result :timeval.tv_usec) micros)
494    result))
495
496;;; Return T iff the time denoted by the timeval a is not later than the
497;;; time denoted by the timeval b.
498(defun %timeval<= (a b)
499  (let* ((asec (pref a :timeval.tv_sec))
500         (bsec (pref b :timeval.tv_sec)))
501    (or (< asec bsec)
502        (and (= asec bsec)
503             (< (pref a :timeval.tv_usec)
504                (pref b :timeval.tv_usec))))))
505
506
507(defun %%rusage (usage &optional (who #$RUSAGE_SELF))
508  (syscall syscalls::getrusage who usage))
509
510
511
512(defconstant unix-to-universal-time 2208988800)
513
514(defun %file-write-date (namestring)
515  (let* ((date (nth-value 3 (%stat namestring))))
516    (if date
517      (+ date unix-to-universal-time))))
518
519(defun %file-author (namestring)
520  (let* ((uid (nth-value 5 (%stat namestring))))
521    (if uid
522      (with-macptrs ((pw (#_getpwuid uid)))
523        (unless (%null-ptr-p pw)
524          (without-interrupts
525           (%get-cstring (pref pw :passwd.pw_name))))))))
526
527(defun %utimes (namestring)
528  (with-filename-cstrs ((cnamestring namestring))
529    (let* ((err (#_utimes cnamestring (%null-ptr))))
530      (declare (fixnum err))
531      (or (eql err 0)
532          (%errno-disp err namestring)))))
533         
534
535(defun get-uid-from-name (name)
536  (with-cstrs ((name name))
537    (let* ((pwent (#_getpwnam name)))
538      (unless (%null-ptr-p pwent)
539        (pref pwent :passwd.pw_uid)))))
540
541   
542(defun isatty (fd)
543  (= 1 (#_isatty fd)))
544
545(defun %open-dir (namestring)
546  (with-filename-cstrs ((name namestring))
547    (let* ((DIR (#_opendir name)))
548      (unless (%null-ptr-p DIR)
549        DIR))))
550
551(defun close-dir (dir)
552  (#_closedir DIR))
553
554(defun %read-dir (dir)
555  (let* ((res (#_readdir dir)))
556    (unless (%null-ptr-p res)
557      (get-foreign-namestring (pref res :dirent.d_name)))))
558
559(defun tcgetpgrp (fd)
560  (#_tcgetpgrp fd))
561
562(defun getpid ()
563  "Return the ID of the OpenMCL OS process."
564  (syscall syscalls::getpid))
565
566(defun getuid ()
567  "Return the (real) user ID of the current user."
568  (syscall syscalls::getuid))
569
570(defun get-user-home-dir (userid)
571  "Look up and return the defined home directory of the user identified
572by uid. This value comes from the OS user database, not from the $HOME
573environment variable. Returns NIL if there is no user with the ID uid."
574  (rlet ((pwd :passwd)
575         (result :address))
576    (do* ((buflen 512 (* 2 buflen)))
577         ()
578      (%stack-block ((buf buflen))
579        (let* ((err (#_getpwuid_r userid pwd buf buflen result)))
580          (if (eql 0 err)
581            (return (get-foreign-namestring (pref pwd :passwd.pw_dir)))
582            (unless (eql err #$ERANGE)
583              (return nil))))))))
584
585(defun %delete-file (name)
586  (with-cstrs ((n name))
587    (syscall syscalls::unlink n)))
588
589(defun os-command (string)
590  "Invoke the Posix function system(), which invokes the user's default
591system shell (such as sh or tcsh) as a new process, and has that shell
592execute command-line.
593
594If the shell was able to find the command specified in command-line, then
595exit-code is the exit code of that command. If not, it is the exit code
596of the shell itself."
597  (with-cstrs ((s string))
598    (#_system s)))
599
600(defun %strerror (errno)
601  (declare (fixnum errno))
602  (if (< errno 0)
603    (setq errno (- errno)))
604  (with-macptrs (p)
605    (%setf-macptr p (#_strerror errno))
606    (if (%null-ptr-p p)
607      (format nil "OS Error %d" errno)
608      (%get-cstring p))))
609
610;;; Kind of has something to do with files, and doesn't work in level-0.
611#+linux-target
612(defun close-shared-library (lib &key (completely t))
613  "If completely is T, set the reference count of library to 0. Otherwise,
614decrements it by 1. In either case, if the reference count becomes 0,
615close-shared-library frees all memory resources consumed library and causes
616any EXTERNAL-ENTRY-POINTs known to be defined by it to become unresolved."
617  (let* ((lib (if (typep lib 'string)
618                (or (shared-library-with-name lib)
619                    (error "Shared library ~s not found." lib))
620                (require-type lib 'shlib)))
621         (map (shlib.map lib)))
622    (unless (shlib.opened-by-lisp-kernel lib)
623      (when map
624        (let* ((found nil)
625               (base (shlib.base lib)))
626          (do* ()
627               ((progn           
628                  (#_dlclose map)
629                  (or (not (setq found (shlib-containing-address base)))
630                      (not completely)))))
631          (when (not found)
632            (setf (shlib.pathname lib) nil
633              (shlib.base lib) nil
634              (shlib.map lib) nil)
635            (unload-foreign-variables lib)
636            (unload-library-entrypoints lib)))))))
637
638#+darwin-target
639;; completely specifies whether to remove it totally from our list
640(defun close-shared-library (lib &key (completely nil))
641  "If completely is T, set the reference count of library to 0. Otherwise,
642decrements it by 1. In either case, if the reference count becomes 0,
643close-shared-library frees all memory resources consumed library and causes
644any EXTERNAL-ENTRY-POINTs known to be defined by it to become unresolved."
645  (let* ((lib (if (typep lib 'string)
646                  (or (shared-library-with-name lib)
647                      (error "Shared library ~s not found." lib))
648                (require-type lib 'shlib))))
649    ;; no possible danger closing libsystem since dylibs can't be closed
650    (cond
651     ((or (not (shlib.map lib)) (not (shlib.base lib)))
652      (error "Shared library ~s uninitialized." (shlib.soname lib)))
653     ((and (not (%null-ptr-p (shlib.map lib)))
654           (%null-ptr-p (shlib.base lib)))
655      (warn "Dynamic libraries cannot be closed on Darwin."))
656     ((and (%null-ptr-p (shlib.map lib))
657           (not (%null-ptr-p (shlib.base lib))))
658      ;; we have a bundle type library not sure what to do with the
659      ;; completely flag when we open the same bundle more than once,
660      ;; Darwin gives back a new module address, so we have multiple
661      ;; entries on *shared-libraries* the best we can do is unlink
662      ;; the module asked for (or our best guess based on name) and
663      ;; invalidate any entries which refer to this container
664      (if (= 0 (#_NSUnLinkModule (shlib.base lib) #$NSUNLINKMODULE_OPTION_NONE))
665          (error "Unable to close shared library, NSUnlinkModule failed.")
666        (progn
667          (setf (shlib.map lib) nil
668                (shlib.base lib) nil)
669          (unload-library-entrypoints lib)
670          (when completely
671            (setq *shared-libraries* (delete lib *shared-libraries*)))))))))
672
673
674
675;;; Foreign (unix) processes.
676
677(defun call-with-string-vector (function strings)
678  (let ((bufsize (reduce #'+ strings
679                         :key #'(lambda (s) (1+ (length (string s))))))
680        (argvsize (ash (1+ (length strings)) target::word-shift))
681        (bufpos 0)
682        (argvpos 0))
683    (%stack-block ((buf bufsize) (argv argvsize))
684      (flet ((init (s)
685             (multiple-value-bind (sstr start end) (get-sstring s)
686               (declare (fixnum start end))
687               (let ((len (- end start)))
688                 (declare (fixnum len))
689                 (do* ((i 0 (1+ i))
690                       (start start (1+ start))
691                       (bufpos bufpos (1+ bufpos)))
692                      ((= i len))
693                   (setf (%get-unsigned-byte buf bufpos)
694                         (logand #xff (%scharcode sstr start))))
695                 (setf (%get-byte buf (%i+ bufpos len)) 0)
696                 (setf (%get-ptr argv argvpos) (%inc-ptr buf bufpos))
697                 (setq bufpos (%i+ bufpos len 1))
698                 (setq argvpos (%i+ argvpos target::node-size))))))
699        (declare (dynamic-extent #'init))
700        (map nil #'init strings))
701      (setf (%get-ptr argv argvpos) (%null-ptr))
702      (funcall function argv))))
703
704(defmacro with-string-vector ((var &rest strings) &body body)
705  `(call-with-string-vector #'(lambda (,var) ,@body) ,@strings))
706
707(defloadvar *max-os-open-files* (#_getdtablesize))
708
709(defun %execvp (argv)
710  (#_execvp (%get-ptr argv) argv)
711  (#_exit #$EX_OSERR))
712
713(defun exec-with-io-redirection (new-in new-out new-err argv)
714  (#_setpgid 0 0)
715  (if new-in (#_dup2 new-in 0))
716  (if new-out (#_dup2 new-out 1))
717  (if new-err (#_dup2 new-err 2))
718  (do* ((fd 3 (1+ fd)))
719       ((= fd *max-os-open-files*) (%execvp argv))
720    (declare (fixnum fd))
721    (#_close fd)))
722
723
724
725
726
727
728;;; I believe that the Darwin/FreeBSD syscall infterface is rather ... odd.
729;;; Use libc's interface.
730(defun pipe ()
731  ;;  (rlet ((filedes (:array :int 2)))
732  (%stack-block ((filedes 8))
733    (let* ((status (#_pipe filedes))
734           (errno (if (eql status 0) 0 (%get-errno))))
735      (unless (zerop status)
736        (when (or (eql errno (- #$EMFILE))
737                  (eql errno (- #$ENFILE)))
738          (gc)
739          (drain-termination-queue)
740          (setq status (#_pipe filedes)
741                errno (if (zerop status) 0 (%get-errno)))))
742      (if (zerop status)
743        (values (paref filedes (:array :int)  0) (paref filedes (:array :int)  1))
744        (%errno-disp errno)))))
745
746
747
748(defstruct external-process
749  pid
750  %status
751  %exit-code
752  pty
753  input
754  output
755  error
756  status-hook
757  plist
758  token
759  core
760  args
761  (signal (make-semaphore))
762  (completed (make-semaphore))
763  watched-fd
764  watched-stream
765  )
766
767(defmethod print-object ((p external-process) stream)
768  (print-unreadable-object (p stream :type t :identity t)
769    (let* ((status (external-process-%status p)))
770      (let* ((*print-length* 3))
771        (format stream "~a" (external-process-args p)))
772      (format stream "[~d] (~a" (external-process-pid p) status)
773      (unless (eq status :running)
774        (format stream " : ~d" (external-process-%exit-code p)))
775      (format stream ")"))))
776
777(defun get-descriptor-for (object proc close-in-parent close-on-error
778                                  &rest keys &key direction (element-type 'character)
779                                  &allow-other-keys)
780  (etypecase object
781    ((eql t)
782     (values nil nil close-in-parent close-on-error))
783    (null
784     (let* ((fd (fd-open "/dev/null" (case direction
785                                       (:input #$O_RDONLY)
786                                       (:output #$O_WRONLY)
787                                       (t #$O_RDWR)))))
788       (if (< fd 0)
789         (signal-file-error fd "/dev/null"))
790       (values fd nil (cons fd close-in-parent) (cons fd close-on-error))))
791    ((eql :stream)
792     (multiple-value-bind (read-pipe write-pipe) (pipe)
793       (case direction
794         (:input
795          (values read-pipe
796                  (make-fd-stream write-pipe
797                                  :direction :output
798                                  :element-type element-type
799                                  :interactive nil
800                                  :basic t
801                                  :auto-close t)
802                  (cons read-pipe close-in-parent)
803                  (cons write-pipe close-on-error)))
804         (:output
805          (values write-pipe
806                  (make-fd-stream read-pipe
807                                  :direction :input
808                                  :element-type element-type
809                                  :interactive nil
810                                  :basic t
811                                  :auto-close t)
812                  (cons write-pipe close-in-parent)
813                  (cons read-pipe close-on-error)))
814         (t
815          (fd-close read-pipe)
816          (fd-close write-pipe)
817          (report-bad-arg direction '(member :input :output))))))
818    ((or pathname string)
819     (with-open-stream (file (apply #'open object keys))
820       (let* ((fd (fd-dup (ioblock-device (stream-ioblock file t)))))
821         (values fd
822                 nil
823                 (cons fd close-in-parent)
824                 (cons fd close-on-error)))))
825    (fd-stream
826     (let ((fd (fd-dup (ioblock-device (stream-ioblock object t)))))
827       (values fd
828               nil
829               (cons fd close-in-parent)
830               (cons fd close-on-error))))
831    (stream
832     (ecase direction
833       (:input
834        (with-cstrs ((template "lisp-tempXXXXXX"))
835          (let* ((fd (#_mkstemp template)))
836            (if (< fd 0)
837              (%errno-disp fd))
838            (#_unlink template)
839            (loop
840              (multiple-value-bind (line no-newline)
841                  (read-line object nil nil)
842                (unless line
843                  (return))
844                (let* ((len (length line)))
845                  (%stack-block ((buf (1+ len)))
846                    (%cstr-pointer line buf)
847                    (fd-write fd buf len)
848                    (if no-newline
849                      (return))
850                    (setf (%get-byte buf) (char-code #\newline))
851                    (fd-write fd buf 1)))))
852            (fd-lseek fd 0 #$SEEK_SET)
853            (values fd nil (cons fd close-in-parent) (cons fd close-on-error)))))
854       (:output
855        (multiple-value-bind (read-pipe write-pipe) (pipe)
856          (setf (external-process-watched-fd proc) read-pipe
857                (external-process-watched-stream proc) object)
858          (incf (car (external-process-token proc)))
859          (values write-pipe
860                  nil
861                  (cons write-pipe close-in-parent)
862                  (cons read-pipe close-on-error))))))))
863
864(let* ((external-processes ())
865       (external-processes-lock (make-lock)))
866  (defun add-external-process (p)
867    (with-lock-grabbed (external-processes-lock)
868      (push p external-processes)))
869  (defun remove-external-process (p)
870    (with-lock-grabbed (external-processes-lock)
871      (setq external-processes (delete p external-processes))))
872  ;; Likewise
873  (defun external-processes ()
874    (with-lock-grabbed (external-processes-lock)
875      (copy-list external-processes)))
876  )
877
878
879(defmacro wtermsig (status)
880  `(ldb (byte 7 0) ,status))
881
882(defmacro wexitstatus (status)
883  `(ldb (byte 8 8) (the fixnum ,status)))
884
885(defmacro wstopsig (status)
886  `(wexitstatus ,status))
887
888(defmacro wifexited (status)
889  `(eql (wtermsig ,status) 0))
890
891(defmacro wifstopped (status)
892  `(eql #x7f (ldb (byte 7 0) (the fixnum ,status))))
893
894(defun monitor-external-process (p)
895  (let* ((in-fd (external-process-watched-fd p))
896         (out-stream (external-process-watched-stream p))
897         (token (external-process-token p))
898         (terminated))
899    (loop
900      (when (and terminated (null in-fd))
901        (signal-semaphore (external-process-completed p))
902        (return))
903      (when in-fd
904        (when (fd-input-available-p in-fd 0)
905          (%stack-block ((buf 1024))
906            (let* ((n (fd-read in-fd buf 1024)))
907              (declare (fixnum n))
908              (if (<= n 0)
909                (progn
910                  (without-interrupts
911                   (decf (car token))
912                   (fd-close in-fd)
913                   (setq in-fd nil)))
914                (let* ((string (make-string 1024)))
915                  (declare (dynamic-extent string))
916                  (%str-from-ptr buf n string)
917                  (write-sequence string out-stream :end n)))))))
918      (let* ((statusflags (check-pid (external-process-pid p)
919                                     (logior
920                                      (if in-fd #$WNOHANG 0)
921                                      #$WUNTRACED)))
922             (oldstatus (external-process-%status p)))
923        (cond ((null statusflags)
924               (remove-external-process p)
925               (setq terminated t))
926              ((eq statusflags t))      ; Running.
927              (t
928               (multiple-value-bind (status code core)
929                   (cond ((wifstopped statusflags)
930                          (values :stopped (wstopsig statusflags)))
931                         ((wifexited statusflags)
932                          (values :exited (wexitstatus statusflags)))
933                         (t
934                          (let* ((signal (wtermsig statusflags)))
935                            (declare (fixnum signal))
936                            (values
937                             (if (or (= signal #$SIGSTOP)
938                                     (= signal #$SIGTSTP)
939                                     (= signal #$SIGTTIN)
940                                     (= signal #$SIGTTOU))
941                               :stopped
942                               :signaled)
943                             signal
944                             (logtest #$WCOREFLAG statusflags)))))
945                 (setf (external-process-%status p) status
946                       (external-process-%exit-code p) code
947                       (external-process-core p) core)
948                 (let* ((status-hook (external-process-status-hook p)))
949                   (when (and status-hook (not (eq oldstatus status)))
950                     (funcall status-hook p)))
951                 (when (or (eq status :exited)
952                           (eq status :signaled))
953                   (remove-external-process p)
954                   (setq terminated t)))))))))
955     
956(defun run-external-process (proc in-fd out-fd error-fd &optional env)
957  ;; type-check the env variable
958  (dolist (pair env)
959    (destructuring-bind (var . val) pair
960      (assert (typep var '(or string symbol character)))
961      (assert (typep val 'string)))) 
962  (call-with-string-vector
963   #'(lambda (argv)
964       (let* ((child-pid (#_fork)))
965         (declare (fixnum child-pid))
966         (cond ((zerop child-pid)
967                ;; Running in the child; do an exec
968                (dolist (pair env)
969                  (setenv (string (car pair)) (cdr pair)))
970                (without-interrupts
971                 (exec-with-io-redirection
972                  in-fd out-fd error-fd argv)))
973               ((> child-pid 0)
974                ;; Running in the parent: success
975                (setf (external-process-pid proc) child-pid)
976                (add-external-process proc)
977                (signal-semaphore (external-process-signal proc))
978                (monitor-external-process proc)))))
979   (external-process-args proc)))
980
981               
982(defun run-program (program args &key
983                            (wait t) pty
984                            input if-input-does-not-exist
985                            output (if-output-exists :error)
986                            (error :output) (if-error-exists :error)
987                            status-hook (element-type 'character)
988                            env)
989  "Invoke an external program as an OS subprocess of lisp."
990  (declare (ignore pty))
991  (unless (every #'(lambda (a) (typep a 'simple-string)) args)
992    (error "Program args must all be simple strings : ~s" args))
993  (push (native-untranslated-namestring program) args)
994  (let* ((token (list 0))
995         (in-fd nil)
996         (in-stream nil)
997         (out-fd nil)
998         (out-stream nil)
999         (error-fd nil)
1000         (error-stream nil)
1001         (close-in-parent nil)
1002         (close-on-error nil)
1003         (proc
1004          (make-external-process
1005           :pid nil
1006           :args args
1007           :%status :running
1008           :input nil
1009           :output nil
1010           :error nil
1011           :token token
1012           :status-hook status-hook)))
1013    (unwind-protect
1014         (progn
1015           (multiple-value-setq (in-fd in-stream close-in-parent close-on-error)
1016             (get-descriptor-for input proc  nil nil :direction :input
1017                                 :if-does-not-exist if-input-does-not-exist
1018                                 :element-type element-type))
1019           (multiple-value-setq (out-fd out-stream close-in-parent close-on-error)
1020             (get-descriptor-for output proc close-in-parent close-on-error
1021                                 :direction :output
1022                                 :if-exists if-output-exists
1023                                 :element-type element-type))
1024           (multiple-value-setq (error-fd error-stream close-in-parent close-on-error)
1025             (if (eq error :output)
1026               (values out-fd out-stream close-in-parent close-on-error)
1027               (get-descriptor-for error proc close-in-parent close-on-error
1028                                   :direction :output
1029                                   :if-exists if-error-exists
1030                                   :element-type element-type)))
1031           (setf (external-process-input proc) in-stream
1032                 (external-process-output proc) out-stream
1033                 (external-process-error proc) error-stream)
1034           (process-run-function
1035            (format nil "Monitor thread for external process ~a" args)
1036                   
1037            #'run-external-process proc in-fd out-fd error-fd env)
1038           (wait-on-semaphore (external-process-signal proc))
1039           )
1040      (dolist (fd close-in-parent) (fd-close fd))
1041      (unless (external-process-pid proc)
1042        (dolist (fd close-on-error) (fd-close fd)))
1043      (when (and wait (external-process-pid proc))
1044        (with-interrupts-enabled
1045            (wait-on-semaphore (external-process-completed proc)))))
1046    (and (external-process-pid proc) proc)))
1047
1048
1049
1050
1051(defmacro wifsignaled (status)
1052  (let* ((statname (gensym)))
1053    `(let* ((,statname ,status))
1054      (and (not (wifstopped ,statname)) (not (wifexited ,statname))))))
1055
1056
1057(defun check-pid (pid &optional (flags (logior  #$WNOHANG #$WUNTRACED)))
1058  (declare (fixnum pid))
1059  (rlet ((status :signed))
1060    (let* ((retval (#_waitpid pid status flags)))
1061      (declare (fixnum retval))
1062      (if (= retval pid)
1063        (pref status :signed)
1064        (zerop retval)))))
1065
1066
1067
1068
1069
1070(defun external-process-wait (proc &optional check-stopped)
1071  (process-wait "external-process-wait"
1072                #'(lambda ()
1073                    (case (external-process-%status proc)
1074                      (:running)
1075                      (:stopped
1076                       (when check-stopped
1077                         t))
1078                      (t
1079                       (when (zerop (car (external-process-token proc)))
1080                         t))))))
1081
1082(defun external-process-status (proc)
1083  "Return information about whether an OS subprocess is running; or, if
1084not, why not; and what its result code was if it completed."
1085  (require-type proc 'external-process)
1086  (values (external-process-%status proc)
1087          (external-process-%exit-code proc)))
1088
1089(defun external-process-input-stream (proc)
1090  "Return the lisp stream which is used to write input to a given OS
1091subprocess, if it has one."
1092  (require-type proc 'external-process)
1093  (external-process-input proc))
1094
1095(defun external-process-output-stream (proc)
1096  "Return the lisp stream which is used to read output from a given OS
1097subprocess, if there is one."
1098  (require-type proc 'external-process)
1099  (external-process-output proc))
1100
1101(defun external-process-error-stream (proc)
1102  "Return the stream which is used to read error output from a given OS
1103subprocess, if it has one."
1104  (require-type proc 'external-process)
1105  (external-process-error proc))
1106
1107(defun external-process-id (proc)
1108  "Return the process id of an OS subprocess, a positive integer which
1109identifies it."
1110  (require-type proc 'external-process)
1111  (external-process-pid proc))
1112 
1113(defun signal-external-process (proc signal)
1114  "Send the specified signal to the specified external process.  (Typically,
1115it would only be useful to call this function if the EXTERNAL-PROCESS was
1116created with :WAIT NIL.) Return T if successful; signal an error otherwise."
1117  (require-type proc 'external-process)
1118  (let* ((pid (external-process-pid proc))
1119         (error (syscall syscalls::kill pid signal)))
1120    (or (eql error 0)
1121        (%errno-disp error))))
1122
1123;;; EOF on a TTY is transient, but I'm less sure of other cases.
1124(defun eof-transient-p (fd)
1125  (case (%unix-fd-kind fd)
1126    (:tty t)
1127    (t nil)))
1128
1129
1130(defstruct (shared-resource (:constructor make-shared-resource (name)))
1131  (name)
1132  (lock (make-lock))
1133  (primary-owner *current-process*)
1134  (primary-owner-notify (make-semaphore))
1135  (current-owner nil)
1136  (requestors (make-dll-header)))
1137
1138(defstruct (shared-resource-request
1139             (:constructor make-shared-resource-request (process))
1140             (:include dll-node))
1141  process
1142  (signal (make-semaphore)))
1143             
1144
1145;; Returns NIL if already owned by calling thread, T otherwise
1146(defun %acquire-shared-resource (resource  &optional verbose)
1147  (let* ((current *current-process*))
1148    (with-lock-grabbed ((shared-resource-lock resource))
1149      (let* ((secondary (shared-resource-current-owner resource)))
1150        (if (or (eq current secondary)
1151                (and (null secondary)
1152                     (eq current (shared-resource-primary-owner resource))))
1153          (return-from %acquire-shared-resource nil))))
1154    (let* ((request (make-shared-resource-request *current-process*)))
1155      (when verbose
1156        (format t "~%~%;;;~%;;; ~a requires access to ~a~%;;;~%~%"
1157                *current-process* (shared-resource-name resource)))
1158      (with-lock-grabbed ((shared-resource-lock resource))
1159        (append-dll-node request (shared-resource-requestors resource)))
1160      (wait-on-semaphore (shared-resource-request-signal request))
1161      (assert (eq current (shared-resource-current-owner resource)))
1162      (when verbose
1163        (format t "~%~%;;;~%;;; ~a is now owned by ~a~%;;;~%~%"
1164                (shared-resource-name resource) current))
1165      t)))
1166
1167;;; If we're the primary owner and there is no secondary owner, do nothing.
1168;;; If we're the secondary owner, cease being the secondary owner.
1169(defun %release-shared-resource (r)
1170  (let* ((not-any-owner ()))
1171    (with-lock-grabbed ((shared-resource-lock r))
1172      (let* ((current *current-process*)
1173             (primary (shared-resource-primary-owner r))
1174             (secondary (shared-resource-current-owner r)))
1175        (unless (setq not-any-owner
1176                      (not (or (eq current secondary)
1177                               (and (null secondary)
1178                                    (eq current primary)))))
1179          (when (eq current secondary)
1180            (setf (shared-resource-current-owner r) nil)
1181            (signal-semaphore (shared-resource-primary-owner-notify r))))))
1182    (when not-any-owner
1183      (signal-program-error "Process ~a does not own ~a" *current-process*
1184                            (shared-resource-name r)))))
1185
1186;;; The current thread should be the primary owner; there should be
1187;;; no secondary owner.  Wakeup the specified (or first) requesting
1188;;; process, then block on our semaphore
1189(defun %yield-shared-resource (r &optional to)
1190  (let* ((request nil))
1191    (with-lock-grabbed ((shared-resource-lock r))
1192      (let* ((current *current-process*)
1193             (primary (shared-resource-primary-owner r)))
1194        (when (and (eq current primary)
1195                   (null (shared-resource-current-owner r)))
1196          (setq request
1197                (let* ((header (shared-resource-requestors r)))
1198                  (if to 
1199                    (do-dll-nodes (node header)
1200                      (when (eq to (shared-resource-request-process node))
1201                        (return node)))
1202                    (let* ((first (dll-header-first header)))
1203                      (unless (eq first header)
1204                        first)))))
1205          (when request
1206            (remove-dll-node request)
1207            (setf (shared-resource-current-owner r)
1208                  (shared-resource-request-process request))
1209            (signal-semaphore (shared-resource-request-signal request))))))
1210    (when request
1211      (wait-on-semaphore (shared-resource-primary-owner-notify r))
1212      (format t "~%;;;~%;;;control of ~a restored to ~a~%;;;~&"
1213              (shared-resource-name r)
1214              *current-process*))))
1215
1216
1217     
1218
1219(defun %shared-resource-requestor-p (r proc)
1220  (with-lock-grabbed ((shared-resource-lock r))
1221    (do-dll-nodes (node (shared-resource-requestors r))
1222      (when (eq proc (shared-resource-request-process node))
1223        (return t)))))
1224
1225(defparameter *resident-editor-hook* nil
1226  "If non-NIL, should be a function that takes an optional argument
1227   (like ED) and invokes a \"resident\" editor.")
1228
1229(defun ed (&optional arg)
1230  (if *resident-editor-hook*
1231    (funcall *resident-editor-hook* arg)
1232    (error "This implementation doesn't provide a resident editor.")))
1233
1234(defun running-under-emacs-p ()
1235  (not (null (getenv "EMACS"))))
1236
1237(defloadvar *cpu-count* nil)
1238
1239(defun cpu-count ()
1240  (or *cpu-count*
1241      (setq *cpu-count*
1242            #+darwin-target
1243            (rlet ((info :host_basic_info)
1244                   (count :mach_msg_type_number_t #$HOST_BASIC_INFO_COUNT))
1245              (if (eql #$KERN_SUCCESS (#_host_info (#_mach_host_self)
1246                                                   #$HOST_BASIC_INFO
1247                                                   info
1248                                                   count))
1249                (pref info :host_basic_info.max_cpus)
1250                1))
1251            #+linux-target
1252            (or
1253             (let* ((n (#_sysconf #$_SC_NPROCESSORS_ONLN)))
1254               (declare (fixnum n))
1255               (if (> n 0) n))
1256             (ignore-errors
1257               (with-open-file (p "/proc/cpuinfo")
1258                 (let* ((ncpu 0)
1259                        (match "processor")
1260                        (matchlen (length match)))
1261                   (do* ((line (read-line p nil nil) (read-line p nil nil)))
1262                        ((null line) ncpu)
1263                     (let* ((line-length (length line)))
1264                       (when (and
1265                              (> line-length matchlen)
1266                              (string= match line
1267                                       :end2 matchlen)
1268                              (whitespacep (schar line matchlen)))
1269                         (incf ncpu)))))))
1270             1)
1271            #+freebsd-target
1272            (rlet ((ret :uint))
1273              (%stack-block ((mib (* (record-length :uint) 2)))
1274              (setf (paref mib (:array :uint) 0)
1275                    #$CTL_HW
1276                    (paref mib (:array :uint) 1)
1277                    #$HW_NCPU)
1278              (rlet ((oldsize :uint (record-length :uint)))
1279                (if (eql 0 (#_sysctl mib 2 ret oldsize (%null-ptr) 0))
1280                  (pref ret :uint)
1281                  1))))
1282            )))
1283
1284(def-load-pointers spin-count ()
1285  (if (eql 1 (cpu-count))
1286    (%defglobal '*spin-lock-tries* 1)
1287    (%defglobal '*spin-lock-tries* 1024))
1288  (%defglobal '*spin-lock-timeouts* 0))
1289
1290(defun yield ()
1291  (#_sched_yield))
1292
1293(defloadvar *host-page-size* (#_getpagesize))
1294
1295;;(assert (= (logcount *host-page-size*) 1))
1296
1297(defun map-file-to-ivector (pathname element-type)
1298  (let* ((upgraded-type (upgraded-array-element-type element-type))
1299         (upgraded-ctype (specifier-type upgraded-type)))
1300    (unless (and (typep upgraded-ctype 'numeric-ctype)
1301                 (eq 'integer (numeric-ctype-class upgraded-ctype)))
1302      (error "Invalid element-type: ~s" element-type))
1303    (let* ((bits-per-element (integer-length (- (numeric-ctype-high upgraded-ctype)
1304                                                (numeric-ctype-low upgraded-ctype))))
1305           (fd (fd-open (native-translated-namestring pathname) #$O_RDONLY)))
1306      (if (< fd 0)
1307        (signal-file-error fd pathname)
1308        (let* ((len (fd-size fd)))
1309          (if (< len 0)
1310            (signal-file-error fd pathname)
1311            (let* ((nbytes (+ *host-page-size*
1312                              (logandc2 (+ len
1313                                           (1- *host-page-size*))
1314                                        (1- *host-page-size*))))
1315
1316                   (ndata-elements
1317                    (ash len
1318                         (ecase bits-per-element
1319                           (1 3)
1320                           (8 0)
1321                           (16 -1)
1322                           (32 -2)
1323                           (64 -3))))
1324                   (nalignment-elements
1325                    (ash target::nbits-in-word
1326                         (ecase bits-per-element
1327                           (1 0)
1328                           (8 -3)
1329                           (16 -4)
1330                           (32 -5)
1331                           (64 -6)))))
1332              (if (>= (+ ndata-elements nalignment-elements)
1333                      array-total-size-limit)
1334                (progn
1335                  (fd-close fd)
1336                  (error "Can't make a vector with ~s elements in this implementation." (+ ndata-elements nalignment-elements)))
1337                (let* ((addr (#_mmap +null-ptr+
1338                                     nbytes
1339                                     #$PROT_NONE
1340                                     (logior #$MAP_ANON #$MAP_PRIVATE)
1341                                     -1
1342                                     0)))             
1343                  (if (eql addr (%int-to-ptr (1- (ash 1 target::nbits-in-word)))) ; #$MAP_FAILED
1344                    (let* ((errno (%get-errno)))
1345                      (fd-close fd)
1346                      (error "Can't map ~d bytes: ~a" nbytes (%strerror errno)))
1347              ;;; Remap the first page so that we can put a vector header
1348              ;;; there; use the first word on the first page to remember
1349              ;;; the file descriptor.
1350                    (progn
1351                      (#_mmap addr
1352                              *host-page-size*
1353                              (logior #$PROT_READ #$PROT_WRITE)
1354                              (logior #$MAP_ANON #$MAP_PRIVATE #$MAP_FIXED)
1355                              -1
1356                              0)
1357                      (setf (pref addr :int) fd)
1358                      (let* ((header-addr (%inc-ptr addr (- *host-page-size*
1359                                                            (* 2 target::node-size)))))
1360                        (setf (pref header-addr :unsigned-long)
1361                              (logior (element-type-subtype upgraded-type)
1362                                      (ash (+ ndata-elements nalignment-elements) target::num-subtag-bits)))
1363                        (when (> len 0)
1364                          (let* ((target-addr (%inc-ptr header-addr (* 2 target::node-size))))
1365                            (unless (eql target-addr
1366                                         (#_mmap target-addr
1367                                                 len
1368                                                 #$PROT_READ
1369                                                 (logior #$MAP_PRIVATE #$MAP_FIXED)
1370                                                 fd
1371                                                 0))
1372                              (let* ((errno (%get-errno)))
1373                                (fd-close fd)
1374                                (#_munmap addr nbytes)
1375                                (error "Mapping failed: ~a" (%strerror errno))))))
1376                        (with-macptrs ((v (%inc-ptr header-addr target::fulltag-misc)))
1377                          (let* ((vector (rlet ((p :address v)) (%get-object p 0))))
1378                            ;; Tell some parts of OpenMCL - notably the
1379                            ;; printer - that this thing off in foreign
1380                            ;; memory is a real lisp object and not
1381                            ;; "bogus".
1382                            (with-lock-grabbed (*heap-ivector-lock*)
1383                              (push vector *heap-ivectors*))
1384                            (make-array ndata-elements
1385                                        :element-type upgraded-type
1386                                        :displaced-to vector
1387                                        :adjustable t
1388                                        :displaced-index-offset nalignment-elements)))))))))))))))
1389
1390(defun map-file-to-octet-vector (pathname)
1391  (map-file-to-ivector pathname '(unsigned-byte 8)))
1392
1393(defun mapped-vector-data-address-and-size (displaced-vector)
1394  (let* ((v (array-displacement displaced-vector))
1395         (element-type (array-element-type displaced-vector)))
1396    (if (or (eq v displaced-vector)
1397            (not (with-lock-grabbed (*heap-ivector-lock*)
1398                   (member v *heap-ivectors*))))
1399      (error "~s doesn't seem to have been allocated via ~s and not yet unmapped" displaced-vector 'map-file-to-ivector))
1400    (let* ((pv (rlet ((x :address)) (%set-object x 0 v) (pref x :address)))
1401           (ctype (specifier-type element-type))
1402           (arch (backend-target-arch *target-backend*)))
1403      (values (%inc-ptr pv (- (* 2 target::node-size) target::fulltag-misc))
1404              (- (funcall (arch::target-array-data-size-function arch)
1405                          (ctype-subtype ctype)
1406                          (length v))
1407                 target::node-size)))))
1408
1409 
1410;;; Argument should be something returned by MAP-FILE-TO-IVECTOR;
1411;;; this should be called at most once for any such object.
1412(defun unmap-ivector (displaced-vector)
1413  (multiple-value-bind (data-address size-in-octets)
1414      (mapped-vector-data-address-and-size displaced-vector)
1415  (let* ((v (array-displacement displaced-vector))
1416         (base-address (%inc-ptr data-address (- *host-page-size*)))
1417         (fd (pref base-address :int)))
1418      (let* ((element-type (array-element-type displaced-vector)))
1419        (adjust-array displaced-vector 0
1420                      :element-type element-type
1421                      :displaced-to (make-array 0 :element-type element-type)
1422                      :displaced-index-offset 0))
1423      (with-lock-grabbed (*heap-ivector-lock*)
1424        (setq *heap-ivectors* (delete v *heap-ivectors*)))
1425      (#_munmap base-address (+ size-in-octets *host-page-size*))     
1426      (fd-close fd)
1427      t)))
1428
1429(defun unmap-octet-vector (v)
1430  (unmap-ivector v))
1431
1432(defun lock-mapped-vector (v)
1433  (multiple-value-bind (address nbytes)
1434      (mapped-vector-data-address-and-size v)
1435    (eql 0 (#_mlock address nbytes))))
1436
1437(defun unlock-mapped-vector (v)
1438  (multiple-value-bind (address nbytes)
1439      (mapped-vector-data-address-and-size v)
1440    (eql 0 (#_munlock address nbytes))))
1441
1442(defun bitmap-for-mapped-range (address nbytes)
1443  (let* ((npages (ceiling nbytes *host-page-size*)))
1444    (%stack-block ((vec npages))
1445      (when (eql 0 (#_mincore address nbytes vec))
1446        (let* ((bits (make-array npages :element-type 'bit)))
1447          (dotimes (i npages bits)
1448            (setf (sbit bits i)
1449                  (logand 1 (%get-unsigned-byte vec i)))))))))
1450
1451(defun percentage-of-resident-pages (address nbytes)
1452  (let* ((npages (ceiling nbytes *host-page-size*)))
1453    (%stack-block ((vec npages))
1454      (when (eql 0 (#_mincore address nbytes vec))
1455        (let* ((nresident 0))
1456          (dotimes (i npages (* 100.0 (/ nresident npages)))
1457            (when (logbitp 0 (%get-unsigned-byte vec i))
1458              (incf nresident))))))))
1459
1460(defun mapped-vector-resident-pages (v)
1461  (multiple-value-bind (address nbytes)
1462      (mapped-vector-data-address-and-size v)
1463    (bitmap-for-mapped-range address nbytes)))
1464
1465(defun mapped-vector-resident-pages-percentage (v)
1466  (multiple-value-bind (address nbytes)
1467      (mapped-vector-data-address-and-size v)
1468    (percentage-of-resident-pages address nbytes)))
1469 
1470#+x86-target
1471(progn
1472(defloadvar *last-rdtsc-time* 0)
1473
1474(defstatic *rdtsc-estimated-increment* 1 "Should be positive ...")
1475
1476(defun rdtsc-monotonic ()
1477  "Return monotonically increasing values, partly compensating for
1478   OSes that don't keep the TSCs of all processorsin synch."
1479  (loop
1480    (let* ((old *last-rdtsc-time*)
1481           (new (rdtsc)))
1482      (when (< new old)
1483        ;; We're running on a CPU whose TSC is behind the one
1484        ;; on the last CPU we were scheduled on.
1485        (setq new (+ old *rdtsc-estimated-increment*)))
1486      (when (%store-node-conditional target::symbol.vcell *last-rdtsc-time* old new)
1487        (return new)))))
1488
1489(defun estimate-rdtsc-skew (&optional (niter 1000000))
1490  (do* ((i 0 (1+ i))
1491        (last (rdtsc) next)
1492        (next (rdtsc) (rdtsc))
1493        (skew 1))
1494       ((>= i niter) (setq *rdtsc-estimated-increment* skew))
1495    (declare (fixnum last next skew))
1496    (when (> last next)
1497      (let* ((s (- last next)))
1498        (declare (fixnum s))
1499        (when (> s skew) (setq skew s))))))
1500)
1501
1502
Note: See TracBrowser for help on using the repository browser.