Newer
Older
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
;;; -*- Package: Extensions; Log: code.log -*-
;;;
;;; **********************************************************************
;;; This code was written as part of the Spice Lisp project at
;;; Carnegie-Mellon University, and has been placed in the public domain.
;;; If you want to use this code or any part of Spice Lisp, please contact
;;; Scott Fahlman (FAHLMAN@CMUC).
;;; **********************************************************************
;;;
;;; RUN-PROGRAM and friends. Factilty for running unix programs from inside
;;; a lisp.
;;;
;;; Written by Jim Healy and Bill Chiles, November 1987, using an earlier
;;; version written by David McDonald.
;;;
;;; Completely re-written by William Lott, July 1989 - January 1990.
;;;
(in-package "EXTENSIONS")
(export '(run-program process-status process-exit-code process-core-dumped
process-wait process-kill process-input process-output process-plist
process-pty process-error process-status-hook process-alive-p
process-close process-pid process-p))
;;;; Import WAIT3 from unix.
(ext:def-c-pointer *wait (unsigned-byte 32))
(ext:def-c-routine ("wait3" c-wait3)
(int)
(status *wait :out)
(options int)
(rusage int))
(eval-when (load eval compile)
(defconstant wait-wstopped #o177)
(defconstant wait-wnohang 1)
(defconstant wait-wuntraced 2))
(defun wait3 (&optional do-not-hang check-for-stopped)
"Return any available status information on child processed. "
(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 (or (eql signal mach:sigstop)
(eql signal mach:sigtstp)
(eql signal mach:sigttin)
(eql signal mach: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 (:print-function %print-process))
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 ; Place for clients to stash tings.
)
(defun %print-process (proc stream depth)
(declare (ignore depth))
(format stream "#<process ~D ~S>"
(process-pid proc)
(process-status proc)))
;;; PROCESS-STATUS -- Public.
;;;
(defun process-status (proc)
"Return the current status of process. The result is one of :running,
:stopped, :exited, :signaled."
(get-processes-status-changes)
(process-%status proc))
;;; PROCESS-WAIT -- Public.
;;;
(defun process-wait (proc &optional check-for-stopped)
"Wait for PROC to quit running for some reason. Returns PROC."
(loop
(unless (or (eq (process-status proc) :running)
(and check-for-stopped
(eq (process-status proc) :stopped)))
(return))
(system:serve-all-events 1))
proc)
;;; FIND-CURRENT-FOREGROUND-PROCESS -- internal
;;;
;;; Finds the current foreground process group id.
;;;
(defun find-current-foreground-process (proc)
(mach:with-trap-arg-block mach::int1 pgrp
(multiple-value-bind
(wonp error)
(mach:unix-ioctl (system:fd-stream-fd (ext:process-pty proc))
mach:TIOCGPGRP
(lisp::alien-value-sap mach::int1))
(unless wonp
(error "TIOCPGRP ioctl failed: ~S"
(mach:get-unix-error-msg error)))
(system:alien-access (mach::int1-int (system:alien-value pgrp))))))
;;; PROCESS-KILL -- public
;;;
;;; Hand a process a signal.
;;;
(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
(find-current-foreground-process proc)))))
(multiple-value-bind (okay errno)
(if (eq whom :pty-process-group)
(mach:unix-killpg pid signal)
(mach:unix-kill pid signal))
(cond ((not okay)
(values nil errno))
((and (eql pid (process-pid proc))
(= (unix-signal-number signal) mach: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)))))
;;; PROCESS-ALIVE-P -- public
;;;
;;; Returns T if the process is still alive, NIL otherwise.
;;;
(defun process-alive-p (proc)
"Returns T if the process is still alive, NIL otherwise."
(let ((status (process-status proc)))
(if (or (eq status :running)
(eq status :stopped))
t
nil)))
;;; PROCESS-CLOSE -- public
;;;
;;; Close all the streams held open by PROC.
;;;
(defun process-close (proc)
"Close all streams connected to PROC and stop maintaining the status slot."
(macrolet ((frob (stream)
`(when ,stream (close ,stream))))
(frob (process-pty proc))
(frob (process-input proc))
(frob (process-output proc))
(frob (process-error proc))
(system:without-interrupts
(setf *active-processes* (delete proc *active-processes*)))
proc))
;;; SIGCHLD-HANDLER -- Internal.
;;;
;;; This should be the handler for sigchld signals that RUN-PROGRAM establishes.
;;;
;;; Since interrupts are so broken in the current RT system, we don't turn on
;;; sigchld signals for now. We call this by hand whenever we need to check
;;; the status of a process.
;;;
(defun sigchld-handler (ignore1 ignore2 ignore3)
(declare (ignore ignore1 ignore2 ignore3))
(get-processes-status-changes))
;;; GET-PROCESSES-STATUS-CHANGES -- Internal.
;;;
(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 (or (eq what :exited)
(eq what :signaled))
(system:without-interrupts
(setf *active-processes*
(delete proc *active-processes*)))))))))
;;;; RUN-PROGRAM and close friends.
(defvar *close-on-error* nil
"List of file descriptors to close when RUN-PROGRAM exits due to an error.")
(defvar *close-in-parent* nil
"List of file descriptors to close when RUN-PROGRAM returns in the parent.")
(defvar *handlers-installed* nil
"List of handlers installed by RUN-PROGRAM.")
;;; FIND-A-PTY -- internal
;;;
;;; Finds a pty that is not in use. Returns 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 ()
"Returns the master fd, the slave fd, and the name of the tty"
(dolist (char '(#\p #\q))
(dotimes (digit 16)
(let* ((master-name (format nil "/dev/pty~C~X" char digit))
(master-fd (mach:unix-open master-name
mach:o_rdwr
#o666)))
(when master-fd
(let* ((slave-name (format nil "/dev/tty~C~X" char digit))
(slave-fd (mach:unix-open slave-name
mach:o_rdwr
#o666)))
(when slave-fd
; Maybe put a vhangup here?
(mach:unix-ioctl slave-fd
mach:TIOCGETP
(system:alien-sap mach:sgtty))
(setf (system:alien-access (mach::sgtty-flags mach:sgtty))
#o6300) ; XTABS|EVENP|ODDP
(mach:unix-ioctl slave-fd
mach:TIOCSETP
(system:alien-sap mach:sgtty))
(mach:unix-ioctl master-fd
mach:TIOCGETP
(system:alien-sap mach:sgtty))
(setf (system:alien-access (mach::sgtty-flags mach:sgtty))
(logand (system:alien-access (mach::sgtty-flags mach:sgtty))
(lognot 8))) ; ~ECHO
(mach:unix-ioctl master-fd
mach:TIOCSETP
(system:alien-sap mach:sgtty))
(return-from find-a-pty
(values master-fd
slave-fd
slave-name))))
(mach:unix-close master-fd)))))
(error "Could not find a pty."))
;;; OPEN-PTY -- internal
;;;
(defun open-pty (pty)
(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 (won new-fd) (mach:unix-dup master)
(unless won
(error "Could not MACH:UNIX-DUP ~D: ~A"
master (mach:get-unix-error-msg new-fd)))
(push new-fd *close-on-error*)
(copy-descriptor-to-stream new-fd pty)))
(values name
(system:make-fd-stream master :input t :output t)))))
;;; SETUP-CHILD -- internal
;;;
;;; Execs the program after setting up the environment correctly. This
;;; routine never returns under any condition.
;;;
(defun setup-child (pfile args env stdin stdout stderr pty-name before-execve)
(unwind-protect
(handler-bind ((error #'(lambda (condition)
(declare (ignore condition))
(mach:unix-exit 2))))
;; Put us in our own pgrp.
(mach:unix-setpgrp 0 (mach:unix-getpid))
;; If we want a pty, set it up.
(when pty-name
(let ((old-tty (mach:unix-open "/dev/tty" mach:o_rdwr 0)))
(when old-tty
(mach:unix-ioctl old-tty mach:TIOCNOTTY 0)
(mach:unix-close old-tty)))
(let ((new-tty (mach:unix-open pty-name mach:o_rdwr 0)))
(when new-tty
(mach:unix-dup2 new-tty 0)
(mach:unix-dup2 new-tty 1)
(mach:unix-dup2 new-tty 2))))
;; Setup the three standard descriptors.
(when stdin
(mach:unix-dup2 stdin 0))
(when stdout
(mach:unix-dup2 stdout 1))
(when stderr
(mach:unix-dup2 stderr 2))
;; Close all other descriptors.
(do ((fd (1- (mach:unix-getdtablesize))
(1- fd)))
((= fd 3))
(mach:unix-close fd))
;; Do the before-execve
(when before-execve
(funcall before-execve))
;; Exec the program
(mach:unix-execve pfile args env))
;; If exec returns, we lose.
(mach:unix-exit 1)))
;;; RUN-PROGRAM -- public
;;;
;;; 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 it's input from somewhere, and send it's
;;; 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 system: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 n 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 struct for the process if the fork worked,
;;; and NIL if it did not.
;;;
(defun run-program (program args
&key (env *environment-list*) (wait t) pty input
if-input-does-not-exist output (if-output-exists :error)
(error :output) (if-error-exists :error) status-hook
before-execve)
"Run-program creates a new process and runs the unix progam in the
file specified by the simple-string program. Args are the standard
arguments that can be passed to a Unix program, for no arguments
use NIL (which means 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.
The keyword arguments have the following meanings:
:env -
An A-LIST mapping keyword environment variables to simple-string
values.
: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 spesified 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 - generate an error.
:create - create an empty file.
nil (default) - return nil from run-program.
:output -
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 spesified 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 :input is the name of a file) -
can be one of:
:error (default) - generates an error if the file already exists.
:supersede - output from the program supersedes the file.
:append - output from the program is appended to the file.
nil - run-program returns nil without doing anything.
:error and :if-error-exists -
Same as :output and :if-output-exists, except that :error can also be
spesified 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.
:before-execve -
This is a function, without arguments, RUN-PROGRAM runs in the child
process just before turning it into the specified program."
;; Make sure the interrupt handler is installed.
;(system:enable-interrupt mach:sigchld #'sigchld-handler)
;; Make sure all the args are okay.
(unless (every #'simple-string-p args)
(error "All args to program must be simple strings -- ~S." args))
;; Pre-pend the program to the argument list.
(push (namestring program) args)
;; Clear random specials used by GET-DESCRIPTOR-FOR to communicate cleanup
;; info. Also, establish proc at this level so we can return it.
(let (*close-on-error* *close-in-parent* *handlers-installed* proc)
(unwind-protect
(let ((pfile (namestring (truename (merge-pathnames program "path:")))))
(multiple-value-bind
(stdin input-stream)
(get-descriptor-for input :direction :input
:if-does-not-exist if-input-does-not-exist)
(multiple-value-bind
(stdout output-stream)
(get-descriptor-for output :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 :direction :output
:if-exists if-error-exists))
(multiple-value-bind (pty-name pty-stream)
(open-pty pty)
;; Make sure we are not notified about the child death before
;; we have installed the process struct in *active-processes*
(system:without-interrupts
(multiple-value-bind
(child-pid errno)
(mach:unix-fork)
(cond ((zerop child-pid)
;; We are the child. Note: setup-child NEVER returns
(setup-child pfile args env stdin stdout stderr
pty-name before-execve))
((null child-pid)
;; This should only happen if the bozo has too
;; many running procs.
(error "Could not fork child process: ~A"
(mach:get-unix-error-msg errno)))
(t
;; We are the parent.
(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))
(push proc *active-processes*))))))))))
(dolist (fd *close-in-parent*)
(mach:unix-close fd))
(unless proc
(dolist (fd *close-on-error*)
(mach:unix-close fd))
(dolist (handler *handlers-installed*)
(system:remove-fd-handler handler))))
(when (and wait proc)
(process-wait proc))
proc))
;;; COPY-DESCRIPTOR-TO-STREAM -- internal
;;;
;;; Installs 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)
(let ((string (make-string 256))
handler)
(setf handler
(system:add-fd-handler descriptor :input
#'(lambda (fd)
(declare (ignore fd))
(loop
(multiple-value-bind
(result readable/errno)
(mach:unix-select (1+ descriptor) (ash 1 descriptor)
0 0 0)
(cond ((null result)
(error "Could not select on sub-process: ~A"
(mach:get-unix-error-msg readable/errno)))
((zerop result)
(return))))
(multiple-value-bind
(count errno)
(mach:unix-read descriptor
string
(length string))
(cond ((or (and (null count)
(eql errno mach:eio))
(eql count 0))
(system:remove-fd-handler handler)
(mach:unix-close descriptor)
(return))
((null count)
(system:remove-fd-handler handler)
(error "Could not read input from sub-process: ~A"
(mach:get-unix-error-msg errno)))
(t
(write-string string stream
:end count))))))))))
;;; GET-DESCRIPTOR-FOR -- internal
;;;
;;; 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 &rest keys &key direction &allow-other-keys)
(cond ((eq object t)
;; No new descriptor is needed.
(values nil nil))
((eq object nil)
;; Use /dev/null.
(multiple-value-bind
(fd errno)
(mach:unix-open "/dev/null"
(case direction
(:input mach:o_rdonly)
(:output mach:o_wronly)
(t mach:o_rdwr))
#o666)
(unless fd
(error "Could not open \"/dev/null\": ~A"
(mach:get-unix-error-msg errno)))
(push fd *close-in-parent*)
(values fd nil)))
((eq object :stream)
(multiple-value-bind
(read-fd write-fd)
(mach:unix-pipe)
(unless read-fd
(error "Could not create pipe: ~A"
(mach:get-unix-error-msg write-fd)))
(case direction
(:input
(push read-fd *close-in-parent*)
(push write-fd *close-on-error*)
(let ((stream (system: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 (system:make-fd-stream read-fd :input t)))
(values write-fd stream)))
(t
(mach:unix-close read-fd)
(mach:unix-close write-fd)
(error "Direction must be either :INPUT or :OUTPUT, not ~S"
direction)))))
((stringp object)
(with-open-stream (file (apply #'open object keys))
(multiple-value-bind (won fd)
(mach:unix-dup (system:fd-stream-fd file))
(cond (won
(push fd *close-in-parent*)
(values fd nil))
(t
(error "Could not duplicate file descriptor: ~A"
(mach:get-unix-error-msg fd)))))))
((system:fd-stream-p object)
(values (system:fd-stream-fd object) nil))
((streamp object)
(ecase direction
(:input
(dotimes (count
256
(error "Could not open a temporary file in /tmp"))
(let* ((name (format nil "/tmp/.run-program-~D" count))
(fd (mach:unix-open name
(logior mach:o_rdwr
mach:o_creat
mach:o_excl)
#o666)))
(mach:unix-unlink name)
(when fd
(let ((newline (string #\Newline)))
(loop
(multiple-value-bind
(line no-cr)
(read-line object nil nil)
(unless line
(return))
(mach:unix-write fd line 0 (length line))
(if no-cr
(return)
(mach:unix-write fd newline 0 1)))))
(mach:unix-lseek fd 0 mach:l_set)
(push fd *close-in-parent*)
(return (values fd nil))))))
(:output
(multiple-value-bind (read-fd write-fd)
(mach:unix-pipe)
(unless read-fd
(error "Cound not create pipe: ~A"
(mach:get-unix-error-msg write-fd)))
(copy-descriptor-to-stream read-fd object)
(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))))