1 ;;;; This file contains Unix support that SBCL needs to implement
2 ;;;; itself. It's derived from Peter Van Eynde's unix-glibc2.lisp for
3 ;;;; CMU CL, which was derived from CMU CL unix.lisp 1.56. But those
4 ;;;; files aspired to be complete Unix interfaces exported to the end
5 ;;;; user, while this file aims to be as simple as possible and is not
6 ;;;; intended for the end user.
8 ;;;; FIXME: The old CMU CL unix.lisp code was implemented as hand
9 ;;;; transcriptions from Unix headers into Lisp. It appears that this was as
10 ;;;; unmaintainable in practice as you'd expect in theory, so I really really
11 ;;;; don't want to do that. It'd be good to implement the various system calls
12 ;;;; as C code implemented using the Unix header files, and have their
13 ;;;; interface back to SBCL code be characterized by things like "32-bit-wide
14 ;;;; int" which are already in the interface between the runtime
15 ;;;; executable and the SBCL lisp code.
17 ;;;; This software is part of the SBCL system. See the README file for
18 ;;;; more information.
20 ;;;; This software is derived from the CMU CL system, which was
21 ;;;; written at Carnegie Mellon University and released into the
22 ;;;; public domain. The software is in the public domain and is
23 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
24 ;;;; files for more information.
26 (in-package "SB!UNIX")
28 (/show0 "unix.lisp 21")
30 ;;; Given a C-level zero-terminated array of C strings, return a
31 ;;; corresponding Lisp-level list of SIMPLE-STRINGs.
32 (defun c-strings->string-list (c-strings)
33 (declare (type (alien (* c-string)) c-strings))
34 (let ((reversed-result nil))
35 (dotimes (i most-positive-fixnum (error "argh! can't happen"))
36 (declare (type index i))
37 (let ((c-string (deref c-strings i)))
39 (push c-string reversed-result)
40 (return (nreverse reversed-result)))))))
42 ;;;; Lisp types used by syscalls
44 (deftype unix-pathname () 'simple-string)
45 (deftype unix-fd () `(integer 0 ,sb!xc:most-positive-fixnum))
47 (deftype unix-file-mode () '(unsigned-byte 32))
48 (deftype unix-pid () '(unsigned-byte 32))
49 (deftype unix-uid () '(unsigned-byte 32))
50 (deftype unix-gid () '(unsigned-byte 32))
54 (/show0 "unix.lisp 74")
56 ;;; FIXME: The various FOO-SYSCALL-BAR macros, and perhaps some other
57 ;;; macros in this file, are only used in this file, and could be
58 ;;; implemented using SB!XC:DEFMACRO wrapped in EVAL-WHEN.
60 ;;; SB-EXECUTABLE, at least, uses one of these macros; other libraries
61 ;;; and programs have been known to use them as well. Perhaps they
62 ;;; should live in SB-SYS or even SB-EXT?
64 (defmacro syscall ((name &rest arg-types) success-form &rest args)
65 (when (eql 3 (mismatch "[_]" name))
67 (concatenate 'string #!+win32 "_" (subseq name 3))))
69 (declare (optimize (sb!c::float-accuracy 0)))
70 (let ((result (alien-funcall (extern-alien ,name (function int ,@arg-types))
73 (values nil (get-errno))
76 ;;; This is like SYSCALL, but if it fails, signal an error instead of
77 ;;; returning error codes. Should only be used for syscalls that will
78 ;;; never really get an error.
79 (defmacro syscall* ((name &rest arg-types) success-form &rest args)
81 (declare (optimize (sb!c::float-accuracy 0)))
82 (let ((result (alien-funcall (extern-alien ,name (function int ,@arg-types))
85 (error "Syscall ~A failed: ~A" ,name (strerror))
88 (defmacro int-syscall ((name &rest arg-types) &rest args)
89 `(syscall (,name ,@arg-types) (values result 0) ,@args))
91 (defmacro with-restarted-syscall ((&optional (value (gensym))
93 syscall-form &rest body)
95 "Evaluate BODY with VALUE and ERRNO bound to the return values of
96 SYSCALL-FORM. Repeat evaluation of SYSCALL-FORM if it is interrupted."
98 (loop (multiple-value-setq (,value ,errno)
100 (unless #!-win32 (eql ,errno sb!unix:eintr) #!+win32 nil
101 (return (values ,value ,errno))))
104 (defmacro void-syscall ((name &rest arg-types) &rest args)
105 `(syscall (,name ,@arg-types) (values t 0) ,@args))
109 (defconstant espipe 29))
111 ;;;; hacking the Unix environment
114 (define-alien-routine ("getenv" posix-getenv) c-string
115 "Return the \"value\" part of the environment string \"name=value\" which
116 corresponds to NAME, or NIL if there is none."
117 (name (c-string :not-null t)))
121 ;;; Rename the file with string NAME1 to the string NAME2. NIL and an
122 ;;; error code is returned if an error occurs.
124 (defun unix-rename (name1 name2)
125 (declare (type unix-pathname name1 name2))
126 (void-syscall ("rename" (c-string :not-null t)
127 (c-string :not-null t))
130 ;;; from sys/types.h and gnu/types.h
132 (/show0 "unix.lisp 220")
134 ;;; FIXME: We shouldn't hand-copy types from header files into Lisp
135 ;;; like this unless we have extreme provocation. Reading directories
136 ;;; is not extreme enough, since it doesn't need to be blindingly
137 ;;; fast: we can just implement those functions in C as a wrapper
139 (define-alien-type fd-mask unsigned)
141 (define-alien-type nil
143 (fds-bits (array fd-mask #.(/ fd-setsize
144 sb!vm:n-machine-word-bits)))))
146 (/show0 "unix.lisp 304")
151 ;;;; POSIX Standard: 6.5 File Control Operations <fcntl.h>
153 ;;; Open the file whose pathname is specified by PATH for reading
154 ;;; and/or writing as specified by the FLAGS argument. Various FLAGS
155 ;;; masks (O_RDONLY etc.) are defined in fcntlbits.h.
157 ;;; If the O_CREAT flag is specified, then the file is created with a
158 ;;; permission of argument MODE if the file doesn't exist. An integer
159 ;;; file descriptor is returned by UNIX-OPEN.
160 (defun unix-open (path flags mode)
161 (declare (type unix-pathname path)
163 (type unix-file-mode mode))
164 #!+win32 (sb!win32:unixlike-open path flags mode)
166 (with-restarted-syscall (value errno)
167 (int-syscall ("open" c-string int int)
169 (logior #!+win32 o_binary
170 #!+largefile o_largefile
174 ;;; UNIX-CLOSE accepts a file descriptor and attempts to close the file
175 ;;; associated with it.
176 (/show0 "unix.lisp 391")
177 (defun unix-close (fd)
178 #!+win32 (sb!win32:unixlike-close fd)
179 #!-win32 (declare (type unix-fd fd))
180 #!-win32 (void-syscall ("close" int) fd))
184 ;;; There are good reasons to implement some OPEN options with an
185 ;;; mkstemp(3)-like routine, but we don't do that yet. Instead, this
186 ;;; function is used only to make a temporary file for RUN-PROGRAM.
187 ;;; sb_mkstemp() is a wrapper that lives in src/runtime/wrap.c. Since
188 ;;; SUSv3 mkstemp() doesn't specify the mode of the created file and
189 ;;; since we have to implement most of this ourselves for Windows
190 ;;; anyway, it seems worthwhile to depart from the mkstemp()
191 ;;; specification by taking a mode to use when creating the new file.
192 (defun sb-mkstemp (template-string mode)
193 (declare (type string template-string)
194 (type unix-file-mode mode))
195 (let ((template-buffer (string-to-octets template-string :null-terminate t)))
196 (with-pinned-objects (template-buffer)
197 (let ((fd (alien-funcall (extern-alien "sb_mkstemp"
198 (function int (* char) int))
199 (vector-sap template-buffer)
202 (values nil (get-errno))
203 (values #!-win32 fd #!+win32 (sb!win32::duplicate-and-unwrap-fd fd)
204 (octets-to-string template-buffer)))))))
208 (defconstant rusage_self 0) ; the calling process
209 (defconstant rusage_children -1) ; terminated child processes
210 (defconstant rusage_both -2)
212 (define-alien-type nil
214 (ru-utime (struct timeval)) ; user time used
215 (ru-stime (struct timeval)) ; system time used.
216 (ru-maxrss long) ; maximum resident set size (in kilobytes)
217 (ru-ixrss long) ; integral shared memory size
218 (ru-idrss long) ; integral unshared data size
219 (ru-isrss long) ; integral unshared stack size
220 (ru-minflt long) ; page reclaims
221 (ru-majflt long) ; page faults
222 (ru-nswap long) ; swaps
223 (ru-inblock long) ; block input operations
224 (ru-oublock long) ; block output operations
225 (ru-msgsnd long) ; messages sent
226 (ru-msgrcv long) ; messages received
227 (ru-nsignals long) ; signals received
228 (ru-nvcsw long) ; voluntary context switches
229 (ru-nivcsw long))) ; involuntary context switches
233 ;;; Given a file path (a string) and one of four constant modes,
234 ;;; return T if the file is accessible with that mode and NIL if not.
235 ;;; When NIL, also return an errno value with NIL which tells why the
236 ;;; file was not accessible.
238 ;;; The access modes are:
239 ;;; r_ok Read permission.
240 ;;; w_ok Write permission.
241 ;;; x_ok Execute permission.
242 ;;; f_ok Presence of file.
244 ;;; In Windows, the MODE argument to access is defined in terms of
245 ;;; literal magic numbers---there are no constants to grovel. X_OK
251 (defconstant r_ok 4))
253 (defun unix-access (path mode)
254 (declare (type unix-pathname path)
256 (void-syscall ("[_]access" c-string int) path mode))
258 ;;; values for the second argument to UNIX-LSEEK
259 ;;; Note that nowadays these are called SEEK_SET, SEEK_CUR, and SEEK_END
260 (defconstant l_set 0) ; to set the file pointer
261 (defconstant l_incr 1) ; to increment the file pointer
262 (defconstant l_xtnd 2) ; to extend the file size
264 ;; off_t is 32 bit on Windows, yet our functions support 64 bit seeks.
265 (define-alien-type unix-offset
267 #!+win32 (signed 64))
269 ;;; Is a stream interactive?
270 (defun unix-isatty (fd)
271 (declare (type unix-fd fd))
272 #!-win32 (int-syscall ("isatty" int) fd)
273 #!+win32 (sb!win32::windows-isatty fd))
275 (defun unix-lseek (fd offset whence)
276 "Unix-lseek accepts a file descriptor and moves the file pointer by
277 OFFSET octets. Whence can be any of the following:
279 L_SET Set the file pointer.
280 L_INCR Increment the file pointer.
281 L_XTND Extend the file size.
283 (declare (type unix-fd fd)
284 (type (integer 0 2) whence))
287 (alien-funcall (extern-alien #!-largefile "lseek"
288 #!+largefile "lseek_largefile"
289 (function off-t int off-t int))
291 #!+win32 (sb!win32:lseeki64 fd offset whence)))
293 (values nil (get-errno))
296 ;;; UNIX-READ accepts a file descriptor, a buffer, and the length to read.
297 ;;; It attempts to read len bytes from the device associated with fd
298 ;;; and store them into the buffer. It returns the actual number of
302 (declaim (maybe-inline unix-read))
304 (defun unix-read (fd buf len)
305 (declare (type unix-fd fd)
306 (type (unsigned-byte 32) len))
307 (int-syscall (#!-win32 "read" #!+win32 "win32_unix_read"
308 int (* char) int) fd buf len))
310 ;;; UNIX-WRITE accepts a file descriptor, a buffer, an offset, and the
311 ;;; length to write. It attempts to write len bytes to the device
312 ;;; associated with fd from the buffer starting at offset. It returns
313 ;;; the actual number of bytes written.
314 (defun unix-write (fd buf offset len)
315 (declare (type unix-fd fd)
316 (type (unsigned-byte 32) offset len))
318 (declare (system-area-pointer sap))
319 (int-syscall (#!-win32 "write" #!+win32 "win32_unix_write"
322 (with-alien ((ptr (* char) sap))
323 (addr (deref ptr offset)))
326 ((simple-array * (*))
327 (with-pinned-objects (buf)
328 (%write (vector-sap buf))))
332 ;;; Set up a unix-piping mechanism consisting of an input pipe and an
333 ;;; output pipe. Return two values: if no error occurred the first
334 ;;; value is the pipe to be read from and the second is can be written
335 ;;; to. If an error occurred the first value is NIL and the second the
339 (with-alien ((fds (array int 2)))
340 (syscall ("pipe" (* int))
341 (values (deref fds 0) (deref fds 1))
342 (cast fds (* int)))))
346 (sb!win32::windows-pipe))
348 ;; Windows mkdir() doesn't take the mode argument. It's cdecl, so we could
349 ;; actually call it passing the mode argument, but some sharp-eyed reader
350 ;; would put five and twenty-seven together and ask us about it, so...
353 (defun unix-mkdir (name mode)
354 (declare (type unix-pathname name)
355 (type unix-file-mode mode)
356 #!+win32 (ignore mode))
357 (void-syscall ("mkdir" c-string #!-win32 int) name #!-win32 mode))
359 ;;; Given a C char* pointer allocated by malloc(), free it and return a
360 ;;; corresponding Lisp string (or return NIL if the pointer is a C NULL).
361 (defun newcharstar-string (newcharstar)
362 (declare (type (alien (* char)) newcharstar))
363 (if (null-alien newcharstar)
366 (cast newcharstar c-string)
367 (free-alien newcharstar))))
369 ;;; Return the Unix current directory as a SIMPLE-STRING, in the
370 ;;; style returned by getcwd() (no trailing slash character).
372 (defun posix-getcwd ()
373 ;; This implementation relies on a BSD/Linux extension to getcwd()
374 ;; behavior, automatically allocating memory when a null buffer
375 ;; pointer is used. On a system which doesn't support that
376 ;; extension, it'll have to be rewritten somehow.
378 ;; SunOS and OSF/1 provide almost as useful an extension: if given a null
379 ;; buffer pointer, it will automatically allocate size space. The
380 ;; KLUDGE in this solution arises because we have just read off
381 ;; PATH_MAX+1 from the Solaris header files and stuck it in here as
382 ;; a constant. Going the grovel_headers route doesn't seem to be
383 ;; helpful, either, as Solaris doesn't export PATH_MAX from
386 ;; Signal an error at compile-time, since it's needed for the
387 ;; runtime to start up
388 #!-(or linux openbsd freebsd netbsd sunos osf1 darwin hpux win32)
389 #.(error "POSIX-GETCWD is not implemented.")
390 #!+(or linux openbsd freebsd netbsd sunos osf1 darwin hpux win32)
391 (or (newcharstar-string (alien-funcall (extern-alien "getcwd"
396 #!+(or linux openbsd freebsd netbsd darwin win32) 0
397 #!+(or sunos osf1 hpux) 1025))
398 (simple-perror "getcwd")))
400 ;;; Return the Unix current directory as a SIMPLE-STRING terminated
401 ;;; by a slash character.
402 (defun posix-getcwd/ ()
403 (concatenate 'string (posix-getcwd) "/"))
405 ;;; Duplicate an existing file descriptor (given as the argument) and
406 ;;; return it. If FD is not a valid file descriptor, NIL and an error
407 ;;; number are returned.
410 (declare (type unix-fd fd))
411 (int-syscall ("dup" int) fd))
413 ;;; Terminate the current process with an optional error code. If
414 ;;; successful, the call doesn't return. If unsuccessful, the call
415 ;;; returns NIL and an error number.
416 (deftype exit-code ()
418 (defun os-exit (code &key abort)
420 "Exit the process with CODE. If ABORT is true, exit is performed using _exit(2),
421 avoiding atexit(3) hooks, etc. Otherwise exit(2) is called."
422 (unless (typep code 'exit-code)
423 (setf code (if abort 1 0)))
425 (void-syscall ("_exit" int) code)
426 (void-syscall ("exit" int) code)))
428 (define-deprecated-function :early "1.0.56.55" unix-exit os-exit (code)
431 ;;; Return the process id of the current process.
432 (define-alien-routine (#!+win32 "_getpid" #!-win32 "getpid" unix-getpid) int)
434 ;;; Return the real user id associated with the current process.
436 (define-alien-routine ("getuid" unix-getuid) int)
438 ;;; Translate a user id into a login name.
440 (defun uid-username (uid)
441 (or (newcharstar-string (alien-funcall (extern-alien "uid_username"
442 (function (* char) int))
444 (error "found no match for Unix uid=~S" uid)))
446 ;;; Return the namestring of the home directory, being careful to
447 ;;; include a trailing #\/
450 (defun uid-homedir (uid)
451 (or (newcharstar-string (alien-funcall (extern-alien "uid_homedir"
452 (function (* char) int))
454 (error "failed to resolve home directory for Unix uid=~S" uid)))
456 (defun user-homedir (uid)
457 (or (newcharstar-string (alien-funcall (extern-alien "user_homedir"
458 (function (* char) c-string))
460 (error "failed to resolve home directory for Unix uid=~S" uid))))
462 ;;; Invoke readlink(2) on the file name specified by PATH. Return
463 ;;; (VALUES LINKSTRING NIL) on success, or (VALUES NIL ERRNO) on
466 (defun unix-readlink (path)
467 (declare (type unix-pathname path))
468 (with-alien ((ptr (* char)
469 (alien-funcall (extern-alien
471 (function (* char) c-string))
474 (values nil (get-errno))
475 (multiple-value-prog1
476 (values (with-alien ((c-string c-string ptr)) c-string)
480 ;; Win32 doesn't do links, but something likes to call this anyway.
481 ;; Something in this file, no less. But it only takes one result, so...
482 (defun unix-readlink (path)
483 (declare (ignore path))
486 (defun unix-realpath (path)
487 (declare (type unix-pathname path))
488 (with-alien ((ptr (* char)
489 (alien-funcall (extern-alien
491 (function (* char) c-string))
494 (values nil (get-errno))
495 (multiple-value-prog1
496 (values (with-alien ((c-string c-string ptr)) c-string)
500 ;;; UNIX-UNLINK accepts a name and deletes the directory entry for that
501 ;;; name and the file if this is the last link.
502 (defun unix-unlink (name)
503 (declare (type unix-pathname name))
504 (void-syscall ("[_]unlink" c-string) name))
506 ;;; Return the name of the host machine as a string.
508 (defun unix-gethostname ()
509 (with-alien ((buf (array char 256)))
510 (syscall ("gethostname" (* char) int)
512 (cast buf (* char)) 256)))
515 (defun unix-setsid ()
516 (int-syscall ("setsid")))
520 ;;; UNIX-IOCTL performs a variety of operations on open i/o
521 ;;; descriptors. See the UNIX Programmer's Manual for more
524 (defun unix-ioctl (fd cmd arg)
525 (declare (type unix-fd fd)
526 (type (signed-byte 32) cmd))
527 (void-syscall ("ioctl" int int (* char)) fd cmd arg))
531 ;;; FIXME: All we seem to need is the RUSAGE_SELF version of this.
533 ;;; This is like getrusage(2), except it returns only the system and
534 ;;; user time, and returns the seconds and microseconds as separate
536 #!-sb-fluid (declaim (inline unix-fast-getrusage))
538 (defun unix-fast-getrusage (who)
539 (declare (values (member t)
541 unsigned-byte fixnum))
542 (with-alien ((usage (struct rusage)))
543 (syscall* ("sb_getrusage" int (* (struct rusage)))
545 (slot (slot usage 'ru-utime) 'tv-sec)
546 (slot (slot usage 'ru-utime) 'tv-usec)
547 (slot (slot usage 'ru-stime) 'tv-sec)
548 (slot (slot usage 'ru-stime) 'tv-usec))
551 ;;; Return information about the resource usage of the process
552 ;;; specified by WHO. WHO can be either the current process
553 ;;; (rusage_self) or all of the terminated child processes
554 ;;; (rusage_children). NIL and an error number is returned if the call
557 (defun unix-getrusage (who)
558 (with-alien ((usage (struct rusage)))
559 (syscall ("sb_getrusage" int (* (struct rusage)))
561 (+ (* (slot (slot usage 'ru-utime) 'tv-sec) 1000000)
562 (slot (slot usage 'ru-utime) 'tv-usec))
563 (+ (* (slot (slot usage 'ru-stime) 'tv-sec) 1000000)
564 (slot (slot usage 'ru-stime) 'tv-usec))
565 (slot usage 'ru-maxrss)
566 (slot usage 'ru-ixrss)
567 (slot usage 'ru-idrss)
568 (slot usage 'ru-isrss)
569 (slot usage 'ru-minflt)
570 (slot usage 'ru-majflt)
571 (slot usage 'ru-nswap)
572 (slot usage 'ru-inblock)
573 (slot usage 'ru-oublock)
574 (slot usage 'ru-msgsnd)
575 (slot usage 'ru-msgrcv)
576 (slot usage 'ru-nsignals)
577 (slot usage 'ru-nvcsw)
578 (slot usage 'ru-nivcsw))
581 (defvar *on-dangerous-wait* :warn)
583 ;;; Calling select in a bad place can hang in a nasty manner, so it's better
584 ;;; to have some way to detect these.
585 (defun note-dangerous-wait (type)
586 (let ((action *on-dangerous-wait*)
587 (*on-dangerous-wait* nil))
590 (warn "Starting a ~A without a timeout while interrupts are ~
594 (error "Starting a ~A without a timeout while interrupts are ~
599 "~&=== Starting a ~A without a timeout while interrupts are disabled. ===~%"
601 (sb!debug:backtrace)))
607 (define-alien-type nil
610 (events short) ; requested events
611 (revents short))) ; returned events
613 (defun unix-simple-poll (fd direction to-msec)
614 (declare (fixnum fd to-msec))
615 (when (and (minusp to-msec) (not *interrupts-enabled*))
616 (note-dangerous-wait "poll(2)"))
617 (let ((events (ecase direction
618 (:input (logior pollin pollpri))
620 (with-alien ((fds (struct pollfd)))
621 (with-restarted-syscall (count errno)
623 (setf (slot fds 'fd) fd
624 (slot fds 'events) events
625 (slot fds 'revents) 0)
626 (int-syscall ("poll" (* (struct pollfd)) int int)
627 (addr fds) 1 to-msec))
629 (let ((revents (slot fds 'revents)))
630 (or (and (eql 1 count) (logtest events revents))
631 (logtest pollhup revents)))
632 (error "Syscall poll(2) failed: ~A" (strerror))))))))
636 (defmacro with-fd-setsize ((n) &body body)
637 `(let ((,n (if (< 0 ,n fd-setsize)
639 (error "Cannot select(2) on ~D: above FD_SETSIZE limit."
641 (declare (type (integer 0 #.fd-setsize) ,n))
644 ;;;; FIXME: Why have both UNIX-SELECT and UNIX-FAST-SELECT?
646 ;;; Perform the UNIX select(2) system call.
647 (declaim (inline unix-fast-select))
648 (defun unix-fast-select (num-descriptors
649 read-fds write-fds exception-fds
650 timeout-secs timeout-usecs)
651 (declare (type integer num-descriptors)
652 (type (or (alien (* (struct fd-set))) null)
653 read-fds write-fds exception-fds)
654 (type (or null (unsigned-byte 31)) timeout-secs timeout-usecs))
655 (with-fd-setsize (num-descriptors)
656 (flet ((select (tv-sap)
657 (int-syscall ("sb_select" int (* (struct fd-set)) (* (struct fd-set))
658 (* (struct fd-set)) (* (struct timeval)))
659 num-descriptors read-fds write-fds exception-fds
661 (cond ((or timeout-secs timeout-usecs)
662 (with-alien ((tv (struct timeval)))
663 (setf (slot tv 'tv-sec) (or timeout-secs 0))
664 (setf (slot tv 'tv-usec) (or timeout-usecs 0))
665 (select (alien-sap (addr tv)))))
667 (unless *interrupts-enabled*
668 (note-dangerous-wait "select(2)"))
669 (select (int-sap 0)))))))
671 ;;; UNIX-SELECT accepts sets of file descriptors and waits for an event
672 ;;; to happen on one of them or to time out.
673 (declaim (inline num-to-fd-set fd-set-to-num))
674 (defun num-to-fd-set (fdset num)
677 (setf (deref (slot fdset 'fds-bits) 0) num)
678 (loop for index from 1 below (/ fd-setsize
679 sb!vm:n-machine-word-bits)
680 do (setf (deref (slot fdset 'fds-bits) index) 0)))
682 (loop for index from 0 below (/ fd-setsize
683 sb!vm:n-machine-word-bits)
684 do (setf (deref (slot fdset 'fds-bits) index)
685 (ldb (byte sb!vm:n-machine-word-bits
686 (* index sb!vm:n-machine-word-bits))
689 (defun fd-set-to-num (nfds fdset)
690 (if (<= nfds sb!vm:n-machine-word-bits)
691 (deref (slot fdset 'fds-bits) 0)
692 (loop for index below (/ fd-setsize
693 sb!vm:n-machine-word-bits)
694 sum (ash (deref (slot fdset 'fds-bits) index)
695 (* index sb!vm:n-machine-word-bits)))))
697 ;;; Examine the sets of descriptors passed as arguments to see whether
698 ;;; they are ready for reading and writing. See the UNIX Programmer's
699 ;;; Manual for more information.
700 (defun unix-select (nfds rdfds wrfds xpfds to-secs &optional (to-usecs 0))
701 (declare (type integer nfds)
702 (type unsigned-byte rdfds wrfds xpfds)
703 (type (or (unsigned-byte 31) null) to-secs)
704 (type (unsigned-byte 31) to-usecs)
705 (optimize (speed 3) (safety 0)))
706 (with-fd-setsize (nfds)
707 (with-alien ((tv (struct timeval))
708 (rdf (struct fd-set))
709 (wrf (struct fd-set))
710 (xpf (struct fd-set)))
712 (setf (slot tv 'tv-sec) to-secs
713 (slot tv 'tv-usec) to-usecs))
714 ((not *interrupts-enabled*)
715 (note-dangerous-wait "select(2)")))
716 (num-to-fd-set rdf rdfds)
717 (num-to-fd-set wrf wrfds)
718 (num-to-fd-set xpf xpfds)
719 (macrolet ((frob (lispvar alienvar)
720 `(if (zerop ,lispvar)
722 (alien-sap (addr ,alienvar)))))
723 (syscall ("sb_select" int (* (struct fd-set)) (* (struct fd-set))
724 (* (struct fd-set)) (* (struct timeval)))
726 (fd-set-to-num nfds rdf)
727 (fd-set-to-num nfds wrf)
728 (fd-set-to-num nfds xpf))
729 nfds (frob rdfds rdf) (frob wrfds wrf) (frob xpfds xpf)
730 (if to-secs (alien-sap (addr tv)) (int-sap 0)))))))
732 ;;; Lisp-side implmentations of FD_FOO macros.
733 (declaim (inline fd-set fd-clr fd-isset fd-zero))
734 (defun fd-set (offset fd-set)
735 (multiple-value-bind (word bit) (floor offset
736 sb!vm:n-machine-word-bits)
737 (setf (deref (slot fd-set 'fds-bits) word)
738 (logior (truly-the (unsigned-byte #.sb!vm:n-machine-word-bits)
740 (deref (slot fd-set 'fds-bits) word)))))
742 (defun fd-clr (offset fd-set)
743 (multiple-value-bind (word bit) (floor offset
744 sb!vm:n-machine-word-bits)
745 (setf (deref (slot fd-set 'fds-bits) word)
746 (logand (deref (slot fd-set 'fds-bits) word)
747 (sb!kernel:word-logical-not
748 (truly-the (unsigned-byte #.sb!vm:n-machine-word-bits)
751 (defun fd-isset (offset fd-set)
752 (multiple-value-bind (word bit) (floor offset
753 sb!vm:n-machine-word-bits)
754 (logbitp bit (deref (slot fd-set 'fds-bits) word))))
756 (defun fd-zero (fd-set)
757 (loop for index below (/ fd-setsize sb!vm:n-machine-word-bits)
758 do (setf (deref (slot fd-set 'fds-bits) index) 0)))
761 (defun unix-simple-poll (fd direction to-msec)
762 (multiple-value-bind (to-sec to-usec)
765 (multiple-value-bind (to-sec to-msec2) (truncate to-msec 1000)
766 (values to-sec (* to-msec2 1000))))
767 (sb!unix:with-restarted-syscall (count errno)
768 (sb!alien:with-alien ((fds (sb!alien:struct sb!unix:fd-set)))
769 (sb!unix:fd-zero fds)
770 (sb!unix:fd-set fd fds)
771 (multiple-value-bind (read-fds write-fds)
774 (values (addr fds) nil))
776 (values nil (addr fds))))
777 (sb!unix:unix-fast-select (1+ fd)
778 read-fds write-fds nil
784 (error "Syscall select(2) failed on fd ~D: ~A" fd (strerror)))))))
788 ;;; This is a structure defined in src/runtime/wrap.c, to look
789 ;;; basically like "struct stat" according to stat(2). It may not
790 ;;; actually correspond to the real in-memory stat structure that the
791 ;;; syscall uses, and that's OK. Linux in particular is packed full of
792 ;;; stat macros, and trying to keep Lisp code in correspondence with
793 ;;; it is more pain than it's worth, so we just let our C runtime
794 ;;; synthesize a nice consistent structure for us.
796 ;;; Note that st-dev is a long, not a dev-t. This is because dev-t on
797 ;;; linux 32 bit archs is a 64 bit quantity, but alien doesn't support
798 ;;; those. We don't actually access that field anywhere, though, so
799 ;;; until we can get 64 bit alien support it'll do. Also note that
800 ;;; st_size is a long, not an off-t, because off-t is a 64-bit
801 ;;; quantity on Alpha. And FIXME: "No one would want a file length
802 ;;; longer than 32 bits anyway, right?":-|
804 ;;; The comment about alien and 64-bit quantities has not been kept in
805 ;;; sync with the comment now in wrap.h (formerly wrap.c), but it's
806 ;;; not clear whether either comment is correct. -- RMK 2007-11-14.
807 (define-alien-type nil
812 (st-nlink wst-nlink-t)
817 (st-blksize wst-blksize-t)
818 (st-blocks wst-blkcnt-t)
823 ;;; shared C-struct-to-multiple-VALUES conversion for the stat(2)
824 ;;; family of Unix system calls
826 ;;; FIXME: I think this should probably not be INLINE. However, when
827 ;;; this was not inline, it seemed to cause memory corruption
828 ;;; problems. My first guess is that it's a bug in the FFI code, where
829 ;;; the WITH-ALIEN expansion doesn't deal well with being wrapped
830 ;;; around a call to a function returning >10 values. But I didn't try
831 ;;; to figure it out, just inlined it as a quick fix. Perhaps someone
832 ;;; who's motivated to debug the FFI code can go over the DISASSEMBLE
833 ;;; output in the not-inlined case and see whether there's a problem,
834 ;;; and maybe even find a fix..
835 (declaim (inline %extract-stat-results))
836 (defun %extract-stat-results (wrapped-stat)
837 (declare (type (alien (* (struct wrapped_stat))) wrapped-stat))
839 (slot wrapped-stat 'st-dev)
840 (slot wrapped-stat 'st-ino)
841 (slot wrapped-stat 'st-mode)
842 (slot wrapped-stat 'st-nlink)
843 (slot wrapped-stat 'st-uid)
844 (slot wrapped-stat 'st-gid)
845 (slot wrapped-stat 'st-rdev)
846 (slot wrapped-stat 'st-size)
847 (slot wrapped-stat 'st-atime)
848 (slot wrapped-stat 'st-mtime)
849 (slot wrapped-stat 'st-ctime)
850 (slot wrapped-stat 'st-blksize)
851 (slot wrapped-stat 'st-blocks)))
853 ;;; Unix system calls in the stat(2) family are handled by calls to
854 ;;; C-level wrapper functions which copy all the raw "struct stat"
855 ;;; slots into the system-independent wrapped_stat format.
856 ;;; stat(2) <-> stat_wrapper()
857 ;;; fstat(2) <-> fstat_wrapper()
858 ;;; lstat(2) <-> lstat_wrapper()
859 (defun unix-stat (name)
860 (declare (type unix-pathname name))
861 (with-alien ((buf (struct wrapped_stat)))
862 (syscall ("stat_wrapper" c-string (* (struct wrapped_stat)))
863 (%extract-stat-results (addr buf))
865 (defun unix-lstat (name)
866 (declare (type unix-pathname name))
867 (with-alien ((buf (struct wrapped_stat)))
868 (syscall ("lstat_wrapper" c-string (* (struct wrapped_stat)))
869 (%extract-stat-results (addr buf))
871 (defun unix-fstat (fd)
873 (declare (type unix-fd fd))
874 (#!-win32 funcall #!+win32 sb!win32::call-with-crt-fd
876 (with-alien ((buf (struct wrapped_stat)))
877 (syscall ("fstat_wrapper" int (* (struct wrapped_stat)))
878 (%extract-stat-results (addr buf))
884 (declare (type unix-fd fd))
887 (or (with-alien ((buf (struct wrapped_stat)))
888 (syscall ("fstat_wrapper" int (* (struct wrapped_stat)))
892 (cond ((logtest sb!unix:s-ififo fmt)
894 ((logtest sb!unix:s-ifchr fmt)
896 ((logtest sb!unix:s-ifdir fmt)
898 ((logtest sb!unix:s-ifblk fmt)
900 ((logtest sb!unix:s-ifreg fmt)
902 ((logtest sb!unix:s-ifsock fmt)
909 ;; used by other time functions
910 (define-alien-type nil
912 (tm-sec int) ; Seconds. [0-60] (1 leap second)
913 (tm-min int) ; Minutes. [0-59]
914 (tm-hour int) ; Hours. [0-23]
915 (tm-mday int) ; Day. [1-31]
916 (tm-mon int) ; Month. [0-11]
917 (tm-year int) ; Year - 1900.
918 (tm-wday int) ; Day of week. [0-6]
919 (tm-yday int) ; Days in year. [0-365]
920 (tm-isdst int) ; DST. [-1/0/1]
921 (tm-gmtoff long) ; Seconds east of UTC.
922 (tm-zone c-string))) ; Timezone abbreviation.
924 (define-alien-routine get-timezone sb!alien:void
926 (seconds-west sb!alien:int :out)
927 (daylight-savings-p sb!alien:boolean :out))
930 (defun nanosleep (secs nsecs)
931 (with-alien ((req (struct timespec))
932 (rem (struct timespec)))
933 (setf (slot req 'tv-sec) secs
934 (slot req 'tv-nsec) nsecs)
935 (loop while (and (eql sb!unix:eintr
937 (int-syscall ("sb_nanosleep" (* (struct timespec))
938 (* (struct timespec)))
939 (addr req) (addr rem))))
940 ;; KLUDGE: On Darwin, if an interrupt cases nanosleep to
941 ;; take longer than the requested time, the call will
942 ;; return with EINT and (unsigned)-1 seconds in the
943 ;; remainder timespec, which would cause us to enter
944 ;; nanosleep again for ~136 years. So, we check that the
945 ;; remainder time is actually decreasing.
947 ;; It would be neat to do this bit of defensive
948 ;; programming on all platforms, but unfortunately on
949 ;; Linux, REM can be a little higher than REQ if the
950 ;; nanosleep() call is interrupted quickly enough,
951 ;; probably due to the request being rounded up to the
952 ;; nearest HZ. This would cause the sleep to return way
955 (let ((rem-sec (slot rem 'tv-sec))
956 (rem-nsec (slot rem 'tv-nsec)))
957 (when (or (> secs rem-sec)
958 (and (= secs rem-sec) (>= nsecs rem-nsec)))
959 ;; Update for next round.
963 do (setf (slot req 'tv-sec) (slot rem 'tv-sec)
964 (slot req 'tv-nsec) (slot rem 'tv-nsec)))))
966 (defun unix-get-seconds-west (secs)
967 (multiple-value-bind (ignore seconds dst) (get-timezone secs)
968 (declare (ignore ignore) (ignore dst))
973 ;;; Structure crudely representing a timezone. KLUDGE: This is
974 ;;; obsolete and should never be used.
975 (define-alien-type nil
977 (tz-minuteswest int) ; minutes west of Greenwich
978 (tz-dsttime int))) ; type of dst correction
981 ;; Type of the second argument to `getitimer' and
982 ;; the second and third arguments `setitimer'.
983 (define-alien-type nil
985 (it-interval (struct timeval)) ; timer interval
986 (it-value (struct timeval)))) ; current value
988 (defconstant itimer-real 0)
989 (defconstant itimer-virtual 1)
990 (defconstant itimer-prof 2)
993 (defun unix-getitimer (which)
994 "Unix-getitimer returns the INTERVAL and VALUE slots of one of
995 three system timers (:real :virtual or :profile). On success,
996 unix-getitimer returns 5 values,
997 T, it-interval-secs, it-interval-usec, it-value-secs, it-value-usec."
998 (declare (type (member :real :virtual :profile) which)
1000 unsigned-byte (mod 1000000)
1001 unsigned-byte (mod 1000000)))
1002 (let ((which (ecase which
1004 (:virtual itimer-virtual)
1005 (:profile itimer-prof))))
1006 (with-alien ((itv (struct itimerval)))
1007 (syscall* ("sb_getitimer" int (* (struct itimerval)))
1009 (slot (slot itv 'it-interval) 'tv-sec)
1010 (slot (slot itv 'it-interval) 'tv-usec)
1011 (slot (slot itv 'it-value) 'tv-sec)
1012 (slot (slot itv 'it-value) 'tv-usec))
1013 which (alien-sap (addr itv))))))
1016 (defun unix-setitimer (which int-secs int-usec val-secs val-usec)
1017 " Unix-setitimer sets the INTERVAL and VALUE slots of one of
1018 three system timers (:real :virtual or :profile). A SIGALRM signal
1019 will be delivered VALUE <seconds+microseconds> from now. INTERVAL,
1020 when non-zero, is <seconds+microseconds> to be loaded each time
1021 the timer expires. Setting INTERVAL and VALUE to zero disables
1022 the timer. See the Unix man page for more details. On success,
1023 unix-setitimer returns the old contents of the INTERVAL and VALUE
1024 slots as in unix-getitimer."
1025 (declare (type (member :real :virtual :profile) which)
1026 (type unsigned-byte int-secs val-secs)
1027 (type (integer 0 (1000000)) int-usec val-usec)
1029 unsigned-byte (mod 1000000)
1030 unsigned-byte (mod 1000000)))
1031 (let ((which (ecase which
1033 (:virtual itimer-virtual)
1034 (:profile itimer-prof))))
1035 (with-alien ((itvn (struct itimerval))
1036 (itvo (struct itimerval)))
1037 (setf (slot (slot itvn 'it-interval) 'tv-sec ) int-secs
1038 (slot (slot itvn 'it-interval) 'tv-usec) int-usec
1039 (slot (slot itvn 'it-value ) 'tv-sec ) val-secs
1040 (slot (slot itvn 'it-value ) 'tv-usec) val-usec)
1041 (syscall* ("sb_setitimer" int (* (struct timeval))(* (struct timeval)))
1043 (slot (slot itvo 'it-interval) 'tv-sec)
1044 (slot (slot itvo 'it-interval) 'tv-usec)
1045 (slot (slot itvo 'it-value) 'tv-sec)
1046 (slot (slot itvo 'it-value) 'tv-usec))
1047 which (alien-sap (addr itvn))(alien-sap (addr itvo))))))
1050 ;;; FIXME: Many Unix error code definitions were deleted from the old
1051 ;;; CMU CL source code here, but not in the exports of SB-UNIX. I
1052 ;;; (WHN) hope that someday I'll figure out an automatic way to detect
1053 ;;; unused symbols in package exports, but if I don't, there are
1054 ;;; enough of them all in one place here that they should probably be
1055 ;;; removed by hand.
1057 (defconstant micro-seconds-per-internal-time-unit
1058 (/ 1000000 sb!xc:internal-time-units-per-second))
1060 ;;; UNIX specific code, that has been cleanly separated from the
1065 #!-sb-fluid (declaim (inline get-time-of-day))
1066 (defun get-time-of-day ()
1067 "Return the number of seconds and microseconds since the beginning of
1068 the UNIX epoch (January 1st 1970.)"
1069 #!+(or darwin netbsd)
1070 (with-alien ((tv (struct timeval)))
1071 ;; CLH: FIXME! This seems to be a MacOS bug, but on x86-64/darwin,
1072 ;; gettimeofday occasionally fails. passing in a null pointer for the
1073 ;; timezone struct seems to work around the problem. NS notes: Darwin
1074 ;; manpage says the timezone is not used anymore in their implementation
1076 (syscall* ("sb_gettimeofday" (* (struct timeval))
1077 (* (struct timezone)))
1078 (values (slot tv 'tv-sec)
1082 #!-(or darwin netbsd)
1083 (with-alien ((tv (struct timeval))
1084 (tz (struct timezone)))
1085 (syscall* ("sb_gettimeofday" (* (struct timeval))
1086 (* (struct timezone)))
1087 (values (slot tv 'tv-sec)
1092 (declaim (inline system-internal-run-time
1093 system-real-time-values))
1095 (defun system-real-time-values ()
1096 (multiple-value-bind (sec usec) (get-time-of-day)
1097 (declare (type unsigned-byte sec) (type (unsigned-byte 31) usec))
1098 (values sec (truncate usec micro-seconds-per-internal-time-unit))))
1100 ;; There are two optimizations here that actually matter (on 32-bit
1101 ;; systems): substract the epoch from seconds and milliseconds
1102 ;; separately, as those should remain fixnums for the first 17 years
1103 ;; or so of runtime. Also, avoid doing consing a new bignum if the
1104 ;; result would be = to the last result given.
1106 ;; Note: the next trick would be to spin a separate thread to update
1107 ;; a global value once per internal tick, so each individual call to
1108 ;; get-internal-real-time would be just a memory read... but that is
1109 ;; probably best left for user-level code. ;)
1111 ;; Thanks to James Anderson for the optimization hint.
1113 ;; Yes, it is possible to a computation to be GET-INTERNAL-REAL-TIME
1122 (declare (type unsigned-byte e-sec c-sec)
1123 (type fixnum e-msec c-msec)
1124 (type unsigned-byte now))
1125 (defun reinit-internal-real-time ()
1126 (setf (values e-sec e-msec) (system-real-time-values)
1129 ;; If two threads call this at the same time, we're still safe, I
1130 ;; believe, as long as NOW is updated before either of C-MSEC or
1131 ;; C-SEC. Same applies to interrupts. --NS
1133 ;; I believe this is almost correct with x86/x86-64 cache
1134 ;; coherency, but if the new value of C-SEC, C-MSEC can become
1135 ;; visible to another CPU without NOW doing the same then it's
1136 ;; unsafe. It's `almost' correct on x86 because writes by other
1137 ;; processors may become visible in any order provided transitity
1138 ;; holds. With at least three cpus, C-MSEC and C-SEC may be from
1139 ;; different threads and an incorrect value may be returned.
1140 ;; Considering that this failure is not detectable by the caller -
1141 ;; it looks like time passes a bit slowly - and that it should be
1142 ;; an extremely rare occurance I'm inclinded to leave it as it is.
1144 (defun get-internal-real-time ()
1145 (multiple-value-bind (sec msec) (system-real-time-values)
1146 (unless (and (= msec c-msec) (= sec c-sec))
1147 (setf now (+ (* (- sec e-sec)
1148 sb!xc:internal-time-units-per-second)
1154 (defun system-internal-run-time ()
1155 (multiple-value-bind (ignore utime-sec utime-usec stime-sec stime-usec)
1156 (unix-fast-getrusage rusage_self)
1157 (declare (ignore ignore)
1158 (type unsigned-byte utime-sec stime-sec)
1159 ;; (Classic CMU CL had these (MOD 1000000) instead, but
1160 ;; at least in Linux 2.2.12, the type doesn't seem to
1161 ;; be documented anywhere and the observed behavior is
1162 ;; to sometimes return 1000000 exactly.)
1163 (type fixnum utime-usec stime-usec))
1164 (let ((result (+ (* (+ utime-sec stime-sec)
1165 sb!xc:internal-time-units-per-second)
1166 (floor (+ utime-usec
1168 (floor micro-seconds-per-internal-time-unit 2))
1169 micro-seconds-per-internal-time-unit))))
1172 ;;; FIXME, KLUDGE: GET-TIME-OF-DAY used to be UNIX-GETTIMEOFDAY, and had a
1173 ;;; primary return value indicating sucess, and also returned timezone
1174 ;;; information -- though the timezone data was not there on Darwin.
1175 ;;; Now we have GET-TIME-OF-DAY, but it turns out that despite SB-UNIX being
1176 ;;; an implementation package UNIX-GETTIMEOFDAY has users in the wild.
1177 ;;; So we're stuck with it for a while -- maybe delete it towards the end
1179 (defun unix-gettimeofday ()
1180 (multiple-value-bind (sec usec) (get-time-of-day)
1181 (values t sec usec nil nil)))
1183 ;;;; opendir, readdir, closedir, and dirent-name
1185 (declaim (inline unix-opendir))
1186 (defun unix-opendir (namestring &optional (errorp t))
1187 (let ((dir (alien-funcall
1188 (extern-alien "sb_opendir"
1189 (function system-area-pointer c-string))
1191 (if (zerop (sap-int dir))
1192 (when errorp (simple-perror
1193 (format nil "Error opening directory ~S"
1197 (declaim (inline unix-readdir))
1198 (defun unix-readdir (dir &optional (errorp t) namestring)
1199 (let ((ent (alien-funcall
1200 (extern-alien "sb_readdir"
1201 (function system-area-pointer system-area-pointer))
1203 (if (zerop (sap-int ent))
1204 (when errorp (simple-perror
1205 (format nil "Error reading directory entry~@[ from ~S~]"
1209 (declaim (inline unix-closedir))
1210 (defun unix-closedir (dir &optional (errorp t) namestring)
1211 (let ((r (alien-funcall
1212 (extern-alien "sb_closedir" (function int system-area-pointer))
1215 (when errorp (simple-perror
1216 (format nil "Error closing directory~@[ ~S~]"
1220 (declaim (inline unix-dirent-name))
1221 (defun unix-dirent-name (ent)
1223 (extern-alien "sb_dirent_name" (function c-string system-area-pointer))
1226 ;;;; A magic constant for wait3().
1228 ;;;; FIXME: This used to be defined in run-program.lisp as
1229 ;;;; (defconstant wait-wstopped #-svr4 #o177 #+svr4 wait-wuntraced)
1230 ;;;; According to some of the man pages, the #o177 is part of the API
1231 ;;;; for wait3(); that said, under SunOS there is a WSTOPPED thing in
1232 ;;;; the headers that may or may not be the same thing. To be
1233 ;;;; investigated. -- CSR, 2002-03-25
1234 (defconstant wstopped #o177)