source: branches/win64/level-1/linux-files.lisp @ 9335

Last change on this file since 9335 was 9335, checked in by andreas, 13 years ago

Properly conditionalize definition of PIPE.

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