Fix typos in comments.
[bpt/emacs.git] / src / process.c
1 /* Asynchronous subprocess control for GNU Emacs.
2 Copyright (C) 1985, 86, 87, 88, 93, 94 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20
21 #include <signal.h>
22
23 #include <config.h>
24
25 /* This file is split into two parts by the following preprocessor
26 conditional. The 'then' clause contains all of the support for
27 asynchronous subprocesses. The 'else' clause contains stub
28 versions of some of the asynchronous subprocess routines that are
29 often called elsewhere in Emacs, so we don't have to #ifdef the
30 sections that call them. */
31
32 \f
33 #ifdef subprocesses
34
35 #include <stdio.h>
36 #include <errno.h>
37 #include <setjmp.h>
38 #include <sys/types.h> /* some typedefs are used in sys/file.h */
39 #include <sys/file.h>
40 #include <sys/stat.h>
41 #ifdef HAVE_UNISTD_H
42 #include <unistd.h>
43 #endif
44
45 #ifdef HAVE_SOCKETS /* TCP connection support, if kernel can do it */
46 #include <sys/socket.h>
47 #include <netdb.h>
48 #include <netinet/in.h>
49 #include <arpa/inet.h>
50 #endif /* HAVE_SOCKETS */
51
52 /* TERM is a poor-man's SLIP, used on Linux. */
53 #ifdef TERM
54 #include <client.h>
55 #endif
56
57 /* DGUX inet_addr returns a 'struct in_addr'. */
58 #ifdef DGUX
59 #define IN_ADDR struct in_addr
60 #define NUMERIC_ADDR_ERROR (numeric_addr.s_addr == -1)
61 #else
62 #define IN_ADDR unsigned long
63 #define NUMERIC_ADDR_ERROR (numeric_addr == -1)
64 #endif
65
66 #if defined(BSD) || defined(STRIDE)
67 #include <sys/ioctl.h>
68 #if !defined (O_NDELAY) && defined (HAVE_PTYS) && !defined(USG5)
69 #include <fcntl.h>
70 #endif /* HAVE_PTYS and no O_NDELAY */
71 #endif /* BSD or STRIDE */
72
73 #ifdef BROKEN_O_NONBLOCK
74 #undef O_NONBLOCK
75 #endif /* BROKEN_O_NONBLOCK */
76
77 #ifdef NEED_BSDTTY
78 #include <bsdtty.h>
79 #endif
80
81 #ifdef IRIS
82 #include <sys/sysmacros.h> /* for "minor" */
83 #endif /* not IRIS */
84
85 #include "systime.h"
86 #include "systty.h"
87
88 #include "lisp.h"
89 #include "window.h"
90 #include "buffer.h"
91 #include "process.h"
92 #include "termhooks.h"
93 #include "termopts.h"
94 #include "commands.h"
95 #include "frame.h"
96
97 Lisp_Object Qprocessp;
98 Lisp_Object Qrun, Qstop, Qsignal, Qopen, Qclosed;
99 /* Qexit is declared and initialized in eval.c. */
100
101 /* a process object is a network connection when its childp field is neither
102 Qt nor Qnil but is instead a string (name of foreign host we
103 are connected to + name of port we are connected to) */
104
105 #ifdef HAVE_SOCKETS
106 static Lisp_Object stream_process;
107
108 #define NETCONN_P(p) (XGCTYPE (XPROCESS (p)->childp) == Lisp_String)
109 #else
110 #define NETCONN_P(p) 0
111 #endif /* HAVE_SOCKETS */
112
113 /* Define first descriptor number available for subprocesses. */
114 #ifdef VMS
115 #define FIRST_PROC_DESC 1
116 #else /* Not VMS */
117 #define FIRST_PROC_DESC 3
118 #endif
119
120 /* Define SIGCHLD as an alias for SIGCLD. There are many conditionals
121 testing SIGCHLD. */
122
123 #if !defined (SIGCHLD) && defined (SIGCLD)
124 #define SIGCHLD SIGCLD
125 #endif /* SIGCLD */
126
127 #include "syssignal.h"
128
129 #include "syswait.h"
130
131 extern int errno;
132 extern char *strerror ();
133 #ifdef VMS
134 extern char *sys_errlist[];
135 #endif
136
137 #ifndef SYS_SIGLIST_DECLARED
138 #ifndef VMS
139 #ifndef BSD4_1
140 #ifndef LINUX
141 extern char *sys_siglist[];
142 #endif /* not LINUX */
143 #else /* BSD4_1 */
144 char *sys_siglist[] =
145 {
146 "bum signal!!",
147 "hangup",
148 "interrupt",
149 "quit",
150 "illegal instruction",
151 "trace trap",
152 "iot instruction",
153 "emt instruction",
154 "floating point exception",
155 "kill",
156 "bus error",
157 "segmentation violation",
158 "bad argument to system call",
159 "write on a pipe with no one to read it",
160 "alarm clock",
161 "software termination signal from kill",
162 "status signal",
163 "sendable stop signal not from tty",
164 "stop signal from tty",
165 "continue a stopped process",
166 "child status has changed",
167 "background read attempted from control tty",
168 "background write attempted from control tty",
169 "input record available at control tty",
170 "exceeded CPU time limit",
171 "exceeded file size limit"
172 };
173 #endif
174 #endif /* VMS */
175 #endif /* ! SYS_SIGLIST_DECLARED */
176
177 /* t means use pty, nil means use a pipe,
178 maybe other values to come. */
179 static Lisp_Object Vprocess_connection_type;
180
181 #ifdef SKTPAIR
182 #ifndef HAVE_SOCKETS
183 #include <sys/socket.h>
184 #endif
185 #endif /* SKTPAIR */
186
187 /* Number of events of change of status of a process. */
188 static int process_tick;
189
190 /* Number of events for which the user or sentinel has been notified. */
191 static int update_tick;
192
193 #ifdef FD_SET
194 /* We could get this from param.h, but better not to depend on finding that.
195 And better not to risk that it might define other symbols used in this
196 file. */
197 #ifdef FD_SETSIZE
198 #define MAXDESC FD_SETSIZE
199 #else
200 #define MAXDESC 64
201 #endif
202 #define SELECT_TYPE fd_set
203 #else /* no FD_SET */
204 #define MAXDESC 32
205 #define SELECT_TYPE int
206
207 /* Define the macros to access a single-int bitmap of descriptors. */
208 #define FD_SET(n, p) (*(p) |= (1 << (n)))
209 #define FD_CLR(n, p) (*(p) &= ~(1 << (n)))
210 #define FD_ISSET(n, p) (*(p) & (1 << (n)))
211 #define FD_ZERO(p) (*(p) = 0)
212 #endif /* no FD_SET */
213
214 /* Mask of bits indicating the descriptors that we wait for input on */
215
216 static SELECT_TYPE input_wait_mask;
217
218 /* Descriptor to use for keyboard input. */
219 static int keyboard_descriptor;
220
221 /* Nonzero means delete a process right away if it exits. */
222 static int delete_exited_processes;
223
224 /* Indexed by descriptor, gives the process (if any) for that descriptor */
225 Lisp_Object chan_process[MAXDESC];
226
227 /* Alist of elements (NAME . PROCESS) */
228 Lisp_Object Vprocess_alist;
229
230 /* Buffered-ahead input char from process, indexed by channel.
231 -1 means empty (no char is buffered).
232 Used on sys V where the only way to tell if there is any
233 output from the process is to read at least one char.
234 Always -1 on systems that support FIONREAD. */
235
236 static int proc_buffered_char[MAXDESC];
237
238 static Lisp_Object get_process ();
239
240 /* Maximum number of bytes to send to a pty without an eof. */
241 static int pty_max_bytes;
242 \f
243 /* Compute the Lisp form of the process status, p->status, from
244 the numeric status that was returned by `wait'. */
245
246 Lisp_Object status_convert ();
247
248 update_status (p)
249 struct Lisp_Process *p;
250 {
251 union { int i; WAITTYPE wt; } u;
252 u.i = XFASTINT (p->raw_status_low) + (XFASTINT (p->raw_status_high) << 16);
253 p->status = status_convert (u.wt);
254 p->raw_status_low = Qnil;
255 p->raw_status_high = Qnil;
256 }
257
258 /* Convert a process status word in Unix format to
259 the list that we use internally. */
260
261 Lisp_Object
262 status_convert (w)
263 WAITTYPE w;
264 {
265 if (WIFSTOPPED (w))
266 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
267 else if (WIFEXITED (w))
268 return Fcons (Qexit, Fcons (make_number (WRETCODE (w)),
269 WCOREDUMP (w) ? Qt : Qnil));
270 else if (WIFSIGNALED (w))
271 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
272 WCOREDUMP (w) ? Qt : Qnil));
273 else
274 return Qrun;
275 }
276
277 /* Given a status-list, extract the three pieces of information
278 and store them individually through the three pointers. */
279
280 void
281 decode_status (l, symbol, code, coredump)
282 Lisp_Object l;
283 Lisp_Object *symbol;
284 int *code;
285 int *coredump;
286 {
287 Lisp_Object tem;
288
289 if (XTYPE (l) == Lisp_Symbol)
290 {
291 *symbol = l;
292 *code = 0;
293 *coredump = 0;
294 }
295 else
296 {
297 *symbol = XCONS (l)->car;
298 tem = XCONS (l)->cdr;
299 *code = XFASTINT (XCONS (tem)->car);
300 tem = XCONS (tem)->cdr;
301 *coredump = !NILP (tem);
302 }
303 }
304
305 /* Return a string describing a process status list. */
306
307 Lisp_Object
308 status_message (status)
309 Lisp_Object status;
310 {
311 Lisp_Object symbol;
312 int code, coredump;
313 Lisp_Object string, string2;
314
315 decode_status (status, &symbol, &code, &coredump);
316
317 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
318 {
319 char *signame = 0;
320 if (code < NSIG)
321 {
322 #ifndef VMS
323 signame = sys_siglist[code];
324 #else
325 signame = sys_errlist[code];
326 #endif
327 }
328 if (signame == 0)
329 signame = "unknown";
330 string = build_string (signame);
331 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
332 XSTRING (string)->data[0] = DOWNCASE (XSTRING (string)->data[0]);
333 return concat2 (string, string2);
334 }
335 else if (EQ (symbol, Qexit))
336 {
337 if (code == 0)
338 return build_string ("finished\n");
339 string = Fnumber_to_string (make_number (code));
340 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
341 return concat2 (build_string ("exited abnormally with code "),
342 concat2 (string, string2));
343 }
344 else
345 return Fcopy_sequence (Fsymbol_name (symbol));
346 }
347 \f
348 #ifdef HAVE_PTYS
349
350 /* Open an available pty, returning a file descriptor.
351 Return -1 on failure.
352 The file name of the terminal corresponding to the pty
353 is left in the variable pty_name. */
354
355 char pty_name[24];
356
357 int
358 allocate_pty ()
359 {
360 struct stat stb;
361 register c, i;
362 int fd;
363
364 /* Some systems name their pseudoterminals so that there are gaps in
365 the usual sequence - for example, on HP9000/S700 systems, there
366 are no pseudoterminals with names ending in 'f'. So we wait for
367 three failures in a row before deciding that we've reached the
368 end of the ptys. */
369 int failed_count = 0;
370
371 #ifdef PTY_ITERATION
372 PTY_ITERATION
373 #else
374 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
375 for (i = 0; i < 16; i++)
376 #endif
377 {
378 #ifdef PTY_NAME_SPRINTF
379 PTY_NAME_SPRINTF
380 #else
381 sprintf (pty_name, "/dev/pty%c%x", c, i);
382 #endif /* no PTY_NAME_SPRINTF */
383
384 #ifdef PTY_OPEN
385 PTY_OPEN;
386 #else /* no PTY_OPEN */
387 #ifdef IRIS
388 /* Unusual IRIS code */
389 *ptyv = open ("/dev/ptc", O_RDWR | O_NDELAY, 0);
390 if (fd < 0)
391 return -1;
392 if (fstat (fd, &stb) < 0)
393 return -1;
394 #else /* not IRIS */
395 if (stat (pty_name, &stb) < 0)
396 {
397 failed_count++;
398 if (failed_count >= 3)
399 return -1;
400 }
401 else
402 failed_count = 0;
403 #ifdef O_NONBLOCK
404 fd = open (pty_name, O_RDWR | O_NONBLOCK, 0);
405 #else
406 fd = open (pty_name, O_RDWR | O_NDELAY, 0);
407 #endif
408 #endif /* not IRIS */
409 #endif /* no PTY_OPEN */
410
411 if (fd >= 0)
412 {
413 /* check to make certain that both sides are available
414 this avoids a nasty yet stupid bug in rlogins */
415 #ifdef PTY_TTY_NAME_SPRINTF
416 PTY_TTY_NAME_SPRINTF
417 #else
418 sprintf (pty_name, "/dev/tty%c%x", c, i);
419 #endif /* no PTY_TTY_NAME_SPRINTF */
420 #ifndef UNIPLUS
421 if (access (pty_name, 6) != 0)
422 {
423 close (fd);
424 #if !defined(IRIS) && !defined(__sgi)
425 continue;
426 #else
427 return -1;
428 #endif /* IRIS */
429 }
430 #endif /* not UNIPLUS */
431 setup_pty (fd);
432 return fd;
433 }
434 }
435 return -1;
436 }
437 #endif /* HAVE_PTYS */
438 \f
439 Lisp_Object
440 make_process (name)
441 Lisp_Object name;
442 {
443 register Lisp_Object val, tem, name1;
444 register struct Lisp_Process *p;
445 char suffix[10];
446 register int i;
447
448 /* size of process structure includes the vector header,
449 so deduct for that. But struct Lisp_Vector includes the first
450 element, thus deducts too much, so add it back. */
451 val = Fmake_vector (make_number ((sizeof (struct Lisp_Process)
452 - sizeof (struct Lisp_Vector)
453 + sizeof (Lisp_Object))
454 / sizeof (Lisp_Object)),
455 Qnil);
456 XSETTYPE (val, Lisp_Process);
457
458 p = XPROCESS (val);
459 XSET (p->infd, Lisp_Int, -1);
460 XSET (p->outfd, Lisp_Int, -1);
461 XFASTINT (p->pid) = 0;
462 XFASTINT (p->tick) = 0;
463 XFASTINT (p->update_tick) = 0;
464 p->raw_status_low = Qnil;
465 p->raw_status_high = Qnil;
466 p->status = Qrun;
467 p->mark = Fmake_marker ();
468
469 /* If name is already in use, modify it until it is unused. */
470
471 name1 = name;
472 for (i = 1; ; i++)
473 {
474 tem = Fget_process (name1);
475 if (NILP (tem)) break;
476 sprintf (suffix, "<%d>", i);
477 name1 = concat2 (name, build_string (suffix));
478 }
479 name = name1;
480 p->name = name;
481 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
482 return val;
483 }
484
485 remove_process (proc)
486 register Lisp_Object proc;
487 {
488 register Lisp_Object pair;
489
490 pair = Frassq (proc, Vprocess_alist);
491 Vprocess_alist = Fdelq (pair, Vprocess_alist);
492 Fset_marker (XPROCESS (proc)->mark, Qnil, Qnil);
493
494 deactivate_process (proc);
495 }
496 \f
497 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
498 "Return t if OBJECT is a process.")
499 (obj)
500 Lisp_Object obj;
501 {
502 return XTYPE (obj) == Lisp_Process ? Qt : Qnil;
503 }
504
505 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
506 "Return the process named NAME, or nil if there is none.")
507 (name)
508 register Lisp_Object name;
509 {
510 if (XTYPE (name) == Lisp_Process)
511 return name;
512 CHECK_STRING (name, 0);
513 return Fcdr (Fassoc (name, Vprocess_alist));
514 }
515
516 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
517 "Return the (or, a) process associated with BUFFER.\n\
518 BUFFER may be a buffer or the name of one.")
519 (name)
520 register Lisp_Object name;
521 {
522 register Lisp_Object buf, tail, proc;
523
524 if (NILP (name)) return Qnil;
525 buf = Fget_buffer (name);
526 if (NILP (buf)) return Qnil;
527
528 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
529 {
530 proc = Fcdr (Fcar (tail));
531 if (XTYPE (proc) == Lisp_Process && EQ (XPROCESS (proc)->buffer, buf))
532 return proc;
533 }
534 return Qnil;
535 }
536
537 /* This is how commands for the user decode process arguments. It
538 accepts a process, a process name, a buffer, a buffer name, or nil.
539 Buffers denote the first process in the buffer, and nil denotes the
540 current buffer. */
541
542 static Lisp_Object
543 get_process (name)
544 register Lisp_Object name;
545 {
546 register Lisp_Object proc, obj;
547 if (STRINGP (name))
548 {
549 obj = Fget_process (name);
550 if (NILP (obj))
551 obj = Fget_buffer (name);
552 if (NILP (obj))
553 error ("Process %s does not exist", XSTRING (name)->data);
554 }
555 else if (NILP (name))
556 obj = Fcurrent_buffer ();
557 else
558 obj = name;
559
560 /* Now obj should be either a buffer object or a process object.
561 */
562 if (BUFFERP (obj))
563 {
564 proc = Fget_buffer_process (obj);
565 if (NILP (proc))
566 error ("Buffer %s has no process", XSTRING (XBUFFER (obj)->name)->data);
567 }
568 else
569 {
570 CHECK_PROCESS (obj, 0);
571 proc = obj;
572 }
573 return proc;
574 }
575
576 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
577 "Delete PROCESS: kill it and forget about it immediately.\n\
578 PROCESS may be a process, a buffer, the name of a process or buffer, or\n\
579 nil, indicating the current buffer's process.")
580 (proc)
581 register Lisp_Object proc;
582 {
583 proc = get_process (proc);
584 XPROCESS (proc)->raw_status_low = Qnil;
585 XPROCESS (proc)->raw_status_high = Qnil;
586 if (NETCONN_P (proc))
587 {
588 XPROCESS (proc)->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
589 XSETINT (XPROCESS (proc)->tick, ++process_tick);
590 }
591 else if (XINT (XPROCESS (proc)->infd) >= 0)
592 {
593 Fkill_process (proc, Qnil);
594 /* Do this now, since remove_process will make sigchld_handler do nothing. */
595 XPROCESS (proc)->status
596 = Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
597 XSETINT (XPROCESS (proc)->tick, ++process_tick);
598 status_notify ();
599 }
600 remove_process (proc);
601 return Qnil;
602 }
603 \f
604 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
605 "Return the status of PROCESS: a symbol, one of these:\n\
606 run -- for a process that is running.\n\
607 stop -- for a process stopped but continuable.\n\
608 exit -- for a process that has exited.\n\
609 signal -- for a process that has got a fatal signal.\n\
610 open -- for a network stream connection that is open.\n\
611 closed -- for a network stream connection that is closed.\n\
612 nil -- if arg is a process name and no such process exists.\n\
613 PROCESS may be a process, a buffer, the name of a process or buffer, or\n\
614 nil, indicating the current buffer's process.")
615 (proc)
616 register Lisp_Object proc;
617 {
618 register struct Lisp_Process *p;
619 register Lisp_Object status;
620 proc = get_process (proc);
621 if (NILP (proc))
622 return proc;
623 p = XPROCESS (proc);
624 if (!NILP (p->raw_status_low))
625 update_status (p);
626 status = p->status;
627 if (XTYPE (status) == Lisp_Cons)
628 status = XCONS (status)->car;
629 if (NETCONN_P (proc))
630 {
631 if (EQ (status, Qrun))
632 status = Qopen;
633 else if (EQ (status, Qexit))
634 status = Qclosed;
635 }
636 return status;
637 }
638
639 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
640 1, 1, 0,
641 "Return the exit status of PROCESS or the signal number that killed it.\n\
642 If PROCESS has not yet exited or died, return 0.")
643 (proc)
644 register Lisp_Object proc;
645 {
646 CHECK_PROCESS (proc, 0);
647 if (!NILP (XPROCESS (proc)->raw_status_low))
648 update_status (XPROCESS (proc));
649 if (XTYPE (XPROCESS (proc)->status) == Lisp_Cons)
650 return XCONS (XCONS (XPROCESS (proc)->status)->cdr)->car;
651 return make_number (0);
652 }
653
654 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
655 "Return the process id of PROCESS.\n\
656 This is the pid of the Unix process which PROCESS uses or talks to.\n\
657 For a network connection, this value is nil.")
658 (proc)
659 register Lisp_Object proc;
660 {
661 CHECK_PROCESS (proc, 0);
662 return XPROCESS (proc)->pid;
663 }
664
665 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
666 "Return the name of PROCESS, as a string.\n\
667 This is the name of the program invoked in PROCESS,\n\
668 possibly modified to make it unique among process names.")
669 (proc)
670 register Lisp_Object proc;
671 {
672 CHECK_PROCESS (proc, 0);
673 return XPROCESS (proc)->name;
674 }
675
676 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
677 "Return the command that was executed to start PROCESS.\n\
678 This is a list of strings, the first string being the program executed\n\
679 and the rest of the strings being the arguments given to it.\n\
680 For a non-child channel, this is nil.")
681 (proc)
682 register Lisp_Object proc;
683 {
684 CHECK_PROCESS (proc, 0);
685 return XPROCESS (proc)->command;
686 }
687
688 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
689 2, 2, 0,
690 "Set buffer associated with PROCESS to BUFFER (a buffer, or nil).")
691 (proc, buffer)
692 register Lisp_Object proc, buffer;
693 {
694 CHECK_PROCESS (proc, 0);
695 if (!NILP (buffer))
696 CHECK_BUFFER (buffer, 1);
697 XPROCESS (proc)->buffer = buffer;
698 return buffer;
699 }
700
701 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
702 1, 1, 0,
703 "Return the buffer PROCESS is associated with.\n\
704 Output from PROCESS is inserted in this buffer\n\
705 unless PROCESS has a filter.")
706 (proc)
707 register Lisp_Object proc;
708 {
709 CHECK_PROCESS (proc, 0);
710 return XPROCESS (proc)->buffer;
711 }
712
713 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
714 1, 1, 0,
715 "Return the marker for the end of the last output from PROCESS.")
716 (proc)
717 register Lisp_Object proc;
718 {
719 CHECK_PROCESS (proc, 0);
720 return XPROCESS (proc)->mark;
721 }
722
723 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
724 2, 2, 0,
725 "Give PROCESS the filter function FILTER; nil means no filter.\n\
726 t means stop accepting output from the process.\n\
727 When a process has a filter, each time it does output\n\
728 the entire string of output is passed to the filter.\n\
729 The filter gets two arguments: the process and the string of output.\n\
730 If the process has a filter, its buffer is not used for output.")
731 (proc, filter)
732 register Lisp_Object proc, filter;
733 {
734 CHECK_PROCESS (proc, 0);
735 if (EQ (filter, Qt))
736 FD_CLR (XINT (XPROCESS (proc)->infd), &input_wait_mask);
737 else if (EQ (XPROCESS (proc)->filter, Qt))
738 FD_SET (XINT (XPROCESS (proc)->infd), &input_wait_mask);
739 XPROCESS (proc)->filter = filter;
740 return filter;
741 }
742
743 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
744 1, 1, 0,
745 "Returns the filter function of PROCESS; nil if none.\n\
746 See `set-process-filter' for more info on filter functions.")
747 (proc)
748 register Lisp_Object proc;
749 {
750 CHECK_PROCESS (proc, 0);
751 return XPROCESS (proc)->filter;
752 }
753
754 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
755 2, 2, 0,
756 "Give PROCESS the sentinel SENTINEL; nil for none.\n\
757 The sentinel is called as a function when the process changes state.\n\
758 It gets two arguments: the process, and a string describing the change.")
759 (proc, sentinel)
760 register Lisp_Object proc, sentinel;
761 {
762 CHECK_PROCESS (proc, 0);
763 XPROCESS (proc)->sentinel = sentinel;
764 return sentinel;
765 }
766
767 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
768 1, 1, 0,
769 "Return the sentinel of PROCESS; nil if none.\n\
770 See `set-process-sentinel' for more info on sentinels.")
771 (proc)
772 register Lisp_Object proc;
773 {
774 CHECK_PROCESS (proc, 0);
775 return XPROCESS (proc)->sentinel;
776 }
777
778 DEFUN ("process-kill-without-query", Fprocess_kill_without_query,
779 Sprocess_kill_without_query, 1, 2, 0,
780 "Say no query needed if PROCESS is running when Emacs is exited.\n\
781 Optional second argument if non-nil says to require a query.\n\
782 Value is t if a query was formerly required.")
783 (proc, value)
784 register Lisp_Object proc, value;
785 {
786 Lisp_Object tem;
787
788 CHECK_PROCESS (proc, 0);
789 tem = XPROCESS (proc)->kill_without_query;
790 XPROCESS (proc)->kill_without_query = Fnull (value);
791
792 return Fnull (tem);
793 }
794
795 #if 0 /* Turned off because we don't currently record this info
796 in the process. Perhaps add it. */
797 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
798 "Return the connection type of `PROCESS'.\n\
799 The value is `nil' for a pipe,\n\
800 `t' or `pty' for a pty, or `stream' for a socket connection.")
801 (process)
802 Lisp_Object process;
803 {
804 return XPROCESS (process)->type;
805 }
806 #endif
807 \f
808 Lisp_Object
809 list_processes_1 ()
810 {
811 register Lisp_Object tail, tem;
812 Lisp_Object proc, minspace, tem1;
813 register struct buffer *old = current_buffer;
814 register struct Lisp_Process *p;
815 register int state;
816 char tembuf[80];
817
818 XFASTINT (minspace) = 1;
819
820 set_buffer_internal (XBUFFER (Vstandard_output));
821 Fbuffer_disable_undo (Vstandard_output);
822
823 current_buffer->truncate_lines = Qt;
824
825 write_string ("\
826 Proc Status Buffer Command\n\
827 ---- ------ ------ -------\n", -1);
828
829 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
830 {
831 Lisp_Object symbol;
832
833 proc = Fcdr (Fcar (tail));
834 p = XPROCESS (proc);
835 if (NILP (p->childp))
836 continue;
837
838 Finsert (1, &p->name);
839 Findent_to (make_number (13), minspace);
840
841 if (!NILP (p->raw_status_low))
842 update_status (p);
843 symbol = p->status;
844 if (XTYPE (p->status) == Lisp_Cons)
845 symbol = XCONS (p->status)->car;
846
847
848 if (EQ (symbol, Qsignal))
849 {
850 Lisp_Object tem;
851 tem = Fcar (Fcdr (p->status));
852 #ifdef VMS
853 if (XINT (tem) < NSIG)
854 write_string (sys_errlist [XINT (tem)], -1);
855 else
856 #endif
857 Fprinc (symbol, Qnil);
858 }
859 else if (NETCONN_P (proc))
860 {
861 if (EQ (symbol, Qrun))
862 write_string ("open", -1);
863 else if (EQ (symbol, Qexit))
864 write_string ("closed", -1);
865 else
866 Fprinc (symbol, Qnil);
867 }
868 else
869 Fprinc (symbol, Qnil);
870
871 if (EQ (symbol, Qexit))
872 {
873 Lisp_Object tem;
874 tem = Fcar (Fcdr (p->status));
875 if (XFASTINT (tem))
876 {
877 sprintf (tembuf, " %d", XFASTINT (tem));
878 write_string (tembuf, -1);
879 }
880 }
881
882 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
883 remove_process (proc);
884
885 Findent_to (make_number (22), minspace);
886 if (NILP (p->buffer))
887 insert_string ("(none)");
888 else if (NILP (XBUFFER (p->buffer)->name))
889 insert_string ("(Killed)");
890 else
891 Finsert (1, &XBUFFER (p->buffer)->name);
892
893 Findent_to (make_number (37), minspace);
894
895 if (NETCONN_P (proc))
896 {
897 sprintf (tembuf, "(network stream connection to %s)\n",
898 XSTRING (p->childp)->data);
899 insert_string (tembuf);
900 }
901 else
902 {
903 tem = p->command;
904 while (1)
905 {
906 tem1 = Fcar (tem);
907 Finsert (1, &tem1);
908 tem = Fcdr (tem);
909 if (NILP (tem))
910 break;
911 insert_string (" ");
912 }
913 insert_string ("\n");
914 }
915 }
916 return Qnil;
917 }
918
919 DEFUN ("list-processes", Flist_processes, Slist_processes, 0, 0, "",
920 "Display a list of all processes.\n\
921 \(Any processes listed as Exited or Signaled are actually eliminated\n\
922 after the listing is made.)")
923 ()
924 {
925 internal_with_output_to_temp_buffer ("*Process List*",
926 list_processes_1, Qnil);
927 return Qnil;
928 }
929
930 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
931 "Return a list of all processes.")
932 ()
933 {
934 return Fmapcar (Qcdr, Vprocess_alist);
935 }
936 \f
937 /* Starting asynchronous inferior processes. */
938
939 static Lisp_Object start_process_unwind ();
940
941 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
942 "Start a program in a subprocess. Return the process object for it.\n\
943 Args are NAME BUFFER PROGRAM &rest PROGRAM-ARGS\n\
944 NAME is name for process. It is modified if necessary to make it unique.\n\
945 BUFFER is the buffer or (buffer-name) to associate with the process.\n\
946 Process output goes at end of that buffer, unless you specify\n\
947 an output stream or filter function to handle the output.\n\
948 BUFFER may be also nil, meaning that this process is not associated\n\
949 with any buffer\n\
950 Third arg is program file name. It is searched for as in the shell.\n\
951 Remaining arguments are strings to give program as arguments.")
952 (nargs, args)
953 int nargs;
954 register Lisp_Object *args;
955 {
956 Lisp_Object buffer, name, program, proc, current_dir, tem;
957 #ifdef VMS
958 register unsigned char *new_argv;
959 int len;
960 #else
961 register unsigned char **new_argv;
962 #endif
963 register int i;
964 int count = specpdl_ptr - specpdl;
965
966 buffer = args[1];
967 if (!NILP (buffer))
968 buffer = Fget_buffer_create (buffer);
969
970 /* Make sure that the child will be able to chdir to the current
971 buffer's current directory, or its unhandled equivalent. We
972 can't just have the child check for an error when it does the
973 chdir, since it's in a vfork.
974
975 We have to GCPRO around this because Fexpand_file_name and
976 Funhandled_file_name_directory might call a file name handling
977 function. The argument list is protected by the caller, so all
978 we really have to worry about is buffer. */
979 {
980 struct gcpro gcpro1, gcpro2;
981
982 current_dir = current_buffer->directory;
983
984 GCPRO2 (buffer, current_dir);
985
986 current_dir =
987 expand_and_dir_to_file
988 (Funhandled_file_name_directory (current_dir), Qnil);
989 if (NILP (Ffile_accessible_directory_p (current_dir)))
990 report_file_error ("Setting current directory",
991 Fcons (current_buffer->directory, Qnil));
992
993 UNGCPRO;
994 }
995
996 name = args[0];
997 CHECK_STRING (name, 0);
998
999 program = args[2];
1000
1001 CHECK_STRING (program, 2);
1002
1003 #ifdef VMS
1004 /* Make a one member argv with all args concatenated
1005 together separated by a blank. */
1006 len = XSTRING (program)->size + 2;
1007 for (i = 3; i < nargs; i++)
1008 {
1009 tem = args[i];
1010 CHECK_STRING (tem, i);
1011 len += XSTRING (tem)->size + 1; /* count the blank */
1012 }
1013 new_argv = (unsigned char *) alloca (len);
1014 strcpy (new_argv, XSTRING (program)->data);
1015 for (i = 3; i < nargs; i++)
1016 {
1017 tem = args[i];
1018 CHECK_STRING (tem, i);
1019 strcat (new_argv, " ");
1020 strcat (new_argv, XSTRING (tem)->data);
1021 }
1022 /* Need to add code here to check for program existence on VMS */
1023
1024 #else /* not VMS */
1025 new_argv = (unsigned char **) alloca ((nargs - 1) * sizeof (char *));
1026
1027 /* If program file name is not absolute, search our path for it */
1028 if (XSTRING (program)->data[0] != '/')
1029 {
1030 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1031
1032 tem = Qnil;
1033 GCPRO4 (name, program, buffer, current_dir);
1034 openp (Vexec_path, program, EXEC_SUFFIXES, &tem, 1);
1035 UNGCPRO;
1036 if (NILP (tem))
1037 report_file_error ("Searching for program", Fcons (program, Qnil));
1038 new_argv[0] = XSTRING (tem)->data;
1039 }
1040 else
1041 new_argv[0] = XSTRING (program)->data;
1042
1043 for (i = 3; i < nargs; i++)
1044 {
1045 tem = args[i];
1046 CHECK_STRING (tem, i);
1047 new_argv[i - 2] = XSTRING (tem)->data;
1048 }
1049 new_argv[i - 2] = 0;
1050 #endif /* not VMS */
1051
1052 proc = make_process (name);
1053 /* If an error occurs and we can't start the process, we want to
1054 remove it from the process list. This means that each error
1055 check in create_process doesn't need to call remove_process
1056 itself; it's all taken care of here. */
1057 record_unwind_protect (start_process_unwind, proc);
1058
1059 XPROCESS (proc)->childp = Qt;
1060 XPROCESS (proc)->command_channel_p = Qnil;
1061 XPROCESS (proc)->buffer = buffer;
1062 XPROCESS (proc)->sentinel = Qnil;
1063 XPROCESS (proc)->filter = Qnil;
1064 XPROCESS (proc)->command = Flist (nargs - 2, args + 2);
1065
1066 create_process (proc, new_argv, current_dir);
1067
1068 return unbind_to (count, proc);
1069 }
1070
1071 /* This function is the unwind_protect form for Fstart_process. If
1072 PROC doesn't have its pid set, then we know someone has signalled
1073 an error and the process wasn't started successfully, so we should
1074 remove it from the process list. */
1075 static Lisp_Object
1076 start_process_unwind (proc)
1077 Lisp_Object proc;
1078 {
1079 if (XTYPE (proc) != Lisp_Process)
1080 abort ();
1081
1082 /* Was PROC started successfully? */
1083 if (XINT (XPROCESS (proc)->pid) <= 0)
1084 remove_process (proc);
1085
1086 return Qnil;
1087 }
1088
1089
1090 SIGTYPE
1091 create_process_1 (signo)
1092 int signo;
1093 {
1094 #ifdef USG
1095 /* USG systems forget handlers when they are used;
1096 must reestablish each time */
1097 signal (signo, create_process_1);
1098 #endif /* USG */
1099 }
1100
1101 #if 0 /* This doesn't work; see the note before sigchld_handler. */
1102 #ifdef USG
1103 #ifdef SIGCHLD
1104 /* Mimic blocking of signals on system V, which doesn't really have it. */
1105
1106 /* Nonzero means we got a SIGCHLD when it was supposed to be blocked. */
1107 int sigchld_deferred;
1108
1109 SIGTYPE
1110 create_process_sigchld ()
1111 {
1112 signal (SIGCHLD, create_process_sigchld);
1113
1114 sigchld_deferred = 1;
1115 }
1116 #endif
1117 #endif
1118 #endif
1119
1120 #ifndef VMS /* VMS version of this function is in vmsproc.c. */
1121 create_process (process, new_argv, current_dir)
1122 Lisp_Object process;
1123 char **new_argv;
1124 Lisp_Object current_dir;
1125 {
1126 int pid, inchannel, outchannel, forkin, forkout;
1127 int sv[2];
1128 #ifdef SIGCHLD
1129 SIGTYPE (*sigchld)();
1130 #endif
1131 int pty_flag = 0;
1132 extern char **environ;
1133
1134 inchannel = outchannel = -1;
1135
1136 #ifdef HAVE_PTYS
1137 if (EQ (Vprocess_connection_type, Qt))
1138 outchannel = inchannel = allocate_pty ();
1139
1140 if (inchannel >= 0)
1141 {
1142 #ifndef USG
1143 /* On USG systems it does not work to open the pty's tty here
1144 and then close and reopen it in the child. */
1145 #ifdef O_NOCTTY
1146 /* Don't let this terminal become our controlling terminal
1147 (in case we don't have one). */
1148 forkout = forkin = open (pty_name, O_RDWR | O_NOCTTY, 0);
1149 #else
1150 forkout = forkin = open (pty_name, O_RDWR, 0);
1151 #endif
1152 if (forkin < 0)
1153 report_file_error ("Opening pty", Qnil);
1154 #else
1155 forkin = forkout = -1;
1156 #endif /* not USG */
1157 pty_flag = 1;
1158 }
1159 else
1160 #endif /* HAVE_PTYS */
1161 #ifdef SKTPAIR
1162 {
1163 if (socketpair (AF_UNIX, SOCK_STREAM, 0, sv) < 0)
1164 report_file_error ("Opening socketpair", Qnil);
1165 outchannel = inchannel = sv[0];
1166 forkout = forkin = sv[1];
1167 }
1168 #else /* not SKTPAIR */
1169 {
1170 pipe (sv);
1171 inchannel = sv[0];
1172 forkout = sv[1];
1173 pipe (sv);
1174 outchannel = sv[1];
1175 forkin = sv[0];
1176 }
1177 #endif /* not SKTPAIR */
1178
1179 #if 0
1180 /* Replaced by close_process_descs */
1181 set_exclusive_use (inchannel);
1182 set_exclusive_use (outchannel);
1183 #endif
1184
1185 /* Stride people say it's a mystery why this is needed
1186 as well as the O_NDELAY, but that it fails without this. */
1187 #if defined (STRIDE) || (defined (pfa) && defined (HAVE_PTYS))
1188 {
1189 int one = 1;
1190 ioctl (inchannel, FIONBIO, &one);
1191 }
1192 #endif
1193
1194 #ifdef O_NONBLOCK
1195 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1196 #else
1197 #ifdef O_NDELAY
1198 fcntl (inchannel, F_SETFL, O_NDELAY);
1199 #endif
1200 #endif
1201
1202 /* Record this as an active process, with its channels.
1203 As a result, child_setup will close Emacs's side of the pipes. */
1204 chan_process[inchannel] = process;
1205 XSET (XPROCESS (process)->infd, Lisp_Int, inchannel);
1206 XSET (XPROCESS (process)->outfd, Lisp_Int, outchannel);
1207 /* Record the tty descriptor used in the subprocess. */
1208 if (forkin < 0)
1209 XPROCESS (process)->subtty = Qnil;
1210 else
1211 XFASTINT (XPROCESS (process)->subtty) = forkin;
1212 XPROCESS (process)->pty_flag = (pty_flag ? Qt : Qnil);
1213 XPROCESS (process)->status = Qrun;
1214
1215 /* Delay interrupts until we have a chance to store
1216 the new fork's pid in its process structure */
1217 #ifdef SIGCHLD
1218 #ifdef BSD4_1
1219 sighold (SIGCHLD);
1220 #else /* not BSD4_1 */
1221 #if defined (BSD) || defined (UNIPLUS) || defined (HPUX)
1222 sigsetmask (sigmask (SIGCHLD));
1223 #else /* ordinary USG */
1224 #if 0
1225 sigchld_deferred = 0;
1226 sigchld = signal (SIGCHLD, create_process_sigchld);
1227 #endif
1228 #endif /* ordinary USG */
1229 #endif /* not BSD4_1 */
1230 #endif /* SIGCHLD */
1231
1232 /* Until we store the proper pid, enable sigchld_handler
1233 to recognize an unknown pid as standing for this process.
1234 It is very important not to let this `marker' value stay
1235 in the table after this function has returned; if it does
1236 it might cause call-process to hang and subsequent asynchronous
1237 processes to get their return values scrambled. */
1238 XSETINT (XPROCESS (process)->pid, -1);
1239
1240 {
1241 /* child_setup must clobber environ on systems with true vfork.
1242 Protect it from permanent change. */
1243 char **save_environ = environ;
1244
1245 pid = vfork ();
1246 if (pid == 0)
1247 {
1248 int xforkin = forkin;
1249 int xforkout = forkout;
1250
1251 #if 0 /* This was probably a mistake--it duplicates code later on,
1252 but fails to handle all the cases. */
1253 /* Make sure SIGCHLD is not blocked in the child. */
1254 sigsetmask (SIGEMPTYMASK);
1255 #endif
1256
1257 /* Make the pty be the controlling terminal of the process. */
1258 #ifdef HAVE_PTYS
1259 /* First, disconnect its current controlling terminal. */
1260 #ifdef HAVE_SETSID
1261 setsid ();
1262 #ifdef TIOCSCTTY
1263 /* Make the pty's terminal the controlling terminal. */
1264 if (pty_flag)
1265 /* We ignore the return value
1266 because faith@cs.unc.edu says that is necessary on Linux. */
1267 ioctl (xforkin, TIOCSCTTY, 0);
1268 #endif
1269 #else /* not HAVE_SETSID */
1270 #ifdef USG
1271 /* It's very important to call setpgrp here and no time
1272 afterwards. Otherwise, we lose our controlling tty which
1273 is set when we open the pty. */
1274 setpgrp ();
1275 #endif /* USG */
1276 #endif /* not HAVE_SETSID */
1277 #ifdef NTTYDISC
1278 if (pty_flag && xforkin >= 0)
1279 {
1280 /* Use new line discipline. */
1281 int ldisc = NTTYDISC;
1282 if (ioctl (xforkin, TIOCSETD, &ldisc) < 0)
1283 write (1, "create_process/TIOCSETD failed\n", 31);
1284 }
1285 #endif
1286 #ifdef TIOCNOTTY
1287 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1288 can do TIOCSPGRP only to the process's controlling tty. */
1289 if (pty_flag)
1290 {
1291 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1292 I can't test it since I don't have 4.3. */
1293 int j = open ("/dev/tty", O_RDWR, 0);
1294 ioctl (j, TIOCNOTTY, 0);
1295 close (j);
1296 #ifndef USG
1297 /* In order to get a controlling terminal on some versions
1298 of BSD, it is necessary to put the process in pgrp 0
1299 before it opens the terminal. */
1300 setpgrp (0, 0);
1301 #endif
1302 }
1303 #endif /* TIOCNOTTY */
1304
1305 #if !defined (RTU) && !defined (UNIPLUS)
1306 /*** There is a suggestion that this ought to be a
1307 conditional on TIOCSPGRP. */
1308 /* Now close the pty (if we had it open) and reopen it.
1309 This makes the pty the controlling terminal of the subprocess. */
1310 if (pty_flag)
1311 {
1312 #ifdef SET_CHILD_PTY_PGRP
1313 int pgrp = getpid ();
1314 #endif
1315
1316 /* I wonder if close (open (pty_name, ...)) would work? */
1317 if (xforkin >= 0)
1318 close (xforkin);
1319 xforkout = xforkin = open (pty_name, O_RDWR, 0);
1320
1321 #ifdef SET_CHILD_PTY_PGRP
1322 ioctl (xforkin, TIOCSPGRP, &pgrp);
1323 ioctl (xforkout, TIOCSPGRP, &pgrp);
1324 #endif
1325
1326 if (xforkin < 0)
1327 abort ();
1328 }
1329 #endif /* not UNIPLUS and not RTU */
1330 #ifdef SETUP_SLAVE_PTY
1331 SETUP_SLAVE_PTY;
1332 #endif /* SETUP_SLAVE_PTY */
1333 #ifdef AIX
1334 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
1335 Now reenable it in the child, so it will die when we want it to. */
1336 if (pty_flag)
1337 signal (SIGHUP, SIG_DFL);
1338 #endif
1339 #endif /* HAVE_PTYS */
1340
1341 #ifdef SIGCHLD
1342 #ifdef BSD4_1
1343 sigrelse (SIGCHLD);
1344 #else /* not BSD4_1 */
1345 #if defined (BSD) || defined (UNIPLUS) || defined (HPUX)
1346 sigsetmask (SIGEMPTYMASK);
1347 #else /* ordinary USG */
1348 #if 0
1349 signal (SIGCHLD, sigchld);
1350 #endif
1351 #endif /* ordinary USG */
1352 #endif /* not BSD4_1 */
1353 #endif /* SIGCHLD */
1354
1355 child_setup_tty (xforkout);
1356 child_setup (xforkin, xforkout, xforkout,
1357 new_argv, 1, current_dir);
1358 }
1359 environ = save_environ;
1360 }
1361
1362 if (pid < 0)
1363 report_file_error ("Doing vfork", Qnil);
1364
1365 XFASTINT (XPROCESS (process)->pid) = pid;
1366
1367 FD_SET (inchannel, &input_wait_mask);
1368
1369 /* If the subfork execv fails, and it exits,
1370 this close hangs. I don't know why.
1371 So have an interrupt jar it loose. */
1372 stop_polling ();
1373 signal (SIGALRM, create_process_1);
1374 alarm (1);
1375 XPROCESS (process)->subtty = Qnil;
1376 if (forkin >= 0)
1377 close (forkin);
1378 alarm (0);
1379 start_polling ();
1380 if (forkin != forkout && forkout >= 0)
1381 close (forkout);
1382
1383 #ifdef SIGCHLD
1384 #ifdef BSD4_1
1385 sigrelse (SIGCHLD);
1386 #else /* not BSD4_1 */
1387 #if defined (BSD) || defined (UNIPLUS) || defined (HPUX)
1388 sigsetmask (SIGEMPTYMASK);
1389 #else /* ordinary USG */
1390 #if 0
1391 signal (SIGCHLD, sigchld);
1392 /* Now really handle any of these signals
1393 that came in during this function. */
1394 if (sigchld_deferred)
1395 kill (getpid (), SIGCHLD);
1396 #endif
1397 #endif /* ordinary USG */
1398 #endif /* not BSD4_1 */
1399 #endif /* SIGCHLD */
1400 }
1401 #endif /* not VMS */
1402
1403 #ifdef HAVE_SOCKETS
1404
1405 /* open a TCP network connection to a given HOST/SERVICE. Treated
1406 exactly like a normal process when reading and writing. Only
1407 differences are in status display and process deletion. A network
1408 connection has no PID; you cannot signal it. All you can do is
1409 deactivate and close it via delete-process */
1410
1411 DEFUN ("open-network-stream", Fopen_network_stream, Sopen_network_stream,
1412 4, 4, 0,
1413 "Open a TCP connection for a service to a host.\n\
1414 Returns a subprocess-object to represent the connection.\n\
1415 Input and output work as for subprocesses; `delete-process' closes it.\n\
1416 Args are NAME BUFFER HOST SERVICE.\n\
1417 NAME is name for process. It is modified if necessary to make it unique.\n\
1418 BUFFER is the buffer (or buffer-name) to associate with the process.\n\
1419 Process output goes at end of that buffer, unless you specify\n\
1420 an output stream or filter function to handle the output.\n\
1421 BUFFER may be also nil, meaning that this process is not associated\n\
1422 with any buffer\n\
1423 Third arg is name of the host to connect to, or its IP address.\n\
1424 Fourth arg SERVICE is name of the service desired, or an integer\n\
1425 specifying a port number to connect to.")
1426 (name, buffer, host, service)
1427 Lisp_Object name, buffer, host, service;
1428 {
1429 Lisp_Object proc;
1430 register int i;
1431 struct sockaddr_in address;
1432 struct servent *svc_info;
1433 struct hostent *host_info_ptr, host_info;
1434 char *(addr_list[2]);
1435 IN_ADDR numeric_addr;
1436 int s, outch, inch;
1437 char errstring[80];
1438 int port;
1439 struct hostent host_info_fixed;
1440 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1441
1442 GCPRO4 (name, buffer, host, service);
1443 CHECK_STRING (name, 0);
1444 CHECK_STRING (host, 0);
1445 if (XTYPE(service) == Lisp_Int)
1446 port = htons ((unsigned short) XINT (service));
1447 else
1448 {
1449 CHECK_STRING (service, 0);
1450 svc_info = getservbyname (XSTRING (service)->data, "tcp");
1451 if (svc_info == 0)
1452 error ("Unknown service \"%s\"", XSTRING (service)->data);
1453 port = svc_info->s_port;
1454 }
1455
1456 #ifndef TERM
1457 host_info_ptr = gethostbyname (XSTRING (host)->data);
1458 if (host_info_ptr == 0)
1459 /* Attempt to interpret host as numeric inet address */
1460 {
1461 numeric_addr = inet_addr ((char *) XSTRING (host)->data);
1462 if (NUMERIC_ADDR_ERROR)
1463 error ("Unknown host \"%s\"", XSTRING (host)->data);
1464
1465 host_info_ptr = &host_info;
1466 host_info.h_name = 0;
1467 host_info.h_aliases = 0;
1468 host_info.h_addrtype = AF_INET;
1469 #ifdef h_addr
1470 /* Older machines have only one address slot called h_addr.
1471 Newer machines have h_addr_list, but #define h_addr to
1472 be its first element. */
1473 host_info.h_addr_list = &(addr_list[0]);
1474 #endif
1475 host_info.h_addr = (char*)(&numeric_addr);
1476 addr_list[1] = 0;
1477 host_info.h_length = strlen (addr_list[0]);
1478 }
1479
1480 bzero (&address, sizeof address);
1481 bcopy (host_info_ptr->h_addr, (char *) &address.sin_addr,
1482 host_info_ptr->h_length);
1483 address.sin_family = host_info_ptr->h_addrtype;
1484 address.sin_port = port;
1485
1486 s = socket (host_info_ptr->h_addrtype, SOCK_STREAM, 0);
1487 if (s < 0)
1488 report_file_error ("error creating socket", Fcons (name, Qnil));
1489
1490 /* Kernel bugs (on Ultrix at least) cause lossage (not just EINTR)
1491 when connect is interrupted. So let's not let it get interrupted.
1492 Note we do not turn off polling, because polling is only used
1493 when not interrupt_input, and thus not normally used on the systems
1494 which have this bug. On systems which use polling, there's no way
1495 to quit if polling is turned off. */
1496 if (interrupt_input)
1497 unrequest_sigio ();
1498
1499 loop:
1500 if (connect (s, (struct sockaddr *) &address, sizeof address) == -1)
1501 {
1502 int xerrno = errno;
1503 if (errno == EINTR)
1504 goto loop;
1505 close (s);
1506
1507 if (interrupt_input)
1508 request_sigio ();
1509
1510 errno = xerrno;
1511 report_file_error ("connection failed",
1512 Fcons (host, Fcons (name, Qnil)));
1513 }
1514
1515 if (interrupt_input)
1516 request_sigio ();
1517
1518 #else /* TERM */
1519 s = connect_server (0);
1520 if (s < 0)
1521 report_file_error ("error creating socket", Fcons (name, Qnil));
1522 send_command (s, C_PORT, 0, "%s:%d", XSTRING (host)->data, ntohs (port));
1523 send_command (s, C_DUMB, 1, 0);
1524 #endif /* TERM */
1525
1526 inch = s;
1527 outch = dup (s);
1528 if (outch < 0)
1529 report_file_error ("error duplicating socket", Fcons (name, Qnil));
1530
1531 if (!NILP (buffer))
1532 buffer = Fget_buffer_create (buffer);
1533 proc = make_process (name);
1534
1535 chan_process[inch] = proc;
1536
1537 #ifdef O_NONBLOCK
1538 fcntl (inch, F_SETFL, O_NONBLOCK);
1539 #else
1540 #ifdef O_NDELAY
1541 fcntl (inch, F_SETFL, O_NDELAY);
1542 #endif
1543 #endif
1544
1545 XPROCESS (proc)->childp = host;
1546 XPROCESS (proc)->command_channel_p = Qnil;
1547 XPROCESS (proc)->buffer = buffer;
1548 XPROCESS (proc)->sentinel = Qnil;
1549 XPROCESS (proc)->filter = Qnil;
1550 XPROCESS (proc)->command = Qnil;
1551 XPROCESS (proc)->pid = Qnil;
1552 XSET (XPROCESS (proc)->infd, Lisp_Int, s);
1553 XSET (XPROCESS (proc)->outfd, Lisp_Int, outch);
1554 XPROCESS (proc)->status = Qrun;
1555 FD_SET (inch, &input_wait_mask);
1556
1557 UNGCPRO;
1558 return proc;
1559 }
1560 #endif /* HAVE_SOCKETS */
1561
1562 deactivate_process (proc)
1563 Lisp_Object proc;
1564 {
1565 register int inchannel, outchannel;
1566 register struct Lisp_Process *p = XPROCESS (proc);
1567
1568 inchannel = XINT (p->infd);
1569 outchannel = XINT (p->outfd);
1570
1571 if (inchannel >= 0)
1572 {
1573 /* Beware SIGCHLD hereabouts. */
1574 flush_pending_output (inchannel);
1575 #ifdef VMS
1576 {
1577 VMS_PROC_STUFF *get_vms_process_pointer (), *vs;
1578 sys$dassgn (outchannel);
1579 vs = get_vms_process_pointer (p->pid);
1580 if (vs)
1581 give_back_vms_process_stuff (vs);
1582 }
1583 #else
1584 close (inchannel);
1585 if (outchannel >= 0 && outchannel != inchannel)
1586 close (outchannel);
1587 #endif
1588
1589 XSET (p->infd, Lisp_Int, -1);
1590 XSET (p->outfd, Lisp_Int, -1);
1591 chan_process[inchannel] = Qnil;
1592 FD_CLR (inchannel, &input_wait_mask);
1593 }
1594 }
1595
1596 /* Close all descriptors currently in use for communication
1597 with subprocess. This is used in a newly-forked subprocess
1598 to get rid of irrelevant descriptors. */
1599
1600 close_process_descs ()
1601 {
1602 int i;
1603 for (i = 0; i < MAXDESC; i++)
1604 {
1605 Lisp_Object process;
1606 process = chan_process[i];
1607 if (!NILP (process))
1608 {
1609 int in = XINT (XPROCESS (process)->infd);
1610 int out = XINT (XPROCESS (process)->outfd);
1611 if (in >= 0)
1612 close (in);
1613 if (out >= 0 && in != out)
1614 close (out);
1615 }
1616 }
1617 }
1618 \f
1619 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
1620 0, 3, 0,
1621 "Allow any pending output from subprocesses to be read by Emacs.\n\
1622 It is read into the process' buffers or given to their filter functions.\n\
1623 Non-nil arg PROCESS means do not return until some output has been received\n\
1624 from PROCESS.\n\
1625 Non-nil second arg TIMEOUT and third arg TIMEOUT-MSECS are number of\n\
1626 seconds and microseconds to wait; return after that much time whether\n\
1627 or not there is input.\n\
1628 Return non-nil iff we received any output before the timeout expired.")
1629 (proc, timeout, timeout_msecs)
1630 register Lisp_Object proc, timeout, timeout_msecs;
1631 {
1632 int seconds;
1633 int useconds;
1634
1635 if (! NILP (timeout_msecs))
1636 {
1637 CHECK_NUMBER (timeout_msecs, 2);
1638 useconds = XINT (timeout_msecs);
1639 if (XTYPE (timeout) != Lisp_Int)
1640 XSET (timeout, Lisp_Int, 0);
1641
1642 {
1643 int carry = useconds / 1000000;
1644
1645 XSETINT (timeout, XINT (timeout) + carry);
1646 useconds -= carry * 1000000;
1647
1648 /* I think this clause is necessary because C doesn't
1649 guarantee a particular rounding direction for negative
1650 integers. */
1651 if (useconds < 0)
1652 {
1653 XSETINT (timeout, XINT (timeout) - 1);
1654 useconds += 1000000;
1655 }
1656 }
1657 }
1658 else
1659 useconds = 0;
1660
1661 if (! NILP (timeout))
1662 {
1663 CHECK_NUMBER (timeout, 1);
1664 seconds = XINT (timeout);
1665 if (seconds <= 0)
1666 seconds = -1;
1667 }
1668 else
1669 {
1670 if (NILP (proc))
1671 seconds = -1;
1672 else
1673 seconds = 0;
1674 }
1675
1676 if (NILP (proc))
1677 XFASTINT (proc) = 0;
1678
1679 return
1680 (wait_reading_process_input (seconds, useconds, proc, 0)
1681 ? Qt : Qnil);
1682 }
1683
1684 /* This variable is different from waiting_for_input in keyboard.c.
1685 It is used to communicate to a lisp process-filter/sentinel (via the
1686 function Fwaiting_for_user_input_p below) whether emacs was waiting
1687 for user-input when that process-filter was called.
1688 waiting_for_input cannot be used as that is by definition 0 when
1689 lisp code is being evalled */
1690 static int waiting_for_user_input_p;
1691
1692 /* Read and dispose of subprocess output while waiting for timeout to
1693 elapse and/or keyboard input to be available.
1694
1695 TIME_LIMIT is:
1696 timeout in seconds, or
1697 zero for no limit, or
1698 -1 means gobble data immediately available but don't wait for any.
1699
1700 MICROSECS is:
1701 an additional duration to wait, measured in microseconds.
1702 If this is nonzero and time_limit is 0, then the timeout
1703 consists of MICROSECS only.
1704
1705 READ_KBD is a lisp value:
1706 0 to ignore keyboard input, or
1707 1 to return when input is available, or
1708 -1 meaning caller will actually read the input, so don't throw to
1709 the quit handler, or
1710 a cons cell, meaning wait until its car is non-nil
1711 (and gobble terminal input into the buffer if any arrives), or
1712 a process object, meaning wait until something arrives from that
1713 process. The return value is true iff we read some input from
1714 that process.
1715
1716 DO_DISPLAY != 0 means redisplay should be done to show subprocess
1717 output that arrives.
1718
1719 If READ_KBD is a pointer to a struct Lisp_Process, then the
1720 function returns true iff we received input from that process
1721 before the timeout elapsed.
1722 Otherwise, return true iff we received input from any process. */
1723
1724 wait_reading_process_input (time_limit, microsecs, read_kbd, do_display)
1725 int time_limit, microsecs;
1726 Lisp_Object read_kbd;
1727 int do_display;
1728 {
1729 register int channel, nfds, m;
1730 static SELECT_TYPE Available;
1731 int xerrno;
1732 Lisp_Object proc;
1733 EMACS_TIME timeout, end_time, garbage;
1734 SELECT_TYPE Atemp;
1735 int wait_channel = -1;
1736 struct Lisp_Process *wait_proc = 0;
1737 int got_some_input = 0;
1738 Lisp_Object *wait_for_cell = 0;
1739
1740 FD_ZERO (&Available);
1741
1742 /* If read_kbd is a process to watch, set wait_proc and wait_channel
1743 accordingly. */
1744 if (XTYPE (read_kbd) == Lisp_Process)
1745 {
1746 wait_proc = XPROCESS (read_kbd);
1747 wait_channel = XINT (wait_proc->infd);
1748 XFASTINT (read_kbd) = 0;
1749 }
1750
1751 /* If waiting for non-nil in a cell, record where. */
1752 if (XTYPE (read_kbd) == Lisp_Cons)
1753 {
1754 wait_for_cell = &XCONS (read_kbd)->car;
1755 XFASTINT (read_kbd) = 0;
1756 }
1757
1758 waiting_for_user_input_p = XINT (read_kbd);
1759
1760 /* Since we may need to wait several times,
1761 compute the absolute time to return at. */
1762 if (time_limit || microsecs)
1763 {
1764 EMACS_GET_TIME (end_time);
1765 EMACS_SET_SECS_USECS (timeout, time_limit, microsecs);
1766 EMACS_ADD_TIME (end_time, end_time, timeout);
1767 }
1768
1769 /* It would not be safe to call this below,
1770 where we call redisplay_preserve_echo_area. */
1771 prepare_menu_bars ();
1772
1773 while (1)
1774 {
1775 /* If calling from keyboard input, do not quit
1776 since we want to return C-g as an input character.
1777 Otherwise, do pending quit if requested. */
1778 if (XINT (read_kbd) >= 0)
1779 QUIT;
1780
1781 /* Exit now if the cell we're waiting for became non-nil. */
1782 if (wait_for_cell && ! NILP (*wait_for_cell))
1783 break;
1784
1785 /* Compute time from now till when time limit is up */
1786 /* Exit if already run out */
1787 if (time_limit == -1)
1788 {
1789 /* -1 specified for timeout means
1790 gobble output available now
1791 but don't wait at all. */
1792
1793 EMACS_SET_SECS_USECS (timeout, 0, 0);
1794 }
1795 else if (time_limit || microsecs)
1796 {
1797 EMACS_GET_TIME (timeout);
1798 EMACS_SUB_TIME (timeout, end_time, timeout);
1799 if (EMACS_TIME_NEG_P (timeout))
1800 break;
1801 }
1802 else
1803 {
1804 EMACS_SET_SECS_USECS (timeout, 100000, 0);
1805 }
1806
1807 /* Cause C-g and alarm signals to take immediate action,
1808 and cause input available signals to zero out timeout.
1809
1810 It is important that we do this before checking for process
1811 activity. If we get a SIGCHLD after the explicit checks for
1812 process activity, timeout is the only way we will know. */
1813 if (XINT (read_kbd) < 0)
1814 set_waiting_for_input (&timeout);
1815
1816 /* If status of something has changed, and no input is
1817 available, notify the user of the change right away. After
1818 this explicit check, we'll let the SIGCHLD handler zap
1819 timeout to get our attention. */
1820 if (update_tick != process_tick && do_display)
1821 {
1822 Atemp = input_wait_mask;
1823 EMACS_SET_SECS_USECS (timeout, 0, 0);
1824 if (select (MAXDESC, &Atemp, 0, 0, &timeout) <= 0)
1825 {
1826 /* It's okay for us to do this and then continue with
1827 the loop, since timeout has already been zeroed out. */
1828 clear_waiting_for_input ();
1829 status_notify ();
1830 }
1831 }
1832
1833 /* Don't wait for output from a non-running process. */
1834 if (wait_proc != 0 && !NILP (wait_proc->raw_status_low))
1835 update_status (wait_proc);
1836 if (wait_proc != 0
1837 && ! EQ (wait_proc->status, Qrun))
1838 {
1839 clear_waiting_for_input ();
1840 break;
1841 }
1842
1843 /* Wait till there is something to do */
1844
1845 Available = input_wait_mask;
1846 /* We used to have && wait_for_cell == 0
1847 but that led to lossage handling selection_request events:
1848 within one, we would start to handle another. */
1849 if (! XINT (read_kbd))
1850 FD_CLR (keyboard_descriptor, &Available);
1851
1852 /* If frame size has changed or the window is newly mapped,
1853 redisplay now, before we start to wait. There is a race
1854 condition here; if a SIGIO arrives between now and the select
1855 and indicates that a frame is trashed, the select may block
1856 displaying a trashed screen. */
1857 if (frame_garbaged && do_display)
1858 redisplay_preserve_echo_area ();
1859
1860 if (XINT (read_kbd) && detect_input_pending ())
1861 {
1862 nfds = 0;
1863 FD_ZERO (&Available);
1864 }
1865 else
1866 nfds = select (MAXDESC, &Available, 0, 0, &timeout);
1867
1868 xerrno = errno;
1869
1870 /* Make C-g and alarm signals set flags again */
1871 clear_waiting_for_input ();
1872
1873 /* If we woke up due to SIGWINCH, actually change size now. */
1874 do_pending_window_change ();
1875
1876 if (time_limit && nfds == 0) /* timeout elapsed */
1877 break;
1878 if (nfds < 0)
1879 {
1880 if (xerrno == EINTR)
1881 FD_ZERO (&Available);
1882 #ifdef ultrix
1883 /* Ultrix select seems to return ENOMEM when it is
1884 interrupted. Treat it just like EINTR. Bleah. Note
1885 that we want to test for the "ultrix" CPP symbol, not
1886 "__ultrix__"; the latter is only defined under GCC, but
1887 not by DEC's bundled CC. -JimB */
1888 else if (xerrno == ENOMEM)
1889 FD_ZERO (&Available);
1890 #endif
1891 #ifdef ALLIANT
1892 /* This happens for no known reason on ALLIANT.
1893 I am guessing that this is the right response. -- RMS. */
1894 else if (xerrno == EFAULT)
1895 FD_ZERO (&Available);
1896 #endif
1897 else if (xerrno == EBADF)
1898 {
1899 #ifdef AIX
1900 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
1901 the child's closure of the pts gives the parent a SIGHUP, and
1902 the ptc file descriptor is automatically closed,
1903 yielding EBADF here or at select() call above.
1904 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
1905 in m/ibmrt-aix.h), and here we just ignore the select error.
1906 Cleanup occurs c/o status_notify after SIGCLD. */
1907 FD_ZERO (&Available); /* Cannot depend on values returned */
1908 #else
1909 abort ();
1910 #endif
1911 }
1912 else
1913 error("select error: %s", strerror (xerrno));
1914 }
1915 #if defined(sun) && !defined(USG5_4)
1916 else if (nfds > 0 && FD_ISSET (keyboard_descriptor, &Available)
1917 && interrupt_input)
1918 /* System sometimes fails to deliver SIGIO.
1919
1920 David J. Mackenzie says that Emacs doesn't compile under
1921 Solaris if this code is enabled, thus the USG5_4 in the CPP
1922 conditional. "I haven't noticed any ill effects so far.
1923 If you find a Solaris expert somewhere, they might know
1924 better." */
1925 kill (getpid (), SIGIO);
1926 #endif
1927
1928 /* Check for keyboard input */
1929 /* If there is any, return immediately
1930 to give it higher priority than subprocesses */
1931
1932 /* We used to do this if wait_for_cell,
1933 but that caused infinite recursion in selection request events. */
1934 if ((XINT (read_kbd))
1935 && detect_input_pending ())
1936 {
1937 swallow_events ();
1938 if (detect_input_pending ())
1939 break;
1940 }
1941
1942 /* Exit now if the cell we're waiting for became non-nil. */
1943 if (wait_for_cell && ! NILP (*wait_for_cell))
1944 break;
1945
1946 #ifdef SIGIO
1947 /* If we think we have keyboard input waiting, but didn't get SIGIO
1948 go read it. This can happen with X on BSD after logging out.
1949 In that case, there really is no input and no SIGIO,
1950 but select says there is input. */
1951
1952 if (XINT (read_kbd) && interrupt_input
1953 && (FD_ISSET (keyboard_descriptor, &Available)))
1954 kill (0, SIGIO);
1955 #endif
1956
1957 if (! wait_proc)
1958 got_some_input |= nfds > 0;
1959
1960 /* If checking input just got us a size-change event from X,
1961 obey it now if we should. */
1962 if (XINT (read_kbd) || wait_for_cell)
1963 do_pending_window_change ();
1964
1965 /* Check for data from a process. */
1966 /* Really FIRST_PROC_DESC should be 0 on Unix,
1967 but this is safer in the short run. */
1968 for (channel = keyboard_descriptor == 0 ? FIRST_PROC_DESC : 0;
1969 channel < MAXDESC; channel++)
1970 {
1971 if (FD_ISSET (channel, &Available))
1972 {
1973 int nread;
1974
1975 /* If waiting for this channel, arrange to return as
1976 soon as no more input to be processed. No more
1977 waiting. */
1978 if (wait_channel == channel)
1979 {
1980 wait_channel = -1;
1981 time_limit = -1;
1982 got_some_input = 1;
1983 }
1984 proc = chan_process[channel];
1985 if (NILP (proc))
1986 continue;
1987
1988 /* Read data from the process, starting with our
1989 buffered-ahead character if we have one. */
1990
1991 nread = read_process_output (proc, channel);
1992 if (nread > 0)
1993 {
1994 /* Since read_process_output can run a filter,
1995 which can call accept-process-output,
1996 don't try to read from any other processes
1997 before doing the select again. */
1998 FD_ZERO (&Available);
1999
2000 if (do_display)
2001 redisplay_preserve_echo_area ();
2002 }
2003 #ifdef EWOULDBLOCK
2004 else if (nread == -1 && errno == EWOULDBLOCK)
2005 ;
2006 #else
2007 #ifdef O_NONBLOCK
2008 else if (nread == -1 && errno == EAGAIN)
2009 ;
2010 #else
2011 #ifdef O_NDELAY
2012 else if (nread == -1 && errno == EAGAIN)
2013 ;
2014 /* Note that we cannot distinguish between no input
2015 available now and a closed pipe.
2016 With luck, a closed pipe will be accompanied by
2017 subprocess termination and SIGCHLD. */
2018 else if (nread == 0 && !NETCONN_P (proc))
2019 ;
2020 #endif /* O_NDELAY */
2021 #endif /* O_NONBLOCK */
2022 #endif /* EWOULDBLOCK */
2023 #ifdef HAVE_PTYS
2024 /* On some OSs with ptys, when the process on one end of
2025 a pty exits, the other end gets an error reading with
2026 errno = EIO instead of getting an EOF (0 bytes read).
2027 Therefore, if we get an error reading and errno =
2028 EIO, just continue, because the child process has
2029 exited and should clean itself up soon (e.g. when we
2030 get a SIGCHLD). */
2031 else if (nread == -1 && errno == EIO)
2032 ;
2033 #endif /* HAVE_PTYS */
2034 /* If we can detect process termination, don't consider the process
2035 gone just because its pipe is closed. */
2036 #ifdef SIGCHLD
2037 else if (nread == 0 && !NETCONN_P (proc))
2038 ;
2039 #endif
2040 else
2041 {
2042 /* Preserve status of processes already terminated. */
2043 XSETINT (XPROCESS (proc)->tick, ++process_tick);
2044 deactivate_process (proc);
2045 if (!NILP (XPROCESS (proc)->raw_status_low))
2046 update_status (XPROCESS (proc));
2047 if (EQ (XPROCESS (proc)->status, Qrun))
2048 XPROCESS (proc)->status
2049 = Fcons (Qexit, Fcons (make_number (256), Qnil));
2050 }
2051 }
2052 } /* end for each file descriptor */
2053 } /* end while exit conditions not met */
2054
2055 /* If calling from keyboard input, do not quit
2056 since we want to return C-g as an input character.
2057 Otherwise, do pending quit if requested. */
2058 if (XINT (read_kbd) >= 0)
2059 {
2060 /* Prevent input_pending from remaining set if we quit. */
2061 clear_input_pending ();
2062 QUIT;
2063 }
2064
2065 return got_some_input;
2066 }
2067 \f
2068 /* Read pending output from the process channel,
2069 starting with our buffered-ahead character if we have one.
2070 Yield number of characters read.
2071
2072 This function reads at most 1024 characters.
2073 If you want to read all available subprocess output,
2074 you must call it repeatedly until it returns zero. */
2075
2076 read_process_output (proc, channel)
2077 Lisp_Object proc;
2078 register int channel;
2079 {
2080 register int nchars;
2081 #ifdef VMS
2082 char *chars;
2083 #else
2084 char chars[1024];
2085 #endif
2086 register Lisp_Object outstream;
2087 register struct buffer *old = current_buffer;
2088 register struct Lisp_Process *p = XPROCESS (proc);
2089 register int opoint;
2090
2091 #ifdef VMS
2092 VMS_PROC_STUFF *vs, *get_vms_process_pointer();
2093
2094 vs = get_vms_process_pointer (p->pid);
2095 if (vs)
2096 {
2097 if (!vs->iosb[0])
2098 return(0); /* Really weird if it does this */
2099 if (!(vs->iosb[0] & 1))
2100 return -1; /* I/O error */
2101 }
2102 else
2103 error ("Could not get VMS process pointer");
2104 chars = vs->inputBuffer;
2105 nchars = clean_vms_buffer (chars, vs->iosb[1]);
2106 if (nchars <= 0)
2107 {
2108 start_vms_process_read (vs); /* Crank up the next read on the process */
2109 return 1; /* Nothing worth printing, say we got 1 */
2110 }
2111 #else /* not VMS */
2112
2113 if (proc_buffered_char[channel] < 0)
2114 nchars = read (channel, chars, sizeof chars);
2115 else
2116 {
2117 chars[0] = proc_buffered_char[channel];
2118 proc_buffered_char[channel] = -1;
2119 nchars = read (channel, chars + 1, sizeof chars - 1);
2120 if (nchars < 0)
2121 nchars = 1;
2122 else
2123 nchars = nchars + 1;
2124 }
2125 #endif /* not VMS */
2126
2127 if (nchars <= 0) return nchars;
2128
2129 outstream = p->filter;
2130 if (!NILP (outstream))
2131 {
2132 /* We inhibit quit here instead of just catching it so that
2133 hitting ^G when a filter happens to be running won't screw
2134 it up. */
2135 int count = specpdl_ptr - specpdl;
2136 Lisp_Object odeactivate;
2137
2138 odeactivate = Vdeactivate_mark;
2139
2140 specbind (Qinhibit_quit, Qt);
2141 call2 (outstream, proc, make_string (chars, nchars));
2142
2143 /* Handling the process output should not deactivate the mark. */
2144 Vdeactivate_mark = odeactivate;
2145
2146 #ifdef VMS
2147 start_vms_process_read (vs);
2148 #endif
2149 unbind_to (count, Qnil);
2150 return nchars;
2151 }
2152
2153 /* If no filter, write into buffer if it isn't dead. */
2154 if (!NILP (p->buffer) && !NILP (XBUFFER (p->buffer)->name))
2155 {
2156 Lisp_Object old_read_only;
2157 Lisp_Object old_begv, old_zv;
2158 Lisp_Object odeactivate;
2159
2160 odeactivate = Vdeactivate_mark;
2161
2162 Fset_buffer (p->buffer);
2163 opoint = point;
2164 old_read_only = current_buffer->read_only;
2165 XFASTINT (old_begv) = BEGV;
2166 XFASTINT (old_zv) = ZV;
2167
2168 current_buffer->read_only = Qnil;
2169
2170 /* Insert new output into buffer
2171 at the current end-of-output marker,
2172 thus preserving logical ordering of input and output. */
2173 if (XMARKER (p->mark)->buffer)
2174 SET_PT (clip_to_bounds (BEGV, marker_position (p->mark), ZV));
2175 else
2176 SET_PT (ZV);
2177
2178 /* If the output marker is outside of the visible region, save
2179 the restriction and widen. */
2180 if (! (BEGV <= point && point <= ZV))
2181 Fwiden ();
2182
2183 /* Make sure opoint floats ahead of any new text, just as point
2184 would. */
2185 if (point <= opoint)
2186 opoint += nchars;
2187
2188 /* Insert after old_begv, but before old_zv. */
2189 if (point < XFASTINT (old_begv))
2190 XFASTINT (old_begv) += nchars;
2191 if (point <= XFASTINT (old_zv))
2192 XFASTINT (old_zv) += nchars;
2193
2194 /* Insert before markers in case we are inserting where
2195 the buffer's mark is, and the user's next command is Meta-y. */
2196 insert_before_markers (chars, nchars);
2197 Fset_marker (p->mark, make_number (point), p->buffer);
2198
2199 update_mode_lines++;
2200
2201 /* If the restriction isn't what it should be, set it. */
2202 if (XFASTINT (old_begv) != BEGV || XFASTINT (old_zv) != ZV)
2203 Fnarrow_to_region (old_begv, old_zv);
2204
2205 /* Handling the process output should not deactivate the mark. */
2206 Vdeactivate_mark = odeactivate;
2207
2208 current_buffer->read_only = old_read_only;
2209 SET_PT (opoint);
2210 set_buffer_internal (old);
2211 }
2212 #ifdef VMS
2213 start_vms_process_read (vs);
2214 #endif
2215 return nchars;
2216 }
2217
2218 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p, Swaiting_for_user_input_p,
2219 0, 0, 0,
2220 "Returns non-NIL if emacs is waiting for input from the user.\n\
2221 This is intended for use by asynchronous process output filters and sentinels.")
2222 ()
2223 {
2224 return ((waiting_for_user_input_p) ? Qt : Qnil);
2225 }
2226 \f
2227 /* Sending data to subprocess */
2228
2229 jmp_buf send_process_frame;
2230
2231 SIGTYPE
2232 send_process_trap ()
2233 {
2234 #ifdef BSD4_1
2235 sigrelse (SIGPIPE);
2236 sigrelse (SIGALRM);
2237 #endif /* BSD4_1 */
2238 longjmp (send_process_frame, 1);
2239 }
2240
2241 send_process (proc, buf, len)
2242 Lisp_Object proc;
2243 char *buf;
2244 int len;
2245 {
2246 /* Don't use register vars; longjmp can lose them. */
2247 int rv;
2248 unsigned char *procname = XSTRING (XPROCESS (proc)->name)->data;
2249
2250
2251 #ifdef VMS
2252 struct Lisp_Process *p = XPROCESS (proc);
2253 VMS_PROC_STUFF *vs, *get_vms_process_pointer();
2254 #endif /* VMS */
2255
2256 if (! NILP (XPROCESS (proc)->raw_status_low))
2257 update_status (XPROCESS (proc));
2258 if (! EQ (XPROCESS (proc)->status, Qrun))
2259 error ("Process %s not running", procname);
2260
2261 #ifdef VMS
2262 vs = get_vms_process_pointer (p->pid);
2263 if (vs == 0)
2264 error ("Could not find this process: %x", p->pid);
2265 else if (write_to_vms_process (vs, buf, len))
2266 ;
2267 #else
2268 if (!setjmp (send_process_frame))
2269 while (len > 0)
2270 {
2271 int this = len;
2272 SIGTYPE (*old_sigpipe)();
2273 int flush_pty = 0;
2274
2275 if (pty_max_bytes == 0)
2276 {
2277 #if defined (HAVE_FPATHCONF) && defined (_PC_MAX_CANON)
2278 pty_max_bytes = fpathconf (XFASTINT (XPROCESS (proc)->outfd),
2279 _PC_MAX_CANON);
2280 #else
2281 pty_max_bytes = 250;
2282 #endif
2283 }
2284
2285 /* Don't send more than pty_max_bytes bytes at a time. */
2286 /* Subtract 1 to leave room for the EOF. */
2287 if (this >= pty_max_bytes && XPROCESS (proc)->pty_flag != 0)
2288 this = pty_max_bytes - 1;
2289
2290 old_sigpipe = (SIGTYPE (*) ()) signal (SIGPIPE, send_process_trap);
2291 rv = write (XINT (XPROCESS (proc)->outfd), buf, this);
2292
2293 /* If we sent just part of the string, put in an EOF
2294 to force it through, before we send the rest. */
2295 if (this < len)
2296 Fprocess_send_eof (proc);
2297
2298 signal (SIGPIPE, old_sigpipe);
2299 if (rv < 0)
2300 {
2301 if (0
2302 #ifdef EWOULDBLOCK
2303 || errno == EWOULDBLOCK
2304 #endif
2305 #ifdef EAGAIN
2306 || errno == EAGAIN
2307 #endif
2308 )
2309 {
2310 /* It would be nice to accept process output here,
2311 but that is difficult. For example, it could
2312 garbage what we are sending if that is from a buffer. */
2313 immediate_quit = 1;
2314 QUIT;
2315 sleep (1);
2316 immediate_quit = 0;
2317 continue;
2318 }
2319 report_file_error ("writing to process", Fcons (proc, Qnil));
2320 }
2321 buf += rv;
2322 len -= rv;
2323 /* Allow input from processes between bursts of sending.
2324 Otherwise things may get stopped up. */
2325 if (len > 0)
2326 {
2327 Lisp_Object zero;
2328
2329 XFASTINT (zero) = 0;
2330 wait_reading_process_input (-1, 0, zero, 0);
2331 }
2332 }
2333 #endif
2334 else
2335 {
2336 XPROCESS (proc)->raw_status_low = Qnil;
2337 XPROCESS (proc)->raw_status_high = Qnil;
2338 XPROCESS (proc)->status = Fcons (Qexit, Fcons (make_number (256), Qnil));
2339 XSETINT (XPROCESS (proc)->tick, ++process_tick);
2340 deactivate_process (proc);
2341 #ifdef VMS
2342 error ("Error writing to process %s; closed it", procname);
2343 #else
2344 error ("SIGPIPE raised on process %s; closed it", procname);
2345 #endif
2346 }
2347 }
2348
2349 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
2350 3, 3, 0,
2351 "Send current contents of region as input to PROCESS.\n\
2352 PROCESS may be a process, a buffer, the name of a process or buffer, or\n\
2353 nil, indicating the current buffer's process.\n\
2354 Called from program, takes three arguments, PROCESS, START and END.\n\
2355 If the region is more than 500 characters long,\n\
2356 it is sent in several bunches. This may happen even for shorter regions.\n\
2357 Output from processes can arrive in between bunches.")
2358 (process, start, end)
2359 Lisp_Object process, start, end;
2360 {
2361 Lisp_Object proc;
2362 int start1;
2363
2364 proc = get_process (process);
2365 validate_region (&start, &end);
2366
2367 if (XINT (start) < GPT && XINT (end) > GPT)
2368 move_gap (start);
2369
2370 start1 = XINT (start);
2371 send_process (proc, &FETCH_CHAR (start1), XINT (end) - XINT (start));
2372
2373 return Qnil;
2374 }
2375
2376 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
2377 2, 2, 0,
2378 "Send PROCESS the contents of STRING as input.\n\
2379 PROCESS may be a process, a buffer, the name of a process or buffer, or\n\
2380 nil, indicating the current buffer's process.\n\
2381 If STRING is more than 500 characters long,\n\
2382 it is sent in several bunches. This may happen even for shorter strings.\n\
2383 Output from processes can arrive in between bunches.")
2384 (process, string)
2385 Lisp_Object process, string;
2386 {
2387 Lisp_Object proc;
2388 CHECK_STRING (string, 1);
2389 proc = get_process (process);
2390 send_process (proc, XSTRING (string)->data, XSTRING (string)->size);
2391 return Qnil;
2392 }
2393 \f
2394 /* send a signal number SIGNO to PROCESS.
2395 CURRENT_GROUP means send to the process group that currently owns
2396 the terminal being used to communicate with PROCESS.
2397 This is used for various commands in shell mode.
2398 If NOMSG is zero, insert signal-announcements into process's buffers
2399 right away.
2400
2401 If we can, we try to signal PROCESS by sending control characters
2402 down the pipe. This allows us to signal inferiors who have changed
2403 their uid, for which killpg would return an EPERM error. */
2404
2405 static void
2406 process_send_signal (process, signo, current_group, nomsg)
2407 Lisp_Object process;
2408 int signo;
2409 Lisp_Object current_group;
2410 int nomsg;
2411 {
2412 Lisp_Object proc;
2413 register struct Lisp_Process *p;
2414 int gid;
2415 int no_pgrp = 0;
2416
2417 proc = get_process (process);
2418 p = XPROCESS (proc);
2419
2420 if (!EQ (p->childp, Qt))
2421 error ("Process %s is not a subprocess",
2422 XSTRING (p->name)->data);
2423 if (XINT (p->infd) < 0)
2424 error ("Process %s is not active",
2425 XSTRING (p->name)->data);
2426
2427 if (NILP (p->pty_flag))
2428 current_group = Qnil;
2429
2430 /* If we are using pgrps, get a pgrp number and make it negative. */
2431 if (!NILP (current_group))
2432 {
2433 #ifdef SIGNALS_VIA_CHARACTERS
2434 /* If possible, send signals to the entire pgrp
2435 by sending an input character to it. */
2436
2437 /* TERMIOS is the latest and bestest, and seems most likely to
2438 work. If the system has it, use it. */
2439 #ifdef HAVE_TERMIOS
2440 struct termios t;
2441
2442 switch (signo)
2443 {
2444 case SIGINT:
2445 tcgetattr (XINT (p->infd), &t);
2446 send_process (proc, &t.c_cc[VINTR], 1);
2447 return;
2448
2449 case SIGQUIT:
2450 tcgetattr (XINT (p->infd), &t);
2451 send_process (proc, &t.c_cc[VQUIT], 1);
2452 return;
2453
2454 case SIGTSTP:
2455 tcgetattr (XINT (p->infd), &t);
2456 #if defined (VSWTCH) && !defined (IRIX5)
2457 send_process (proc, &t.c_cc[VSWTCH], 1);
2458 #else
2459 send_process (proc, &t.c_cc[VSUSP], 1);
2460 #endif
2461 return;
2462 }
2463
2464 #else /* ! HAVE_TERMIOS */
2465
2466 /* On Berkeley descendants, the following IOCTL's retrieve the
2467 current control characters. */
2468 #if defined (TIOCGLTC) && defined (TIOCGETC)
2469
2470 struct tchars c;
2471 struct ltchars lc;
2472
2473 switch (signo)
2474 {
2475 case SIGINT:
2476 ioctl (XINT (p->infd), TIOCGETC, &c);
2477 send_process (proc, &c.t_intrc, 1);
2478 return;
2479 case SIGQUIT:
2480 ioctl (XINT (p->infd), TIOCGETC, &c);
2481 send_process (proc, &c.t_quitc, 1);
2482 return;
2483 #ifdef SIGTSTP
2484 case SIGTSTP:
2485 ioctl (XINT (p->infd), TIOCGLTC, &lc);
2486 send_process (proc, &lc.t_suspc, 1);
2487 return;
2488 #endif /* ! defined (SIGTSTP) */
2489 }
2490
2491 #else /* ! defined (TIOCGLTC) && defined (TIOCGETC) */
2492
2493 /* On SYSV descendants, the TCGETA ioctl retrieves the current control
2494 characters. */
2495 #ifdef TCGETA
2496 struct termio t;
2497 switch (signo)
2498 {
2499 case SIGINT:
2500 ioctl (XINT (p->infd), TCGETA, &t);
2501 send_process (proc, &t.c_cc[VINTR], 1);
2502 return;
2503 case SIGQUIT:
2504 ioctl (XINT (p->infd), TCGETA, &t);
2505 send_process (proc, &t.c_cc[VQUIT], 1);
2506 return;
2507 #ifdef SIGTSTP
2508 case SIGTSTP:
2509 ioctl (XINT (p->infd), TCGETA, &t);
2510 send_process (proc, &t.c_cc[VSWTCH], 1);
2511 return;
2512 #endif /* ! defined (SIGTSTP) */
2513 }
2514 #else /* ! defined (TCGETA) */
2515 Your configuration files are messed up.
2516 /* If your system configuration files define SIGNALS_VIA_CHARACTERS,
2517 you'd better be using one of the alternatives above! */
2518 #endif /* ! defined (TCGETA) */
2519 #endif /* ! defined (TIOCGLTC) && defined (TIOCGETC) */
2520 #endif /* ! defined HAVE_TERMIOS */
2521 #endif /* ! defined (SIGNALS_VIA_CHARACTERS) */
2522
2523 #ifdef TIOCGPGRP
2524 /* Get the pgrp using the tty itself, if we have that.
2525 Otherwise, use the pty to get the pgrp.
2526 On pfa systems, saka@pfu.fujitsu.co.JP writes:
2527 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
2528 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
2529 His patch indicates that if TIOCGPGRP returns an error, then
2530 we should just assume that p->pid is also the process group id. */
2531 {
2532 int err;
2533
2534 if (!NILP (p->subtty))
2535 err = ioctl (XFASTINT (p->subtty), TIOCGPGRP, &gid);
2536 else
2537 err = ioctl (XINT (p->infd), TIOCGPGRP, &gid);
2538
2539 #ifdef pfa
2540 if (err == -1)
2541 gid = - XFASTINT (p->pid);
2542 #endif /* ! defined (pfa) */
2543 }
2544 if (gid == -1)
2545 no_pgrp = 1;
2546 else
2547 gid = - gid;
2548 #else /* ! defined (TIOCGPGRP ) */
2549 /* Can't select pgrps on this system, so we know that
2550 the child itself heads the pgrp. */
2551 gid = - XFASTINT (p->pid);
2552 #endif /* ! defined (TIOCGPGRP ) */
2553 }
2554 else
2555 gid = - XFASTINT (p->pid);
2556
2557 switch (signo)
2558 {
2559 #ifdef SIGCONT
2560 case SIGCONT:
2561 p->raw_status_low = Qnil;
2562 p->raw_status_high = Qnil;
2563 p->status = Qrun;
2564 XSETINT (p->tick, ++process_tick);
2565 if (!nomsg)
2566 status_notify ();
2567 break;
2568 #endif /* ! defined (SIGCONT) */
2569 case SIGINT:
2570 #ifdef VMS
2571 send_process (proc, "\003", 1); /* ^C */
2572 goto whoosh;
2573 #endif
2574 case SIGQUIT:
2575 #ifdef VMS
2576 send_process (proc, "\031", 1); /* ^Y */
2577 goto whoosh;
2578 #endif
2579 case SIGKILL:
2580 #ifdef VMS
2581 sys$forcex (&(XFASTINT (p->pid)), 0, 1);
2582 whoosh:
2583 #endif
2584 flush_pending_output (XINT (p->infd));
2585 break;
2586 }
2587
2588 /* If we don't have process groups, send the signal to the immediate
2589 subprocess. That isn't really right, but it's better than any
2590 obvious alternative. */
2591 if (no_pgrp)
2592 {
2593 kill (XFASTINT (p->pid), signo);
2594 return;
2595 }
2596
2597 /* gid may be a pid, or minus a pgrp's number */
2598 #ifdef TIOCSIGSEND
2599 if (!NILP (current_group))
2600 ioctl (XINT (p->infd), TIOCSIGSEND, signo);
2601 else
2602 {
2603 gid = - XFASTINT (p->pid);
2604 kill (gid, signo);
2605 }
2606 #else /* ! defined (TIOCSIGSEND) */
2607 EMACS_KILLPG (-gid, signo);
2608 #endif /* ! defined (TIOCSIGSEND) */
2609 }
2610
2611 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
2612 "Interrupt process PROCESS. May be process or name of one.\n\
2613 PROCESS may be a process, a buffer, or the name of a process or buffer.\n\
2614 Nil or no arg means current buffer's process.\n\
2615 Second arg CURRENT-GROUP non-nil means send signal to\n\
2616 the current process-group of the process's controlling terminal\n\
2617 rather than to the process's own process group.\n\
2618 If the process is a shell, this means interrupt current subjob\n\
2619 rather than the shell.")
2620 (process, current_group)
2621 Lisp_Object process, current_group;
2622 {
2623 process_send_signal (process, SIGINT, current_group, 0);
2624 return process;
2625 }
2626
2627 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
2628 "Kill process PROCESS. May be process or name of one.\n\
2629 See function `interrupt-process' for more details on usage.")
2630 (process, current_group)
2631 Lisp_Object process, current_group;
2632 {
2633 process_send_signal (process, SIGKILL, current_group, 0);
2634 return process;
2635 }
2636
2637 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
2638 "Send QUIT signal to process PROCESS. May be process or name of one.\n\
2639 See function `interrupt-process' for more details on usage.")
2640 (process, current_group)
2641 Lisp_Object process, current_group;
2642 {
2643 process_send_signal (process, SIGQUIT, current_group, 0);
2644 return process;
2645 }
2646
2647 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
2648 "Stop process PROCESS. May be process or name of one.\n\
2649 See function `interrupt-process' for more details on usage.")
2650 (process, current_group)
2651 Lisp_Object process, current_group;
2652 {
2653 #ifndef SIGTSTP
2654 error ("no SIGTSTP support");
2655 #else
2656 process_send_signal (process, SIGTSTP, current_group, 0);
2657 #endif
2658 return process;
2659 }
2660
2661 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
2662 "Continue process PROCESS. May be process or name of one.\n\
2663 See function `interrupt-process' for more details on usage.")
2664 (process, current_group)
2665 Lisp_Object process, current_group;
2666 {
2667 #ifdef SIGCONT
2668 process_send_signal (process, SIGCONT, current_group, 0);
2669 #else
2670 error ("no SIGCONT support");
2671 #endif
2672 return process;
2673 }
2674
2675 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
2676 2, 2, "nProcess number: \nnSignal code: ",
2677 "Send the process with number PID the signal with code CODE.\n\
2678 Both PID and CODE are integers.")
2679 (pid, sig)
2680 Lisp_Object pid, sig;
2681 {
2682 CHECK_NUMBER (pid, 0);
2683 CHECK_NUMBER (sig, 1);
2684 return make_number (kill (XINT (pid), XINT (sig)));
2685 }
2686
2687 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
2688 "Make PROCESS see end-of-file in its input.\n\
2689 Eof comes after any text already sent to it.\n\
2690 PROCESS may be a process, a buffer, the name of a process or buffer, or\n\
2691 nil, indicating the current buffer's process.")
2692 (process)
2693 Lisp_Object process;
2694 {
2695 Lisp_Object proc;
2696
2697 proc = get_process (process);
2698
2699 /* Make sure the process is really alive. */
2700 if (! NILP (XPROCESS (proc)->raw_status_low))
2701 update_status (XPROCESS (proc));
2702 if (! EQ (XPROCESS (proc)->status, Qrun))
2703 error ("Process %s not running", XSTRING (XPROCESS (proc)->name)->data);
2704
2705 /* Sending a zero-length record is supposed to mean eof
2706 when TIOCREMOTE is turned on. */
2707 #ifdef DID_REMOTE
2708 {
2709 char buf[1];
2710 write (XINT (XPROCESS (proc)->outfd), buf, 0);
2711 }
2712 #else /* did not do TOICREMOTE */
2713 #ifdef VMS
2714 send_process (proc, "\032", 1); /* ^z */
2715 #else
2716 if (!NILP (XPROCESS (proc)->pty_flag))
2717 send_process (proc, "\004", 1);
2718 else
2719 {
2720 close (XINT (XPROCESS (proc)->outfd));
2721 XSET (XPROCESS (proc)->outfd, Lisp_Int, open (NULL_DEVICE, O_WRONLY));
2722 }
2723 #endif /* VMS */
2724 #endif /* did not do TOICREMOTE */
2725 return process;
2726 }
2727
2728 /* Kill all processes associated with `buffer'.
2729 If `buffer' is nil, kill all processes */
2730
2731 kill_buffer_processes (buffer)
2732 Lisp_Object buffer;
2733 {
2734 Lisp_Object tail, proc;
2735
2736 for (tail = Vprocess_alist; XGCTYPE (tail) == Lisp_Cons;
2737 tail = XCONS (tail)->cdr)
2738 {
2739 proc = XCONS (XCONS (tail)->car)->cdr;
2740 if (XGCTYPE (proc) == Lisp_Process
2741 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
2742 {
2743 if (NETCONN_P (proc))
2744 deactivate_process (proc);
2745 else if (XINT (XPROCESS (proc)->infd) >= 0)
2746 process_send_signal (proc, SIGHUP, Qnil, 1);
2747 }
2748 }
2749 }
2750 \f
2751 /* On receipt of a signal that a child status has changed,
2752 loop asking about children with changed statuses until
2753 the system says there are no more.
2754 All we do is change the status;
2755 we do not run sentinels or print notifications.
2756 That is saved for the next time keyboard input is done,
2757 in order to avoid timing errors. */
2758
2759 /** WARNING: this can be called during garbage collection.
2760 Therefore, it must not be fooled by the presence of mark bits in
2761 Lisp objects. */
2762
2763 /** USG WARNING: Although it is not obvious from the documentation
2764 in signal(2), on a USG system the SIGCLD handler MUST NOT call
2765 signal() before executing at least one wait(), otherwise the handler
2766 will be called again, resulting in an infinite loop. The relevant
2767 portion of the documentation reads "SIGCLD signals will be queued
2768 and the signal-catching function will be continually reentered until
2769 the queue is empty". Invoking signal() causes the kernel to reexamine
2770 the SIGCLD queue. Fred Fish, UniSoft Systems Inc. */
2771
2772 SIGTYPE
2773 sigchld_handler (signo)
2774 int signo;
2775 {
2776 int old_errno = errno;
2777 Lisp_Object proc;
2778 register struct Lisp_Process *p;
2779 extern EMACS_TIME *input_available_clear_time;
2780
2781 #ifdef BSD4_1
2782 extern int sigheld;
2783 sigheld |= sigbit (SIGCHLD);
2784 #endif
2785
2786 while (1)
2787 {
2788 register int pid;
2789 WAITTYPE w;
2790 Lisp_Object tail;
2791
2792 #ifdef WNOHANG
2793 #ifndef WUNTRACED
2794 #define WUNTRACED 0
2795 #endif /* no WUNTRACED */
2796 /* Keep trying to get a status until we get a definitive result. */
2797 do
2798 {
2799 errno = 0;
2800 pid = wait3 (&w, WNOHANG | WUNTRACED, 0);
2801 }
2802 while (pid <= 0 && errno == EINTR);
2803
2804 if (pid <= 0)
2805 {
2806 /* A real failure. We have done all our job, so return. */
2807
2808 /* USG systems forget handlers when they are used;
2809 must reestablish each time */
2810 #ifdef USG
2811 signal (signo, sigchld_handler); /* WARNING - must come after wait3() */
2812 #endif
2813 #ifdef BSD4_1
2814 sigheld &= ~sigbit (SIGCHLD);
2815 sigrelse (SIGCHLD);
2816 #endif
2817 errno = old_errno;
2818 return;
2819 }
2820 #else
2821 pid = wait (&w);
2822 #endif /* no WNOHANG */
2823
2824 /* Find the process that signaled us, and record its status. */
2825
2826 p = 0;
2827 for (tail = Vprocess_alist; XSYMBOL (tail) != XSYMBOL (Qnil); tail = XCONS (tail)->cdr)
2828 {
2829 proc = XCONS (XCONS (tail)->car)->cdr;
2830 p = XPROCESS (proc);
2831 if (EQ (p->childp, Qt) && XFASTINT (p->pid) == pid)
2832 break;
2833 p = 0;
2834 }
2835
2836 /* Look for an asynchronous process whose pid hasn't been filled
2837 in yet. */
2838 if (p == 0)
2839 for (tail = Vprocess_alist; XSYMBOL (tail) != XSYMBOL (Qnil); tail = XCONS (tail)->cdr)
2840 {
2841 proc = XCONS (XCONS (tail)->car)->cdr;
2842 p = XPROCESS (proc);
2843 if (XTYPE (p->pid) == Lisp_Int && XINT (p->pid) == -1)
2844 break;
2845 p = 0;
2846 }
2847
2848 /* Change the status of the process that was found. */
2849 if (p != 0)
2850 {
2851 union { int i; WAITTYPE wt; } u;
2852
2853 XSETINT (p->tick, ++process_tick);
2854 u.wt = w;
2855 XFASTINT (p->raw_status_low) = u.i & 0xffff;
2856 XFASTINT (p->raw_status_high) = u.i >> 16;
2857
2858 /* If process has terminated, stop waiting for its output. */
2859 if (WIFSIGNALED (w) || WIFEXITED (w))
2860 if (XINT (p->infd) >= 0)
2861 FD_CLR (XINT (p->infd), &input_wait_mask);
2862
2863 /* Tell wait_reading_process_input that it needs to wake up and
2864 look around. */
2865 if (input_available_clear_time)
2866 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
2867 }
2868
2869 /* There was no asynchronous process found for that id. Check
2870 if we have a synchronous process. */
2871 else
2872 {
2873 synch_process_alive = 0;
2874
2875 /* Report the status of the synchronous process. */
2876 if (WIFEXITED (w))
2877 synch_process_retcode = WRETCODE (w);
2878 else if (WIFSIGNALED (w))
2879 {
2880 int code = WTERMSIG (w);
2881 char *signame = 0;
2882
2883 if (code < NSIG)
2884 {
2885 #ifndef VMS
2886 signame = sys_siglist[code];
2887 #else
2888 signame = sys_errlist[code];
2889 #endif
2890 }
2891 if (signame == 0)
2892 signame = "unknown";
2893
2894 synch_process_death = signame;
2895 }
2896
2897 /* Tell wait_reading_process_input that it needs to wake up and
2898 look around. */
2899 if (input_available_clear_time)
2900 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
2901 }
2902
2903 /* On some systems, we must return right away.
2904 If any more processes want to signal us, we will
2905 get another signal.
2906 Otherwise (on systems that have WNOHANG), loop around
2907 to use up all the processes that have something to tell us. */
2908 #if defined (USG) && ! (defined (HPUX) && defined (WNOHANG))
2909 #ifdef USG
2910 signal (signo, sigchld_handler);
2911 #endif
2912 errno = old_errno;
2913 return;
2914 #endif /* USG, but not HPUX with WNOHANG */
2915 }
2916 }
2917 \f
2918
2919 static Lisp_Object
2920 exec_sentinel_unwind (data)
2921 Lisp_Object data;
2922 {
2923 XPROCESS (XCONS (data)->car)->sentinel = XCONS (data)->cdr;
2924 return Qnil;
2925 }
2926
2927 static void
2928 exec_sentinel (proc, reason)
2929 Lisp_Object proc, reason;
2930 {
2931 Lisp_Object sentinel;
2932 register struct Lisp_Process *p = XPROCESS (proc);
2933 int count = specpdl_ptr - specpdl;
2934
2935 sentinel = p->sentinel;
2936 if (NILP (sentinel))
2937 return;
2938
2939 /* Zilch the sentinel while it's running, to avoid recursive invocations;
2940 assure that it gets restored no matter how the sentinel exits. */
2941 p->sentinel = Qnil;
2942 record_unwind_protect (exec_sentinel_unwind, Fcons (proc, sentinel));
2943 /* Inhibit quit so that random quits don't screw up a running filter. */
2944 specbind (Qinhibit_quit, Qt);
2945 call2 (sentinel, proc, reason);
2946 unbind_to (count, Qnil);
2947 }
2948
2949 /* Report all recent events of a change in process status
2950 (either run the sentinel or output a message).
2951 This is done while Emacs is waiting for keyboard input. */
2952
2953 status_notify ()
2954 {
2955 register Lisp_Object proc, buffer;
2956 Lisp_Object tail, msg;
2957 struct gcpro gcpro1, gcpro2;
2958
2959 tail = Qnil;
2960 msg = Qnil;
2961 /* We need to gcpro tail; if read_process_output calls a filter
2962 which deletes a process and removes the cons to which tail points
2963 from Vprocess_alist, and then causes a GC, tail is an unprotected
2964 reference. */
2965 GCPRO2 (tail, msg);
2966
2967 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
2968 {
2969 Lisp_Object symbol;
2970 register struct Lisp_Process *p;
2971
2972 proc = Fcdr (Fcar (tail));
2973 p = XPROCESS (proc);
2974
2975 if (XINT (p->tick) != XINT (p->update_tick))
2976 {
2977 XSETINT (p->update_tick, XINT (p->tick));
2978
2979 /* If process is still active, read any output that remains. */
2980 if (XINT (p->infd) >= 0)
2981 while (! EQ (p->filter, Qt)
2982 && read_process_output (proc, XINT (p->infd)) > 0);
2983
2984 buffer = p->buffer;
2985
2986 /* Get the text to use for the message. */
2987 if (!NILP (p->raw_status_low))
2988 update_status (p);
2989 msg = status_message (p->status);
2990
2991 /* If process is terminated, deactivate it or delete it. */
2992 symbol = p->status;
2993 if (XTYPE (p->status) == Lisp_Cons)
2994 symbol = XCONS (p->status)->car;
2995
2996 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
2997 || EQ (symbol, Qclosed))
2998 {
2999 if (delete_exited_processes)
3000 remove_process (proc);
3001 else
3002 deactivate_process (proc);
3003 }
3004
3005 /* Now output the message suitably. */
3006 if (!NILP (p->sentinel))
3007 exec_sentinel (proc, msg);
3008 /* Don't bother with a message in the buffer
3009 when a process becomes runnable. */
3010 else if (!EQ (symbol, Qrun) && !NILP (buffer))
3011 {
3012 Lisp_Object ro, tem;
3013 struct buffer *old = current_buffer;
3014 int opoint;
3015
3016 ro = XBUFFER (buffer)->read_only;
3017
3018 /* Avoid error if buffer is deleted
3019 (probably that's why the process is dead, too) */
3020 if (NILP (XBUFFER (buffer)->name))
3021 continue;
3022 Fset_buffer (buffer);
3023 opoint = point;
3024 /* Insert new output into buffer
3025 at the current end-of-output marker,
3026 thus preserving logical ordering of input and output. */
3027 if (XMARKER (p->mark)->buffer)
3028 SET_PT (marker_position (p->mark));
3029 else
3030 SET_PT (ZV);
3031 if (point <= opoint)
3032 opoint += XSTRING (msg)->size + XSTRING (p->name)->size + 10;
3033
3034 tem = current_buffer->read_only;
3035 current_buffer->read_only = Qnil;
3036 insert_string ("\nProcess ");
3037 Finsert (1, &p->name);
3038 insert_string (" ");
3039 Finsert (1, &msg);
3040 current_buffer->read_only = tem;
3041 Fset_marker (p->mark, make_number (point), p->buffer);
3042
3043 SET_PT (opoint);
3044 set_buffer_internal (old);
3045 }
3046 }
3047 } /* end for */
3048
3049 update_mode_lines++; /* in case buffers use %s in mode-line-format */
3050 redisplay_preserve_echo_area ();
3051
3052 update_tick = process_tick;
3053
3054 UNGCPRO;
3055 }
3056 \f
3057 init_process ()
3058 {
3059 register int i;
3060
3061 #ifdef SIGCHLD
3062 #ifndef CANNOT_DUMP
3063 if (! noninteractive || initialized)
3064 #endif
3065 signal (SIGCHLD, sigchld_handler);
3066 #endif
3067
3068 FD_ZERO (&input_wait_mask);
3069
3070 keyboard_descriptor = 0;
3071 FD_SET (keyboard_descriptor, &input_wait_mask);
3072
3073 Vprocess_alist = Qnil;
3074 for (i = 0; i < MAXDESC; i++)
3075 {
3076 chan_process[i] = Qnil;
3077 proc_buffered_char[i] = -1;
3078 }
3079 }
3080
3081 /* From now on, assume keyboard input comes from descriptor DESC. */
3082
3083 void
3084 change_keyboard_wait_descriptor (desc)
3085 int desc;
3086 {
3087 FD_CLR (keyboard_descriptor, &input_wait_mask);
3088 keyboard_descriptor = desc;
3089 FD_SET (keyboard_descriptor, &input_wait_mask);
3090 }
3091
3092 syms_of_process ()
3093 {
3094 #ifdef HAVE_SOCKETS
3095 stream_process = intern ("stream");
3096 #endif
3097 Qprocessp = intern ("processp");
3098 staticpro (&Qprocessp);
3099 Qrun = intern ("run");
3100 staticpro (&Qrun);
3101 Qstop = intern ("stop");
3102 staticpro (&Qstop);
3103 Qsignal = intern ("signal");
3104 staticpro (&Qsignal);
3105
3106 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
3107 here again.
3108
3109 Qexit = intern ("exit");
3110 staticpro (&Qexit); */
3111
3112 Qopen = intern ("open");
3113 staticpro (&Qopen);
3114 Qclosed = intern ("closed");
3115 staticpro (&Qclosed);
3116
3117 staticpro (&Vprocess_alist);
3118
3119 DEFVAR_BOOL ("delete-exited-processes", &delete_exited_processes,
3120 "*Non-nil means delete processes immediately when they exit.\n\
3121 nil means don't delete them until `list-processes' is run.");
3122
3123 delete_exited_processes = 1;
3124
3125 DEFVAR_LISP ("process-connection-type", &Vprocess_connection_type,
3126 "Control type of device used to communicate with subprocesses.\n\
3127 Values are nil to use a pipe, and t or 'pty for a pty. Note that if\n\
3128 pty's are not available, this variable will be ignored. The value takes\n\
3129 effect when `start-process' is called.");
3130 Vprocess_connection_type = Qt;
3131
3132 defsubr (&Sprocessp);
3133 defsubr (&Sget_process);
3134 defsubr (&Sget_buffer_process);
3135 defsubr (&Sdelete_process);
3136 defsubr (&Sprocess_status);
3137 defsubr (&Sprocess_exit_status);
3138 defsubr (&Sprocess_id);
3139 defsubr (&Sprocess_name);
3140 defsubr (&Sprocess_command);
3141 defsubr (&Sset_process_buffer);
3142 defsubr (&Sprocess_buffer);
3143 defsubr (&Sprocess_mark);
3144 defsubr (&Sset_process_filter);
3145 defsubr (&Sprocess_filter);
3146 defsubr (&Sset_process_sentinel);
3147 defsubr (&Sprocess_sentinel);
3148 defsubr (&Sprocess_kill_without_query);
3149 defsubr (&Slist_processes);
3150 defsubr (&Sprocess_list);
3151 defsubr (&Sstart_process);
3152 #ifdef HAVE_SOCKETS
3153 defsubr (&Sopen_network_stream);
3154 #endif /* HAVE_SOCKETS */
3155 defsubr (&Saccept_process_output);
3156 defsubr (&Sprocess_send_region);
3157 defsubr (&Sprocess_send_string);
3158 defsubr (&Sinterrupt_process);
3159 defsubr (&Skill_process);
3160 defsubr (&Squit_process);
3161 defsubr (&Sstop_process);
3162 defsubr (&Scontinue_process);
3163 defsubr (&Sprocess_send_eof);
3164 defsubr (&Ssignal_process);
3165 defsubr (&Swaiting_for_user_input_p);
3166 /* defsubr (&Sprocess_connection); */
3167 }
3168
3169 \f
3170 #else /* not subprocesses */
3171
3172 #include <sys/types.h>
3173 #include <errno.h>
3174
3175 #include "lisp.h"
3176 #include "systime.h"
3177 #include "termopts.h"
3178
3179 extern int frame_garbaged;
3180
3181
3182 /* As described above, except assuming that there are no subprocesses:
3183
3184 Wait for timeout to elapse and/or keyboard input to be available.
3185
3186 time_limit is:
3187 timeout in seconds, or
3188 zero for no limit, or
3189 -1 means gobble data immediately available but don't wait for any.
3190
3191 read_kbd is a Lisp_Object:
3192 0 to ignore keyboard input, or
3193 1 to return when input is available, or
3194 -1 means caller will actually read the input, so don't throw to
3195 the quit handler.
3196 We know that read_kbd will never be a Lisp_Process, since
3197 `subprocesses' isn't defined.
3198
3199 do_display != 0 means redisplay should be done to show subprocess
3200 output that arrives.
3201
3202 Return true iff we received input from any process. */
3203
3204 int
3205 wait_reading_process_input (time_limit, microsecs, read_kbd, do_display)
3206 int time_limit, microsecs;
3207 Lisp_Object read_kbd;
3208 int do_display;
3209 {
3210 EMACS_TIME end_time, timeout, *timeout_p;
3211 int waitchannels;
3212
3213 /* What does time_limit really mean? */
3214 if (time_limit || microsecs)
3215 {
3216 /* It's not infinite. */
3217 timeout_p = &timeout;
3218
3219 if (time_limit == -1)
3220 /* In fact, it's zero. */
3221 EMACS_SET_SECS_USECS (timeout, 0, 0);
3222 else
3223 EMACS_SET_SECS_USECS (timeout, time_limit, microsecs);
3224
3225 /* How far in the future is that? */
3226 EMACS_GET_TIME (end_time);
3227 EMACS_ADD_TIME (end_time, end_time, timeout);
3228 }
3229 else
3230 /* It's infinite. */
3231 timeout_p = 0;
3232
3233 /* This must come before stop_polling. */
3234 prepare_menu_bars ();
3235
3236 /* Turn off periodic alarms (in case they are in use)
3237 because the select emulator uses alarms. */
3238 stop_polling ();
3239
3240 for (;;)
3241 {
3242 int nfds;
3243
3244 waitchannels = XINT (read_kbd) ? 1 : 0;
3245
3246 /* If calling from keyboard input, do not quit
3247 since we want to return C-g as an input character.
3248 Otherwise, do pending quit if requested. */
3249 if (XINT (read_kbd) >= 0)
3250 QUIT;
3251
3252 if (timeout_p)
3253 {
3254 EMACS_GET_TIME (*timeout_p);
3255 EMACS_SUB_TIME (*timeout_p, end_time, *timeout_p);
3256 if (EMACS_TIME_NEG_P (*timeout_p))
3257 break;
3258 }
3259
3260 /* Cause C-g and alarm signals to take immediate action,
3261 and cause input available signals to zero out timeout. */
3262 if (XINT (read_kbd) < 0)
3263 set_waiting_for_input (&timeout);
3264
3265 /* If a frame has been newly mapped and needs updating,
3266 reprocess its display stuff. */
3267 if (frame_garbaged && do_display)
3268 redisplay_preserve_echo_area ();
3269
3270 if (XINT (read_kbd) && detect_input_pending ())
3271 nfds = 0;
3272 else
3273 nfds = select (1, &waitchannels, 0, 0, timeout_p);
3274
3275 /* Make C-g and alarm signals set flags again */
3276 clear_waiting_for_input ();
3277
3278 /* If we woke up due to SIGWINCH, actually change size now. */
3279 do_pending_window_change ();
3280
3281 if (nfds == -1)
3282 {
3283 /* If the system call was interrupted, then go around the
3284 loop again. */
3285 if (errno == EINTR)
3286 waitchannels = 0;
3287 }
3288 #ifdef sun
3289 else if (nfds > 0 && (waitchannels & 1) && interrupt_input)
3290 /* System sometimes fails to deliver SIGIO. */
3291 kill (getpid (), SIGIO);
3292 #endif
3293 #ifdef SIGIO
3294 if (XINT (read_kbd) && interrupt_input && (waitchannels & 1))
3295 kill (0, SIGIO);
3296 #endif
3297
3298 /* If we have timed out (nfds == 0) or found some input (nfds > 0),
3299 we should exit. */
3300 if (nfds >= 0)
3301 break;
3302 }
3303
3304 start_polling ();
3305
3306 return 0;
3307 }
3308
3309
3310 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
3311 /* Don't confuse make-docfile by having two doc strings for this function.
3312 make-docfile does not pay attention to #if, for good reason! */
3313 0)
3314 (name)
3315 register Lisp_Object name;
3316 {
3317 return Qnil;
3318 }
3319
3320 /* Kill all processes associated with `buffer'.
3321 If `buffer' is nil, kill all processes.
3322 Since we have no subprocesses, this does nothing. */
3323
3324 kill_buffer_processes (buffer)
3325 Lisp_Object buffer;
3326 {
3327 }
3328
3329 init_process ()
3330 {
3331 }
3332
3333 syms_of_process ()
3334 {
3335 defsubr (&Sget_buffer_process);
3336 }
3337
3338 \f
3339 #endif /* not subprocesses */