-;;;; RUN-PROGRAM and friends, a facility for running Unix programs
-;;;; from inside SBCL
-
-;;;; This software is part of the SBCL system. See the README file for
-;;;; more information.
-;;;;
-;;;; This software is derived from the CMU CL system, which was
-;;;; written at Carnegie Mellon University and released into the
-;;;; public domain. The software is in the public domain and is
-;;;; provided with absolutely no warranty. See the COPYING and CREDITS
-;;;; files for more information.
-
-(in-package "SB-IMPL") ;(SB-IMPL, not SB!IMPL, since we're built in warm load.)
-\f
-;;;; hacking the Unix environment
-;;;;
-;;;; In the original CMU CL code that LOAD-FOREIGN is derived from, the
-;;;; Unix environment (as in "man environ") was represented as an
-;;;; alist from keywords to strings, so that e.g. the Unix environment
-;;;; "SHELL=/bin/bash" "HOME=/root" "PAGER=less"
-;;;; was represented as
-;;;; ((:SHELL . "/bin/bash") (:HOME . "/root") (:PAGER "less"))
-;;;; This had a few problems in principle: the mapping into
-;;;; keyword symbols smashed the case of environment
-;;;; variables, and the whole mapping depended on the presence of
-;;;; #\= characters in the environment strings. In practice these
-;;;; problems weren't hugely important, since conventionally environment
-;;;; variables are uppercase strings followed by #\= followed by
-;;;; arbitrary data. However, since it's so manifestly not The Right
-;;;; Thing to make code which breaks unnecessarily on input which
-;;;; doesn't follow what is, after all, only a tradition, we've switched
-;;;; formats in SBCL, so that the fundamental environment list
-;;;; is just a list of strings, with a one-to-one-correspondence
-;;;; to the C-level representation. I.e., in the example above,
-;;;; the SBCL representation is
-;;;; '("SHELL=/bin/bash" "HOME=/root" "PAGER=less")
-;;;; CMU CL's implementation is currently supported to help with porting.
-;;;;
-;;;; It's not obvious that this code belongs here (instead of e.g. in
-;;;; unix.lisp), since it has only a weak logical connection with
-;;;; RUN-PROGRAM. However, physically it's convenient to put it here.
-;;;; It's not needed at cold init, so we *can* put it in this
-;;;; warm-loaded file. And by putting it in this warm-loaded file, we
-;;;; make it easy for it to get to the C-level 'environ' variable.
-;;;; which (at least in sbcl-0.6.10 on Red Hat Linux 6.2) is not
-;;;; visible at GENESIS time.
-
-#-win32
-(progn
- (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 (wrapped-environ))))
-
-;#+win32 (sb-alien:define-alien-routine msvcrt-environ (* c-string))
-
-;;; 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!"))
-;;; WARNING:
-;;; smashing case of "Bletch=fub" in conversion to CMU-CL-style
-;;; environment alist
-;;; WARNING:
-;;; no #\= in "Noggin", eliding it in CMU-CL-style environment alist
-;;; ((:BLETCH . "fub") (:YES . "No!"))
-(defun unix-environment-cmucl-from-sbcl (sbcl)
- (mapcan
- (lambda (string)
- (declare (type simple-base-string string))
- (let ((=-pos (position #\= string :test #'equal)))
- (if =-pos
- (list
- (let* ((key-as-string (subseq string 0 =-pos))
- (key-as-upcase-string (string-upcase key-as-string))
- (key (keywordicate key-as-upcase-string))
- (val (subseq string (1+ =-pos))))
- (unless (string= key-as-string key-as-upcase-string)
- (warn "smashing case of ~S in conversion to CMU-CL-style ~
- environment alist"
- string))
- (cons key val)))
- (warn "no #\\= in ~S, eliding it in CMU-CL-style environment alist"
- string))))
- sbcl))
-
-;;; Convert from a CMU CL representation of a Unix environment to a
-;;; SBCL representation.
-(defun unix-environment-sbcl-from-cmucl (cmucl)
- (mapcar
- (lambda (cons)
- (destructuring-bind (key . val) cons
- (declare (type keyword key) (type simple-base-string val))
- (concatenate 'simple-base-string (symbol-name key) "=" val)))
- cmucl))
-\f
-;;;; Import wait3(2) from Unix.
-
-#-win32
-(define-alien-routine ("wait3" c-wait3) sb-alien:int
- (status sb-alien:int :out)
- (options sb-alien:int)
- (rusage sb-alien:int))
-
-#-win32
-(defun wait3 (&optional do-not-hang check-for-stopped)
- #+sb-doc
- "Return any available status information on child process. "
- (multiple-value-bind (pid status)
- (c-wait3 (logior (if do-not-hang
- sb-unix:wnohang
- 0)
- (if check-for-stopped
- sb-unix:wuntraced
- 0))
- 0)
- (cond ((or (minusp pid)
- (zerop pid))
- nil)
- ((eql (ldb (byte 8 0) status)
- sb-unix:wstopped)
- (values pid
- :stopped
- (ldb (byte 8 8) status)))
- ((zerop (ldb (byte 7 0) status))
- (values pid
- :exited
- (ldb (byte 8 8) status)))
- (t
- (let ((signal (ldb (byte 7 0) status)))
- (values pid
- (if (position signal
- #.(vector
- sb-unix:sigstop
- sb-unix:sigtstp
- sb-unix:sigttin
- sb-unix:sigttou))
- :stopped
- :signaled)
- signal
- (not (zerop (ldb (byte 1 7) status)))))))))
-\f
-;;;; process control stuff
-(defvar *active-processes* nil
- #+sb-doc
- "List of process structures for all active processes.")
-
-#-win32
-(defvar *active-processes-lock*
- (sb-thread:make-mutex :name "Lock for active processes."))
-
-;;; *ACTIVE-PROCESSES* can be accessed from multiple threads so a
-;;; mutex is needed. More importantly the sigchld signal handler also
-;;; accesses it, that's why we need without-interrupts.
-(defmacro with-active-processes-lock (() &body body)
- #-win32
- `(without-interrupts
- (sb-thread:with-mutex (*active-processes-lock*)
- ,@body))
- #+win32
- `(progn ,@body))
-
-(defstruct (process (:copier nil))
- pid ; PID of child process
- %status ; either :RUNNING, :STOPPED, :EXITED, or :SIGNALED
- exit-code ; either exit code or signal
- core-dumped ; T if a core image was dumped
- #-win32 pty ; stream to child's pty, or NIL
- input ; stream to child's input, or NIL
- output ; stream from child's output, or NIL
- error ; stream from child's error output, or NIL
- status-hook ; closure to call when PROC changes status
- plist ; a place for clients to stash things
- cookie) ; list of the number of pipes from the subproc
-
-(defmethod print-object ((process process) stream)
- (print-unreadable-object (process stream :type t)
- (let ((status (process-status process)))
- (if (eq :exited status)
- (format stream "~S ~S" status (process-exit-code process))
- (format stream "~S ~S" (process-pid process) status)))
- process))
-
-#+sb-doc
-(setf (documentation 'process-p 'function)
- "T if OBJECT is a PROCESS, NIL otherwise.")
-
-#+sb-doc
-(setf (documentation 'process-pid 'function) "The pid of the child process.")
-
-#+win32
-(define-alien-routine ("GetExitCodeProcess@8" get-exit-code-process)
- int
- (handle unsigned) (exit-code unsigned :out))
-
-(defun process-status (process)
- #+sb-doc
- "Return the current status of PROCESS. The result is one of :RUNNING,
- :STOPPED, :EXITED, or :SIGNALED."
- (get-processes-status-changes)
- (process-%status process))
-
-#+sb-doc
-(setf (documentation 'process-exit-code 'function)
- "The exit code or the signal of a stopped process.")
-
-#+sb-doc
-(setf (documentation 'process-core-dumped 'function)
- "T if a core image was dumped by the process.")
-
-#+sb-doc
-(setf (documentation 'process-pty 'function)
- "The pty stream of the process or NIL.")
-
-#+sb-doc
-(setf (documentation 'process-input 'function)
- "The input stream of the process or NIL.")
-
-#+sb-doc
-(setf (documentation 'process-output 'function)
- "The output stream of the process or NIL.")
-
-#+sb-doc
-(setf (documentation 'process-error 'function)
- "The error stream of the process or NIL.")
-
-#+sb-doc
-(setf (documentation 'process-status-hook 'function)
- "A function that is called when PROCESS changes its status.
-The function is called with PROCESS as its only argument.")
-
-#+sb-doc
-(setf (documentation 'process-plist 'function)
- "A place for clients to stash things.")
-
-(defun process-wait (process &optional check-for-stopped)
- #+sb-doc
- "Wait for PROCESS to quit running for some reason. When
-CHECK-FOR-STOPPED is T, also returns when PROCESS is stopped. Returns
-PROCESS."
- (loop
- (case (process-status process)
- (:running)
- (:stopped
- (when check-for-stopped
- (return)))
- (t
- (when (zerop (car (process-cookie process)))
- (return))))
- (sb-sys:serve-all-events 1))
- process)
-
-#-(or hpux win32)
-;;; Find the current foreground process group id.
-(defun find-current-foreground-process (proc)
- (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
- (alien-sap (sb-alien:addr result)))
- (unless wonp
- (error "TIOCPGRP ioctl failed: ~S" (strerror error)))
- result))
- (process-pid proc))
-
-#-win32
-(defun process-kill (process signal &optional (whom :pid))
- #+sb-doc
- "Hand SIGNAL to PROCESS. If WHOM is :PID, use the kill Unix system call. If
- WHOM is :PROCESS-GROUP, use the killpg Unix system call. If WHOM is
- :PTY-PROCESS-GROUP deliver the signal to whichever process group is
- currently in the foreground."
- (let ((pid (ecase whom
- ((:pid :process-group)
- (process-pid process))
- (:pty-process-group
- #-hpux
- (find-current-foreground-process process)))))
- (multiple-value-bind
- (okay errno)
- (case whom
- #+hpux
- (:pty-process-group
- (sb-unix:unix-ioctl (sb-sys:fd-stream-fd (process-pty process))
- sb-unix:TIOCSIGSEND
- (sb-sys:int-sap
- signal)))
- ((:process-group #-hpux :pty-process-group)
- (sb-unix:unix-killpg pid signal))
- (t
- (sb-unix:unix-kill pid signal)))
- (cond ((not okay)
- (values nil errno))
- ((and (eql pid (process-pid process))
- (= signal sb-unix:sigcont))
- (setf (process-%status process) :running)
- (setf (process-exit-code process) nil)
- (when (process-status-hook process)
- (funcall (process-status-hook process) process))
- t)
- (t
- t)))))
-
-(defun process-alive-p (process)
- #+sb-doc
- "Return T if PROCESS is still alive, NIL otherwise."
- (let ((status (process-status process)))
- (if (or (eq status :running)
- (eq status :stopped))
- t
- nil)))
-
-(defun process-close (process)
- #+sb-doc
- "Close all streams connected to PROCESS and stop maintaining the
-status slot."
- (macrolet ((frob (stream abort)
- `(when ,stream (close ,stream :abort ,abort))))
- #-win32
- (frob (process-pty process) t) ; Don't FLUSH-OUTPUT to dead process,
- (frob (process-input process) t) ; .. 'cause it will generate SIGPIPE.
- (frob (process-output process) nil)
- (frob (process-error process) nil))
- ;; FIXME: Given that the status-slot is no longer updated,
- ;; maybe it should be set to :CLOSED, or similar?
- (with-active-processes-lock ()
- (setf *active-processes* (delete process *active-processes*)))
- process)
-
-;;; the handler for SIGCHLD signals that RUN-PROGRAM establishes
-#-win32
-(defun sigchld-handler (ignore1 ignore2 ignore3)
- (declare (ignore ignore1 ignore2 ignore3))
- (get-processes-status-changes))
-
-(defun get-processes-status-changes ()
- #-win32
- (loop
- (multiple-value-bind (pid what code core)
- (wait3 t t)
- (unless pid
- (return))
- (let ((proc (with-active-processes-lock ()
- (find pid *active-processes* :key #'process-pid))))
- (when proc
- (setf (process-%status proc) what)
- (setf (process-exit-code proc) code)
- (setf (process-core-dumped proc) core)
- (when (process-status-hook proc)
- (funcall (process-status-hook proc) proc))
- (when (position what #(:exited :signaled))
- (with-active-processes-lock ()
- (setf *active-processes*
- (delete proc *active-processes*))))))))
- #+win32
- (let (exited)
- (with-active-processes-lock ()
- (setf *active-processes*
- (delete-if (lambda (proc)
- (multiple-value-bind (ok code)
- (get-exit-code-process (process-pid proc))
- (when (and (plusp ok) (/= code 259))
- (setf (process-%status proc) :exited
- (process-exit-code proc) code)
- (when (process-status-hook proc)
- (push proc exited))
- t)))
- *active-processes*)))
- ;; Can't call the hooks before all the processes have been deal
- ;; with, as calling a hook may cause re-entry to
- ;; GET-PROCESS-STATUS-CHANGES. That may be OK when using wait3,
- ;; but in the Windows implementation is would be deeply bad.
- (dolist (proc exited)
- (let ((hook (process-status-hook proc)))
- (when hook
- (funcall hook proc))))))
-\f
-;;;; RUN-PROGRAM and close friends
-
-;;; list of file descriptors to close when RUN-PROGRAM exits due to an error
-(defvar *close-on-error* nil)
-
-;;; list of file descriptors to close when RUN-PROGRAM returns in the parent
-(defvar *close-in-parent* nil)
-
-;;; list of handlers installed by RUN-PROGRAM
-#-win32
-(defvar *handlers-installed* nil)
-
-;;; 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.
-#-win32
-(defun find-a-pty ()
- (dolist (char '(#\p #\q))
- (dotimes (digit 16)
- (let* ((master-name (coerce (format nil "/dev/pty~C~X" char digit) 'base-string))
- (master-fd (sb-unix:unix-open master-name
- sb-unix:o_rdwr
- #o666)))
- (when master-fd
- (let* ((slave-name (coerce (format nil "/dev/tty~C~X" char digit) 'base-string))
- (slave-fd (sb-unix:unix-open slave-name
- sb-unix:o_rdwr
- #o666)))
- (when slave-fd
- (return-from find-a-pty
- (values master-fd
- slave-fd
- slave-name)))
- (sb-unix:unix-close master-fd))))))
- (error "could not find a pty"))
-
-#-win32
-(defun open-pty (pty cookie)
- (when pty
- (multiple-value-bind
- (master slave name)
- (find-a-pty)
- (push master *close-on-error*)
- (push slave *close-in-parent*)
- (when (streamp pty)
- (multiple-value-bind (new-fd errno) (sb-unix:unix-dup master)
- (unless new-fd
- (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
- (sb-sys:make-fd-stream master :input t :output t
- :element-type :default
- :dual-channel-p t)))))
-
-(defmacro round-bytes-to-words (n)
- `(logand (the fixnum (+ (the fixnum ,n) 3)) (lognot 3)))
-
-(defun string-list-to-c-strvec (string-list)
- ;; Make a pass over STRING-LIST to calculate the amount of memory
- ;; needed to hold the strvec.
- (let ((string-bytes 0)
- ;; We need an extra for the null, and an extra 'cause exect
- ;; clobbers argv[-1].
- (vec-bytes (* #.(/ sb-vm::n-machine-word-bits sb-vm::n-byte-bits)
- (+ (length string-list) 2))))
- (declare (fixnum string-bytes vec-bytes))
- (dolist (s string-list)
- (enforce-type s simple-string)
- (incf string-bytes (round-bytes-to-words (1+ (length s)))))
- ;; Now allocate the memory and fill it in.
- (let* ((total-bytes (+ string-bytes vec-bytes))
- (vec-sap (sb-sys:allocate-system-memory total-bytes))
- (string-sap (sap+ vec-sap vec-bytes))
- (i #.(/ sb-vm::n-machine-word-bits sb-vm::n-byte-bits)))
- (declare (type (and unsigned-byte fixnum) total-bytes i)
- (type sb-sys:system-area-pointer vec-sap string-sap))
- (dolist (s string-list)
- (declare (simple-string s))
- (let ((n (length s)))
- ;; Blast the string into place.
- (sb-kernel:copy-ub8-to-system-area (the simple-base-string
- ;; FIXME
- (coerce s 'simple-base-string))
- 0
- string-sap 0
- (1+ n))
- ;; 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))))
- (incf i #.(/ sb-vm::n-machine-word-bits sb-vm::n-byte-bits))))
- ;; Blast in the last null pointer.
- (setf (sap-ref-sap vec-sap i) (int-sap 0))
- (values vec-sap (sap+ vec-sap #.(/ sb-vm::n-machine-word-bits
- sb-vm::n-byte-bits))
- total-bytes))))
-
-(defmacro with-c-strvec ((var str-list) &body body)
- (with-unique-names (sap size)
- `(multiple-value-bind
- (,sap ,var ,size)
- (string-list-to-c-strvec ,str-list)
- (unwind-protect
- (progn
- ,@body)
- (sb-sys:deallocate-system-memory ,sap ,size)))))
-
-#-win32
-(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))
-
-#+win32
-(sb-alien:define-alien-routine spawn sb-win32::handle
- (program sb-alien:c-string)
- (argv (* sb-alien:c-string))
- (stdin sb-alien:int)
- (stdout sb-alien:int)
- (stderr sb-alien:int)
- (wait sb-alien:int))
-
-;;; Is UNIX-FILENAME the name of a file that we can execute?
-(defun unix-filename-is-executable-p (unix-filename)
- (let ((filename (coerce unix-filename 'base-string)))
- (values (and (eq (sb-unix:unix-file-kind filename) :file)
- #-win32
- (sb-unix:unix-access filename sb-unix:x_ok)))))
-
-(defun find-executable-in-search-path (pathname &optional
- (search-path (posix-getenv "PATH")))
- #+sb-doc
- "Find the first executable file matching PATHNAME in any of the
-colon-separated list of pathnames SEARCH-PATH"
- (let ((program #-win32 pathname
- #+win32 (merge-pathnames pathname (make-pathname :type "exe"))))
- (loop for end = (position #-win32 #\: #+win32 #\; 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
- (unix-namestring (merge-pathnames program truename)))
- when (and fullpath (unix-filename-is-executable-p 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
-;;; this comment should be merged into the doc string, and then this
-;;; comment can go away.
-;;;
-;;; RUN-PROGRAM uses fork() and execve() to run a different program.
-;;; Strange stuff happens to keep the Unix state of the world
-;;; coherent.
-;;;
-;;; The child process needs to get its input from somewhere, and send
-;;; its output (both standard and error) to somewhere. We have to do
-;;; different things depending on where these somewheres really are.
-;;;
-;;; For input, there are five options:
-;;; -- T: Just leave fd 0 alone. Pretty simple.
-;;; -- "file": Read from the file. We need to open the file and
-;;; pull the descriptor out of the stream. The parent should close
-;;; this stream after the child is up and running to free any
-;;; storage used in the parent.
-;;; -- NIL: Same as "file", but use "/dev/null" as the file.
-;;; -- :STREAM: Use Unix pipe() to create two descriptors. Use
-;;; SB-SYS:MAKE-FD-STREAM to create the output stream on the
-;;; writeable descriptor, and pass the readable descriptor to
-;;; the child. The parent must close the readable descriptor for
-;;; EOF to be passed up correctly.
-;;; -- a stream: If it's a fd-stream, just pull the descriptor out
-;;; of it. Otherwise make a pipe as in :STREAM, and copy
-;;; everything across.
-;;;
-;;; For output, there are five options:
-;;; -- T: Leave descriptor 1 alone.
-;;; -- "file": dump output to the file.
-;;; -- NIL: dump output to /dev/null.
-;;; -- :STREAM: return a stream that can be read from.
-;;; -- a stream: if it's a fd-stream, use the descriptor in it.
-;;; Otherwise, copy stuff from output to stream.
-;;;
-;;; For error, there are all the same options as output plus:
-;;; -- :OUTPUT: redirect to the same place as output.
-;;;
-;;; RUN-PROGRAM returns a PROCESS structure for the process if
-;;; the fork worked, and NIL if it did not.
-
-#-win32
-(defun run-program (program args
- &key
- (env nil env-p)
- (environment (if env-p
- (unix-environment-sbcl-from-cmucl env)
- (posix-environ))
- environment-p)
- (wait t)
- search
- pty
- input
- if-input-does-not-exist
- output
- (if-output-exists :error)
- (error :output)
- (if-error-exists :error)
- status-hook)
- #+sb-doc
- "RUN-PROGRAM creates a new Unix process running the Unix program
-found in the file specified by the PROGRAM argument. ARGS are the
-standard arguments that can be passed to a Unix program. For no
-arguments, use NIL (which means that just the name of the program is
-passed as arg 0).
-
-RUN-PROGRAM will return a PROCESS structure. See the CMU Common Lisp
-Users Manual for details about the PROCESS structure.
-
- Notes about Unix environments (as in the :ENVIRONMENT and :ENV args):
-
- - The SBCL implementation of RUN-PROGRAM, like Perl and many other
- programs, but unlike the original CMU CL implementation, copies
- the Unix environment by default.
-
- - Running Unix programs from a setuid process, or in any other
- situation where the Unix environment is under the control of someone
- else, is a mother lode of security problems. If you are contemplating
- doing this, read about it first. (The Perl community has a lot of good
- documentation about this and other security issues in script-like
- programs.)
-
- The &KEY arguments have the following meanings:
-
- :ENVIRONMENT
- 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.
- :PTY
- Either T, NIL, or a stream. Unless NIL, the subprocess is established
- under a PTY. If :pty is a stream, all output to this pty is sent to
- this stream, otherwise the PROCESS-PTY slot is filled in with a stream
- connected to pty that can read output and write input.
- :INPUT
- Either T, NIL, a pathname, a stream, or :STREAM. If T, the standard
- input for the current process is inherited. If NIL, /dev/null
- is used. If a pathname, the file so specified is used. If a stream,
- all the input is read from that stream and send to the subprocess. If
- :STREAM, the PROCESS-INPUT slot is filled in with a stream that sends
- its output to the process. Defaults to NIL.
- :IF-INPUT-DOES-NOT-EXIST (when :INPUT is the name of a file)
- can be one of:
- :ERROR to generate an error
- :CREATE to create an empty file
- NIL (the default) to return NIL from RUN-PROGRAM
- :OUTPUT
- Either T, NIL, a pathname, a stream, or :STREAM. If T, the standard
- output for the current process is inherited. If NIL, /dev/null
- is used. If a pathname, the file so specified is used. If a stream,
- all the output from the process is written to this stream. If
- :STREAM, the PROCESS-OUTPUT slot is filled in with a stream that can
- be read to get the output. Defaults to NIL.
- :IF-OUTPUT-EXISTS (when :OUTPUT is the name of a file)
- can be one of:
- :ERROR (the default) to generate an error
- :SUPERSEDE to supersede the file with output from the program
- :APPEND to append output from the program to the file
- NIL to return NIL from RUN-PROGRAM, without doing anything
- :ERROR and :IF-ERROR-EXISTS
- Same as :OUTPUT and :IF-OUTPUT-EXISTS, except that :ERROR can also be
- specified as :OUTPUT in which case all error output is routed to the
- same place as normal output.
- :STATUS-HOOK
- This is a function the system calls whenever the status of the
- process changes. The function takes the process as an argument."
- (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 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
- ;; communicate cleanup info.
- *close-on-error*
- *close-in-parent*
- *handlers-installed*
- ;; Establish PROC at this level so that we can return it.
- proc
- ;; It's friendly to allow the caller to pass any string
- ;; designator, but internally we'd like SIMPLE-STRINGs.
- (simple-args (mapcar (lambda (x) (coerce x 'simple-string)) args)))
- (unwind-protect
- (let ((pfile
- (if search
- (find-executable-in-search-path program)
- (unix-namestring program)))
- (cookie (list 0)))
- (unless pfile
- (error "no such program: ~S" program))
- (unless (unix-filename-is-executable-p pfile)
- (error "not executable: ~S" program))
- (multiple-value-bind (stdin input-stream)
- (get-descriptor-for input cookie
- :direction :input
- :if-does-not-exist if-input-does-not-exist)
- (multiple-value-bind (stdout output-stream)
- (get-descriptor-for output cookie
- :direction :output
- :if-exists if-output-exists)
- (multiple-value-bind (stderr error-stream)
- (if (eq error :output)
- (values stdout output-stream)
- (get-descriptor-for error cookie
- :direction :output
- :if-exists if-error-exists))
- (multiple-value-bind (pty-name pty-stream)
- (open-pty pty cookie)
- ;; Make sure we are not notified about the child
- ;; death before we have installed the PROCESS
- ;; structure in *ACTIVE-PROCESSES*.
- (with-active-processes-lock ()
- (with-c-strvec (args-vec simple-args)
- (with-c-strvec (environment-vec environment)
- (let ((child-pid
- (without-gcing
- (spawn pfile args-vec environment-vec pty-name
- stdin stdout stderr))))
- (when (< child-pid 0)
- (error "couldn't fork child process: ~A"
- (strerror)))
- (setf proc (make-process :pid child-pid
- :%status :running
- :pty pty-stream
- :input input-stream
- :output output-stream
- :error error-stream
- :status-hook status-hook
- :cookie cookie))
- (push proc *active-processes*))))))))))
- (dolist (fd *close-in-parent*)
- (sb-unix:unix-close fd))
- (unless proc
- (dolist (fd *close-on-error*)
- (sb-unix:unix-close fd))
- (dolist (handler *handlers-installed*)
- (sb-sys:remove-fd-handler handler))))
- (when (and wait proc)
- (process-wait proc))
- proc))
-
-#+win32
-(defun run-program (program args
- &key
- (wait t)
- search
- input
- if-input-does-not-exist
- output
- (if-output-exists :error)
- (error :output)
- (if-error-exists :error)
- status-hook)
- "RUN-PROGRAM creates a new process specified by the PROGRAM
-argument. ARGS are the standard arguments that can be passed to a
-program. For no arguments, use NIL (which means that just the name of
-the program is passed as arg 0).
-
-RUN-PROGRAM will either return a PROCESS structure. See the CMU
-Common Lisp Users Manual for details about the PROCESS structure.
-
- The &KEY arguments have the following meanings:
- :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.
- :INPUT
- Either T, NIL, a pathname, a stream, or :STREAM. If T, the standard
- input for the current process is inherited. If NIL, /dev/null
- is used. If a pathname, the file so specified is used. If a stream,
- all the input is read from that stream and send to the subprocess. If
- :STREAM, the PROCESS-INPUT slot is filled in with a stream that sends
- its output to the process. Defaults to NIL.
- :IF-INPUT-DOES-NOT-EXIST (when :INPUT is the name of a file)
- can be one of:
- :ERROR to generate an error
- :CREATE to create an empty file
- NIL (the default) to return NIL from RUN-PROGRAM
- :OUTPUT
- Either T, NIL, a pathname, a stream, or :STREAM. If T, the standard
- output for the current process is inherited. If NIL, /dev/null
- is used. If a pathname, the file so specified is used. If a stream,
- all the output from the process is written to this stream. If
- :STREAM, the PROCESS-OUTPUT slot is filled in with a stream that can
- be read to get the output. Defaults to NIL.
- :IF-OUTPUT-EXISTS (when :OUTPUT is the name of a file)
- can be one of:
- :ERROR (the default) to generate an error
- :SUPERSEDE to supersede the file with output from the program
- :APPEND to append output from the program to the file
- NIL to return NIL from RUN-PROGRAM, without doing anything
- :ERROR and :IF-ERROR-EXISTS
- Same as :OUTPUT and :IF-OUTPUT-EXISTS, except that :ERROR can also be
- specified as :OUTPUT in which case all error output is routed to the
- same place as normal output.
- :STATUS-HOOK
- This is a function the system calls whenever the status of the
- process changes. The function takes the process as an argument."
- ;; Prepend the program to the argument list.
- (push (namestring program) args)
- (let (;; Clear various specials used by GET-DESCRIPTOR-FOR to
- ;; communicate cleanup info.
- *close-on-error*
- *close-in-parent*
- ;; Establish PROC at this level so that we can return it.
- proc
- ;; It's friendly to allow the caller to pass any string
- ;; designator, but internally we'd like SIMPLE-STRINGs.
- (simple-args (mapcar (lambda (x) (coerce x 'simple-string)) args)))
- (unwind-protect
- (let ((pfile
- (if search
- (find-executable-in-search-path program)
- (unix-namestring program)))
- (cookie (list 0)))
- (unless pfile
- (error "No such program: ~S" program))
- (unless (unix-filename-is-executable-p pfile)
- (error "Not an executable: ~S" program))
- (multiple-value-bind (stdin input-stream)
- (get-descriptor-for input cookie
- :direction :input
- :if-does-not-exist if-input-does-not-exist)
- (multiple-value-bind (stdout output-stream)
- (get-descriptor-for output cookie
- :direction :output
- :if-exists if-output-exists)
- (multiple-value-bind (stderr error-stream)
- (if (eq error :output)
- (values stdout output-stream)
- (get-descriptor-for error cookie
- :direction :output
- :if-exists if-error-exists))
- (with-c-strvec (args-vec simple-args)
- (let ((handle (without-gcing
- (spawn pfile args-vec
- stdin stdout stderr
- (if wait 1 0)))))
- (when (< handle 0)
- (error "Couldn't spawn program: ~A" (strerror)))
- (setf proc
- (if wait
- (make-process :%status :exited
- :exit-code handle)
- (make-process :pid handle
- :%status :running
- :input input-stream
- :output output-stream
- :error error-stream
- :status-hook status-hook
- :cookie cookie))))))))))
- ;; FIXME: this should probably use PROCESS-WAIT instead instead
- ;; of special argument to SPAWN.
- (unless wait
- (push proc *active-processes*))
- (when (and wait status-hook)
- (funcall status-hook proc))
- proc))
-
-;;; Install a handler for any input that shows up on the file
-;;; descriptor. The handler reads the data and writes it to the
-;;; stream.
-(defun copy-descriptor-to-stream (descriptor stream cookie)
- (incf (car cookie))
- (let ((string (make-string 256 :element-type 'base-char))
- handler)
- (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: ~
- ~2I~_~A~:>"
- (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 (#-win32(or (and (null count)
- (eql errno sb-unix:eio))
- (eql count 0))
- #+win32(<= 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-ub8-from-system-area
- (alien-sap buf) 0
- string 0
- count)
- (write-string string stream
- :end count)))))))))))
-
-(defun get-stream-fd (stream direction)
- (typecase stream
- (sb-sys:fd-stream
- (values (sb-sys:fd-stream-fd stream) nil))
- (synonym-stream
- (get-stream-fd (symbol-value (synonym-stream-symbol stream)) direction))
- (two-way-stream
- (ecase direction
- (:input
- (get-stream-fd (two-way-stream-input-stream stream) direction))
- (:output
- (get-stream-fd (two-way-stream-output-stream stream) direction))))))
-
-;;; Find a file descriptor to use for object given the direction.
-;;; Returns the descriptor. If object is :STREAM, returns the created
-;;; stream as the second value.
-(defun get-descriptor-for (object
- cookie
- &rest keys
- &key direction
- &allow-other-keys)
- (cond ((eq object t)
- ;; No new descriptor is needed.
- (values -1 nil))
- ((eq object nil)
- ;; Use /dev/null.
- (multiple-value-bind
- (fd errno)
- (sb-unix:unix-open #-win32 #.(coerce "/dev/null" 'base-string)
- #+win32 #.(coerce "nul" 'base-string)
- (case direction
- (:input sb-unix:o_rdonly)
- (:output sb-unix:o_wronly)
- (t sb-unix:o_rdwr))
- #o666)
- (unless fd
- (error "~@<couldn't open \"/dev/null\": ~2I~_~A~:>"
- (strerror errno)))
- (push fd *close-in-parent*)
- (values fd nil)))
- ((eq object :stream)
- (multiple-value-bind (read-fd write-fd) (sb-unix:unix-pipe)
- (unless read-fd
- (error "couldn't create pipe: ~A" (strerror write-fd)))
- (case direction
- (:input
- (push read-fd *close-in-parent*)
- (push write-fd *close-on-error*)
- (let ((stream (sb-sys:make-fd-stream write-fd :output t
- :element-type :default)))
- (values read-fd stream)))
- (:output
- (push read-fd *close-on-error*)
- (push write-fd *close-in-parent*)
- (let ((stream (sb-sys:make-fd-stream read-fd :input t
- :element-type :default)))
- (values write-fd stream)))
- (t
- (sb-unix:unix-close read-fd)
- (sb-unix:unix-close write-fd)
- (error "Direction must be either :INPUT or :OUTPUT, not ~S."
- direction)))))
- ((or (pathnamep object) (stringp object))
- (with-open-stream (file (apply #'open object keys))
- (multiple-value-bind
- (fd errno)
- (sb-unix:unix-dup (sb-sys:fd-stream-fd file))
- (cond (fd
- (push fd *close-in-parent*)
- (values fd nil))
- (t
- (error "couldn't duplicate file descriptor: ~A"
- (strerror errno)))))))
- ((streamp object)
- (ecase direction
- (:input
- (or (get-stream-fd object :input)
- ;; FIXME: We could use a better way of setting up
- ;; temporary files
- (dotimes (count
- 256
- (error "could not open a temporary file in /tmp"))
- (let* ((name (coerce (format nil "/tmp/.run-program-~D" count)
- 'base-string))
- (fd (sb-unix:unix-open name
- (logior sb-unix:o_rdwr
- sb-unix:o_creat
- sb-unix:o_excl)
- #o666)))
- (sb-unix:unix-unlink name)
- (when fd
- (let ((newline (string #\Newline)))
- (loop
- (multiple-value-bind
- (line no-cr)
- (read-line object nil nil)
- (unless line
- (return))
- (sb-unix:unix-write
- fd
- ;; FIXME: this really should be
- ;; (STRING-TO-OCTETS :EXTERNAL-FORMAT ...).
- ;; RUN-PROGRAM should take an
- ;; external-format argument, which should
- ;; be passed down to here. Something
- ;; similar should happen on :OUTPUT, too.
- (map '(vector (unsigned-byte 8)) #'char-code line)
- 0 (length line))
- (if no-cr
- (return)
- (sb-unix:unix-write fd newline 0 1)))))
- (sb-unix:unix-lseek fd 0 sb-unix:l_set)
- (push fd *close-in-parent*)
- (return (values fd nil)))))))
- (:output
- (or (get-stream-fd object :output)
- (multiple-value-bind (read-fd write-fd)
- (sb-unix:unix-pipe)
- (unless read-fd
- (error "couldn't create pipe: ~S" (strerror write-fd)))
- (copy-descriptor-to-stream read-fd object cookie)
- (push read-fd *close-on-error*)
- (push write-fd *close-in-parent*)
- (values write-fd nil))))))
- (t
- (error "invalid option to RUN-PROGRAM: ~S" object))))
+;;;; RUN-PROGRAM and friends, a facility for running Unix programs\r
+;;;; from inside SBCL\r
+\r
+;;;; This software is part of the SBCL system. See the README file for\r
+;;;; more information.\r
+;;;;\r
+;;;; This software is derived from the CMU CL system, which was\r
+;;;; written at Carnegie Mellon University and released into the\r
+;;;; public domain. The software is in the public domain and is\r
+;;;; provided with absolutely no warranty. See the COPYING and CREDITS\r
+;;;; files for more information.\r
+\r
+(in-package "SB-IMPL") ;(SB-IMPL, not SB!IMPL, since we're built in warm load.)\r
+\f\r
+;;;; hacking the Unix environment\r
+;;;;\r
+;;;; In the original CMU CL code that LOAD-FOREIGN is derived from, the\r
+;;;; Unix environment (as in "man environ") was represented as an\r
+;;;; alist from keywords to strings, so that e.g. the Unix environment\r
+;;;; "SHELL=/bin/bash" "HOME=/root" "PAGER=less"\r
+;;;; was represented as\r
+;;;; ((:SHELL . "/bin/bash") (:HOME . "/root") (:PAGER "less"))\r
+;;;; This had a few problems in principle: the mapping into\r
+;;;; keyword symbols smashed the case of environment\r
+;;;; variables, and the whole mapping depended on the presence of\r
+;;;; #\= characters in the environment strings. In practice these\r
+;;;; problems weren't hugely important, since conventionally environment\r
+;;;; variables are uppercase strings followed by #\= followed by\r
+;;;; arbitrary data. However, since it's so manifestly not The Right\r
+;;;; Thing to make code which breaks unnecessarily on input which\r
+;;;; doesn't follow what is, after all, only a tradition, we've switched\r
+;;;; formats in SBCL, so that the fundamental environment list\r
+;;;; is just a list of strings, with a one-to-one-correspondence\r
+;;;; to the C-level representation. I.e., in the example above,\r
+;;;; the SBCL representation is\r
+;;;; '("SHELL=/bin/bash" "HOME=/root" "PAGER=less")\r
+;;;; CMU CL's implementation is currently supported to help with porting.\r
+;;;;\r
+;;;; It's not obvious that this code belongs here (instead of e.g. in\r
+;;;; unix.lisp), since it has only a weak logical connection with\r
+;;;; RUN-PROGRAM. However, physically it's convenient to put it here.\r
+;;;; It's not needed at cold init, so we *can* put it in this\r
+;;;; warm-loaded file. And by putting it in this warm-loaded file, we\r
+;;;; make it easy for it to get to the C-level 'environ' variable.\r
+;;;; which (at least in sbcl-0.6.10 on Red Hat Linux 6.2) is not\r
+;;;; visible at GENESIS time.\r
+\r
+#-win32\r
+(progn\r
+ (define-alien-routine wrapped-environ (* c-string))\r
+ (defun posix-environ ()\r
+ "Return the Unix environment (\"man environ\") as a list of SIMPLE-STRINGs."\r
+ (c-strings->string-list (wrapped-environ))))\r
+\r
+;#+win32 (sb-alien:define-alien-routine msvcrt-environ (* c-string))\r
+\r
+;;; Convert as best we can from an SBCL representation of a Unix\r
+;;; environment to a CMU CL representation.\r
+;;;\r
+;;; * (UNIX-ENVIRONMENT-CMUCL-FROM-SBCL '("Bletch=fub" "Noggin" "YES=No!"))\r
+;;; WARNING:\r
+;;; smashing case of "Bletch=fub" in conversion to CMU-CL-style\r
+;;; environment alist\r
+;;; WARNING:\r
+;;; no #\= in "Noggin", eliding it in CMU-CL-style environment alist\r
+;;; ((:BLETCH . "fub") (:YES . "No!"))\r
+(defun unix-environment-cmucl-from-sbcl (sbcl)\r
+ (mapcan\r
+ (lambda (string)\r
+ (declare (type simple-base-string string))\r
+ (let ((=-pos (position #\= string :test #'equal)))\r
+ (if =-pos\r
+ (list\r
+ (let* ((key-as-string (subseq string 0 =-pos))\r
+ (key-as-upcase-string (string-upcase key-as-string))\r
+ (key (keywordicate key-as-upcase-string))\r
+ (val (subseq string (1+ =-pos))))\r
+ (unless (string= key-as-string key-as-upcase-string)\r
+ (warn "smashing case of ~S in conversion to CMU-CL-style ~\r
+ environment alist"\r
+ string))\r
+ (cons key val)))\r
+ (warn "no #\\= in ~S, eliding it in CMU-CL-style environment alist"\r
+ string))))\r
+ sbcl))\r
+\r
+;;; Convert from a CMU CL representation of a Unix environment to a\r
+;;; SBCL representation.\r
+(defun unix-environment-sbcl-from-cmucl (cmucl)\r
+ (mapcar\r
+ (lambda (cons)\r
+ (destructuring-bind (key . val) cons\r
+ (declare (type keyword key) (type simple-base-string val))\r
+ (concatenate 'simple-base-string (symbol-name key) "=" val)))\r
+ cmucl))\r
+\f\r
+;;;; Import wait3(2) from Unix.\r
+\r
+#-win32\r
+(define-alien-routine ("wait3" c-wait3) sb-alien:int\r
+ (status sb-alien:int :out)\r
+ (options sb-alien:int)\r
+ (rusage sb-alien:int))\r
+\r
+#-win32\r
+(defun wait3 (&optional do-not-hang check-for-stopped)\r
+ #+sb-doc\r
+ "Return any available status information on child process. "\r
+ (multiple-value-bind (pid status)\r
+ (c-wait3 (logior (if do-not-hang\r
+ sb-unix:wnohang\r
+ 0)\r
+ (if check-for-stopped\r
+ sb-unix:wuntraced\r
+ 0))\r
+ 0)\r
+ (cond ((or (minusp pid)\r
+ (zerop pid))\r
+ nil)\r
+ ((eql (ldb (byte 8 0) status)\r
+ sb-unix:wstopped)\r
+ (values pid\r
+ :stopped\r
+ (ldb (byte 8 8) status)))\r
+ ((zerop (ldb (byte 7 0) status))\r
+ (values pid\r
+ :exited\r
+ (ldb (byte 8 8) status)))\r
+ (t\r
+ (let ((signal (ldb (byte 7 0) status)))\r
+ (values pid\r
+ (if (position signal\r
+ #.(vector\r
+ sb-unix:sigstop\r
+ sb-unix:sigtstp\r
+ sb-unix:sigttin\r
+ sb-unix:sigttou))\r
+ :stopped\r
+ :signaled)\r
+ signal\r
+ (not (zerop (ldb (byte 1 7) status)))))))))\r
+\f\r
+;;;; process control stuff\r
+(defvar *active-processes* nil\r
+ #+sb-doc\r
+ "List of process structures for all active processes.")\r
+\r
+#-win32\r
+(defvar *active-processes-lock*\r
+ (sb-thread:make-mutex :name "Lock for active processes."))\r
+\r
+;;; *ACTIVE-PROCESSES* can be accessed from multiple threads so a\r
+;;; mutex is needed. More importantly the sigchld signal handler also\r
+;;; accesses it, that's why we need without-interrupts.\r
+(defmacro with-active-processes-lock (() &body body)\r
+ #-win32\r
+ `(without-interrupts\r
+ (sb-thread:with-mutex (*active-processes-lock*)\r
+ ,@body))\r
+ #+win32\r
+ `(progn ,@body))\r
+\r
+(defstruct (process (:copier nil))\r
+ pid ; PID of child process\r
+ %status ; either :RUNNING, :STOPPED, :EXITED, or :SIGNALED\r
+ exit-code ; either exit code or signal\r
+ core-dumped ; T if a core image was dumped\r
+ #-win32 pty ; stream to child's pty, or NIL\r
+ input ; stream to child's input, or NIL\r
+ output ; stream from child's output, or NIL\r
+ error ; stream from child's error output, or NIL\r
+ status-hook ; closure to call when PROC changes status\r
+ plist ; a place for clients to stash things\r
+ cookie) ; list of the number of pipes from the subproc\r
+\r
+(defmethod print-object ((process process) stream)\r
+ (print-unreadable-object (process stream :type t)\r
+ (let ((status (process-status process)))\r
+ (if (eq :exited status)\r
+ (format stream "~S ~S" status (process-exit-code process))\r
+ (format stream "~S ~S" (process-pid process) status)))\r
+ process))\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-p 'function)\r
+ "T if OBJECT is a PROCESS, NIL otherwise.")\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-pid 'function) "The pid of the child process.")\r
+\r
+#+win32\r
+(define-alien-routine ("GetExitCodeProcess@8" get-exit-code-process)\r
+ int\r
+ (handle unsigned) (exit-code unsigned :out))\r
+\r
+(defun process-status (process)\r
+ #+sb-doc\r
+ "Return the current status of PROCESS. The result is one of :RUNNING,\r
+ :STOPPED, :EXITED, or :SIGNALED."\r
+ (get-processes-status-changes)\r
+ (process-%status process))\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-exit-code 'function)\r
+ "The exit code or the signal of a stopped process.")\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-core-dumped 'function)\r
+ "T if a core image was dumped by the process.")\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-pty 'function)\r
+ "The pty stream of the process or NIL.")\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-input 'function)\r
+ "The input stream of the process or NIL.")\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-output 'function)\r
+ "The output stream of the process or NIL.")\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-error 'function)\r
+ "The error stream of the process or NIL.")\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-status-hook 'function)\r
+ "A function that is called when PROCESS changes its status.\r
+The function is called with PROCESS as its only argument.")\r
+\r
+#+sb-doc\r
+(setf (documentation 'process-plist 'function)\r
+ "A place for clients to stash things.")\r
+\r
+(defun process-wait (process &optional check-for-stopped)\r
+ #+sb-doc\r
+ "Wait for PROCESS to quit running for some reason. When\r
+CHECK-FOR-STOPPED is T, also returns when PROCESS is stopped. Returns\r
+PROCESS."\r
+ (loop\r
+ (case (process-status process)\r
+ (:running)\r
+ (:stopped\r
+ (when check-for-stopped\r
+ (return)))\r
+ (t\r
+ (when (zerop (car (process-cookie process)))\r
+ (return))))\r
+ (sb-sys:serve-all-events 1))\r
+ process)\r
+\r
+#-(or hpux win32)\r
+;;; Find the current foreground process group id.\r
+(defun find-current-foreground-process (proc)\r
+ (with-alien ((result sb-alien:int))\r
+ (multiple-value-bind\r
+ (wonp error)\r
+ (sb-unix:unix-ioctl (sb-sys:fd-stream-fd (process-pty proc))\r
+ sb-unix:TIOCGPGRP\r
+ (alien-sap (sb-alien:addr result)))\r
+ (unless wonp\r
+ (error "TIOCPGRP ioctl failed: ~S" (strerror error)))\r
+ result))\r
+ (process-pid proc))\r
+\r
+#-win32\r
+(defun process-kill (process signal &optional (whom :pid))\r
+ #+sb-doc\r
+ "Hand SIGNAL to PROCESS. If WHOM is :PID, use the kill Unix system call. If\r
+ WHOM is :PROCESS-GROUP, use the killpg Unix system call. If WHOM is\r
+ :PTY-PROCESS-GROUP deliver the signal to whichever process group is\r
+ currently in the foreground."\r
+ (let ((pid (ecase whom\r
+ ((:pid :process-group)\r
+ (process-pid process))\r
+ (:pty-process-group\r
+ #-hpux\r
+ (find-current-foreground-process process)))))\r
+ (multiple-value-bind\r
+ (okay errno)\r
+ (case whom\r
+ #+hpux\r
+ (:pty-process-group\r
+ (sb-unix:unix-ioctl (sb-sys:fd-stream-fd (process-pty process))\r
+ sb-unix:TIOCSIGSEND\r
+ (sb-sys:int-sap\r
+ signal)))\r
+ ((:process-group #-hpux :pty-process-group)\r
+ (sb-unix:unix-killpg pid signal))\r
+ (t\r
+ (sb-unix:unix-kill pid signal)))\r
+ (cond ((not okay)\r
+ (values nil errno))\r
+ ((and (eql pid (process-pid process))\r
+ (= signal sb-unix:sigcont))\r
+ (setf (process-%status process) :running)\r
+ (setf (process-exit-code process) nil)\r
+ (when (process-status-hook process)\r
+ (funcall (process-status-hook process) process))\r
+ t)\r
+ (t\r
+ t)))))\r
+\r
+(defun process-alive-p (process)\r
+ #+sb-doc\r
+ "Return T if PROCESS is still alive, NIL otherwise."\r
+ (let ((status (process-status process)))\r
+ (if (or (eq status :running)\r
+ (eq status :stopped))\r
+ t\r
+ nil)))\r
+\r
+(defun process-close (process)\r
+ #+sb-doc\r
+ "Close all streams connected to PROCESS and stop maintaining the\r
+status slot."\r
+ (macrolet ((frob (stream abort)\r
+ `(when ,stream (close ,stream :abort ,abort))))\r
+ #-win32\r
+ (frob (process-pty process) t) ; Don't FLUSH-OUTPUT to dead process,\r
+ (frob (process-input process) t) ; .. 'cause it will generate SIGPIPE.\r
+ (frob (process-output process) nil)\r
+ (frob (process-error process) nil))\r
+ ;; FIXME: Given that the status-slot is no longer updated,\r
+ ;; maybe it should be set to :CLOSED, or similar?\r
+ (with-active-processes-lock ()\r
+ (setf *active-processes* (delete process *active-processes*)))\r
+ process)\r
+\r
+;;; the handler for SIGCHLD signals that RUN-PROGRAM establishes\r
+#-win32\r
+(defun sigchld-handler (ignore1 ignore2 ignore3)\r
+ (declare (ignore ignore1 ignore2 ignore3))\r
+ (get-processes-status-changes))\r
+\r
+(defun get-processes-status-changes ()\r
+ #-win32\r
+ (loop\r
+ (multiple-value-bind (pid what code core)\r
+ (wait3 t t)\r
+ (unless pid\r
+ (return))\r
+ (let ((proc (with-active-processes-lock ()\r
+ (find pid *active-processes* :key #'process-pid))))\r
+ (when proc\r
+ (setf (process-%status proc) what)\r
+ (setf (process-exit-code proc) code)\r
+ (setf (process-core-dumped proc) core)\r
+ (when (process-status-hook proc)\r
+ (funcall (process-status-hook proc) proc))\r
+ (when (position what #(:exited :signaled))\r
+ (with-active-processes-lock ()\r
+ (setf *active-processes*\r
+ (delete proc *active-processes*))))))))\r
+ #+win32\r
+ (let (exited)\r
+ (with-active-processes-lock ()\r
+ (setf *active-processes*\r
+ (delete-if (lambda (proc)\r
+ (multiple-value-bind (ok code)\r
+ (get-exit-code-process (process-pid proc))\r
+ (when (and (plusp ok) (/= code 259))\r
+ (setf (process-%status proc) :exited\r
+ (process-exit-code proc) code)\r
+ (when (process-status-hook proc)\r
+ (push proc exited))\r
+ t)))\r
+ *active-processes*)))\r
+ ;; Can't call the hooks before all the processes have been deal\r
+ ;; with, as calling a hook may cause re-entry to\r
+ ;; GET-PROCESS-STATUS-CHANGES. That may be OK when using wait3,\r
+ ;; but in the Windows implementation is would be deeply bad.\r
+ (dolist (proc exited)\r
+ (let ((hook (process-status-hook proc)))\r
+ (when hook\r
+ (funcall hook proc))))))\r
+\f\r
+;;;; RUN-PROGRAM and close friends\r
+\r
+;;; list of file descriptors to close when RUN-PROGRAM exits due to an error\r
+(defvar *close-on-error* nil)\r
+\r
+;;; list of file descriptors to close when RUN-PROGRAM returns in the parent\r
+(defvar *close-in-parent* nil)\r
+\r
+;;; list of handlers installed by RUN-PROGRAM\r
+#-win32\r
+(defvar *handlers-installed* nil)\r
+\r
+;;; Find an unused pty. Return three values: the file descriptor for\r
+;;; the master side of the pty, the file descriptor for the slave side\r
+;;; of the pty, and the name of the tty device for the slave side.\r
+#-win32\r
+(defun find-a-pty ()\r
+ (dolist (char '(#\p #\q))\r
+ (dotimes (digit 16)\r
+ (let* ((master-name (coerce (format nil "/dev/pty~C~X" char digit) 'base-string))\r
+ (master-fd (sb-unix:unix-open master-name\r
+ sb-unix:o_rdwr\r
+ #o666)))\r
+ (when master-fd\r
+ (let* ((slave-name (coerce (format nil "/dev/tty~C~X" char digit) 'base-string))\r
+ (slave-fd (sb-unix:unix-open slave-name\r
+ sb-unix:o_rdwr\r
+ #o666)))\r
+ (when slave-fd\r
+ (return-from find-a-pty\r
+ (values master-fd\r
+ slave-fd\r
+ slave-name)))\r
+ (sb-unix:unix-close master-fd))))))\r
+ (error "could not find a pty"))\r
+\r
+#-win32\r
+(defun open-pty (pty cookie)\r
+ (when pty\r
+ (multiple-value-bind\r
+ (master slave name)\r
+ (find-a-pty)\r
+ (push master *close-on-error*)\r
+ (push slave *close-in-parent*)\r
+ (when (streamp pty)\r
+ (multiple-value-bind (new-fd errno) (sb-unix:unix-dup master)\r
+ (unless new-fd\r
+ (error "couldn't SB-UNIX:UNIX-DUP ~W: ~A" master (strerror errno)))\r
+ (push new-fd *close-on-error*)\r
+ (copy-descriptor-to-stream new-fd pty cookie)))\r
+ (values name\r
+ (sb-sys:make-fd-stream master :input t :output t\r
+ :element-type :default\r
+ :dual-channel-p t)))))\r
+\r
+(defmacro round-bytes-to-words (n)\r
+ `(logand (the fixnum (+ (the fixnum ,n) 3)) (lognot 3)))\r
+\r
+(defun string-list-to-c-strvec (string-list)\r
+ ;; Make a pass over STRING-LIST to calculate the amount of memory\r
+ ;; needed to hold the strvec.\r
+ (let ((string-bytes 0)\r
+ ;; We need an extra for the null, and an extra 'cause exect\r
+ ;; clobbers argv[-1].\r
+ (vec-bytes (* #.(/ sb-vm::n-machine-word-bits sb-vm::n-byte-bits)\r
+ (+ (length string-list) 2))))\r
+ (declare (fixnum string-bytes vec-bytes))\r
+ (dolist (s string-list)\r
+ (enforce-type s simple-string)\r
+ (incf string-bytes (round-bytes-to-words (1+ (length s)))))\r
+ ;; Now allocate the memory and fill it in.\r
+ (let* ((total-bytes (+ string-bytes vec-bytes))\r
+ (vec-sap (sb-sys:allocate-system-memory total-bytes))\r
+ (string-sap (sap+ vec-sap vec-bytes))\r
+ (i #.(/ sb-vm::n-machine-word-bits sb-vm::n-byte-bits)))\r
+ (declare (type (and unsigned-byte fixnum) total-bytes i)\r
+ (type sb-sys:system-area-pointer vec-sap string-sap))\r
+ (dolist (s string-list)\r
+ (declare (simple-string s))\r
+ (let ((n (length s)))\r
+ ;; Blast the string into place.\r
+ (sb-kernel:copy-ub8-to-system-area (the simple-base-string\r
+ ;; FIXME\r
+ (coerce s 'simple-base-string))\r
+ 0\r
+ string-sap 0\r
+ (1+ n))\r
+ ;; Blast the pointer to the string into place.\r
+ (setf (sap-ref-sap vec-sap i) string-sap)\r
+ (setf string-sap (sap+ string-sap (round-bytes-to-words (1+ n))))\r
+ (incf i #.(/ sb-vm::n-machine-word-bits sb-vm::n-byte-bits))))\r
+ ;; Blast in the last null pointer.\r
+ (setf (sap-ref-sap vec-sap i) (int-sap 0))\r
+ (values vec-sap (sap+ vec-sap #.(/ sb-vm::n-machine-word-bits\r
+ sb-vm::n-byte-bits))\r
+ total-bytes))))\r
+\r
+(defmacro with-c-strvec ((var str-list) &body body)\r
+ (with-unique-names (sap size)\r
+ `(multiple-value-bind\r
+ (,sap ,var ,size)\r
+ (string-list-to-c-strvec ,str-list)\r
+ (unwind-protect\r
+ (progn\r
+ ,@body)\r
+ (sb-sys:deallocate-system-memory ,sap ,size)))))\r
+\r
+#-win32\r
+(sb-alien:define-alien-routine spawn sb-alien:int\r
+ (program sb-alien:c-string)\r
+ (argv (* sb-alien:c-string))\r
+ (envp (* sb-alien:c-string))\r
+ (pty-name sb-alien:c-string)\r
+ (stdin sb-alien:int)\r
+ (stdout sb-alien:int)\r
+ (stderr sb-alien:int))\r
+\r
+#+win32\r
+(sb-alien:define-alien-routine spawn sb-win32::handle\r
+ (program sb-alien:c-string)\r
+ (argv (* sb-alien:c-string))\r
+ (stdin sb-alien:int)\r
+ (stdout sb-alien:int)\r
+ (stderr sb-alien:int)\r
+ (wait sb-alien:int))\r
+\r
+;;; Is UNIX-FILENAME the name of a file that we can execute?\r
+(defun unix-filename-is-executable-p (unix-filename)\r
+ (let ((filename (coerce unix-filename 'base-string)))\r
+ (values (and (eq (sb-unix:unix-file-kind filename) :file)\r
+ #-win32\r
+ (sb-unix:unix-access filename sb-unix:x_ok)))))\r
+\r
+(defun find-executable-in-search-path (pathname &optional\r
+ (search-path (posix-getenv "PATH")))\r
+ #+sb-doc\r
+ "Find the first executable file matching PATHNAME in any of the\r
+colon-separated list of pathnames SEARCH-PATH"\r
+ (let ((program #-win32 pathname\r
+ #+win32 (merge-pathnames pathname (make-pathname :type "exe"))))\r
+ (loop for end = (position #-win32 #\: #+win32 #\; search-path\r
+ :start (if end (1+ end) 0))\r
+ and start = 0 then (and end (1+ end))\r
+ while start\r
+ ;; <Krystof> the truename of a file naming a directory is the\r
+ ;; directory, at least until pfdietz comes along and says why\r
+ ;; that's noncompliant -- CSR, c. 2003-08-10\r
+ for truename = (probe-file (subseq search-path start end))\r
+ for fullpath = (when truename\r
+ (unix-namestring (merge-pathnames program truename)))\r
+ when (and fullpath (unix-filename-is-executable-p fullpath))\r
+ return fullpath)))\r
+\r
+;;; FIXME: There shouldn't be two semiredundant versions of the\r
+;;; documentation. Since this is a public extension function, the\r
+;;; documentation should be in the doc string. So all information from\r
+;;; this comment should be merged into the doc string, and then this\r
+;;; comment can go away.\r
+;;;\r
+;;; RUN-PROGRAM uses fork() and execve() to run a different program.\r
+;;; Strange stuff happens to keep the Unix state of the world\r
+;;; coherent.\r
+;;;\r
+;;; The child process needs to get its input from somewhere, and send\r
+;;; its output (both standard and error) to somewhere. We have to do\r
+;;; different things depending on where these somewheres really are.\r
+;;;\r
+;;; For input, there are five options:\r
+;;; -- T: Just leave fd 0 alone. Pretty simple.\r
+;;; -- "file": Read from the file. We need to open the file and\r
+;;; pull the descriptor out of the stream. The parent should close\r
+;;; this stream after the child is up and running to free any\r
+;;; storage used in the parent.\r
+;;; -- NIL: Same as "file", but use "/dev/null" as the file.\r
+;;; -- :STREAM: Use Unix pipe() to create two descriptors. Use\r
+;;; SB-SYS:MAKE-FD-STREAM to create the output stream on the\r
+;;; writeable descriptor, and pass the readable descriptor to\r
+;;; the child. The parent must close the readable descriptor for\r
+;;; EOF to be passed up correctly.\r
+;;; -- a stream: If it's a fd-stream, just pull the descriptor out\r
+;;; of it. Otherwise make a pipe as in :STREAM, and copy\r
+;;; everything across.\r
+;;;\r
+;;; For output, there are five options:\r
+;;; -- T: Leave descriptor 1 alone.\r
+;;; -- "file": dump output to the file.\r
+;;; -- NIL: dump output to /dev/null.\r
+;;; -- :STREAM: return a stream that can be read from.\r
+;;; -- a stream: if it's a fd-stream, use the descriptor in it.\r
+;;; Otherwise, copy stuff from output to stream.\r
+;;;\r
+;;; For error, there are all the same options as output plus:\r
+;;; -- :OUTPUT: redirect to the same place as output.\r
+;;;\r
+;;; RUN-PROGRAM returns a PROCESS structure for the process if\r
+;;; the fork worked, and NIL if it did not.\r
+\r
+#-win32\r
+(defun run-program (program args\r
+ &key\r
+ (env nil env-p)\r
+ (environment (if env-p\r
+ (unix-environment-sbcl-from-cmucl env)\r
+ (posix-environ))\r
+ environment-p)\r
+ (wait t)\r
+ search\r
+ pty\r
+ input\r
+ if-input-does-not-exist\r
+ output\r
+ (if-output-exists :error)\r
+ (error :output)\r
+ (if-error-exists :error)\r
+ status-hook)\r
+ #+sb-doc\r
+ "RUN-PROGRAM creates a new Unix process running the Unix program\r
+found in the file specified by the PROGRAM argument. ARGS are the\r
+standard arguments that can be passed to a Unix program. For no\r
+arguments, use NIL (which means that just the name of the program is\r
+passed as arg 0).\r
+\r
+RUN-PROGRAM will return a PROCESS structure. See the CMU Common Lisp\r
+Users Manual for details about the PROCESS structure.\r
+\r
+ Notes about Unix environments (as in the :ENVIRONMENT and :ENV args):\r
+\r
+ - The SBCL implementation of RUN-PROGRAM, like Perl and many other\r
+ programs, but unlike the original CMU CL implementation, copies\r
+ the Unix environment by default.\r
+\r
+ - Running Unix programs from a setuid process, or in any other\r
+ situation where the Unix environment is under the control of someone\r
+ else, is a mother lode of security problems. If you are contemplating\r
+ doing this, read about it first. (The Perl community has a lot of good\r
+ documentation about this and other security issues in script-like\r
+ programs.)\r
+\r
+ The &KEY arguments have the following meanings:\r
+\r
+ :ENVIRONMENT\r
+ a list of SIMPLE-BASE-STRINGs describing the new Unix environment\r
+ (as in \"man environ\"). The default is to copy the environment of\r
+ the current process.\r
+ :ENV\r
+ an alternative lossy representation of the new Unix environment,\r
+ for compatibility with CMU CL\r
+ :SEARCH\r
+ Look for PROGRAM in each of the directories along the $PATH\r
+ environment variable. Otherwise an absolute pathname is required.\r
+ (See also FIND-EXECUTABLE-IN-SEARCH-PATH)\r
+ :WAIT\r
+ If non-NIL (default), wait until the created process finishes. If\r
+ NIL, continue running Lisp until the program finishes.\r
+ :PTY\r
+ Either T, NIL, or a stream. Unless NIL, the subprocess is established\r
+ under a PTY. If :pty is a stream, all output to this pty is sent to\r
+ this stream, otherwise the PROCESS-PTY slot is filled in with a stream\r
+ connected to pty that can read output and write input.\r
+ :INPUT\r
+ Either T, NIL, a pathname, a stream, or :STREAM. If T, the standard\r
+ input for the current process is inherited. If NIL, /dev/null\r
+ is used. If a pathname, the file so specified is used. If a stream,\r
+ all the input is read from that stream and send to the subprocess. If\r
+ :STREAM, the PROCESS-INPUT slot is filled in with a stream that sends\r
+ its output to the process. Defaults to NIL.\r
+ :IF-INPUT-DOES-NOT-EXIST (when :INPUT is the name of a file)\r
+ can be one of:\r
+ :ERROR to generate an error\r
+ :CREATE to create an empty file\r
+ NIL (the default) to return NIL from RUN-PROGRAM\r
+ :OUTPUT\r
+ Either T, NIL, a pathname, a stream, or :STREAM. If T, the standard\r
+ output for the current process is inherited. If NIL, /dev/null\r
+ is used. If a pathname, the file so specified is used. If a stream,\r
+ all the output from the process is written to this stream. If\r
+ :STREAM, the PROCESS-OUTPUT slot is filled in with a stream that can\r
+ be read to get the output. Defaults to NIL.\r
+ :IF-OUTPUT-EXISTS (when :OUTPUT is the name of a file)\r
+ can be one of:\r
+ :ERROR (the default) to generate an error\r
+ :SUPERSEDE to supersede the file with output from the program\r
+ :APPEND to append output from the program to the file\r
+ NIL to return NIL from RUN-PROGRAM, without doing anything\r
+ :ERROR and :IF-ERROR-EXISTS\r
+ Same as :OUTPUT and :IF-OUTPUT-EXISTS, except that :ERROR can also be\r
+ specified as :OUTPUT in which case all error output is routed to the\r
+ same place as normal output.\r
+ :STATUS-HOOK\r
+ This is a function the system calls whenever the status of the\r
+ process changes. The function takes the process as an argument."\r
+ (when (and env-p environment-p)\r
+ (error "can't specify :ENV and :ENVIRONMENT simultaneously"))\r
+ ;; Make sure that the interrupt handler is installed.\r
+ (sb-sys:enable-interrupt sb-unix:sigchld #'sigchld-handler)\r
+ ;; Prepend the program to the argument list.\r
+ (push (namestring program) args)\r
+ (let (;; Clear various specials used by GET-DESCRIPTOR-FOR to\r
+ ;; communicate cleanup info.\r
+ *close-on-error*\r
+ *close-in-parent*\r
+ *handlers-installed*\r
+ ;; Establish PROC at this level so that we can return it.\r
+ proc\r
+ ;; It's friendly to allow the caller to pass any string\r
+ ;; designator, but internally we'd like SIMPLE-STRINGs.\r
+ (simple-args (mapcar (lambda (x) (coerce x 'simple-string)) args)))\r
+ (unwind-protect\r
+ (let ((pfile\r
+ (if search\r
+ (find-executable-in-search-path program)\r
+ (unix-namestring program)))\r
+ (cookie (list 0)))\r
+ (unless pfile\r
+ (error "no such program: ~S" program))\r
+ (unless (unix-filename-is-executable-p pfile)\r
+ (error "not executable: ~S" program))\r
+ (multiple-value-bind (stdin input-stream)\r
+ (get-descriptor-for input cookie\r
+ :direction :input\r
+ :if-does-not-exist if-input-does-not-exist)\r
+ (multiple-value-bind (stdout output-stream)\r
+ (get-descriptor-for output cookie\r
+ :direction :output\r
+ :if-exists if-output-exists)\r
+ (multiple-value-bind (stderr error-stream)\r
+ (if (eq error :output)\r
+ (values stdout output-stream)\r
+ (get-descriptor-for error cookie\r
+ :direction :output\r
+ :if-exists if-error-exists))\r
+ (multiple-value-bind (pty-name pty-stream)\r
+ (open-pty pty cookie)\r
+ ;; Make sure we are not notified about the child\r
+ ;; death before we have installed the PROCESS\r
+ ;; structure in *ACTIVE-PROCESSES*.\r
+ (with-active-processes-lock ()\r
+ (with-c-strvec (args-vec simple-args)\r
+ (with-c-strvec (environment-vec environment)\r
+ (let ((child-pid\r
+ (without-gcing\r
+ (spawn pfile args-vec environment-vec pty-name\r
+ stdin stdout stderr))))\r
+ (when (< child-pid 0)\r
+ (error "couldn't fork child process: ~A"\r
+ (strerror)))\r
+ (setf proc (make-process :pid child-pid\r
+ :%status :running\r
+ :pty pty-stream\r
+ :input input-stream\r
+ :output output-stream\r
+ :error error-stream\r
+ :status-hook status-hook\r
+ :cookie cookie))\r
+ (push proc *active-processes*))))))))))\r
+ (dolist (fd *close-in-parent*)\r
+ (sb-unix:unix-close fd))\r
+ (unless proc\r
+ (dolist (fd *close-on-error*)\r
+ (sb-unix:unix-close fd))\r
+ (dolist (handler *handlers-installed*)\r
+ (sb-sys:remove-fd-handler handler))))\r
+ (when (and wait proc)\r
+ (process-wait proc))\r
+ proc))\r
+\r
+#+win32\r
+(defun run-program (program args\r
+ &key\r
+ (wait t)\r
+ search\r
+ input\r
+ if-input-does-not-exist\r
+ output\r
+ (if-output-exists :error)\r
+ (error :output)\r
+ (if-error-exists :error)\r
+ status-hook)\r
+ "RUN-PROGRAM creates a new process specified by the PROGRAM\r
+argument. ARGS are the standard arguments that can be passed to a\r
+program. For no arguments, use NIL (which means that just the name of\r
+the program is passed as arg 0).\r
+\r
+RUN-PROGRAM will return a PROCESS structure. See the CMU\r
+Common Lisp Users Manual for details about the PROCESS structure.\r
+\r
+ The &KEY arguments have the following meanings:\r
+ :SEARCH\r
+ Look for PROGRAM in each of the directories along the $PATH\r
+ environment variable. Otherwise an absolute pathname is required.\r
+ (See also FIND-EXECUTABLE-IN-SEARCH-PATH)\r
+ :WAIT\r
+ If non-NIL (default), wait until the created process finishes. If\r
+ NIL, continue running Lisp until the program finishes.\r
+ :INPUT\r
+ Either T, NIL, a pathname, a stream, or :STREAM. If T, the standard\r
+ input for the current process is inherited. If NIL, nul\r
+ is used. If a pathname, the file so specified is used. If a stream,\r
+ all the input is read from that stream and send to the subprocess. If\r
+ :STREAM, the PROCESS-INPUT slot is filled in with a stream that sends\r
+ its output to the process. Defaults to NIL.\r
+ :IF-INPUT-DOES-NOT-EXIST (when :INPUT is the name of a file)\r
+ can be one of:\r
+ :ERROR to generate an error\r
+ :CREATE to create an empty file\r
+ NIL (the default) to return NIL from RUN-PROGRAM\r
+ :OUTPUT\r
+ Either T, NIL, a pathname, a stream, or :STREAM. If T, the standard\r
+ output for the current process is inherited. If NIL, nul\r
+ is used. If a pathname, the file so specified is used. If a stream,\r
+ all the output from the process is written to this stream. If\r
+ :STREAM, the PROCESS-OUTPUT slot is filled in with a stream that can\r
+ be read to get the output. Defaults to NIL.\r
+ :IF-OUTPUT-EXISTS (when :OUTPUT is the name of a file)\r
+ can be one of:\r
+ :ERROR (the default) to generate an error\r
+ :SUPERSEDE to supersede the file with output from the program\r
+ :APPEND to append output from the program to the file\r
+ NIL to return NIL from RUN-PROGRAM, without doing anything\r
+ :ERROR and :IF-ERROR-EXISTS\r
+ Same as :OUTPUT and :IF-OUTPUT-EXISTS, except that :ERROR can also be\r
+ specified as :OUTPUT in which case all error output is routed to the\r
+ same place as normal output.\r
+ :STATUS-HOOK\r
+ This is a function the system calls whenever the status of the\r
+ process changes. The function takes the process as an argument."\r
+ ;; Prepend the program to the argument list.\r
+ (push (namestring program) args)\r
+ (let (;; Clear various specials used by GET-DESCRIPTOR-FOR to\r
+ ;; communicate cleanup info.\r
+ *close-on-error*\r
+ *close-in-parent*\r
+ ;; Establish PROC at this level so that we can return it.\r
+ proc\r
+ ;; It's friendly to allow the caller to pass any string\r
+ ;; designator, but internally we'd like SIMPLE-STRINGs.\r
+ (simple-args (mapcar (lambda (x) (coerce x 'simple-string)) args)))\r
+ (unwind-protect\r
+ (let ((pfile\r
+ (if search\r
+ (find-executable-in-search-path program)\r
+ (unix-namestring program)))\r
+ (cookie (list 0)))\r
+ (unless pfile\r
+ (error "No such program: ~S" program))\r
+ (unless (unix-filename-is-executable-p pfile)\r
+ (error "Not an executable: ~S" program))\r
+ (multiple-value-bind (stdin input-stream)\r
+ (get-descriptor-for input cookie\r
+ :direction :input\r
+ :if-does-not-exist if-input-does-not-exist)\r
+ (multiple-value-bind (stdout output-stream)\r
+ (get-descriptor-for output cookie\r
+ :direction :output\r
+ :if-exists if-output-exists)\r
+ (multiple-value-bind (stderr error-stream)\r
+ (if (eq error :output)\r
+ (values stdout output-stream)\r
+ (get-descriptor-for error cookie\r
+ :direction :output\r
+ :if-exists if-error-exists))\r
+ (with-c-strvec (args-vec simple-args)\r
+ (let ((handle (without-gcing\r
+ (spawn pfile args-vec\r
+ stdin stdout stderr\r
+ (if wait 1 0)))))\r
+ (when (< handle 0)\r
+ (error "Couldn't spawn program: ~A" (strerror)))\r
+ (setf proc\r
+ (if wait \r
+ (make-process :pid handle\r
+ :%status :exited\r
+ :input input-stream\r
+ :output output-stream\r
+ :error error-stream\r
+ :status-hook status-hook\r
+ :cookie cookie\r
+ :exit-code handle)\r
+ (make-process :pid handle\r
+ :%status :running\r
+ :input input-stream\r
+ :output output-stream\r
+ :error error-stream\r
+ :status-hook status-hook\r
+ :cookie cookie)))\r
+ (push proc *active-processes*)))))))\r
+ (dolist (fd *close-in-parent*)\r
+ (sb-unix:unix-close fd)))\r
+ (unless proc\r
+ (dolist (fd *close-on-error*)\r
+ (sb-unix:unix-close fd)))\r
+\r
+ proc))\r
+\r
+;;; Install a handler for any input that shows up on the file\r
+;;; descriptor. The handler reads the data and writes it to the\r
+;;; stream.\r
+(defun copy-descriptor-to-stream (descriptor stream cookie)\r
+ (incf (car cookie))\r
+ (let ((string (make-string 256 :element-type 'base-char))\r
+ handler)\r
+ (setf handler\r
+ (sb-sys:add-fd-handler\r
+ descriptor\r
+ :input (lambda (fd)\r
+ (declare (ignore fd))\r
+ (loop\r
+ (unless handler\r
+ (return))\r
+ (multiple-value-bind\r
+ (result readable/errno)\r
+ (sb-unix:unix-select (1+ descriptor)\r
+ (ash 1 descriptor)\r
+ 0 0 0)\r
+ (cond ((null result)\r
+ (error "~@<couldn't select on sub-process: ~\r
+ ~2I~_~A~:>"\r
+ (strerror readable/errno)))\r
+ ((zerop result)\r
+ (return))))\r
+ (sb-alien:with-alien ((buf (sb-alien:array\r
+ sb-alien:char\r
+ 256)))\r
+ (multiple-value-bind\r
+ (count errno)\r
+ (sb-unix:unix-read descriptor\r
+ (alien-sap buf)\r
+ 256)\r
+ (cond (#-win32(or (and (null count)\r
+ (eql errno sb-unix:eio))\r
+ (eql count 0))\r
+ #+win32(<= count 0)\r
+ (sb-sys:remove-fd-handler handler)\r
+ (setf handler nil)\r
+ (decf (car cookie))\r
+ (sb-unix:unix-close descriptor)\r
+ (return))\r
+ ((null count)\r
+ (sb-sys:remove-fd-handler handler)\r
+ (setf handler nil)\r
+ (decf (car cookie))\r
+ (error\r
+ "~@<couldn't read input from sub-process: ~\r
+ ~2I~_~A~:>"\r
+ (strerror errno)))\r
+ (t\r
+ (sb-kernel:copy-ub8-from-system-area\r
+ (alien-sap buf) 0\r
+ string 0\r
+ count)\r
+ (write-string string stream\r
+ :end count)))))))))))\r
+\r
+(defun get-stream-fd (stream direction)\r
+ (typecase stream\r
+ (sb-sys:fd-stream\r
+ (values (sb-sys:fd-stream-fd stream) nil))\r
+ (synonym-stream\r
+ (get-stream-fd (symbol-value (synonym-stream-symbol stream)) direction))\r
+ (two-way-stream\r
+ (ecase direction\r
+ (:input\r
+ (get-stream-fd (two-way-stream-input-stream stream) direction))\r
+ (:output\r
+ (get-stream-fd (two-way-stream-output-stream stream) direction))))))\r
+\r
+;;; Find a file descriptor to use for object given the direction.\r
+;;; Returns the descriptor. If object is :STREAM, returns the created\r
+;;; stream as the second value.\r
+(defun get-descriptor-for (object\r
+ cookie\r
+ &rest keys\r
+ &key direction\r
+ &allow-other-keys)\r
+ (cond ((eq object t)\r
+ ;; No new descriptor is needed.\r
+ (values -1 nil))\r
+ ((eq object nil)\r
+ ;; Use /dev/null.\r
+ (multiple-value-bind\r
+ (fd errno)\r
+ (sb-unix:unix-open #-win32 #.(coerce "/dev/null" 'base-string)\r
+ #+win32 #.(coerce "nul" 'base-string)\r
+ (case direction\r
+ (:input sb-unix:o_rdonly)\r
+ (:output sb-unix:o_wronly)\r
+ (t sb-unix:o_rdwr))\r
+ #o666)\r
+ (unless fd\r
+ (error #-win32 "~@<couldn't open \"/dev/null\": ~2I~_~A~:>"\r
+ #+win32 "~@<couldn't open \"nul\" device: ~2I~_~A~:>"\r
+ (strerror errno)))\r
+ (push fd *close-in-parent*)\r
+ (values fd nil)))\r
+ ((eq object :stream)\r
+ (multiple-value-bind (read-fd write-fd) (sb-unix:unix-pipe)\r
+ (unless read-fd\r
+ (error "couldn't create pipe: ~A" (strerror write-fd)))\r
+ (case direction\r
+ (:input\r
+ (push read-fd *close-in-parent*)\r
+ (push write-fd *close-on-error*)\r
+ (let ((stream (sb-sys:make-fd-stream write-fd :output t\r
+ :element-type :default)))\r
+ (values read-fd stream)))\r
+ (:output\r
+ (push read-fd *close-on-error*)\r
+ (push write-fd *close-in-parent*)\r
+ (let ((stream (sb-sys:make-fd-stream read-fd :input t\r
+ :element-type :default)))\r
+ (values write-fd stream)))\r
+ (t\r
+ (sb-unix:unix-close read-fd)\r
+ (sb-unix:unix-close write-fd)\r
+ (error "Direction must be either :INPUT or :OUTPUT, not ~S."\r
+ direction)))))\r
+ ((or (pathnamep object) (stringp object))\r
+ (with-open-stream (file (apply #'open object keys))\r
+ (multiple-value-bind\r
+ (fd errno)\r
+ (sb-unix:unix-dup (sb-sys:fd-stream-fd file))\r
+ (cond (fd\r
+ (push fd *close-in-parent*)\r
+ (values fd nil))\r
+ (t\r
+ (error "couldn't duplicate file descriptor: ~A"\r
+ (strerror errno)))))))\r
+ ((streamp object)\r
+ (ecase direction\r
+ (:input\r
+ (or (get-stream-fd object :input)\r
+ ;; FIXME: We could use a better way of setting up\r
+ ;; temporary files\r
+ (dotimes (count\r
+ 256\r
+ (error "could not open a temporary file in /tmp"))\r
+ (let* ((name (coerce (format nil "/tmp/.run-program-~D" count)\r
+ 'base-string))\r
+ (fd (sb-unix:unix-open name\r
+ (logior sb-unix:o_rdwr\r
+ sb-unix:o_creat\r
+ sb-unix:o_excl)\r
+ #o666)))\r
+ (sb-unix:unix-unlink name)\r
+ (when fd\r
+ (let ((newline (string #\Newline)))\r
+ (loop\r
+ (multiple-value-bind\r
+ (line no-cr)\r
+ (read-line object nil nil)\r
+ (unless line\r
+ (return))\r
+ (sb-unix:unix-write\r
+ fd\r
+ ;; FIXME: this really should be\r
+ ;; (STRING-TO-OCTETS :EXTERNAL-FORMAT ...).\r
+ ;; RUN-PROGRAM should take an\r
+ ;; external-format argument, which should\r
+ ;; be passed down to here. Something\r
+ ;; similar should happen on :OUTPUT, too.\r
+ (map '(vector (unsigned-byte 8)) #'char-code line)\r
+ 0 (length line))\r
+ (if no-cr\r
+ (return)\r
+ (sb-unix:unix-write fd newline 0 1)))))\r
+ (sb-unix:unix-lseek fd 0 sb-unix:l_set)\r
+ (push fd *close-in-parent*)\r
+ (return (values fd nil)))))))\r
+ (:output\r
+ (or (get-stream-fd object :output)\r
+ (multiple-value-bind (read-fd write-fd)\r
+ (sb-unix:unix-pipe)\r
+ (unless read-fd\r
+ (error "couldn't create pipe: ~S" (strerror write-fd)))\r
+ (copy-descriptor-to-stream read-fd object cookie)\r
+ (push read-fd *close-on-error*)\r
+ (push write-fd *close-in-parent*)\r
+ (values write-fd nil))))))\r
+ (t\r
+ (error "invalid option to RUN-PROGRAM: ~S" object))))\r
projects / sbcl.git / commitdiff