1 ;;; esh-proc.el --- process management -*- lexical-binding:t -*-
3 ;; Copyright (C) 1999-2018 Free Software Foundation, Inc.
5 ;; Author: John Wiegley <johnw@gnu.org>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
30 (defgroup eshell-proc nil
31 "When Eshell invokes external commands, it always does so
32 asynchronously, so that Emacs isn't tied up waiting for the process to
34 :tag
"Process management"
39 (defcustom eshell-proc-load-hook nil
40 "A hook that gets run when `eshell-proc' is loaded."
41 :version
"24.1" ; removed eshell-proc-initialize
45 (defcustom eshell-process-wait-seconds
0
46 "The number of seconds to delay waiting for a synchronous process."
50 (defcustom eshell-process-wait-milliseconds
50
51 "The number of milliseconds to delay waiting for a synchronous process."
55 (defcustom eshell-done-messages-in-minibuffer t
56 "If non-nil, subjob \"Done\" messages will display in minibuffer."
60 (defcustom eshell-delete-exited-processes t
61 "If nil, process entries will stick around until `jobs' is run.
62 This variable sets the buffer-local value of `delete-exited-processes'
65 This variable causes Eshell to mimic the behavior of bash when set to
66 nil. It allows the user to view the exit status of a completed subjob
67 \(process) at their leisure, because the process entry remains in
68 memory until the user examines it using \\[list-processes].
70 Otherwise, if `eshell-done-messages-in-minibuffer' is nil, and this
71 variable is set to t, the only indication the user will have that a
72 subjob is done is that it will no longer appear in the
73 \\[list-processes\\] display.
75 Note that Eshell will have to be restarted for a change in this
76 variable's value to take effect."
80 (defcustom eshell-reset-signals
81 "^\\(interrupt\\|killed\\|quit\\|stopped\\)"
82 "If a termination signal matches this regexp, the terminal will be reset."
86 (defcustom eshell-exec-hook nil
87 "Called each time a process is exec'd by `eshell-gather-process-output'.
88 It is passed one argument, which is the process that was just started.
89 It is useful for things that must be done each time a process is
90 executed in a eshell mode buffer (e.g., `process-kill-without-query').
91 In contrast, `eshell-mode-hook' is only executed once when the buffer
96 (defcustom eshell-kill-hook nil
97 "Called when a process run by `eshell-gather-process-output' has ended.
98 It is passed two arguments: the process that was just ended, and the
99 termination status (as a string). Note that the first argument may be
100 nil, in which case the user attempted to send a signal, but there was
101 no relevant process. This can be used for displaying help
102 information, for example."
103 :version
"24.1" ; removed eshell-reset-after-proc
107 ;;; Internal Variables:
109 (defvar eshell-current-subjob-p nil
)
111 (defvar eshell-process-list nil
112 "A list of the current status of subprocesses.")
116 (defun eshell-kill-process-function (proc status
)
117 "Function run when killing a process.
118 Runs `eshell-reset-after-proc' and `eshell-kill-hook', passing arguments
119 PROC and STATUS to functions on the latter."
120 ;; Was there till 24.1, but it is not optional.
121 (if (memq 'eshell-reset-after-proc eshell-kill-hook
)
122 (setq eshell-kill-hook
(delq 'eshell-reset-after-proc eshell-kill-hook
)))
123 (eshell-reset-after-proc status
)
124 (run-hook-with-args 'eshell-kill-hook proc status
))
126 (defun eshell-proc-initialize ()
127 "Initialize the process handling code."
128 (make-local-variable 'eshell-process-list
)
129 (define-key eshell-command-map
[(meta ?i
)] 'eshell-insert-process
)
130 (define-key eshell-command-map
[(control ?c
)] 'eshell-interrupt-process
)
131 (define-key eshell-command-map
[(control ?k
)] 'eshell-kill-process
)
132 (define-key eshell-command-map
[(control ?d
)] 'eshell-send-eof-to-process
)
133 ; (define-key eshell-command-map [(control ?q)] 'eshell-continue-process)
134 (define-key eshell-command-map
[(control ?s
)] 'list-processes
)
135 ; (define-key eshell-command-map [(control ?z)] 'eshell-stop-process)
136 (define-key eshell-command-map
[(control ?
\\)] 'eshell-quit-process
))
138 (defun eshell-reset-after-proc (status)
139 "Reset the command input location after a process terminates.
140 The signals which will cause this to happen are matched by
141 `eshell-reset-signals'."
142 (if (and (stringp status
)
143 (string-match eshell-reset-signals status
))
146 (defun eshell-wait-for-process (&rest procs
)
147 "Wait until PROC has successfully completed."
149 (let ((proc (car procs
)))
150 (when (eshell-processp proc
)
151 ;; NYI: If the process gets stopped here, that's bad.
152 (while (assq proc eshell-process-list
)
153 (if (input-pending-p)
155 (sit-for eshell-process-wait-seconds
156 eshell-process-wait-milliseconds
))))
157 (setq procs
(cdr procs
))))
159 (defalias 'eshell
/wait
'eshell-wait-for-process
)
161 (defun eshell/jobs
(&rest args
)
162 "List processes, if there are any."
163 (and (fboundp 'process-list
)
167 (defun eshell/kill
(&rest args
)
169 Usage: kill [-<signal>] <pid>|<process> ...
170 Accepts PIDs and process objects."
171 ;; If the first argument starts with a dash, treat it as the signal
173 (let ((signum 'SIGINT
))
174 (let ((arg (car args
))
175 (case-fold-search nil
))
178 ((string-match "\\`-[[:digit:]]+\\'" arg
)
179 (setq signum
(abs (string-to-number arg
))))
180 ((string-match "\\`-\\([[:upper:]]+\\|[[:lower:]]+\\)\\'" arg
)
181 (setq signum
(abs (string-to-number arg
)))))
182 (setq args
(cdr args
))))
184 (let ((arg (if (eshell-processp (car args
))
185 (process-id (car args
))
190 (error "kill: null pid. Process may actually be a network connection."))
192 (error "kill: invalid argument type: %s" (type-of arg
)))
195 (error "kill: bad pid: %d" arg
))
197 (signal-process arg signum
)))))
198 (setq args
(cdr args
))))
201 (defun eshell-read-process-name (prompt)
202 "Read the name of a process from the minibuffer, using completion.
203 The prompt will be set to PROMPT."
204 (completing-read prompt
208 (cons (process-name proc
) t
)))
209 (process-list)) nil t
))
211 (defun eshell-insert-process (process)
212 "Insert the name of PROCESS into the current buffer at point."
215 (eshell-read-process-name "Name of process: "))))
216 (insert-and-inherit "#<process " (process-name process
) ">"))
218 (defsubst eshell-record-process-object
(object)
219 "Record OBJECT as now running."
220 (if (and (eshell-processp object
)
221 eshell-current-subjob-p
)
222 (eshell-interactive-print
223 (format "[%s] %d\n" (process-name object
) (process-id object
))))
224 (setq eshell-process-list
225 (cons (list object eshell-current-handles
226 eshell-current-subjob-p nil nil
)
227 eshell-process-list
)))
229 (defun eshell-remove-process-entry (entry)
230 "Record the process ENTRY as fully completed."
231 (if (and (eshell-processp (car entry
))
233 eshell-done-messages-in-minibuffer
)
234 (message "[%s]+ Done %s" (process-name (car entry
))
235 (process-command (car entry
))))
236 (setq eshell-process-list
237 (delq entry eshell-process-list
)))
239 (defvar eshell-scratch-buffer
" *eshell-scratch*"
240 "Scratch buffer for holding Eshell's input/output.")
241 (defvar eshell-last-sync-output-start nil
242 "A marker that tracks the beginning of output of the last subprocess.
243 Used only on systems which do not support async subprocesses.")
245 (defvar eshell-needs-pipe
'("bc")
246 "List of commands which need `process-connection-type' to be nil.
247 Currently only affects commands in pipelines, and not those at
248 the front. If an element contains a directory part it must match
249 the full name of a command, otherwise just the nondirectory part must match.")
251 (defun eshell-needs-pipe-p (command)
252 "Return non-nil if COMMAND needs `process-connection-type' to be nil.
253 See `eshell-needs-pipe'."
254 (and eshell-in-pipeline-p
255 (not (eq eshell-in-pipeline-p
'first
))
256 ;; FIXME should this return non-nil for anything that is
257 ;; neither 'first nor 'last? See bug#1388 discussion.
259 (dolist (exe eshell-needs-pipe
)
260 (if (string-equal exe
(if (string-match "/" exe
)
262 (file-name-nondirectory command
)))
263 (throw 'found t
))))))
265 (defun eshell-gather-process-output (command args
)
266 "Gather the output from COMMAND + ARGS."
267 (unless (and (file-executable-p command
)
268 (file-regular-p (file-truename command
)))
269 (error "%s: not an executable file" command
))
270 (let* ((delete-exited-processes
271 (if eshell-current-subjob-p
272 eshell-delete-exited-processes
273 delete-exited-processes
))
274 (process-environment (eshell-environment-variables))
275 proc decoding encoding changed
)
277 ((fboundp 'start-file-process
)
279 (let ((process-connection-type
280 (unless (eshell-needs-pipe-p command
)
281 process-connection-type
))
282 (command (file-local-name command
)))
283 (apply 'start-file-process
284 (file-name-nondirectory command
) nil
285 ;; `start-process' can't deal with relative filenames.
286 (append (list (expand-file-name command
)) args
))))
287 (eshell-record-process-object proc
)
288 (set-process-buffer proc
(current-buffer))
289 (if (eshell-interactive-output-p)
290 (set-process-filter proc
'eshell-output-filter
)
291 (set-process-filter proc
'eshell-insertion-filter
))
292 (set-process-sentinel proc
'eshell-sentinel
)
293 (run-hook-with-args 'eshell-exec-hook proc
)
294 (when (fboundp 'process-coding-system
)
295 (let ((coding-systems (process-coding-system proc
)))
296 (setq decoding
(car coding-systems
)
297 encoding
(cdr coding-systems
)))
298 ;; If start-process decided to use some coding system for
299 ;; decoding data sent from the process and the coding system
300 ;; doesn't specify EOL conversion, we had better convert CRLF
302 (if (vectorp (coding-system-eol-type decoding
))
303 (setq decoding
(coding-system-change-eol-conversion decoding
'dos
)
305 ;; Even if start-process left the coding system for encoding
306 ;; data sent from the process undecided, we had better use the
307 ;; same one as what we use for decoding. But, we should
308 ;; suppress EOL conversion.
309 (if (and decoding
(not encoding
))
310 (setq encoding
(coding-system-change-eol-conversion decoding
'unix
)
313 (set-process-coding-system proc decoding encoding
))))
315 ;; No async subprocesses...
316 (let ((oldbuf (current-buffer))
317 (interact-p (eshell-interactive-output-p))
318 lbeg lend line proc-buf exit-status
)
319 (and (not (markerp eshell-last-sync-output-start
))
320 (setq eshell-last-sync-output-start
(point-marker)))
322 (set-buffer (get-buffer-create eshell-scratch-buffer
)))
325 (run-hook-with-args 'eshell-exec-hook command
)
327 (apply 'call-process-region
328 (append (list eshell-last-sync-output-start
(point)
330 eshell-scratch-buffer nil
)
332 ;; When in a pipeline, record the place where the output of
333 ;; this process will begin.
334 (and eshell-in-pipeline-p
335 (set-marker eshell-last-sync-output-start
(point)))
336 ;; Simulate the effect of the process filter.
337 (when (numberp exit-status
)
338 (set-buffer proc-buf
)
339 (goto-char (point-min))
341 (while (eq 0 (forward-line 1))
343 line
(buffer-substring-no-properties lbeg lend
))
346 (eshell-output-filter nil line
)
347 (eshell-output-object line
))
349 (set-buffer proc-buf
))
351 (eshell-update-markers eshell-last-output-end
)
352 ;; Simulate the effect of eshell-sentinel.
353 (eshell-close-handles (if (numberp exit-status
) exit-status -
1))
354 (eshell-kill-process-function command exit-status
)
355 (or eshell-in-pipeline-p
356 (setq eshell-last-sync-output-start nil
))
357 (if (not (numberp exit-status
))
358 (error "%s: external command failed: %s" command exit-status
))
362 (defun eshell-insertion-filter (proc string
)
363 "Insert a string into the eshell buffer, or a process/file/buffer.
364 PROC is the process for which we're inserting output. STRING is the
366 (when (buffer-live-p (process-buffer proc
))
367 (with-current-buffer (process-buffer proc
)
368 (let ((entry (assq proc eshell-process-list
)))
370 (setcar (nthcdr 3 entry
)
371 (concat (nth 3 entry
) string
))
372 (unless (nth 4 entry
) ; already being handled?
374 (let ((data (nth 3 entry
)))
375 (setcar (nthcdr 3 entry
) nil
)
376 (setcar (nthcdr 4 entry
) t
)
377 (eshell-output-object data nil
(cadr entry
))
378 (setcar (nthcdr 4 entry
) nil
)))))))))
380 (defun eshell-sentinel (proc string
)
381 "Generic sentinel for command processes. Reports only signals.
382 PROC is the process that's exiting. STRING is the exit message."
383 (when (buffer-live-p (process-buffer proc
))
384 (with-current-buffer (process-buffer proc
)
386 (let* ((entry (assq proc eshell-process-list
)))
388 ; (error "Sentinel called for unowned process `%s'"
389 ; (process-name proc))
393 (unless (string= string
"run")
394 (unless (string-match "^\\(finished\\|exited\\)" string
)
395 (eshell-insertion-filter proc string
))
396 (let ((handles (nth 1 entry
))
397 (str (prog1 (nth 3 entry
)
398 (setf (nth 3 entry
) nil
)))
399 (status (process-exit-status proc
)))
400 ;; If we're in the middle of handling output
401 ;; from this process then schedule the EOF for
406 (run-at-time 0 nil finish-io
)
407 (when str
(eshell-output-object str nil handles
))
408 (eshell-close-handles status
'nil handles
)))))
409 (funcall finish-io
)))))
410 (eshell-remove-process-entry entry
))))
411 (eshell-kill-process-function proc string
)))))
413 (defun eshell-process-interact (func &optional all query
)
414 "Interact with a process, using PROMPT if more than one, via FUNC.
415 If ALL is non-nil, background processes will be interacted with as well.
416 If QUERY is non-nil, query the user with QUERY before calling FUNC."
417 (let (defunct result
)
418 (dolist (entry eshell-process-list
)
419 (if (and (memq (process-status (car entry
))
420 '(run stop open closed
))
424 (y-or-n-p (format-message query
425 (process-name (car entry
))))))
426 (setq result
(funcall func
(car entry
))))
427 (unless (memq (process-status (car entry
))
428 '(run stop open closed
))
429 (setq defunct
(cons entry defunct
))))
430 ;; clean up the process list; this can get dirty if an error
431 ;; occurred that brought the user into the debugger, and then they
432 ;; quit, so that the sentinel was never called.
434 (eshell-remove-process-entry d
))
437 (defcustom eshell-kill-process-wait-time
5
438 "Seconds to wait between sending termination signals to a subprocess."
442 (defcustom eshell-kill-process-signals
'(SIGINT SIGQUIT SIGKILL
)
443 "Signals used to kill processes when an Eshell buffer exits.
444 Eshell calls each of these signals in order when an Eshell buffer is
445 killed; if the process is still alive afterwards, Eshell waits a
446 number of seconds defined by `eshell-kill-process-wait-time', and
447 tries the next signal in the list."
448 :type
'(repeat symbol
)
451 (defcustom eshell-kill-processes-on-exit nil
452 "If non-nil, kill active processes when exiting an Eshell buffer.
453 Emacs will only kill processes owned by that Eshell buffer.
455 If nil, ownership of background and foreground processes reverts to
456 Emacs itself, and will die only if the user exits Emacs, calls
457 `kill-process', or terminates the processes externally.
459 If `ask', Emacs prompts the user before killing any processes.
461 If `every', it prompts once for every process.
463 If t, it kills all buffer-owned processes without asking.
465 Processes are first sent SIGHUP, then SIGINT, then SIGQUIT, then
466 SIGKILL. The variable `eshell-kill-process-wait-time' specifies how
467 long to delay between signals."
468 :type
'(choice (const :tag
"Kill all, don't ask" t
)
469 (const :tag
"Ask before killing" ask
)
470 (const :tag
"Ask for each process" every
)
471 (const :tag
"Don't kill subprocesses" nil
))
474 (defun eshell-round-robin-kill (&optional query
)
475 "Kill current process by trying various signals in sequence.
476 See the variable `eshell-kill-processes-on-exit'."
477 (let ((sigs eshell-kill-process-signals
))
479 (eshell-process-interact
482 (signal-process (process-id proc
) (car sigs
)))) t query
)
484 (if (not eshell-process-list
)
486 (sleep-for eshell-kill-process-wait-time
)
487 (setq sigs
(cdr sigs
))))))
489 (defun eshell-query-kill-processes ()
490 "Kill processes belonging to the current Eshell buffer, possibly w/ query."
491 (when (and eshell-kill-processes-on-exit
493 (save-window-excursion
495 (if (or (not (eq eshell-kill-processes-on-exit
'ask
))
496 (y-or-n-p (format-message "Kill processes owned by `%s'? "
498 (eshell-round-robin-kill
499 (if (eq eshell-kill-processes-on-exit
'every
)
500 (format-message "Kill Eshell child process `%s'? "))))
501 (let ((buf (get-buffer "*Process List*")))
502 (if (and buf
(buffer-live-p buf
))
506 (defun eshell-interrupt-process ()
507 "Interrupt a process."
509 (unless (eshell-process-interact 'interrupt-process
)
510 (eshell-kill-process-function nil
"interrupt")))
512 (defun eshell-kill-process ()
515 (unless (eshell-process-interact 'kill-process
)
516 (eshell-kill-process-function nil
"killed")))
518 (defun eshell-quit-process ()
519 "Send quit signal to process."
521 (unless (eshell-process-interact 'quit-process
)
522 (eshell-kill-process-function nil
"quit")))
524 ;(defun eshell-stop-process ()
525 ; "Send STOP signal to process."
527 ; (unless (eshell-process-interact 'stop-process)
528 ; (eshell-kill-process-function nil "stopped")))
530 ;(defun eshell-continue-process ()
531 ; "Send CONTINUE signal to process."
533 ; (unless (eshell-process-interact 'continue-process)
534 ; ;; jww (1999-09-17): this signal is not dealt with yet. For
535 ; ;; example, `eshell-reset' will be called, and so will
536 ; ;; `eshell-resume-eval'.
537 ; (eshell-kill-process-function nil "continue")))
539 (defun eshell-send-eof-to-process ()
540 "Send EOF to process."
542 (eshell-send-input nil nil t
)
543 (eshell-process-interact 'process-send-eof
))
545 ;;; esh-proc.el ends here