0.8alpha.0.9:
[sbcl.git] / src / code / unix.lisp
index 0a405ca..1e973f3 100644 (file)
@@ -47,7 +47,7 @@
 \f
 ;;;; Lisp types used by syscalls
 
-(deftype unix-pathname () 'simple-string)
+(deftype unix-pathname () 'simple-base-string)
 (deftype unix-fd () `(integer 0 ,most-positive-fixnum))
 
 (deftype unix-file-mode () '(unsigned-byte 32))
@@ -90,7 +90,7 @@
 \f
 ;;;; hacking the Unix environment
 
-(def-alien-routine ("getenv" posix-getenv) c-string
+(define-alien-routine ("getenv" posix-getenv) c-string
   "Return the \"value\" part of the environment string \"name=value\" which
    corresponds to NAME, or NIL if there is none."
   (name c-string))
 ;;; is not extreme enough, since it doesn't need to be blindingly
 ;;; fast: we can just implement those functions in C as a wrapper
 ;;; layer.
-(def-alien-type fd-mask unsigned-long)
+(define-alien-type fd-mask unsigned-long)
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defconstant fd-setsize 1024))
 
-(def-alien-type nil
+(define-alien-type nil
   (struct fd-set
          (fds-bits (array fd-mask #.(/ fd-setsize 32)))))
 
 
 ;; A time value that is accurate to the nearest
 ;; microsecond but also has a range of years.
-(def-alien-type nil
+(define-alien-type nil
   (struct timeval
          (tv-sec time-t)               ; seconds
          (tv-usec time-t)))            ; and microseconds
 (defconstant rusage_children -1) ; terminated child processes
 (defconstant rusage_both -2)
 
-(def-alien-type nil
+(define-alien-type nil
   (struct rusage
     (ru-utime (struct timeval))            ; user time used
     (ru-stime (struct timeval))            ; system time used.
 (defconstant l_incr 1) ; to increment the file pointer
 (defconstant l_xtnd 2) ; to extend the file size
 
+;;; Is a stream interactive?
+(defun unix-isatty (fd)
+  (declare (type unix-fd fd))
+  (int-syscall ("isatty" int) fd))
+
 ;;; Accept a file descriptor and move the file pointer ahead
 ;;; a certain offset for that file. WHENCE can be any of the following:
 ;;;  L_SET     Set the file pointer.
           (type unix-file-mode mode))
   (void-syscall ("mkdir" c-string int) name mode))
 
+;;; Given a C char* pointer allocated by malloc(), free it and return a
+;;; corresponding Lisp string (or return NIL if the pointer is a C NULL).
+(defun newcharstar-string (newcharstar)
+  (declare (type (alien (* char)) newcharstar))
+  (if (null-alien newcharstar)
+      nil
+      (prog1
+         (cast newcharstar c-string)
+       (free-alien newcharstar))))
+
 ;;; Return the Unix current directory as a SIMPLE-STRING, in the
 ;;; style returned by getcwd() (no trailing slash character). 
 (defun posix-getcwd ()
   ;; behavior, automatically allocating memory when a null buffer
   ;; pointer is used. On a system which doesn't support that
   ;; extension, it'll have to be rewritten somehow.
-  #!-(or linux openbsd freebsd) (,stub,)
-  (let* ((raw-char-ptr (alien-funcall (extern-alien "getcwd"
-                                                   (function (* char)
-                                                             (* char) size-t))
-                                     nil 0)))
-    (if (null-alien raw-char-ptr)
-       (simple-perror "getcwd")
-       (prog1
-           (cast raw-char-ptr c-string)
-         (free-alien raw-char-ptr)))))
+  ;;
+  ;; SunOS and OSF/1 provide almost as useful an extension: if given a null
+  ;; buffer pointer, it will automatically allocate size space. The
+  ;; KLUDGE in this solution arises because we have just read off
+  ;; PATH_MAX+1 from the Solaris header files and stuck it in here as
+  ;; a constant. Going the grovel_headers route doesn't seem to be
+  ;; helpful, either, as Solaris doesn't export PATH_MAX from
+  ;; unistd.h.
+  #!-(or linux openbsd freebsd sunos osf1) (,stub,)
+  #!+(or linux openbsd freebsd sunos osf1)
+  (or (newcharstar-string (alien-funcall (extern-alien "getcwd"
+                                                      (function (* char)
+                                                                (* char)
+                                                                size-t))
+                                        nil 
+                                        #!+(or linux openbsd freebsd) 0
+                                        #!+(or sunos osf1) 1025))
+      (simple-perror "getcwd")))
 
 ;;; Return the Unix current directory as a SIMPLE-STRING terminated
 ;;; by a slash character.
   (void-syscall ("exit" int) code))
 
 ;;; Return the process id of the current process.
-(def-alien-routine ("getpid" unix-getpid) int)
-
-;;; Return the real user-id associated with the current process.
-(def-alien-routine ("getuid" unix-getuid) int)
+(define-alien-routine ("getpid" unix-getpid) int)
+
+;;; Return the real user id associated with the current process.
+(define-alien-routine ("getuid" unix-getuid) int)
+
+;;; Translate a user id into a login name.
+(defun uid-username (uid)
+  (or (newcharstar-string (alien-funcall (extern-alien "uid_username"
+                                                      (function (* char) int))
+                                        uid))
+      (error "found no match for Unix uid=~S" uid)))
+
+;;; Return the namestring of the home directory, being careful to
+;;; include a trailing #\/
+(defun uid-homedir (uid)
+  (or (newcharstar-string (alien-funcall (extern-alien "uid_homedir"
+                                                      (function (* char) int))
+                                        uid))
+      (error "failed to resolve home directory for Unix uid=~S" uid)))
 
 ;;; Invoke readlink(2) on the file name specified by PATH. Return
 ;;; (VALUES LINKSTRING NIL) on success, or (VALUES NIL ERRNO) on
   (declare (type unix-pathname name))
   (void-syscall ("unlink" c-string) name))
 
-;;; Set the tty-process-group for the unix file-descriptor FD to PGRP.
-;;; If not supplied, FD defaults to "/dev/tty".
-(defun %set-tty-process-group (pgrp &optional fd)
-  (let ((old-sigs (unix-sigblock (sigmask :sigttou
-                                         :sigttin
-                                         :sigtstp
-                                         :sigchld))))
-    (declare (type (unsigned-byte 32) old-sigs))
-    (unwind-protect
-       (if fd
-           (tcsetpgrp fd pgrp)
-           (multiple-value-bind (tty-fd errno) (unix-open "/dev/tty" o_rdwr 0)
-             (cond (tty-fd
-                    (multiple-value-prog1
-                        (tcsetpgrp tty-fd pgrp)
-                      (unix-close tty-fd)))
-                   (t
-                    (values nil errno)))))
-      (unix-sigsetmask old-sigs))))
-
 ;;; Return the name of the host machine as a string.
 (defun unix-gethostname ()
   (with-alien ((buf (array char 256)))
   (declare (type unix-fd fd))
   (void-syscall ("fsync" int) fd))
 \f
+
+(defun unix-setsid ()
+  (int-syscall ("setsid")))
+
 ;;;; sys/ioctl.h
 
 ;;; UNIX-IOCTL performs a variety of operations on open i/o
 
 ;;; FIXME: All we seem to need is the RUSAGE_SELF version of this.
 ;;;
-;;; Like getrusage(2), but return only the system and user time,
-;;; and return the seconds and microseconds as separate values.
+;;; This is like getrusage(2), except it returns only the system and
+;;; user time, and returns the seconds and microseconds as separate
+;;; values.
 #!-sb-fluid (declaim (inline unix-fast-getrusage))
 (defun unix-fast-getrusage (who)
   (declare (values (member t)
 \f
 ;;;; sys/select.h
 
-(defmacro unix-fast-select (num-descriptors
-                           read-fds write-fds exception-fds
-                           timeout-secs &optional (timeout-usecs 0))
-  #!+sb-doc
-  "Perform the UNIX select(2) system call."
-  (declare (type (integer 0 #.FD-SETSIZE) num-descriptors)
+;;;; FIXME: Why have both UNIX-SELECT and UNIX-FAST-SELECT?
+
+;;; Perform the UNIX select(2) system call.
+(declaim (inline unix-fast-select)) ; (used to be a macro in CMU CL)
+(defun unix-fast-select (num-descriptors
+                        read-fds write-fds exception-fds
+                        timeout-secs &optional (timeout-usecs 0))
+  (declare (type (integer 0 #.fd-setsize) num-descriptors)
           (type (or (alien (* (struct fd-set))) null)
                 read-fds write-fds exception-fds)
           (type (or null (unsigned-byte 31)) timeout-secs)
-          (type (unsigned-byte 31) timeout-usecs) )
+          (type (unsigned-byte 31) timeout-usecs))
   ;; FIXME: CMU CL had
-  ;;   (optimize (speed 3) (safety 0) (inhibit-warnings 3))
-  ;; in the declarations above. If they're important, they should
-  ;; be in a declaration inside the LET expansion, not in the
-  ;; macro compile-time code.
-  `(let ((timeout-secs ,timeout-secs))
-     (with-alien ((tv (struct timeval)))
-       (when timeout-secs
-        (setf (slot tv 'tv-sec) timeout-secs)
-        (setf (slot tv 'tv-usec) ,timeout-usecs))
-       (int-syscall ("select" int (* (struct fd-set)) (* (struct fd-set))
-                    (* (struct fd-set)) (* (struct timeval)))
-                   ,num-descriptors ,read-fds ,write-fds ,exception-fds
-                   (if timeout-secs (alien-sap (addr tv)) (int-sap 0))))))
+  ;;   (declare (optimize (speed 3) (safety 0) (inhibit-warnings 3)))
+  ;; here. Is that important for SBCL? If so, why? Profiling might tell us..
+  (with-alien ((tv (struct timeval)))
+    (when timeout-secs
+      (setf (slot tv 'tv-sec) timeout-secs)
+      (setf (slot tv 'tv-usec) timeout-usecs))
+    (int-syscall ("select" int (* (struct fd-set)) (* (struct fd-set))
+                 (* (struct fd-set)) (* (struct timeval)))
+                num-descriptors read-fds write-fds exception-fds
+                (if timeout-secs (alien-sap (addr tv)) (int-sap 0)))))
 
 ;;; UNIX-SELECT accepts sets of file descriptors and waits for an event
 ;;; to happen on one of them or to time out.
 ;;; st_size is a long, not an off-t, because off-t is a 64-bit
 ;;; quantity on Alpha. And FIXME: "No one would want a file length
 ;;; longer than 32 bits anyway, right?":-|
-(def-alien-type nil
+(define-alien-type nil
   (struct wrapped_stat
     (st-dev unsigned-long)              ; would be dev-t in a real stat
     (st-ino ino-t)
 
 ;; the POSIX.4 structure for a time value. This is like a "struct
 ;; timeval" but has nanoseconds instead of microseconds.
-(def-alien-type nil
+(define-alien-type nil
     (struct timespec
            (tv-sec long)   ; seconds
            (tv-nsec long))) ; nanoseconds
 
 ;; used by other time functions
-(def-alien-type nil
+(define-alien-type nil
     (struct tm
            (tm-sec int)   ; Seconds.   [0-60] (1 leap second)
            (tm-min int)   ; Minutes.   [0-59]
            (tm-gmtoff long) ;  Seconds east of UTC.
            (tm-zone c-string))) ; Timezone abbreviation.
 
-(def-alien-routine get-timezone sb!c-call:void
-  (when sb!c-call:long :in)
-  (minutes-west sb!c-call:int :out)
+(define-alien-routine get-timezone sb!alien:void
+  (when sb!alien:long :in)
+  (minutes-west sb!alien:int :out)
   (daylight-savings-p sb!alien:boolean :out))
 
 (defun unix-get-minutes-west (secs)
 
 ;;; Structure crudely representing a timezone. KLUDGE: This is
 ;;; obsolete and should never be used.
-(def-alien-type nil
+(define-alien-type nil
   (struct timezone
     (tz-minuteswest int)               ; minutes west of Greenwich
     (tz-dsttime        int)))                  ; type of dst correction
              (addr tz))))
 \f
 
+;; Type of the second argument to `getitimer' and
+;; the second and third arguments `setitimer'. 
+(define-alien-type nil
+  (struct itimerval
+    (it-interval (struct timeval))     ; timer interval
+    (it-value (struct timeval))))      ; current value
+
+(defconstant ITIMER-REAL 0)
+(defconstant ITIMER-VIRTUAL 1)
+(defconstant ITIMER-PROF 2)
+
+(defun unix-getitimer(which)
+  "Unix-getitimer returns the INTERVAL and VALUE slots of one of
+   three system timers (:real :virtual or :profile). On success,
+   unix-getitimer returns 5 values,
+   T, it-interval-secs, it-interval-usec, it-value-secs, it-value-usec."
+  (declare (type (member :real :virtual :profile) which)
+          (values t
+                  (unsigned-byte 29) (mod 1000000)
+                  (unsigned-byte 29) (mod 1000000)))
+  (let ((which (ecase which
+                (:real ITIMER-REAL)
+                (:virtual ITIMER-VIRTUAL)
+                (:profile ITIMER-PROF))))
+    (with-alien ((itv (struct itimerval)))
+      (syscall* ("getitimer" int (* (struct itimerval)))
+               (values T
+                       (slot (slot itv 'it-interval) 'tv-sec)
+                       (slot (slot itv 'it-interval) 'tv-usec)
+                       (slot (slot itv 'it-value) 'tv-sec)
+                       (slot (slot itv 'it-value) 'tv-usec))
+               which (alien-sap (addr itv))))))
+
+(defun unix-setitimer (which int-secs int-usec val-secs val-usec)
+  " Unix-setitimer sets the INTERVAL and VALUE slots of one of
+   three system timers (:real :virtual or :profile). A SIGALRM signal
+   will be delivered VALUE <seconds+microseconds> from now. INTERVAL,
+   when non-zero, is <seconds+microseconds> to be loaded each time
+   the timer expires. Setting INTERVAL and VALUE to zero disables
+   the timer. See the Unix man page for more details. On success,
+   unix-setitimer returns the old contents of the INTERVAL and VALUE
+   slots as in unix-getitimer."
+  (declare (type (member :real :virtual :profile) which)
+          (type (unsigned-byte 29) int-secs val-secs)
+          (type (integer 0 (1000000)) int-usec val-usec)
+          (values t
+                  (unsigned-byte 29) (mod 1000000)
+                  (unsigned-byte 29) (mod 1000000)))
+  (let ((which (ecase which
+                (:real ITIMER-REAL)
+                (:virtual ITIMER-VIRTUAL)
+                (:profile ITIMER-PROF))))
+    (with-alien ((itvn (struct itimerval))
+                (itvo (struct itimerval)))
+      (setf (slot (slot itvn 'it-interval) 'tv-sec ) int-secs
+           (slot (slot itvn 'it-interval) 'tv-usec) int-usec
+           (slot (slot itvn 'it-value   ) 'tv-sec ) val-secs
+           (slot (slot itvn 'it-value   ) 'tv-usec) val-usec)
+      (syscall* ("setitimer" int (* (struct timeval))(* (struct timeval)))
+               (values T
+                       (slot (slot itvo 'it-interval) 'tv-sec)
+                       (slot (slot itvo 'it-interval) 'tv-usec)
+                       (slot (slot itvo 'it-value) 'tv-sec)
+                       (slot (slot itvo 'it-value) 'tv-usec))
+               which (alien-sap (addr itvn))(alien-sap (addr itvo))))))
+
+(defmacro sb!ext::with-timeout (expires &body body)
+  "Execute the body, interrupting it with a SIGALRM after at least
+EXPIRES seconds have passed.  Uses Unix setitimer(), restoring any
+previous timer after the body has finished executing"
+  (with-unique-names (saved-seconds saved-useconds s u)
+    `(let (- ,saved-seconds ,saved-useconds)
+      (multiple-value-setq (- - - ,saved-seconds ,saved-useconds)
+       (unix-getitimer :real))
+      (multiple-value-bind (,s ,u) (floor ,expires)
+       (setf ,u (floor (* ,u 1000000)))
+       (if (and (> ,expires 0)
+                (or (and (zerop ,saved-seconds) (zerop ,saved-useconds))
+                    (> ,saved-seconds ,s)
+                    (and (= ,saved-seconds ,s)
+                         (> ,saved-useconds ,u))))
+           (unwind-protect
+                (progn
+                  (unix-setitimer :real 0 0 ,s ,u)
+                  ,@body)
+             (unix-setitimer :real 0 0 ,saved-seconds ,saved-useconds))
+           ,@body)))))
+
+\f
+
 (defconstant ENOENT 2) ; Unix error code, "No such file or directory"
 (defconstant EINTR 4) ; Unix error code, "Interrupted system call"
 (defconstant EIO 5) ; Unix error code, "I/O error"
 (defun unix-file-kind (name &optional check-for-links)
   #!+sb-doc
   "Return either :FILE, :DIRECTORY, :LINK, :SPECIAL, or NIL."
-  (declare (simple-string name))
+  (declare (simple-base-string name))
   (multiple-value-bind (res dev ino mode)
       (if check-for-links (unix-lstat name) (unix-stat name))
     (declare (type (or fixnum null) mode)
 (defun unix-resolve-links (pathname)
   (declare (type simple-string pathname))
   (aver (not (relative-unix-pathname? pathname)))
-  (/show "entering UNIX-RESOLVE-LINKS")
+  (/noshow "entering UNIX-RESOLVE-LINKS")
   (loop with previous-pathnames = nil do
-       (/show pathname previous-pathnames)
+       (/noshow pathname previous-pathnames)
        (let ((link (unix-readlink pathname)))
-         (/show link)
+         (/noshow link)
          ;; Unlike the old CMU CL code, we handle a broken symlink by
          ;; returning the link itself. That way, CL:TRUENAME on a
          ;; broken link returns the link itself, so that CL:DIRECTORY
                                                        pathname
                                                        :from-end t)))
                                 (dir (subseq pathname 0 dir-len)))
-                           (/show dir)
+                           (/noshow dir)
                            (concatenate 'string dir link))
                          link))))
                (if (unix-file-kind new-pathname)
          (t
           (subseq dst 0 dst-len)))))
 \f
+;;;; A magic constant for wait3().
+;;;;
+;;;; FIXME: This used to be defined in run-program.lisp as
+;;;; (defconstant wait-wstopped #-svr4 #o177 #+svr4 wait-wuntraced)
+;;;; According to some of the man pages, the #o177 is part of the API
+;;;; for wait3(); that said, under SunOS there is a WSTOPPED thing in
+;;;; the headers that may or may not be the same thing. To be
+;;;; investigated. -- CSR, 2002-03-25
+(defconstant wstopped #o177)
+
+\f
 ;;;; stuff not yet found in the header files
 ;;;;
 ;;;; Abandon all hope who enters here...