-;;;; 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
+;;;; 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
+(progn
+ (defun decode-windows-environment (environment)
+ (loop until (zerop (sap-ref-8 environment 0))
+ collect
+ (let ((string (sb-alien::c-string-to-string environment
+ (sb-alien::default-c-string-external-format)
+ 'character)))
+ (loop for value = (sap-ref-8 environment 0)
+ do (setf environment (sap+ environment 1))
+ until (zerop value))
+ string)))
+
+ (defun encode-windows-environment (list)
+ (let* ((external-format (sb-alien::default-c-string-external-format))
+ octets
+ (length 1)) ;; 1 for \0 at the very end
+ (setf octets
+ (loop for x in list
+ for octet =
+ (string-to-octets x :external-format external-format
+ :null-terminate t)
+ collect octet
+ do
+ (incf length (length octet))))
+ (let ((mem (allocate-system-memory length))
+ (index 0))
+
+ (loop for string in octets
+ for length = (length string)
+ do
+ (copy-ub8-to-system-area string 0 mem index length)
+ (incf index length))
+ (setf (sap-ref-8 mem index) 0)
+ (values mem mem length))))
+
+ (defun posix-environ ()
+ (decode-windows-environment
+ (alien-funcall (extern-alien "GetEnvironmentStrings"
+ (function system-area-pointer))))))
+
+;;; 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) (string val))
+ (concatenate 'simple-string (symbol-name key) "=" val)))
+ cmucl))
+\f
+;;;; Import wait3(2) from Unix.
+
+#-win32
+(define-alien-routine ("waitpid" c-waitpid) int
+ (pid int)
+ (status int :out)
+ (options int))
+
+#-win32
+(defun waitpid (pid &optional do-not-hang check-for-stopped)
+ #+sb-doc
+ "Return any available status information on child process with PID."
+ (multiple-value-bind (pid status)
+ (c-waitpid pid
+ (logior (if do-not-hang
+ sb-unix:wnohang
+ 0)
+ (if check-for-stopped
+ sb-unix:wuntraced
+ 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.")
+
+(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)
+ `(sb-thread::with-system-mutex (*active-processes-lock*)
+ ,@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" get-exit-code-process)
+ int
+ (handle unsigned) (exit-code unsigned :out))
+
+(defun process-exit-code (process)
+ #+sb-doc
+ "Return the exit code of PROCESS."
+ (or (process-%exit-code process)
+ (progn (get-processes-status-changes)
+ (process-%exit-code process))))
+
+(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."
+ (declare (ignorable check-for-stopped))
+ #+win32
+ (let ((pid (process-pid process)))
+ (when (and pid (plusp pid))
+ (without-interrupts
+ (do ()
+ ((= 0
+ (with-local-interrupts
+ (sb-win32:wait-object-or-signal pid))))))))
+ #-win32
+ (loop
+ (case (process-status process)
+ (:running)
+ (:stopped
+ (when check-for-stopped
+ (return)))
+ (t
+ (when (zerop (car (process-cookie process)))
+ (return))))
+ (serve-all-events 1))
+ process)
+
+#-win32
+;;; Find the current foreground process group id.
+(defun find-current-foreground-process (proc)
+ (with-alien ((result int))
+ (multiple-value-bind
+ (wonp error)
+ (sb-unix:unix-ioctl (fd-stream-fd (process-pty proc))
+ sb-unix:TIOCGPGRP
+ (alien-sap (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
+ (find-current-foreground-process process)))))
+ (multiple-value-bind
+ (okay errno)
+ (case whom
+ ((: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*)))
+ #+win32
+ (let ((handle (shiftf (process-pid process) nil)))
+ (when (and handle (plusp handle))
+ (or (sb-win32:close-handle handle)
+ (sb-win32::win32-error 'process-close))))
+ process)
+
+(defun get-processes-status-changes ()
+ (let (exited)
+ (with-active-processes-lock ()
+ (setf *active-processes*
+ (delete-if #-win32
+ (lambda (proc)
+ ;; Wait only on pids belonging to processes
+ ;; started by RUN-PROGRAM. There used to be a
+ ;; WAIT3 call here, but that makes direct
+ ;; WAIT, WAITPID usage impossible due to the
+ ;; race with the SIGCHLD signal handler.
+ (multiple-value-bind (pid what code core)
+ (waitpid (process-pid proc) t t)
+ (when pid
+ (setf (process-%status proc) what)
+ (setf (process-%exit-code proc) code)
+ (setf (process-core-dumped proc) core)
+ (when (process-status-hook proc)
+ (push proc exited))
+ t)))
+ #+win32
+ (lambda (proc)
+ (let ((pid (process-pid proc)))
+ (when pid
+ (multiple-value-bind (ok code)
+ (sb-win32::get-exit-code-process pid)
+ (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 waitpid,
+ ;; but in the Windows implementation it 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. FIXME: nothing seems
+;;; to set this.
+#-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.
+#-(or win32 openbsd)
+(progn
+ (define-alien-routine ptsname c-string (fd int))
+ (define-alien-routine grantpt boolean (fd int))
+ (define-alien-routine unlockpt boolean (fd int))
+
+ (defun find-a-pty ()
+ ;; First try to use the Unix98 pty api.
+ (let* ((master-name (coerce (format nil "/dev/ptmx") 'base-string))
+ (master-fd (sb-unix:unix-open master-name
+ (logior sb-unix:o_rdwr
+ sb-unix:o_noctty)
+ #o666)))
+ (when master-fd
+ (grantpt master-fd)
+ (unlockpt master-fd)
+ (let* ((slave-name (ptsname master-fd))
+ (slave-fd (sb-unix:unix-open slave-name
+ (logior sb-unix:o_rdwr
+ sb-unix:o_noctty)
+ #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")))
+ ;; No dice, try using the old-school method.
+ (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
+ (logior sb-unix:o_rdwr
+ sb-unix:o_noctty)
+ #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
+ (logior sb-unix:o_rdwr
+ sb-unix:o_noctty)
+ #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")))
+#+openbsd
+(progn
+ (define-alien-routine openpty int (amaster int :out) (aslave int :out)
+ (name (* char)) (termp (* t)) (winp (* t)))
+ (defun find-a-pty ()
+ (with-alien ((name-buf (array char 16)))
+ (multiple-value-bind (return-val master-fd slave-fd)
+ (openpty (cast name-buf (* char)) nil nil)
+ (if (zerop return-val)
+ (values master-fd
+ slave-fd
+ (sb-alien::c-string-to-string (alien-sap name-buf)
+ (sb-impl::default-external-format)
+ 'character))
+ (error "could not find a pty"))))))
+
+#-win32
+(defun open-pty (pty cookie &key (external-format :default))
+ (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 external-format)))
+ (values name
+ (make-fd-stream master :input t :output t
+ :external-format external-format
+ :element-type :default
+ :dual-channel-p t)))))
+
+;; Null terminate strings only C-side: otherwise we can run into
+;; A-T-S-L even for simple encodings like ASCII. Multibyte encodings
+;; may need more than a single byte of zeros; assume 4 byte is enough
+;; for everyone.
+#-win32
+(defmacro round-null-terminated-bytes-to-words (n)
+ `(logandc2 (the sb-vm:signed-word (+ (the fixnum ,n)
+ 4 (1- sb-vm:n-word-bytes)))
+ (1- sb-vm:n-word-bytes)))
+
+#-win32
+(defun string-list-to-c-strvec (string-list)
+ (let* (;; We need an extra for the null, and an extra 'cause exect
+ ;; clobbers argv[-1].
+ (vec-bytes (* sb-vm:n-word-bytes (+ (length string-list) 2)))
+ (octet-vector-list (mapcar (lambda (s)
+ (string-to-octets s))
+ string-list))
+ (string-bytes (reduce #'+ octet-vector-list
+ :key (lambda (s)
+ (round-null-terminated-bytes-to-words
+ (length s)))))
+ (total-bytes (+ string-bytes vec-bytes))
+ ;; Memory to hold the vector of pointers and all the strings.
+ (vec-sap (allocate-system-memory total-bytes))
+ (string-sap (sap+ vec-sap vec-bytes))
+ ;; Index starts from [1]!
+ (vec-index-offset sb-vm:n-word-bytes))
+ (declare (sb-vm:signed-word vec-bytes)
+ (sb-vm:word string-bytes total-bytes)
+ (system-area-pointer vec-sap string-sap))
+ (dolist (octets octet-vector-list)
+ (declare (type (simple-array (unsigned-byte 8) (*)) octets))
+ (let ((size (length octets)))
+ ;; Copy string.
+ (sb-kernel:copy-ub8-to-system-area octets 0 string-sap 0 size)
+ ;; NULL-terminate it
+ (sb-kernel:system-area-ub8-fill 0 string-sap size 4)
+ ;; Put the pointer in the vector.
+ (setf (sap-ref-sap vec-sap vec-index-offset) string-sap)
+ ;; Advance string-sap for the next string.
+ (setf string-sap (sap+ string-sap
+ (round-null-terminated-bytes-to-words size)))
+ (incf vec-index-offset sb-vm:n-word-bytes)))
+ ;; Final null pointer.
+ (setf (sap-ref-sap vec-sap vec-index-offset) (int-sap 0))
+ (values vec-sap (sap+ vec-sap sb-vm:n-word-bytes) total-bytes)))
+
+#-win32
+(defmacro with-args ((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)
+ (deallocate-system-memory ,sap ,size)))))
+
+(defmacro with-environment ((var str-list &key null) &body body)
+ (once-only ((null null))
+ (with-unique-names (sap size)
+ `(multiple-value-bind (,sap ,var ,size)
+ (if ,null
+ (values nil (int-sap 0))
+ #-win32 (string-list-to-c-strvec ,str-list)
+ #+win32 (encode-windows-environment ,str-list))
+ (unwind-protect
+ (progn
+ ,@body)
+ (unless ,null
+ (deallocate-system-memory ,sap ,size)))))))
+#-win32
+(define-alien-routine spawn
+ int
+ (program c-string)
+ (argv (* c-string))
+ (stdin int)
+ (stdout int)
+ (stderr int)
+ (search int)
+ (envp (* c-string))
+ (pty-name c-string)
+ (wait int)
+ (dir c-string))
+
+#+win32
+(defun escape-arg (arg stream)
+ ;; Normally, #\\ doesn't have to be escaped
+ ;; But if #\" follows #\\, then they have to be escaped.
+ ;; Do that by counting the number of consequent backslashes, and
+ ;; upon encoutering #\" immediately after them, output the same
+ ;; number of backslashes, plus one for #\"
+ (write-char #\" stream)
+ (loop with slashes = 0
+ for i below (length arg)
+ for previous-char = #\a then char
+ for char = (char arg i)
+ do
+ (case char
+ (#\"
+ (loop repeat slashes
+ do (write-char #\\ stream))
+ (write-string "\\\"" stream))
+ (t
+ (write-char char stream)))
+ (case char
+ (#\\
+ (incf slashes))
+ (t
+ (setf slashes 0)))
+ finally
+ ;; The final #\" counts too, but doesn't need to be escaped itself
+ (loop repeat slashes
+ do (write-char #\\ stream)))
+ (write-char #\" stream))
+
+(defun prepare-args (args)
+ (cond #-win32
+ ((every #'simple-string-p args)
+ args)
+ #-win32
+ (t
+ (loop for arg in args
+ collect (coerce arg 'simple-string)))
+ #+win32
+ (t
+ (with-output-to-string (str)
+ (loop for (arg . rest) on args
+ do
+ (cond ((find-if (lambda (c) (find c '(#\Space #\Tab #\")))
+ arg)
+ (escape-arg arg str))
+ (t
+ (princ arg str)))
+ (when rest
+ (write-char #\Space str)))))))
+
+;;; 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.
+(defun run-program (program args
+ &key
+ (env nil env-p)
+ (environment
+ (when env-p
+ (unix-environment-sbcl-from-cmucl env))
+ environment-p)
+ (wait t)
+ search
+ #-win32 pty
+ input
+ if-input-does-not-exist
+ output
+ (if-output-exists :error)
+ (error :output)
+ (if-error-exists :error)
+ status-hook
+ (external-format :default)
+ directory)
+ #+sb-doc
+ #.(concatenate
+ 'string
+ ;; The Texinfoizer is sensitive to whitespace, so mind the
+ ;; placement of the #-win32 pseudosplicings.
+ "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).
+
+The program arguments and the environment are encoded using the
+default external format for streams.
+
+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."#-win32"
+ - 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 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 in the child's $PATH
+ environment variable. Otherwise an absolute pathname is required.
+ :WAIT
+ If non-NIL (default), wait until the created process finishes. If
+ NIL, continue running Lisp until the program finishes."#-win32"
+ :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, "
+ #-win32"/dev/null"#+win32"nul""
+ is used. If a pathname, the file so specified is used. If a stream,
+ all the input is read from that stream and sent 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, "
+ #-win32"/dev/null"#+win32"nul""
+ 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.
+ :EXTERNAL-FORMAT
+ The external-format to use for :INPUT, :OUTPUT, and :ERROR :STREAMs.
+ :DIRECTORY
+ Specifies the directory in which the program should be run.
+ NIL (the default) means the directory is unchanged.")
+ (when (and env-p environment-p)
+ (error "can't specify :ENV and :ENVIRONMENT simultaneously"))
+ (let* (;; Clear various specials used by GET-DESCRIPTOR-FOR to
+ ;; communicate cleanup info.
+ *close-on-error*
+ *close-in-parent*
+ ;; Some other binding used only on non-Win32. FIXME:
+ ;; nothing seems to set this.
+ #-win32 *handlers-installed*
+ ;; Establish PROC at this level so that we can return it.
+ proc
+ (progname (native-namestring program))
+ (args (prepare-args (cons progname args)))
+ (directory (and directory (native-namestring directory)))
+ ;; Gag.
+ (cookie (list 0)))
+ (unwind-protect
+ ;; Note: despite the WITH-* names, these macros don't
+ ;; expand into UNWIND-PROTECT forms. They're just
+ ;; syntactic sugar to make the rest of the routine slightly
+ ;; easier to read.
+ (macrolet ((with-fd-and-stream-for (((fd stream) which &rest args)
+ &body body)
+ `(multiple-value-bind (,fd ,stream)
+ ,(ecase which
+ ((:input :output)
+ `(get-descriptor-for ,@args))
+ (:error
+ `(if (eq ,(first args) :output)
+ ;; kludge: we expand into
+ ;; hard-coded symbols here.
+ (values stdout output-stream)
+ (get-descriptor-for ,@args))))
+ (unless ,fd
+ (return-from run-program))
+ ,@body))
+ (with-open-pty (((pty-name pty-stream) (pty cookie))
+ &body body)
+ (declare (ignorable pty-name pty-stream pty cookie))
+ #+win32
+ `(progn ,@body)
+ #-win32
+ `(multiple-value-bind (,pty-name ,pty-stream)
+ (open-pty ,pty ,cookie :external-format external-format)
+ ,@body)))
+ (with-fd-and-stream-for ((stdin input-stream) :input
+ input cookie
+ :direction :input
+ :if-does-not-exist if-input-does-not-exist
+ :external-format external-format
+ :wait wait)
+ (with-fd-and-stream-for ((stdout output-stream) :output
+ output cookie
+ :direction :output
+ :if-exists if-output-exists
+ :external-format external-format)
+ (with-fd-and-stream-for ((stderr error-stream) :error
+ error cookie
+ :direction :output
+ :if-exists if-error-exists
+ :external-format external-format)
+ (with-open-pty ((pty-name pty-stream) (pty cookie))
+ ;; Make sure we are not notified about the child
+ ;; death before we have installed the PROCESS
+ ;; structure in *ACTIVE-PROCESSES*.
+ (let (child)
+ (with-active-processes-lock ()
+ (with-environment (environment-vec environment
+ :null (not (or environment environment-p)))
+ (setq child
+ #+win32
+ (sb-win32::mswin-spawn
+ progname
+ args
+ stdin stdout stderr
+ search environment-vec wait directory)
+ #-win32
+ (with-args (args-vec args)
+ (without-gcing
+ (spawn progname args-vec
+ stdin stdout stderr
+ (if search 1 0)
+ environment-vec pty-name
+ (if wait 1 0) directory))))
+ (unless (minusp child)
+ (setf proc
+ (make-process
+ :input input-stream
+ :output output-stream
+ :error error-stream
+ :status-hook status-hook
+ :cookie cookie
+ #-win32 :pty #-win32 pty-stream
+ :%status #-win32 :running
+ #+win32 (if wait
+ :exited
+ :running)
+ :pid #-win32 child
+ #+win32 (if wait
+ nil
+ child)
+ #+win32 :%exit-code #+win32 (and wait child)))
+ (push proc *active-processes*))))
+ ;; Report the error outside the lock.
+ (case child
+ (-1
+ (error "Couldn't fork child process: ~A"
+ (strerror)))
+ (-2
+ (error "Couldn't execute ~S: ~A"
+ progname (strerror)))
+ (-3
+ (error "Couldn't change directory to ~S: ~A"
+ directory (strerror))))))))))
+ (dolist (fd *close-in-parent*)
+ (sb-unix:unix-close fd))
+ (unless proc
+ (dolist (fd *close-on-error*)
+ (sb-unix:unix-close fd))
+ #-win32
+ (dolist (handler *handlers-installed*)
+ (remove-fd-handler handler)))
+ #-win32
+ (when (and wait proc)
+ (unwind-protect
+ (process-wait proc)
+ (dolist (handler *handlers-installed*)
+ (remove-fd-handler handler)))))
+ 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 external-format)
+ (incf (car cookie))
+ (let* ((handler nil)
+ (buf (make-array 256 :element-type '(unsigned-byte 8)))
+ (read-end 0)
+ (et (stream-element-type stream))
+ (copy-fun
+ (cond
+ ((member et '(character base-char))
+ (lambda ()
+ (let* ((decode-end read-end)
+ (string (handler-case
+ (octets-to-string
+ buf :end read-end
+ :external-format external-format)
+ (end-of-input-in-character (e)
+ (setf decode-end
+ (octet-decoding-error-start e))
+ (octets-to-string
+ buf :end decode-end
+ :external-format external-format)))))
+ (unless (zerop (length string))
+ (write-string string stream)
+ (when (/= decode-end (length buf))
+ (replace buf buf :start2 decode-end :end2 read-end))
+ (decf read-end decode-end)))))
+ ((member et '(:default (unsigned-byte 8)) :test #'equal)
+ (lambda ()
+ (write-sequence buf stream :end read-end)
+ (setf read-end 0)))
+ (t
+ ;; FIXME.
+ (error "Don't know how to copy to stream of element-type ~S"
+ et)))))
+ (setf handler
+ (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)
+ (if (eql sb-unix:eintr readable/errno)
+ (return)
+ (error "~@<Couldn't select on sub-process: ~
+ ~2I~_~A~:>"
+ (strerror readable/errno))))
+ ((zerop result)
+ (return))))
+ (multiple-value-bind (count errno)
+ (with-pinned-objects (buf)
+ (sb-unix:unix-read descriptor
+ (sap+ (vector-sap buf) read-end)
+ (- (length buf) read-end)))
+ (cond
+ ((and #-win32 (or (and (null count)
+ (eql errno sb-unix:eio))
+ (eql count 0))
+ #+win32 (<= count 0))
+ (remove-fd-handler handler)
+ (setf handler nil)
+ (decf (car cookie))
+ (sb-unix:unix-close descriptor)
+ (unless (zerop read-end)
+ ;; Should this be an END-OF-FILE?
+ (error "~@<non-empty buffer when EOF reached ~
+ while reading from child: ~S~:>" buf))
+ (return))
+ ((null count)
+ (remove-fd-handler handler)
+ (setf handler nil)
+ (decf (car cookie))
+ (error
+ "~@<couldn't read input from sub-process: ~
+ ~2I~_~A~:>"
+ (strerror errno)))
+ (t
+ (incf read-end count)
+ (funcall copy-fun))))))))
+ #-win32
+ (push handler *handlers-installed*)))
+
+;;; FIXME: something very like this is done in SB-POSIX to treat
+;;; streams as file descriptor designators; maybe we can combine these
+;;; two? Additionally, as we have a couple of user-defined streams
+;;; libraries, maybe we should have a generic function for doing this,
+;;; so user-defined streams can play nicely with RUN-PROGRAM (and
+;;; maybe also with SB-POSIX)?
+(defun get-stream-fd-and-external-format (stream direction)
+ (typecase stream
+ (fd-stream
+ (values (fd-stream-fd stream) nil (stream-external-format stream)))
+ (synonym-stream
+ (get-stream-fd-and-external-format
+ (symbol-value (synonym-stream-symbol stream)) direction))
+ (two-way-stream
+ (ecase direction
+ (:input
+ (get-stream-fd-and-external-format
+ (two-way-stream-input-stream stream) direction))
+ (:output
+ (get-stream-fd-and-external-format
+ (two-way-stream-output-stream stream) direction))))))
+
+(defun get-temporary-directory ()
+ #-win32 (or (sb-ext:posix-getenv "TMPDIR")
+ "/tmp")
+ #+win32 (or (sb-ext:posix-getenv "TEMP")
+ "C:/Temp"))
+
+\f
+;;; 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 (external-format :default) wait
+ &allow-other-keys)
+ (declare (ignore wait)) ;This is explained below.
+ ;; Our use of a temporary file dates back to very old CMUCLs, and
+ ;; was probably only ever intended for use with STRING-STREAMs,
+ ;; which are ordinarily smallish. However, as we've got
+ ;; user-defined stream classes, we can end up trying to copy
+ ;; arbitrarily much data into the temp file, and so are liable to
+ ;; run afoul of disk quotas or to choke on small /tmp file systems.
+ (flet ((make-temp-fd ()
+ (multiple-value-bind (fd name/errno)
+ (sb-unix:sb-mkstemp (format nil "~a/.run-program-XXXXXX"
+ (get-temporary-directory))
+ #o0600)
+ (unless fd
+ (error "could not open a temporary file: ~A"
+ (strerror name/errno)))
+ ;; Can't unlink an open file on Windows
+ #-win32
+ (unless (sb-unix:unix-unlink name/errno)
+ (sb-unix:unix-close fd)
+ (error "failed to unlink ~A" name/errno))
+ fd)))
+ (let ((dev-null #.(coerce #-win32 "/dev/null" #+win32 "nul" 'base-string)))
+ (cond ((eq object t)
+ ;; No new descriptor is needed.
+ (values -1 nil))
+ ((or (eq object nil)
+ (and (typep object 'broadcast-stream)
+ (not (broadcast-stream-streams object))))
+ ;; Use /dev/null.
+ (multiple-value-bind
+ (fd errno)
+ (sb-unix:unix-open dev-null
+ (case direction
+ (:input sb-unix:o_rdonly)
+ (:output sb-unix:o_wronly)
+ (t sb-unix:o_rdwr))
+ #o666)
+ (unless fd
+ (error "~@<couldn't open ~S: ~2I~_~A~:>"
+ dev-null (strerror errno)))
+ #+win32
+ (setf (sb-win32::inheritable-handle-p fd) t)
+ (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)))
+ #+win32
+ (setf (sb-win32::inheritable-handle-p read-fd)
+ (eq direction :input)
+ (sb-win32::inheritable-handle-p write-fd)
+ (eq direction :output))
+ (case direction
+ (:input
+ (push read-fd *close-in-parent*)
+ (push write-fd *close-on-error*)
+ (let ((stream (make-fd-stream write-fd :output t
+ :element-type :default
+ :external-format
+ external-format)))
+ (values read-fd stream)))
+ (:output
+ (push read-fd *close-on-error*)
+ (push write-fd *close-in-parent*)
+ (let ((stream (make-fd-stream read-fd :input t
+ :element-type :default
+ :external-format
+ external-format)))
+ (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))
+ ;; GET-DESCRIPTOR-FOR uses &allow-other-keys, so rather
+ ;; than munge the &rest list for OPEN, just disable keyword
+ ;; validation there.
+ (with-open-stream (file (apply #'open object :allow-other-keys t
+ keys))
+ (when file
+ (multiple-value-bind
+ (fd errno)
+ (sb-unix:unix-dup (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
+ (block nil
+ ;; If we can get an fd for the stream, let the child
+ ;; process use the fd for its descriptor. Otherwise,
+ ;; we copy data from the stream into a temp file, and
+ ;; give the temp file's descriptor to the
+ ;; child.
+ (multiple-value-bind (fd stream format)
+ (get-stream-fd-and-external-format object :input)
+ (declare (ignore format))
+ (when fd
+ (return (values fd stream))))
+ ;; FIXME: if we can't get the file descriptor, since
+ ;; the stream might be interactive or otherwise
+ ;; block-y, we can't know whether we can copy the
+ ;; stream's data to a temp file, so if RUN-PROGRAM was
+ ;; called with :WAIT NIL, we should probably error.
+ ;; However, STRING-STREAMs aren't fd-streams, but
+ ;; they're not prone to blocking; any user-defined
+ ;; streams that "read" from some in-memory data will
+ ;; probably be similar to STRING-STREAMs. So maybe we
+ ;; should add a STREAM-INTERACTIVE-P generic function
+ ;; for problems like this? Anyway, the machinery is
+ ;; here, if you feel like filling in the details.
+ #|
+ (when (and (null wait) #<some undetermined criterion>)
+ (error "~@<don't know how to get an fd for ~A, and so ~
+ can't ensure that copying its data to the ~
+ child process won't hang~:>" object))
+ |#
+ (let ((fd (make-temp-fd))
+ (et (stream-element-type object)))
+ (cond ((member et '(character base-char))
+ (loop
+ (multiple-value-bind
+ (line no-cr)
+ (read-line object nil nil)
+ (unless line
+ (return))
+ (let ((vector (string-to-octets
+ line
+ :external-format external-format)))
+ (sb-unix:unix-write
+ fd vector 0 (length vector)))
+ (if no-cr
+ (return)
+ (sb-unix:unix-write
+ fd #.(string #\Newline) 0 1)))))
+ ((member et '(:default (unsigned-byte 8))
+ :test 'equal)
+ (loop with buf = (make-array 256 :element-type '(unsigned-byte 8))
+ for p = (read-sequence buf object)
+ until (zerop p)
+ do (sb-unix:unix-write fd buf 0 p)))
+ (t
+ (error "Don't know how to copy from stream of element-type ~S"
+ et)))
+ (sb-unix:unix-lseek fd 0 sb-unix:l_set)
+ (push fd *close-in-parent*)
+ (return (values fd nil)))))
+ (:output
+ (block nil
+ ;; Similar to the :input trick above, except we
+ ;; arrange to copy data from the stream. This is
+ ;; slightly saner than the input case, since we don't
+ ;; buffer to a file, but I think we may still lose if
+ ;; there's unflushed data in the stream buffer and we
+ ;; give the file descriptor to the child.
+ (multiple-value-bind (fd stream format)
+ (get-stream-fd-and-external-format object :output)
+ (declare (ignore format))
+ (when fd
+ (return (values fd stream))))
+ (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
+ external-format)
+ (push read-fd *close-on-error*)
+ (push write-fd *close-in-parent*)
+ (return (values write-fd nil)))))
+ (t
+ (error "invalid option to RUN-PROGRAM: ~S" object))))))))
projects / sbcl.git / blobdiff