Remove * in defcustom docstrings.
[emacs.git] / src / process.c
blobb24dee002c64eaef236eebff8a56e62d42d9532e
1 /* Asynchronous subprocess control for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1996, 1998, 1999, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
24 #include <config.h>
25 #include <signal.h>
27 /* This file is split into two parts by the following preprocessor
28 conditional. The 'then' clause contains all of the support for
29 asynchronous subprocesses. The 'else' clause contains stub
30 versions of some of the asynchronous subprocess routines that are
31 often called elsewhere in Emacs, so we don't have to #ifdef the
32 sections that call them. */
35 #ifdef subprocesses
37 #include <stdio.h>
38 #include <errno.h>
39 #include <setjmp.h>
40 #include <sys/types.h> /* some typedefs are used in sys/file.h */
41 #include <sys/file.h>
42 #include <sys/stat.h>
43 #ifdef HAVE_INTTYPES_H
44 #include <inttypes.h>
45 #endif
46 #ifdef HAVE_UNISTD_H
47 #include <unistd.h>
48 #endif
50 #if defined(WINDOWSNT) || defined(UNIX98_PTYS)
51 #include <stdlib.h>
52 #include <fcntl.h>
53 #endif /* not WINDOWSNT */
55 #ifdef HAVE_SOCKETS /* TCP connection support, if kernel can do it */
56 #include <sys/socket.h>
57 #include <netdb.h>
58 #include <netinet/in.h>
59 #include <arpa/inet.h>
60 #ifdef NEED_NET_ERRNO_H
61 #include <net/errno.h>
62 #endif /* NEED_NET_ERRNO_H */
64 /* Are local (unix) sockets supported? */
65 #if defined (HAVE_SYS_UN_H) && !defined (NO_SOCKETS_IN_FILE_SYSTEM)
66 #if !defined (AF_LOCAL) && defined (AF_UNIX)
67 #define AF_LOCAL AF_UNIX
68 #endif
69 #ifdef AF_LOCAL
70 #define HAVE_LOCAL_SOCKETS
71 #include <sys/un.h>
72 #endif
73 #endif
74 #endif /* HAVE_SOCKETS */
76 /* TERM is a poor-man's SLIP, used on GNU/Linux. */
77 #ifdef TERM
78 #include <client.h>
79 #endif
81 /* On some systems, e.g. DGUX, inet_addr returns a 'struct in_addr'. */
82 #ifdef HAVE_BROKEN_INET_ADDR
83 #define IN_ADDR struct in_addr
84 #define NUMERIC_ADDR_ERROR (numeric_addr.s_addr == -1)
85 #else
86 #define IN_ADDR unsigned long
87 #define NUMERIC_ADDR_ERROR (numeric_addr == -1)
88 #endif
90 #if defined(BSD_SYSTEM) || defined(STRIDE)
91 #include <sys/ioctl.h>
92 #if !defined (O_NDELAY) && defined (HAVE_PTYS) && !defined(USG5)
93 #include <fcntl.h>
94 #endif /* HAVE_PTYS and no O_NDELAY */
95 #endif /* BSD_SYSTEM || STRIDE */
97 #ifdef BROKEN_O_NONBLOCK
98 #undef O_NONBLOCK
99 #endif /* BROKEN_O_NONBLOCK */
101 #ifdef NEED_BSDTTY
102 #include <bsdtty.h>
103 #endif
105 /* Can we use SIOCGIFCONF and/or SIOCGIFADDR */
106 #ifdef HAVE_SOCKETS
107 #if defined(HAVE_SYS_IOCTL_H) && defined(HAVE_NET_IF_H)
108 /* sys/ioctl.h may have been included already */
109 #ifndef SIOCGIFADDR
110 #include <sys/ioctl.h>
111 #endif
112 #include <net/if.h>
113 #endif
114 #endif
116 #ifdef IRIS
117 #include <sys/sysmacros.h> /* for "minor" */
118 #endif /* not IRIS */
120 #ifdef HAVE_SYS_WAIT
121 #include <sys/wait.h>
122 #endif
124 /* Disable IPv6 support for w32 until someone figures out how to do it
125 properly. */
126 #ifdef WINDOWSNT
127 # ifdef AF_INET6
128 # undef AF_INET6
129 # endif
130 #endif
132 #include "lisp.h"
133 #include "systime.h"
134 #include "systty.h"
136 #include "window.h"
137 #include "buffer.h"
138 #include "charset.h"
139 #include "coding.h"
140 #include "process.h"
141 #include "termhooks.h"
142 #include "termopts.h"
143 #include "commands.h"
144 #include "keyboard.h"
145 #include "frame.h"
146 #include "blockinput.h"
147 #include "dispextern.h"
148 #include "composite.h"
149 #include "atimer.h"
151 Lisp_Object Qprocessp;
152 Lisp_Object Qrun, Qstop, Qsignal;
153 Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
154 Lisp_Object Qlocal, Qipv4, Qdatagram;
155 #ifdef AF_INET6
156 Lisp_Object Qipv6;
157 #endif
158 Lisp_Object QCname, QCbuffer, QChost, QCservice, QCtype;
159 Lisp_Object QClocal, QCremote, QCcoding;
160 Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
161 Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
162 Lisp_Object QCfilter_multibyte;
163 Lisp_Object Qlast_nonmenu_event;
164 /* QCfamily is declared and initialized in xfaces.c,
165 QCfilter in keyboard.c. */
166 extern Lisp_Object QCfamily, QCfilter;
168 /* Qexit is declared and initialized in eval.c. */
170 /* QCfamily is defined in xfaces.c. */
171 extern Lisp_Object QCfamily;
172 /* QCfilter is defined in keyboard.c. */
173 extern Lisp_Object QCfilter;
175 /* a process object is a network connection when its childp field is neither
176 Qt nor Qnil but is instead a property list (KEY VAL ...). */
178 #ifdef HAVE_SOCKETS
179 #define NETCONN_P(p) (GC_CONSP (XPROCESS (p)->childp))
180 #define NETCONN1_P(p) (GC_CONSP ((p)->childp))
181 #else
182 #define NETCONN_P(p) 0
183 #define NETCONN1_P(p) 0
184 #endif /* HAVE_SOCKETS */
186 /* Define first descriptor number available for subprocesses. */
187 #ifdef VMS
188 #define FIRST_PROC_DESC 1
189 #else /* Not VMS */
190 #define FIRST_PROC_DESC 3
191 #endif
193 /* Define SIGCHLD as an alias for SIGCLD. There are many conditionals
194 testing SIGCHLD. */
196 #if !defined (SIGCHLD) && defined (SIGCLD)
197 #define SIGCHLD SIGCLD
198 #endif /* SIGCLD */
200 #include "syssignal.h"
202 #include "syswait.h"
204 extern char *get_operating_system_release ();
206 #ifndef USE_CRT_DLL
207 extern int errno;
208 #endif
209 #ifdef VMS
210 extern char *sys_errlist[];
211 #endif
213 #ifndef HAVE_H_ERRNO
214 extern int h_errno;
215 #endif
217 /* t means use pty, nil means use a pipe,
218 maybe other values to come. */
219 static Lisp_Object Vprocess_connection_type;
221 #ifdef SKTPAIR
222 #ifndef HAVE_SOCKETS
223 #include <sys/socket.h>
224 #endif
225 #endif /* SKTPAIR */
227 /* These next two vars are non-static since sysdep.c uses them in the
228 emulation of `select'. */
229 /* Number of events of change of status of a process. */
230 int process_tick;
231 /* Number of events for which the user or sentinel has been notified. */
232 int update_tick;
234 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
236 #ifdef BROKEN_NON_BLOCKING_CONNECT
237 #undef NON_BLOCKING_CONNECT
238 #else
239 #ifndef NON_BLOCKING_CONNECT
240 #ifdef HAVE_SOCKETS
241 #ifdef HAVE_SELECT
242 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
243 #if defined (O_NONBLOCK) || defined (O_NDELAY)
244 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
245 #define NON_BLOCKING_CONNECT
246 #endif /* EWOULDBLOCK || EINPROGRESS */
247 #endif /* O_NONBLOCK || O_NDELAY */
248 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
249 #endif /* HAVE_SELECT */
250 #endif /* HAVE_SOCKETS */
251 #endif /* NON_BLOCKING_CONNECT */
252 #endif /* BROKEN_NON_BLOCKING_CONNECT */
254 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
255 this system. We need to read full packets, so we need a
256 "non-destructive" select. So we require either native select,
257 or emulation of select using FIONREAD. */
259 #ifdef BROKEN_DATAGRAM_SOCKETS
260 #undef DATAGRAM_SOCKETS
261 #else
262 #ifndef DATAGRAM_SOCKETS
263 #ifdef HAVE_SOCKETS
264 #if defined (HAVE_SELECT) || defined (FIONREAD)
265 #if defined (HAVE_SENDTO) && defined (HAVE_RECVFROM) && defined (EMSGSIZE)
266 #define DATAGRAM_SOCKETS
267 #endif /* HAVE_SENDTO && HAVE_RECVFROM && EMSGSIZE */
268 #endif /* HAVE_SELECT || FIONREAD */
269 #endif /* HAVE_SOCKETS */
270 #endif /* DATAGRAM_SOCKETS */
271 #endif /* BROKEN_DATAGRAM_SOCKETS */
273 #ifdef TERM
274 #undef NON_BLOCKING_CONNECT
275 #undef DATAGRAM_SOCKETS
276 #endif
278 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
279 #ifdef EMACS_HAS_USECS
280 #define ADAPTIVE_READ_BUFFERING
281 #endif
282 #endif
284 #ifdef ADAPTIVE_READ_BUFFERING
285 #define READ_OUTPUT_DELAY_INCREMENT 10000
286 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
287 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
289 /* Number of processes which have a non-zero read_output_delay,
290 and therefore might be delayed for adaptive read buffering. */
292 static int process_output_delay_count;
294 /* Non-zero if any process has non-nil read_output_skip. */
296 static int process_output_skip;
298 /* Non-nil means to delay reading process output to improve buffering.
299 A value of t means that delay is reset after each send, any other
300 non-nil value does not reset the delay. A value of nil disables
301 adaptive read buffering completely. */
302 static Lisp_Object Vprocess_adaptive_read_buffering;
303 #else
304 #define process_output_delay_count 0
305 #endif
308 #include "sysselect.h"
310 static int keyboard_bit_set P_ ((SELECT_TYPE *));
311 static void deactivate_process P_ ((Lisp_Object));
312 static void status_notify P_ ((struct Lisp_Process *));
313 static int read_process_output P_ ((Lisp_Object, int));
315 /* If we support a window system, turn on the code to poll periodically
316 to detect C-g. It isn't actually used when doing interrupt input. */
317 #ifdef HAVE_WINDOW_SYSTEM
318 #define POLL_FOR_INPUT
319 #endif
321 /* Mask of bits indicating the descriptors that we wait for input on. */
323 static SELECT_TYPE input_wait_mask;
325 /* Mask that excludes keyboard input descriptor (s). */
327 static SELECT_TYPE non_keyboard_wait_mask;
329 /* Mask that excludes process input descriptor (s). */
331 static SELECT_TYPE non_process_wait_mask;
333 #ifdef NON_BLOCKING_CONNECT
334 /* Mask of bits indicating the descriptors that we wait for connect to
335 complete on. Once they complete, they are removed from this mask
336 and added to the input_wait_mask and non_keyboard_wait_mask. */
338 static SELECT_TYPE connect_wait_mask;
340 /* Number of bits set in connect_wait_mask. */
341 static int num_pending_connects;
343 #define IF_NON_BLOCKING_CONNECT(s) s
344 #else
345 #define IF_NON_BLOCKING_CONNECT(s)
346 #endif
348 /* The largest descriptor currently in use for a process object. */
349 static int max_process_desc;
351 /* The largest descriptor currently in use for keyboard input. */
352 static int max_keyboard_desc;
354 /* Nonzero means delete a process right away if it exits. */
355 static int delete_exited_processes;
357 /* Indexed by descriptor, gives the process (if any) for that descriptor */
358 Lisp_Object chan_process[MAXDESC];
360 /* Alist of elements (NAME . PROCESS) */
361 Lisp_Object Vprocess_alist;
363 /* Buffered-ahead input char from process, indexed by channel.
364 -1 means empty (no char is buffered).
365 Used on sys V where the only way to tell if there is any
366 output from the process is to read at least one char.
367 Always -1 on systems that support FIONREAD. */
369 /* Don't make static; need to access externally. */
370 int proc_buffered_char[MAXDESC];
372 /* Table of `struct coding-system' for each process. */
373 static struct coding_system *proc_decode_coding_system[MAXDESC];
374 static struct coding_system *proc_encode_coding_system[MAXDESC];
376 #ifdef DATAGRAM_SOCKETS
377 /* Table of `partner address' for datagram sockets. */
378 struct sockaddr_and_len {
379 struct sockaddr *sa;
380 int len;
381 } datagram_address[MAXDESC];
382 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
383 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XINT (XPROCESS (proc)->infd)].sa != 0)
384 #else
385 #define DATAGRAM_CHAN_P(chan) (0)
386 #define DATAGRAM_CONN_P(proc) (0)
387 #endif
389 static Lisp_Object get_process ();
390 static void exec_sentinel ();
392 extern EMACS_TIME timer_check ();
393 extern int timers_run;
395 /* Maximum number of bytes to send to a pty without an eof. */
396 static int pty_max_bytes;
398 #ifdef HAVE_PTYS
399 #ifdef HAVE_PTY_H
400 #include <pty.h>
401 #endif
402 /* The file name of the pty opened by allocate_pty. */
404 static char pty_name[24];
405 #endif
407 /* Compute the Lisp form of the process status, p->status, from
408 the numeric status that was returned by `wait'. */
410 static Lisp_Object status_convert ();
412 static void
413 update_status (p)
414 struct Lisp_Process *p;
416 union { int i; WAITTYPE wt; } u;
417 eassert (p->raw_status_new);
418 u.i = p->raw_status;
419 p->status = status_convert (u.wt);
420 p->raw_status_new = 0;
423 /* Convert a process status word in Unix format to
424 the list that we use internally. */
426 static Lisp_Object
427 status_convert (w)
428 WAITTYPE w;
430 if (WIFSTOPPED (w))
431 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
432 else if (WIFEXITED (w))
433 return Fcons (Qexit, Fcons (make_number (WRETCODE (w)),
434 WCOREDUMP (w) ? Qt : Qnil));
435 else if (WIFSIGNALED (w))
436 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
437 WCOREDUMP (w) ? Qt : Qnil));
438 else
439 return Qrun;
442 /* Given a status-list, extract the three pieces of information
443 and store them individually through the three pointers. */
445 static void
446 decode_status (l, symbol, code, coredump)
447 Lisp_Object l;
448 Lisp_Object *symbol;
449 int *code;
450 int *coredump;
452 Lisp_Object tem;
454 if (SYMBOLP (l))
456 *symbol = l;
457 *code = 0;
458 *coredump = 0;
460 else
462 *symbol = XCAR (l);
463 tem = XCDR (l);
464 *code = XFASTINT (XCAR (tem));
465 tem = XCDR (tem);
466 *coredump = !NILP (tem);
470 /* Return a string describing a process status list. */
472 static Lisp_Object
473 status_message (p)
474 struct Lisp_Process *p;
476 Lisp_Object status = p->status;
477 Lisp_Object symbol;
478 int code, coredump;
479 Lisp_Object string, string2;
481 decode_status (status, &symbol, &code, &coredump);
483 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
485 char *signame;
486 synchronize_system_messages_locale ();
487 signame = strsignal (code);
488 if (signame == 0)
489 signame = "unknown";
490 string = build_string (signame);
491 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
492 SSET (string, 0, DOWNCASE (SREF (string, 0)));
493 return concat2 (string, string2);
495 else if (EQ (symbol, Qexit))
497 if (NETCONN1_P (p))
498 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
499 if (code == 0)
500 return build_string ("finished\n");
501 string = Fnumber_to_string (make_number (code));
502 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
503 return concat3 (build_string ("exited abnormally with code "),
504 string, string2);
506 else if (EQ (symbol, Qfailed))
508 string = Fnumber_to_string (make_number (code));
509 string2 = build_string ("\n");
510 return concat3 (build_string ("failed with code "),
511 string, string2);
513 else
514 return Fcopy_sequence (Fsymbol_name (symbol));
517 #ifdef HAVE_PTYS
519 /* Open an available pty, returning a file descriptor.
520 Return -1 on failure.
521 The file name of the terminal corresponding to the pty
522 is left in the variable pty_name. */
524 static int
525 allocate_pty ()
527 register int c, i;
528 int fd;
530 #ifdef PTY_ITERATION
531 PTY_ITERATION
532 #else
533 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
534 for (i = 0; i < 16; i++)
535 #endif
537 struct stat stb; /* Used in some PTY_OPEN. */
538 #ifdef PTY_NAME_SPRINTF
539 PTY_NAME_SPRINTF
540 #else
541 sprintf (pty_name, "/dev/pty%c%x", c, i);
542 #endif /* no PTY_NAME_SPRINTF */
544 #ifdef PTY_OPEN
545 PTY_OPEN;
546 #else /* no PTY_OPEN */
548 # ifdef IRIS
549 /* Unusual IRIS code */
550 *ptyv = emacs_open ("/dev/ptc", O_RDWR | O_NDELAY, 0);
551 if (fd < 0)
552 return -1;
553 if (fstat (fd, &stb) < 0)
554 return -1;
555 # else /* not IRIS */
556 { /* Some systems name their pseudoterminals so that there are gaps in
557 the usual sequence - for example, on HP9000/S700 systems, there
558 are no pseudoterminals with names ending in 'f'. So we wait for
559 three failures in a row before deciding that we've reached the
560 end of the ptys. */
561 int failed_count = 0;
563 if (stat (pty_name, &stb) < 0)
565 failed_count++;
566 if (failed_count >= 3)
567 return -1;
569 else
570 failed_count = 0;
572 # ifdef O_NONBLOCK
573 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
574 # else
575 fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
576 # endif
577 # endif /* not IRIS */
579 #endif /* no PTY_OPEN */
581 if (fd >= 0)
583 /* check to make certain that both sides are available
584 this avoids a nasty yet stupid bug in rlogins */
585 #ifdef PTY_TTY_NAME_SPRINTF
586 PTY_TTY_NAME_SPRINTF
587 #else
588 sprintf (pty_name, "/dev/tty%c%x", c, i);
589 #endif /* no PTY_TTY_NAME_SPRINTF */
590 #ifndef UNIPLUS
591 if (access (pty_name, 6) != 0)
593 emacs_close (fd);
594 # if !defined(IRIS) && !defined(__sgi)
595 continue;
596 # else
597 return -1;
598 # endif /* IRIS */
600 #endif /* not UNIPLUS */
601 setup_pty (fd);
602 return fd;
605 return -1;
607 #endif /* HAVE_PTYS */
609 static Lisp_Object
610 make_process (name)
611 Lisp_Object name;
613 register Lisp_Object val, tem, name1;
614 register struct Lisp_Process *p;
615 char suffix[10];
616 register int i;
618 p = allocate_process ();
620 XSETINT (p->infd, -1);
621 XSETINT (p->outfd, -1);
622 XSETFASTINT (p->tick, 0);
623 XSETFASTINT (p->update_tick, 0);
624 p->pid = 0;
625 p->raw_status_new = 0;
626 p->status = Qrun;
627 p->mark = Fmake_marker ();
629 #ifdef ADAPTIVE_READ_BUFFERING
630 p->adaptive_read_buffering = Qnil;
631 XSETFASTINT (p->read_output_delay, 0);
632 p->read_output_skip = Qnil;
633 #endif
635 /* If name is already in use, modify it until it is unused. */
637 name1 = name;
638 for (i = 1; ; i++)
640 tem = Fget_process (name1);
641 if (NILP (tem)) break;
642 sprintf (suffix, "<%d>", i);
643 name1 = concat2 (name, build_string (suffix));
645 name = name1;
646 p->name = name;
647 XSETPROCESS (val, p);
648 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
649 return val;
652 static void
653 remove_process (proc)
654 register Lisp_Object proc;
656 register Lisp_Object pair;
658 pair = Frassq (proc, Vprocess_alist);
659 Vprocess_alist = Fdelq (pair, Vprocess_alist);
661 deactivate_process (proc);
664 /* Setup coding systems of PROCESS. */
666 void
667 setup_process_coding_systems (process)
668 Lisp_Object process;
670 struct Lisp_Process *p = XPROCESS (process);
671 int inch = XINT (p->infd);
672 int outch = XINT (p->outfd);
674 if (inch < 0 || outch < 0)
675 return;
677 if (!proc_decode_coding_system[inch])
678 proc_decode_coding_system[inch]
679 = (struct coding_system *) xmalloc (sizeof (struct coding_system));
680 setup_coding_system (p->decode_coding_system,
681 proc_decode_coding_system[inch]);
682 if (! NILP (p->filter))
684 if (NILP (p->filter_multibyte))
685 setup_raw_text_coding_system (proc_decode_coding_system[inch]);
687 else if (BUFFERP (p->buffer))
689 if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
690 setup_raw_text_coding_system (proc_decode_coding_system[inch]);
693 if (!proc_encode_coding_system[outch])
694 proc_encode_coding_system[outch]
695 = (struct coding_system *) xmalloc (sizeof (struct coding_system));
696 setup_coding_system (p->encode_coding_system,
697 proc_encode_coding_system[outch]);
698 if (proc_encode_coding_system[outch]->eol_type == CODING_EOL_UNDECIDED)
699 proc_encode_coding_system[outch]->eol_type = system_eol_type;
702 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
703 doc: /* Return t if OBJECT is a process. */)
704 (object)
705 Lisp_Object object;
707 return PROCESSP (object) ? Qt : Qnil;
710 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
711 doc: /* Return the process named NAME, or nil if there is none. */)
712 (name)
713 register Lisp_Object name;
715 if (PROCESSP (name))
716 return name;
717 CHECK_STRING (name);
718 return Fcdr (Fassoc (name, Vprocess_alist));
721 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
722 doc: /* Return the (or a) process associated with BUFFER.
723 BUFFER may be a buffer or the name of one. */)
724 (buffer)
725 register Lisp_Object buffer;
727 register Lisp_Object buf, tail, proc;
729 if (NILP (buffer)) return Qnil;
730 buf = Fget_buffer (buffer);
731 if (NILP (buf)) return Qnil;
733 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
735 proc = Fcdr (Fcar (tail));
736 if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
737 return proc;
739 return Qnil;
742 /* This is how commands for the user decode process arguments. It
743 accepts a process, a process name, a buffer, a buffer name, or nil.
744 Buffers denote the first process in the buffer, and nil denotes the
745 current buffer. */
747 static Lisp_Object
748 get_process (name)
749 register Lisp_Object name;
751 register Lisp_Object proc, obj;
752 if (STRINGP (name))
754 obj = Fget_process (name);
755 if (NILP (obj))
756 obj = Fget_buffer (name);
757 if (NILP (obj))
758 error ("Process %s does not exist", SDATA (name));
760 else if (NILP (name))
761 obj = Fcurrent_buffer ();
762 else
763 obj = name;
765 /* Now obj should be either a buffer object or a process object.
767 if (BUFFERP (obj))
769 proc = Fget_buffer_process (obj);
770 if (NILP (proc))
771 error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
773 else
775 CHECK_PROCESS (obj);
776 proc = obj;
778 return proc;
782 #ifdef SIGCHLD
783 /* Fdelete_process promises to immediately forget about the process, but in
784 reality, Emacs needs to remember those processes until they have been
785 treated by sigchld_handler; otherwise this handler would consider the
786 process as being synchronous and say that the synchronous process is
787 dead. */
788 static Lisp_Object deleted_pid_list;
789 #endif
791 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
792 doc: /* Delete PROCESS: kill it and forget about it immediately.
793 PROCESS may be a process, a buffer, the name of a process or buffer, or
794 nil, indicating the current buffer's process. */)
795 (process)
796 register Lisp_Object process;
798 register struct Lisp_Process *p;
800 process = get_process (process);
801 p = XPROCESS (process);
803 p->raw_status_new = 0;
804 if (NETCONN1_P (p))
806 p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
807 XSETINT (p->tick, ++process_tick);
808 status_notify (p);
810 else if (XINT (p->infd) >= 0)
812 #ifdef SIGCHLD
813 Lisp_Object symbol;
815 /* No problem storing the pid here, as it is still in Vprocess_alist. */
816 deleted_pid_list = Fcons (make_fixnum_or_float (p->pid),
817 /* GC treated elements set to nil. */
818 Fdelq (Qnil, deleted_pid_list));
819 /* If the process has already signaled, remove it from the list. */
820 if (p->raw_status_new)
821 update_status (p);
822 symbol = p->status;
823 if (CONSP (p->status))
824 symbol = XCAR (p->status);
825 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
826 Fdelete (make_fixnum_or_float (p->pid), deleted_pid_list);
827 else
828 #endif
830 Fkill_process (process, Qnil);
831 /* Do this now, since remove_process will make sigchld_handler do nothing. */
832 p->status
833 = Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
834 XSETINT (p->tick, ++process_tick);
835 status_notify (p);
838 remove_process (process);
839 return Qnil;
842 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
843 doc: /* Return the status of PROCESS.
844 The returned value is one of the following symbols:
845 run -- for a process that is running.
846 stop -- for a process stopped but continuable.
847 exit -- for a process that has exited.
848 signal -- for a process that has got a fatal signal.
849 open -- for a network stream connection that is open.
850 listen -- for a network stream server that is listening.
851 closed -- for a network stream connection that is closed.
852 connect -- when waiting for a non-blocking connection to complete.
853 failed -- when a non-blocking connection has failed.
854 nil -- if arg is a process name and no such process exists.
855 PROCESS may be a process, a buffer, the name of a process, or
856 nil, indicating the current buffer's process. */)
857 (process)
858 register Lisp_Object process;
860 register struct Lisp_Process *p;
861 register Lisp_Object status;
863 if (STRINGP (process))
864 process = Fget_process (process);
865 else
866 process = get_process (process);
868 if (NILP (process))
869 return process;
871 p = XPROCESS (process);
872 if (p->raw_status_new)
873 update_status (p);
874 status = p->status;
875 if (CONSP (status))
876 status = XCAR (status);
877 if (NETCONN1_P (p))
879 if (EQ (status, Qexit))
880 status = Qclosed;
881 else if (EQ (p->command, Qt))
882 status = Qstop;
883 else if (EQ (status, Qrun))
884 status = Qopen;
886 return status;
889 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
890 1, 1, 0,
891 doc: /* Return the exit status of PROCESS or the signal number that killed it.
892 If PROCESS has not yet exited or died, return 0. */)
893 (process)
894 register Lisp_Object process;
896 CHECK_PROCESS (process);
897 if (XPROCESS (process)->raw_status_new)
898 update_status (XPROCESS (process));
899 if (CONSP (XPROCESS (process)->status))
900 return XCAR (XCDR (XPROCESS (process)->status));
901 return make_number (0);
904 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
905 doc: /* Return the process id of PROCESS.
906 This is the pid of the external process which PROCESS uses or talks to.
907 For a network connection, this value is nil. */)
908 (process)
909 register Lisp_Object process;
911 CHECK_PROCESS (process);
912 return (XPROCESS (process)->pid
913 ? make_fixnum_or_float (XPROCESS (process)->pid)
914 : Qnil);
917 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
918 doc: /* Return the name of PROCESS, as a string.
919 This is the name of the program invoked in PROCESS,
920 possibly modified to make it unique among process names. */)
921 (process)
922 register Lisp_Object process;
924 CHECK_PROCESS (process);
925 return XPROCESS (process)->name;
928 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
929 doc: /* Return the command that was executed to start PROCESS.
930 This is a list of strings, the first string being the program executed
931 and the rest of the strings being the arguments given to it.
932 For a non-child channel, this is nil. */)
933 (process)
934 register Lisp_Object process;
936 CHECK_PROCESS (process);
937 return XPROCESS (process)->command;
940 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
941 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
942 This is the terminal that the process itself reads and writes on,
943 not the name of the pty that Emacs uses to talk with that terminal. */)
944 (process)
945 register Lisp_Object process;
947 CHECK_PROCESS (process);
948 return XPROCESS (process)->tty_name;
951 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
952 2, 2, 0,
953 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil). */)
954 (process, buffer)
955 register Lisp_Object process, buffer;
957 struct Lisp_Process *p;
959 CHECK_PROCESS (process);
960 if (!NILP (buffer))
961 CHECK_BUFFER (buffer);
962 p = XPROCESS (process);
963 p->buffer = buffer;
964 if (NETCONN1_P (p))
965 p->childp = Fplist_put (p->childp, QCbuffer, buffer);
966 setup_process_coding_systems (process);
967 return buffer;
970 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
971 1, 1, 0,
972 doc: /* Return the buffer PROCESS is associated with.
973 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
974 (process)
975 register Lisp_Object process;
977 CHECK_PROCESS (process);
978 return XPROCESS (process)->buffer;
981 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
982 1, 1, 0,
983 doc: /* Return the marker for the end of the last output from PROCESS. */)
984 (process)
985 register Lisp_Object process;
987 CHECK_PROCESS (process);
988 return XPROCESS (process)->mark;
991 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
992 2, 2, 0,
993 doc: /* Give PROCESS the filter function FILTER; nil means no filter.
994 t means stop accepting output from the process.
996 When a process has a filter, its buffer is not used for output.
997 Instead, each time it does output, the entire string of output is
998 passed to the filter.
1000 The filter gets two arguments: the process and the string of output.
1001 The string argument is normally a multibyte string, except:
1002 - if the process' input coding system is no-conversion or raw-text,
1003 it is a unibyte string (the non-converted input), or else
1004 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1005 string (the result of converting the decoded input multibyte
1006 string to unibyte with `string-make-unibyte'). */)
1007 (process, filter)
1008 register Lisp_Object process, filter;
1010 struct Lisp_Process *p;
1012 CHECK_PROCESS (process);
1013 p = XPROCESS (process);
1015 /* Don't signal an error if the process' input file descriptor
1016 is closed. This could make debugging Lisp more difficult,
1017 for example when doing something like
1019 (setq process (start-process ...))
1020 (debug)
1021 (set-process-filter process ...) */
1023 if (XINT (p->infd) >= 0)
1025 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1027 FD_CLR (XINT (p->infd), &input_wait_mask);
1028 FD_CLR (XINT (p->infd), &non_keyboard_wait_mask);
1030 else if (EQ (p->filter, Qt)
1031 && !EQ (p->command, Qt)) /* Network process not stopped. */
1033 FD_SET (XINT (p->infd), &input_wait_mask);
1034 FD_SET (XINT (p->infd), &non_keyboard_wait_mask);
1038 p->filter = filter;
1039 if (NETCONN1_P (p))
1040 p->childp = Fplist_put (p->childp, QCfilter, filter);
1041 setup_process_coding_systems (process);
1042 return filter;
1045 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1046 1, 1, 0,
1047 doc: /* Returns the filter function of PROCESS; nil if none.
1048 See `set-process-filter' for more info on filter functions. */)
1049 (process)
1050 register Lisp_Object process;
1052 CHECK_PROCESS (process);
1053 return XPROCESS (process)->filter;
1056 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1057 2, 2, 0,
1058 doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
1059 The sentinel is called as a function when the process changes state.
1060 It gets two arguments: the process, and a string describing the change. */)
1061 (process, sentinel)
1062 register Lisp_Object process, sentinel;
1064 struct Lisp_Process *p;
1066 CHECK_PROCESS (process);
1067 p = XPROCESS (process);
1069 p->sentinel = sentinel;
1070 if (NETCONN1_P (p))
1071 p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
1072 return sentinel;
1075 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1076 1, 1, 0,
1077 doc: /* Return the sentinel of PROCESS; nil if none.
1078 See `set-process-sentinel' for more info on sentinels. */)
1079 (process)
1080 register Lisp_Object process;
1082 CHECK_PROCESS (process);
1083 return XPROCESS (process)->sentinel;
1086 DEFUN ("set-process-window-size", Fset_process_window_size,
1087 Sset_process_window_size, 3, 3, 0,
1088 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1089 (process, height, width)
1090 register Lisp_Object process, height, width;
1092 CHECK_PROCESS (process);
1093 CHECK_NATNUM (height);
1094 CHECK_NATNUM (width);
1096 if (XINT (XPROCESS (process)->infd) < 0
1097 || set_window_size (XINT (XPROCESS (process)->infd),
1098 XINT (height), XINT (width)) <= 0)
1099 return Qnil;
1100 else
1101 return Qt;
1104 DEFUN ("set-process-inherit-coding-system-flag",
1105 Fset_process_inherit_coding_system_flag,
1106 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1107 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1108 If the second argument FLAG is non-nil, then the variable
1109 `buffer-file-coding-system' of the buffer associated with PROCESS
1110 will be bound to the value of the coding system used to decode
1111 the process output.
1113 This is useful when the coding system specified for the process buffer
1114 leaves either the character code conversion or the end-of-line conversion
1115 unspecified, or if the coding system used to decode the process output
1116 is more appropriate for saving the process buffer.
1118 Binding the variable `inherit-process-coding-system' to non-nil before
1119 starting the process is an alternative way of setting the inherit flag
1120 for the process which will run. */)
1121 (process, flag)
1122 register Lisp_Object process, flag;
1124 CHECK_PROCESS (process);
1125 XPROCESS (process)->inherit_coding_system_flag = flag;
1126 return flag;
1129 DEFUN ("process-inherit-coding-system-flag",
1130 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
1131 1, 1, 0,
1132 doc: /* Return the value of inherit-coding-system flag for PROCESS.
1133 If this flag is t, `buffer-file-coding-system' of the buffer
1134 associated with PROCESS will inherit the coding system used to decode
1135 the process output. */)
1136 (process)
1137 register Lisp_Object process;
1139 CHECK_PROCESS (process);
1140 return XPROCESS (process)->inherit_coding_system_flag;
1143 DEFUN ("set-process-query-on-exit-flag",
1144 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1145 2, 2, 0,
1146 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1147 If the second argument FLAG is non-nil, Emacs will query the user before
1148 exiting if PROCESS is running. */)
1149 (process, flag)
1150 register Lisp_Object process, flag;
1152 CHECK_PROCESS (process);
1153 XPROCESS (process)->kill_without_query = Fnull (flag);
1154 return flag;
1157 DEFUN ("process-query-on-exit-flag",
1158 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1159 1, 1, 0,
1160 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1161 (process)
1162 register Lisp_Object process;
1164 CHECK_PROCESS (process);
1165 return Fnull (XPROCESS (process)->kill_without_query);
1168 #ifdef DATAGRAM_SOCKETS
1169 Lisp_Object Fprocess_datagram_address ();
1170 #endif
1172 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1173 1, 2, 0,
1174 doc: /* Return the contact info of PROCESS; t for a real child.
1175 For a net connection, the value depends on the optional KEY arg.
1176 If KEY is nil, value is a cons cell of the form (HOST SERVICE),
1177 if KEY is t, the complete contact information for the connection is
1178 returned, else the specific value for the keyword KEY is returned.
1179 See `make-network-process' for a list of keywords. */)
1180 (process, key)
1181 register Lisp_Object process, key;
1183 Lisp_Object contact;
1185 CHECK_PROCESS (process);
1186 contact = XPROCESS (process)->childp;
1188 #ifdef DATAGRAM_SOCKETS
1189 if (DATAGRAM_CONN_P (process)
1190 && (EQ (key, Qt) || EQ (key, QCremote)))
1191 contact = Fplist_put (contact, QCremote,
1192 Fprocess_datagram_address (process));
1193 #endif
1195 if (!NETCONN_P (process) || EQ (key, Qt))
1196 return contact;
1197 if (NILP (key))
1198 return Fcons (Fplist_get (contact, QChost),
1199 Fcons (Fplist_get (contact, QCservice), Qnil));
1200 return Fplist_get (contact, key);
1203 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1204 1, 1, 0,
1205 doc: /* Return the plist of PROCESS. */)
1206 (process)
1207 register Lisp_Object process;
1209 CHECK_PROCESS (process);
1210 return XPROCESS (process)->plist;
1213 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1214 2, 2, 0,
1215 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1216 (process, plist)
1217 register Lisp_Object process, plist;
1219 CHECK_PROCESS (process);
1220 CHECK_LIST (plist);
1222 XPROCESS (process)->plist = plist;
1223 return plist;
1226 #if 0 /* Turned off because we don't currently record this info
1227 in the process. Perhaps add it. */
1228 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1229 doc: /* Return the connection type of PROCESS.
1230 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1231 a socket connection. */)
1232 (process)
1233 Lisp_Object process;
1235 return XPROCESS (process)->type;
1237 #endif
1239 #ifdef HAVE_SOCKETS
1240 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1241 1, 2, 0,
1242 doc: /* Convert network ADDRESS from internal format to a string.
1243 A 4 or 5 element vector represents an IPv4 address (with port number).
1244 An 8 or 9 element vector represents an IPv6 address (with port number).
1245 If optional second argument OMIT-PORT is non-nil, don't include a port
1246 number in the string, even when present in ADDRESS.
1247 Returns nil if format of ADDRESS is invalid. */)
1248 (address, omit_port)
1249 Lisp_Object address, omit_port;
1251 if (NILP (address))
1252 return Qnil;
1254 if (STRINGP (address)) /* AF_LOCAL */
1255 return address;
1257 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1259 register struct Lisp_Vector *p = XVECTOR (address);
1260 Lisp_Object args[6];
1261 int nargs, i;
1263 if (p->size == 4 || (p->size == 5 && !NILP (omit_port)))
1265 args[0] = build_string ("%d.%d.%d.%d");
1266 nargs = 4;
1268 else if (p->size == 5)
1270 args[0] = build_string ("%d.%d.%d.%d:%d");
1271 nargs = 5;
1273 else if (p->size == 8 || (p->size == 9 && !NILP (omit_port)))
1275 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1276 nargs = 8;
1278 else if (p->size == 9)
1280 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1281 nargs = 9;
1283 else
1284 return Qnil;
1286 for (i = 0; i < nargs; i++)
1287 args[i+1] = p->contents[i];
1288 return Fformat (nargs+1, args);
1291 if (CONSP (address))
1293 Lisp_Object args[2];
1294 args[0] = build_string ("<Family %d>");
1295 args[1] = Fcar (address);
1296 return Fformat (2, args);
1300 return Qnil;
1302 #endif
1304 static Lisp_Object
1305 list_processes_1 (query_only)
1306 Lisp_Object query_only;
1308 register Lisp_Object tail, tem;
1309 Lisp_Object proc, minspace, tem1;
1310 register struct Lisp_Process *p;
1311 char tembuf[300];
1312 int w_proc, w_buffer, w_tty;
1313 Lisp_Object i_status, i_buffer, i_tty, i_command;
1315 w_proc = 4; /* Proc */
1316 w_buffer = 6; /* Buffer */
1317 w_tty = 0; /* Omit if no ttys */
1319 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
1321 int i;
1323 proc = Fcdr (Fcar (tail));
1324 p = XPROCESS (proc);
1325 if (NILP (p->childp))
1326 continue;
1327 if (!NILP (query_only) && !NILP (p->kill_without_query))
1328 continue;
1329 if (STRINGP (p->name)
1330 && ( i = SCHARS (p->name), (i > w_proc)))
1331 w_proc = i;
1332 if (!NILP (p->buffer))
1334 if (NILP (XBUFFER (p->buffer)->name) && w_buffer < 8)
1335 w_buffer = 8; /* (Killed) */
1336 else if ((i = SCHARS (XBUFFER (p->buffer)->name), (i > w_buffer)))
1337 w_buffer = i;
1339 if (STRINGP (p->tty_name)
1340 && (i = SCHARS (p->tty_name), (i > w_tty)))
1341 w_tty = i;
1344 XSETFASTINT (i_status, w_proc + 1);
1345 XSETFASTINT (i_buffer, XFASTINT (i_status) + 9);
1346 if (w_tty)
1348 XSETFASTINT (i_tty, XFASTINT (i_buffer) + w_buffer + 1);
1349 XSETFASTINT (i_command, XFASTINT (i_buffer) + w_tty + 1);
1350 } else {
1351 i_tty = Qnil;
1352 XSETFASTINT (i_command, XFASTINT (i_buffer) + w_buffer + 1);
1355 XSETFASTINT (minspace, 1);
1357 set_buffer_internal (XBUFFER (Vstandard_output));
1358 current_buffer->undo_list = Qt;
1360 current_buffer->truncate_lines = Qt;
1362 write_string ("Proc", -1);
1363 Findent_to (i_status, minspace); write_string ("Status", -1);
1364 Findent_to (i_buffer, minspace); write_string ("Buffer", -1);
1365 if (!NILP (i_tty))
1367 Findent_to (i_tty, minspace); write_string ("Tty", -1);
1369 Findent_to (i_command, minspace); write_string ("Command", -1);
1370 write_string ("\n", -1);
1372 write_string ("----", -1);
1373 Findent_to (i_status, minspace); write_string ("------", -1);
1374 Findent_to (i_buffer, minspace); write_string ("------", -1);
1375 if (!NILP (i_tty))
1377 Findent_to (i_tty, minspace); write_string ("---", -1);
1379 Findent_to (i_command, minspace); write_string ("-------", -1);
1380 write_string ("\n", -1);
1382 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
1384 Lisp_Object symbol;
1386 proc = Fcdr (Fcar (tail));
1387 p = XPROCESS (proc);
1388 if (NILP (p->childp))
1389 continue;
1390 if (!NILP (query_only) && !NILP (p->kill_without_query))
1391 continue;
1393 Finsert (1, &p->name);
1394 Findent_to (i_status, minspace);
1396 if (p->raw_status_new)
1397 update_status (p);
1398 symbol = p->status;
1399 if (CONSP (p->status))
1400 symbol = XCAR (p->status);
1403 if (EQ (symbol, Qsignal))
1405 Lisp_Object tem;
1406 tem = Fcar (Fcdr (p->status));
1407 #ifdef VMS
1408 if (XINT (tem) < NSIG)
1409 write_string (sys_errlist [XINT (tem)], -1);
1410 else
1411 #endif
1412 Fprinc (symbol, Qnil);
1414 else if (NETCONN1_P (p))
1416 if (EQ (symbol, Qexit))
1417 write_string ("closed", -1);
1418 else if (EQ (p->command, Qt))
1419 write_string ("stopped", -1);
1420 else if (EQ (symbol, Qrun))
1421 write_string ("open", -1);
1422 else
1423 Fprinc (symbol, Qnil);
1425 else
1426 Fprinc (symbol, Qnil);
1428 if (EQ (symbol, Qexit))
1430 Lisp_Object tem;
1431 tem = Fcar (Fcdr (p->status));
1432 if (XFASTINT (tem))
1434 sprintf (tembuf, " %d", (int) XFASTINT (tem));
1435 write_string (tembuf, -1);
1439 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
1440 remove_process (proc);
1442 Findent_to (i_buffer, minspace);
1443 if (NILP (p->buffer))
1444 insert_string ("(none)");
1445 else if (NILP (XBUFFER (p->buffer)->name))
1446 insert_string ("(Killed)");
1447 else
1448 Finsert (1, &XBUFFER (p->buffer)->name);
1450 if (!NILP (i_tty))
1452 Findent_to (i_tty, minspace);
1453 if (STRINGP (p->tty_name))
1454 Finsert (1, &p->tty_name);
1457 Findent_to (i_command, minspace);
1459 if (EQ (p->status, Qlisten))
1461 Lisp_Object port = Fplist_get (p->childp, QCservice);
1462 if (INTEGERP (port))
1463 port = Fnumber_to_string (port);
1464 if (NILP (port))
1465 port = Fformat_network_address (Fplist_get (p->childp, QClocal), Qnil);
1466 sprintf (tembuf, "(network %s server on %s)\n",
1467 (DATAGRAM_CHAN_P (XINT (p->infd)) ? "datagram" : "stream"),
1468 (STRINGP (port) ? (char *)SDATA (port) : "?"));
1469 insert_string (tembuf);
1471 else if (NETCONN1_P (p))
1473 /* For a local socket, there is no host name,
1474 so display service instead. */
1475 Lisp_Object host = Fplist_get (p->childp, QChost);
1476 if (!STRINGP (host))
1478 host = Fplist_get (p->childp, QCservice);
1479 if (INTEGERP (host))
1480 host = Fnumber_to_string (host);
1482 if (NILP (host))
1483 host = Fformat_network_address (Fplist_get (p->childp, QCremote), Qnil);
1484 sprintf (tembuf, "(network %s connection to %s)\n",
1485 (DATAGRAM_CHAN_P (XINT (p->infd)) ? "datagram" : "stream"),
1486 (STRINGP (host) ? (char *)SDATA (host) : "?"));
1487 insert_string (tembuf);
1489 else
1491 tem = p->command;
1492 while (1)
1494 tem1 = Fcar (tem);
1495 Finsert (1, &tem1);
1496 tem = Fcdr (tem);
1497 if (NILP (tem))
1498 break;
1499 insert_string (" ");
1501 insert_string ("\n");
1504 return Qnil;
1507 DEFUN ("list-processes", Flist_processes, Slist_processes, 0, 1, "P",
1508 doc: /* Display a list of all processes.
1509 If optional argument QUERY-ONLY is non-nil, only processes with
1510 the query-on-exit flag set will be listed.
1511 Any process listed as exited or signaled is actually eliminated
1512 after the listing is made. */)
1513 (query_only)
1514 Lisp_Object query_only;
1516 internal_with_output_to_temp_buffer ("*Process List*",
1517 list_processes_1, query_only);
1518 return Qnil;
1521 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1522 doc: /* Return a list of all processes. */)
1525 return Fmapcar (Qcdr, Vprocess_alist);
1528 /* Starting asynchronous inferior processes. */
1530 static Lisp_Object start_process_unwind ();
1532 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1533 doc: /* Start a program in a subprocess. Return the process object for it.
1534 NAME is name for process. It is modified if necessary to make it unique.
1535 BUFFER is the buffer (or buffer name) to associate with the process.
1536 Process output goes at end of that buffer, unless you specify
1537 an output stream or filter function to handle the output.
1538 BUFFER may be also nil, meaning that this process is not associated
1539 with any buffer.
1540 PROGRAM is the program file name. It is searched for in PATH.
1541 Remaining arguments are strings to give program as arguments.
1543 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1544 (nargs, args)
1545 int nargs;
1546 register Lisp_Object *args;
1548 Lisp_Object buffer, name, program, proc, current_dir, tem;
1549 #ifdef VMS
1550 register unsigned char *new_argv;
1551 int len;
1552 #else
1553 register unsigned char **new_argv;
1554 #endif
1555 register int i;
1556 int count = SPECPDL_INDEX ();
1558 buffer = args[1];
1559 if (!NILP (buffer))
1560 buffer = Fget_buffer_create (buffer);
1562 /* Make sure that the child will be able to chdir to the current
1563 buffer's current directory, or its unhandled equivalent. We
1564 can't just have the child check for an error when it does the
1565 chdir, since it's in a vfork.
1567 We have to GCPRO around this because Fexpand_file_name and
1568 Funhandled_file_name_directory might call a file name handling
1569 function. The argument list is protected by the caller, so all
1570 we really have to worry about is buffer. */
1572 struct gcpro gcpro1, gcpro2;
1574 current_dir = current_buffer->directory;
1576 GCPRO2 (buffer, current_dir);
1578 current_dir
1579 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir),
1580 Qnil);
1581 if (NILP (Ffile_accessible_directory_p (current_dir)))
1582 report_file_error ("Setting current directory",
1583 Fcons (current_buffer->directory, Qnil));
1585 UNGCPRO;
1588 name = args[0];
1589 CHECK_STRING (name);
1591 program = args[2];
1593 CHECK_STRING (program);
1595 proc = make_process (name);
1596 /* If an error occurs and we can't start the process, we want to
1597 remove it from the process list. This means that each error
1598 check in create_process doesn't need to call remove_process
1599 itself; it's all taken care of here. */
1600 record_unwind_protect (start_process_unwind, proc);
1602 XPROCESS (proc)->childp = Qt;
1603 XPROCESS (proc)->plist = Qnil;
1604 XPROCESS (proc)->buffer = buffer;
1605 XPROCESS (proc)->sentinel = Qnil;
1606 XPROCESS (proc)->filter = Qnil;
1607 XPROCESS (proc)->filter_multibyte
1608 = buffer_defaults.enable_multibyte_characters;
1609 XPROCESS (proc)->command = Flist (nargs - 2, args + 2);
1611 #ifdef ADAPTIVE_READ_BUFFERING
1612 XPROCESS (proc)->adaptive_read_buffering = Vprocess_adaptive_read_buffering;
1613 #endif
1615 /* Make the process marker point into the process buffer (if any). */
1616 if (BUFFERP (buffer))
1617 set_marker_both (XPROCESS (proc)->mark, buffer,
1618 BUF_ZV (XBUFFER (buffer)),
1619 BUF_ZV_BYTE (XBUFFER (buffer)));
1622 /* Decide coding systems for communicating with the process. Here
1623 we don't setup the structure coding_system nor pay attention to
1624 unibyte mode. They are done in create_process. */
1626 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1627 Lisp_Object coding_systems = Qt;
1628 Lisp_Object val, *args2;
1629 struct gcpro gcpro1, gcpro2;
1631 val = Vcoding_system_for_read;
1632 if (NILP (val))
1634 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
1635 args2[0] = Qstart_process;
1636 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1637 GCPRO2 (proc, current_dir);
1638 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1639 UNGCPRO;
1640 if (CONSP (coding_systems))
1641 val = XCAR (coding_systems);
1642 else if (CONSP (Vdefault_process_coding_system))
1643 val = XCAR (Vdefault_process_coding_system);
1645 XPROCESS (proc)->decode_coding_system = val;
1647 val = Vcoding_system_for_write;
1648 if (NILP (val))
1650 if (EQ (coding_systems, Qt))
1652 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof args2);
1653 args2[0] = Qstart_process;
1654 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1655 GCPRO2 (proc, current_dir);
1656 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1657 UNGCPRO;
1659 if (CONSP (coding_systems))
1660 val = XCDR (coding_systems);
1661 else if (CONSP (Vdefault_process_coding_system))
1662 val = XCDR (Vdefault_process_coding_system);
1664 XPROCESS (proc)->encode_coding_system = val;
1667 #ifdef VMS
1668 /* Make a one member argv with all args concatenated
1669 together separated by a blank. */
1670 len = SBYTES (program) + 2;
1671 for (i = 3; i < nargs; i++)
1673 tem = args[i];
1674 CHECK_STRING (tem);
1675 len += SBYTES (tem) + 1; /* count the blank */
1677 new_argv = (unsigned char *) alloca (len);
1678 strcpy (new_argv, SDATA (program));
1679 for (i = 3; i < nargs; i++)
1681 tem = args[i];
1682 CHECK_STRING (tem);
1683 strcat (new_argv, " ");
1684 strcat (new_argv, SDATA (tem));
1686 /* Need to add code here to check for program existence on VMS */
1688 #else /* not VMS */
1689 new_argv = (unsigned char **) alloca ((nargs - 1) * sizeof (char *));
1691 /* If program file name is not absolute, search our path for it.
1692 Put the name we will really use in TEM. */
1693 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1694 && !(SCHARS (program) > 1
1695 && IS_DEVICE_SEP (SREF (program, 1))))
1697 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1699 tem = Qnil;
1700 GCPRO4 (name, program, buffer, current_dir);
1701 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1702 UNGCPRO;
1703 if (NILP (tem))
1704 report_file_error ("Searching for program", Fcons (program, Qnil));
1705 tem = Fexpand_file_name (tem, Qnil);
1707 else
1709 if (!NILP (Ffile_directory_p (program)))
1710 error ("Specified program for new process is a directory");
1711 tem = program;
1714 /* If program file name starts with /: for quoting a magic name,
1715 discard that. */
1716 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1717 && SREF (tem, 1) == ':')
1718 tem = Fsubstring (tem, make_number (2), Qnil);
1720 /* Encode the file name and put it in NEW_ARGV.
1721 That's where the child will use it to execute the program. */
1722 tem = ENCODE_FILE (tem);
1723 new_argv[0] = SDATA (tem);
1725 /* Here we encode arguments by the coding system used for sending
1726 data to the process. We don't support using different coding
1727 systems for encoding arguments and for encoding data sent to the
1728 process. */
1730 for (i = 3; i < nargs; i++)
1732 tem = args[i];
1733 CHECK_STRING (tem);
1734 if (STRING_MULTIBYTE (tem))
1735 tem = (code_convert_string_norecord
1736 (tem, XPROCESS (proc)->encode_coding_system, 1));
1737 new_argv[i - 2] = SDATA (tem);
1739 new_argv[i - 2] = 0;
1740 #endif /* not VMS */
1742 XPROCESS (proc)->decoding_buf = make_uninit_string (0);
1743 XPROCESS (proc)->decoding_carryover = make_number (0);
1744 XPROCESS (proc)->encoding_buf = make_uninit_string (0);
1745 XPROCESS (proc)->encoding_carryover = make_number (0);
1747 XPROCESS (proc)->inherit_coding_system_flag
1748 = (NILP (buffer) || !inherit_process_coding_system
1749 ? Qnil : Qt);
1751 create_process (proc, (char **) new_argv, current_dir);
1753 return unbind_to (count, proc);
1756 /* This function is the unwind_protect form for Fstart_process. If
1757 PROC doesn't have its pid set, then we know someone has signaled
1758 an error and the process wasn't started successfully, so we should
1759 remove it from the process list. */
1760 static Lisp_Object
1761 start_process_unwind (proc)
1762 Lisp_Object proc;
1764 if (!PROCESSP (proc))
1765 abort ();
1767 /* Was PROC started successfully? */
1768 if (XPROCESS (proc)->pid <= 0)
1769 remove_process (proc);
1771 return Qnil;
1774 static void
1775 create_process_1 (timer)
1776 struct atimer *timer;
1778 /* Nothing to do. */
1782 #if 0 /* This doesn't work; see the note before sigchld_handler. */
1783 #ifdef USG
1784 #ifdef SIGCHLD
1785 /* Mimic blocking of signals on system V, which doesn't really have it. */
1787 /* Nonzero means we got a SIGCHLD when it was supposed to be blocked. */
1788 int sigchld_deferred;
1790 SIGTYPE
1791 create_process_sigchld ()
1793 signal (SIGCHLD, create_process_sigchld);
1795 sigchld_deferred = 1;
1797 #endif
1798 #endif
1799 #endif
1801 #ifndef VMS /* VMS version of this function is in vmsproc.c. */
1802 void
1803 create_process (process, new_argv, current_dir)
1804 Lisp_Object process;
1805 char **new_argv;
1806 Lisp_Object current_dir;
1808 int pid, inchannel, outchannel;
1809 int sv[2];
1810 #ifdef POSIX_SIGNALS
1811 sigset_t procmask;
1812 sigset_t blocked;
1813 struct sigaction sigint_action;
1814 struct sigaction sigquit_action;
1815 #ifdef AIX
1816 struct sigaction sighup_action;
1817 #endif
1818 #else /* !POSIX_SIGNALS */
1819 #if 0
1820 #ifdef SIGCHLD
1821 SIGTYPE (*sigchld)();
1822 #endif
1823 #endif /* 0 */
1824 #endif /* !POSIX_SIGNALS */
1825 /* Use volatile to protect variables from being clobbered by longjmp. */
1826 volatile int forkin, forkout;
1827 volatile int pty_flag = 0;
1828 #ifndef USE_CRT_DLL
1829 extern char **environ;
1830 #endif
1832 inchannel = outchannel = -1;
1834 #ifdef HAVE_PTYS
1835 if (!NILP (Vprocess_connection_type))
1836 outchannel = inchannel = allocate_pty ();
1838 if (inchannel >= 0)
1840 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1841 /* On most USG systems it does not work to open the pty's tty here,
1842 then close it and reopen it in the child. */
1843 #ifdef O_NOCTTY
1844 /* Don't let this terminal become our controlling terminal
1845 (in case we don't have one). */
1846 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1847 #else
1848 forkout = forkin = emacs_open (pty_name, O_RDWR, 0);
1849 #endif
1850 if (forkin < 0)
1851 report_file_error ("Opening pty", Qnil);
1852 #if defined (RTU) || defined (UNIPLUS) || defined (DONT_REOPEN_PTY)
1853 /* In the case that vfork is defined as fork, the parent process
1854 (Emacs) may send some data before the child process completes
1855 tty options setup. So we setup tty before forking. */
1856 child_setup_tty (forkout);
1857 #endif /* RTU or UNIPLUS or DONT_REOPEN_PTY */
1858 #else
1859 forkin = forkout = -1;
1860 #endif /* not USG, or USG_SUBTTY_WORKS */
1861 pty_flag = 1;
1863 else
1864 #endif /* HAVE_PTYS */
1865 #ifdef SKTPAIR
1867 if (socketpair (AF_UNIX, SOCK_STREAM, 0, sv) < 0)
1868 report_file_error ("Opening socketpair", Qnil);
1869 outchannel = inchannel = sv[0];
1870 forkout = forkin = sv[1];
1872 #else /* not SKTPAIR */
1874 int tem;
1875 tem = pipe (sv);
1876 if (tem < 0)
1877 report_file_error ("Creating pipe", Qnil);
1878 inchannel = sv[0];
1879 forkout = sv[1];
1880 tem = pipe (sv);
1881 if (tem < 0)
1883 emacs_close (inchannel);
1884 emacs_close (forkout);
1885 report_file_error ("Creating pipe", Qnil);
1887 outchannel = sv[1];
1888 forkin = sv[0];
1890 #endif /* not SKTPAIR */
1892 #if 0
1893 /* Replaced by close_process_descs */
1894 set_exclusive_use (inchannel);
1895 set_exclusive_use (outchannel);
1896 #endif
1898 /* Stride people say it's a mystery why this is needed
1899 as well as the O_NDELAY, but that it fails without this. */
1900 #if defined (STRIDE) || (defined (pfa) && defined (HAVE_PTYS))
1902 int one = 1;
1903 ioctl (inchannel, FIONBIO, &one);
1905 #endif
1907 #ifdef O_NONBLOCK
1908 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1909 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1910 #else
1911 #ifdef O_NDELAY
1912 fcntl (inchannel, F_SETFL, O_NDELAY);
1913 fcntl (outchannel, F_SETFL, O_NDELAY);
1914 #endif
1915 #endif
1917 /* Record this as an active process, with its channels.
1918 As a result, child_setup will close Emacs's side of the pipes. */
1919 chan_process[inchannel] = process;
1920 XSETINT (XPROCESS (process)->infd, inchannel);
1921 XSETINT (XPROCESS (process)->outfd, outchannel);
1923 /* Previously we recorded the tty descriptor used in the subprocess.
1924 It was only used for getting the foreground tty process, so now
1925 we just reopen the device (see emacs_get_tty_pgrp) as this is
1926 more portable (see USG_SUBTTY_WORKS above). */
1928 XPROCESS (process)->pty_flag = (pty_flag ? Qt : Qnil);
1929 XPROCESS (process)->status = Qrun;
1930 setup_process_coding_systems (process);
1932 /* Delay interrupts until we have a chance to store
1933 the new fork's pid in its process structure */
1934 #ifdef POSIX_SIGNALS
1935 sigemptyset (&blocked);
1936 #ifdef SIGCHLD
1937 sigaddset (&blocked, SIGCHLD);
1938 #endif
1939 #ifdef HAVE_WORKING_VFORK
1940 /* On many hosts (e.g. Solaris 2.4), if a vforked child calls `signal',
1941 this sets the parent's signal handlers as well as the child's.
1942 So delay all interrupts whose handlers the child might munge,
1943 and record the current handlers so they can be restored later. */
1944 sigaddset (&blocked, SIGINT ); sigaction (SIGINT , 0, &sigint_action );
1945 sigaddset (&blocked, SIGQUIT); sigaction (SIGQUIT, 0, &sigquit_action);
1946 #ifdef AIX
1947 sigaddset (&blocked, SIGHUP ); sigaction (SIGHUP , 0, &sighup_action );
1948 #endif
1949 #endif /* HAVE_WORKING_VFORK */
1950 sigprocmask (SIG_BLOCK, &blocked, &procmask);
1951 #else /* !POSIX_SIGNALS */
1952 #ifdef SIGCHLD
1953 #ifdef BSD4_1
1954 sighold (SIGCHLD);
1955 #else /* not BSD4_1 */
1956 #if defined (BSD_SYSTEM) || defined (UNIPLUS) || defined (HPUX)
1957 sigsetmask (sigmask (SIGCHLD));
1958 #else /* ordinary USG */
1959 #if 0
1960 sigchld_deferred = 0;
1961 sigchld = signal (SIGCHLD, create_process_sigchld);
1962 #endif
1963 #endif /* ordinary USG */
1964 #endif /* not BSD4_1 */
1965 #endif /* SIGCHLD */
1966 #endif /* !POSIX_SIGNALS */
1968 FD_SET (inchannel, &input_wait_mask);
1969 FD_SET (inchannel, &non_keyboard_wait_mask);
1970 if (inchannel > max_process_desc)
1971 max_process_desc = inchannel;
1973 /* Until we store the proper pid, enable sigchld_handler
1974 to recognize an unknown pid as standing for this process.
1975 It is very important not to let this `marker' value stay
1976 in the table after this function has returned; if it does
1977 it might cause call-process to hang and subsequent asynchronous
1978 processes to get their return values scrambled. */
1979 XPROCESS (process)->pid = -1;
1981 BLOCK_INPUT;
1984 /* child_setup must clobber environ on systems with true vfork.
1985 Protect it from permanent change. */
1986 char **save_environ = environ;
1988 current_dir = ENCODE_FILE (current_dir);
1990 #ifndef WINDOWSNT
1991 pid = vfork ();
1992 if (pid == 0)
1993 #endif /* not WINDOWSNT */
1995 int xforkin = forkin;
1996 int xforkout = forkout;
1998 #if 0 /* This was probably a mistake--it duplicates code later on,
1999 but fails to handle all the cases. */
2000 /* Make sure SIGCHLD is not blocked in the child. */
2001 sigsetmask (SIGEMPTYMASK);
2002 #endif
2004 /* Make the pty be the controlling terminal of the process. */
2005 #ifdef HAVE_PTYS
2006 /* First, disconnect its current controlling terminal. */
2007 #ifdef HAVE_SETSID
2008 /* We tried doing setsid only if pty_flag, but it caused
2009 process_set_signal to fail on SGI when using a pipe. */
2010 setsid ();
2011 /* Make the pty's terminal the controlling terminal. */
2012 if (pty_flag)
2014 #ifdef TIOCSCTTY
2015 /* We ignore the return value
2016 because faith@cs.unc.edu says that is necessary on Linux. */
2017 ioctl (xforkin, TIOCSCTTY, 0);
2018 #endif
2020 #else /* not HAVE_SETSID */
2021 #ifdef USG
2022 /* It's very important to call setpgrp here and no time
2023 afterwards. Otherwise, we lose our controlling tty which
2024 is set when we open the pty. */
2025 setpgrp ();
2026 #endif /* USG */
2027 #endif /* not HAVE_SETSID */
2028 #if defined (HAVE_TERMIOS) && defined (LDISC1)
2029 if (pty_flag && xforkin >= 0)
2031 struct termios t;
2032 tcgetattr (xforkin, &t);
2033 t.c_lflag = LDISC1;
2034 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
2035 emacs_write (1, "create_process/tcsetattr LDISC1 failed\n", 39);
2037 #else
2038 #if defined (NTTYDISC) && defined (TIOCSETD)
2039 if (pty_flag && xforkin >= 0)
2041 /* Use new line discipline. */
2042 int ldisc = NTTYDISC;
2043 ioctl (xforkin, TIOCSETD, &ldisc);
2045 #endif
2046 #endif
2047 #ifdef TIOCNOTTY
2048 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
2049 can do TIOCSPGRP only to the process's controlling tty. */
2050 if (pty_flag)
2052 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
2053 I can't test it since I don't have 4.3. */
2054 int j = emacs_open ("/dev/tty", O_RDWR, 0);
2055 ioctl (j, TIOCNOTTY, 0);
2056 emacs_close (j);
2057 #ifndef USG
2058 /* In order to get a controlling terminal on some versions
2059 of BSD, it is necessary to put the process in pgrp 0
2060 before it opens the terminal. */
2061 #ifdef HAVE_SETPGID
2062 setpgid (0, 0);
2063 #else
2064 setpgrp (0, 0);
2065 #endif
2066 #endif
2068 #endif /* TIOCNOTTY */
2070 #if !defined (RTU) && !defined (UNIPLUS) && !defined (DONT_REOPEN_PTY)
2071 /*** There is a suggestion that this ought to be a
2072 conditional on TIOCSPGRP,
2073 or !(defined (HAVE_SETSID) && defined (TIOCSCTTY)).
2074 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
2075 that system does seem to need this code, even though
2076 both HAVE_SETSID and TIOCSCTTY are defined. */
2077 /* Now close the pty (if we had it open) and reopen it.
2078 This makes the pty the controlling terminal of the subprocess. */
2079 if (pty_flag)
2081 #ifdef SET_CHILD_PTY_PGRP
2082 int pgrp = getpid ();
2083 #endif
2085 /* I wonder if emacs_close (emacs_open (pty_name, ...))
2086 would work? */
2087 if (xforkin >= 0)
2088 emacs_close (xforkin);
2089 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
2091 if (xforkin < 0)
2093 emacs_write (1, "Couldn't open the pty terminal ", 31);
2094 emacs_write (1, pty_name, strlen (pty_name));
2095 emacs_write (1, "\n", 1);
2096 _exit (1);
2099 #ifdef SET_CHILD_PTY_PGRP
2100 ioctl (xforkin, TIOCSPGRP, &pgrp);
2101 ioctl (xforkout, TIOCSPGRP, &pgrp);
2102 #endif
2104 #endif /* not UNIPLUS and not RTU and not DONT_REOPEN_PTY */
2106 #ifdef SETUP_SLAVE_PTY
2107 if (pty_flag)
2109 SETUP_SLAVE_PTY;
2111 #endif /* SETUP_SLAVE_PTY */
2112 #ifdef AIX
2113 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
2114 Now reenable it in the child, so it will die when we want it to. */
2115 if (pty_flag)
2116 signal (SIGHUP, SIG_DFL);
2117 #endif
2118 #endif /* HAVE_PTYS */
2120 signal (SIGINT, SIG_DFL);
2121 signal (SIGQUIT, SIG_DFL);
2123 /* Stop blocking signals in the child. */
2124 #ifdef POSIX_SIGNALS
2125 sigprocmask (SIG_SETMASK, &procmask, 0);
2126 #else /* !POSIX_SIGNALS */
2127 #ifdef SIGCHLD
2128 #ifdef BSD4_1
2129 sigrelse (SIGCHLD);
2130 #else /* not BSD4_1 */
2131 #if defined (BSD_SYSTEM) || defined (UNIPLUS) || defined (HPUX)
2132 sigsetmask (SIGEMPTYMASK);
2133 #else /* ordinary USG */
2134 #if 0
2135 signal (SIGCHLD, sigchld);
2136 #endif
2137 #endif /* ordinary USG */
2138 #endif /* not BSD4_1 */
2139 #endif /* SIGCHLD */
2140 #endif /* !POSIX_SIGNALS */
2142 #if !defined (RTU) && !defined (UNIPLUS) && !defined (DONT_REOPEN_PTY)
2143 if (pty_flag)
2144 child_setup_tty (xforkout);
2145 #endif /* not RTU and not UNIPLUS and not DONT_REOPEN_PTY */
2146 #ifdef WINDOWSNT
2147 pid = child_setup (xforkin, xforkout, xforkout,
2148 new_argv, 1, current_dir);
2149 #else /* not WINDOWSNT */
2150 child_setup (xforkin, xforkout, xforkout,
2151 new_argv, 1, current_dir);
2152 #endif /* not WINDOWSNT */
2154 environ = save_environ;
2157 UNBLOCK_INPUT;
2159 /* This runs in the Emacs process. */
2160 if (pid < 0)
2162 if (forkin >= 0)
2163 emacs_close (forkin);
2164 if (forkin != forkout && forkout >= 0)
2165 emacs_close (forkout);
2167 else
2169 /* vfork succeeded. */
2170 XPROCESS (process)->pid = pid;
2172 #ifdef WINDOWSNT
2173 register_child (pid, inchannel);
2174 #endif /* WINDOWSNT */
2176 /* If the subfork execv fails, and it exits,
2177 this close hangs. I don't know why.
2178 So have an interrupt jar it loose. */
2180 struct atimer *timer;
2181 EMACS_TIME offset;
2183 stop_polling ();
2184 EMACS_SET_SECS_USECS (offset, 1, 0);
2185 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
2187 if (forkin >= 0)
2188 emacs_close (forkin);
2190 cancel_atimer (timer);
2191 start_polling ();
2194 if (forkin != forkout && forkout >= 0)
2195 emacs_close (forkout);
2197 #ifdef HAVE_PTYS
2198 if (pty_flag)
2199 XPROCESS (process)->tty_name = build_string (pty_name);
2200 else
2201 #endif
2202 XPROCESS (process)->tty_name = Qnil;
2205 /* Restore the signal state whether vfork succeeded or not.
2206 (We will signal an error, below, if it failed.) */
2207 #ifdef POSIX_SIGNALS
2208 #ifdef HAVE_WORKING_VFORK
2209 /* Restore the parent's signal handlers. */
2210 sigaction (SIGINT, &sigint_action, 0);
2211 sigaction (SIGQUIT, &sigquit_action, 0);
2212 #ifdef AIX
2213 sigaction (SIGHUP, &sighup_action, 0);
2214 #endif
2215 #endif /* HAVE_WORKING_VFORK */
2216 /* Stop blocking signals in the parent. */
2217 sigprocmask (SIG_SETMASK, &procmask, 0);
2218 #else /* !POSIX_SIGNALS */
2219 #ifdef SIGCHLD
2220 #ifdef BSD4_1
2221 sigrelse (SIGCHLD);
2222 #else /* not BSD4_1 */
2223 #if defined (BSD_SYSTEM) || defined (UNIPLUS) || defined (HPUX)
2224 sigsetmask (SIGEMPTYMASK);
2225 #else /* ordinary USG */
2226 #if 0
2227 signal (SIGCHLD, sigchld);
2228 /* Now really handle any of these signals
2229 that came in during this function. */
2230 if (sigchld_deferred)
2231 kill (getpid (), SIGCHLD);
2232 #endif
2233 #endif /* ordinary USG */
2234 #endif /* not BSD4_1 */
2235 #endif /* SIGCHLD */
2236 #endif /* !POSIX_SIGNALS */
2238 /* Now generate the error if vfork failed. */
2239 if (pid < 0)
2240 report_file_error ("Doing vfork", Qnil);
2242 #endif /* not VMS */
2245 #ifdef HAVE_SOCKETS
2247 /* Convert an internal struct sockaddr to a lisp object (vector or string).
2248 The address family of sa is not included in the result. */
2250 static Lisp_Object
2251 conv_sockaddr_to_lisp (sa, len)
2252 struct sockaddr *sa;
2253 int len;
2255 Lisp_Object address;
2256 int i;
2257 unsigned char *cp;
2258 register struct Lisp_Vector *p;
2260 switch (sa->sa_family)
2262 case AF_INET:
2264 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2265 len = sizeof (sin->sin_addr) + 1;
2266 address = Fmake_vector (make_number (len), Qnil);
2267 p = XVECTOR (address);
2268 p->contents[--len] = make_number (ntohs (sin->sin_port));
2269 cp = (unsigned char *)&sin->sin_addr;
2270 break;
2272 #ifdef AF_INET6
2273 case AF_INET6:
2275 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2276 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2277 len = sizeof (sin6->sin6_addr)/2 + 1;
2278 address = Fmake_vector (make_number (len), Qnil);
2279 p = XVECTOR (address);
2280 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2281 for (i = 0; i < len; i++)
2282 p->contents[i] = make_number (ntohs (ip6[i]));
2283 return address;
2285 #endif
2286 #ifdef HAVE_LOCAL_SOCKETS
2287 case AF_LOCAL:
2289 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2290 for (i = 0; i < sizeof (sockun->sun_path); i++)
2291 if (sockun->sun_path[i] == 0)
2292 break;
2293 return make_unibyte_string (sockun->sun_path, i);
2295 #endif
2296 default:
2297 len -= sizeof (sa->sa_family);
2298 address = Fcons (make_number (sa->sa_family),
2299 Fmake_vector (make_number (len), Qnil));
2300 p = XVECTOR (XCDR (address));
2301 cp = (unsigned char *) sa + sizeof (sa->sa_family);
2302 break;
2305 i = 0;
2306 while (i < len)
2307 p->contents[i++] = make_number (*cp++);
2309 return address;
2313 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2315 static int
2316 get_lisp_to_sockaddr_size (address, familyp)
2317 Lisp_Object address;
2318 int *familyp;
2320 register struct Lisp_Vector *p;
2322 if (VECTORP (address))
2324 p = XVECTOR (address);
2325 if (p->size == 5)
2327 *familyp = AF_INET;
2328 return sizeof (struct sockaddr_in);
2330 #ifdef AF_INET6
2331 else if (p->size == 9)
2333 *familyp = AF_INET6;
2334 return sizeof (struct sockaddr_in6);
2336 #endif
2338 #ifdef HAVE_LOCAL_SOCKETS
2339 else if (STRINGP (address))
2341 *familyp = AF_LOCAL;
2342 return sizeof (struct sockaddr_un);
2344 #endif
2345 else if (CONSP (address) && INTEGERP (XCAR (address)) && VECTORP (XCDR (address)))
2347 struct sockaddr *sa;
2348 *familyp = XINT (XCAR (address));
2349 p = XVECTOR (XCDR (address));
2350 return p->size + sizeof (sa->sa_family);
2352 return 0;
2355 /* Convert an address object (vector or string) to an internal sockaddr.
2357 The address format has been basically validated by
2358 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2359 it could have come from user data. So if FAMILY is not valid,
2360 we return after zeroing *SA. */
2362 static void
2363 conv_lisp_to_sockaddr (family, address, sa, len)
2364 int family;
2365 Lisp_Object address;
2366 struct sockaddr *sa;
2367 int len;
2369 register struct Lisp_Vector *p;
2370 register unsigned char *cp = NULL;
2371 register int i;
2373 bzero (sa, len);
2375 if (VECTORP (address))
2377 p = XVECTOR (address);
2378 if (family == AF_INET)
2380 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2381 len = sizeof (sin->sin_addr) + 1;
2382 i = XINT (p->contents[--len]);
2383 sin->sin_port = htons (i);
2384 cp = (unsigned char *)&sin->sin_addr;
2385 sa->sa_family = family;
2387 #ifdef AF_INET6
2388 else if (family == AF_INET6)
2390 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2391 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2392 len = sizeof (sin6->sin6_addr) + 1;
2393 i = XINT (p->contents[--len]);
2394 sin6->sin6_port = htons (i);
2395 for (i = 0; i < len; i++)
2396 if (INTEGERP (p->contents[i]))
2398 int j = XFASTINT (p->contents[i]) & 0xffff;
2399 ip6[i] = ntohs (j);
2401 sa->sa_family = family;
2403 #endif
2404 return;
2406 else if (STRINGP (address))
2408 #ifdef HAVE_LOCAL_SOCKETS
2409 if (family == AF_LOCAL)
2411 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2412 cp = SDATA (address);
2413 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2414 sockun->sun_path[i] = *cp++;
2415 sa->sa_family = family;
2417 #endif
2418 return;
2420 else
2422 p = XVECTOR (XCDR (address));
2423 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2426 for (i = 0; i < len; i++)
2427 if (INTEGERP (p->contents[i]))
2428 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2431 #ifdef DATAGRAM_SOCKETS
2432 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2433 1, 1, 0,
2434 doc: /* Get the current datagram address associated with PROCESS. */)
2435 (process)
2436 Lisp_Object process;
2438 int channel;
2440 CHECK_PROCESS (process);
2442 if (!DATAGRAM_CONN_P (process))
2443 return Qnil;
2445 channel = XINT (XPROCESS (process)->infd);
2446 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2447 datagram_address[channel].len);
2450 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2451 2, 2, 0,
2452 doc: /* Set the datagram address for PROCESS to ADDRESS.
2453 Returns nil upon error setting address, ADDRESS otherwise. */)
2454 (process, address)
2455 Lisp_Object process, address;
2457 int channel;
2458 int family, len;
2460 CHECK_PROCESS (process);
2462 if (!DATAGRAM_CONN_P (process))
2463 return Qnil;
2465 channel = XINT (XPROCESS (process)->infd);
2467 len = get_lisp_to_sockaddr_size (address, &family);
2468 if (datagram_address[channel].len != len)
2469 return Qnil;
2470 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2471 return address;
2473 #endif
2476 static struct socket_options {
2477 /* The name of this option. Should be lowercase version of option
2478 name without SO_ prefix. */
2479 char *name;
2480 /* Option level SOL_... */
2481 int optlevel;
2482 /* Option number SO_... */
2483 int optnum;
2484 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2485 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2486 } socket_options[] =
2488 #ifdef SO_BINDTODEVICE
2489 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2490 #endif
2491 #ifdef SO_BROADCAST
2492 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2493 #endif
2494 #ifdef SO_DONTROUTE
2495 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2496 #endif
2497 #ifdef SO_KEEPALIVE
2498 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2499 #endif
2500 #ifdef SO_LINGER
2501 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2502 #endif
2503 #ifdef SO_OOBINLINE
2504 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2505 #endif
2506 #ifdef SO_PRIORITY
2507 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2508 #endif
2509 #ifdef SO_REUSEADDR
2510 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2511 #endif
2512 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2515 /* Set option OPT to value VAL on socket S.
2517 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2518 Signals an error if setting a known option fails.
2521 static int
2522 set_socket_option (s, opt, val)
2523 int s;
2524 Lisp_Object opt, val;
2526 char *name;
2527 struct socket_options *sopt;
2528 int ret = 0;
2530 CHECK_SYMBOL (opt);
2532 name = (char *) SDATA (SYMBOL_NAME (opt));
2533 for (sopt = socket_options; sopt->name; sopt++)
2534 if (strcmp (name, sopt->name) == 0)
2535 break;
2537 switch (sopt->opttype)
2539 case SOPT_BOOL:
2541 int optval;
2542 optval = NILP (val) ? 0 : 1;
2543 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2544 &optval, sizeof (optval));
2545 break;
2548 case SOPT_INT:
2550 int optval;
2551 if (INTEGERP (val))
2552 optval = XINT (val);
2553 else
2554 error ("Bad option value for %s", name);
2555 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2556 &optval, sizeof (optval));
2557 break;
2560 #ifdef SO_BINDTODEVICE
2561 case SOPT_IFNAME:
2563 char devname[IFNAMSIZ+1];
2565 /* This is broken, at least in the Linux 2.4 kernel.
2566 To unbind, the arg must be a zero integer, not the empty string.
2567 This should work on all systems. KFS. 2003-09-23. */
2568 bzero (devname, sizeof devname);
2569 if (STRINGP (val))
2571 char *arg = (char *) SDATA (val);
2572 int len = min (strlen (arg), IFNAMSIZ);
2573 bcopy (arg, devname, len);
2575 else if (!NILP (val))
2576 error ("Bad option value for %s", name);
2577 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2578 devname, IFNAMSIZ);
2579 break;
2581 #endif
2583 #ifdef SO_LINGER
2584 case SOPT_LINGER:
2586 struct linger linger;
2588 linger.l_onoff = 1;
2589 linger.l_linger = 0;
2590 if (INTEGERP (val))
2591 linger.l_linger = XINT (val);
2592 else
2593 linger.l_onoff = NILP (val) ? 0 : 1;
2594 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2595 &linger, sizeof (linger));
2596 break;
2598 #endif
2600 default:
2601 return 0;
2604 if (ret < 0)
2605 report_file_error ("Cannot set network option",
2606 Fcons (opt, Fcons (val, Qnil)));
2607 return (1 << sopt->optbit);
2611 DEFUN ("set-network-process-option",
2612 Fset_network_process_option, Sset_network_process_option,
2613 3, 4, 0,
2614 doc: /* For network process PROCESS set option OPTION to value VALUE.
2615 See `make-network-process' for a list of options and values.
2616 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2617 OPTION is not a supported option, return nil instead; otherwise return t. */)
2618 (process, option, value, no_error)
2619 Lisp_Object process, option, value;
2620 Lisp_Object no_error;
2622 int s;
2623 struct Lisp_Process *p;
2625 CHECK_PROCESS (process);
2626 p = XPROCESS (process);
2627 if (!NETCONN1_P (p))
2628 error ("Process is not a network process");
2630 s = XINT (p->infd);
2631 if (s < 0)
2632 error ("Process is not running");
2634 if (set_socket_option (s, option, value))
2636 p->childp = Fplist_put (p->childp, option, value);
2637 return Qt;
2640 if (NILP (no_error))
2641 error ("Unknown or unsupported option");
2643 return Qnil;
2647 /* A version of request_sigio suitable for a record_unwind_protect. */
2649 static Lisp_Object
2650 unwind_request_sigio (dummy)
2651 Lisp_Object dummy;
2653 if (interrupt_input)
2654 request_sigio ();
2655 return Qnil;
2658 /* Create a network stream/datagram client/server process. Treated
2659 exactly like a normal process when reading and writing. Primary
2660 differences are in status display and process deletion. A network
2661 connection has no PID; you cannot signal it. All you can do is
2662 stop/continue it and deactivate/close it via delete-process */
2664 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2665 0, MANY, 0,
2666 doc: /* Create and return a network server or client process.
2668 In Emacs, network connections are represented by process objects, so
2669 input and output work as for subprocesses and `delete-process' closes
2670 a network connection. However, a network process has no process id,
2671 it cannot be signaled, and the status codes are different from normal
2672 processes.
2674 Arguments are specified as keyword/argument pairs. The following
2675 arguments are defined:
2677 :name NAME -- NAME is name for process. It is modified if necessary
2678 to make it unique.
2680 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2681 with the process. Process output goes at end of that buffer, unless
2682 you specify an output stream or filter function to handle the output.
2683 BUFFER may be also nil, meaning that this process is not associated
2684 with any buffer.
2686 :host HOST -- HOST is name of the host to connect to, or its IP
2687 address. The symbol `local' specifies the local host. If specified
2688 for a server process, it must be a valid name or address for the local
2689 host, and only clients connecting to that address will be accepted.
2691 :service SERVICE -- SERVICE is name of the service desired, or an
2692 integer specifying a port number to connect to. If SERVICE is t,
2693 a random port number is selected for the server.
2695 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2696 stream type connection, `datagram' creates a datagram type connection.
2698 :family FAMILY -- FAMILY is the address (and protocol) family for the
2699 service specified by HOST and SERVICE. The default (nil) is to use
2700 whatever address family (IPv4 or IPv6) that is defined for the host
2701 and port number specified by HOST and SERVICE. Other address families
2702 supported are:
2703 local -- for a local (i.e. UNIX) address specified by SERVICE.
2704 ipv4 -- use IPv4 address family only.
2705 ipv6 -- use IPv6 address family only.
2707 :local ADDRESS -- ADDRESS is the local address used for the connection.
2708 This parameter is ignored when opening a client process. When specified
2709 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2711 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2712 connection. This parameter is ignored when opening a stream server
2713 process. For a datagram server process, it specifies the initial
2714 setting of the remote datagram address. When specified for a client
2715 process, the FAMILY, HOST, and SERVICE args are ignored.
2717 The format of ADDRESS depends on the address family:
2718 - An IPv4 address is represented as an vector of integers [A B C D P]
2719 corresponding to numeric IP address A.B.C.D and port number P.
2720 - A local address is represented as a string with the address in the
2721 local address space.
2722 - An "unsupported family" address is represented by a cons (F . AV)
2723 where F is the family number and AV is a vector containing the socket
2724 address data with one element per address data byte. Do not rely on
2725 this format in portable code, as it may depend on implementation
2726 defined constants, data sizes, and data structure alignment.
2728 :coding CODING -- If CODING is a symbol, it specifies the coding
2729 system used for both reading and writing for this process. If CODING
2730 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2731 ENCODING is used for writing.
2733 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2734 return without waiting for the connection to complete; instead, the
2735 sentinel function will be called with second arg matching "open" (if
2736 successful) or "failed" when the connect completes. Default is to use
2737 a blocking connect (i.e. wait) for stream type connections.
2739 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2740 running when Emacs is exited.
2742 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2743 In the stopped state, a server process does not accept new
2744 connections, and a client process does not handle incoming traffic.
2745 The stopped state is cleared by `continue-process' and set by
2746 `stop-process'.
2748 :filter FILTER -- Install FILTER as the process filter.
2750 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2751 process filter are multibyte, otherwise they are unibyte.
2752 If this keyword is not specified, the strings are multibyte iff
2753 `default-enable-multibyte-characters' is non-nil.
2755 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2757 :log LOG -- Install LOG as the server process log function. This
2758 function is called when the server accepts a network connection from a
2759 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2760 is the server process, CLIENT is the new process for the connection,
2761 and MESSAGE is a string.
2763 :plist PLIST -- Install PLIST as the new process' initial plist.
2765 :server QLEN -- if QLEN is non-nil, create a server process for the
2766 specified FAMILY, SERVICE, and connection type (stream or datagram).
2767 If QLEN is an integer, it is used as the max. length of the server's
2768 pending connection queue (also known as the backlog); the default
2769 queue length is 5. Default is to create a client process.
2771 The following network options can be specified for this connection:
2773 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2774 :dontroute BOOL -- Only send to directly connected hosts.
2775 :keepalive BOOL -- Send keep-alive messages on network stream.
2776 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2777 :oobinline BOOL -- Place out-of-band data in receive data stream.
2778 :priority INT -- Set protocol defined priority for sent packets.
2779 :reuseaddr BOOL -- Allow reusing a recently used local address
2780 (this is allowed by default for a server process).
2781 :bindtodevice NAME -- bind to interface NAME. Using this may require
2782 special privileges on some systems.
2784 Consult the relevant system programmer's manual pages for more
2785 information on using these options.
2788 A server process will listen for and accept connections from clients.
2789 When a client connection is accepted, a new network process is created
2790 for the connection with the following parameters:
2792 - The client's process name is constructed by concatenating the server
2793 process' NAME and a client identification string.
2794 - If the FILTER argument is non-nil, the client process will not get a
2795 separate process buffer; otherwise, the client's process buffer is a newly
2796 created buffer named after the server process' BUFFER name or process
2797 NAME concatenated with the client identification string.
2798 - The connection type and the process filter and sentinel parameters are
2799 inherited from the server process' TYPE, FILTER and SENTINEL.
2800 - The client process' contact info is set according to the client's
2801 addressing information (typically an IP address and a port number).
2802 - The client process' plist is initialized from the server's plist.
2804 Notice that the FILTER and SENTINEL args are never used directly by
2805 the server process. Also, the BUFFER argument is not used directly by
2806 the server process, but via the optional :log function, accepted (and
2807 failed) connections may be logged in the server process' buffer.
2809 The original argument list, modified with the actual connection
2810 information, is available via the `process-contact' function.
2812 usage: (make-network-process &rest ARGS) */)
2813 (nargs, args)
2814 int nargs;
2815 Lisp_Object *args;
2817 Lisp_Object proc;
2818 Lisp_Object contact;
2819 struct Lisp_Process *p;
2820 #ifdef HAVE_GETADDRINFO
2821 struct addrinfo ai, *res, *lres;
2822 struct addrinfo hints;
2823 char *portstring, portbuf[128];
2824 #else /* HAVE_GETADDRINFO */
2825 struct _emacs_addrinfo
2827 int ai_family;
2828 int ai_socktype;
2829 int ai_protocol;
2830 int ai_addrlen;
2831 struct sockaddr *ai_addr;
2832 struct _emacs_addrinfo *ai_next;
2833 } ai, *res, *lres;
2834 #endif /* HAVE_GETADDRINFO */
2835 struct sockaddr_in address_in;
2836 #ifdef HAVE_LOCAL_SOCKETS
2837 struct sockaddr_un address_un;
2838 #endif
2839 int port;
2840 int ret = 0;
2841 int xerrno = 0;
2842 int s = -1, outch, inch;
2843 struct gcpro gcpro1;
2844 int count = SPECPDL_INDEX ();
2845 int count1;
2846 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2847 Lisp_Object tem;
2848 Lisp_Object name, buffer, host, service, address;
2849 Lisp_Object filter, sentinel;
2850 int is_non_blocking_client = 0;
2851 int is_server = 0, backlog = 5;
2852 int socktype;
2853 int family = -1;
2855 if (nargs == 0)
2856 return Qnil;
2858 /* Save arguments for process-contact and clone-process. */
2859 contact = Flist (nargs, args);
2860 GCPRO1 (contact);
2862 #ifdef WINDOWSNT
2863 /* Ensure socket support is loaded if available. */
2864 init_winsock (TRUE);
2865 #endif
2867 /* :type TYPE (nil: stream, datagram */
2868 tem = Fplist_get (contact, QCtype);
2869 if (NILP (tem))
2870 socktype = SOCK_STREAM;
2871 #ifdef DATAGRAM_SOCKETS
2872 else if (EQ (tem, Qdatagram))
2873 socktype = SOCK_DGRAM;
2874 #endif
2875 else
2876 error ("Unsupported connection type");
2878 /* :server BOOL */
2879 tem = Fplist_get (contact, QCserver);
2880 if (!NILP (tem))
2882 /* Don't support network sockets when non-blocking mode is
2883 not available, since a blocked Emacs is not useful. */
2884 #if defined(TERM) || (!defined(O_NONBLOCK) && !defined(O_NDELAY))
2885 error ("Network servers not supported");
2886 #else
2887 is_server = 1;
2888 if (INTEGERP (tem))
2889 backlog = XINT (tem);
2890 #endif
2893 /* Make QCaddress an alias for :local (server) or :remote (client). */
2894 QCaddress = is_server ? QClocal : QCremote;
2896 /* :wait BOOL */
2897 if (!is_server && socktype == SOCK_STREAM
2898 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2900 #ifndef NON_BLOCKING_CONNECT
2901 error ("Non-blocking connect not supported");
2902 #else
2903 is_non_blocking_client = 1;
2904 #endif
2907 name = Fplist_get (contact, QCname);
2908 buffer = Fplist_get (contact, QCbuffer);
2909 filter = Fplist_get (contact, QCfilter);
2910 sentinel = Fplist_get (contact, QCsentinel);
2912 CHECK_STRING (name);
2914 #ifdef TERM
2915 /* Let's handle TERM before things get complicated ... */
2916 host = Fplist_get (contact, QChost);
2917 CHECK_STRING (host);
2919 service = Fplist_get (contact, QCservice);
2920 if (INTEGERP (service))
2921 port = htons ((unsigned short) XINT (service));
2922 else
2924 struct servent *svc_info;
2925 CHECK_STRING (service);
2926 svc_info = getservbyname (SDATA (service), "tcp");
2927 if (svc_info == 0)
2928 error ("Unknown service: %s", SDATA (service));
2929 port = svc_info->s_port;
2932 s = connect_server (0);
2933 if (s < 0)
2934 report_file_error ("error creating socket", Fcons (name, Qnil));
2935 send_command (s, C_PORT, 0, "%s:%d", SDATA (host), ntohs (port));
2936 send_command (s, C_DUMB, 1, 0);
2938 #else /* not TERM */
2940 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2941 ai.ai_socktype = socktype;
2942 ai.ai_protocol = 0;
2943 ai.ai_next = NULL;
2944 res = &ai;
2946 /* :local ADDRESS or :remote ADDRESS */
2947 address = Fplist_get (contact, QCaddress);
2948 if (!NILP (address))
2950 host = service = Qnil;
2952 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2953 error ("Malformed :address");
2954 ai.ai_family = family;
2955 ai.ai_addr = alloca (ai.ai_addrlen);
2956 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2957 goto open_socket;
2960 /* :family FAMILY -- nil (for Inet), local, or integer. */
2961 tem = Fplist_get (contact, QCfamily);
2962 if (NILP (tem))
2964 #if defined(HAVE_GETADDRINFO) && defined(AF_INET6)
2965 family = AF_UNSPEC;
2966 #else
2967 family = AF_INET;
2968 #endif
2970 #ifdef HAVE_LOCAL_SOCKETS
2971 else if (EQ (tem, Qlocal))
2972 family = AF_LOCAL;
2973 #endif
2974 #ifdef AF_INET6
2975 else if (EQ (tem, Qipv6))
2976 family = AF_INET6;
2977 #endif
2978 else if (EQ (tem, Qipv4))
2979 family = AF_INET;
2980 else if (INTEGERP (tem))
2981 family = XINT (tem);
2982 else
2983 error ("Unknown address family");
2985 ai.ai_family = family;
2987 /* :service SERVICE -- string, integer (port number), or t (random port). */
2988 service = Fplist_get (contact, QCservice);
2990 #ifdef HAVE_LOCAL_SOCKETS
2991 if (family == AF_LOCAL)
2993 /* Host is not used. */
2994 host = Qnil;
2995 CHECK_STRING (service);
2996 bzero (&address_un, sizeof address_un);
2997 address_un.sun_family = AF_LOCAL;
2998 strncpy (address_un.sun_path, SDATA (service), sizeof address_un.sun_path);
2999 ai.ai_addr = (struct sockaddr *) &address_un;
3000 ai.ai_addrlen = sizeof address_un;
3001 goto open_socket;
3003 #endif
3005 /* :host HOST -- hostname, ip address, or 'local for localhost. */
3006 host = Fplist_get (contact, QChost);
3007 if (!NILP (host))
3009 if (EQ (host, Qlocal))
3010 host = build_string ("localhost");
3011 CHECK_STRING (host);
3014 /* Slow down polling to every ten seconds.
3015 Some kernels have a bug which causes retrying connect to fail
3016 after a connect. Polling can interfere with gethostbyname too. */
3017 #ifdef POLL_FOR_INPUT
3018 if (socktype == SOCK_STREAM)
3020 record_unwind_protect (unwind_stop_other_atimers, Qnil);
3021 bind_polling_period (10);
3023 #endif
3025 #ifdef HAVE_GETADDRINFO
3026 /* If we have a host, use getaddrinfo to resolve both host and service.
3027 Otherwise, use getservbyname to lookup the service. */
3028 if (!NILP (host))
3031 /* SERVICE can either be a string or int.
3032 Convert to a C string for later use by getaddrinfo. */
3033 if (EQ (service, Qt))
3034 portstring = "0";
3035 else if (INTEGERP (service))
3037 sprintf (portbuf, "%ld", (long) XINT (service));
3038 portstring = portbuf;
3040 else
3042 CHECK_STRING (service);
3043 portstring = SDATA (service);
3046 immediate_quit = 1;
3047 QUIT;
3048 memset (&hints, 0, sizeof (hints));
3049 hints.ai_flags = 0;
3050 hints.ai_family = family;
3051 hints.ai_socktype = socktype;
3052 hints.ai_protocol = 0;
3053 ret = getaddrinfo (SDATA (host), portstring, &hints, &res);
3054 if (ret)
3055 #ifdef HAVE_GAI_STRERROR
3056 error ("%s/%s %s", SDATA (host), portstring, gai_strerror(ret));
3057 #else
3058 error ("%s/%s getaddrinfo error %d", SDATA (host), portstring, ret);
3059 #endif
3060 immediate_quit = 0;
3062 goto open_socket;
3064 #endif /* HAVE_GETADDRINFO */
3066 /* We end up here if getaddrinfo is not defined, or in case no hostname
3067 has been specified (e.g. for a local server process). */
3069 if (EQ (service, Qt))
3070 port = 0;
3071 else if (INTEGERP (service))
3072 port = htons ((unsigned short) XINT (service));
3073 else
3075 struct servent *svc_info;
3076 CHECK_STRING (service);
3077 svc_info = getservbyname (SDATA (service),
3078 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3079 if (svc_info == 0)
3080 error ("Unknown service: %s", SDATA (service));
3081 port = svc_info->s_port;
3084 bzero (&address_in, sizeof address_in);
3085 address_in.sin_family = family;
3086 address_in.sin_addr.s_addr = INADDR_ANY;
3087 address_in.sin_port = port;
3089 #ifndef HAVE_GETADDRINFO
3090 if (!NILP (host))
3092 struct hostent *host_info_ptr;
3094 /* gethostbyname may fail with TRY_AGAIN, but we don't honour that,
3095 as it may `hang' Emacs for a very long time. */
3096 immediate_quit = 1;
3097 QUIT;
3098 host_info_ptr = gethostbyname (SDATA (host));
3099 immediate_quit = 0;
3101 if (host_info_ptr)
3103 bcopy (host_info_ptr->h_addr, (char *) &address_in.sin_addr,
3104 host_info_ptr->h_length);
3105 family = host_info_ptr->h_addrtype;
3106 address_in.sin_family = family;
3108 else
3109 /* Attempt to interpret host as numeric inet address */
3111 IN_ADDR numeric_addr;
3112 numeric_addr = inet_addr ((char *) SDATA (host));
3113 if (NUMERIC_ADDR_ERROR)
3114 error ("Unknown host \"%s\"", SDATA (host));
3116 bcopy ((char *)&numeric_addr, (char *) &address_in.sin_addr,
3117 sizeof (address_in.sin_addr));
3121 #endif /* not HAVE_GETADDRINFO */
3123 ai.ai_family = family;
3124 ai.ai_addr = (struct sockaddr *) &address_in;
3125 ai.ai_addrlen = sizeof address_in;
3127 open_socket:
3129 /* Kernel bugs (on Ultrix at least) cause lossage (not just EINTR)
3130 when connect is interrupted. So let's not let it get interrupted.
3131 Note we do not turn off polling, because polling is only used
3132 when not interrupt_input, and thus not normally used on the systems
3133 which have this bug. On systems which use polling, there's no way
3134 to quit if polling is turned off. */
3135 if (interrupt_input
3136 && !is_server && socktype == SOCK_STREAM)
3138 /* Comment from KFS: The original open-network-stream code
3139 didn't unwind protect this, but it seems like the proper
3140 thing to do. In any case, I don't see how it could harm to
3141 do this -- and it makes cleanup (using unbind_to) easier. */
3142 record_unwind_protect (unwind_request_sigio, Qnil);
3143 unrequest_sigio ();
3146 /* Do this in case we never enter the for-loop below. */
3147 count1 = SPECPDL_INDEX ();
3148 s = -1;
3150 for (lres = res; lres; lres = lres->ai_next)
3152 int optn, optbits;
3154 retry_connect:
3156 s = socket (lres->ai_family, lres->ai_socktype, lres->ai_protocol);
3157 if (s < 0)
3159 xerrno = errno;
3160 continue;
3163 #ifdef DATAGRAM_SOCKETS
3164 if (!is_server && socktype == SOCK_DGRAM)
3165 break;
3166 #endif /* DATAGRAM_SOCKETS */
3168 #ifdef NON_BLOCKING_CONNECT
3169 if (is_non_blocking_client)
3171 #ifdef O_NONBLOCK
3172 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3173 #else
3174 ret = fcntl (s, F_SETFL, O_NDELAY);
3175 #endif
3176 if (ret < 0)
3178 xerrno = errno;
3179 emacs_close (s);
3180 s = -1;
3181 continue;
3184 #endif
3186 /* Make us close S if quit. */
3187 record_unwind_protect (close_file_unwind, make_number (s));
3189 /* Parse network options in the arg list.
3190 We simply ignore anything which isn't a known option (including other keywords).
3191 An error is signalled if setting a known option fails. */
3192 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3193 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3195 if (is_server)
3197 /* Configure as a server socket. */
3199 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3200 explicit :reuseaddr key to override this. */
3201 #ifdef HAVE_LOCAL_SOCKETS
3202 if (family != AF_LOCAL)
3203 #endif
3204 if (!(optbits & (1 << OPIX_REUSEADDR)))
3206 int optval = 1;
3207 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3208 report_file_error ("Cannot set reuse option on server socket", Qnil);
3211 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3212 report_file_error ("Cannot bind server socket", Qnil);
3214 #ifdef HAVE_GETSOCKNAME
3215 if (EQ (service, Qt))
3217 struct sockaddr_in sa1;
3218 int len1 = sizeof (sa1);
3219 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3221 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3222 service = make_number (ntohs (sa1.sin_port));
3223 contact = Fplist_put (contact, QCservice, service);
3226 #endif
3228 if (socktype == SOCK_STREAM && listen (s, backlog))
3229 report_file_error ("Cannot listen on server socket", Qnil);
3231 break;
3234 immediate_quit = 1;
3235 QUIT;
3237 /* This turns off all alarm-based interrupts; the
3238 bind_polling_period call above doesn't always turn all the
3239 short-interval ones off, especially if interrupt_input is
3240 set.
3242 It'd be nice to be able to control the connect timeout
3243 though. Would non-blocking connect calls be portable?
3245 This used to be conditioned by HAVE_GETADDRINFO. Why? */
3247 turn_on_atimers (0);
3249 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3250 xerrno = errno;
3252 turn_on_atimers (1);
3254 if (ret == 0 || xerrno == EISCONN)
3256 /* The unwind-protect will be discarded afterwards.
3257 Likewise for immediate_quit. */
3258 break;
3261 #ifdef NON_BLOCKING_CONNECT
3262 #ifdef EINPROGRESS
3263 if (is_non_blocking_client && xerrno == EINPROGRESS)
3264 break;
3265 #else
3266 #ifdef EWOULDBLOCK
3267 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3268 break;
3269 #endif
3270 #endif
3271 #endif
3273 immediate_quit = 0;
3275 /* Discard the unwind protect closing S. */
3276 specpdl_ptr = specpdl + count1;
3277 emacs_close (s);
3278 s = -1;
3280 if (xerrno == EINTR)
3281 goto retry_connect;
3284 if (s >= 0)
3286 #ifdef DATAGRAM_SOCKETS
3287 if (socktype == SOCK_DGRAM)
3289 if (datagram_address[s].sa)
3290 abort ();
3291 datagram_address[s].sa = (struct sockaddr *) xmalloc (lres->ai_addrlen);
3292 datagram_address[s].len = lres->ai_addrlen;
3293 if (is_server)
3295 Lisp_Object remote;
3296 bzero (datagram_address[s].sa, lres->ai_addrlen);
3297 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3299 int rfamily, rlen;
3300 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3301 if (rfamily == lres->ai_family && rlen == lres->ai_addrlen)
3302 conv_lisp_to_sockaddr (rfamily, remote,
3303 datagram_address[s].sa, rlen);
3306 else
3307 bcopy (lres->ai_addr, datagram_address[s].sa, lres->ai_addrlen);
3309 #endif
3310 contact = Fplist_put (contact, QCaddress,
3311 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3312 #ifdef HAVE_GETSOCKNAME
3313 if (!is_server)
3315 struct sockaddr_in sa1;
3316 int len1 = sizeof (sa1);
3317 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3318 contact = Fplist_put (contact, QClocal,
3319 conv_sockaddr_to_lisp (&sa1, len1));
3321 #endif
3324 #ifdef HAVE_GETADDRINFO
3325 if (res != &ai)
3326 freeaddrinfo (res);
3327 #endif
3329 immediate_quit = 0;
3331 /* Discard the unwind protect for closing S, if any. */
3332 specpdl_ptr = specpdl + count1;
3334 /* Unwind bind_polling_period and request_sigio. */
3335 unbind_to (count, Qnil);
3337 if (s < 0)
3339 /* If non-blocking got this far - and failed - assume non-blocking is
3340 not supported after all. This is probably a wrong assumption, but
3341 the normal blocking calls to open-network-stream handles this error
3342 better. */
3343 if (is_non_blocking_client)
3344 return Qnil;
3346 errno = xerrno;
3347 if (is_server)
3348 report_file_error ("make server process failed", contact);
3349 else
3350 report_file_error ("make client process failed", contact);
3353 #endif /* not TERM */
3355 inch = s;
3356 outch = s;
3358 if (!NILP (buffer))
3359 buffer = Fget_buffer_create (buffer);
3360 proc = make_process (name);
3362 chan_process[inch] = proc;
3364 #ifdef O_NONBLOCK
3365 fcntl (inch, F_SETFL, O_NONBLOCK);
3366 #else
3367 #ifdef O_NDELAY
3368 fcntl (inch, F_SETFL, O_NDELAY);
3369 #endif
3370 #endif
3372 p = XPROCESS (proc);
3374 p->childp = contact;
3375 p->plist = Fcopy_sequence (Fplist_get (contact, QCplist));
3377 p->buffer = buffer;
3378 p->sentinel = sentinel;
3379 p->filter = filter;
3380 p->filter_multibyte = buffer_defaults.enable_multibyte_characters;
3381 /* Override the above only if :filter-multibyte is specified. */
3382 if (! NILP (Fplist_member (contact, QCfilter_multibyte)))
3383 p->filter_multibyte = Fplist_get (contact, QCfilter_multibyte);
3384 p->log = Fplist_get (contact, QClog);
3385 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3386 p->kill_without_query = Qt;
3387 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3388 p->command = Qt;
3389 p->pid = 0;
3390 XSETINT (p->infd, inch);
3391 XSETINT (p->outfd, outch);
3392 if (is_server && socktype == SOCK_STREAM)
3393 p->status = Qlisten;
3395 /* Make the process marker point into the process buffer (if any). */
3396 if (BUFFERP (buffer))
3397 set_marker_both (p->mark, buffer,
3398 BUF_ZV (XBUFFER (buffer)),
3399 BUF_ZV_BYTE (XBUFFER (buffer)));
3401 #ifdef NON_BLOCKING_CONNECT
3402 if (is_non_blocking_client)
3404 /* We may get here if connect did succeed immediately. However,
3405 in that case, we still need to signal this like a non-blocking
3406 connection. */
3407 p->status = Qconnect;
3408 if (!FD_ISSET (inch, &connect_wait_mask))
3410 FD_SET (inch, &connect_wait_mask);
3411 num_pending_connects++;
3414 else
3415 #endif
3416 /* A server may have a client filter setting of Qt, but it must
3417 still listen for incoming connects unless it is stopped. */
3418 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3419 || (EQ (p->status, Qlisten) && NILP (p->command)))
3421 FD_SET (inch, &input_wait_mask);
3422 FD_SET (inch, &non_keyboard_wait_mask);
3425 if (inch > max_process_desc)
3426 max_process_desc = inch;
3428 tem = Fplist_member (contact, QCcoding);
3429 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3430 tem = Qnil; /* No error message (too late!). */
3433 /* Setup coding systems for communicating with the network stream. */
3434 struct gcpro gcpro1;
3435 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3436 Lisp_Object coding_systems = Qt;
3437 Lisp_Object args[5], val;
3439 if (!NILP (tem))
3441 val = XCAR (XCDR (tem));
3442 if (CONSP (val))
3443 val = XCAR (val);
3445 else if (!NILP (Vcoding_system_for_read))
3446 val = Vcoding_system_for_read;
3447 else if ((!NILP (buffer) && NILP (XBUFFER (buffer)->enable_multibyte_characters))
3448 || (NILP (buffer) && NILP (buffer_defaults.enable_multibyte_characters)))
3449 /* We dare not decode end-of-line format by setting VAL to
3450 Qraw_text, because the existing Emacs Lisp libraries
3451 assume that they receive bare code including a sequene of
3452 CR LF. */
3453 val = Qnil;
3454 else
3456 if (NILP (host) || NILP (service))
3457 coding_systems = Qnil;
3458 else
3460 args[0] = Qopen_network_stream, args[1] = name,
3461 args[2] = buffer, args[3] = host, args[4] = service;
3462 GCPRO1 (proc);
3463 coding_systems = Ffind_operation_coding_system (5, args);
3464 UNGCPRO;
3466 if (CONSP (coding_systems))
3467 val = XCAR (coding_systems);
3468 else if (CONSP (Vdefault_process_coding_system))
3469 val = XCAR (Vdefault_process_coding_system);
3470 else
3471 val = Qnil;
3473 p->decode_coding_system = val;
3475 if (!NILP (tem))
3477 val = XCAR (XCDR (tem));
3478 if (CONSP (val))
3479 val = XCDR (val);
3481 else if (!NILP (Vcoding_system_for_write))
3482 val = Vcoding_system_for_write;
3483 else if (NILP (current_buffer->enable_multibyte_characters))
3484 val = Qnil;
3485 else
3487 if (EQ (coding_systems, Qt))
3489 if (NILP (host) || NILP (service))
3490 coding_systems = Qnil;
3491 else
3493 args[0] = Qopen_network_stream, args[1] = name,
3494 args[2] = buffer, args[3] = host, args[4] = service;
3495 GCPRO1 (proc);
3496 coding_systems = Ffind_operation_coding_system (5, args);
3497 UNGCPRO;
3500 if (CONSP (coding_systems))
3501 val = XCDR (coding_systems);
3502 else if (CONSP (Vdefault_process_coding_system))
3503 val = XCDR (Vdefault_process_coding_system);
3504 else
3505 val = Qnil;
3507 p->encode_coding_system = val;
3509 setup_process_coding_systems (proc);
3511 p->decoding_buf = make_uninit_string (0);
3512 p->decoding_carryover = make_number (0);
3513 p->encoding_buf = make_uninit_string (0);
3514 p->encoding_carryover = make_number (0);
3516 p->inherit_coding_system_flag
3517 = (!NILP (tem) || NILP (buffer) || !inherit_process_coding_system
3518 ? Qnil : Qt);
3520 UNGCPRO;
3521 return proc;
3523 #endif /* HAVE_SOCKETS */
3526 #if defined(HAVE_SOCKETS) && defined(HAVE_NET_IF_H) && defined(HAVE_SYS_IOCTL_H)
3528 #ifdef SIOCGIFCONF
3529 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3530 doc: /* Return an alist of all network interfaces and their network address.
3531 Each element is a cons, the car of which is a string containing the
3532 interface name, and the cdr is the network address in internal
3533 format; see the description of ADDRESS in `make-network-process'. */)
3536 struct ifconf ifconf;
3537 struct ifreq *ifreqs = NULL;
3538 int ifaces = 0;
3539 int buf_size, s;
3540 Lisp_Object res;
3542 s = socket (AF_INET, SOCK_STREAM, 0);
3543 if (s < 0)
3544 return Qnil;
3546 again:
3547 ifaces += 25;
3548 buf_size = ifaces * sizeof(ifreqs[0]);
3549 ifreqs = (struct ifreq *)xrealloc(ifreqs, buf_size);
3550 if (!ifreqs)
3552 close (s);
3553 return Qnil;
3556 ifconf.ifc_len = buf_size;
3557 ifconf.ifc_req = ifreqs;
3558 if (ioctl (s, SIOCGIFCONF, &ifconf))
3560 close (s);
3561 return Qnil;
3564 if (ifconf.ifc_len == buf_size)
3565 goto again;
3567 close (s);
3568 ifaces = ifconf.ifc_len / sizeof (ifreqs[0]);
3570 res = Qnil;
3571 while (--ifaces >= 0)
3573 struct ifreq *ifq = &ifreqs[ifaces];
3574 char namebuf[sizeof (ifq->ifr_name) + 1];
3575 if (ifq->ifr_addr.sa_family != AF_INET)
3576 continue;
3577 bcopy (ifq->ifr_name, namebuf, sizeof (ifq->ifr_name));
3578 namebuf[sizeof (ifq->ifr_name)] = 0;
3579 res = Fcons (Fcons (build_string (namebuf),
3580 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3581 sizeof (struct sockaddr))),
3582 res);
3585 return res;
3587 #endif /* SIOCGIFCONF */
3589 #if defined(SIOCGIFADDR) || defined(SIOCGIFHWADDR) || defined(SIOCGIFFLAGS)
3591 struct ifflag_def {
3592 int flag_bit;
3593 char *flag_sym;
3596 static struct ifflag_def ifflag_table[] = {
3597 #ifdef IFF_UP
3598 { IFF_UP, "up" },
3599 #endif
3600 #ifdef IFF_BROADCAST
3601 { IFF_BROADCAST, "broadcast" },
3602 #endif
3603 #ifdef IFF_DEBUG
3604 { IFF_DEBUG, "debug" },
3605 #endif
3606 #ifdef IFF_LOOPBACK
3607 { IFF_LOOPBACK, "loopback" },
3608 #endif
3609 #ifdef IFF_POINTOPOINT
3610 { IFF_POINTOPOINT, "pointopoint" },
3611 #endif
3612 #ifdef IFF_RUNNING
3613 { IFF_RUNNING, "running" },
3614 #endif
3615 #ifdef IFF_NOARP
3616 { IFF_NOARP, "noarp" },
3617 #endif
3618 #ifdef IFF_PROMISC
3619 { IFF_PROMISC, "promisc" },
3620 #endif
3621 #ifdef IFF_NOTRAILERS
3622 { IFF_NOTRAILERS, "notrailers" },
3623 #endif
3624 #ifdef IFF_ALLMULTI
3625 { IFF_ALLMULTI, "allmulti" },
3626 #endif
3627 #ifdef IFF_MASTER
3628 { IFF_MASTER, "master" },
3629 #endif
3630 #ifdef IFF_SLAVE
3631 { IFF_SLAVE, "slave" },
3632 #endif
3633 #ifdef IFF_MULTICAST
3634 { IFF_MULTICAST, "multicast" },
3635 #endif
3636 #ifdef IFF_PORTSEL
3637 { IFF_PORTSEL, "portsel" },
3638 #endif
3639 #ifdef IFF_AUTOMEDIA
3640 { IFF_AUTOMEDIA, "automedia" },
3641 #endif
3642 #ifdef IFF_DYNAMIC
3643 { IFF_DYNAMIC, "dynamic" },
3644 #endif
3645 #ifdef IFF_OACTIVE
3646 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3647 #endif
3648 #ifdef IFF_SIMPLEX
3649 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3650 #endif
3651 #ifdef IFF_LINK0
3652 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3653 #endif
3654 #ifdef IFF_LINK1
3655 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3656 #endif
3657 #ifdef IFF_LINK2
3658 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3659 #endif
3660 { 0, 0 }
3663 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3664 doc: /* Return information about network interface named IFNAME.
3665 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3666 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3667 NETMASK is the layer 3 network mask, HWADDR is the layer 2 addres, and
3668 FLAGS is the current flags of the interface. */)
3669 (ifname)
3670 Lisp_Object ifname;
3672 struct ifreq rq;
3673 Lisp_Object res = Qnil;
3674 Lisp_Object elt;
3675 int s;
3676 int any = 0;
3678 CHECK_STRING (ifname);
3680 bzero (rq.ifr_name, sizeof rq.ifr_name);
3681 strncpy (rq.ifr_name, SDATA (ifname), sizeof (rq.ifr_name));
3683 s = socket (AF_INET, SOCK_STREAM, 0);
3684 if (s < 0)
3685 return Qnil;
3687 elt = Qnil;
3688 #if defined(SIOCGIFFLAGS) && defined(HAVE_STRUCT_IFREQ_IFR_FLAGS)
3689 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3691 int flags = rq.ifr_flags;
3692 struct ifflag_def *fp;
3693 int fnum;
3695 any++;
3696 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3698 if (flags & fp->flag_bit)
3700 elt = Fcons (intern (fp->flag_sym), elt);
3701 flags -= fp->flag_bit;
3704 for (fnum = 0; flags && fnum < 32; fnum++)
3706 if (flags & (1 << fnum))
3708 elt = Fcons (make_number (fnum), elt);
3712 #endif
3713 res = Fcons (elt, res);
3715 elt = Qnil;
3716 #if defined(SIOCGIFHWADDR) && defined(HAVE_STRUCT_IFREQ_IFR_HWADDR)
3717 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3719 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3720 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3721 int n;
3723 any++;
3724 for (n = 0; n < 6; n++)
3725 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3726 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3728 #endif
3729 res = Fcons (elt, res);
3731 elt = Qnil;
3732 #if defined(SIOCGIFNETMASK) && (defined(HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined(HAVE_STRUCT_IFREQ_IFR_ADDR))
3733 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3735 any++;
3736 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3737 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3738 #else
3739 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3740 #endif
3742 #endif
3743 res = Fcons (elt, res);
3745 elt = Qnil;
3746 #if defined(SIOCGIFBRDADDR) && defined(HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3747 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3749 any++;
3750 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3752 #endif
3753 res = Fcons (elt, res);
3755 elt = Qnil;
3756 #if defined(SIOCGIFADDR) && defined(HAVE_STRUCT_IFREQ_IFR_ADDR)
3757 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3759 any++;
3760 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3762 #endif
3763 res = Fcons (elt, res);
3765 close (s);
3767 return any ? res : Qnil;
3769 #endif
3770 #endif /* HAVE_SOCKETS */
3772 /* Turn off input and output for process PROC. */
3774 void
3775 deactivate_process (proc)
3776 Lisp_Object proc;
3778 register int inchannel, outchannel;
3779 register struct Lisp_Process *p = XPROCESS (proc);
3781 inchannel = XINT (p->infd);
3782 outchannel = XINT (p->outfd);
3784 #ifdef ADAPTIVE_READ_BUFFERING
3785 if (XINT (p->read_output_delay) > 0)
3787 if (--process_output_delay_count < 0)
3788 process_output_delay_count = 0;
3789 XSETINT (p->read_output_delay, 0);
3790 p->read_output_skip = Qnil;
3792 #endif
3794 if (inchannel >= 0)
3796 /* Beware SIGCHLD hereabouts. */
3797 flush_pending_output (inchannel);
3798 #ifdef VMS
3800 VMS_PROC_STUFF *get_vms_process_pointer (), *vs;
3801 sys$dassgn (outchannel);
3802 vs = get_vms_process_pointer (p->pid);
3803 if (vs)
3804 give_back_vms_process_stuff (vs);
3806 #else
3807 emacs_close (inchannel);
3808 if (outchannel >= 0 && outchannel != inchannel)
3809 emacs_close (outchannel);
3810 #endif
3812 XSETINT (p->infd, -1);
3813 XSETINT (p->outfd, -1);
3814 #ifdef DATAGRAM_SOCKETS
3815 if (DATAGRAM_CHAN_P (inchannel))
3817 xfree (datagram_address[inchannel].sa);
3818 datagram_address[inchannel].sa = 0;
3819 datagram_address[inchannel].len = 0;
3821 #endif
3822 chan_process[inchannel] = Qnil;
3823 FD_CLR (inchannel, &input_wait_mask);
3824 FD_CLR (inchannel, &non_keyboard_wait_mask);
3825 #ifdef NON_BLOCKING_CONNECT
3826 if (FD_ISSET (inchannel, &connect_wait_mask))
3828 FD_CLR (inchannel, &connect_wait_mask);
3829 if (--num_pending_connects < 0)
3830 abort ();
3832 #endif
3833 if (inchannel == max_process_desc)
3835 int i;
3836 /* We just closed the highest-numbered process input descriptor,
3837 so recompute the highest-numbered one now. */
3838 max_process_desc = 0;
3839 for (i = 0; i < MAXDESC; i++)
3840 if (!NILP (chan_process[i]))
3841 max_process_desc = i;
3846 /* Close all descriptors currently in use for communication
3847 with subprocess. This is used in a newly-forked subprocess
3848 to get rid of irrelevant descriptors. */
3850 void
3851 close_process_descs ()
3853 #ifndef WINDOWSNT
3854 int i;
3855 for (i = 0; i < MAXDESC; i++)
3857 Lisp_Object process;
3858 process = chan_process[i];
3859 if (!NILP (process))
3861 int in = XINT (XPROCESS (process)->infd);
3862 int out = XINT (XPROCESS (process)->outfd);
3863 if (in >= 0)
3864 emacs_close (in);
3865 if (out >= 0 && in != out)
3866 emacs_close (out);
3869 #endif
3872 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3873 0, 4, 0,
3874 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3875 It is read into the process' buffers or given to their filter functions.
3876 Non-nil arg PROCESS means do not return until some output has been received
3877 from PROCESS.
3879 Non-nil second arg SECONDS and third arg MILLISEC are number of
3880 seconds and milliseconds to wait; return after that much time whether
3881 or not there is input. If SECONDS is a floating point number,
3882 it specifies a fractional number of seconds to wait.
3884 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3885 from PROCESS, suspending reading output from other processes.
3886 If JUST-THIS-ONE is an integer, don't run any timers either.
3887 Return non-nil iff we received any output before the timeout expired. */)
3888 (process, seconds, millisec, just_this_one)
3889 register Lisp_Object process, seconds, millisec, just_this_one;
3891 int secs, usecs = 0;
3893 if (! NILP (process))
3894 CHECK_PROCESS (process);
3895 else
3896 just_this_one = Qnil;
3898 if (!NILP (seconds))
3900 if (INTEGERP (seconds))
3901 secs = XINT (seconds);
3902 else if (FLOATP (seconds))
3904 double timeout = XFLOAT_DATA (seconds);
3905 secs = (int) timeout;
3906 usecs = (int) ((timeout - (double) secs) * 1000000);
3908 else
3909 wrong_type_argument (Qnumberp, seconds);
3911 if (INTEGERP (millisec))
3913 int carry;
3914 usecs += XINT (millisec) * 1000;
3915 carry = usecs / 1000000;
3916 secs += carry;
3917 if ((usecs -= carry * 1000000) < 0)
3919 secs--;
3920 usecs += 1000000;
3924 if (secs < 0 || (secs == 0 && usecs == 0))
3925 secs = -1, usecs = 0;
3927 else
3928 secs = NILP (process) ? -1 : 0;
3930 return
3931 (wait_reading_process_output (secs, usecs, 0, 0,
3932 Qnil,
3933 !NILP (process) ? XPROCESS (process) : NULL,
3934 NILP (just_this_one) ? 0 :
3935 !INTEGERP (just_this_one) ? 1 : -1)
3936 ? Qt : Qnil);
3939 /* Accept a connection for server process SERVER on CHANNEL. */
3941 static int connect_counter = 0;
3943 static void
3944 server_accept_connection (server, channel)
3945 Lisp_Object server;
3946 int channel;
3948 Lisp_Object proc, caller, name, buffer;
3949 Lisp_Object contact, host, service;
3950 struct Lisp_Process *ps= XPROCESS (server);
3951 struct Lisp_Process *p;
3952 int s;
3953 union u_sockaddr {
3954 struct sockaddr sa;
3955 struct sockaddr_in in;
3956 #ifdef AF_INET6
3957 struct sockaddr_in6 in6;
3958 #endif
3959 #ifdef HAVE_LOCAL_SOCKETS
3960 struct sockaddr_un un;
3961 #endif
3962 } saddr;
3963 int len = sizeof saddr;
3965 s = accept (channel, &saddr.sa, &len);
3967 if (s < 0)
3969 int code = errno;
3971 if (code == EAGAIN)
3972 return;
3973 #ifdef EWOULDBLOCK
3974 if (code == EWOULDBLOCK)
3975 return;
3976 #endif
3978 if (!NILP (ps->log))
3979 call3 (ps->log, server, Qnil,
3980 concat3 (build_string ("accept failed with code"),
3981 Fnumber_to_string (make_number (code)),
3982 build_string ("\n")));
3983 return;
3986 connect_counter++;
3988 /* Setup a new process to handle the connection. */
3990 /* Generate a unique identification of the caller, and build contact
3991 information for this process. */
3992 host = Qt;
3993 service = Qnil;
3994 switch (saddr.sa.sa_family)
3996 case AF_INET:
3998 Lisp_Object args[5];
3999 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4000 args[0] = build_string ("%d.%d.%d.%d");
4001 args[1] = make_number (*ip++);
4002 args[2] = make_number (*ip++);
4003 args[3] = make_number (*ip++);
4004 args[4] = make_number (*ip++);
4005 host = Fformat (5, args);
4006 service = make_number (ntohs (saddr.in.sin_port));
4008 args[0] = build_string (" <%s:%d>");
4009 args[1] = host;
4010 args[2] = service;
4011 caller = Fformat (3, args);
4013 break;
4015 #ifdef AF_INET6
4016 case AF_INET6:
4018 Lisp_Object args[9];
4019 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4020 int i;
4021 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4022 for (i = 0; i < 8; i++)
4023 args[i+1] = make_number (ntohs(ip6[i]));
4024 host = Fformat (9, args);
4025 service = make_number (ntohs (saddr.in.sin_port));
4027 args[0] = build_string (" <[%s]:%d>");
4028 args[1] = host;
4029 args[2] = service;
4030 caller = Fformat (3, args);
4032 break;
4033 #endif
4035 #ifdef HAVE_LOCAL_SOCKETS
4036 case AF_LOCAL:
4037 #endif
4038 default:
4039 caller = Fnumber_to_string (make_number (connect_counter));
4040 caller = concat3 (build_string (" <*"), caller, build_string ("*>"));
4041 break;
4044 /* Create a new buffer name for this process if it doesn't have a
4045 filter. The new buffer name is based on the buffer name or
4046 process name of the server process concatenated with the caller
4047 identification. */
4049 if (!NILP (ps->filter) && !EQ (ps->filter, Qt))
4050 buffer = Qnil;
4051 else
4053 buffer = ps->buffer;
4054 if (!NILP (buffer))
4055 buffer = Fbuffer_name (buffer);
4056 else
4057 buffer = ps->name;
4058 if (!NILP (buffer))
4060 buffer = concat2 (buffer, caller);
4061 buffer = Fget_buffer_create (buffer);
4065 /* Generate a unique name for the new server process. Combine the
4066 server process name with the caller identification. */
4068 name = concat2 (ps->name, caller);
4069 proc = make_process (name);
4071 chan_process[s] = proc;
4073 #ifdef O_NONBLOCK
4074 fcntl (s, F_SETFL, O_NONBLOCK);
4075 #else
4076 #ifdef O_NDELAY
4077 fcntl (s, F_SETFL, O_NDELAY);
4078 #endif
4079 #endif
4081 p = XPROCESS (proc);
4083 /* Build new contact information for this setup. */
4084 contact = Fcopy_sequence (ps->childp);
4085 contact = Fplist_put (contact, QCserver, Qnil);
4086 contact = Fplist_put (contact, QChost, host);
4087 if (!NILP (service))
4088 contact = Fplist_put (contact, QCservice, service);
4089 contact = Fplist_put (contact, QCremote,
4090 conv_sockaddr_to_lisp (&saddr.sa, len));
4091 #ifdef HAVE_GETSOCKNAME
4092 len = sizeof saddr;
4093 if (getsockname (s, &saddr.sa, &len) == 0)
4094 contact = Fplist_put (contact, QClocal,
4095 conv_sockaddr_to_lisp (&saddr.sa, len));
4096 #endif
4098 p->childp = contact;
4099 p->plist = Fcopy_sequence (ps->plist);
4101 p->buffer = buffer;
4102 p->sentinel = ps->sentinel;
4103 p->filter = ps->filter;
4104 p->command = Qnil;
4105 p->pid = 0;
4106 XSETINT (p->infd, s);
4107 XSETINT (p->outfd, s);
4108 p->status = Qrun;
4110 /* Client processes for accepted connections are not stopped initially. */
4111 if (!EQ (p->filter, Qt))
4113 FD_SET (s, &input_wait_mask);
4114 FD_SET (s, &non_keyboard_wait_mask);
4117 if (s > max_process_desc)
4118 max_process_desc = s;
4120 /* Setup coding system for new process based on server process.
4121 This seems to be the proper thing to do, as the coding system
4122 of the new process should reflect the settings at the time the
4123 server socket was opened; not the current settings. */
4125 p->decode_coding_system = ps->decode_coding_system;
4126 p->encode_coding_system = ps->encode_coding_system;
4127 setup_process_coding_systems (proc);
4129 p->decoding_buf = make_uninit_string (0);
4130 p->decoding_carryover = make_number (0);
4131 p->encoding_buf = make_uninit_string (0);
4132 p->encoding_carryover = make_number (0);
4134 p->inherit_coding_system_flag
4135 = (NILP (buffer) ? Qnil : ps->inherit_coding_system_flag);
4137 if (!NILP (ps->log))
4138 call3 (ps->log, server, proc,
4139 concat3 (build_string ("accept from "),
4140 (STRINGP (host) ? host : build_string ("-")),
4141 build_string ("\n")));
4143 if (!NILP (p->sentinel))
4144 exec_sentinel (proc,
4145 concat3 (build_string ("open from "),
4146 (STRINGP (host) ? host : build_string ("-")),
4147 build_string ("\n")));
4150 /* This variable is different from waiting_for_input in keyboard.c.
4151 It is used to communicate to a lisp process-filter/sentinel (via the
4152 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4153 for user-input when that process-filter was called.
4154 waiting_for_input cannot be used as that is by definition 0 when
4155 lisp code is being evalled.
4156 This is also used in record_asynch_buffer_change.
4157 For that purpose, this must be 0
4158 when not inside wait_reading_process_output. */
4159 static int waiting_for_user_input_p;
4161 static Lisp_Object
4162 wait_reading_process_output_unwind (data)
4163 Lisp_Object data;
4165 waiting_for_user_input_p = XINT (data);
4166 return Qnil;
4169 /* This is here so breakpoints can be put on it. */
4170 static void
4171 wait_reading_process_output_1 ()
4175 /* Use a wrapper around select to work around a bug in gdb 5.3.
4176 Normally, the wrapper is optimzed away by inlining.
4178 If emacs is stopped inside select, the gdb backtrace doesn't
4179 show the function which called select, so it is practically
4180 impossible to step through wait_reading_process_output. */
4182 #ifndef select
4183 static INLINE int
4184 select_wrapper (n, rfd, wfd, xfd, tmo)
4185 int n;
4186 SELECT_TYPE *rfd, *wfd, *xfd;
4187 EMACS_TIME *tmo;
4189 return select (n, rfd, wfd, xfd, tmo);
4191 #define select select_wrapper
4192 #endif
4194 /* Read and dispose of subprocess output while waiting for timeout to
4195 elapse and/or keyboard input to be available.
4197 TIME_LIMIT is:
4198 timeout in seconds, or
4199 zero for no limit, or
4200 -1 means gobble data immediately available but don't wait for any.
4202 MICROSECS is:
4203 an additional duration to wait, measured in microseconds.
4204 If this is nonzero and time_limit is 0, then the timeout
4205 consists of MICROSECS only.
4207 READ_KBD is a lisp value:
4208 0 to ignore keyboard input, or
4209 1 to return when input is available, or
4210 -1 meaning caller will actually read the input, so don't throw to
4211 the quit handler, or
4213 DO_DISPLAY != 0 means redisplay should be done to show subprocess
4214 output that arrives.
4216 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4217 (and gobble terminal input into the buffer if any arrives).
4219 If WAIT_PROC is specified, wait until something arrives from that
4220 process. The return value is true iff we read some input from
4221 that process.
4223 If JUST_WAIT_PROC is non-nil, handle only output from WAIT_PROC
4224 (suspending output from other processes). A negative value
4225 means don't run any timers either.
4227 If WAIT_PROC is specified, then the function returns true iff we
4228 received input from that process before the timeout elapsed.
4229 Otherwise, return true iff we received input from any process. */
4232 wait_reading_process_output (time_limit, microsecs, read_kbd, do_display,
4233 wait_for_cell, wait_proc, just_wait_proc)
4234 int time_limit, microsecs, read_kbd, do_display;
4235 Lisp_Object wait_for_cell;
4236 struct Lisp_Process *wait_proc;
4237 int just_wait_proc;
4239 register int channel, nfds;
4240 SELECT_TYPE Available;
4241 #ifdef NON_BLOCKING_CONNECT
4242 SELECT_TYPE Connecting;
4243 int check_connect;
4244 #endif
4245 int check_delay, no_avail;
4246 int xerrno;
4247 Lisp_Object proc;
4248 EMACS_TIME timeout, end_time;
4249 int wait_channel = -1;
4250 int got_some_input = 0;
4251 int count = SPECPDL_INDEX ();
4253 FD_ZERO (&Available);
4254 #ifdef NON_BLOCKING_CONNECT
4255 FD_ZERO (&Connecting);
4256 #endif
4258 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4259 if (wait_proc != NULL)
4260 wait_channel = XINT (wait_proc->infd);
4262 record_unwind_protect (wait_reading_process_output_unwind,
4263 make_number (waiting_for_user_input_p));
4264 waiting_for_user_input_p = read_kbd;
4266 /* Since we may need to wait several times,
4267 compute the absolute time to return at. */
4268 if (time_limit || microsecs)
4270 EMACS_GET_TIME (end_time);
4271 EMACS_SET_SECS_USECS (timeout, time_limit, microsecs);
4272 EMACS_ADD_TIME (end_time, end_time, timeout);
4274 #ifdef POLL_INTERRUPTED_SYS_CALL
4275 /* AlainF 5-Jul-1996
4276 HP-UX 10.10 seem to have problems with signals coming in
4277 Causes "poll: interrupted system call" messages when Emacs is run
4278 in an X window
4279 Turn off periodic alarms (in case they are in use),
4280 and then turn off any other atimers. */
4281 stop_polling ();
4282 turn_on_atimers (0);
4283 #endif /* POLL_INTERRUPTED_SYS_CALL */
4285 while (1)
4287 int timeout_reduced_for_timers = 0;
4289 /* If calling from keyboard input, do not quit
4290 since we want to return C-g as an input character.
4291 Otherwise, do pending quit if requested. */
4292 if (read_kbd >= 0)
4293 QUIT;
4294 #ifdef SYNC_INPUT
4295 else if (interrupt_input_pending)
4296 handle_async_input ();
4297 #endif
4299 /* Exit now if the cell we're waiting for became non-nil. */
4300 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4301 break;
4303 /* Compute time from now till when time limit is up */
4304 /* Exit if already run out */
4305 if (time_limit == -1)
4307 /* -1 specified for timeout means
4308 gobble output available now
4309 but don't wait at all. */
4311 EMACS_SET_SECS_USECS (timeout, 0, 0);
4313 else if (time_limit || microsecs)
4315 EMACS_GET_TIME (timeout);
4316 EMACS_SUB_TIME (timeout, end_time, timeout);
4317 if (EMACS_TIME_NEG_P (timeout))
4318 break;
4320 else
4322 EMACS_SET_SECS_USECS (timeout, 100000, 0);
4325 /* Normally we run timers here.
4326 But not if wait_for_cell; in those cases,
4327 the wait is supposed to be short,
4328 and those callers cannot handle running arbitrary Lisp code here. */
4329 if (NILP (wait_for_cell)
4330 && just_wait_proc >= 0)
4332 EMACS_TIME timer_delay;
4336 int old_timers_run = timers_run;
4337 struct buffer *old_buffer = current_buffer;
4339 timer_delay = timer_check (1);
4341 /* If a timer has run, this might have changed buffers
4342 an alike. Make read_key_sequence aware of that. */
4343 if (timers_run != old_timers_run
4344 && old_buffer != current_buffer
4345 && waiting_for_user_input_p == -1)
4346 record_asynch_buffer_change ();
4348 if (timers_run != old_timers_run && do_display)
4349 /* We must retry, since a timer may have requeued itself
4350 and that could alter the time_delay. */
4351 redisplay_preserve_echo_area (9);
4352 else
4353 break;
4355 while (!detect_input_pending ());
4357 /* If there is unread keyboard input, also return. */
4358 if (read_kbd != 0
4359 && requeued_events_pending_p ())
4360 break;
4362 if (! EMACS_TIME_NEG_P (timer_delay) && time_limit != -1)
4364 EMACS_TIME difference;
4365 EMACS_SUB_TIME (difference, timer_delay, timeout);
4366 if (EMACS_TIME_NEG_P (difference))
4368 timeout = timer_delay;
4369 timeout_reduced_for_timers = 1;
4372 /* If time_limit is -1, we are not going to wait at all. */
4373 else if (time_limit != -1)
4375 /* This is so a breakpoint can be put here. */
4376 wait_reading_process_output_1 ();
4380 /* Cause C-g and alarm signals to take immediate action,
4381 and cause input available signals to zero out timeout.
4383 It is important that we do this before checking for process
4384 activity. If we get a SIGCHLD after the explicit checks for
4385 process activity, timeout is the only way we will know. */
4386 if (read_kbd < 0)
4387 set_waiting_for_input (&timeout);
4389 /* If status of something has changed, and no input is
4390 available, notify the user of the change right away. After
4391 this explicit check, we'll let the SIGCHLD handler zap
4392 timeout to get our attention. */
4393 if (update_tick != process_tick && do_display)
4395 SELECT_TYPE Atemp;
4396 #ifdef NON_BLOCKING_CONNECT
4397 SELECT_TYPE Ctemp;
4398 #endif
4400 Atemp = input_wait_mask;
4401 #if 0
4402 /* On Mac OS X 10.0, the SELECT system call always says input is
4403 present (for reading) at stdin, even when none is. This
4404 causes the call to SELECT below to return 1 and
4405 status_notify not to be called. As a result output of
4406 subprocesses are incorrectly discarded.
4408 FD_CLR (0, &Atemp);
4409 #endif
4410 IF_NON_BLOCKING_CONNECT (Ctemp = connect_wait_mask);
4412 EMACS_SET_SECS_USECS (timeout, 0, 0);
4413 if ((select (max (max_process_desc, max_keyboard_desc) + 1,
4414 &Atemp,
4415 #ifdef NON_BLOCKING_CONNECT
4416 (num_pending_connects > 0 ? &Ctemp : (SELECT_TYPE *)0),
4417 #else
4418 (SELECT_TYPE *)0,
4419 #endif
4420 (SELECT_TYPE *)0, &timeout)
4421 <= 0))
4423 /* It's okay for us to do this and then continue with
4424 the loop, since timeout has already been zeroed out. */
4425 clear_waiting_for_input ();
4426 status_notify (NULL);
4430 /* Don't wait for output from a non-running process. Just
4431 read whatever data has already been received. */
4432 if (wait_proc && wait_proc->raw_status_new)
4433 update_status (wait_proc);
4434 if (wait_proc
4435 && ! EQ (wait_proc->status, Qrun)
4436 && ! EQ (wait_proc->status, Qconnect))
4438 int nread, total_nread = 0;
4440 clear_waiting_for_input ();
4441 XSETPROCESS (proc, wait_proc);
4443 /* Read data from the process, until we exhaust it. */
4444 while (XINT (wait_proc->infd) >= 0)
4446 nread = read_process_output (proc, XINT (wait_proc->infd));
4448 if (nread == 0)
4449 break;
4451 if (0 < nread)
4452 total_nread += nread;
4453 #ifdef EIO
4454 else if (nread == -1 && EIO == errno)
4455 break;
4456 #endif
4457 #ifdef EAGAIN
4458 else if (nread == -1 && EAGAIN == errno)
4459 break;
4460 #endif
4461 #ifdef EWOULDBLOCK
4462 else if (nread == -1 && EWOULDBLOCK == errno)
4463 break;
4464 #endif
4466 if (total_nread > 0 && do_display)
4467 redisplay_preserve_echo_area (10);
4469 break;
4472 /* Wait till there is something to do */
4474 if (wait_proc && just_wait_proc)
4476 if (XINT (wait_proc->infd) < 0) /* Terminated */
4477 break;
4478 FD_SET (XINT (wait_proc->infd), &Available);
4479 check_delay = 0;
4480 IF_NON_BLOCKING_CONNECT (check_connect = 0);
4482 else if (!NILP (wait_for_cell))
4484 Available = non_process_wait_mask;
4485 check_delay = 0;
4486 IF_NON_BLOCKING_CONNECT (check_connect = 0);
4488 else
4490 if (! read_kbd)
4491 Available = non_keyboard_wait_mask;
4492 else
4493 Available = input_wait_mask;
4494 IF_NON_BLOCKING_CONNECT (check_connect = (num_pending_connects > 0));
4495 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4498 /* If frame size has changed or the window is newly mapped,
4499 redisplay now, before we start to wait. There is a race
4500 condition here; if a SIGIO arrives between now and the select
4501 and indicates that a frame is trashed, the select may block
4502 displaying a trashed screen. */
4503 if (frame_garbaged && do_display)
4505 clear_waiting_for_input ();
4506 redisplay_preserve_echo_area (11);
4507 if (read_kbd < 0)
4508 set_waiting_for_input (&timeout);
4511 no_avail = 0;
4512 if (read_kbd && detect_input_pending ())
4514 nfds = 0;
4515 no_avail = 1;
4517 else
4519 #ifdef NON_BLOCKING_CONNECT
4520 if (check_connect)
4521 Connecting = connect_wait_mask;
4522 #endif
4524 #ifdef ADAPTIVE_READ_BUFFERING
4525 /* Set the timeout for adaptive read buffering if any
4526 process has non-nil read_output_skip and non-zero
4527 read_output_delay, and we are not reading output for a
4528 specific wait_channel. It is not executed if
4529 Vprocess_adaptive_read_buffering is nil. */
4530 if (process_output_skip && check_delay > 0)
4532 int usecs = EMACS_USECS (timeout);
4533 if (EMACS_SECS (timeout) > 0 || usecs > READ_OUTPUT_DELAY_MAX)
4534 usecs = READ_OUTPUT_DELAY_MAX;
4535 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4537 proc = chan_process[channel];
4538 if (NILP (proc))
4539 continue;
4540 /* Find minimum non-zero read_output_delay among the
4541 processes with non-nil read_output_skip. */
4542 if (XINT (XPROCESS (proc)->read_output_delay) > 0)
4544 check_delay--;
4545 if (NILP (XPROCESS (proc)->read_output_skip))
4546 continue;
4547 FD_CLR (channel, &Available);
4548 XPROCESS (proc)->read_output_skip = Qnil;
4549 if (XINT (XPROCESS (proc)->read_output_delay) < usecs)
4550 usecs = XINT (XPROCESS (proc)->read_output_delay);
4553 EMACS_SET_SECS_USECS (timeout, 0, usecs);
4554 process_output_skip = 0;
4556 #endif
4558 nfds = select (max (max_process_desc, max_keyboard_desc) + 1,
4559 &Available,
4560 #ifdef NON_BLOCKING_CONNECT
4561 (check_connect ? &Connecting : (SELECT_TYPE *)0),
4562 #else
4563 (SELECT_TYPE *)0,
4564 #endif
4565 (SELECT_TYPE *)0, &timeout);
4568 xerrno = errno;
4570 /* Make C-g and alarm signals set flags again */
4571 clear_waiting_for_input ();
4573 /* If we woke up due to SIGWINCH, actually change size now. */
4574 do_pending_window_change (0);
4576 if (time_limit && nfds == 0 && ! timeout_reduced_for_timers)
4577 /* We wanted the full specified time, so return now. */
4578 break;
4579 if (nfds < 0)
4581 if (xerrno == EINTR)
4582 no_avail = 1;
4583 #ifdef ultrix
4584 /* Ultrix select seems to return ENOMEM when it is
4585 interrupted. Treat it just like EINTR. Bleah. Note
4586 that we want to test for the "ultrix" CPP symbol, not
4587 "__ultrix__"; the latter is only defined under GCC, but
4588 not by DEC's bundled CC. -JimB */
4589 else if (xerrno == ENOMEM)
4590 no_avail = 1;
4591 #endif
4592 #ifdef ALLIANT
4593 /* This happens for no known reason on ALLIANT.
4594 I am guessing that this is the right response. -- RMS. */
4595 else if (xerrno == EFAULT)
4596 no_avail = 1;
4597 #endif
4598 else if (xerrno == EBADF)
4600 #ifdef AIX
4601 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
4602 the child's closure of the pts gives the parent a SIGHUP, and
4603 the ptc file descriptor is automatically closed,
4604 yielding EBADF here or at select() call above.
4605 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
4606 in m/ibmrt-aix.h), and here we just ignore the select error.
4607 Cleanup occurs c/o status_notify after SIGCLD. */
4608 no_avail = 1; /* Cannot depend on values returned */
4609 #else
4610 abort ();
4611 #endif
4613 else
4614 error ("select error: %s", emacs_strerror (xerrno));
4617 if (no_avail)
4619 FD_ZERO (&Available);
4620 IF_NON_BLOCKING_CONNECT (check_connect = 0);
4623 #if defined(sun) && !defined(USG5_4)
4624 if (nfds > 0 && keyboard_bit_set (&Available)
4625 && interrupt_input)
4626 /* System sometimes fails to deliver SIGIO.
4628 David J. Mackenzie says that Emacs doesn't compile under
4629 Solaris if this code is enabled, thus the USG5_4 in the CPP
4630 conditional. "I haven't noticed any ill effects so far.
4631 If you find a Solaris expert somewhere, they might know
4632 better." */
4633 kill (getpid (), SIGIO);
4634 #endif
4636 #if 0 /* When polling is used, interrupt_input is 0,
4637 so get_input_pending should read the input.
4638 So this should not be needed. */
4639 /* If we are using polling for input,
4640 and we see input available, make it get read now.
4641 Otherwise it might not actually get read for a second.
4642 And on hpux, since we turn off polling in wait_reading_process_output,
4643 it might never get read at all if we don't spend much time
4644 outside of wait_reading_process_output. */
4645 if (read_kbd && interrupt_input
4646 && keyboard_bit_set (&Available)
4647 && input_polling_used ())
4648 kill (getpid (), SIGALRM);
4649 #endif
4651 /* Check for keyboard input */
4652 /* If there is any, return immediately
4653 to give it higher priority than subprocesses */
4655 if (read_kbd != 0)
4657 int old_timers_run = timers_run;
4658 struct buffer *old_buffer = current_buffer;
4659 int leave = 0;
4661 if (detect_input_pending_run_timers (do_display))
4663 swallow_events (do_display);
4664 if (detect_input_pending_run_timers (do_display))
4665 leave = 1;
4668 /* If a timer has run, this might have changed buffers
4669 an alike. Make read_key_sequence aware of that. */
4670 if (timers_run != old_timers_run
4671 && waiting_for_user_input_p == -1
4672 && old_buffer != current_buffer)
4673 record_asynch_buffer_change ();
4675 if (leave)
4676 break;
4679 /* If there is unread keyboard input, also return. */
4680 if (read_kbd != 0
4681 && requeued_events_pending_p ())
4682 break;
4684 /* If we are not checking for keyboard input now,
4685 do process events (but don't run any timers).
4686 This is so that X events will be processed.
4687 Otherwise they may have to wait until polling takes place.
4688 That would causes delays in pasting selections, for example.
4690 (We used to do this only if wait_for_cell.) */
4691 if (read_kbd == 0 && detect_input_pending ())
4693 swallow_events (do_display);
4694 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4695 if (detect_input_pending ())
4696 break;
4697 #endif
4700 /* Exit now if the cell we're waiting for became non-nil. */
4701 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4702 break;
4704 #ifdef SIGIO
4705 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4706 go read it. This can happen with X on BSD after logging out.
4707 In that case, there really is no input and no SIGIO,
4708 but select says there is input. */
4710 if (read_kbd && interrupt_input
4711 && keyboard_bit_set (&Available) && ! noninteractive)
4712 kill (getpid (), SIGIO);
4713 #endif
4715 if (! wait_proc)
4716 got_some_input |= nfds > 0;
4718 /* If checking input just got us a size-change event from X,
4719 obey it now if we should. */
4720 if (read_kbd || ! NILP (wait_for_cell))
4721 do_pending_window_change (0);
4723 /* Check for data from a process. */
4724 if (no_avail || nfds == 0)
4725 continue;
4727 /* Really FIRST_PROC_DESC should be 0 on Unix,
4728 but this is safer in the short run. */
4729 for (channel = 0; channel <= max_process_desc; channel++)
4731 if (FD_ISSET (channel, &Available)
4732 && FD_ISSET (channel, &non_keyboard_wait_mask))
4734 int nread;
4736 /* If waiting for this channel, arrange to return as
4737 soon as no more input to be processed. No more
4738 waiting. */
4739 if (wait_channel == channel)
4741 wait_channel = -1;
4742 time_limit = -1;
4743 got_some_input = 1;
4745 proc = chan_process[channel];
4746 if (NILP (proc))
4747 continue;
4749 /* If this is a server stream socket, accept connection. */
4750 if (EQ (XPROCESS (proc)->status, Qlisten))
4752 server_accept_connection (proc, channel);
4753 continue;
4756 /* Read data from the process, starting with our
4757 buffered-ahead character if we have one. */
4759 nread = read_process_output (proc, channel);
4760 if (nread > 0)
4762 /* Since read_process_output can run a filter,
4763 which can call accept-process-output,
4764 don't try to read from any other processes
4765 before doing the select again. */
4766 FD_ZERO (&Available);
4768 if (do_display)
4769 redisplay_preserve_echo_area (12);
4771 #ifdef EWOULDBLOCK
4772 else if (nread == -1 && errno == EWOULDBLOCK)
4774 #endif
4775 /* ISC 4.1 defines both EWOULDBLOCK and O_NONBLOCK,
4776 and Emacs uses O_NONBLOCK, so what we get is EAGAIN. */
4777 #ifdef O_NONBLOCK
4778 else if (nread == -1 && errno == EAGAIN)
4780 #else
4781 #ifdef O_NDELAY
4782 else if (nread == -1 && errno == EAGAIN)
4784 /* Note that we cannot distinguish between no input
4785 available now and a closed pipe.
4786 With luck, a closed pipe will be accompanied by
4787 subprocess termination and SIGCHLD. */
4788 else if (nread == 0 && !NETCONN_P (proc))
4790 #endif /* O_NDELAY */
4791 #endif /* O_NONBLOCK */
4792 #ifdef HAVE_PTYS
4793 /* On some OSs with ptys, when the process on one end of
4794 a pty exits, the other end gets an error reading with
4795 errno = EIO instead of getting an EOF (0 bytes read).
4796 Therefore, if we get an error reading and errno =
4797 EIO, just continue, because the child process has
4798 exited and should clean itself up soon (e.g. when we
4799 get a SIGCHLD).
4801 However, it has been known to happen that the SIGCHLD
4802 got lost. So raise the signl again just in case.
4803 It can't hurt. */
4804 else if (nread == -1 && errno == EIO)
4805 kill (getpid (), SIGCHLD);
4806 #endif /* HAVE_PTYS */
4807 /* If we can detect process termination, don't consider the process
4808 gone just because its pipe is closed. */
4809 #ifdef SIGCHLD
4810 else if (nread == 0 && !NETCONN_P (proc))
4812 #endif
4813 else
4815 /* Preserve status of processes already terminated. */
4816 XSETINT (XPROCESS (proc)->tick, ++process_tick);
4817 deactivate_process (proc);
4818 if (XPROCESS (proc)->raw_status_new)
4819 update_status (XPROCESS (proc));
4820 if (EQ (XPROCESS (proc)->status, Qrun))
4821 XPROCESS (proc)->status
4822 = Fcons (Qexit, Fcons (make_number (256), Qnil));
4825 #ifdef NON_BLOCKING_CONNECT
4826 if (check_connect && FD_ISSET (channel, &Connecting)
4827 && FD_ISSET (channel, &connect_wait_mask))
4829 struct Lisp_Process *p;
4831 FD_CLR (channel, &connect_wait_mask);
4832 if (--num_pending_connects < 0)
4833 abort ();
4835 proc = chan_process[channel];
4836 if (NILP (proc))
4837 continue;
4839 p = XPROCESS (proc);
4841 #ifdef GNU_LINUX
4842 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4843 So only use it on systems where it is known to work. */
4845 int xlen = sizeof(xerrno);
4846 if (getsockopt(channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4847 xerrno = errno;
4849 #else
4851 struct sockaddr pname;
4852 int pnamelen = sizeof(pname);
4854 /* If connection failed, getpeername will fail. */
4855 xerrno = 0;
4856 if (getpeername(channel, &pname, &pnamelen) < 0)
4858 /* Obtain connect failure code through error slippage. */
4859 char dummy;
4860 xerrno = errno;
4861 if (errno == ENOTCONN && read(channel, &dummy, 1) < 0)
4862 xerrno = errno;
4865 #endif
4866 if (xerrno)
4868 XSETINT (p->tick, ++process_tick);
4869 p->status = Fcons (Qfailed, Fcons (make_number (xerrno), Qnil));
4870 deactivate_process (proc);
4872 else
4874 p->status = Qrun;
4875 /* Execute the sentinel here. If we had relied on
4876 status_notify to do it later, it will read input
4877 from the process before calling the sentinel. */
4878 exec_sentinel (proc, build_string ("open\n"));
4879 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
4881 FD_SET (XINT (p->infd), &input_wait_mask);
4882 FD_SET (XINT (p->infd), &non_keyboard_wait_mask);
4886 #endif /* NON_BLOCKING_CONNECT */
4887 } /* end for each file descriptor */
4888 } /* end while exit conditions not met */
4890 unbind_to (count, Qnil);
4892 /* If calling from keyboard input, do not quit
4893 since we want to return C-g as an input character.
4894 Otherwise, do pending quit if requested. */
4895 if (read_kbd >= 0)
4897 /* Prevent input_pending from remaining set if we quit. */
4898 clear_input_pending ();
4899 QUIT;
4901 #ifdef POLL_INTERRUPTED_SYS_CALL
4902 /* AlainF 5-Jul-1996
4903 HP-UX 10.10 seems to have problems with signals coming in
4904 Causes "poll: interrupted system call" messages when Emacs is run
4905 in an X window
4906 Turn periodic alarms back on */
4907 start_polling ();
4908 #endif /* POLL_INTERRUPTED_SYS_CALL */
4910 return got_some_input;
4913 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
4915 static Lisp_Object
4916 read_process_output_call (fun_and_args)
4917 Lisp_Object fun_and_args;
4919 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
4922 static Lisp_Object
4923 read_process_output_error_handler (error)
4924 Lisp_Object error;
4926 cmd_error_internal (error, "error in process filter: ");
4927 Vinhibit_quit = Qt;
4928 update_echo_area ();
4929 Fsleep_for (make_number (2), Qnil);
4930 return Qt;
4933 /* Read pending output from the process channel,
4934 starting with our buffered-ahead character if we have one.
4935 Yield number of decoded characters read.
4937 This function reads at most 4096 characters.
4938 If you want to read all available subprocess output,
4939 you must call it repeatedly until it returns zero.
4941 The characters read are decoded according to PROC's coding-system
4942 for decoding. */
4944 static int
4945 read_process_output (proc, channel)
4946 Lisp_Object proc;
4947 register int channel;
4949 register int nbytes;
4950 char *chars;
4951 register Lisp_Object outstream;
4952 register struct buffer *old = current_buffer;
4953 register struct Lisp_Process *p = XPROCESS (proc);
4954 register int opoint;
4955 struct coding_system *coding = proc_decode_coding_system[channel];
4956 int carryover = XINT (p->decoding_carryover);
4957 int readmax = 4096;
4959 #ifdef VMS
4960 VMS_PROC_STUFF *vs, *get_vms_process_pointer();
4962 vs = get_vms_process_pointer (p->pid);
4963 if (vs)
4965 if (!vs->iosb[0])
4966 return (0); /* Really weird if it does this */
4967 if (!(vs->iosb[0] & 1))
4968 return -1; /* I/O error */
4970 else
4971 error ("Could not get VMS process pointer");
4972 chars = vs->inputBuffer;
4973 nbytes = clean_vms_buffer (chars, vs->iosb[1]);
4974 if (nbytes <= 0)
4976 start_vms_process_read (vs); /* Crank up the next read on the process */
4977 return 1; /* Nothing worth printing, say we got 1 */
4979 if (carryover > 0)
4981 /* The data carried over in the previous decoding (which are at
4982 the tail of decoding buffer) should be prepended to the new
4983 data read to decode all together. */
4984 chars = (char *) alloca (nbytes + carryover);
4985 bcopy (SDATA (p->decoding_buf), buf, carryover);
4986 bcopy (vs->inputBuffer, chars + carryover, nbytes);
4988 #else /* not VMS */
4990 chars = (char *) alloca (carryover + readmax);
4991 if (carryover)
4992 /* See the comment above. */
4993 bcopy (SDATA (p->decoding_buf), chars, carryover);
4995 #ifdef DATAGRAM_SOCKETS
4996 /* We have a working select, so proc_buffered_char is always -1. */
4997 if (DATAGRAM_CHAN_P (channel))
4999 int len = datagram_address[channel].len;
5000 nbytes = recvfrom (channel, chars + carryover, readmax,
5001 0, datagram_address[channel].sa, &len);
5003 else
5004 #endif
5005 if (proc_buffered_char[channel] < 0)
5007 nbytes = emacs_read (channel, chars + carryover, readmax);
5008 #ifdef ADAPTIVE_READ_BUFFERING
5009 if (nbytes > 0 && !NILP (p->adaptive_read_buffering))
5011 int delay = XINT (p->read_output_delay);
5012 if (nbytes < 256)
5014 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5016 if (delay == 0)
5017 process_output_delay_count++;
5018 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5021 else if (delay > 0 && (nbytes == readmax))
5023 delay -= READ_OUTPUT_DELAY_INCREMENT;
5024 if (delay == 0)
5025 process_output_delay_count--;
5027 XSETINT (p->read_output_delay, delay);
5028 if (delay)
5030 p->read_output_skip = Qt;
5031 process_output_skip = 1;
5034 #endif
5036 else
5038 chars[carryover] = proc_buffered_char[channel];
5039 proc_buffered_char[channel] = -1;
5040 nbytes = emacs_read (channel, chars + carryover + 1, readmax - 1);
5041 if (nbytes < 0)
5042 nbytes = 1;
5043 else
5044 nbytes = nbytes + 1;
5046 #endif /* not VMS */
5048 XSETINT (p->decoding_carryover, 0);
5050 /* At this point, NBYTES holds number of bytes just received
5051 (including the one in proc_buffered_char[channel]). */
5052 if (nbytes <= 0)
5054 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5055 return nbytes;
5056 coding->mode |= CODING_MODE_LAST_BLOCK;
5059 /* Now set NBYTES how many bytes we must decode. */
5060 nbytes += carryover;
5062 /* Read and dispose of the process output. */
5063 outstream = p->filter;
5064 if (!NILP (outstream))
5066 /* We inhibit quit here instead of just catching it so that
5067 hitting ^G when a filter happens to be running won't screw
5068 it up. */
5069 int count = SPECPDL_INDEX ();
5070 Lisp_Object odeactivate;
5071 Lisp_Object obuffer, okeymap;
5072 Lisp_Object text;
5073 int outer_running_asynch_code = running_asynch_code;
5074 int waiting = waiting_for_user_input_p;
5076 /* No need to gcpro these, because all we do with them later
5077 is test them for EQness, and none of them should be a string. */
5078 odeactivate = Vdeactivate_mark;
5079 XSETBUFFER (obuffer, current_buffer);
5080 okeymap = current_buffer->keymap;
5082 specbind (Qinhibit_quit, Qt);
5083 specbind (Qlast_nonmenu_event, Qt);
5085 /* In case we get recursively called,
5086 and we already saved the match data nonrecursively,
5087 save the same match data in safely recursive fashion. */
5088 if (outer_running_asynch_code)
5090 Lisp_Object tem;
5091 /* Don't clobber the CURRENT match data, either! */
5092 tem = Fmatch_data (Qnil, Qnil, Qnil);
5093 restore_search_regs ();
5094 record_unwind_save_match_data ();
5095 Fset_match_data (tem, Qt);
5098 /* For speed, if a search happens within this code,
5099 save the match data in a special nonrecursive fashion. */
5100 running_asynch_code = 1;
5102 text = decode_coding_string (make_unibyte_string (chars, nbytes),
5103 coding, 0);
5104 Vlast_coding_system_used = coding->symbol;
5105 /* A new coding system might be found. */
5106 if (!EQ (p->decode_coding_system, coding->symbol))
5108 p->decode_coding_system = coding->symbol;
5110 /* Don't call setup_coding_system for
5111 proc_decode_coding_system[channel] here. It is done in
5112 detect_coding called via decode_coding above. */
5114 /* If a coding system for encoding is not yet decided, we set
5115 it as the same as coding-system for decoding.
5117 But, before doing that we must check if
5118 proc_encode_coding_system[p->outfd] surely points to a
5119 valid memory because p->outfd will be changed once EOF is
5120 sent to the process. */
5121 if (NILP (p->encode_coding_system)
5122 && proc_encode_coding_system[XINT (p->outfd)])
5124 p->encode_coding_system = coding->symbol;
5125 setup_coding_system (coding->symbol,
5126 proc_encode_coding_system[XINT (p->outfd)]);
5127 if (proc_encode_coding_system[XINT (p->outfd)]->eol_type
5128 == CODING_EOL_UNDECIDED)
5129 proc_encode_coding_system[XINT (p->outfd)]->eol_type
5130 = system_eol_type;
5134 carryover = nbytes - coding->consumed;
5135 if (SCHARS (p->decoding_buf) < carryover)
5136 p->decoding_buf = make_uninit_string (carryover);
5137 bcopy (chars + coding->consumed, SDATA (p->decoding_buf),
5138 carryover);
5139 XSETINT (p->decoding_carryover, carryover);
5140 /* Adjust the multibyteness of TEXT to that of the filter. */
5141 if (NILP (p->filter_multibyte) != ! STRING_MULTIBYTE (text))
5142 text = (STRING_MULTIBYTE (text)
5143 ? Fstring_as_unibyte (text)
5144 : Fstring_to_multibyte (text));
5145 if (SBYTES (text) > 0)
5146 internal_condition_case_1 (read_process_output_call,
5147 Fcons (outstream,
5148 Fcons (proc, Fcons (text, Qnil))),
5149 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5150 read_process_output_error_handler);
5152 /* If we saved the match data nonrecursively, restore it now. */
5153 restore_search_regs ();
5154 running_asynch_code = outer_running_asynch_code;
5156 /* Handling the process output should not deactivate the mark. */
5157 Vdeactivate_mark = odeactivate;
5159 /* Restore waiting_for_user_input_p as it was
5160 when we were called, in case the filter clobbered it. */
5161 waiting_for_user_input_p = waiting;
5163 #if 0 /* Call record_asynch_buffer_change unconditionally,
5164 because we might have changed minor modes or other things
5165 that affect key bindings. */
5166 if (! EQ (Fcurrent_buffer (), obuffer)
5167 || ! EQ (current_buffer->keymap, okeymap))
5168 #endif
5169 /* But do it only if the caller is actually going to read events.
5170 Otherwise there's no need to make him wake up, and it could
5171 cause trouble (for example it would make sit_for return). */
5172 if (waiting_for_user_input_p == -1)
5173 record_asynch_buffer_change ();
5175 #ifdef VMS
5176 start_vms_process_read (vs);
5177 #endif
5178 unbind_to (count, Qnil);
5179 return nbytes;
5182 /* If no filter, write into buffer if it isn't dead. */
5183 if (!NILP (p->buffer) && !NILP (XBUFFER (p->buffer)->name))
5185 Lisp_Object old_read_only;
5186 int old_begv, old_zv;
5187 int old_begv_byte, old_zv_byte;
5188 Lisp_Object odeactivate;
5189 int before, before_byte;
5190 int opoint_byte;
5191 Lisp_Object text;
5192 struct buffer *b;
5194 odeactivate = Vdeactivate_mark;
5196 Fset_buffer (p->buffer);
5197 opoint = PT;
5198 opoint_byte = PT_BYTE;
5199 old_read_only = current_buffer->read_only;
5200 old_begv = BEGV;
5201 old_zv = ZV;
5202 old_begv_byte = BEGV_BYTE;
5203 old_zv_byte = ZV_BYTE;
5205 current_buffer->read_only = Qnil;
5207 /* Insert new output into buffer
5208 at the current end-of-output marker,
5209 thus preserving logical ordering of input and output. */
5210 if (XMARKER (p->mark)->buffer)
5211 SET_PT_BOTH (clip_to_bounds (BEGV, marker_position (p->mark), ZV),
5212 clip_to_bounds (BEGV_BYTE, marker_byte_position (p->mark),
5213 ZV_BYTE));
5214 else
5215 SET_PT_BOTH (ZV, ZV_BYTE);
5216 before = PT;
5217 before_byte = PT_BYTE;
5219 /* If the output marker is outside of the visible region, save
5220 the restriction and widen. */
5221 if (! (BEGV <= PT && PT <= ZV))
5222 Fwiden ();
5224 text = decode_coding_string (make_unibyte_string (chars, nbytes),
5225 coding, 0);
5226 Vlast_coding_system_used = coding->symbol;
5227 /* A new coding system might be found. See the comment in the
5228 similar code in the previous `if' block. */
5229 if (!EQ (p->decode_coding_system, coding->symbol))
5231 p->decode_coding_system = coding->symbol;
5232 if (NILP (p->encode_coding_system)
5233 && proc_encode_coding_system[XINT (p->outfd)])
5235 p->encode_coding_system = coding->symbol;
5236 setup_coding_system (coding->symbol,
5237 proc_encode_coding_system[XINT (p->outfd)]);
5238 if (proc_encode_coding_system[XINT (p->outfd)]->eol_type
5239 == CODING_EOL_UNDECIDED)
5240 proc_encode_coding_system[XINT (p->outfd)]->eol_type
5241 = system_eol_type;
5244 carryover = nbytes - coding->consumed;
5245 if (SCHARS (p->decoding_buf) < carryover)
5246 p->decoding_buf = make_uninit_string (carryover);
5247 bcopy (chars + coding->consumed, SDATA (p->decoding_buf),
5248 carryover);
5249 XSETINT (p->decoding_carryover, carryover);
5250 /* Adjust the multibyteness of TEXT to that of the buffer. */
5251 if (NILP (current_buffer->enable_multibyte_characters)
5252 != ! STRING_MULTIBYTE (text))
5253 text = (STRING_MULTIBYTE (text)
5254 ? Fstring_as_unibyte (text)
5255 : Fstring_to_multibyte (text));
5256 /* Insert before markers in case we are inserting where
5257 the buffer's mark is, and the user's next command is Meta-y. */
5258 insert_from_string_before_markers (text, 0, 0,
5259 SCHARS (text), SBYTES (text), 0);
5261 /* Make sure the process marker's position is valid when the
5262 process buffer is changed in the signal_after_change above.
5263 W3 is known to do that. */
5264 if (BUFFERP (p->buffer)
5265 && (b = XBUFFER (p->buffer), b != current_buffer))
5266 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5267 else
5268 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5270 update_mode_lines++;
5272 /* Make sure opoint and the old restrictions
5273 float ahead of any new text just as point would. */
5274 if (opoint >= before)
5276 opoint += PT - before;
5277 opoint_byte += PT_BYTE - before_byte;
5279 if (old_begv > before)
5281 old_begv += PT - before;
5282 old_begv_byte += PT_BYTE - before_byte;
5284 if (old_zv >= before)
5286 old_zv += PT - before;
5287 old_zv_byte += PT_BYTE - before_byte;
5290 /* If the restriction isn't what it should be, set it. */
5291 if (old_begv != BEGV || old_zv != ZV)
5292 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5294 /* Handling the process output should not deactivate the mark. */
5295 Vdeactivate_mark = odeactivate;
5297 current_buffer->read_only = old_read_only;
5298 SET_PT_BOTH (opoint, opoint_byte);
5299 set_buffer_internal (old);
5301 #ifdef VMS
5302 start_vms_process_read (vs);
5303 #endif
5304 return nbytes;
5307 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p, Swaiting_for_user_input_p,
5308 0, 0, 0,
5309 doc: /* Returns non-nil if Emacs is waiting for input from the user.
5310 This is intended for use by asynchronous process output filters and sentinels. */)
5313 return (waiting_for_user_input_p ? Qt : Qnil);
5316 /* Sending data to subprocess */
5318 jmp_buf send_process_frame;
5319 Lisp_Object process_sent_to;
5321 SIGTYPE
5322 send_process_trap ()
5324 SIGNAL_THREAD_CHECK (SIGPIPE);
5325 #ifdef BSD4_1
5326 sigrelse (SIGPIPE);
5327 sigrelse (SIGALRM);
5328 #endif /* BSD4_1 */
5329 sigunblock (sigmask (SIGPIPE));
5330 longjmp (send_process_frame, 1);
5333 /* Send some data to process PROC.
5334 BUF is the beginning of the data; LEN is the number of characters.
5335 OBJECT is the Lisp object that the data comes from. If OBJECT is
5336 nil or t, it means that the data comes from C string.
5338 If OBJECT is not nil, the data is encoded by PROC's coding-system
5339 for encoding before it is sent.
5341 This function can evaluate Lisp code and can garbage collect. */
5343 static void
5344 send_process (proc, buf, len, object)
5345 volatile Lisp_Object proc;
5346 unsigned char *volatile buf;
5347 volatile int len;
5348 volatile Lisp_Object object;
5350 /* Use volatile to protect variables from being clobbered by longjmp. */
5351 struct Lisp_Process *p = XPROCESS (proc);
5352 int rv;
5353 struct coding_system *coding;
5354 struct gcpro gcpro1;
5355 SIGTYPE (*volatile old_sigpipe) ();
5357 GCPRO1 (object);
5359 #ifdef VMS
5360 VMS_PROC_STUFF *vs, *get_vms_process_pointer();
5361 #endif /* VMS */
5363 if (p->raw_status_new)
5364 update_status (p);
5365 if (! EQ (p->status, Qrun))
5366 error ("Process %s not running", SDATA (p->name));
5367 if (XINT (p->outfd) < 0)
5368 error ("Output file descriptor of %s is closed", SDATA (p->name));
5370 coding = proc_encode_coding_system[XINT (p->outfd)];
5371 Vlast_coding_system_used = coding->symbol;
5373 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5374 || (BUFFERP (object)
5375 && !NILP (XBUFFER (object)->enable_multibyte_characters))
5376 || EQ (object, Qt))
5378 if (!EQ (coding->symbol, p->encode_coding_system))
5379 /* The coding system for encoding was changed to raw-text
5380 because we sent a unibyte text previously. Now we are
5381 sending a multibyte text, thus we must encode it by the
5382 original coding system specified for the current process. */
5383 setup_coding_system (p->encode_coding_system, coding);
5384 if (coding->eol_type == CODING_EOL_UNDECIDED)
5385 coding->eol_type = system_eol_type;
5386 /* src_multibyte should be set to 1 _after_ a call to
5387 setup_coding_system, since it resets src_multibyte to
5388 zero. */
5389 coding->src_multibyte = 1;
5391 else
5393 /* For sending a unibyte text, character code conversion should
5394 not take place but EOL conversion should. So, setup raw-text
5395 or one of the subsidiary if we have not yet done it. */
5396 if (coding->type != coding_type_raw_text)
5398 if (CODING_REQUIRE_FLUSHING (coding))
5400 /* But, before changing the coding, we must flush out data. */
5401 coding->mode |= CODING_MODE_LAST_BLOCK;
5402 send_process (proc, "", 0, Qt);
5404 coding->src_multibyte = 0;
5405 setup_raw_text_coding_system (coding);
5408 coding->dst_multibyte = 0;
5410 if (CODING_REQUIRE_ENCODING (coding))
5412 int require = encoding_buffer_size (coding, len);
5413 int from_byte = -1, from = -1, to = -1;
5415 if (BUFFERP (object))
5417 from_byte = BUF_PTR_BYTE_POS (XBUFFER (object), buf);
5418 from = buf_bytepos_to_charpos (XBUFFER (object), from_byte);
5419 to = buf_bytepos_to_charpos (XBUFFER (object), from_byte + len);
5421 else if (STRINGP (object))
5423 from_byte = buf - SDATA (object);
5424 from = string_byte_to_char (object, from_byte);
5425 to = string_byte_to_char (object, from_byte + len);
5428 if (coding->composing != COMPOSITION_DISABLED)
5430 if (from_byte >= 0)
5431 coding_save_composition (coding, from, to, object);
5432 else
5433 coding->composing = COMPOSITION_DISABLED;
5436 if (SBYTES (p->encoding_buf) < require)
5437 p->encoding_buf = make_uninit_string (require);
5439 if (from_byte >= 0)
5440 buf = (BUFFERP (object)
5441 ? BUF_BYTE_ADDRESS (XBUFFER (object), from_byte)
5442 : SDATA (object) + from_byte);
5444 object = p->encoding_buf;
5445 encode_coding (coding, (char *) buf, SDATA (object),
5446 len, SBYTES (object));
5447 coding_free_composition_data (coding);
5448 len = coding->produced;
5449 buf = SDATA (object);
5452 #ifdef VMS
5453 vs = get_vms_process_pointer (p->pid);
5454 if (vs == 0)
5455 error ("Could not find this process: %x", p->pid);
5456 else if (write_to_vms_process (vs, buf, len))
5458 #else /* not VMS */
5460 if (pty_max_bytes == 0)
5462 #if defined (HAVE_FPATHCONF) && defined (_PC_MAX_CANON)
5463 pty_max_bytes = fpathconf (XFASTINT (p->outfd), _PC_MAX_CANON);
5464 if (pty_max_bytes < 0)
5465 pty_max_bytes = 250;
5466 #else
5467 pty_max_bytes = 250;
5468 #endif
5469 /* Deduct one, to leave space for the eof. */
5470 pty_max_bytes--;
5473 /* 2000-09-21: Emacs 20.7, sparc-sun-solaris-2.6, GCC 2.95.2,
5474 CFLAGS="-g -O": The value of the parameter `proc' is clobbered
5475 when returning with longjmp despite being declared volatile. */
5476 if (!setjmp (send_process_frame))
5478 process_sent_to = proc;
5479 while (len > 0)
5481 int this = len;
5483 /* Decide how much data we can send in one batch.
5484 Long lines need to be split into multiple batches. */
5485 if (!NILP (p->pty_flag))
5487 /* Starting this at zero is always correct when not the first
5488 iteration because the previous iteration ended by sending C-d.
5489 It may not be correct for the first iteration
5490 if a partial line was sent in a separate send_process call.
5491 If that proves worth handling, we need to save linepos
5492 in the process object. */
5493 int linepos = 0;
5494 unsigned char *ptr = (unsigned char *) buf;
5495 unsigned char *end = (unsigned char *) buf + len;
5497 /* Scan through this text for a line that is too long. */
5498 while (ptr != end && linepos < pty_max_bytes)
5500 if (*ptr == '\n')
5501 linepos = 0;
5502 else
5503 linepos++;
5504 ptr++;
5506 /* If we found one, break the line there
5507 and put in a C-d to force the buffer through. */
5508 this = ptr - buf;
5511 /* Send this batch, using one or more write calls. */
5512 while (this > 0)
5514 int outfd = XINT (p->outfd);
5515 old_sigpipe = (SIGTYPE (*) ()) signal (SIGPIPE, send_process_trap);
5516 #ifdef DATAGRAM_SOCKETS
5517 if (DATAGRAM_CHAN_P (outfd))
5519 rv = sendto (outfd, (char *) buf, this,
5520 0, datagram_address[outfd].sa,
5521 datagram_address[outfd].len);
5522 if (rv < 0 && errno == EMSGSIZE)
5524 signal (SIGPIPE, old_sigpipe);
5525 report_file_error ("sending datagram",
5526 Fcons (proc, Qnil));
5529 else
5530 #endif
5532 rv = emacs_write (outfd, (char *) buf, this);
5533 #ifdef ADAPTIVE_READ_BUFFERING
5534 if (XINT (p->read_output_delay) > 0
5535 && EQ (p->adaptive_read_buffering, Qt))
5537 XSETFASTINT (p->read_output_delay, 0);
5538 process_output_delay_count--;
5539 p->read_output_skip = Qnil;
5541 #endif
5543 signal (SIGPIPE, old_sigpipe);
5545 if (rv < 0)
5547 if (0
5548 #ifdef EWOULDBLOCK
5549 || errno == EWOULDBLOCK
5550 #endif
5551 #ifdef EAGAIN
5552 || errno == EAGAIN
5553 #endif
5555 /* Buffer is full. Wait, accepting input;
5556 that may allow the program
5557 to finish doing output and read more. */
5559 int offset = 0;
5561 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5562 /* A gross hack to work around a bug in FreeBSD.
5563 In the following sequence, read(2) returns
5564 bogus data:
5566 write(2) 1022 bytes
5567 write(2) 954 bytes, get EAGAIN
5568 read(2) 1024 bytes in process_read_output
5569 read(2) 11 bytes in process_read_output
5571 That is, read(2) returns more bytes than have
5572 ever been written successfully. The 1033 bytes
5573 read are the 1022 bytes written successfully
5574 after processing (for example with CRs added if
5575 the terminal is set up that way which it is
5576 here). The same bytes will be seen again in a
5577 later read(2), without the CRs. */
5579 if (errno == EAGAIN)
5581 int flags = FWRITE;
5582 ioctl (XINT (p->outfd), TIOCFLUSH, &flags);
5584 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5586 /* Running filters might relocate buffers or strings.
5587 Arrange to relocate BUF. */
5588 if (BUFFERP (object))
5589 offset = BUF_PTR_BYTE_POS (XBUFFER (object), buf);
5590 else if (STRINGP (object))
5591 offset = buf - SDATA (object);
5593 #ifdef EMACS_HAS_USECS
5594 wait_reading_process_output (0, 20000, 0, 0, Qnil, NULL, 0);
5595 #else
5596 wait_reading_process_output (1, 0, 0, 0, Qnil, NULL, 0);
5597 #endif
5599 if (BUFFERP (object))
5600 buf = BUF_BYTE_ADDRESS (XBUFFER (object), offset);
5601 else if (STRINGP (object))
5602 buf = offset + SDATA (object);
5604 rv = 0;
5606 else
5607 /* This is a real error. */
5608 report_file_error ("writing to process", Fcons (proc, Qnil));
5610 buf += rv;
5611 len -= rv;
5612 this -= rv;
5615 /* If we sent just part of the string, put in an EOF
5616 to force it through, before we send the rest. */
5617 if (len > 0)
5618 Fprocess_send_eof (proc);
5621 #endif /* not VMS */
5622 else
5624 signal (SIGPIPE, old_sigpipe);
5625 #ifndef VMS
5626 proc = process_sent_to;
5627 p = XPROCESS (proc);
5628 #endif
5629 p->raw_status_new = 0;
5630 p->status = Fcons (Qexit, Fcons (make_number (256), Qnil));
5631 XSETINT (p->tick, ++process_tick);
5632 deactivate_process (proc);
5633 #ifdef VMS
5634 error ("Error writing to process %s; closed it", SDATA (p->name));
5635 #else
5636 error ("SIGPIPE raised on process %s; closed it", SDATA (p->name));
5637 #endif
5640 UNGCPRO;
5643 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5644 3, 3, 0,
5645 doc: /* Send current contents of region as input to PROCESS.
5646 PROCESS may be a process, a buffer, the name of a process or buffer, or
5647 nil, indicating the current buffer's process.
5648 Called from program, takes three arguments, PROCESS, START and END.
5649 If the region is more than 500 characters long,
5650 it is sent in several bunches. This may happen even for shorter regions.
5651 Output from processes can arrive in between bunches. */)
5652 (process, start, end)
5653 Lisp_Object process, start, end;
5655 Lisp_Object proc;
5656 int start1, end1;
5658 proc = get_process (process);
5659 validate_region (&start, &end);
5661 if (XINT (start) < GPT && XINT (end) > GPT)
5662 move_gap (XINT (start));
5664 start1 = CHAR_TO_BYTE (XINT (start));
5665 end1 = CHAR_TO_BYTE (XINT (end));
5666 send_process (proc, BYTE_POS_ADDR (start1), end1 - start1,
5667 Fcurrent_buffer ());
5669 return Qnil;
5672 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5673 2, 2, 0,
5674 doc: /* Send PROCESS the contents of STRING as input.
5675 PROCESS may be a process, a buffer, the name of a process or buffer, or
5676 nil, indicating the current buffer's process.
5677 If STRING is more than 500 characters long,
5678 it is sent in several bunches. This may happen even for shorter strings.
5679 Output from processes can arrive in between bunches. */)
5680 (process, string)
5681 Lisp_Object process, string;
5683 Lisp_Object proc;
5684 CHECK_STRING (string);
5685 proc = get_process (process);
5686 send_process (proc, SDATA (string),
5687 SBYTES (string), string);
5688 return Qnil;
5691 /* Return the foreground process group for the tty/pty that
5692 the process P uses. */
5693 static int
5694 emacs_get_tty_pgrp (p)
5695 struct Lisp_Process *p;
5697 int gid = -1;
5699 #ifdef TIOCGPGRP
5700 if (ioctl (XINT (p->infd), TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5702 int fd;
5703 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5704 master side. Try the slave side. */
5705 fd = emacs_open (XSTRING (p->tty_name)->data, O_RDONLY, 0);
5707 if (fd != -1)
5709 ioctl (fd, TIOCGPGRP, &gid);
5710 emacs_close (fd);
5713 #endif /* defined (TIOCGPGRP ) */
5715 return gid;
5718 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5719 Sprocess_running_child_p, 0, 1, 0,
5720 doc: /* Return t if PROCESS has given the terminal to a child.
5721 If the operating system does not make it possible to find out,
5722 return t unconditionally. */)
5723 (process)
5724 Lisp_Object process;
5726 /* Initialize in case ioctl doesn't exist or gives an error,
5727 in a way that will cause returning t. */
5728 int gid;
5729 Lisp_Object proc;
5730 struct Lisp_Process *p;
5732 proc = get_process (process);
5733 p = XPROCESS (proc);
5735 if (!EQ (p->childp, Qt))
5736 error ("Process %s is not a subprocess",
5737 SDATA (p->name));
5738 if (XINT (p->infd) < 0)
5739 error ("Process %s is not active",
5740 SDATA (p->name));
5742 gid = emacs_get_tty_pgrp (p);
5744 if (gid == p->pid)
5745 return Qnil;
5746 return Qt;
5749 /* send a signal number SIGNO to PROCESS.
5750 If CURRENT_GROUP is t, that means send to the process group
5751 that currently owns the terminal being used to communicate with PROCESS.
5752 This is used for various commands in shell mode.
5753 If CURRENT_GROUP is lambda, that means send to the process group
5754 that currently owns the terminal, but only if it is NOT the shell itself.
5756 If NOMSG is zero, insert signal-announcements into process's buffers
5757 right away.
5759 If we can, we try to signal PROCESS by sending control characters
5760 down the pty. This allows us to signal inferiors who have changed
5761 their uid, for which killpg would return an EPERM error. */
5763 static void
5764 process_send_signal (process, signo, current_group, nomsg)
5765 Lisp_Object process;
5766 int signo;
5767 Lisp_Object current_group;
5768 int nomsg;
5770 Lisp_Object proc;
5771 register struct Lisp_Process *p;
5772 int gid;
5773 int no_pgrp = 0;
5775 proc = get_process (process);
5776 p = XPROCESS (proc);
5778 if (!EQ (p->childp, Qt))
5779 error ("Process %s is not a subprocess",
5780 SDATA (p->name));
5781 if (XINT (p->infd) < 0)
5782 error ("Process %s is not active",
5783 SDATA (p->name));
5785 if (NILP (p->pty_flag))
5786 current_group = Qnil;
5788 /* If we are using pgrps, get a pgrp number and make it negative. */
5789 if (NILP (current_group))
5790 /* Send the signal to the shell's process group. */
5791 gid = p->pid;
5792 else
5794 #ifdef SIGNALS_VIA_CHARACTERS
5795 /* If possible, send signals to the entire pgrp
5796 by sending an input character to it. */
5798 /* TERMIOS is the latest and bestest, and seems most likely to
5799 work. If the system has it, use it. */
5800 #ifdef HAVE_TERMIOS
5801 struct termios t;
5802 cc_t *sig_char = NULL;
5804 tcgetattr (XINT (p->infd), &t);
5806 switch (signo)
5808 case SIGINT:
5809 sig_char = &t.c_cc[VINTR];
5810 break;
5812 case SIGQUIT:
5813 sig_char = &t.c_cc[VQUIT];
5814 break;
5816 case SIGTSTP:
5817 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5818 sig_char = &t.c_cc[VSWTCH];
5819 #else
5820 sig_char = &t.c_cc[VSUSP];
5821 #endif
5822 break;
5825 if (sig_char && *sig_char != CDISABLE)
5827 send_process (proc, sig_char, 1, Qnil);
5828 return;
5830 /* If we can't send the signal with a character,
5831 fall through and send it another way. */
5832 #else /* ! HAVE_TERMIOS */
5834 /* On Berkeley descendants, the following IOCTL's retrieve the
5835 current control characters. */
5836 #if defined (TIOCGLTC) && defined (TIOCGETC)
5838 struct tchars c;
5839 struct ltchars lc;
5841 switch (signo)
5843 case SIGINT:
5844 ioctl (XINT (p->infd), TIOCGETC, &c);
5845 send_process (proc, &c.t_intrc, 1, Qnil);
5846 return;
5847 case SIGQUIT:
5848 ioctl (XINT (p->infd), TIOCGETC, &c);
5849 send_process (proc, &c.t_quitc, 1, Qnil);
5850 return;
5851 #ifdef SIGTSTP
5852 case SIGTSTP:
5853 ioctl (XINT (p->infd), TIOCGLTC, &lc);
5854 send_process (proc, &lc.t_suspc, 1, Qnil);
5855 return;
5856 #endif /* ! defined (SIGTSTP) */
5859 #else /* ! defined (TIOCGLTC) && defined (TIOCGETC) */
5861 /* On SYSV descendants, the TCGETA ioctl retrieves the current control
5862 characters. */
5863 #ifdef TCGETA
5864 struct termio t;
5865 switch (signo)
5867 case SIGINT:
5868 ioctl (XINT (p->infd), TCGETA, &t);
5869 send_process (proc, &t.c_cc[VINTR], 1, Qnil);
5870 return;
5871 case SIGQUIT:
5872 ioctl (XINT (p->infd), TCGETA, &t);
5873 send_process (proc, &t.c_cc[VQUIT], 1, Qnil);
5874 return;
5875 #ifdef SIGTSTP
5876 case SIGTSTP:
5877 ioctl (XINT (p->infd), TCGETA, &t);
5878 send_process (proc, &t.c_cc[VSWTCH], 1, Qnil);
5879 return;
5880 #endif /* ! defined (SIGTSTP) */
5882 #else /* ! defined (TCGETA) */
5883 Your configuration files are messed up.
5884 /* If your system configuration files define SIGNALS_VIA_CHARACTERS,
5885 you'd better be using one of the alternatives above! */
5886 #endif /* ! defined (TCGETA) */
5887 #endif /* ! defined (TIOCGLTC) && defined (TIOCGETC) */
5888 /* In this case, the code above should alway returns. */
5889 abort ();
5890 #endif /* ! defined HAVE_TERMIOS */
5892 /* The code above may fall through if it can't
5893 handle the signal. */
5894 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5896 #ifdef TIOCGPGRP
5897 /* Get the current pgrp using the tty itself, if we have that.
5898 Otherwise, use the pty to get the pgrp.
5899 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5900 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5901 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5902 His patch indicates that if TIOCGPGRP returns an error, then
5903 we should just assume that p->pid is also the process group id. */
5905 gid = emacs_get_tty_pgrp (p);
5907 if (gid == -1)
5908 /* If we can't get the information, assume
5909 the shell owns the tty. */
5910 gid = p->pid;
5912 /* It is not clear whether anything really can set GID to -1.
5913 Perhaps on some system one of those ioctls can or could do so.
5914 Or perhaps this is vestigial. */
5915 if (gid == -1)
5916 no_pgrp = 1;
5917 #else /* ! defined (TIOCGPGRP ) */
5918 /* Can't select pgrps on this system, so we know that
5919 the child itself heads the pgrp. */
5920 gid = p->pid;
5921 #endif /* ! defined (TIOCGPGRP ) */
5923 /* If current_group is lambda, and the shell owns the terminal,
5924 don't send any signal. */
5925 if (EQ (current_group, Qlambda) && gid == p->pid)
5926 return;
5929 switch (signo)
5931 #ifdef SIGCONT
5932 case SIGCONT:
5933 p->raw_status_new = 0;
5934 p->status = Qrun;
5935 XSETINT (p->tick, ++process_tick);
5936 if (!nomsg)
5937 status_notify (NULL);
5938 break;
5939 #endif /* ! defined (SIGCONT) */
5940 case SIGINT:
5941 #ifdef VMS
5942 send_process (proc, "\003", 1, Qnil); /* ^C */
5943 goto whoosh;
5944 #endif
5945 case SIGQUIT:
5946 #ifdef VMS
5947 send_process (proc, "\031", 1, Qnil); /* ^Y */
5948 goto whoosh;
5949 #endif
5950 case SIGKILL:
5951 #ifdef VMS
5952 sys$forcex (&(p->pid), 0, 1);
5953 whoosh:
5954 #endif
5955 flush_pending_output (XINT (p->infd));
5956 break;
5959 /* If we don't have process groups, send the signal to the immediate
5960 subprocess. That isn't really right, but it's better than any
5961 obvious alternative. */
5962 if (no_pgrp)
5964 kill (p->pid, signo);
5965 return;
5968 /* gid may be a pid, or minus a pgrp's number */
5969 #ifdef TIOCSIGSEND
5970 if (!NILP (current_group))
5972 if (ioctl (XINT (p->infd), TIOCSIGSEND, signo) == -1)
5973 EMACS_KILLPG (gid, signo);
5975 else
5977 gid = - p->pid;
5978 kill (gid, signo);
5980 #else /* ! defined (TIOCSIGSEND) */
5981 EMACS_KILLPG (gid, signo);
5982 #endif /* ! defined (TIOCSIGSEND) */
5985 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5986 doc: /* Interrupt process PROCESS.
5987 PROCESS may be a process, a buffer, or the name of a process or buffer.
5988 No arg or nil means current buffer's process.
5989 Second arg CURRENT-GROUP non-nil means send signal to
5990 the current process-group of the process's controlling terminal
5991 rather than to the process's own process group.
5992 If the process is a shell, this means interrupt current subjob
5993 rather than the shell.
5995 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5996 don't send the signal. */)
5997 (process, current_group)
5998 Lisp_Object process, current_group;
6000 process_send_signal (process, SIGINT, current_group, 0);
6001 return process;
6004 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
6005 doc: /* Kill process PROCESS. May be process or name of one.
6006 See function `interrupt-process' for more details on usage. */)
6007 (process, current_group)
6008 Lisp_Object process, current_group;
6010 process_send_signal (process, SIGKILL, current_group, 0);
6011 return process;
6014 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
6015 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
6016 See function `interrupt-process' for more details on usage. */)
6017 (process, current_group)
6018 Lisp_Object process, current_group;
6020 process_send_signal (process, SIGQUIT, current_group, 0);
6021 return process;
6024 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
6025 doc: /* Stop process PROCESS. May be process or name of one.
6026 See function `interrupt-process' for more details on usage.
6027 If PROCESS is a network process, inhibit handling of incoming traffic. */)
6028 (process, current_group)
6029 Lisp_Object process, current_group;
6031 #ifdef HAVE_SOCKETS
6032 if (PROCESSP (process) && NETCONN_P (process))
6034 struct Lisp_Process *p;
6036 p = XPROCESS (process);
6037 if (NILP (p->command)
6038 && XINT (p->infd) >= 0)
6040 FD_CLR (XINT (p->infd), &input_wait_mask);
6041 FD_CLR (XINT (p->infd), &non_keyboard_wait_mask);
6043 p->command = Qt;
6044 return process;
6046 #endif
6047 #ifndef SIGTSTP
6048 error ("No SIGTSTP support");
6049 #else
6050 process_send_signal (process, SIGTSTP, current_group, 0);
6051 #endif
6052 return process;
6055 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
6056 doc: /* Continue process PROCESS. May be process or name of one.
6057 See function `interrupt-process' for more details on usage.
6058 If PROCESS is a network process, resume handling of incoming traffic. */)
6059 (process, current_group)
6060 Lisp_Object process, current_group;
6062 #ifdef HAVE_SOCKETS
6063 if (PROCESSP (process) && NETCONN_P (process))
6065 struct Lisp_Process *p;
6067 p = XPROCESS (process);
6068 if (EQ (p->command, Qt)
6069 && XINT (p->infd) >= 0
6070 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
6072 FD_SET (XINT (p->infd), &input_wait_mask);
6073 FD_SET (XINT (p->infd), &non_keyboard_wait_mask);
6075 p->command = Qnil;
6076 return process;
6078 #endif
6079 #ifdef SIGCONT
6080 process_send_signal (process, SIGCONT, current_group, 0);
6081 #else
6082 error ("No SIGCONT support");
6083 #endif
6084 return process;
6087 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
6088 2, 2, "sProcess (name or number): \nnSignal code: ",
6089 doc: /* Send PROCESS the signal with code SIGCODE.
6090 PROCESS may also be an integer specifying the process id of the
6091 process to signal; in this case, the process need not be a child of
6092 this Emacs.
6093 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
6094 (process, sigcode)
6095 Lisp_Object process, sigcode;
6097 pid_t pid;
6099 if (INTEGERP (process))
6101 pid = XINT (process);
6102 goto got_it;
6105 if (FLOATP (process))
6107 pid = (pid_t) XFLOAT (process);
6108 goto got_it;
6111 if (STRINGP (process))
6113 Lisp_Object tem;
6114 if (tem = Fget_process (process), NILP (tem))
6116 pid = XINT (Fstring_to_number (process, make_number (10)));
6117 if (pid > 0)
6118 goto got_it;
6120 process = tem;
6122 else
6123 process = get_process (process);
6125 if (NILP (process))
6126 return process;
6128 CHECK_PROCESS (process);
6129 pid = XPROCESS (process)->pid;
6130 if (pid <= 0)
6131 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
6133 got_it:
6135 #define handle_signal(NAME, VALUE) \
6136 else if (!strcmp (name, NAME)) \
6137 XSETINT (sigcode, VALUE)
6139 if (INTEGERP (sigcode))
6141 else
6143 unsigned char *name;
6145 CHECK_SYMBOL (sigcode);
6146 name = SDATA (SYMBOL_NAME (sigcode));
6148 if (!strncmp(name, "SIG", 3))
6149 name += 3;
6151 if (0)
6153 #ifdef SIGHUP
6154 handle_signal ("HUP", SIGHUP);
6155 #endif
6156 #ifdef SIGINT
6157 handle_signal ("INT", SIGINT);
6158 #endif
6159 #ifdef SIGQUIT
6160 handle_signal ("QUIT", SIGQUIT);
6161 #endif
6162 #ifdef SIGILL
6163 handle_signal ("ILL", SIGILL);
6164 #endif
6165 #ifdef SIGABRT
6166 handle_signal ("ABRT", SIGABRT);
6167 #endif
6168 #ifdef SIGEMT
6169 handle_signal ("EMT", SIGEMT);
6170 #endif
6171 #ifdef SIGKILL
6172 handle_signal ("KILL", SIGKILL);
6173 #endif
6174 #ifdef SIGFPE
6175 handle_signal ("FPE", SIGFPE);
6176 #endif
6177 #ifdef SIGBUS
6178 handle_signal ("BUS", SIGBUS);
6179 #endif
6180 #ifdef SIGSEGV
6181 handle_signal ("SEGV", SIGSEGV);
6182 #endif
6183 #ifdef SIGSYS
6184 handle_signal ("SYS", SIGSYS);
6185 #endif
6186 #ifdef SIGPIPE
6187 handle_signal ("PIPE", SIGPIPE);
6188 #endif
6189 #ifdef SIGALRM
6190 handle_signal ("ALRM", SIGALRM);
6191 #endif
6192 #ifdef SIGTERM
6193 handle_signal ("TERM", SIGTERM);
6194 #endif
6195 #ifdef SIGURG
6196 handle_signal ("URG", SIGURG);
6197 #endif
6198 #ifdef SIGSTOP
6199 handle_signal ("STOP", SIGSTOP);
6200 #endif
6201 #ifdef SIGTSTP
6202 handle_signal ("TSTP", SIGTSTP);
6203 #endif
6204 #ifdef SIGCONT
6205 handle_signal ("CONT", SIGCONT);
6206 #endif
6207 #ifdef SIGCHLD
6208 handle_signal ("CHLD", SIGCHLD);
6209 #endif
6210 #ifdef SIGTTIN
6211 handle_signal ("TTIN", SIGTTIN);
6212 #endif
6213 #ifdef SIGTTOU
6214 handle_signal ("TTOU", SIGTTOU);
6215 #endif
6216 #ifdef SIGIO
6217 handle_signal ("IO", SIGIO);
6218 #endif
6219 #ifdef SIGXCPU
6220 handle_signal ("XCPU", SIGXCPU);
6221 #endif
6222 #ifdef SIGXFSZ
6223 handle_signal ("XFSZ", SIGXFSZ);
6224 #endif
6225 #ifdef SIGVTALRM
6226 handle_signal ("VTALRM", SIGVTALRM);
6227 #endif
6228 #ifdef SIGPROF
6229 handle_signal ("PROF", SIGPROF);
6230 #endif
6231 #ifdef SIGWINCH
6232 handle_signal ("WINCH", SIGWINCH);
6233 #endif
6234 #ifdef SIGINFO
6235 handle_signal ("INFO", SIGINFO);
6236 #endif
6237 #ifdef SIGUSR1
6238 handle_signal ("USR1", SIGUSR1);
6239 #endif
6240 #ifdef SIGUSR2
6241 handle_signal ("USR2", SIGUSR2);
6242 #endif
6243 else
6244 error ("Undefined signal name %s", name);
6247 #undef handle_signal
6249 return make_number (kill (pid, XINT (sigcode)));
6252 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6253 doc: /* Make PROCESS see end-of-file in its input.
6254 EOF comes after any text already sent to it.
6255 PROCESS may be a process, a buffer, the name of a process or buffer, or
6256 nil, indicating the current buffer's process.
6257 If PROCESS is a network connection, or is a process communicating
6258 through a pipe (as opposed to a pty), then you cannot send any more
6259 text to PROCESS after you call this function. */)
6260 (process)
6261 Lisp_Object process;
6263 Lisp_Object proc;
6264 struct coding_system *coding;
6266 if (DATAGRAM_CONN_P (process))
6267 return process;
6269 proc = get_process (process);
6270 coding = proc_encode_coding_system[XINT (XPROCESS (proc)->outfd)];
6272 /* Make sure the process is really alive. */
6273 if (XPROCESS (proc)->raw_status_new)
6274 update_status (XPROCESS (proc));
6275 if (! EQ (XPROCESS (proc)->status, Qrun))
6276 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6278 if (CODING_REQUIRE_FLUSHING (coding))
6280 coding->mode |= CODING_MODE_LAST_BLOCK;
6281 send_process (proc, "", 0, Qnil);
6284 #ifdef VMS
6285 send_process (proc, "\032", 1, Qnil); /* ^z */
6286 #else
6287 if (!NILP (XPROCESS (proc)->pty_flag))
6288 send_process (proc, "\004", 1, Qnil);
6289 else
6291 int old_outfd, new_outfd;
6293 #ifdef HAVE_SHUTDOWN
6294 /* If this is a network connection, or socketpair is used
6295 for communication with the subprocess, call shutdown to cause EOF.
6296 (In some old system, shutdown to socketpair doesn't work.
6297 Then we just can't win.) */
6298 if (XPROCESS (proc)->pid == 0
6299 || XINT (XPROCESS (proc)->outfd) == XINT (XPROCESS (proc)->infd))
6300 shutdown (XINT (XPROCESS (proc)->outfd), 1);
6301 /* In case of socketpair, outfd == infd, so don't close it. */
6302 if (XINT (XPROCESS (proc)->outfd) != XINT (XPROCESS (proc)->infd))
6303 emacs_close (XINT (XPROCESS (proc)->outfd));
6304 #else /* not HAVE_SHUTDOWN */
6305 emacs_close (XINT (XPROCESS (proc)->outfd));
6306 #endif /* not HAVE_SHUTDOWN */
6307 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6308 if (new_outfd < 0)
6309 abort ();
6310 old_outfd = XINT (XPROCESS (proc)->outfd);
6312 if (!proc_encode_coding_system[new_outfd])
6313 proc_encode_coding_system[new_outfd]
6314 = (struct coding_system *) xmalloc (sizeof (struct coding_system));
6315 bcopy (proc_encode_coding_system[old_outfd],
6316 proc_encode_coding_system[new_outfd],
6317 sizeof (struct coding_system));
6318 bzero (proc_encode_coding_system[old_outfd],
6319 sizeof (struct coding_system));
6321 XSETINT (XPROCESS (proc)->outfd, new_outfd);
6323 #endif /* VMS */
6324 return process;
6327 /* Kill all processes associated with `buffer'.
6328 If `buffer' is nil, kill all processes */
6330 void
6331 kill_buffer_processes (buffer)
6332 Lisp_Object buffer;
6334 Lisp_Object tail, proc;
6336 for (tail = Vprocess_alist; GC_CONSP (tail); tail = XCDR (tail))
6338 proc = XCDR (XCAR (tail));
6339 if (GC_PROCESSP (proc)
6340 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
6342 if (NETCONN_P (proc))
6343 Fdelete_process (proc);
6344 else if (XINT (XPROCESS (proc)->infd) >= 0)
6345 process_send_signal (proc, SIGHUP, Qnil, 1);
6350 /* On receipt of a signal that a child status has changed, loop asking
6351 about children with changed statuses until the system says there
6352 are no more.
6354 All we do is change the status; we do not run sentinels or print
6355 notifications. That is saved for the next time keyboard input is
6356 done, in order to avoid timing errors.
6358 ** WARNING: this can be called during garbage collection.
6359 Therefore, it must not be fooled by the presence of mark bits in
6360 Lisp objects.
6362 ** USG WARNING: Although it is not obvious from the documentation
6363 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6364 signal() before executing at least one wait(), otherwise the
6365 handler will be called again, resulting in an infinite loop. The
6366 relevant portion of the documentation reads "SIGCLD signals will be
6367 queued and the signal-catching function will be continually
6368 reentered until the queue is empty". Invoking signal() causes the
6369 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6370 Inc.
6372 ** Malloc WARNING: This should never call malloc either directly or
6373 indirectly; if it does, that is a bug */
6375 #ifdef SIGCHLD
6376 SIGTYPE
6377 sigchld_handler (signo)
6378 int signo;
6380 int old_errno = errno;
6381 Lisp_Object proc;
6382 register struct Lisp_Process *p;
6383 extern EMACS_TIME *input_available_clear_time;
6385 SIGNAL_THREAD_CHECK (signo);
6387 #ifdef BSD4_1
6388 extern int sigheld;
6389 sigheld |= sigbit (SIGCHLD);
6390 #endif
6392 while (1)
6394 register int pid;
6395 WAITTYPE w;
6396 Lisp_Object tail;
6398 #ifdef WNOHANG
6399 #ifndef WUNTRACED
6400 #define WUNTRACED 0
6401 #endif /* no WUNTRACED */
6402 /* Keep trying to get a status until we get a definitive result. */
6405 errno = 0;
6406 pid = wait3 (&w, WNOHANG | WUNTRACED, 0);
6408 while (pid < 0 && errno == EINTR);
6410 if (pid <= 0)
6412 /* PID == 0 means no processes found, PID == -1 means a real
6413 failure. We have done all our job, so return. */
6415 /* USG systems forget handlers when they are used;
6416 must reestablish each time */
6417 #if defined (USG) && !defined (POSIX_SIGNALS)
6418 signal (signo, sigchld_handler); /* WARNING - must come after wait3() */
6419 #endif
6420 #ifdef BSD4_1
6421 sigheld &= ~sigbit (SIGCHLD);
6422 sigrelse (SIGCHLD);
6423 #endif
6424 errno = old_errno;
6425 return;
6427 #else
6428 pid = wait (&w);
6429 #endif /* no WNOHANG */
6431 /* Find the process that signaled us, and record its status. */
6433 /* The process can have been deleted by Fdelete_process. */
6434 tail = Fmember (make_fixnum_or_float (pid), deleted_pid_list);
6435 if (!NILP (tail))
6437 Fsetcar (tail, Qnil);
6438 goto sigchld_end_of_loop;
6441 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6442 p = 0;
6443 for (tail = Vprocess_alist; GC_CONSP (tail); tail = XCDR (tail))
6445 proc = XCDR (XCAR (tail));
6446 p = XPROCESS (proc);
6447 if (GC_EQ (p->childp, Qt) && p->pid == pid)
6448 break;
6449 p = 0;
6452 /* Look for an asynchronous process whose pid hasn't been filled
6453 in yet. */
6454 if (p == 0)
6455 for (tail = Vprocess_alist; GC_CONSP (tail); tail = XCDR (tail))
6457 proc = XCDR (XCAR (tail));
6458 p = XPROCESS (proc);
6459 if (p->pid == -1)
6460 break;
6461 p = 0;
6464 /* Change the status of the process that was found. */
6465 if (p != 0)
6467 union { int i; WAITTYPE wt; } u;
6468 int clear_desc_flag = 0;
6470 XSETINT (p->tick, ++process_tick);
6471 u.wt = w;
6472 p->raw_status = u.i;
6473 p->raw_status_new = 1;
6475 /* If process has terminated, stop waiting for its output. */
6476 if ((WIFSIGNALED (w) || WIFEXITED (w))
6477 && XINT (p->infd) >= 0)
6478 clear_desc_flag = 1;
6480 /* We use clear_desc_flag to avoid a compiler bug in Microsoft C. */
6481 if (clear_desc_flag)
6483 FD_CLR (XINT (p->infd), &input_wait_mask);
6484 FD_CLR (XINT (p->infd), &non_keyboard_wait_mask);
6487 /* Tell wait_reading_process_output that it needs to wake up and
6488 look around. */
6489 if (input_available_clear_time)
6490 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
6493 /* There was no asynchronous process found for that pid: we have
6494 a synchronous process. */
6495 else
6497 synch_process_alive = 0;
6499 /* Report the status of the synchronous process. */
6500 if (WIFEXITED (w))
6501 synch_process_retcode = WRETCODE (w);
6502 else if (WIFSIGNALED (w))
6503 synch_process_termsig = WTERMSIG (w);
6505 /* Tell wait_reading_process_output that it needs to wake up and
6506 look around. */
6507 if (input_available_clear_time)
6508 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
6511 sigchld_end_of_loop:
6514 /* On some systems, we must return right away.
6515 If any more processes want to signal us, we will
6516 get another signal.
6517 Otherwise (on systems that have WNOHANG), loop around
6518 to use up all the processes that have something to tell us. */
6519 #if (defined WINDOWSNT \
6520 || (defined USG && !defined GNU_LINUX \
6521 && !(defined HPUX && defined WNOHANG)))
6522 #if defined (USG) && ! defined (POSIX_SIGNALS)
6523 signal (signo, sigchld_handler);
6524 #endif
6525 errno = old_errno;
6526 return;
6527 #endif /* USG, but not HPUX with WNOHANG */
6530 #endif /* SIGCHLD */
6533 static Lisp_Object
6534 exec_sentinel_unwind (data)
6535 Lisp_Object data;
6537 XPROCESS (XCAR (data))->sentinel = XCDR (data);
6538 return Qnil;
6541 static Lisp_Object
6542 exec_sentinel_error_handler (error)
6543 Lisp_Object error;
6545 cmd_error_internal (error, "error in process sentinel: ");
6546 Vinhibit_quit = Qt;
6547 update_echo_area ();
6548 Fsleep_for (make_number (2), Qnil);
6549 return Qt;
6552 static void
6553 exec_sentinel (proc, reason)
6554 Lisp_Object proc, reason;
6556 Lisp_Object sentinel, obuffer, odeactivate, okeymap;
6557 register struct Lisp_Process *p = XPROCESS (proc);
6558 int count = SPECPDL_INDEX ();
6559 int outer_running_asynch_code = running_asynch_code;
6560 int waiting = waiting_for_user_input_p;
6562 /* No need to gcpro these, because all we do with them later
6563 is test them for EQness, and none of them should be a string. */
6564 odeactivate = Vdeactivate_mark;
6565 XSETBUFFER (obuffer, current_buffer);
6566 okeymap = current_buffer->keymap;
6568 sentinel = p->sentinel;
6569 if (NILP (sentinel))
6570 return;
6572 /* Zilch the sentinel while it's running, to avoid recursive invocations;
6573 assure that it gets restored no matter how the sentinel exits. */
6574 p->sentinel = Qnil;
6575 record_unwind_protect (exec_sentinel_unwind, Fcons (proc, sentinel));
6576 /* Inhibit quit so that random quits don't screw up a running filter. */
6577 specbind (Qinhibit_quit, Qt);
6578 specbind (Qlast_nonmenu_event, Qt);
6580 /* In case we get recursively called,
6581 and we already saved the match data nonrecursively,
6582 save the same match data in safely recursive fashion. */
6583 if (outer_running_asynch_code)
6585 Lisp_Object tem;
6586 tem = Fmatch_data (Qnil, Qnil, Qnil);
6587 restore_search_regs ();
6588 record_unwind_save_match_data ();
6589 Fset_match_data (tem, Qt);
6592 /* For speed, if a search happens within this code,
6593 save the match data in a special nonrecursive fashion. */
6594 running_asynch_code = 1;
6596 internal_condition_case_1 (read_process_output_call,
6597 Fcons (sentinel,
6598 Fcons (proc, Fcons (reason, Qnil))),
6599 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6600 exec_sentinel_error_handler);
6602 /* If we saved the match data nonrecursively, restore it now. */
6603 restore_search_regs ();
6604 running_asynch_code = outer_running_asynch_code;
6606 Vdeactivate_mark = odeactivate;
6608 /* Restore waiting_for_user_input_p as it was
6609 when we were called, in case the filter clobbered it. */
6610 waiting_for_user_input_p = waiting;
6612 #if 0
6613 if (! EQ (Fcurrent_buffer (), obuffer)
6614 || ! EQ (current_buffer->keymap, okeymap))
6615 #endif
6616 /* But do it only if the caller is actually going to read events.
6617 Otherwise there's no need to make him wake up, and it could
6618 cause trouble (for example it would make sit_for return). */
6619 if (waiting_for_user_input_p == -1)
6620 record_asynch_buffer_change ();
6622 unbind_to (count, Qnil);
6625 /* Report all recent events of a change in process status
6626 (either run the sentinel or output a message).
6627 This is usually done while Emacs is waiting for keyboard input
6628 but can be done at other times. */
6630 static void
6631 status_notify (deleting_process)
6632 struct Lisp_Process *deleting_process;
6634 register Lisp_Object proc, buffer;
6635 Lisp_Object tail, msg;
6636 struct gcpro gcpro1, gcpro2;
6638 tail = Qnil;
6639 msg = Qnil;
6640 /* We need to gcpro tail; if read_process_output calls a filter
6641 which deletes a process and removes the cons to which tail points
6642 from Vprocess_alist, and then causes a GC, tail is an unprotected
6643 reference. */
6644 GCPRO2 (tail, msg);
6646 /* Set this now, so that if new processes are created by sentinels
6647 that we run, we get called again to handle their status changes. */
6648 update_tick = process_tick;
6650 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
6652 Lisp_Object symbol;
6653 register struct Lisp_Process *p;
6655 proc = Fcdr (Fcar (tail));
6656 p = XPROCESS (proc);
6658 if (XINT (p->tick) != XINT (p->update_tick))
6660 XSETINT (p->update_tick, XINT (p->tick));
6662 /* If process is still active, read any output that remains. */
6663 while (! EQ (p->filter, Qt)
6664 && ! EQ (p->status, Qconnect)
6665 && ! EQ (p->status, Qlisten)
6666 && ! EQ (p->command, Qt) /* Network process not stopped. */
6667 && XINT (p->infd) >= 0
6668 && p != deleting_process
6669 && read_process_output (proc, XINT (p->infd)) > 0);
6671 buffer = p->buffer;
6673 /* Get the text to use for the message. */
6674 if (p->raw_status_new)
6675 update_status (p);
6676 msg = status_message (p);
6678 /* If process is terminated, deactivate it or delete it. */
6679 symbol = p->status;
6680 if (CONSP (p->status))
6681 symbol = XCAR (p->status);
6683 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6684 || EQ (symbol, Qclosed))
6686 if (delete_exited_processes)
6687 remove_process (proc);
6688 else
6689 deactivate_process (proc);
6692 /* The actions above may have further incremented p->tick.
6693 So set p->update_tick again
6694 so that an error in the sentinel will not cause
6695 this code to be run again. */
6696 XSETINT (p->update_tick, XINT (p->tick));
6697 /* Now output the message suitably. */
6698 if (!NILP (p->sentinel))
6699 exec_sentinel (proc, msg);
6700 /* Don't bother with a message in the buffer
6701 when a process becomes runnable. */
6702 else if (!EQ (symbol, Qrun) && !NILP (buffer))
6704 Lisp_Object ro, tem;
6705 struct buffer *old = current_buffer;
6706 int opoint, opoint_byte;
6707 int before, before_byte;
6709 ro = XBUFFER (buffer)->read_only;
6711 /* Avoid error if buffer is deleted
6712 (probably that's why the process is dead, too) */
6713 if (NILP (XBUFFER (buffer)->name))
6714 continue;
6715 Fset_buffer (buffer);
6717 opoint = PT;
6718 opoint_byte = PT_BYTE;
6719 /* Insert new output into buffer
6720 at the current end-of-output marker,
6721 thus preserving logical ordering of input and output. */
6722 if (XMARKER (p->mark)->buffer)
6723 Fgoto_char (p->mark);
6724 else
6725 SET_PT_BOTH (ZV, ZV_BYTE);
6727 before = PT;
6728 before_byte = PT_BYTE;
6730 tem = current_buffer->read_only;
6731 current_buffer->read_only = Qnil;
6732 insert_string ("\nProcess ");
6733 Finsert (1, &p->name);
6734 insert_string (" ");
6735 Finsert (1, &msg);
6736 current_buffer->read_only = tem;
6737 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6739 if (opoint >= before)
6740 SET_PT_BOTH (opoint + (PT - before),
6741 opoint_byte + (PT_BYTE - before_byte));
6742 else
6743 SET_PT_BOTH (opoint, opoint_byte);
6745 set_buffer_internal (old);
6748 } /* end for */
6750 update_mode_lines++; /* in case buffers use %s in mode-line-format */
6751 redisplay_preserve_echo_area (13);
6753 UNGCPRO;
6757 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6758 Sset_process_coding_system, 1, 3, 0,
6759 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6760 DECODING will be used to decode subprocess output and ENCODING to
6761 encode subprocess input. */)
6762 (process, decoding, encoding)
6763 register Lisp_Object process, decoding, encoding;
6765 register struct Lisp_Process *p;
6767 CHECK_PROCESS (process);
6768 p = XPROCESS (process);
6769 if (XINT (p->infd) < 0)
6770 error ("Input file descriptor of %s closed", SDATA (p->name));
6771 if (XINT (p->outfd) < 0)
6772 error ("Output file descriptor of %s closed", SDATA (p->name));
6773 Fcheck_coding_system (decoding);
6774 Fcheck_coding_system (encoding);
6776 p->decode_coding_system = decoding;
6777 p->encode_coding_system = encoding;
6778 setup_process_coding_systems (process);
6780 return Qnil;
6783 DEFUN ("process-coding-system",
6784 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6785 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6786 (process)
6787 register Lisp_Object process;
6789 CHECK_PROCESS (process);
6790 return Fcons (XPROCESS (process)->decode_coding_system,
6791 XPROCESS (process)->encode_coding_system);
6794 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6795 Sset_process_filter_multibyte, 2, 2, 0,
6796 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6797 If FLAG is non-nil, the filter is given multibyte strings.
6798 If FLAG is nil, the filter is given unibyte strings. In this case,
6799 all character code conversion except for end-of-line conversion is
6800 suppressed. */)
6801 (process, flag)
6802 Lisp_Object process, flag;
6804 register struct Lisp_Process *p;
6806 CHECK_PROCESS (process);
6807 p = XPROCESS (process);
6808 p->filter_multibyte = flag;
6809 setup_process_coding_systems (process);
6811 return Qnil;
6814 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6815 Sprocess_filter_multibyte_p, 1, 1, 0,
6816 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6817 (process)
6818 Lisp_Object process;
6820 register struct Lisp_Process *p;
6822 CHECK_PROCESS (process);
6823 p = XPROCESS (process);
6825 return (NILP (p->filter_multibyte) ? Qnil : Qt);
6830 /* The first time this is called, assume keyboard input comes from DESC
6831 instead of from where we used to expect it.
6832 Subsequent calls mean assume input keyboard can come from DESC
6833 in addition to other places. */
6835 static int add_keyboard_wait_descriptor_called_flag;
6837 void
6838 add_keyboard_wait_descriptor (desc)
6839 int desc;
6841 if (! add_keyboard_wait_descriptor_called_flag)
6842 FD_CLR (0, &input_wait_mask);
6843 add_keyboard_wait_descriptor_called_flag = 1;
6844 FD_SET (desc, &input_wait_mask);
6845 FD_SET (desc, &non_process_wait_mask);
6846 if (desc > max_keyboard_desc)
6847 max_keyboard_desc = desc;
6850 /* From now on, do not expect DESC to give keyboard input. */
6852 void
6853 delete_keyboard_wait_descriptor (desc)
6854 int desc;
6856 int fd;
6857 int lim = max_keyboard_desc;
6859 FD_CLR (desc, &input_wait_mask);
6860 FD_CLR (desc, &non_process_wait_mask);
6862 if (desc == max_keyboard_desc)
6863 for (fd = 0; fd < lim; fd++)
6864 if (FD_ISSET (fd, &input_wait_mask)
6865 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6866 max_keyboard_desc = fd;
6869 /* Return nonzero if *MASK has a bit set
6870 that corresponds to one of the keyboard input descriptors. */
6872 static int
6873 keyboard_bit_set (mask)
6874 SELECT_TYPE *mask;
6876 int fd;
6878 for (fd = 0; fd <= max_keyboard_desc; fd++)
6879 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6880 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6881 return 1;
6883 return 0;
6886 void
6887 init_process ()
6889 register int i;
6891 #ifdef SIGCHLD
6892 #ifndef CANNOT_DUMP
6893 if (! noninteractive || initialized)
6894 #endif
6895 signal (SIGCHLD, sigchld_handler);
6896 #endif
6898 FD_ZERO (&input_wait_mask);
6899 FD_ZERO (&non_keyboard_wait_mask);
6900 FD_ZERO (&non_process_wait_mask);
6901 max_process_desc = 0;
6903 #ifdef NON_BLOCKING_CONNECT
6904 FD_ZERO (&connect_wait_mask);
6905 num_pending_connects = 0;
6906 #endif
6908 #ifdef ADAPTIVE_READ_BUFFERING
6909 process_output_delay_count = 0;
6910 process_output_skip = 0;
6911 #endif
6913 FD_SET (0, &input_wait_mask);
6915 Vprocess_alist = Qnil;
6916 #ifdef SIGCHLD
6917 deleted_pid_list = Qnil;
6918 #endif
6919 for (i = 0; i < MAXDESC; i++)
6921 chan_process[i] = Qnil;
6922 proc_buffered_char[i] = -1;
6924 bzero (proc_decode_coding_system, sizeof proc_decode_coding_system);
6925 bzero (proc_encode_coding_system, sizeof proc_encode_coding_system);
6926 #ifdef DATAGRAM_SOCKETS
6927 bzero (datagram_address, sizeof datagram_address);
6928 #endif
6930 #ifdef HAVE_SOCKETS
6932 Lisp_Object subfeatures = Qnil;
6933 struct socket_options *sopt;
6935 #define ADD_SUBFEATURE(key, val) \
6936 subfeatures = Fcons (Fcons (key, Fcons (val, Qnil)), subfeatures)
6938 #ifdef NON_BLOCKING_CONNECT
6939 ADD_SUBFEATURE (QCnowait, Qt);
6940 #endif
6941 #ifdef DATAGRAM_SOCKETS
6942 ADD_SUBFEATURE (QCtype, Qdatagram);
6943 #endif
6944 #ifdef HAVE_LOCAL_SOCKETS
6945 ADD_SUBFEATURE (QCfamily, Qlocal);
6946 #endif
6947 ADD_SUBFEATURE (QCfamily, Qipv4);
6948 #ifdef AF_INET6
6949 ADD_SUBFEATURE (QCfamily, Qipv6);
6950 #endif
6951 #ifdef HAVE_GETSOCKNAME
6952 ADD_SUBFEATURE (QCservice, Qt);
6953 #endif
6954 #if !defined(TERM) && (defined(O_NONBLOCK) || defined(O_NDELAY))
6955 ADD_SUBFEATURE (QCserver, Qt);
6956 #endif
6958 for (sopt = socket_options; sopt->name; sopt++)
6959 subfeatures = Fcons (intern (sopt->name), subfeatures);
6961 Fprovide (intern ("make-network-process"), subfeatures);
6963 #endif /* HAVE_SOCKETS */
6965 #if defined (DARWIN) || defined (MAC_OSX)
6966 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
6967 processes. As such, we only change the default value. */
6968 if (initialized)
6970 char *release = get_operating_system_release();
6971 if (!release || !release[0] || (release[0] < MIN_PTY_KERNEL_VERSION
6972 && release[1] == '.')) {
6973 Vprocess_connection_type = Qnil;
6976 #endif
6979 void
6980 syms_of_process ()
6982 Qprocessp = intern ("processp");
6983 staticpro (&Qprocessp);
6984 Qrun = intern ("run");
6985 staticpro (&Qrun);
6986 Qstop = intern ("stop");
6987 staticpro (&Qstop);
6988 Qsignal = intern ("signal");
6989 staticpro (&Qsignal);
6991 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
6992 here again.
6994 Qexit = intern ("exit");
6995 staticpro (&Qexit); */
6997 Qopen = intern ("open");
6998 staticpro (&Qopen);
6999 Qclosed = intern ("closed");
7000 staticpro (&Qclosed);
7001 Qconnect = intern ("connect");
7002 staticpro (&Qconnect);
7003 Qfailed = intern ("failed");
7004 staticpro (&Qfailed);
7005 Qlisten = intern ("listen");
7006 staticpro (&Qlisten);
7007 Qlocal = intern ("local");
7008 staticpro (&Qlocal);
7009 Qipv4 = intern ("ipv4");
7010 staticpro (&Qipv4);
7011 #ifdef AF_INET6
7012 Qipv6 = intern ("ipv6");
7013 staticpro (&Qipv6);
7014 #endif
7015 Qdatagram = intern ("datagram");
7016 staticpro (&Qdatagram);
7018 QCname = intern (":name");
7019 staticpro (&QCname);
7020 QCbuffer = intern (":buffer");
7021 staticpro (&QCbuffer);
7022 QChost = intern (":host");
7023 staticpro (&QChost);
7024 QCservice = intern (":service");
7025 staticpro (&QCservice);
7026 QCtype = intern (":type");
7027 staticpro (&QCtype);
7028 QClocal = intern (":local");
7029 staticpro (&QClocal);
7030 QCremote = intern (":remote");
7031 staticpro (&QCremote);
7032 QCcoding = intern (":coding");
7033 staticpro (&QCcoding);
7034 QCserver = intern (":server");
7035 staticpro (&QCserver);
7036 QCnowait = intern (":nowait");
7037 staticpro (&QCnowait);
7038 QCsentinel = intern (":sentinel");
7039 staticpro (&QCsentinel);
7040 QClog = intern (":log");
7041 staticpro (&QClog);
7042 QCnoquery = intern (":noquery");
7043 staticpro (&QCnoquery);
7044 QCstop = intern (":stop");
7045 staticpro (&QCstop);
7046 QCoptions = intern (":options");
7047 staticpro (&QCoptions);
7048 QCplist = intern (":plist");
7049 staticpro (&QCplist);
7050 QCfilter_multibyte = intern (":filter-multibyte");
7051 staticpro (&QCfilter_multibyte);
7053 Qlast_nonmenu_event = intern ("last-nonmenu-event");
7054 staticpro (&Qlast_nonmenu_event);
7056 staticpro (&Vprocess_alist);
7057 #ifdef SIGCHLD
7058 staticpro (&deleted_pid_list);
7059 #endif
7061 DEFVAR_BOOL ("delete-exited-processes", &delete_exited_processes,
7062 doc: /* *Non-nil means delete processes immediately when they exit.
7063 nil means don't delete them until `list-processes' is run. */);
7065 delete_exited_processes = 1;
7067 DEFVAR_LISP ("process-connection-type", &Vprocess_connection_type,
7068 doc: /* Control type of device used to communicate with subprocesses.
7069 Values are nil to use a pipe, or t or `pty' to use a pty.
7070 The value has no effect if the system has no ptys or if all ptys are busy:
7071 then a pipe is used in any case.
7072 The value takes effect when `start-process' is called. */);
7073 Vprocess_connection_type = Qt;
7075 #ifdef ADAPTIVE_READ_BUFFERING
7076 DEFVAR_LISP ("process-adaptive-read-buffering", &Vprocess_adaptive_read_buffering,
7077 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7078 On some systems, when Emacs reads the output from a subprocess, the output data
7079 is read in very small blocks, potentially resulting in very poor performance.
7080 This behavior can be remedied to some extent by setting this variable to a
7081 non-nil value, as it will automatically delay reading from such processes, to
7082 allow them to produce more output before Emacs tries to read it.
7083 If the value is t, the delay is reset after each write to the process; any other
7084 non-nil value means that the delay is not reset on write.
7085 The variable takes effect when `start-process' is called. */);
7086 Vprocess_adaptive_read_buffering = Qt;
7087 #endif
7089 defsubr (&Sprocessp);
7090 defsubr (&Sget_process);
7091 defsubr (&Sget_buffer_process);
7092 defsubr (&Sdelete_process);
7093 defsubr (&Sprocess_status);
7094 defsubr (&Sprocess_exit_status);
7095 defsubr (&Sprocess_id);
7096 defsubr (&Sprocess_name);
7097 defsubr (&Sprocess_tty_name);
7098 defsubr (&Sprocess_command);
7099 defsubr (&Sset_process_buffer);
7100 defsubr (&Sprocess_buffer);
7101 defsubr (&Sprocess_mark);
7102 defsubr (&Sset_process_filter);
7103 defsubr (&Sprocess_filter);
7104 defsubr (&Sset_process_sentinel);
7105 defsubr (&Sprocess_sentinel);
7106 defsubr (&Sset_process_window_size);
7107 defsubr (&Sset_process_inherit_coding_system_flag);
7108 defsubr (&Sprocess_inherit_coding_system_flag);
7109 defsubr (&Sset_process_query_on_exit_flag);
7110 defsubr (&Sprocess_query_on_exit_flag);
7111 defsubr (&Sprocess_contact);
7112 defsubr (&Sprocess_plist);
7113 defsubr (&Sset_process_plist);
7114 defsubr (&Slist_processes);
7115 defsubr (&Sprocess_list);
7116 defsubr (&Sstart_process);
7117 #ifdef HAVE_SOCKETS
7118 defsubr (&Sset_network_process_option);
7119 defsubr (&Smake_network_process);
7120 defsubr (&Sformat_network_address);
7121 #endif /* HAVE_SOCKETS */
7122 #if defined(HAVE_SOCKETS) && defined(HAVE_NET_IF_H) && defined(HAVE_SYS_IOCTL_H)
7123 #ifdef SIOCGIFCONF
7124 defsubr (&Snetwork_interface_list);
7125 #endif
7126 #if defined(SIOCGIFADDR) || defined(SIOCGIFHWADDR) || defined(SIOCGIFFLAGS)
7127 defsubr (&Snetwork_interface_info);
7128 #endif
7129 #endif /* HAVE_SOCKETS ... */
7130 #ifdef DATAGRAM_SOCKETS
7131 defsubr (&Sprocess_datagram_address);
7132 defsubr (&Sset_process_datagram_address);
7133 #endif
7134 defsubr (&Saccept_process_output);
7135 defsubr (&Sprocess_send_region);
7136 defsubr (&Sprocess_send_string);
7137 defsubr (&Sinterrupt_process);
7138 defsubr (&Skill_process);
7139 defsubr (&Squit_process);
7140 defsubr (&Sstop_process);
7141 defsubr (&Scontinue_process);
7142 defsubr (&Sprocess_running_child_p);
7143 defsubr (&Sprocess_send_eof);
7144 defsubr (&Ssignal_process);
7145 defsubr (&Swaiting_for_user_input_p);
7146 /* defsubr (&Sprocess_connection); */
7147 defsubr (&Sset_process_coding_system);
7148 defsubr (&Sprocess_coding_system);
7149 defsubr (&Sset_process_filter_multibyte);
7150 defsubr (&Sprocess_filter_multibyte_p);
7154 #else /* not subprocesses */
7156 #include <sys/types.h>
7157 #include <errno.h>
7159 #include "lisp.h"
7160 #include "systime.h"
7161 #include "charset.h"
7162 #include "coding.h"
7163 #include "termopts.h"
7164 #include "sysselect.h"
7166 extern int frame_garbaged;
7168 extern EMACS_TIME timer_check ();
7169 extern int timers_run;
7171 Lisp_Object QCtype;
7173 /* As described above, except assuming that there are no subprocesses:
7175 Wait for timeout to elapse and/or keyboard input to be available.
7177 time_limit is:
7178 timeout in seconds, or
7179 zero for no limit, or
7180 -1 means gobble data immediately available but don't wait for any.
7182 read_kbd is a Lisp_Object:
7183 0 to ignore keyboard input, or
7184 1 to return when input is available, or
7185 -1 means caller will actually read the input, so don't throw to
7186 the quit handler.
7188 see full version for other parameters. We know that wait_proc will
7189 always be NULL, since `subprocesses' isn't defined.
7191 do_display != 0 means redisplay should be done to show subprocess
7192 output that arrives.
7194 Return true iff we received input from any process. */
7197 wait_reading_process_output (time_limit, microsecs, read_kbd, do_display,
7198 wait_for_cell, wait_proc, just_wait_proc)
7199 int time_limit, microsecs, read_kbd, do_display;
7200 Lisp_Object wait_for_cell;
7201 struct Lisp_Process *wait_proc;
7202 int just_wait_proc;
7204 register int nfds;
7205 EMACS_TIME end_time, timeout;
7206 SELECT_TYPE waitchannels;
7207 int xerrno;
7209 /* What does time_limit really mean? */
7210 if (time_limit || microsecs)
7212 EMACS_GET_TIME (end_time);
7213 EMACS_SET_SECS_USECS (timeout, time_limit, microsecs);
7214 EMACS_ADD_TIME (end_time, end_time, timeout);
7217 /* Turn off periodic alarms (in case they are in use)
7218 and then turn off any other atimers,
7219 because the select emulator uses alarms. */
7220 stop_polling ();
7221 turn_on_atimers (0);
7223 while (1)
7225 int timeout_reduced_for_timers = 0;
7227 /* If calling from keyboard input, do not quit
7228 since we want to return C-g as an input character.
7229 Otherwise, do pending quit if requested. */
7230 if (read_kbd >= 0)
7231 QUIT;
7233 /* Exit now if the cell we're waiting for became non-nil. */
7234 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7235 break;
7237 /* Compute time from now till when time limit is up */
7238 /* Exit if already run out */
7239 if (time_limit == -1)
7241 /* -1 specified for timeout means
7242 gobble output available now
7243 but don't wait at all. */
7245 EMACS_SET_SECS_USECS (timeout, 0, 0);
7247 else if (time_limit || microsecs)
7249 EMACS_GET_TIME (timeout);
7250 EMACS_SUB_TIME (timeout, end_time, timeout);
7251 if (EMACS_TIME_NEG_P (timeout))
7252 break;
7254 else
7256 EMACS_SET_SECS_USECS (timeout, 100000, 0);
7259 /* If our caller will not immediately handle keyboard events,
7260 run timer events directly.
7261 (Callers that will immediately read keyboard events
7262 call timer_delay on their own.) */
7263 if (NILP (wait_for_cell))
7265 EMACS_TIME timer_delay;
7269 int old_timers_run = timers_run;
7270 timer_delay = timer_check (1);
7271 if (timers_run != old_timers_run && do_display)
7272 /* We must retry, since a timer may have requeued itself
7273 and that could alter the time delay. */
7274 redisplay_preserve_echo_area (14);
7275 else
7276 break;
7278 while (!detect_input_pending ());
7280 /* If there is unread keyboard input, also return. */
7281 if (read_kbd != 0
7282 && requeued_events_pending_p ())
7283 break;
7285 if (! EMACS_TIME_NEG_P (timer_delay) && time_limit != -1)
7287 EMACS_TIME difference;
7288 EMACS_SUB_TIME (difference, timer_delay, timeout);
7289 if (EMACS_TIME_NEG_P (difference))
7291 timeout = timer_delay;
7292 timeout_reduced_for_timers = 1;
7297 /* Cause C-g and alarm signals to take immediate action,
7298 and cause input available signals to zero out timeout. */
7299 if (read_kbd < 0)
7300 set_waiting_for_input (&timeout);
7302 /* Wait till there is something to do. */
7304 if (! read_kbd && NILP (wait_for_cell))
7305 FD_ZERO (&waitchannels);
7306 else
7307 FD_SET (0, &waitchannels);
7309 /* If a frame has been newly mapped and needs updating,
7310 reprocess its display stuff. */
7311 if (frame_garbaged && do_display)
7313 clear_waiting_for_input ();
7314 redisplay_preserve_echo_area (15);
7315 if (read_kbd < 0)
7316 set_waiting_for_input (&timeout);
7319 if (read_kbd && detect_input_pending ())
7321 nfds = 0;
7322 FD_ZERO (&waitchannels);
7324 else
7325 nfds = select (1, &waitchannels, (SELECT_TYPE *)0, (SELECT_TYPE *)0,
7326 &timeout);
7328 xerrno = errno;
7330 /* Make C-g and alarm signals set flags again */
7331 clear_waiting_for_input ();
7333 /* If we woke up due to SIGWINCH, actually change size now. */
7334 do_pending_window_change (0);
7336 if (time_limit && nfds == 0 && ! timeout_reduced_for_timers)
7337 /* We waited the full specified time, so return now. */
7338 break;
7340 if (nfds == -1)
7342 /* If the system call was interrupted, then go around the
7343 loop again. */
7344 if (xerrno == EINTR)
7345 FD_ZERO (&waitchannels);
7346 else
7347 error ("select error: %s", emacs_strerror (xerrno));
7349 #ifdef sun
7350 else if (nfds > 0 && (waitchannels & 1) && interrupt_input)
7351 /* System sometimes fails to deliver SIGIO. */
7352 kill (getpid (), SIGIO);
7353 #endif
7354 #ifdef SIGIO
7355 if (read_kbd && interrupt_input && (waitchannels & 1))
7356 kill (getpid (), SIGIO);
7357 #endif
7359 /* Check for keyboard input */
7361 if (read_kbd
7362 && detect_input_pending_run_timers (do_display))
7364 swallow_events (do_display);
7365 if (detect_input_pending_run_timers (do_display))
7366 break;
7369 /* If there is unread keyboard input, also return. */
7370 if (read_kbd
7371 && requeued_events_pending_p ())
7372 break;
7374 /* If wait_for_cell. check for keyboard input
7375 but don't run any timers.
7376 ??? (It seems wrong to me to check for keyboard
7377 input at all when wait_for_cell, but the code
7378 has been this way since July 1994.
7379 Try changing this after version 19.31.) */
7380 if (! NILP (wait_for_cell)
7381 && detect_input_pending ())
7383 swallow_events (do_display);
7384 if (detect_input_pending ())
7385 break;
7388 /* Exit now if the cell we're waiting for became non-nil. */
7389 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7390 break;
7393 start_polling ();
7395 return 0;
7399 /* Don't confuse make-docfile by having two doc strings for this function.
7400 make-docfile does not pay attention to #if, for good reason! */
7401 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
7403 (name)
7404 register Lisp_Object name;
7406 return Qnil;
7409 /* Don't confuse make-docfile by having two doc strings for this function.
7410 make-docfile does not pay attention to #if, for good reason! */
7411 DEFUN ("process-inherit-coding-system-flag",
7412 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
7413 1, 1, 0,
7415 (process)
7416 register Lisp_Object process;
7418 /* Ignore the argument and return the value of
7419 inherit-process-coding-system. */
7420 return inherit_process_coding_system ? Qt : Qnil;
7423 /* Kill all processes associated with `buffer'.
7424 If `buffer' is nil, kill all processes.
7425 Since we have no subprocesses, this does nothing. */
7427 void
7428 kill_buffer_processes (buffer)
7429 Lisp_Object buffer;
7433 void
7434 init_process ()
7438 void
7439 syms_of_process ()
7441 QCtype = intern (":type");
7442 staticpro (&QCtype);
7444 defsubr (&Sget_buffer_process);
7445 defsubr (&Sprocess_inherit_coding_system_flag);
7449 #endif /* not subprocesses */
7451 /* arch-tag: 3706c011-7b9a-4117-bd4f-59e7f701a4c4
7452 (do not change this comment) */