Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

[a18f0a]: src / code / run-program.lisp Maximize Restore History

Download this file

run-program.lisp    802 lines (760 with data), 29.7 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
;;;; 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")
;;;; 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.
(def-alien-variable "environ" (* c-string))
(defun posix-environ ()
"Return the Unix environment (\"man environ\") as a list of SIMPLE-STRINGs."
(c-strings->string-list environ))
;;; Convert as best we can from a 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-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-string val))
(concatenate 'simple-string (symbol-name key) "=" val)))
cmucl))
;;;; Import wait3(2) from Unix.
(sb-alien:def-alien-routine ("wait3" c-wait3) sb-c-call:int
(status sb-c-call:int :out)
(options sb-c-call:int)
(rusage sb-c-call:int))
(defconstant wait-wnohang #-svr4 1 #+svr4 #o100)
(defconstant wait-wuntraced #-svr4 2 #+svr4 4)
(defconstant wait-wstopped #-svr4 #o177 #+svr4 wait-wuntraced)
(defun wait3 (&optional do-not-hang check-for-stopped)
"Return any available status information on child process. "
(multiple-value-bind (pid status)
(c-wait3 (logior (if do-not-hang
wait-wnohang
0)
(if check-for-stopped
wait-wuntraced
0))
0)
(cond ((or (minusp pid)
(zerop pid))
nil)
((eql (ldb (byte 8 0) status)
wait-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:unix-signal-number :sigstop)
(sb-unix:unix-signal-number :sigtstp)
(sb-unix:unix-signal-number :sigttin)
(sb-unix:unix-signal-number :sigttou)))
:stopped
:signaled)
signal
(not (zerop (ldb (byte 1 7) status)))))))))
;;;; process control stuff
(defvar *active-processes* nil
"List of process structures for all active processes.")
(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
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)
(format stream
"~D ~S"
(process-pid process)
(process-status process)))
process)
(defun process-status (proc)
"Return the current status of process. The result is one of :RUNNING,
:STOPPED, :EXITED, or :SIGNALED."
(get-processes-status-changes)
(process-%status proc))
(defun process-wait (proc &optional check-for-stopped)
"Wait for PROC to quit running for some reason. Returns PROC."
(loop
(case (process-status proc)
(:running)
(:stopped
(when check-for-stopped
(return)))
(t
(when (zerop (car (process-cookie proc)))
(return))))
(sb-sys:serve-all-events 1))
proc)
#-hpux
;;; Find the current foreground process group id.
(defun find-current-foreground-process (proc)
(sb-alien:with-alien ((result sb-c-call:int))
(multiple-value-bind
(wonp error)
(sb-unix:unix-ioctl (sb-sys:fd-stream-fd (process-pty proc))
sb-unix:TIOCGPGRP
(sb-alien:alien-sap (sb-alien:addr result)))
(unless wonp
(error "TIOCPGRP ioctl failed: ~S"
(sb-unix:get-unix-error-msg error)))
result))
(process-pid proc))
(defun process-kill (proc signal &optional (whom :pid))
"Hand SIGNAL to PROC. 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 proc))
(:pty-process-group
#-hpux
(find-current-foreground-process proc)))))
(multiple-value-bind
(okay errno)
(case whom
#+hpux
(:pty-process-group
(sb-unix:unix-ioctl (sb-sys:fd-stream-fd (process-pty proc))
sb-unix:TIOCSIGSEND
(sb-sys:int-sap
(sb-unix:unix-signal-number signal))))
((: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 proc))
(= (sb-unix:unix-signal-number signal)
(sb-unix:unix-signal-number :sigcont)))
(setf (process-%status proc) :running)
(setf (process-exit-code proc) nil)
(when (process-status-hook proc)
(funcall (process-status-hook proc) proc))
t)
(t
t)))))
(defun process-alive-p (proc)
"Return T if the process is still alive, NIL otherwise."
(let ((status (process-status proc)))
(if (or (eq status :running)
(eq status :stopped))
t
nil)))
(defun process-close (proc)
"Close all streams connected to PROC and stop maintaining the status slot."
(macrolet ((frob (stream abort)
`(when ,stream (close ,stream :abort ,abort))))
(frob (process-pty proc) t) ; Don't FLUSH-OUTPUT to dead process, ..
(frob (process-input proc) t) ; .. 'cause it will generate SIGPIPE.
(frob (process-output proc) nil)
(frob (process-error proc) nil))
(sb-sys:without-interrupts
(setf *active-processes* (delete proc *active-processes*)))
proc)
;;; the handler for SIGCHLD signals that RUN-PROGRAM establishes
(defun sigchld-handler (ignore1 ignore2 ignore3)
(declare (ignore ignore1 ignore2 ignore3))
(get-processes-status-changes))
(defun get-processes-status-changes ()
(loop
(multiple-value-bind (pid what code core)
(wait3 t t)
(unless pid
(return))
(let ((proc (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))
(sb-sys:without-interrupts
(setf *active-processes*
(delete proc *active-processes*)))))))))
;;;; 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
(defvar *handlers-installed* nil)
#+FreeBSD
(def-alien-type nil
(struct sgttyb
(sg-ispeed sb-c-call:char) ; input speed
(sg-ospeed sb-c-call:char) ; output speed
(sg-erase sb-c-call:char) ; erase character
(sg-kill sb-c-call:char) ; kill character
(sg-flags sb-c-call:short))) ; mode flags
#+OpenBSD
(def-alien-type nil
(struct sgttyb
(sg-four sb-c-call:int)
(sg-chars (array sb-c-call:char 4))
(sg-flags sb-c-call:int)))
;;; Find an unused pty. Return three values: the file descriptor for
;;; the master side of the pty, the file descriptor for the slave side
;;; of the pty, and the name of the tty device for the slave side.
(defun find-a-pty ()
(dolist (char '(#\p #\q))
(dotimes (digit 16)
(let* ((master-name (format nil "/dev/pty~C~X" char digit))
(master-fd (sb-unix:unix-open master-name
sb-unix:o_rdwr
#o666)))
(when master-fd
(let* ((slave-name (format nil "/dev/tty~C~X" char digit))
(slave-fd (sb-unix:unix-open slave-name
sb-unix:o_rdwr
#o666)))
(when slave-fd
;; comment from classic CMU CL:
;; Maybe put a vhangup here?
;;
;; FIXME: It seems as though this logic should be in
;; OPEN-PTY, not FIND-A-PTY (both from the comments
;; documenting DEFUN FIND-A-PTY, and from the
;; connotations of the function names).
;;
;; FIXME: It would be nice to have a note, and/or a pointer
;; to some reference material somewhere, explaining
;; why we need this on *BSD and not on Linux.
#+bsd
(sb-alien:with-alien ((stuff (sb-alien:struct sgttyb)))
(let ((sap (sb-alien:alien-sap stuff)))
(sb-unix:unix-ioctl slave-fd sb-unix:TIOCGETP sap)
(setf (sb-alien:slot stuff 'sg-flags)
;; This is EVENP|ODDP, the same numeric code
;; both on FreeBSD and on OpenBSD. -- WHN 20000929
#o300) ; EVENP|ODDP
(sb-unix:unix-ioctl slave-fd sb-unix:TIOCSETP sap)
(sb-unix:unix-ioctl master-fd sb-unix:TIOCGETP sap)
(setf (sb-alien:slot stuff 'sg-flags)
(logand (sb-alien:slot stuff 'sg-flags)
;; This is ~ECHO, the same numeric
;; code both on FreeBSD and on OpenBSD.
;; -- WHN 20000929
(lognot 8))) ; ~ECHO
(sb-unix:unix-ioctl master-fd sb-unix:TIOCSETP sap)))
(return-from find-a-pty
(values master-fd
slave-fd
slave-name)))
(sb-unix:unix-close master-fd))))))
(error "could not find a pty"))
(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 "could not SB-UNIX:UNIX-DUP ~D: ~S"
master (sb-unix:get-unix-error-msg 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)))))
(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 (* #-alpha 4 #+alpha 8 (+ (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 #-alpha 4 #+alpha 8))
(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-to-system-area (the simple-string s)
(* sb-vm:vector-data-offset
sb-vm:word-bits)
string-sap 0
(* (1+ n) sb-vm:byte-bits))
;; Blast the pointer to the string into place.
(setf (sap-ref-sap vec-sap i) string-sap)
(setf string-sap (sap+ string-sap (round-bytes-to-words (1+ n))))
(incf i #-alpha 4 #+alpha 8)))
;; Blast in the last null pointer.
(setf (sap-ref-sap vec-sap i) (int-sap 0))
(values vec-sap (sap+ vec-sap #-alpha 4 #+alpha 8) total-bytes))))
(defmacro with-c-strvec ((var str-list) &body body)
(let ((sap (gensym "SAP-"))
(size (gensym "SIZE-")))
`(multiple-value-bind
(,sap ,var ,size)
(string-list-to-c-strvec ,str-list)
(unwind-protect
(progn
,@body)
(sb-sys:deallocate-system-memory ,sap ,size)))))
(sb-alien:def-alien-routine spawn sb-c-call:int
(program sb-c-call:c-string)
(argv (* sb-c-call:c-string))
(envp (* sb-c-call:c-string))
(pty-name sb-c-call:c-string)
(stdin sb-c-call:int)
(stdout sb-c-call:int)
(stderr sb-c-call:int))
;;; 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 (if env-p
(unix-environment-sbcl-from-cmucl env)
(posix-environ))
environment-p)
(wait t)
pty
input
if-input-does-not-exist
output
(if-output-exists :error)
(error :output)
(if-error-exists :error)
status-hook)
"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 either return NIL or 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):
1. 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.
2. 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-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
: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 :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 (;; FIXME: The old code here used to do
;; (MERGE-PATHNAMES PROGRAM "path:"),
;; which is the right idea (searching through the Unix
;; PATH). Unfortunately, there is no logical pathname
;; "path:" defined in sbcl-0.6.10. It would probably be
;; reasonable to restore Unix PATH searching in SBCL, e.g.
;; with a function FIND-EXECUTABLE-FILE-IN-POSIX-PATH.
;; (I don't want to do it with search lists the way
;; that CMU CL did, because those are a non-ANSI
;; extension which I'd like to get rid of. -- WHN)
(pfile (unix-namestring program t t))
(cookie (list 0)))
(unless pfile
(error "no such program: ~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*.
(sb-sys:without-interrupts
(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 "could not fork child process: ~S"
(sb-unix:get-unix-error-msg)))
(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))
;;; 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))
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 "could not select on sub-process: ~S"
(sb-unix:get-unix-error-msg
readable/errno)))
((zerop result)
(return))))
(sb-alien:with-alien ((buf (sb-alien:array
sb-c-call:char
256)))
(multiple-value-bind
(count errno)
(sb-unix:unix-read descriptor
(alien-sap buf)
256)
(cond ((or (and (null count)
(eql errno sb-unix:eio))
(eql count 0))
(sb-sys:remove-fd-handler handler)
(setf handler nil)
(decf (car cookie))
(sb-unix:unix-close descriptor)
(return))
((null count)
(sb-sys:remove-fd-handler handler)
(setf handler nil)
(decf (car cookie))
(error "could not read input from sub-process: ~S"
(sb-unix:get-unix-error-msg errno)))
(t
(sb-kernel:copy-from-system-area
(alien-sap buf) 0
string (* sb-vm:vector-data-offset
sb-vm:word-bits)
(* count sb-vm:byte-bits))
(write-string string stream
:end count)))))))))))
;;; 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 "/dev/null"
(case direction
(:input sb-unix:o_rdonly)
(:output sb-unix:o_wronly)
(t sb-unix:o_rdwr))
#o666)
(unless fd
(error "could not open \"/dev/null\": ~S"
(sb-unix:get-unix-error-msg 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 "could not create pipe: ~S"
(sb-unix:get-unix-error-msg 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)))
(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)))
(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 "could not duplicate file descriptor: ~S"
(sb-unix:get-unix-error-msg errno)))))))
((sb-sys:fd-stream-p object)
(values (sb-sys:fd-stream-fd object) nil))
((streamp object)
(ecase direction
(:input
;; FIXME: We could use a better way of setting up
;; temporary files, both here and in LOAD-FOREIGN.
(dotimes (count
256
(error "could not open a temporary file in /tmp"))
(let* ((name (format nil "/tmp/.run-program-~D" count))
(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 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
(multiple-value-bind (read-fd write-fd)
(sb-unix:unix-pipe)
(unless read-fd
(error "could not create pipe: ~S"
(sb-unix:get-unix-error-msg 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))))