src/code/unix.lisp

   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.
   7 ;;;;
   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.
  16
  17 ;;;; This software is part of the SBCL system. See the README file for
  18 ;;;; more information.
  19 ;;;;
  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.
  25
  26 (in-package "SB!UNIX")
  27
  28 (/show0 "unix.lisp 21")
  29
  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)))
  38         (if c-string
  39             (push c-string reversed-result)
  40             (return (nreverse reversed-result)))))))
  41 \f
  42 ;;;; Lisp types used by syscalls
  43
  44 (deftype unix-pathname () 'simple-string)
  45 (deftype unix-fd () `(integer 0 ,sb!xc:most-positive-fixnum))
  46
  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))
  51 \f
  52 ;;;; system calls
  53
  54 (/show0 "unix.lisp 74")
  55
  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.
  59 ;;;
  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?
  63
  64 (defmacro syscall ((name &rest arg-types) success-form &rest args)
  65   `(locally
  66     (declare (optimize (sb!c::float-accuracy 0)))
  67     (let ((result (alien-funcall (extern-alien ,name (function int ,@arg-types))
  68                                 ,@args)))
  69       (if (minusp result)
  70           (values nil (get-errno))
  71           ,success-form))))
  72
  73 ;;; This is like SYSCALL, but if it fails, signal an error instead of
  74 ;;; returning error codes. Should only be used for syscalls that will
  75 ;;; never really get an error.
  76 (defmacro syscall* ((name &rest arg-types) success-form &rest args)
  77   `(locally
  78     (declare (optimize (sb!c::float-accuracy 0)))
  79     (let ((result (alien-funcall (extern-alien ,name (function int ,@arg-types))
  80                                  ,@args)))
  81       (if (minusp result)
  82           (error "Syscall ~A failed: ~A" ,name (strerror))
  83           ,success-form))))
  84
  85 (defmacro int-syscall ((name &rest arg-types) &rest args)
  86   `(syscall (,name ,@arg-types) (values result 0) ,@args))
  87
  88 (defmacro with-restarted-syscall ((&optional (value (gensym))
  89                                              (errno (gensym)))
  90                                   syscall-form &rest body)
  91   #!+sb-doc
  92   "Evaluate BODY with VALUE and ERRNO bound to the return values of
  93 SYSCALL-FORM. Repeat evaluation of SYSCALL-FORM if it is interrupted."
  94   `(let (,value ,errno)
  95      (loop (multiple-value-setq (,value ,errno)
  96              ,syscall-form)
  97         (unless #!-win32 (eql ,errno sb!unix:eintr) #!+win32 nil
  98           (return (values ,value ,errno))))
  99      ,@body))
 100
 101 (defmacro void-syscall ((name &rest arg-types) &rest args)
 102   `(syscall (,name ,@arg-types) (values t 0) ,@args))
 103
 104 #!+win32
 105 (progn
 106   (defconstant espipe 29))
 107 \f
 108 ;;;; hacking the Unix environment
 109
 110 #!-win32
 111 (define-alien-routine ("getenv" posix-getenv) c-string
 112   "Return the \"value\" part of the environment string \"name=value\" which
 113 corresponds to NAME, or NIL if there is none."
 114   (name c-string))
 115 \f
 116 ;;; from stdio.h
 117
 118 ;;; Rename the file with string NAME1 to the string NAME2. NIL and an
 119 ;;; error code is returned if an error occurs.
 120 #!-win32
 121 (defun unix-rename (name1 name2)
 122   (declare (type unix-pathname name1 name2))
 123   (void-syscall ("rename" c-string c-string) name1 name2))
 124 \f
 125 ;;; from sys/types.h and gnu/types.h
 126
 127 (/show0 "unix.lisp 220")
 128
 129 ;;; FIXME: We shouldn't hand-copy types from header files into Lisp
 130 ;;; like this unless we have extreme provocation. Reading directories
 131 ;;; is not extreme enough, since it doesn't need to be blindingly
 132 ;;; fast: we can just implement those functions in C as a wrapper
 133 ;;; layer.
 134 (define-alien-type fd-mask unsigned-long)
 135
 136 (eval-when (:compile-toplevel :load-toplevel :execute)
 137   (defconstant fd-setsize 1024))
 138
 139 (define-alien-type nil
 140   (struct fd-set
 141           (fds-bits (array fd-mask #.(/ fd-setsize
 142                                         sb!vm:n-machine-word-bits)))))
 143
 144 (/show0 "unix.lisp 304")
 145 \f
 146 \f
 147 ;;;; fcntl.h
 148 ;;;;
 149 ;;;; POSIX Standard: 6.5 File Control Operations        <fcntl.h>
 150
 151 ;;; Open the file whose pathname is specified by PATH for reading
 152 ;;; and/or writing as specified by the FLAGS argument. Various FLAGS
 153 ;;; masks (O_RDONLY etc.) are defined in fcntlbits.h.
 154 ;;;
 155 ;;; If the O_CREAT flag is specified, then the file is created with a
 156 ;;; permission of argument MODE if the file doesn't exist. An integer
 157 ;;; file descriptor is returned by UNIX-OPEN.
 158 (defun unix-open (path flags mode)
 159   (declare (type unix-pathname path)
 160            (type fixnum flags)
 161            (type unix-file-mode mode))
 162   (int-syscall ("open" c-string int int)
 163                path
 164                (logior #!+win32 o_binary
 165                        #!+largefile o_largefile
 166                        flags)
 167                mode))
 168
 169 ;;; UNIX-CLOSE accepts a file descriptor and attempts to close the file
 170 ;;; associated with it.
 171 (/show0 "unix.lisp 391")
 172 (defun unix-close (fd)
 173   (declare (type unix-fd fd))
 174   (void-syscall ("close" int) fd))
 175 \f
 176 ;;;; stdlib.h
 177
 178 ;;; There are good reasons to implement some OPEN options with an
 179 ;;; mkstemp(3)-like routine, but we don't do that yet.  Instead, this
 180 ;;; function is used only to make a temporary file for RUN-PROGRAM.
 181 ;;; sb_mkstemp() is a wrapper that lives in src/runtime/wrap.c.  Since
 182 ;;; SUSv3 mkstemp() doesn't specify the mode of the created file and
 183 ;;; since we have to implement most of this ourselves for Windows
 184 ;;; anyway, it seems worthwhile to depart from the mkstemp()
 185 ;;; specification by taking a mode to use when creating the new file.
 186 (defun sb-mkstemp (template-string mode)
 187   (declare (type string template-string)
 188            (type unix-file-mode mode))
 189   (let ((template-buffer (string-to-octets template-string :null-terminate t)))
 190     (with-pinned-objects (template-buffer)
 191       (let ((fd (alien-funcall (extern-alien "sb_mkstemp"
 192                                              (function int (* char) int))
 193                                (vector-sap template-buffer)
 194                                mode)))
 195         (if (minusp fd)
 196             (values nil (get-errno))
 197             (values fd (octets-to-string template-buffer)))))))
 198 \f
 199 ;;;; timebits.h
 200
 201 ;; A time value that is accurate to the nearest
 202 ;; microsecond but also has a range of years.
 203 ;; CLH: Note that tv-usec used to be a time-t, but that this seems
 204 ;; problematic on Darwin x86-64 (and wrong). Trying suseconds-t.
 205 #!-(or win32 openbsd netbsd)
 206 (define-alien-type nil
 207   (struct timeval
 208           (tv-sec time-t)           ; seconds
 209           (tv-usec suseconds-t)))   ; and microseconds
 210
 211 ;; The above definition doesn't work on 64-bit OpenBSD platforms.
 212 ;; Both tv_sec and tv_usec are declared as long instead of time_t, and
 213 ;; time_t is a typedef for int.
 214 #!+(or openbsd netbsd)
 215 (define-alien-type nil
 216   (struct timeval
 217           (tv-sec long)             ; seconds
 218           (tv-usec long)))          ; and microseconds
 219
 220 #!+win32
 221 (define-alien-type nil
 222   (struct timeval
 223           (tv-sec time-t)           ; seconds
 224           (tv-usec long)))          ; and microseconds
 225 \f
 226 ;;;; resourcebits.h
 227
 228 (defconstant rusage_self 0) ; the calling process
 229 (defconstant rusage_children -1) ; terminated child processes
 230 (defconstant rusage_both -2)
 231
 232 (define-alien-type nil
 233   (struct rusage
 234     (ru-utime (struct timeval))     ; user time used
 235     (ru-stime (struct timeval))     ; system time used.
 236     (ru-maxrss long)                ; maximum resident set size (in kilobytes)
 237     (ru-ixrss long)                 ; integral shared memory size
 238     (ru-idrss long)                 ; integral unshared data size
 239     (ru-isrss long)                 ; integral unshared stack size
 240     (ru-minflt long)                ; page reclaims
 241     (ru-majflt long)                ; page faults
 242     (ru-nswap long)                 ; swaps
 243     (ru-inblock long)               ; block input operations
 244     (ru-oublock long)               ; block output operations
 245     (ru-msgsnd long)                ; messages sent
 246     (ru-msgrcv long)                ; messages received
 247     (ru-nsignals long)              ; signals received
 248     (ru-nvcsw long)                 ; voluntary context switches
 249     (ru-nivcsw long)))              ; involuntary context switches
 250 \f
 251 ;;;; unistd.h
 252
 253 ;;; Given a file path (a string) and one of four constant modes,
 254 ;;; return T if the file is accessible with that mode and NIL if not.
 255 ;;; When NIL, also return an errno value with NIL which tells why the
 256 ;;; file was not accessible.
 257 ;;;
 258 ;;; The access modes are:
 259 ;;;   r_ok     Read permission.
 260 ;;;   w_ok     Write permission.
 261 ;;;   x_ok     Execute permission.
 262 ;;;   f_ok     Presence of file.
 263
 264 ;;; In Windows, the MODE argument to access is defined in terms of
 265 ;;; literal magic numbers---there are no constants to grovel.  X_OK
 266 ;;; is not defined.
 267 #!+win32
 268 (progn
 269   (defconstant f_ok 0)
 270   (defconstant w_ok 2)
 271   (defconstant r_ok 4))
 272
 273 (defun unix-access (path mode)
 274   (declare (type unix-pathname path)
 275            (type (mod 8) mode))
 276   (void-syscall ("access" c-string int) path mode))
 277
 278 ;;; values for the second argument to UNIX-LSEEK
 279 (defconstant l_set 0) ; to set the file pointer
 280 (defconstant l_incr 1) ; to increment the file pointer
 281 (defconstant l_xtnd 2) ; to extend the file size
 282
 283 ;;; Is a stream interactive?
 284 (defun unix-isatty (fd)
 285   (declare (type unix-fd fd))
 286   (int-syscall ("isatty" int) fd))
 287
 288 (defun unix-lseek (fd offset whence)
 289   "Unix-lseek accepts a file descriptor and moves the file pointer by
 290    OFFSET octets.  Whence can be any of the following:
 291
 292    L_SET        Set the file pointer.
 293    L_INCR       Increment the file pointer.
 294    L_XTND       Extend the file size.
 295   "
 296   (declare (type unix-fd fd)
 297            (type (integer 0 2) whence))
 298   (let ((result (alien-funcall (extern-alien #!-largefile "lseek"
 299                                              #!+largefile "lseek_largefile"
 300                                              (function off-t int off-t int))
 301                  fd offset whence)))
 302     (if (minusp result)
 303         (values nil (get-errno))
 304       (values result 0))))
 305
 306 ;;; UNIX-READ accepts a file descriptor, a buffer, and the length to read.
 307 ;;; It attempts to read len bytes from the device associated with fd
 308 ;;; and store them into the buffer. It returns the actual number of
 309 ;;; bytes read.
 310
 311 #!-sb!fluid
 312 (declaim (maybe-inline unix-read))
 313
 314 (defun unix-read (fd buf len)
 315   (declare (type unix-fd fd)
 316            (type (unsigned-byte 32) len))
 317   (int-syscall ("read" int (* char) int) fd buf len))
 318
 319 ;;; UNIX-WRITE accepts a file descriptor, a buffer, an offset, and the
 320 ;;; length to write. It attempts to write len bytes to the device
 321 ;;; associated with fd from the buffer starting at offset. It returns
 322 ;;; the actual number of bytes written.
 323 (defun unix-write (fd buf offset len)
 324   (declare (type unix-fd fd)
 325            (type (unsigned-byte 32) offset len))
 326   (flet ((%write (sap)
 327            (declare (system-area-pointer sap))
 328            (int-syscall ("write" int (* char) int)
 329                         fd
 330                         (with-alien ((ptr (* char) sap))
 331                           (addr (deref ptr offset)))
 332                         len)))
 333     (etypecase buf
 334       ((simple-array * (*))
 335        (with-pinned-objects (buf)
 336          (%write (vector-sap buf))))
 337       (system-area-pointer
 338        (%write buf)))))
 339
 340 ;;; Set up a unix-piping mechanism consisting of an input pipe and an
 341 ;;; output pipe. Return two values: if no error occurred the first
 342 ;;; value is the pipe to be read from and the second is can be written
 343 ;;; to. If an error occurred the first value is NIL and the second the
 344 ;;; unix error code.
 345 #!-win32
 346 (defun unix-pipe ()
 347   (with-alien ((fds (array int 2)))
 348     (syscall ("pipe" (* int))
 349              (values (deref fds 0) (deref fds 1))
 350              (cast fds (* int)))))
 351 #!+win32
 352 (defun msvcrt-raw-pipe (fds size mode)
 353   (syscall ("_pipe" (* int) int int)
 354            (values (deref fds 0) (deref fds 1))
 355            (cast fds (* int)) size mode))
 356 #!+win32
 357 (defun unix-pipe ()
 358   (with-alien ((fds (array int 2)))
 359     (msvcrt-raw-pipe fds 256 o_binary)))
 360
 361 ;; Windows mkdir() doesn't take the mode argument. It's cdecl, so we could
 362 ;; actually call it passing the mode argument, but some sharp-eyed reader
 363 ;; would put five and twenty-seven together and ask us about it, so...
 364 ;;    -- AB, 2005-12-27
 365 #!-win32
 366 (defun unix-mkdir (name mode)
 367   (declare (type unix-pathname name)
 368            (type unix-file-mode mode)
 369            #!+win32 (ignore mode))
 370   (void-syscall ("mkdir" c-string #!-win32 int) name #!-win32 mode))
 371
 372 ;;; Given a C char* pointer allocated by malloc(), free it and return a
 373 ;;; corresponding Lisp string (or return NIL if the pointer is a C NULL).
 374 (defun newcharstar-string (newcharstar)
 375   (declare (type (alien (* char)) newcharstar))
 376   (if (null-alien newcharstar)
 377       nil
 378       (prog1
 379           (cast newcharstar c-string)
 380         (free-alien newcharstar))))
 381
 382 ;;; Return the Unix current directory as a SIMPLE-STRING, in the
 383 ;;; style returned by getcwd() (no trailing slash character).
 384 #!-win32
 385 (defun posix-getcwd ()
 386   ;; This implementation relies on a BSD/Linux extension to getcwd()
 387   ;; behavior, automatically allocating memory when a null buffer
 388   ;; pointer is used. On a system which doesn't support that
 389   ;; extension, it'll have to be rewritten somehow.
 390   ;;
 391   ;; SunOS and OSF/1 provide almost as useful an extension: if given a null
 392   ;; buffer pointer, it will automatically allocate size space. The
 393   ;; KLUDGE in this solution arises because we have just read off
 394   ;; PATH_MAX+1 from the Solaris header files and stuck it in here as
 395   ;; a constant. Going the grovel_headers route doesn't seem to be
 396   ;; helpful, either, as Solaris doesn't export PATH_MAX from
 397   ;; unistd.h.
 398   ;;
 399   ;; FIXME: The (,stub,) nastiness produces an error message about a
 400   ;; comma not inside a backquote. This error has absolutely nothing
 401   ;; to do with the actual meaning of the error (and little to do with
 402   ;; its location, either).
 403   #!-(or linux openbsd freebsd netbsd sunos osf1 darwin hpux win32) (,stub,)
 404   #!+(or linux openbsd freebsd netbsd sunos osf1 darwin hpux win32)
 405   (or (newcharstar-string (alien-funcall (extern-alien "getcwd"
 406                                                        (function (* char)
 407                                                                  (* char)
 408                                                                  size-t))
 409                                          nil
 410                                          #!+(or linux openbsd freebsd netbsd darwin win32) 0
 411                                          #!+(or sunos osf1 hpux) 1025))
 412       (simple-perror "getcwd")))
 413
 414 ;;; Return the Unix current directory as a SIMPLE-STRING terminated
 415 ;;; by a slash character.
 416 (defun posix-getcwd/ ()
 417   (concatenate 'string (posix-getcwd) "/"))
 418
 419 ;;; Duplicate an existing file descriptor (given as the argument) and
 420 ;;; return it. If FD is not a valid file descriptor, NIL and an error
 421 ;;; number are returned.
 422 (defun unix-dup (fd)
 423   (declare (type unix-fd fd))
 424   (int-syscall ("dup" int) fd))
 425
 426 ;;; Terminate the current process with an optional error code. If
 427 ;;; successful, the call doesn't return. If unsuccessful, the call
 428 ;;; returns NIL and an error number.
 429 (defun unix-exit (&optional (code 0))
 430   (declare (type (signed-byte 32) code))
 431   (void-syscall ("exit" int) code))
 432
 433 ;;; Return the process id of the current process.
 434 (define-alien-routine ("getpid" unix-getpid) int)
 435
 436 ;;; Return the real user id associated with the current process.
 437 #!-win32
 438 (define-alien-routine ("getuid" unix-getuid) int)
 439
 440 ;;; Translate a user id into a login name.
 441 #!-win32
 442 (defun uid-username (uid)
 443   (or (newcharstar-string (alien-funcall (extern-alien "uid_username"
 444                                                        (function (* char) int))
 445                                          uid))
 446       (error "found no match for Unix uid=~S" uid)))
 447
 448 ;;; Return the namestring of the home directory, being careful to
 449 ;;; include a trailing #\/
 450 #!-win32
 451 (defun uid-homedir (uid)
 452   (or (newcharstar-string (alien-funcall (extern-alien "uid_homedir"
 453                                                        (function (* char) int))
 454                                          uid))
 455       (error "failed to resolve home directory for Unix uid=~S" uid)))
 456
 457 ;;; Invoke readlink(2) on the file name specified by PATH. Return
 458 ;;; (VALUES LINKSTRING NIL) on success, or (VALUES NIL ERRNO) on
 459 ;;; failure.
 460 #!-win32
 461 (defun unix-readlink (path)
 462   (declare (type unix-pathname path))
 463   (with-alien ((ptr (* char)
 464                     (alien-funcall (extern-alien
 465                                     "wrapped_readlink"
 466                                     (function (* char) c-string))
 467                                    path)))
 468     (if (null-alien ptr)
 469         (values nil (get-errno))
 470         (multiple-value-prog1
 471             (values (with-alien ((c-string c-string ptr)) c-string)
 472                     nil)
 473           (free-alien ptr)))))
 474 #!+win32
 475 ;; Win32 doesn't do links, but something likes to call this anyway.
 476 ;; Something in this file, no less. But it only takes one result, so...
 477 (defun unix-readlink (path)
 478   (declare (ignore path))
 479   nil)
 480
 481 (defun unix-realpath (path)
 482   (declare (type unix-pathname path))
 483   (with-alien ((ptr (* char)
 484                     (alien-funcall (extern-alien
 485                                     "sb_realpath"
 486                                     (function (* char) c-string))
 487                                    path)))
 488     (if (null-alien ptr)
 489         (values nil (get-errno))
 490         (multiple-value-prog1
 491             (values (with-alien ((c-string c-string ptr)) c-string)
 492                     nil)
 493           (free-alien ptr)))))
 494
 495 ;;; UNIX-UNLINK accepts a name and deletes the directory entry for that
 496 ;;; name and the file if this is the last link.
 497 (defun unix-unlink (name)
 498   (declare (type unix-pathname name))
 499   (void-syscall ("unlink" c-string) name))
 500
 501 ;;; Return the name of the host machine as a string.
 502 #!-win32
 503 (defun unix-gethostname ()
 504   (with-alien ((buf (array char 256)))
 505     (syscall ("gethostname" (* char) int)
 506              (cast buf c-string)
 507              (cast buf (* char)) 256)))
 508
 509 #!-win32
 510 (defun unix-setsid ()
 511   (int-syscall ("setsid")))
 512
 513 ;;;; sys/ioctl.h
 514
 515 ;;; UNIX-IOCTL performs a variety of operations on open i/o
 516 ;;; descriptors. See the UNIX Programmer's Manual for more
 517 ;;; information.
 518 #!-win32
 519 (defun unix-ioctl (fd cmd arg)
 520   (declare (type unix-fd fd)
 521            (type (signed-byte 32) cmd))
 522   (void-syscall ("ioctl" int int (* char)) fd cmd arg))
 523 \f
 524 ;;;; sys/resource.h
 525
 526 ;;; FIXME: All we seem to need is the RUSAGE_SELF version of this.
 527 ;;;
 528 ;;; This is like getrusage(2), except it returns only the system and
 529 ;;; user time, and returns the seconds and microseconds as separate
 530 ;;; values.
 531 #!-sb-fluid (declaim (inline unix-fast-getrusage))
 532 #!-win32
 533 (defun unix-fast-getrusage (who)
 534   (declare (values (member t)
 535                    (unsigned-byte 31) (integer 0 1000000)
 536                    (unsigned-byte 31) (integer 0 1000000)))
 537   (with-alien ((usage (struct rusage)))
 538     (syscall* ("getrusage" int (* (struct rusage)))
 539               (values t
 540                       (slot (slot usage 'ru-utime) 'tv-sec)
 541                       (slot (slot usage 'ru-utime) 'tv-usec)
 542                       (slot (slot usage 'ru-stime) 'tv-sec)
 543                       (slot (slot usage 'ru-stime) 'tv-usec))
 544               who (addr usage))))
 545
 546 ;;; Return information about the resource usage of the process
 547 ;;; specified by WHO. WHO can be either the current process
 548 ;;; (rusage_self) or all of the terminated child processes
 549 ;;; (rusage_children). NIL and an error number is returned if the call
 550 ;;; fails.
 551 #!-win32
 552 (defun unix-getrusage (who)
 553   (with-alien ((usage (struct rusage)))
 554     (syscall ("getrusage" int (* (struct rusage)))
 555               (values t
 556                       (+ (* (slot (slot usage 'ru-utime) 'tv-sec) 1000000)
 557                          (slot (slot usage 'ru-utime) 'tv-usec))
 558                       (+ (* (slot (slot usage 'ru-stime) 'tv-sec) 1000000)
 559                          (slot (slot usage 'ru-stime) 'tv-usec))
 560                       (slot usage 'ru-maxrss)
 561                       (slot usage 'ru-ixrss)
 562                       (slot usage 'ru-idrss)
 563                       (slot usage 'ru-isrss)
 564                       (slot usage 'ru-minflt)
 565                       (slot usage 'ru-majflt)
 566                       (slot usage 'ru-nswap)
 567                       (slot usage 'ru-inblock)
 568                       (slot usage 'ru-oublock)
 569                       (slot usage 'ru-msgsnd)
 570                       (slot usage 'ru-msgrcv)
 571                       (slot usage 'ru-nsignals)
 572                       (slot usage 'ru-nvcsw)
 573                       (slot usage 'ru-nivcsw))
 574               who (addr usage))))
 575 \f
 576 ;;;; sys/select.h
 577
 578 (defvar *on-dangerous-select* :warn)
 579
 580 ;;; Calling select in a bad place can hang in a nasty manner, so it's better
 581 ;;; to have some way to detect these.
 582 (defun note-dangerous-select ()
 583   (let ((action *on-dangerous-select*)
 584         (*on-dangerous-select* nil))
 585     (case action
 586       (:warn
 587        (warn "Starting a select without a timeout while interrupts are ~
 588              disabled."))
 589       (:error
 590        (error "Starting a select without a timeout while interrupts are ~
 591               disabled."))
 592       (:backtrace
 593        (write-line
 594         "=== Starting a select without a timeout while interrupts are disabled. ==="
 595         *debug-io*)
 596        (sb!debug:backtrace)))
 597     nil))
 598
 599 ;;;; FIXME: Why have both UNIX-SELECT and UNIX-FAST-SELECT?
 600
 601 ;;; Perform the UNIX select(2) system call.
 602 (declaim (inline unix-fast-select))
 603 (defun unix-fast-select (num-descriptors
 604                          read-fds write-fds exception-fds
 605                          timeout-secs timeout-usecs)
 606   (declare (type (integer 0 #.fd-setsize) num-descriptors)
 607            (type (or (alien (* (struct fd-set))) null)
 608                  read-fds write-fds exception-fds)
 609            (type (or null (unsigned-byte 31)) timeout-secs timeout-usecs))
 610   (flet ((select (tv-sap)
 611            (int-syscall ("select" int (* (struct fd-set)) (* (struct fd-set))
 612                                   (* (struct fd-set)) (* (struct timeval)))
 613                         num-descriptors read-fds write-fds exception-fds
 614                         tv-sap)))
 615     (cond ((or timeout-secs timeout-usecs)
 616            (with-alien ((tv (struct timeval)))
 617              (setf (slot tv 'tv-sec) (or timeout-secs 0))
 618              (setf (slot tv 'tv-usec) (or timeout-usecs 0))
 619              (select (alien-sap (addr tv)))))
 620           (t
 621            (unless *interrupts-enabled*
 622              (note-dangerous-select))
 623            (select (int-sap 0))))))
 624
 625 ;;; UNIX-SELECT accepts sets of file descriptors and waits for an event
 626 ;;; to happen on one of them or to time out.
 627 (defmacro num-to-fd-set (fdset num)
 628   `(if (fixnump ,num)
 629        (progn
 630          (setf (deref (slot ,fdset 'fds-bits) 0) ,num)
 631          ,@(loop for index upfrom 1 below (/ fd-setsize
 632                                              sb!vm:n-machine-word-bits)
 633              collect `(setf (deref (slot ,fdset 'fds-bits) ,index) 0)))
 634        (progn
 635          ,@(loop for index upfrom 0 below (/ fd-setsize
 636                                              sb!vm:n-machine-word-bits)
 637              collect `(setf (deref (slot ,fdset 'fds-bits) ,index)
 638                             (ldb (byte sb!vm:n-machine-word-bits
 639                                        ,(* index sb!vm:n-machine-word-bits))
 640                                  ,num))))))
 641
 642 (defmacro fd-set-to-num (nfds fdset)
 643   `(if (<= ,nfds sb!vm:n-machine-word-bits)
 644        (deref (slot ,fdset 'fds-bits) 0)
 645        (+ ,@(loop for index upfrom 0 below (/ fd-setsize
 646                                               sb!vm:n-machine-word-bits)
 647               collect `(ash (deref (slot ,fdset 'fds-bits) ,index)
 648                             ,(* index sb!vm:n-machine-word-bits))))))
 649
 650 ;;; Examine the sets of descriptors passed as arguments to see whether
 651 ;;; they are ready for reading and writing. See the UNIX Programmer's
 652 ;;; Manual for more information.
 653 (defun unix-select (nfds rdfds wrfds xpfds to-secs &optional (to-usecs 0))
 654   (declare (type (integer 0 #.fd-setsize) nfds)
 655            (type unsigned-byte rdfds wrfds xpfds)
 656            (type (or (unsigned-byte 31) null) to-secs)
 657            (type (unsigned-byte 31) to-usecs)
 658            (optimize (speed 3) (safety 0) (inhibit-warnings 3)))
 659   (with-alien ((tv (struct timeval))
 660                (rdf (struct fd-set))
 661                (wrf (struct fd-set))
 662                (xpf (struct fd-set)))
 663     (cond (to-secs
 664            (setf (slot tv 'tv-sec) to-secs
 665                  (slot tv 'tv-usec) to-usecs))
 666           ((not *interrupts-enabled*)
 667            (note-dangerous-select)))
 668     (num-to-fd-set rdf rdfds)
 669     (num-to-fd-set wrf wrfds)
 670     (num-to-fd-set xpf xpfds)
 671     (macrolet ((frob (lispvar alienvar)
 672                  `(if (zerop ,lispvar)
 673                       (int-sap 0)
 674                       (alien-sap (addr ,alienvar)))))
 675       (syscall ("select" int (* (struct fd-set)) (* (struct fd-set))
 676                          (* (struct fd-set)) (* (struct timeval)))
 677                (values result
 678                        (fd-set-to-num nfds rdf)
 679                        (fd-set-to-num nfds wrf)
 680                        (fd-set-to-num nfds xpf))
 681                nfds (frob rdfds rdf) (frob wrfds wrf) (frob xpfds xpf)
 682                (if to-secs (alien-sap (addr tv)) (int-sap 0))))))
 683 \f
 684 ;;;; sys/stat.h
 685
 686 ;;; This is a structure defined in src/runtime/wrap.c, to look
 687 ;;; basically like "struct stat" according to stat(2). It may not
 688 ;;; actually correspond to the real in-memory stat structure that the
 689 ;;; syscall uses, and that's OK. Linux in particular is packed full of
 690 ;;; stat macros, and trying to keep Lisp code in correspondence with
 691 ;;; it is more pain than it's worth, so we just let our C runtime
 692 ;;; synthesize a nice consistent structure for us.
 693 ;;;
 694 ;;; Note that st-dev is a long, not a dev-t. This is because dev-t on
 695 ;;; linux 32 bit archs is a 64 bit quantity, but alien doesn't support
 696 ;;; those. We don't actually access that field anywhere, though, so
 697 ;;; until we can get 64 bit alien support it'll do. Also note that
 698 ;;; st_size is a long, not an off-t, because off-t is a 64-bit
 699 ;;; quantity on Alpha. And FIXME: "No one would want a file length
 700 ;;; longer than 32 bits anyway, right?":-|
 701 ;;;
 702 ;;; The comment about alien and 64-bit quantities has not been kept in
 703 ;;; sync with the comment now in wrap.h (formerly wrap.c), but it's
 704 ;;; not clear whether either comment is correct.  -- RMK 2007-11-14.
 705 (define-alien-type nil
 706   (struct wrapped_stat
 707     (st-dev wst-dev-t)
 708     (st-ino ino-t)
 709     (st-mode mode-t)
 710     (st-nlink wst-nlink-t)
 711     (st-uid wst-uid-t)
 712     (st-gid wst-gid-t)
 713     (st-rdev wst-dev-t)
 714     (st-size wst-off-t)
 715     (st-blksize wst-blksize-t)
 716     (st-blocks wst-blkcnt-t)
 717     (st-atime time-t)
 718     (st-mtime time-t)
 719     (st-ctime time-t)))
 720
 721 ;;; shared C-struct-to-multiple-VALUES conversion for the stat(2)
 722 ;;; family of Unix system calls
 723 ;;;
 724 ;;; FIXME: I think this should probably not be INLINE. However, when
 725 ;;; this was not inline, it seemed to cause memory corruption
 726 ;;; problems. My first guess is that it's a bug in the FFI code, where
 727 ;;; the WITH-ALIEN expansion doesn't deal well with being wrapped
 728 ;;; around a call to a function returning >10 values. But I didn't try
 729 ;;; to figure it out, just inlined it as a quick fix. Perhaps someone
 730 ;;; who's motivated to debug the FFI code can go over the DISASSEMBLE
 731 ;;; output in the not-inlined case and see whether there's a problem,
 732 ;;; and maybe even find a fix..
 733 (declaim (inline %extract-stat-results))
 734 (defun %extract-stat-results (wrapped-stat)
 735   (declare (type (alien (* (struct wrapped_stat))) wrapped-stat))
 736   (values t
 737           (slot wrapped-stat 'st-dev)
 738           (slot wrapped-stat 'st-ino)
 739           (slot wrapped-stat 'st-mode)
 740           (slot wrapped-stat 'st-nlink)
 741           (slot wrapped-stat 'st-uid)
 742           (slot wrapped-stat 'st-gid)
 743           (slot wrapped-stat 'st-rdev)
 744           (slot wrapped-stat 'st-size)
 745           (slot wrapped-stat 'st-atime)
 746           (slot wrapped-stat 'st-mtime)
 747           (slot wrapped-stat 'st-ctime)
 748           (slot wrapped-stat 'st-blksize)
 749           (slot wrapped-stat 'st-blocks)))
 750
 751 ;;; Unix system calls in the stat(2) family are handled by calls to
 752 ;;; C-level wrapper functions which copy all the raw "struct stat"
 753 ;;; slots into the system-independent wrapped_stat format.
 754 ;;;    stat(2) <->  stat_wrapper()
 755 ;;;   fstat(2) <-> fstat_wrapper()
 756 ;;;   lstat(2) <-> lstat_wrapper()
 757 (defun unix-stat (name)
 758   (declare (type unix-pathname name))
 759   (with-alien ((buf (struct wrapped_stat)))
 760     (syscall ("stat_wrapper" c-string (* (struct wrapped_stat)))
 761              (%extract-stat-results (addr buf))
 762              name (addr buf))))
 763 (defun unix-lstat (name)
 764   (declare (type unix-pathname name))
 765   (with-alien ((buf (struct wrapped_stat)))
 766     (syscall ("lstat_wrapper" c-string (* (struct wrapped_stat)))
 767              (%extract-stat-results (addr buf))
 768              name (addr buf))))
 769 (defun unix-fstat (fd)
 770   (declare (type unix-fd fd))
 771   (with-alien ((buf (struct wrapped_stat)))
 772     (syscall ("fstat_wrapper" int (* (struct wrapped_stat)))
 773              (%extract-stat-results (addr buf))
 774              fd (addr buf))))
 775 \f
 776 ;;;; time.h
 777
 778 ;; the POSIX.4 structure for a time value. This is like a "struct
 779 ;; timeval" but has nanoseconds instead of microseconds.
 780 #!-(or openbsd netbsd)
 781 (define-alien-type nil
 782     (struct timespec
 783             (tv-sec long)   ; seconds
 784             (tv-nsec long))) ; nanoseconds
 785
 786 ;; Just as with struct timeval, 64-bit OpenBSD has problems with the
 787 ;; above definition.  tv_sec is declared as time_t instead of long,
 788 ;; and time_t is a typedef for int.
 789 #!+(or openbsd netbsd)
 790 (define-alien-type nil
 791     (struct timespec
 792             (tv-sec time-t)  ; seconds
 793             (tv-nsec long))) ; nanoseconds
 794
 795 ;; used by other time functions
 796 (define-alien-type nil
 797     (struct tm
 798             (tm-sec int)   ; Seconds.   [0-60] (1 leap second)
 799             (tm-min int)   ; Minutes.   [0-59]
 800             (tm-hour int)  ; Hours.     [0-23]
 801             (tm-mday int)  ; Day.       [1-31]
 802             (tm-mon int)   ; Month.     [0-11]
 803             (tm-year int)  ; Year - 1900.
 804             (tm-wday int)  ; Day of week. [0-6]
 805             (tm-yday int)  ; Days in year. [0-365]
 806             (tm-isdst int) ; DST.       [-1/0/1]
 807             (tm-gmtoff long) ;  Seconds east of UTC.
 808             (tm-zone c-string))) ; Timezone abbreviation.
 809
 810 (define-alien-routine get-timezone sb!alien:void
 811   (when sb!alien:long :in)
 812   (seconds-west sb!alien:int :out)
 813   (daylight-savings-p sb!alien:boolean :out))
 814
 815 #!-win32
 816 (defun nanosleep (secs nsecs)
 817   (with-alien ((req (struct timespec))
 818                (rem (struct timespec)))
 819     (setf (slot req 'tv-sec) secs)
 820     (setf (slot req 'tv-nsec) nsecs)
 821     (loop while (eql sb!unix:eintr
 822                      (nth-value 1
 823                                 (int-syscall ("nanosleep" (* (struct timespec))
 824                                                           (* (struct timespec)))
 825                                              (addr req) (addr rem))))
 826        do (rotatef req rem))))
 827
 828 (defun unix-get-seconds-west (secs)
 829   (multiple-value-bind (ignore seconds dst) (get-timezone secs)
 830     (declare (ignore ignore) (ignore dst))
 831     (values seconds)))
 832 \f
 833 ;;;; sys/time.h
 834
 835 ;;; Structure crudely representing a timezone. KLUDGE: This is
 836 ;;; obsolete and should never be used.
 837 (define-alien-type nil
 838   (struct timezone
 839     (tz-minuteswest int)                ; minutes west of Greenwich
 840     (tz-dsttime int)))                  ; type of dst correction
 841 \f
 842
 843 ;; Type of the second argument to `getitimer' and
 844 ;; the second and third arguments `setitimer'.
 845 (define-alien-type nil
 846   (struct itimerval
 847     (it-interval (struct timeval))      ; timer interval
 848     (it-value (struct timeval))))       ; current value
 849
 850 (defconstant itimer-real 0)
 851 (defconstant itimer-virtual 1)
 852 (defconstant itimer-prof 2)
 853
 854 #!-win32
 855 (defun unix-getitimer (which)
 856   "Unix-getitimer returns the INTERVAL and VALUE slots of one of
 857    three system timers (:real :virtual or :profile). On success,
 858    unix-getitimer returns 5 values,
 859    T, it-interval-secs, it-interval-usec, it-value-secs, it-value-usec."
 860   (declare (type (member :real :virtual :profile) which)
 861            (values t
 862                    (unsigned-byte 29) (mod 1000000)
 863                    (unsigned-byte 29) (mod 1000000)))
 864   (let ((which (ecase which
 865                  (:real itimer-real)
 866                  (:virtual itimer-virtual)
 867                  (:profile itimer-prof))))
 868     (with-alien ((itv (struct itimerval)))
 869       (syscall* ("getitimer" int (* (struct itimerval)))
 870                 (values t
 871                         (slot (slot itv 'it-interval) 'tv-sec)
 872                         (slot (slot itv 'it-interval) 'tv-usec)
 873                         (slot (slot itv 'it-value) 'tv-sec)
 874                         (slot (slot itv 'it-value) 'tv-usec))
 875                 which (alien-sap (addr itv))))))
 876
 877 #!-win32
 878 (defun unix-setitimer (which int-secs int-usec val-secs val-usec)
 879   " Unix-setitimer sets the INTERVAL and VALUE slots of one of
 880    three system timers (:real :virtual or :profile). A SIGALRM signal
 881    will be delivered VALUE <seconds+microseconds> from now. INTERVAL,
 882    when non-zero, is <seconds+microseconds> to be loaded each time
 883    the timer expires. Setting INTERVAL and VALUE to zero disables
 884    the timer. See the Unix man page for more details. On success,
 885    unix-setitimer returns the old contents of the INTERVAL and VALUE
 886    slots as in unix-getitimer."
 887   (declare (type (member :real :virtual :profile) which)
 888            (type (unsigned-byte 29) int-secs val-secs)
 889            (type (integer 0 (1000000)) int-usec val-usec)
 890            (values t
 891                    (unsigned-byte 29) (mod 1000000)
 892                    (unsigned-byte 29) (mod 1000000)))
 893   (let ((which (ecase which
 894                  (:real itimer-real)
 895                  (:virtual itimer-virtual)
 896                  (:profile itimer-prof))))
 897     (with-alien ((itvn (struct itimerval))
 898                  (itvo (struct itimerval)))
 899       (setf (slot (slot itvn 'it-interval) 'tv-sec ) int-secs
 900             (slot (slot itvn 'it-interval) 'tv-usec) int-usec
 901             (slot (slot itvn 'it-value   ) 'tv-sec ) val-secs
 902             (slot (slot itvn 'it-value   ) 'tv-usec) val-usec)
 903       (syscall* ("setitimer" int (* (struct timeval))(* (struct timeval)))
 904                 (values t
 905                         (slot (slot itvo 'it-interval) 'tv-sec)
 906                         (slot (slot itvo 'it-interval) 'tv-usec)
 907                         (slot (slot itvo 'it-value) 'tv-sec)
 908                         (slot (slot itvo 'it-value) 'tv-usec))
 909                 which (alien-sap (addr itvn))(alien-sap (addr itvo))))))
 910
 911 \f
 912 ;;; FIXME: Many Unix error code definitions were deleted from the old
 913 ;;; CMU CL source code here, but not in the exports of SB-UNIX. I
 914 ;;; (WHN) hope that someday I'll figure out an automatic way to detect
 915 ;;; unused symbols in package exports, but if I don't, there are
 916 ;;; enough of them all in one place here that they should probably be
 917 ;;; removed by hand.
 918 \f
 919 (defconstant micro-seconds-per-internal-time-unit
 920   (/ 1000000 sb!xc:internal-time-units-per-second))
 921
 922 ;;; UNIX specific code, that has been cleanly separated from the
 923 ;;; Windows build.
 924 #!-win32
 925 (progn
 926
 927   #!-sb-fluid (declaim (inline get-time-of-day))
 928   (defun get-time-of-day ()
 929     "Return the number of seconds and microseconds since the beginning of
 930 the UNIX epoch (January 1st 1970.)"
 931     #!+darwin
 932     (with-alien ((tv (struct timeval)))
 933       ;; CLH: FIXME! This seems to be a MacOS bug, but on x86-64/darwin,
 934       ;; gettimeofday occasionally fails. passing in a null pointer for the
 935       ;; timezone struct seems to work around the problem. NS notes: Darwin
 936       ;; manpage says the timezone is not used anymore in their implementation
 937       ;; at all.
 938       (syscall* ("gettimeofday" (* (struct timeval))
 939                                 (* (struct timezone)))
 940                 (values (slot tv 'tv-sec)
 941                         (slot tv 'tv-usec))
 942                 (addr tv)
 943                 nil))
 944     #!-(and x86-64 darwin)
 945     (with-alien ((tv (struct timeval))
 946                  (tz (struct timezone)))
 947       (syscall* ("gettimeofday" (* (struct timeval))
 948                                 (* (struct timezone)))
 949                 (values (slot tv 'tv-sec)
 950                         (slot tv 'tv-usec))
 951                 (addr tv)
 952                 (addr tz))))
 953
 954   (declaim (inline system-internal-run-time
 955                    system-real-time-values))
 956
 957   (defun system-real-time-values ()
 958     (multiple-value-bind (sec usec) (get-time-of-day)
 959       (declare (type (unsigned-byte 32) sec usec))
 960       (values sec (truncate usec micro-seconds-per-internal-time-unit))))
 961
 962   ;; There are two optimizations here that actually matter (on 32-bit
 963   ;; systems): substract the epoch from seconds and milliseconds
 964   ;; separately, as those should remain fixnums for the first 17 years
 965   ;; or so of runtime. Also, avoid doing consing a new bignum if the
 966   ;; result would be = to the last result given.
 967   ;;
 968   ;; Note: the next trick would be to spin a separate thread to update
 969   ;; a global value once per internal tick, so each individual call to
 970   ;; get-internal-real-time would be just a memory read... but that is
 971   ;; probably best left for user-level code. ;)
 972   ;;
 973   ;; Thanks to James Anderson for the optimization hint.
 974   ;;
 975   ;; Yes, it is possible to a computation to be GET-INTERNAL-REAL-TIME
 976   ;; bound.
 977   ;;
 978   ;; --NS 2007-04-05
 979   (let ((e-sec 0)
 980         (e-msec 0)
 981         (c-sec 0)
 982         (c-msec 0)
 983         (now 0))
 984     (declare (type (unsigned-byte 32) e-sec c-sec)
 985              (type fixnum e-msec c-msec)
 986              (type unsigned-byte now))
 987     (defun reinit-internal-real-time ()
 988       (setf (values e-sec e-msec) (system-real-time-values)
 989             c-sec 0
 990             c-msec 0))
 991     ;; If two threads call this at the same time, we're still safe, I
 992     ;; believe, as long as NOW is updated before either of C-MSEC or
 993     ;; C-SEC. Same applies to interrupts. --NS
 994     ;;
 995     ;; I believe this is almost correct with x86/x86-64 cache
 996     ;; coherency, but if the new value of C-SEC, C-MSEC can become
 997     ;; visible to another CPU without NOW doing the same then it's
 998     ;; unsafe. It's `almost' correct on x86 because writes by other
 999     ;; processors may become visible in any order provided transitity
1000     ;; holds. With at least three cpus, C-MSEC and C-SEC may be from
1001     ;; different threads and an incorrect value may be returned.
1002     ;; Considering that this failure is not detectable by the caller -
1003     ;; it looks like time passes a bit slowly - and that it should be
1004     ;; an extremely rare occurance I'm inclinded to leave it as it is.
1005     ;; --MG
1006     (defun get-internal-real-time ()
1007       (multiple-value-bind (sec msec) (system-real-time-values)
1008         (unless (and (= msec c-msec) (= sec c-sec))
1009           (setf now (+ (* (- sec e-sec)
1010                           sb!xc:internal-time-units-per-second)
1011                        (- msec e-msec))
1012                 c-msec msec
1013                 c-sec sec))
1014         now)))
1015
1016   (defun system-internal-run-time ()
1017     (multiple-value-bind (ignore utime-sec utime-usec stime-sec stime-usec)
1018         (unix-fast-getrusage rusage_self)
1019       (declare (ignore ignore)
1020                (type (unsigned-byte 31) utime-sec stime-sec)
1021                ;; (Classic CMU CL had these (MOD 1000000) instead, but
1022                ;; at least in Linux 2.2.12, the type doesn't seem to
1023                ;; be documented anywhere and the observed behavior is
1024                ;; to sometimes return 1000000 exactly.)
1025                (type (integer 0 1000000) utime-usec stime-usec))
1026       (let ((result (+ (* (+ utime-sec stime-sec)
1027                           sb!xc:internal-time-units-per-second)
1028                        (floor (+ utime-usec
1029                                  stime-usec
1030                                  (floor micro-seconds-per-internal-time-unit 2))
1031                               micro-seconds-per-internal-time-unit))))
1032         result))))
1033 \f
1034 ;;; FIXME, KLUDGE: GET-TIME-OF-DAY used to be UNIX-GETTIMEOFDAY, and had a
1035 ;;; primary return value indicating sucess, and also returned timezone
1036 ;;; information -- though the timezone data was not there on Darwin.
1037 ;;; Now we have GET-TIME-OF-DAY, but it turns out that despite SB-UNIX being
1038 ;;; an implementation package UNIX-GETTIMEOFDAY has users in the wild.
1039 ;;; So we're stuck with it for a while -- maybe delete it towards the end
1040 ;;; of 2009.
1041 (defun unix-gettimeofday ()
1042   (multiple-value-bind (sec usec) (get-time-of-day)
1043     (values t sec usec nil nil)))
1044 \f
1045 ;;;; opendir, readdir, closedir, and dirent-name
1046
1047 (declaim (inline unix-opendir))
1048 (defun unix-opendir (namestring &optional (errorp t))
1049   (let ((dir (alien-funcall
1050               (extern-alien "sb_opendir"
1051                             (function system-area-pointer c-string))
1052               namestring)))
1053     (if (zerop (sap-int dir))
1054         (when errorp (simple-perror
1055                       (format nil "Error opening directory ~S"
1056                               namestring)))
1057         dir)))
1058
1059 (declaim (inline unix-readdir))
1060 (defun unix-readdir (dir &optional (errorp t) namestring)
1061   (let ((ent (alien-funcall
1062               (extern-alien "sb_readdir"
1063                             (function system-area-pointer system-area-pointer))
1064                             dir)))
1065     (if (zerop (sap-int ent))
1066         (when errorp (simple-perror
1067                       (format nil "Error reading directory entry~@[ from ~S~]"
1068                               namestring)))
1069         ent)))
1070
1071 (declaim (inline unix-closedir))
1072 (defun unix-closedir (dir &optional (errorp t) namestring)
1073   (let ((r (alien-funcall
1074             (extern-alien "sb_closedir" (function int system-area-pointer))
1075             dir)))
1076     (if (minusp r)
1077         (when errorp (simple-perror
1078                       (format nil "Error closing directory~@[ ~S~]"
1079                               namestring)))
1080         r)))
1081
1082 (declaim (inline unix-dirent-name))
1083 (defun unix-dirent-name (ent)
1084   (alien-funcall
1085    (extern-alien "sb_dirent_name" (function c-string system-area-pointer))
1086    ent))
1087 \f
1088 ;;;; A magic constant for wait3().
1089 ;;;;
1090 ;;;; FIXME: This used to be defined in run-program.lisp as
1091 ;;;; (defconstant wait-wstopped #-svr4 #o177 #+svr4 wait-wuntraced)
1092 ;;;; According to some of the man pages, the #o177 is part of the API
1093 ;;;; for wait3(); that said, under SunOS there is a WSTOPPED thing in
1094 ;;;; the headers that may or may not be the same thing. To be
1095 ;;;; investigated. -- CSR, 2002-03-25
1096 (defconstant wstopped #o177)
1097
1098 \f
1099 ;;;; stuff not yet found in the header files
1100 ;;;;
1101 ;;;; Abandon all hope who enters here...
1102
1103 ;;; not checked for linux...
1104 (defmacro fd-set (offset fd-set)
1105   (with-unique-names (word bit)
1106     `(multiple-value-bind (,word ,bit) (floor ,offset
1107                                               sb!vm:n-machine-word-bits)
1108        (setf (deref (slot ,fd-set 'fds-bits) ,word)
1109              (logior (truly-the (unsigned-byte #.sb!vm:n-machine-word-bits)
1110                                 (ash 1 ,bit))
1111                      (deref (slot ,fd-set 'fds-bits) ,word))))))
1112
1113 ;;; not checked for linux...
1114 (defmacro fd-clr (offset fd-set)
1115   (with-unique-names (word bit)
1116     `(multiple-value-bind (,word ,bit) (floor ,offset
1117                                               sb!vm:n-machine-word-bits)
1118        (setf (deref (slot ,fd-set 'fds-bits) ,word)
1119              (logand (deref (slot ,fd-set 'fds-bits) ,word)
1120                      (sb!kernel:word-logical-not
1121                       (truly-the (unsigned-byte #.sb!vm:n-machine-word-bits)
1122                                  (ash 1 ,bit))))))))
1123
1124 ;;; not checked for linux...
1125 (defmacro fd-isset (offset fd-set)
1126   (with-unique-names (word bit)
1127     `(multiple-value-bind (,word ,bit) (floor ,offset
1128                                               sb!vm:n-machine-word-bits)
1129        (logbitp ,bit (deref (slot ,fd-set 'fds-bits) ,word)))))
1130
1131 ;;; not checked for linux...
1132 (defmacro fd-zero (fd-set)
1133   `(progn
1134      ,@(loop for index upfrom 0 below (/ fd-setsize sb!vm:n-machine-word-bits)
1135          collect `(setf (deref (slot ,fd-set 'fds-bits) ,index) 0))))
1136