0.8.16.16:
[sbcl.git] / src / code / run-program.lisp
index b7fb7c8..e3a1299 100644 (file)
 ;;;; which (at least in sbcl-0.6.10 on Red Hat Linux 6.2) is not
 ;;;; visible at GENESIS time.
 
-(def-alien-variable "environ" (* c-string))
-
+(define-alien-routine wrapped-environ (* c-string))
 (defun posix-environ ()
   "Return the Unix environment (\"man environ\") as a list of SIMPLE-STRINGs."
-  (c-strings->string-list environ))
+  (c-strings->string-list (wrapped-environ)))
 
-;;; Convert as best we can from a SBCL representation of a Unix
+;;; Convert as best we can from an SBCL representation of a Unix
 ;;; environment to a CMU CL representation.
 ;;;
 ;;; * (UNIX-ENVIRONMENT-CMUCL-FROM-SBCL '("Bletch=fub" "Noggin" "YES=No!"))
@@ -64,7 +63,7 @@
 (defun unix-environment-cmucl-from-sbcl (sbcl)
   (mapcan
    (lambda (string)
-     (declare (type simple-string string))
+     (declare (type simple-base-string string))
      (let ((=-pos (position #\= string :test #'equal)))
        (if =-pos
           (list
   (mapcar
    (lambda (cons)
      (destructuring-bind (key . val) cons
-       (declare (type keyword key) (type simple-string val))
-       (concatenate 'simple-string (symbol-name key) "=" val)))
+       (declare (type keyword key) (type simple-base-string val))
+       (concatenate 'simple-base-string (symbol-name key) "=" val)))
    cmucl))
 \f
 ;;;; Import wait3(2) from Unix.
 
-(sb-alien:def-alien-routine ("wait3" c-wait3) sb-c-call:int
-  (status sb-c-call:int :out)
-  (options sb-c-call:int)
-  (rusage sb-c-call:int))
-
-(defconstant wait-wnohang #-svr4 1 #+svr4 #o100)
-(defconstant wait-wuntraced #-svr4 2 #+svr4 4)
-(defconstant wait-wstopped #-svr4 #o177 #+svr4 wait-wuntraced)
+(define-alien-routine ("wait3" c-wait3) sb-alien:int
+  (status sb-alien:int :out)
+  (options sb-alien:int)
+  (rusage sb-alien:int))
 
 (defun wait3 (&optional do-not-hang check-for-stopped)
   "Return any available status information on child process. "
   (multiple-value-bind (pid status)
       (c-wait3 (logior (if do-not-hang
-                          wait-wnohang
+                          sb-unix:wnohang
                           0)
                       (if check-for-stopped
-                          wait-wuntraced
+                          sb-unix:wuntraced
                           0))
               0)
     (cond ((or (minusp pid)
               (zerop pid))
           nil)
          ((eql (ldb (byte 8 0) status)
-               wait-wstopped)
+               sb-unix:wstopped)
           (values pid
                   :stopped
                   (ldb (byte 8 8) status)))
             (values pid
                     (if (position signal
                                   #.(vector
-                                     (sb-unix:unix-signal-number :sigstop)
-                                     (sb-unix:unix-signal-number :sigtstp)
-                                     (sb-unix:unix-signal-number :sigttin)
-                                     (sb-unix:unix-signal-number :sigttou)))
+                                     sb-unix:sigstop
+                                     sb-unix:sigtstp
+                                     sb-unix:sigttin
+                                     sb-unix:sigttou))
                         :stopped
                         :signaled)
                     signal
 (defmethod print-object ((process process) stream)
   (print-unreadable-object (process stream :type t)
     (format stream
-           "~D ~S"
+           "~W ~S"
            (process-pid process)
            (process-status process)))
   process)
 #-hpux
 ;;; Find the current foreground process group id.
 (defun find-current-foreground-process (proc)
-  (sb-alien:with-alien ((result sb-c-call:int))
+  (with-alien ((result sb-alien:int))
     (multiple-value-bind
          (wonp error)
        (sb-unix:unix-ioctl (sb-sys:fd-stream-fd (process-pty proc))
                            sb-unix:TIOCGPGRP
-                           (sb-alien:alien-sap (sb-alien:addr result)))
+                           (alien-sap (sb-alien:addr result)))
       (unless wonp
        (error "TIOCPGRP ioctl failed: ~S" (strerror error)))
       result))
           (sb-unix:unix-ioctl (sb-sys:fd-stream-fd (process-pty proc))
                               sb-unix:TIOCSIGSEND
                               (sb-sys:int-sap
-                               (sb-unix:unix-signal-number signal))))
+                               signal)))
          ((:process-group #-hpux :pty-process-group)
           (sb-unix:unix-killpg pid signal))
          (t
       (cond ((not okay)
             (values nil errno))
            ((and (eql pid (process-pid proc))
-                 (= (sb-unix:unix-signal-number signal)
-                    (sb-unix:unix-signal-number :sigcont)))
+                 (= signal sb-unix:sigcont))
             (setf (process-%status proc) :running)
             (setf (process-exit-code proc) nil)
             (when (process-status-hook proc)
 ;;; list of handlers installed by RUN-PROGRAM
 (defvar *handlers-installed* nil)
 
-#+FreeBSD
-(def-alien-type nil
-  (struct sgttyb
-         (sg-ispeed sb-c-call:char)    ; input speed
-         (sg-ospeed sb-c-call:char)    ; output speed
-         (sg-erase sb-c-call:char)     ; erase character
-         (sg-kill sb-c-call:char)      ; kill character
-         (sg-flags sb-c-call:short)))  ; mode flags
-#+OpenBSD
-(def-alien-type nil
-  (struct sgttyb
-         (sg-four sb-c-call:int)
-         (sg-chars (array sb-c-call:char 4))
-         (sg-flags sb-c-call:int)))
-
 ;;; Find an unused pty. Return three values: the file descriptor for
 ;;; the master side of the pty, the file descriptor for the slave side
 ;;; of the pty, and the name of the tty device for the slave side.
                                              sb-unix:o_rdwr
                                              #o666)))
            (when slave-fd
-             ;; comment from classic CMU CL:
-             ;;   Maybe put a vhangup here?
-             ;;
-             ;; FIXME: It seems as though this logic should be in
-             ;; OPEN-PTY, not FIND-A-PTY (both from the comments
-             ;; documenting DEFUN FIND-A-PTY, and from the
-             ;; connotations of the function names).
-             ;;
-             ;; FIXME: It would be nice to have a note, and/or a pointer
-             ;; to some reference material somewhere, explaining
-             ;; why we need this on *BSD and not on Linux.
-              #+bsd
-             (sb-alien:with-alien ((stuff (sb-alien:struct sgttyb)))
-               (let ((sap (sb-alien:alien-sap stuff)))
-                 (sb-unix:unix-ioctl slave-fd sb-unix:TIOCGETP sap)
-                 (setf (sb-alien:slot stuff 'sg-flags)
-                       ;; This is EVENP|ODDP, the same numeric code
-                       ;; both on FreeBSD and on OpenBSD. -- WHN 20000929
-                       #o300) ; EVENP|ODDP
-                 (sb-unix:unix-ioctl slave-fd sb-unix:TIOCSETP sap)
-                 (sb-unix:unix-ioctl master-fd sb-unix:TIOCGETP sap)
-                 (setf (sb-alien:slot stuff 'sg-flags)
-                       (logand (sb-alien:slot stuff 'sg-flags)
-                               ;; This is ~ECHO, the same numeric
-                               ;; code both on FreeBSD and on OpenBSD.
-                               ;; -- WHN 20000929
-                               (lognot 8))) ; ~ECHO
-                 (sb-unix:unix-ioctl master-fd sb-unix:TIOCSETP sap)))
              (return-from find-a-pty
                (values master-fd
                        slave-fd
       (when (streamp pty)
        (multiple-value-bind (new-fd errno) (sb-unix:unix-dup master)
          (unless new-fd
-           (error "couldn't SB-UNIX:UNIX-DUP ~D: ~A" master (strerror errno)))
+           (error "couldn't SB-UNIX:UNIX-DUP ~W: ~A" master (strerror errno)))
          (push new-fd *close-on-error*)
          (copy-descriptor-to-stream new-fd pty cookie)))
       (values name
          ;; Blast the string into place.
          (sb-kernel:copy-to-system-area (the simple-string s)
                                         (* sb-vm:vector-data-offset
-                                           sb-vm:word-bits)
+                                           sb-vm:n-word-bits)
                                         string-sap 0
-                                        (* (1+ n) sb-vm:byte-bits))
+                                        (* (1+ n) sb-vm:n-byte-bits))
          ;; Blast the pointer to the string into place.
          (setf (sap-ref-sap vec-sap i) string-sap)
          (setf string-sap (sap+ string-sap (round-bytes-to-words (1+ n))))
       (values vec-sap (sap+ vec-sap #-alpha 4 #+alpha 8) total-bytes))))
 
 (defmacro with-c-strvec ((var str-list) &body body)
-  (let ((sap (gensym "SAP-"))
-       (size (gensym "SIZE-")))
+  (with-unique-names (sap size)
     `(multiple-value-bind
       (,sap ,var ,size)
       (string-list-to-c-strvec ,str-list)
             ,@body)
        (sb-sys:deallocate-system-memory ,sap ,size)))))
 
-(sb-alien:def-alien-routine spawn sb-c-call:int
-  (program sb-c-call:c-string)
-  (argv (* sb-c-call:c-string))
-  (envp (* sb-c-call:c-string))
-  (pty-name sb-c-call:c-string)
-  (stdin sb-c-call:int)
-  (stdout sb-c-call:int)
-  (stderr sb-c-call:int))
+(sb-alien:define-alien-routine spawn sb-alien:int
+  (program sb-alien:c-string)
+  (argv (* sb-alien:c-string))
+  (envp (* sb-alien:c-string))
+  (pty-name sb-alien:c-string)
+  (stdin sb-alien:int)
+  (stdout sb-alien:int)
+  (stderr sb-alien:int))
 
 ;;; Is UNIX-FILENAME the name of a file that we can execute?
 (defun unix-filename-is-executable-p (unix-filename)
   (declare (type simple-string unix-filename))
+  (setf unix-filename (coerce unix-filename 'base-string))
   (values (and (eq (sb-unix:unix-file-kind unix-filename) :file)
               (sb-unix:unix-access unix-filename sb-unix:x_ok))))
 
+(defun find-executable-in-search-path (pathname
+                                      &optional
+                                      (search-path (posix-getenv "PATH")))
+  "Find the first executable file matching PATHNAME in any of the colon-separated list of pathnames SEARCH-PATH"
+  (loop for end =  (position #\: search-path :start (if end (1+ end) 0))
+       and start = 0 then (and end (1+ end))
+       while start
+       ;; <Krystof> the truename of a file naming a directory is the
+       ;; directory, at least until pfdietz comes along and says why
+       ;; that's noncompliant  -- CSR, c. 2003-08-10
+       for truename = (probe-file (subseq search-path start end))
+       for fullpath = (when truename (merge-pathnames pathname truename))
+       when (and fullpath
+                 (unix-filename-is-executable-p (namestring fullpath)))
+       return fullpath))
+
 ;;; FIXME: There shouldn't be two semiredundant versions of the
 ;;; documentation. Since this is a public extension function, the
 ;;; documentation should be in the doc string. So all information from
                                     (posix-environ))
                                 environment-p)
                    (wait t)
+                   search
                    pty
                    input
                    if-input-does-not-exist
 
    The &KEY arguments have the following meanings:
      :ENVIRONMENT
-        a list of SIMPLE-STRINGs describing the new Unix environment (as
-        in \"man environ\"). The default is to copy the environment of
+        a list of SIMPLE-BASE-STRINGs describing the new Unix environment
+        (as in \"man environ\"). The default is to copy the environment of
         the current process.
      :ENV
         an alternative lossy representation of the new Unix environment,
         for compatibility with CMU CL
+     :SEARCH
+        Look for PROGRAM in each of the directories along the $PATH
+        environment variable.  Otherwise an absolute pathname is required.
+        (See also FIND-EXECUTABLE-IN-SEARCH-PATH)
      :WAIT
         If non-NIL (default), wait until the created process finishes.  If
         NIL, continue running Lisp until the program finishes.
   (when (and env-p environment-p)
     (error "can't specify :ENV and :ENVIRONMENT simultaneously"))
   ;; Make sure that the interrupt handler is installed.
-  (sb-sys:enable-interrupt :sigchld #'sigchld-handler)
+  (sb-sys:enable-interrupt sb-unix:sigchld #'sigchld-handler)
   ;; Prepend the program to the argument list.
   (push (namestring program) args)
   (let (;; Clear various specials used by GET-DESCRIPTOR-FOR to
        ;; designator, but internally we'd like SIMPLE-STRINGs.
        (simple-args (mapcar (lambda (x) (coerce x 'simple-string)) args)))
     (unwind-protect
-        (let (;; FIXME: The old code here used to do
-              ;;   (MERGE-PATHNAMES PROGRAM "path:"),
-              ;; which is the right idea (searching through the Unix
-              ;; PATH). Unfortunately, there is no logical pathname
-              ;; "path:" defined in sbcl-0.6.10. It would probably be 
-              ;; reasonable to restore Unix PATH searching in SBCL, e.g.
-              ;; with a function FIND-EXECUTABLE-FILE-IN-POSIX-PATH.
-              ;; (I don't want to do it with search lists the way
-              ;; that CMU CL did, because those are a non-ANSI
-              ;; extension which I'd like to get rid of. -- WHN)
-              (pfile (unix-namestring program t))
+        (let ((pfile
+               (if search 
+                   (let ((p (find-executable-in-search-path program)))
+                     (and p (unix-namestring p t)))
+                   (unix-namestring program t)))
               (cookie (list 0)))
           (unless pfile
             (error "no such program: ~S" program))
     (setf handler
          (sb-sys:add-fd-handler
           descriptor
-          :input #'(lambda (fd)
-                     (declare (ignore fd))
-                     (loop
-                         (unless handler
-                           (return))
-                         (multiple-value-bind
-                               (result readable/errno)
-                             (sb-unix:unix-select (1+ descriptor)
-                                                  (ash 1 descriptor)
-                                                  0 0 0)
-                           (cond ((null result)
-                                  (error "~@<couldn't select on sub-process: ~
+          :input (lambda (fd)
+                   (declare (ignore fd))
+                   (loop
+                    (unless handler
+                      (return))
+                    (multiple-value-bind
+                        (result readable/errno)
+                        (sb-unix:unix-select (1+ descriptor)
+                                             (ash 1 descriptor)
+                                             0 0 0)
+                      (cond ((null result)
+                             (error "~@<couldn't select on sub-process: ~
                                            ~2I~_~A~:>"
-                                         (strerror readable/errno)))
-                                 ((zerop result)
-                                  (return))))
-                       (sb-alien:with-alien ((buf (sb-alien:array
-                                                   sb-c-call:char
-                                                   256)))
-                         (multiple-value-bind
-                               (count errno)
-                             (sb-unix:unix-read descriptor
-                                                (alien-sap buf)
-                                                256)
-                           (cond ((or (and (null count)
-                                           (eql errno sb-unix:eio))
-                                      (eql count 0))
-                                  (sb-sys:remove-fd-handler handler)
-                                  (setf handler nil)
-                                  (decf (car cookie))
-                                  (sb-unix:unix-close descriptor)
-                                  (return))
-                                 ((null count)
-                                  (sb-sys:remove-fd-handler handler)
-                                  (setf handler nil)
-                                  (decf (car cookie))
-                                  (error
-                                   "~@<couldn't read input from sub-process: ~
+                                    (strerror readable/errno)))
+                            ((zerop result)
+                             (return))))
+                    (sb-alien:with-alien ((buf (sb-alien:array
+                                                sb-alien:char
+                                                256)))
+                      (multiple-value-bind
+                          (count errno)
+                          (sb-unix:unix-read descriptor
+                                             (alien-sap buf)
+                                             256)
+                        (cond ((or (and (null count)
+                                        (eql errno sb-unix:eio))
+                                   (eql count 0))
+                               (sb-sys:remove-fd-handler handler)
+                               (setf handler nil)
+                               (decf (car cookie))
+                               (sb-unix:unix-close descriptor)
+                               (return))
+                              ((null count)
+                               (sb-sys:remove-fd-handler handler)
+                               (setf handler nil)
+                               (decf (car cookie))
+                               (error
+                                "~@<couldn't read input from sub-process: ~
                                      ~2I~_~A~:>"
-                                   (strerror errno)))
-                                 (t
-                                  (sb-kernel:copy-from-system-area
-                                   (alien-sap buf) 0
-                                   string (* sb-vm:vector-data-offset
-                                             sb-vm:word-bits)
-                                   (* count sb-vm:byte-bits))
-                                  (write-string string stream
-                                                :end count)))))))))))
+                                (strerror errno)))
+                              (t
+                               (sb-kernel:copy-from-system-area
+                                (alien-sap buf) 0
+                                string (* sb-vm:vector-data-offset
+                                          sb-vm:n-word-bits)
+                                (* count sb-vm:n-byte-bits))
+                               (write-string string stream
+                                             :end count)))))))))))
 
 ;;; Find a file descriptor to use for object given the direction.
 ;;; Returns the descriptor. If object is :STREAM, returns the created