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