(bubbles-version): Bump value to "0.5".
[emacs.git] / src / process.c
blobdfb97b8d6159db909c103ef086f473933dea042f
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, 2007 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 3, 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 #include "lisp.h"
125 #include "systime.h"
126 #include "systty.h"
128 #include "window.h"
129 #include "buffer.h"
130 #include "charset.h"
131 #include "coding.h"
132 #include "process.h"
133 #include "frame.h"
134 #include "termhooks.h"
135 #include "termopts.h"
136 #include "commands.h"
137 #include "keyboard.h"
138 #include "blockinput.h"
139 #include "dispextern.h"
140 #include "composite.h"
141 #include "atimer.h"
143 Lisp_Object Qprocessp;
144 Lisp_Object Qrun, Qstop, Qsignal;
145 Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
146 Lisp_Object Qlocal, Qipv4, Qdatagram;
147 #ifdef AF_INET6
148 Lisp_Object Qipv6;
149 #endif
150 Lisp_Object QCname, QCbuffer, QChost, QCservice, QCtype;
151 Lisp_Object QClocal, QCremote, QCcoding;
152 Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
153 Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
154 Lisp_Object QCfilter_multibyte;
155 Lisp_Object Qlast_nonmenu_event;
156 /* QCfamily is declared and initialized in xfaces.c,
157 QCfilter in keyboard.c. */
158 extern Lisp_Object QCfamily, QCfilter;
160 /* Qexit is declared and initialized in eval.c. */
162 /* QCfamily is defined in xfaces.c. */
163 extern Lisp_Object QCfamily;
164 /* QCfilter is defined in keyboard.c. */
165 extern Lisp_Object QCfilter;
167 /* a process object is a network connection when its childp field is neither
168 Qt nor Qnil but is instead a property list (KEY VAL ...). */
170 #ifdef HAVE_SOCKETS
171 #define NETCONN_P(p) (GC_CONSP (XPROCESS (p)->childp))
172 #define NETCONN1_P(p) (GC_CONSP ((p)->childp))
173 #else
174 #define NETCONN_P(p) 0
175 #define NETCONN1_P(p) 0
176 #endif /* HAVE_SOCKETS */
178 /* Define first descriptor number available for subprocesses. */
179 #ifdef VMS
180 #define FIRST_PROC_DESC 1
181 #else /* Not VMS */
182 #define FIRST_PROC_DESC 3
183 #endif
185 /* Define SIGCHLD as an alias for SIGCLD. There are many conditionals
186 testing SIGCHLD. */
188 #if !defined (SIGCHLD) && defined (SIGCLD)
189 #define SIGCHLD SIGCLD
190 #endif /* SIGCLD */
192 #include "syssignal.h"
194 #include "syswait.h"
196 extern char *get_operating_system_release ();
198 #ifndef USE_CRT_DLL
199 extern int errno;
200 #endif
201 #ifdef VMS
202 extern char *sys_errlist[];
203 #endif
205 #ifndef HAVE_H_ERRNO
206 extern int h_errno;
207 #endif
209 /* t means use pty, nil means use a pipe,
210 maybe other values to come. */
211 static Lisp_Object Vprocess_connection_type;
213 #ifdef SKTPAIR
214 #ifndef HAVE_SOCKETS
215 #include <sys/socket.h>
216 #endif
217 #endif /* SKTPAIR */
219 /* These next two vars are non-static since sysdep.c uses them in the
220 emulation of `select'. */
221 /* Number of events of change of status of a process. */
222 int process_tick;
223 /* Number of events for which the user or sentinel has been notified. */
224 int update_tick;
226 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
228 #ifdef BROKEN_NON_BLOCKING_CONNECT
229 #undef NON_BLOCKING_CONNECT
230 #else
231 #ifndef NON_BLOCKING_CONNECT
232 #ifdef HAVE_SOCKETS
233 #ifdef HAVE_SELECT
234 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
235 #if defined (O_NONBLOCK) || defined (O_NDELAY)
236 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
237 #define NON_BLOCKING_CONNECT
238 #endif /* EWOULDBLOCK || EINPROGRESS */
239 #endif /* O_NONBLOCK || O_NDELAY */
240 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
241 #endif /* HAVE_SELECT */
242 #endif /* HAVE_SOCKETS */
243 #endif /* NON_BLOCKING_CONNECT */
244 #endif /* BROKEN_NON_BLOCKING_CONNECT */
246 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
247 this system. We need to read full packets, so we need a
248 "non-destructive" select. So we require either native select,
249 or emulation of select using FIONREAD. */
251 #ifdef BROKEN_DATAGRAM_SOCKETS
252 #undef DATAGRAM_SOCKETS
253 #else
254 #ifndef DATAGRAM_SOCKETS
255 #ifdef HAVE_SOCKETS
256 #if defined (HAVE_SELECT) || defined (FIONREAD)
257 #if defined (HAVE_SENDTO) && defined (HAVE_RECVFROM) && defined (EMSGSIZE)
258 #define DATAGRAM_SOCKETS
259 #endif /* HAVE_SENDTO && HAVE_RECVFROM && EMSGSIZE */
260 #endif /* HAVE_SELECT || FIONREAD */
261 #endif /* HAVE_SOCKETS */
262 #endif /* DATAGRAM_SOCKETS */
263 #endif /* BROKEN_DATAGRAM_SOCKETS */
265 #ifdef TERM
266 #undef NON_BLOCKING_CONNECT
267 #undef DATAGRAM_SOCKETS
268 #endif
270 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
271 #ifdef EMACS_HAS_USECS
272 #define ADAPTIVE_READ_BUFFERING
273 #endif
274 #endif
276 #ifdef ADAPTIVE_READ_BUFFERING
277 #define READ_OUTPUT_DELAY_INCREMENT 10000
278 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
279 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
281 /* Number of processes which have a non-zero read_output_delay,
282 and therefore might be delayed for adaptive read buffering. */
284 static int process_output_delay_count;
286 /* Non-zero if any process has non-nil read_output_skip. */
288 static int process_output_skip;
290 /* Non-nil means to delay reading process output to improve buffering.
291 A value of t means that delay is reset after each send, any other
292 non-nil value does not reset the delay. A value of nil disables
293 adaptive read buffering completely. */
294 static Lisp_Object Vprocess_adaptive_read_buffering;
295 #else
296 #define process_output_delay_count 0
297 #endif
300 #include "sysselect.h"
302 static int keyboard_bit_set P_ ((SELECT_TYPE *));
303 static void deactivate_process P_ ((Lisp_Object));
304 static void status_notify P_ ((struct Lisp_Process *));
305 static int read_process_output P_ ((Lisp_Object, int));
307 /* If we support a window system, turn on the code to poll periodically
308 to detect C-g. It isn't actually used when doing interrupt input. */
309 #ifdef HAVE_WINDOW_SYSTEM
310 #define POLL_FOR_INPUT
311 #endif
313 static Lisp_Object get_process ();
314 static void exec_sentinel ();
316 extern EMACS_TIME timer_check ();
317 extern int timers_run;
319 /* Mask of bits indicating the descriptors that we wait for input on. */
321 static SELECT_TYPE input_wait_mask;
323 /* Mask that excludes keyboard input descriptor(s). */
325 static SELECT_TYPE non_keyboard_wait_mask;
327 /* Mask that excludes process input descriptor(s). */
329 static SELECT_TYPE non_process_wait_mask;
331 /* Mask for the gpm mouse input descriptor. */
333 static SELECT_TYPE gpm_wait_mask;
335 #ifdef NON_BLOCKING_CONNECT
336 /* Mask of bits indicating the descriptors that we wait for connect to
337 complete on. Once they complete, they are removed from this mask
338 and added to the input_wait_mask and non_keyboard_wait_mask. */
340 static SELECT_TYPE connect_wait_mask;
342 /* Number of bits set in connect_wait_mask. */
343 static int num_pending_connects;
345 #define IF_NON_BLOCKING_CONNECT(s) s
346 #else
347 #define IF_NON_BLOCKING_CONNECT(s)
348 #endif
350 /* The largest descriptor currently in use for a process object. */
351 static int max_process_desc;
353 /* The largest descriptor currently in use for keyboard input. */
354 static int max_keyboard_desc;
356 /* The largest descriptor currently in use for gpm mouse input. */
357 static int max_gpm_desc;
359 /* Nonzero means delete a process right away if it exits. */
360 static int delete_exited_processes;
362 /* Indexed by descriptor, gives the process (if any) for that descriptor */
363 Lisp_Object chan_process[MAXDESC];
365 /* Alist of elements (NAME . PROCESS) */
366 Lisp_Object Vprocess_alist;
368 /* Buffered-ahead input char from process, indexed by channel.
369 -1 means empty (no char is buffered).
370 Used on sys V where the only way to tell if there is any
371 output from the process is to read at least one char.
372 Always -1 on systems that support FIONREAD. */
374 /* Don't make static; need to access externally. */
375 int proc_buffered_char[MAXDESC];
377 /* Table of `struct coding-system' for each process. */
378 static struct coding_system *proc_decode_coding_system[MAXDESC];
379 static struct coding_system *proc_encode_coding_system[MAXDESC];
381 #ifdef DATAGRAM_SOCKETS
382 /* Table of `partner address' for datagram sockets. */
383 struct sockaddr_and_len {
384 struct sockaddr *sa;
385 int len;
386 } datagram_address[MAXDESC];
387 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
388 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
389 #else
390 #define DATAGRAM_CHAN_P(chan) (0)
391 #define DATAGRAM_CONN_P(proc) (0)
392 #endif
394 /* Maximum number of bytes to send to a pty without an eof. */
395 static int pty_max_bytes;
397 /* Nonzero means don't run process sentinels. This is used
398 when exiting. */
399 int inhibit_sentinels;
401 #ifdef HAVE_PTYS
402 #ifdef HAVE_PTY_H
403 #include <pty.h>
404 #endif
405 /* The file name of the pty opened by allocate_pty. */
407 static char pty_name[24];
408 #endif
410 /* Compute the Lisp form of the process status, p->status, from
411 the numeric status that was returned by `wait'. */
413 static Lisp_Object status_convert ();
415 static void
416 update_status (p)
417 struct Lisp_Process *p;
419 union { int i; WAITTYPE wt; } u;
420 eassert (p->raw_status_new);
421 u.i = p->raw_status;
422 p->status = status_convert (u.wt);
423 p->raw_status_new = 0;
426 /* Convert a process status word in Unix format to
427 the list that we use internally. */
429 static Lisp_Object
430 status_convert (w)
431 WAITTYPE w;
433 if (WIFSTOPPED (w))
434 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
435 else if (WIFEXITED (w))
436 return Fcons (Qexit, Fcons (make_number (WRETCODE (w)),
437 WCOREDUMP (w) ? Qt : Qnil));
438 else if (WIFSIGNALED (w))
439 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
440 WCOREDUMP (w) ? Qt : Qnil));
441 else
442 return Qrun;
445 /* Given a status-list, extract the three pieces of information
446 and store them individually through the three pointers. */
448 static void
449 decode_status (l, symbol, code, coredump)
450 Lisp_Object l;
451 Lisp_Object *symbol;
452 int *code;
453 int *coredump;
455 Lisp_Object tem;
457 if (SYMBOLP (l))
459 *symbol = l;
460 *code = 0;
461 *coredump = 0;
463 else
465 *symbol = XCAR (l);
466 tem = XCDR (l);
467 *code = XFASTINT (XCAR (tem));
468 tem = XCDR (tem);
469 *coredump = !NILP (tem);
473 /* Return a string describing a process status list. */
475 static Lisp_Object
476 status_message (p)
477 struct Lisp_Process *p;
479 Lisp_Object status = p->status;
480 Lisp_Object symbol;
481 int code, coredump;
482 Lisp_Object string, string2;
484 decode_status (status, &symbol, &code, &coredump);
486 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
488 char *signame;
489 synchronize_system_messages_locale ();
490 signame = strsignal (code);
491 if (signame == 0)
492 signame = "unknown";
493 string = build_string (signame);
494 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
495 SSET (string, 0, DOWNCASE (SREF (string, 0)));
496 return concat2 (string, string2);
498 else if (EQ (symbol, Qexit))
500 if (NETCONN1_P (p))
501 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
502 if (code == 0)
503 return build_string ("finished\n");
504 string = Fnumber_to_string (make_number (code));
505 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
506 return concat3 (build_string ("exited abnormally with code "),
507 string, string2);
509 else if (EQ (symbol, Qfailed))
511 string = Fnumber_to_string (make_number (code));
512 string2 = build_string ("\n");
513 return concat3 (build_string ("failed with code "),
514 string, string2);
516 else
517 return Fcopy_sequence (Fsymbol_name (symbol));
520 #ifdef HAVE_PTYS
522 /* Open an available pty, returning a file descriptor.
523 Return -1 on failure.
524 The file name of the terminal corresponding to the pty
525 is left in the variable pty_name. */
527 static int
528 allocate_pty ()
530 register int c, i;
531 int fd;
533 #ifdef PTY_ITERATION
534 PTY_ITERATION
535 #else
536 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
537 for (i = 0; i < 16; i++)
538 #endif
540 struct stat stb; /* Used in some PTY_OPEN. */
541 #ifdef PTY_NAME_SPRINTF
542 PTY_NAME_SPRINTF
543 #else
544 sprintf (pty_name, "/dev/pty%c%x", c, i);
545 #endif /* no PTY_NAME_SPRINTF */
547 #ifdef PTY_OPEN
548 PTY_OPEN;
549 #else /* no PTY_OPEN */
551 # ifdef IRIS
552 /* Unusual IRIS code */
553 *ptyv = emacs_open ("/dev/ptc", O_RDWR | O_NDELAY, 0);
554 if (fd < 0)
555 return -1;
556 if (fstat (fd, &stb) < 0)
557 return -1;
558 # else /* not IRIS */
559 { /* Some systems name their pseudoterminals so that there are gaps in
560 the usual sequence - for example, on HP9000/S700 systems, there
561 are no pseudoterminals with names ending in 'f'. So we wait for
562 three failures in a row before deciding that we've reached the
563 end of the ptys. */
564 int failed_count = 0;
566 if (stat (pty_name, &stb) < 0)
568 failed_count++;
569 if (failed_count >= 3)
570 return -1;
572 else
573 failed_count = 0;
575 # ifdef O_NONBLOCK
576 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
577 # else
578 fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
579 # endif
580 # endif /* not IRIS */
582 #endif /* no PTY_OPEN */
584 if (fd >= 0)
586 /* check to make certain that both sides are available
587 this avoids a nasty yet stupid bug in rlogins */
588 #ifdef PTY_TTY_NAME_SPRINTF
589 PTY_TTY_NAME_SPRINTF
590 #else
591 sprintf (pty_name, "/dev/tty%c%x", c, i);
592 #endif /* no PTY_TTY_NAME_SPRINTF */
593 #ifndef UNIPLUS
594 if (access (pty_name, 6) != 0)
596 emacs_close (fd);
597 # if !defined(IRIS) && !defined(__sgi)
598 continue;
599 # else
600 return -1;
601 # endif /* IRIS */
603 #endif /* not UNIPLUS */
604 setup_pty (fd);
605 return fd;
608 return -1;
610 #endif /* HAVE_PTYS */
612 static Lisp_Object
613 make_process (name)
614 Lisp_Object name;
616 register Lisp_Object val, tem, name1;
617 register struct Lisp_Process *p;
618 char suffix[10];
619 register int i;
621 p = allocate_process ();
623 p->infd = -1;
624 p->outfd = -1;
625 p->tick = 0;
626 p->update_tick = 0;
627 p->pid = 0;
628 p->raw_status_new = 0;
629 p->status = Qrun;
630 p->mark = Fmake_marker ();
632 #ifdef ADAPTIVE_READ_BUFFERING
633 p->adaptive_read_buffering = 0;
634 p->read_output_delay = 0;
635 p->read_output_skip = 0;
636 #endif
638 /* If name is already in use, modify it until it is unused. */
640 name1 = name;
641 for (i = 1; ; i++)
643 tem = Fget_process (name1);
644 if (NILP (tem)) break;
645 sprintf (suffix, "<%d>", i);
646 name1 = concat2 (name, build_string (suffix));
648 name = name1;
649 p->name = name;
650 XSETPROCESS (val, p);
651 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
652 return val;
655 static void
656 remove_process (proc)
657 register Lisp_Object proc;
659 register Lisp_Object pair;
661 pair = Frassq (proc, Vprocess_alist);
662 Vprocess_alist = Fdelq (pair, Vprocess_alist);
664 deactivate_process (proc);
667 /* Setup coding systems of PROCESS. */
669 void
670 setup_process_coding_systems (process)
671 Lisp_Object process;
673 struct Lisp_Process *p = XPROCESS (process);
674 int inch = p->infd;
675 int outch = p->outfd;
677 if (inch < 0 || outch < 0)
678 return;
680 if (!proc_decode_coding_system[inch])
681 proc_decode_coding_system[inch]
682 = (struct coding_system *) xmalloc (sizeof (struct coding_system));
683 setup_coding_system (p->decode_coding_system,
684 proc_decode_coding_system[inch]);
685 if (! NILP (p->filter))
687 if (!p->filter_multibyte)
688 setup_raw_text_coding_system (proc_decode_coding_system[inch]);
690 else if (BUFFERP (p->buffer))
692 if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
693 setup_raw_text_coding_system (proc_decode_coding_system[inch]);
696 if (!proc_encode_coding_system[outch])
697 proc_encode_coding_system[outch]
698 = (struct coding_system *) xmalloc (sizeof (struct coding_system));
699 setup_coding_system (p->encode_coding_system,
700 proc_encode_coding_system[outch]);
701 if (proc_encode_coding_system[outch]->eol_type == CODING_EOL_UNDECIDED)
702 proc_encode_coding_system[outch]->eol_type = system_eol_type;
705 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
706 doc: /* Return t if OBJECT is a process. */)
707 (object)
708 Lisp_Object object;
710 return PROCESSP (object) ? Qt : Qnil;
713 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
714 doc: /* Return the process named NAME, or nil if there is none. */)
715 (name)
716 register Lisp_Object name;
718 if (PROCESSP (name))
719 return name;
720 CHECK_STRING (name);
721 return Fcdr (Fassoc (name, Vprocess_alist));
724 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
725 doc: /* Return the (or a) process associated with BUFFER.
726 BUFFER may be a buffer or the name of one. */)
727 (buffer)
728 register Lisp_Object buffer;
730 register Lisp_Object buf, tail, proc;
732 if (NILP (buffer)) return Qnil;
733 buf = Fget_buffer (buffer);
734 if (NILP (buf)) return Qnil;
736 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
738 proc = Fcdr (Fcar (tail));
739 if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
740 return proc;
742 return Qnil;
745 /* This is how commands for the user decode process arguments. It
746 accepts a process, a process name, a buffer, a buffer name, or nil.
747 Buffers denote the first process in the buffer, and nil denotes the
748 current buffer. */
750 static Lisp_Object
751 get_process (name)
752 register Lisp_Object name;
754 register Lisp_Object proc, obj;
755 if (STRINGP (name))
757 obj = Fget_process (name);
758 if (NILP (obj))
759 obj = Fget_buffer (name);
760 if (NILP (obj))
761 error ("Process %s does not exist", SDATA (name));
763 else if (NILP (name))
764 obj = Fcurrent_buffer ();
765 else
766 obj = name;
768 /* Now obj should be either a buffer object or a process object.
770 if (BUFFERP (obj))
772 proc = Fget_buffer_process (obj);
773 if (NILP (proc))
774 error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
776 else
778 CHECK_PROCESS (obj);
779 proc = obj;
781 return proc;
785 #ifdef SIGCHLD
786 /* Fdelete_process promises to immediately forget about the process, but in
787 reality, Emacs needs to remember those processes until they have been
788 treated by sigchld_handler; otherwise this handler would consider the
789 process as being synchronous and say that the synchronous process is
790 dead. */
791 static Lisp_Object deleted_pid_list;
792 #endif
794 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
795 doc: /* Delete PROCESS: kill it and forget about it immediately.
796 PROCESS may be a process, a buffer, the name of a process or buffer, or
797 nil, indicating the current buffer's process. */)
798 (process)
799 register Lisp_Object process;
801 register struct Lisp_Process *p;
803 process = get_process (process);
804 p = XPROCESS (process);
806 p->raw_status_new = 0;
807 if (NETCONN1_P (p))
809 p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
810 p->tick = ++process_tick;
811 status_notify (p);
813 else if (p->infd >= 0)
815 #ifdef SIGCHLD
816 Lisp_Object symbol;
817 /* Assignment to EMACS_INT stops GCC whining about limited range
818 of data type. */
819 EMACS_INT pid = p->pid;
821 /* No problem storing the pid here, as it is still in Vprocess_alist. */
822 deleted_pid_list = Fcons (make_fixnum_or_float (pid),
823 /* GC treated elements set to nil. */
824 Fdelq (Qnil, deleted_pid_list));
825 /* If the process has already signaled, remove it from the list. */
826 if (p->raw_status_new)
827 update_status (p);
828 symbol = p->status;
829 if (CONSP (p->status))
830 symbol = XCAR (p->status);
831 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
832 deleted_pid_list
833 = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
834 else
835 #endif
837 Fkill_process (process, Qnil);
838 /* Do this now, since remove_process will make sigchld_handler do nothing. */
839 p->status
840 = Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
841 p->tick = ++process_tick;
842 status_notify (p);
845 remove_process (process);
846 return Qnil;
849 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
850 doc: /* Return the status of PROCESS.
851 The returned value is one of the following symbols:
852 run -- for a process that is running.
853 stop -- for a process stopped but continuable.
854 exit -- for a process that has exited.
855 signal -- for a process that has got a fatal signal.
856 open -- for a network stream connection that is open.
857 listen -- for a network stream server that is listening.
858 closed -- for a network stream connection that is closed.
859 connect -- when waiting for a non-blocking connection to complete.
860 failed -- when a non-blocking connection has failed.
861 nil -- if arg is a process name and no such process exists.
862 PROCESS may be a process, a buffer, the name of a process, or
863 nil, indicating the current buffer's process. */)
864 (process)
865 register Lisp_Object process;
867 register struct Lisp_Process *p;
868 register Lisp_Object status;
870 if (STRINGP (process))
871 process = Fget_process (process);
872 else
873 process = get_process (process);
875 if (NILP (process))
876 return process;
878 p = XPROCESS (process);
879 if (p->raw_status_new)
880 update_status (p);
881 status = p->status;
882 if (CONSP (status))
883 status = XCAR (status);
884 if (NETCONN1_P (p))
886 if (EQ (status, Qexit))
887 status = Qclosed;
888 else if (EQ (p->command, Qt))
889 status = Qstop;
890 else if (EQ (status, Qrun))
891 status = Qopen;
893 return status;
896 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
897 1, 1, 0,
898 doc: /* Return the exit status of PROCESS or the signal number that killed it.
899 If PROCESS has not yet exited or died, return 0. */)
900 (process)
901 register Lisp_Object process;
903 CHECK_PROCESS (process);
904 if (XPROCESS (process)->raw_status_new)
905 update_status (XPROCESS (process));
906 if (CONSP (XPROCESS (process)->status))
907 return XCAR (XCDR (XPROCESS (process)->status));
908 return make_number (0);
911 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
912 doc: /* Return the process id of PROCESS.
913 This is the pid of the external process which PROCESS uses or talks to.
914 For a network connection, this value is nil. */)
915 (process)
916 register Lisp_Object process;
918 /* Assignment to EMACS_INT stops GCC whining about limited range of
919 data type. */
920 EMACS_INT pid;
922 CHECK_PROCESS (process);
923 pid = XPROCESS (process)->pid;
924 return (pid ? make_fixnum_or_float (pid) : Qnil);
927 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
928 doc: /* Return the name of PROCESS, as a string.
929 This is the name of the program invoked in PROCESS,
930 possibly modified to make it unique among process names. */)
931 (process)
932 register Lisp_Object process;
934 CHECK_PROCESS (process);
935 return XPROCESS (process)->name;
938 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
939 doc: /* Return the command that was executed to start PROCESS.
940 This is a list of strings, the first string being the program executed
941 and the rest of the strings being the arguments given to it.
942 For a non-child channel, this is nil. */)
943 (process)
944 register Lisp_Object process;
946 CHECK_PROCESS (process);
947 return XPROCESS (process)->command;
950 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
951 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
952 This is the terminal that the process itself reads and writes on,
953 not the name of the pty that Emacs uses to talk with that terminal. */)
954 (process)
955 register Lisp_Object process;
957 CHECK_PROCESS (process);
958 return XPROCESS (process)->tty_name;
961 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
962 2, 2, 0,
963 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil). */)
964 (process, buffer)
965 register Lisp_Object process, buffer;
967 struct Lisp_Process *p;
969 CHECK_PROCESS (process);
970 if (!NILP (buffer))
971 CHECK_BUFFER (buffer);
972 p = XPROCESS (process);
973 p->buffer = buffer;
974 if (NETCONN1_P (p))
975 p->childp = Fplist_put (p->childp, QCbuffer, buffer);
976 setup_process_coding_systems (process);
977 return buffer;
980 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
981 1, 1, 0,
982 doc: /* Return the buffer PROCESS is associated with.
983 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
984 (process)
985 register Lisp_Object process;
987 CHECK_PROCESS (process);
988 return XPROCESS (process)->buffer;
991 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
992 1, 1, 0,
993 doc: /* Return the marker for the end of the last output from PROCESS. */)
994 (process)
995 register Lisp_Object process;
997 CHECK_PROCESS (process);
998 return XPROCESS (process)->mark;
1001 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1002 2, 2, 0,
1003 doc: /* Give PROCESS the filter function FILTER; nil means no filter.
1004 t means stop accepting output from the process.
1006 When a process has a filter, its buffer is not used for output.
1007 Instead, each time it does output, the entire string of output is
1008 passed to the filter.
1010 The filter gets two arguments: the process and the string of output.
1011 The string argument is normally a multibyte string, except:
1012 - if the process' input coding system is no-conversion or raw-text,
1013 it is a unibyte string (the non-converted input), or else
1014 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1015 string (the result of converting the decoded input multibyte
1016 string to unibyte with `string-make-unibyte'). */)
1017 (process, filter)
1018 register Lisp_Object process, filter;
1020 struct Lisp_Process *p;
1022 CHECK_PROCESS (process);
1023 p = XPROCESS (process);
1025 /* Don't signal an error if the process' input file descriptor
1026 is closed. This could make debugging Lisp more difficult,
1027 for example when doing something like
1029 (setq process (start-process ...))
1030 (debug)
1031 (set-process-filter process ...) */
1033 if (p->infd >= 0)
1035 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1037 FD_CLR (p->infd, &input_wait_mask);
1038 FD_CLR (p->infd, &non_keyboard_wait_mask);
1040 else if (EQ (p->filter, Qt)
1041 && !EQ (p->command, Qt)) /* Network process not stopped. */
1043 FD_SET (p->infd, &input_wait_mask);
1044 FD_SET (p->infd, &non_keyboard_wait_mask);
1048 p->filter = filter;
1049 if (NETCONN1_P (p))
1050 p->childp = Fplist_put (p->childp, QCfilter, filter);
1051 setup_process_coding_systems (process);
1052 return filter;
1055 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1056 1, 1, 0,
1057 doc: /* Returns the filter function of PROCESS; nil if none.
1058 See `set-process-filter' for more info on filter functions. */)
1059 (process)
1060 register Lisp_Object process;
1062 CHECK_PROCESS (process);
1063 return XPROCESS (process)->filter;
1066 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1067 2, 2, 0,
1068 doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
1069 The sentinel is called as a function when the process changes state.
1070 It gets two arguments: the process, and a string describing the change. */)
1071 (process, sentinel)
1072 register Lisp_Object process, sentinel;
1074 struct Lisp_Process *p;
1076 CHECK_PROCESS (process);
1077 p = XPROCESS (process);
1079 p->sentinel = sentinel;
1080 if (NETCONN1_P (p))
1081 p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
1082 return sentinel;
1085 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1086 1, 1, 0,
1087 doc: /* Return the sentinel of PROCESS; nil if none.
1088 See `set-process-sentinel' for more info on sentinels. */)
1089 (process)
1090 register Lisp_Object process;
1092 CHECK_PROCESS (process);
1093 return XPROCESS (process)->sentinel;
1096 DEFUN ("set-process-window-size", Fset_process_window_size,
1097 Sset_process_window_size, 3, 3, 0,
1098 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1099 (process, height, width)
1100 register Lisp_Object process, height, width;
1102 CHECK_PROCESS (process);
1103 CHECK_NATNUM (height);
1104 CHECK_NATNUM (width);
1106 if (XPROCESS (process)->infd < 0
1107 || set_window_size (XPROCESS (process)->infd,
1108 XINT (height), XINT (width)) <= 0)
1109 return Qnil;
1110 else
1111 return Qt;
1114 DEFUN ("set-process-inherit-coding-system-flag",
1115 Fset_process_inherit_coding_system_flag,
1116 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1117 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1118 If the second argument FLAG is non-nil, then the variable
1119 `buffer-file-coding-system' of the buffer associated with PROCESS
1120 will be bound to the value of the coding system used to decode
1121 the process output.
1123 This is useful when the coding system specified for the process buffer
1124 leaves either the character code conversion or the end-of-line conversion
1125 unspecified, or if the coding system used to decode the process output
1126 is more appropriate for saving the process buffer.
1128 Binding the variable `inherit-process-coding-system' to non-nil before
1129 starting the process is an alternative way of setting the inherit flag
1130 for the process which will run. */)
1131 (process, flag)
1132 register Lisp_Object process, flag;
1134 CHECK_PROCESS (process);
1135 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1136 return flag;
1139 DEFUN ("process-inherit-coding-system-flag",
1140 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
1141 1, 1, 0,
1142 doc: /* Return the value of inherit-coding-system flag for PROCESS.
1143 If this flag is t, `buffer-file-coding-system' of the buffer
1144 associated with PROCESS will inherit the coding system used to decode
1145 the process output. */)
1146 (process)
1147 register Lisp_Object process;
1149 CHECK_PROCESS (process);
1150 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
1153 DEFUN ("set-process-query-on-exit-flag",
1154 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1155 2, 2, 0,
1156 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1157 If the second argument FLAG is non-nil, Emacs will query the user before
1158 exiting if PROCESS is running. */)
1159 (process, flag)
1160 register Lisp_Object process, flag;
1162 CHECK_PROCESS (process);
1163 XPROCESS (process)->kill_without_query = NILP (flag);
1164 return flag;
1167 DEFUN ("process-query-on-exit-flag",
1168 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1169 1, 1, 0,
1170 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1171 (process)
1172 register Lisp_Object process;
1174 CHECK_PROCESS (process);
1175 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1178 #ifdef DATAGRAM_SOCKETS
1179 Lisp_Object Fprocess_datagram_address ();
1180 #endif
1182 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1183 1, 2, 0,
1184 doc: /* Return the contact info of PROCESS; t for a real child.
1185 For a net connection, the value depends on the optional KEY arg.
1186 If KEY is nil, value is a cons cell of the form (HOST SERVICE),
1187 if KEY is t, the complete contact information for the connection is
1188 returned, else the specific value for the keyword KEY is returned.
1189 See `make-network-process' for a list of keywords. */)
1190 (process, key)
1191 register Lisp_Object process, key;
1193 Lisp_Object contact;
1195 CHECK_PROCESS (process);
1196 contact = XPROCESS (process)->childp;
1198 #ifdef DATAGRAM_SOCKETS
1199 if (DATAGRAM_CONN_P (process)
1200 && (EQ (key, Qt) || EQ (key, QCremote)))
1201 contact = Fplist_put (contact, QCremote,
1202 Fprocess_datagram_address (process));
1203 #endif
1205 if (!NETCONN_P (process) || EQ (key, Qt))
1206 return contact;
1207 if (NILP (key))
1208 return Fcons (Fplist_get (contact, QChost),
1209 Fcons (Fplist_get (contact, QCservice), Qnil));
1210 return Fplist_get (contact, key);
1213 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1214 1, 1, 0,
1215 doc: /* Return the plist of PROCESS. */)
1216 (process)
1217 register Lisp_Object process;
1219 CHECK_PROCESS (process);
1220 return XPROCESS (process)->plist;
1223 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1224 2, 2, 0,
1225 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1226 (process, plist)
1227 register Lisp_Object process, plist;
1229 CHECK_PROCESS (process);
1230 CHECK_LIST (plist);
1232 XPROCESS (process)->plist = plist;
1233 return plist;
1236 #if 0 /* Turned off because we don't currently record this info
1237 in the process. Perhaps add it. */
1238 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1239 doc: /* Return the connection type of PROCESS.
1240 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1241 a socket connection. */)
1242 (process)
1243 Lisp_Object process;
1245 return XPROCESS (process)->type;
1247 #endif
1249 #ifdef HAVE_SOCKETS
1250 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1251 1, 2, 0,
1252 doc: /* Convert network ADDRESS from internal format to a string.
1253 A 4 or 5 element vector represents an IPv4 address (with port number).
1254 An 8 or 9 element vector represents an IPv6 address (with port number).
1255 If optional second argument OMIT-PORT is non-nil, don't include a port
1256 number in the string, even when present in ADDRESS.
1257 Returns nil if format of ADDRESS is invalid. */)
1258 (address, omit_port)
1259 Lisp_Object address, omit_port;
1261 if (NILP (address))
1262 return Qnil;
1264 if (STRINGP (address)) /* AF_LOCAL */
1265 return address;
1267 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1269 register struct Lisp_Vector *p = XVECTOR (address);
1270 Lisp_Object args[10];
1271 int nargs, i;
1273 if (p->size == 4 || (p->size == 5 && !NILP (omit_port)))
1275 args[0] = build_string ("%d.%d.%d.%d");
1276 nargs = 4;
1278 else if (p->size == 5)
1280 args[0] = build_string ("%d.%d.%d.%d:%d");
1281 nargs = 5;
1283 else if (p->size == 8 || (p->size == 9 && !NILP (omit_port)))
1285 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1286 nargs = 8;
1288 else if (p->size == 9)
1290 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1291 nargs = 9;
1293 else
1294 return Qnil;
1296 for (i = 0; i < nargs; i++)
1298 EMACS_INT element = XINT (p->contents[i]);
1300 if (element < 0 || element > 65535)
1301 return Qnil;
1303 if (nargs <= 5 /* IPv4 */
1304 && i < 4 /* host, not port */
1305 && element > 255)
1306 return Qnil;
1308 args[i+1] = p->contents[i];
1311 return Fformat (nargs+1, args);
1314 if (CONSP (address))
1316 Lisp_Object args[2];
1317 args[0] = build_string ("<Family %d>");
1318 args[1] = Fcar (address);
1319 return Fformat (2, args);
1322 return Qnil;
1324 #endif
1326 static Lisp_Object
1327 list_processes_1 (query_only)
1328 Lisp_Object query_only;
1330 register Lisp_Object tail, tem;
1331 Lisp_Object proc, minspace, tem1;
1332 register struct Lisp_Process *p;
1333 char tembuf[300];
1334 int w_proc, w_buffer, w_tty;
1335 int exited = 0;
1336 Lisp_Object i_status, i_buffer, i_tty, i_command;
1338 w_proc = 4; /* Proc */
1339 w_buffer = 6; /* Buffer */
1340 w_tty = 0; /* Omit if no ttys */
1342 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
1344 int i;
1346 proc = Fcdr (Fcar (tail));
1347 p = XPROCESS (proc);
1348 if (NILP (p->childp))
1349 continue;
1350 if (!NILP (query_only) && p->kill_without_query)
1351 continue;
1352 if (STRINGP (p->name)
1353 && ( i = SCHARS (p->name), (i > w_proc)))
1354 w_proc = i;
1355 if (!NILP (p->buffer))
1357 if (NILP (XBUFFER (p->buffer)->name) && w_buffer < 8)
1358 w_buffer = 8; /* (Killed) */
1359 else if ((i = SCHARS (XBUFFER (p->buffer)->name), (i > w_buffer)))
1360 w_buffer = i;
1362 if (STRINGP (p->tty_name)
1363 && (i = SCHARS (p->tty_name), (i > w_tty)))
1364 w_tty = i;
1367 XSETFASTINT (i_status, w_proc + 1);
1368 XSETFASTINT (i_buffer, XFASTINT (i_status) + 9);
1369 if (w_tty)
1371 XSETFASTINT (i_tty, XFASTINT (i_buffer) + w_buffer + 1);
1372 XSETFASTINT (i_command, XFASTINT (i_buffer) + w_tty + 1);
1373 } else {
1374 i_tty = Qnil;
1375 XSETFASTINT (i_command, XFASTINT (i_buffer) + w_buffer + 1);
1378 XSETFASTINT (minspace, 1);
1380 set_buffer_internal (XBUFFER (Vstandard_output));
1381 current_buffer->undo_list = Qt;
1383 current_buffer->truncate_lines = Qt;
1385 write_string ("Proc", -1);
1386 Findent_to (i_status, minspace); write_string ("Status", -1);
1387 Findent_to (i_buffer, minspace); write_string ("Buffer", -1);
1388 if (!NILP (i_tty))
1390 Findent_to (i_tty, minspace); write_string ("Tty", -1);
1392 Findent_to (i_command, minspace); write_string ("Command", -1);
1393 write_string ("\n", -1);
1395 write_string ("----", -1);
1396 Findent_to (i_status, minspace); write_string ("------", -1);
1397 Findent_to (i_buffer, minspace); write_string ("------", -1);
1398 if (!NILP (i_tty))
1400 Findent_to (i_tty, minspace); write_string ("---", -1);
1402 Findent_to (i_command, minspace); write_string ("-------", -1);
1403 write_string ("\n", -1);
1405 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
1407 Lisp_Object symbol;
1409 proc = Fcdr (Fcar (tail));
1410 p = XPROCESS (proc);
1411 if (NILP (p->childp))
1412 continue;
1413 if (!NILP (query_only) && p->kill_without_query)
1414 continue;
1416 Finsert (1, &p->name);
1417 Findent_to (i_status, minspace);
1419 if (p->raw_status_new)
1420 update_status (p);
1421 symbol = p->status;
1422 if (CONSP (p->status))
1423 symbol = XCAR (p->status);
1425 if (EQ (symbol, Qsignal))
1427 Lisp_Object tem;
1428 tem = Fcar (Fcdr (p->status));
1429 #ifdef VMS
1430 if (XINT (tem) < NSIG)
1431 write_string (sys_errlist [XINT (tem)], -1);
1432 else
1433 #endif
1434 Fprinc (symbol, Qnil);
1436 else if (NETCONN1_P (p))
1438 if (EQ (symbol, Qexit))
1439 write_string ("closed", -1);
1440 else if (EQ (p->command, Qt))
1441 write_string ("stopped", -1);
1442 else if (EQ (symbol, Qrun))
1443 write_string ("open", -1);
1444 else
1445 Fprinc (symbol, Qnil);
1447 else
1448 Fprinc (symbol, Qnil);
1450 if (EQ (symbol, Qexit))
1452 Lisp_Object tem;
1453 tem = Fcar (Fcdr (p->status));
1454 if (XFASTINT (tem))
1456 sprintf (tembuf, " %d", (int) XFASTINT (tem));
1457 write_string (tembuf, -1);
1461 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit) || EQ (symbol, Qclosed))
1462 exited++;
1464 Findent_to (i_buffer, minspace);
1465 if (NILP (p->buffer))
1466 insert_string ("(none)");
1467 else if (NILP (XBUFFER (p->buffer)->name))
1468 insert_string ("(Killed)");
1469 else
1470 Finsert (1, &XBUFFER (p->buffer)->name);
1472 if (!NILP (i_tty))
1474 Findent_to (i_tty, minspace);
1475 if (STRINGP (p->tty_name))
1476 Finsert (1, &p->tty_name);
1479 Findent_to (i_command, minspace);
1481 if (EQ (p->status, Qlisten))
1483 Lisp_Object port = Fplist_get (p->childp, QCservice);
1484 if (INTEGERP (port))
1485 port = Fnumber_to_string (port);
1486 if (NILP (port))
1487 port = Fformat_network_address (Fplist_get (p->childp, QClocal), Qnil);
1488 sprintf (tembuf, "(network %s server on %s)\n",
1489 (DATAGRAM_CHAN_P (p->infd) ? "datagram" : "stream"),
1490 (STRINGP (port) ? (char *)SDATA (port) : "?"));
1491 insert_string (tembuf);
1493 else if (NETCONN1_P (p))
1495 /* For a local socket, there is no host name,
1496 so display service instead. */
1497 Lisp_Object host = Fplist_get (p->childp, QChost);
1498 if (!STRINGP (host))
1500 host = Fplist_get (p->childp, QCservice);
1501 if (INTEGERP (host))
1502 host = Fnumber_to_string (host);
1504 if (NILP (host))
1505 host = Fformat_network_address (Fplist_get (p->childp, QCremote), Qnil);
1506 sprintf (tembuf, "(network %s connection to %s)\n",
1507 (DATAGRAM_CHAN_P (p->infd) ? "datagram" : "stream"),
1508 (STRINGP (host) ? (char *)SDATA (host) : "?"));
1509 insert_string (tembuf);
1511 else
1513 tem = p->command;
1514 while (1)
1516 tem1 = Fcar (tem);
1517 Finsert (1, &tem1);
1518 tem = Fcdr (tem);
1519 if (NILP (tem))
1520 break;
1521 insert_string (" ");
1523 insert_string ("\n");
1526 if (exited)
1527 status_notify (NULL);
1528 return Qnil;
1531 DEFUN ("list-processes", Flist_processes, Slist_processes, 0, 1, "P",
1532 doc: /* Display a list of all processes.
1533 If optional argument QUERY-ONLY is non-nil, only processes with
1534 the query-on-exit flag set will be listed.
1535 Any process listed as exited or signaled is actually eliminated
1536 after the listing is made. */)
1537 (query_only)
1538 Lisp_Object query_only;
1540 internal_with_output_to_temp_buffer ("*Process List*",
1541 list_processes_1, query_only);
1542 return Qnil;
1545 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1546 doc: /* Return a list of all processes. */)
1549 return Fmapcar (Qcdr, Vprocess_alist);
1552 /* Starting asynchronous inferior processes. */
1554 static Lisp_Object start_process_unwind ();
1556 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1557 doc: /* Start a program in a subprocess. Return the process object for it.
1558 NAME is name for process. It is modified if necessary to make it unique.
1559 BUFFER is the buffer (or buffer name) to associate with the process.
1561 Process output (both standard output and standard error streams) goes
1562 at end of BUFFER, unless you specify an output stream or filter
1563 function to handle the output. BUFFER may also be nil, meaning that
1564 this process is not associated with any buffer.
1566 PROGRAM is the program file name. It is searched for in PATH.
1567 Remaining arguments are strings to give program as arguments.
1569 If you want to separate standard output from standard error, invoke
1570 the command through a shell and redirect one of them using the shell
1571 syntax.
1573 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1574 (nargs, args)
1575 int nargs;
1576 register Lisp_Object *args;
1578 Lisp_Object buffer, name, program, proc, current_dir, tem;
1579 #ifdef VMS
1580 register unsigned char *new_argv;
1581 int len;
1582 #else
1583 register unsigned char **new_argv;
1584 #endif
1585 register int i;
1586 int count = SPECPDL_INDEX ();
1588 buffer = args[1];
1589 if (!NILP (buffer))
1590 buffer = Fget_buffer_create (buffer);
1592 /* Make sure that the child will be able to chdir to the current
1593 buffer's current directory, or its unhandled equivalent. We
1594 can't just have the child check for an error when it does the
1595 chdir, since it's in a vfork.
1597 We have to GCPRO around this because Fexpand_file_name and
1598 Funhandled_file_name_directory might call a file name handling
1599 function. The argument list is protected by the caller, so all
1600 we really have to worry about is buffer. */
1602 struct gcpro gcpro1, gcpro2;
1604 current_dir = current_buffer->directory;
1606 GCPRO2 (buffer, current_dir);
1608 current_dir
1609 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir),
1610 Qnil);
1611 if (NILP (Ffile_accessible_directory_p (current_dir)))
1612 report_file_error ("Setting current directory",
1613 Fcons (current_buffer->directory, Qnil));
1615 UNGCPRO;
1618 name = args[0];
1619 CHECK_STRING (name);
1621 program = args[2];
1623 CHECK_STRING (program);
1625 proc = make_process (name);
1626 /* If an error occurs and we can't start the process, we want to
1627 remove it from the process list. This means that each error
1628 check in create_process doesn't need to call remove_process
1629 itself; it's all taken care of here. */
1630 record_unwind_protect (start_process_unwind, proc);
1632 XPROCESS (proc)->childp = Qt;
1633 XPROCESS (proc)->plist = Qnil;
1634 XPROCESS (proc)->buffer = buffer;
1635 XPROCESS (proc)->sentinel = Qnil;
1636 XPROCESS (proc)->filter = Qnil;
1637 XPROCESS (proc)->filter_multibyte
1638 = !NILP (buffer_defaults.enable_multibyte_characters);
1639 XPROCESS (proc)->command = Flist (nargs - 2, args + 2);
1641 #ifdef ADAPTIVE_READ_BUFFERING
1642 XPROCESS (proc)->adaptive_read_buffering
1643 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1644 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1645 #endif
1647 /* Make the process marker point into the process buffer (if any). */
1648 if (BUFFERP (buffer))
1649 set_marker_both (XPROCESS (proc)->mark, buffer,
1650 BUF_ZV (XBUFFER (buffer)),
1651 BUF_ZV_BYTE (XBUFFER (buffer)));
1654 /* Decide coding systems for communicating with the process. Here
1655 we don't setup the structure coding_system nor pay attention to
1656 unibyte mode. They are done in create_process. */
1658 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1659 Lisp_Object coding_systems = Qt;
1660 Lisp_Object val, *args2;
1661 struct gcpro gcpro1, gcpro2;
1663 val = Vcoding_system_for_read;
1664 if (NILP (val))
1666 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
1667 args2[0] = Qstart_process;
1668 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1669 GCPRO2 (proc, current_dir);
1670 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1671 UNGCPRO;
1672 if (CONSP (coding_systems))
1673 val = XCAR (coding_systems);
1674 else if (CONSP (Vdefault_process_coding_system))
1675 val = XCAR (Vdefault_process_coding_system);
1677 XPROCESS (proc)->decode_coding_system = val;
1679 val = Vcoding_system_for_write;
1680 if (NILP (val))
1682 if (EQ (coding_systems, Qt))
1684 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof args2);
1685 args2[0] = Qstart_process;
1686 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1687 GCPRO2 (proc, current_dir);
1688 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1689 UNGCPRO;
1691 if (CONSP (coding_systems))
1692 val = XCDR (coding_systems);
1693 else if (CONSP (Vdefault_process_coding_system))
1694 val = XCDR (Vdefault_process_coding_system);
1696 XPROCESS (proc)->encode_coding_system = val;
1699 #ifdef VMS
1700 /* Make a one member argv with all args concatenated
1701 together separated by a blank. */
1702 len = SBYTES (program) + 2;
1703 for (i = 3; i < nargs; i++)
1705 tem = args[i];
1706 CHECK_STRING (tem);
1707 len += SBYTES (tem) + 1; /* count the blank */
1709 new_argv = (unsigned char *) alloca (len);
1710 strcpy (new_argv, SDATA (program));
1711 for (i = 3; i < nargs; i++)
1713 tem = args[i];
1714 CHECK_STRING (tem);
1715 strcat (new_argv, " ");
1716 strcat (new_argv, SDATA (tem));
1718 /* Need to add code here to check for program existence on VMS */
1720 #else /* not VMS */
1721 new_argv = (unsigned char **) alloca ((nargs - 1) * sizeof (char *));
1723 /* If program file name is not absolute, search our path for it.
1724 Put the name we will really use in TEM. */
1725 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1726 && !(SCHARS (program) > 1
1727 && IS_DEVICE_SEP (SREF (program, 1))))
1729 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1731 tem = Qnil;
1732 GCPRO4 (name, program, buffer, current_dir);
1733 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1734 UNGCPRO;
1735 if (NILP (tem))
1736 report_file_error ("Searching for program", Fcons (program, Qnil));
1737 tem = Fexpand_file_name (tem, Qnil);
1739 else
1741 if (!NILP (Ffile_directory_p (program)))
1742 error ("Specified program for new process is a directory");
1743 tem = program;
1746 /* If program file name starts with /: for quoting a magic name,
1747 discard that. */
1748 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1749 && SREF (tem, 1) == ':')
1750 tem = Fsubstring (tem, make_number (2), Qnil);
1752 /* Encode the file name and put it in NEW_ARGV.
1753 That's where the child will use it to execute the program. */
1754 tem = ENCODE_FILE (tem);
1755 new_argv[0] = SDATA (tem);
1757 /* Here we encode arguments by the coding system used for sending
1758 data to the process. We don't support using different coding
1759 systems for encoding arguments and for encoding data sent to the
1760 process. */
1762 for (i = 3; i < nargs; i++)
1764 tem = args[i];
1765 CHECK_STRING (tem);
1766 if (STRING_MULTIBYTE (tem))
1767 tem = (code_convert_string_norecord
1768 (tem, XPROCESS (proc)->encode_coding_system, 1));
1769 new_argv[i - 2] = SDATA (tem);
1771 new_argv[i - 2] = 0;
1772 #endif /* not VMS */
1774 XPROCESS (proc)->decoding_buf = make_uninit_string (0);
1775 XPROCESS (proc)->decoding_carryover = 0;
1776 XPROCESS (proc)->encoding_buf = make_uninit_string (0);
1778 XPROCESS (proc)->inherit_coding_system_flag
1779 = !(NILP (buffer) || !inherit_process_coding_system);
1781 create_process (proc, (char **) new_argv, current_dir);
1783 return unbind_to (count, proc);
1786 /* This function is the unwind_protect form for Fstart_process. If
1787 PROC doesn't have its pid set, then we know someone has signaled
1788 an error and the process wasn't started successfully, so we should
1789 remove it from the process list. */
1790 static Lisp_Object
1791 start_process_unwind (proc)
1792 Lisp_Object proc;
1794 if (!PROCESSP (proc))
1795 abort ();
1797 /* Was PROC started successfully? */
1798 if (XPROCESS (proc)->pid <= 0)
1799 remove_process (proc);
1801 return Qnil;
1804 static void
1805 create_process_1 (timer)
1806 struct atimer *timer;
1808 /* Nothing to do. */
1812 #if 0 /* This doesn't work; see the note before sigchld_handler. */
1813 #ifdef USG
1814 #ifdef SIGCHLD
1815 /* Mimic blocking of signals on system V, which doesn't really have it. */
1817 /* Nonzero means we got a SIGCHLD when it was supposed to be blocked. */
1818 int sigchld_deferred;
1820 SIGTYPE
1821 create_process_sigchld ()
1823 signal (SIGCHLD, create_process_sigchld);
1825 sigchld_deferred = 1;
1827 #endif
1828 #endif
1829 #endif
1831 #ifndef VMS /* VMS version of this function is in vmsproc.c. */
1832 void
1833 create_process (process, new_argv, current_dir)
1834 Lisp_Object process;
1835 char **new_argv;
1836 Lisp_Object current_dir;
1838 int inchannel, outchannel;
1839 pid_t pid;
1840 int sv[2];
1841 #ifdef POSIX_SIGNALS
1842 sigset_t procmask;
1843 sigset_t blocked;
1844 struct sigaction sigint_action;
1845 struct sigaction sigquit_action;
1846 #ifdef AIX
1847 struct sigaction sighup_action;
1848 #endif
1849 #else /* !POSIX_SIGNALS */
1850 #if 0
1851 #ifdef SIGCHLD
1852 SIGTYPE (*sigchld)();
1853 #endif
1854 #endif /* 0 */
1855 #endif /* !POSIX_SIGNALS */
1856 /* Use volatile to protect variables from being clobbered by longjmp. */
1857 volatile int forkin, forkout;
1858 volatile int pty_flag = 0;
1859 #ifndef USE_CRT_DLL
1860 extern char **environ;
1861 #endif
1863 inchannel = outchannel = -1;
1865 #ifdef HAVE_PTYS
1866 if (!NILP (Vprocess_connection_type))
1867 outchannel = inchannel = allocate_pty ();
1869 if (inchannel >= 0)
1871 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1872 /* On most USG systems it does not work to open the pty's tty here,
1873 then close it and reopen it in the child. */
1874 #ifdef O_NOCTTY
1875 /* Don't let this terminal become our controlling terminal
1876 (in case we don't have one). */
1877 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1878 #else
1879 forkout = forkin = emacs_open (pty_name, O_RDWR, 0);
1880 #endif
1881 if (forkin < 0)
1882 report_file_error ("Opening pty", Qnil);
1883 #if defined (RTU) || defined (UNIPLUS) || defined (DONT_REOPEN_PTY)
1884 /* In the case that vfork is defined as fork, the parent process
1885 (Emacs) may send some data before the child process completes
1886 tty options setup. So we setup tty before forking. */
1887 child_setup_tty (forkout);
1888 #endif /* RTU or UNIPLUS or DONT_REOPEN_PTY */
1889 #else
1890 forkin = forkout = -1;
1891 #endif /* not USG, or USG_SUBTTY_WORKS */
1892 pty_flag = 1;
1894 else
1895 #endif /* HAVE_PTYS */
1896 #ifdef SKTPAIR
1898 if (socketpair (AF_UNIX, SOCK_STREAM, 0, sv) < 0)
1899 report_file_error ("Opening socketpair", Qnil);
1900 outchannel = inchannel = sv[0];
1901 forkout = forkin = sv[1];
1903 #else /* not SKTPAIR */
1905 int tem;
1906 tem = pipe (sv);
1907 if (tem < 0)
1908 report_file_error ("Creating pipe", Qnil);
1909 inchannel = sv[0];
1910 forkout = sv[1];
1911 tem = pipe (sv);
1912 if (tem < 0)
1914 emacs_close (inchannel);
1915 emacs_close (forkout);
1916 report_file_error ("Creating pipe", Qnil);
1918 outchannel = sv[1];
1919 forkin = sv[0];
1921 #endif /* not SKTPAIR */
1923 #if 0
1924 /* Replaced by close_process_descs */
1925 set_exclusive_use (inchannel);
1926 set_exclusive_use (outchannel);
1927 #endif
1929 /* Stride people say it's a mystery why this is needed
1930 as well as the O_NDELAY, but that it fails without this. */
1931 #if defined (STRIDE) || (defined (pfa) && defined (HAVE_PTYS))
1933 int one = 1;
1934 ioctl (inchannel, FIONBIO, &one);
1936 #endif
1938 #ifdef O_NONBLOCK
1939 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1940 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1941 #else
1942 #ifdef O_NDELAY
1943 fcntl (inchannel, F_SETFL, O_NDELAY);
1944 fcntl (outchannel, F_SETFL, O_NDELAY);
1945 #endif
1946 #endif
1948 /* Record this as an active process, with its channels.
1949 As a result, child_setup will close Emacs's side of the pipes. */
1950 chan_process[inchannel] = process;
1951 XPROCESS (process)->infd = inchannel;
1952 XPROCESS (process)->outfd = outchannel;
1954 /* Previously we recorded the tty descriptor used in the subprocess.
1955 It was only used for getting the foreground tty process, so now
1956 we just reopen the device (see emacs_get_tty_pgrp) as this is
1957 more portable (see USG_SUBTTY_WORKS above). */
1959 XPROCESS (process)->pty_flag = pty_flag;
1960 XPROCESS (process)->status = Qrun;
1961 setup_process_coding_systems (process);
1963 /* Delay interrupts until we have a chance to store
1964 the new fork's pid in its process structure */
1965 #ifdef POSIX_SIGNALS
1966 sigemptyset (&blocked);
1967 #ifdef SIGCHLD
1968 sigaddset (&blocked, SIGCHLD);
1969 #endif
1970 #ifdef HAVE_WORKING_VFORK
1971 /* On many hosts (e.g. Solaris 2.4), if a vforked child calls `signal',
1972 this sets the parent's signal handlers as well as the child's.
1973 So delay all interrupts whose handlers the child might munge,
1974 and record the current handlers so they can be restored later. */
1975 sigaddset (&blocked, SIGINT ); sigaction (SIGINT , 0, &sigint_action );
1976 sigaddset (&blocked, SIGQUIT); sigaction (SIGQUIT, 0, &sigquit_action);
1977 #ifdef AIX
1978 sigaddset (&blocked, SIGHUP ); sigaction (SIGHUP , 0, &sighup_action );
1979 #endif
1980 #endif /* HAVE_WORKING_VFORK */
1981 sigprocmask (SIG_BLOCK, &blocked, &procmask);
1982 #else /* !POSIX_SIGNALS */
1983 #ifdef SIGCHLD
1984 #ifdef BSD4_1
1985 sighold (SIGCHLD);
1986 #else /* not BSD4_1 */
1987 #if defined (BSD_SYSTEM) || defined (UNIPLUS) || defined (HPUX)
1988 sigsetmask (sigmask (SIGCHLD));
1989 #else /* ordinary USG */
1990 #if 0
1991 sigchld_deferred = 0;
1992 sigchld = signal (SIGCHLD, create_process_sigchld);
1993 #endif
1994 #endif /* ordinary USG */
1995 #endif /* not BSD4_1 */
1996 #endif /* SIGCHLD */
1997 #endif /* !POSIX_SIGNALS */
1999 FD_SET (inchannel, &input_wait_mask);
2000 FD_SET (inchannel, &non_keyboard_wait_mask);
2001 if (inchannel > max_process_desc)
2002 max_process_desc = inchannel;
2004 /* Until we store the proper pid, enable sigchld_handler
2005 to recognize an unknown pid as standing for this process.
2006 It is very important not to let this `marker' value stay
2007 in the table after this function has returned; if it does
2008 it might cause call-process to hang and subsequent asynchronous
2009 processes to get their return values scrambled. */
2010 XPROCESS (process)->pid = -1;
2012 BLOCK_INPUT;
2015 /* child_setup must clobber environ on systems with true vfork.
2016 Protect it from permanent change. */
2017 char **save_environ = environ;
2019 current_dir = ENCODE_FILE (current_dir);
2021 #ifndef WINDOWSNT
2022 pid = vfork ();
2023 if (pid == 0)
2024 #endif /* not WINDOWSNT */
2026 int xforkin = forkin;
2027 int xforkout = forkout;
2029 #if 0 /* This was probably a mistake--it duplicates code later on,
2030 but fails to handle all the cases. */
2031 /* Make sure SIGCHLD is not blocked in the child. */
2032 sigsetmask (SIGEMPTYMASK);
2033 #endif
2035 /* Make the pty be the controlling terminal of the process. */
2036 #ifdef HAVE_PTYS
2037 /* First, disconnect its current controlling terminal. */
2038 #ifdef HAVE_SETSID
2039 /* We tried doing setsid only if pty_flag, but it caused
2040 process_set_signal to fail on SGI when using a pipe. */
2041 setsid ();
2042 /* Make the pty's terminal the controlling terminal. */
2043 if (pty_flag)
2045 #ifdef TIOCSCTTY
2046 /* We ignore the return value
2047 because faith@cs.unc.edu says that is necessary on Linux. */
2048 ioctl (xforkin, TIOCSCTTY, 0);
2049 #endif
2051 #else /* not HAVE_SETSID */
2052 #ifdef USG
2053 /* It's very important to call setpgrp here and no time
2054 afterwards. Otherwise, we lose our controlling tty which
2055 is set when we open the pty. */
2056 setpgrp ();
2057 #endif /* USG */
2058 #endif /* not HAVE_SETSID */
2059 #if defined (HAVE_TERMIOS) && defined (LDISC1)
2060 if (pty_flag && xforkin >= 0)
2062 struct termios t;
2063 tcgetattr (xforkin, &t);
2064 t.c_lflag = LDISC1;
2065 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
2066 emacs_write (1, "create_process/tcsetattr LDISC1 failed\n", 39);
2068 #else
2069 #if defined (NTTYDISC) && defined (TIOCSETD)
2070 if (pty_flag && xforkin >= 0)
2072 /* Use new line discipline. */
2073 int ldisc = NTTYDISC;
2074 ioctl (xforkin, TIOCSETD, &ldisc);
2076 #endif
2077 #endif
2078 #ifdef TIOCNOTTY
2079 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
2080 can do TIOCSPGRP only to the process's controlling tty. */
2081 if (pty_flag)
2083 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
2084 I can't test it since I don't have 4.3. */
2085 int j = emacs_open ("/dev/tty", O_RDWR, 0);
2086 ioctl (j, TIOCNOTTY, 0);
2087 emacs_close (j);
2088 #ifndef USG
2089 /* In order to get a controlling terminal on some versions
2090 of BSD, it is necessary to put the process in pgrp 0
2091 before it opens the terminal. */
2092 #ifdef HAVE_SETPGID
2093 setpgid (0, 0);
2094 #else
2095 setpgrp (0, 0);
2096 #endif
2097 #endif
2099 #endif /* TIOCNOTTY */
2101 #if !defined (RTU) && !defined (UNIPLUS) && !defined (DONT_REOPEN_PTY)
2102 /*** There is a suggestion that this ought to be a
2103 conditional on TIOCSPGRP,
2104 or !(defined (HAVE_SETSID) && defined (TIOCSCTTY)).
2105 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
2106 that system does seem to need this code, even though
2107 both HAVE_SETSID and TIOCSCTTY are defined. */
2108 /* Now close the pty (if we had it open) and reopen it.
2109 This makes the pty the controlling terminal of the subprocess. */
2110 if (pty_flag)
2112 #ifdef SET_CHILD_PTY_PGRP
2113 int pgrp = getpid ();
2114 #endif
2116 /* I wonder if emacs_close (emacs_open (pty_name, ...))
2117 would work? */
2118 if (xforkin >= 0)
2119 emacs_close (xforkin);
2120 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
2122 if (xforkin < 0)
2124 emacs_write (1, "Couldn't open the pty terminal ", 31);
2125 emacs_write (1, pty_name, strlen (pty_name));
2126 emacs_write (1, "\n", 1);
2127 _exit (1);
2130 #ifdef SET_CHILD_PTY_PGRP
2131 ioctl (xforkin, TIOCSPGRP, &pgrp);
2132 ioctl (xforkout, TIOCSPGRP, &pgrp);
2133 #endif
2135 #endif /* not UNIPLUS and not RTU and not DONT_REOPEN_PTY */
2137 #ifdef SETUP_SLAVE_PTY
2138 if (pty_flag)
2140 SETUP_SLAVE_PTY;
2142 #endif /* SETUP_SLAVE_PTY */
2143 #ifdef AIX
2144 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
2145 Now reenable it in the child, so it will die when we want it to. */
2146 if (pty_flag)
2147 signal (SIGHUP, SIG_DFL);
2148 #endif
2149 #endif /* HAVE_PTYS */
2151 signal (SIGINT, SIG_DFL);
2152 signal (SIGQUIT, SIG_DFL);
2154 /* Stop blocking signals in the child. */
2155 #ifdef POSIX_SIGNALS
2156 sigprocmask (SIG_SETMASK, &procmask, 0);
2157 #else /* !POSIX_SIGNALS */
2158 #ifdef SIGCHLD
2159 #ifdef BSD4_1
2160 sigrelse (SIGCHLD);
2161 #else /* not BSD4_1 */
2162 #if defined (BSD_SYSTEM) || defined (UNIPLUS) || defined (HPUX)
2163 sigsetmask (SIGEMPTYMASK);
2164 #else /* ordinary USG */
2165 #if 0
2166 signal (SIGCHLD, sigchld);
2167 #endif
2168 #endif /* ordinary USG */
2169 #endif /* not BSD4_1 */
2170 #endif /* SIGCHLD */
2171 #endif /* !POSIX_SIGNALS */
2173 #if !defined (RTU) && !defined (UNIPLUS) && !defined (DONT_REOPEN_PTY)
2174 if (pty_flag)
2175 child_setup_tty (xforkout);
2176 #endif /* not RTU and not UNIPLUS and not DONT_REOPEN_PTY */
2177 #ifdef WINDOWSNT
2178 pid = child_setup (xforkin, xforkout, xforkout,
2179 new_argv, 1, current_dir);
2180 #else /* not WINDOWSNT */
2181 child_setup (xforkin, xforkout, xforkout,
2182 new_argv, 1, current_dir);
2183 #endif /* not WINDOWSNT */
2185 environ = save_environ;
2188 UNBLOCK_INPUT;
2190 /* This runs in the Emacs process. */
2191 if (pid < 0)
2193 if (forkin >= 0)
2194 emacs_close (forkin);
2195 if (forkin != forkout && forkout >= 0)
2196 emacs_close (forkout);
2198 else
2200 /* vfork succeeded. */
2201 XPROCESS (process)->pid = pid;
2203 #ifdef WINDOWSNT
2204 register_child (pid, inchannel);
2205 #endif /* WINDOWSNT */
2207 /* If the subfork execv fails, and it exits,
2208 this close hangs. I don't know why.
2209 So have an interrupt jar it loose. */
2211 struct atimer *timer;
2212 EMACS_TIME offset;
2214 stop_polling ();
2215 EMACS_SET_SECS_USECS (offset, 1, 0);
2216 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
2218 if (forkin >= 0)
2219 emacs_close (forkin);
2221 cancel_atimer (timer);
2222 start_polling ();
2225 if (forkin != forkout && forkout >= 0)
2226 emacs_close (forkout);
2228 #ifdef HAVE_PTYS
2229 if (pty_flag)
2230 XPROCESS (process)->tty_name = build_string (pty_name);
2231 else
2232 #endif
2233 XPROCESS (process)->tty_name = Qnil;
2236 /* Restore the signal state whether vfork succeeded or not.
2237 (We will signal an error, below, if it failed.) */
2238 #ifdef POSIX_SIGNALS
2239 #ifdef HAVE_WORKING_VFORK
2240 /* Restore the parent's signal handlers. */
2241 sigaction (SIGINT, &sigint_action, 0);
2242 sigaction (SIGQUIT, &sigquit_action, 0);
2243 #ifdef AIX
2244 sigaction (SIGHUP, &sighup_action, 0);
2245 #endif
2246 #endif /* HAVE_WORKING_VFORK */
2247 /* Stop blocking signals in the parent. */
2248 sigprocmask (SIG_SETMASK, &procmask, 0);
2249 #else /* !POSIX_SIGNALS */
2250 #ifdef SIGCHLD
2251 #ifdef BSD4_1
2252 sigrelse (SIGCHLD);
2253 #else /* not BSD4_1 */
2254 #if defined (BSD_SYSTEM) || defined (UNIPLUS) || defined (HPUX)
2255 sigsetmask (SIGEMPTYMASK);
2256 #else /* ordinary USG */
2257 #if 0
2258 signal (SIGCHLD, sigchld);
2259 /* Now really handle any of these signals
2260 that came in during this function. */
2261 if (sigchld_deferred)
2262 kill (getpid (), SIGCHLD);
2263 #endif
2264 #endif /* ordinary USG */
2265 #endif /* not BSD4_1 */
2266 #endif /* SIGCHLD */
2267 #endif /* !POSIX_SIGNALS */
2269 /* Now generate the error if vfork failed. */
2270 if (pid < 0)
2271 report_file_error ("Doing vfork", Qnil);
2273 #endif /* not VMS */
2276 #ifdef HAVE_SOCKETS
2278 /* Convert an internal struct sockaddr to a lisp object (vector or string).
2279 The address family of sa is not included in the result. */
2281 static Lisp_Object
2282 conv_sockaddr_to_lisp (sa, len)
2283 struct sockaddr *sa;
2284 int len;
2286 Lisp_Object address;
2287 int i;
2288 unsigned char *cp;
2289 register struct Lisp_Vector *p;
2291 switch (sa->sa_family)
2293 case AF_INET:
2295 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2296 len = sizeof (sin->sin_addr) + 1;
2297 address = Fmake_vector (make_number (len), Qnil);
2298 p = XVECTOR (address);
2299 p->contents[--len] = make_number (ntohs (sin->sin_port));
2300 cp = (unsigned char *)&sin->sin_addr;
2301 break;
2303 #ifdef AF_INET6
2304 case AF_INET6:
2306 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2307 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2308 len = sizeof (sin6->sin6_addr)/2 + 1;
2309 address = Fmake_vector (make_number (len), Qnil);
2310 p = XVECTOR (address);
2311 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2312 for (i = 0; i < len; i++)
2313 p->contents[i] = make_number (ntohs (ip6[i]));
2314 return address;
2316 #endif
2317 #ifdef HAVE_LOCAL_SOCKETS
2318 case AF_LOCAL:
2320 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2321 for (i = 0; i < sizeof (sockun->sun_path); i++)
2322 if (sockun->sun_path[i] == 0)
2323 break;
2324 return make_unibyte_string (sockun->sun_path, i);
2326 #endif
2327 default:
2328 len -= sizeof (sa->sa_family);
2329 address = Fcons (make_number (sa->sa_family),
2330 Fmake_vector (make_number (len), Qnil));
2331 p = XVECTOR (XCDR (address));
2332 cp = (unsigned char *) sa + sizeof (sa->sa_family);
2333 break;
2336 i = 0;
2337 while (i < len)
2338 p->contents[i++] = make_number (*cp++);
2340 return address;
2344 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2346 static int
2347 get_lisp_to_sockaddr_size (address, familyp)
2348 Lisp_Object address;
2349 int *familyp;
2351 register struct Lisp_Vector *p;
2353 if (VECTORP (address))
2355 p = XVECTOR (address);
2356 if (p->size == 5)
2358 *familyp = AF_INET;
2359 return sizeof (struct sockaddr_in);
2361 #ifdef AF_INET6
2362 else if (p->size == 9)
2364 *familyp = AF_INET6;
2365 return sizeof (struct sockaddr_in6);
2367 #endif
2369 #ifdef HAVE_LOCAL_SOCKETS
2370 else if (STRINGP (address))
2372 *familyp = AF_LOCAL;
2373 return sizeof (struct sockaddr_un);
2375 #endif
2376 else if (CONSP (address) && INTEGERP (XCAR (address)) && VECTORP (XCDR (address)))
2378 struct sockaddr *sa;
2379 *familyp = XINT (XCAR (address));
2380 p = XVECTOR (XCDR (address));
2381 return p->size + sizeof (sa->sa_family);
2383 return 0;
2386 /* Convert an address object (vector or string) to an internal sockaddr.
2388 The address format has been basically validated by
2389 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2390 it could have come from user data. So if FAMILY is not valid,
2391 we return after zeroing *SA. */
2393 static void
2394 conv_lisp_to_sockaddr (family, address, sa, len)
2395 int family;
2396 Lisp_Object address;
2397 struct sockaddr *sa;
2398 int len;
2400 register struct Lisp_Vector *p;
2401 register unsigned char *cp = NULL;
2402 register int i;
2404 bzero (sa, len);
2406 if (VECTORP (address))
2408 p = XVECTOR (address);
2409 if (family == AF_INET)
2411 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2412 len = sizeof (sin->sin_addr) + 1;
2413 i = XINT (p->contents[--len]);
2414 sin->sin_port = htons (i);
2415 cp = (unsigned char *)&sin->sin_addr;
2416 sa->sa_family = family;
2418 #ifdef AF_INET6
2419 else if (family == AF_INET6)
2421 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2422 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2423 len = sizeof (sin6->sin6_addr) + 1;
2424 i = XINT (p->contents[--len]);
2425 sin6->sin6_port = htons (i);
2426 for (i = 0; i < len; i++)
2427 if (INTEGERP (p->contents[i]))
2429 int j = XFASTINT (p->contents[i]) & 0xffff;
2430 ip6[i] = ntohs (j);
2432 sa->sa_family = family;
2434 #endif
2435 return;
2437 else if (STRINGP (address))
2439 #ifdef HAVE_LOCAL_SOCKETS
2440 if (family == AF_LOCAL)
2442 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2443 cp = SDATA (address);
2444 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2445 sockun->sun_path[i] = *cp++;
2446 sa->sa_family = family;
2448 #endif
2449 return;
2451 else
2453 p = XVECTOR (XCDR (address));
2454 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2457 for (i = 0; i < len; i++)
2458 if (INTEGERP (p->contents[i]))
2459 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2462 #ifdef DATAGRAM_SOCKETS
2463 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2464 1, 1, 0,
2465 doc: /* Get the current datagram address associated with PROCESS. */)
2466 (process)
2467 Lisp_Object process;
2469 int channel;
2471 CHECK_PROCESS (process);
2473 if (!DATAGRAM_CONN_P (process))
2474 return Qnil;
2476 channel = XPROCESS (process)->infd;
2477 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2478 datagram_address[channel].len);
2481 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2482 2, 2, 0,
2483 doc: /* Set the datagram address for PROCESS to ADDRESS.
2484 Returns nil upon error setting address, ADDRESS otherwise. */)
2485 (process, address)
2486 Lisp_Object process, address;
2488 int channel;
2489 int family, len;
2491 CHECK_PROCESS (process);
2493 if (!DATAGRAM_CONN_P (process))
2494 return Qnil;
2496 channel = XPROCESS (process)->infd;
2498 len = get_lisp_to_sockaddr_size (address, &family);
2499 if (datagram_address[channel].len != len)
2500 return Qnil;
2501 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2502 return address;
2504 #endif
2507 static struct socket_options {
2508 /* The name of this option. Should be lowercase version of option
2509 name without SO_ prefix. */
2510 char *name;
2511 /* Option level SOL_... */
2512 int optlevel;
2513 /* Option number SO_... */
2514 int optnum;
2515 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2516 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2517 } socket_options[] =
2519 #ifdef SO_BINDTODEVICE
2520 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2521 #endif
2522 #ifdef SO_BROADCAST
2523 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2524 #endif
2525 #ifdef SO_DONTROUTE
2526 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2527 #endif
2528 #ifdef SO_KEEPALIVE
2529 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2530 #endif
2531 #ifdef SO_LINGER
2532 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2533 #endif
2534 #ifdef SO_OOBINLINE
2535 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2536 #endif
2537 #ifdef SO_PRIORITY
2538 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2539 #endif
2540 #ifdef SO_REUSEADDR
2541 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2542 #endif
2543 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2546 /* Set option OPT to value VAL on socket S.
2548 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2549 Signals an error if setting a known option fails.
2552 static int
2553 set_socket_option (s, opt, val)
2554 int s;
2555 Lisp_Object opt, val;
2557 char *name;
2558 struct socket_options *sopt;
2559 int ret = 0;
2561 CHECK_SYMBOL (opt);
2563 name = (char *) SDATA (SYMBOL_NAME (opt));
2564 for (sopt = socket_options; sopt->name; sopt++)
2565 if (strcmp (name, sopt->name) == 0)
2566 break;
2568 switch (sopt->opttype)
2570 case SOPT_BOOL:
2572 int optval;
2573 optval = NILP (val) ? 0 : 1;
2574 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2575 &optval, sizeof (optval));
2576 break;
2579 case SOPT_INT:
2581 int optval;
2582 if (INTEGERP (val))
2583 optval = XINT (val);
2584 else
2585 error ("Bad option value for %s", name);
2586 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2587 &optval, sizeof (optval));
2588 break;
2591 #ifdef SO_BINDTODEVICE
2592 case SOPT_IFNAME:
2594 char devname[IFNAMSIZ+1];
2596 /* This is broken, at least in the Linux 2.4 kernel.
2597 To unbind, the arg must be a zero integer, not the empty string.
2598 This should work on all systems. KFS. 2003-09-23. */
2599 bzero (devname, sizeof devname);
2600 if (STRINGP (val))
2602 char *arg = (char *) SDATA (val);
2603 int len = min (strlen (arg), IFNAMSIZ);
2604 bcopy (arg, devname, len);
2606 else if (!NILP (val))
2607 error ("Bad option value for %s", name);
2608 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2609 devname, IFNAMSIZ);
2610 break;
2612 #endif
2614 #ifdef SO_LINGER
2615 case SOPT_LINGER:
2617 struct linger linger;
2619 linger.l_onoff = 1;
2620 linger.l_linger = 0;
2621 if (INTEGERP (val))
2622 linger.l_linger = XINT (val);
2623 else
2624 linger.l_onoff = NILP (val) ? 0 : 1;
2625 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2626 &linger, sizeof (linger));
2627 break;
2629 #endif
2631 default:
2632 return 0;
2635 if (ret < 0)
2636 report_file_error ("Cannot set network option",
2637 Fcons (opt, Fcons (val, Qnil)));
2638 return (1 << sopt->optbit);
2642 DEFUN ("set-network-process-option",
2643 Fset_network_process_option, Sset_network_process_option,
2644 3, 4, 0,
2645 doc: /* For network process PROCESS set option OPTION to value VALUE.
2646 See `make-network-process' for a list of options and values.
2647 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2648 OPTION is not a supported option, return nil instead; otherwise return t. */)
2649 (process, option, value, no_error)
2650 Lisp_Object process, option, value;
2651 Lisp_Object no_error;
2653 int s;
2654 struct Lisp_Process *p;
2656 CHECK_PROCESS (process);
2657 p = XPROCESS (process);
2658 if (!NETCONN1_P (p))
2659 error ("Process is not a network process");
2661 s = p->infd;
2662 if (s < 0)
2663 error ("Process is not running");
2665 if (set_socket_option (s, option, value))
2667 p->childp = Fplist_put (p->childp, option, value);
2668 return Qt;
2671 if (NILP (no_error))
2672 error ("Unknown or unsupported option");
2674 return Qnil;
2678 /* A version of request_sigio suitable for a record_unwind_protect. */
2680 static Lisp_Object
2681 unwind_request_sigio (dummy)
2682 Lisp_Object dummy;
2684 if (interrupt_input)
2685 request_sigio ();
2686 return Qnil;
2689 /* Create a network stream/datagram client/server process. Treated
2690 exactly like a normal process when reading and writing. Primary
2691 differences are in status display and process deletion. A network
2692 connection has no PID; you cannot signal it. All you can do is
2693 stop/continue it and deactivate/close it via delete-process */
2695 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2696 0, MANY, 0,
2697 doc: /* Create and return a network server or client process.
2699 In Emacs, network connections are represented by process objects, so
2700 input and output work as for subprocesses and `delete-process' closes
2701 a network connection. However, a network process has no process id,
2702 it cannot be signaled, and the status codes are different from normal
2703 processes.
2705 Arguments are specified as keyword/argument pairs. The following
2706 arguments are defined:
2708 :name NAME -- NAME is name for process. It is modified if necessary
2709 to make it unique.
2711 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2712 with the process. Process output goes at end of that buffer, unless
2713 you specify an output stream or filter function to handle the output.
2714 BUFFER may be also nil, meaning that this process is not associated
2715 with any buffer.
2717 :host HOST -- HOST is name of the host to connect to, or its IP
2718 address. The symbol `local' specifies the local host. If specified
2719 for a server process, it must be a valid name or address for the local
2720 host, and only clients connecting to that address will be accepted.
2722 :service SERVICE -- SERVICE is name of the service desired, or an
2723 integer specifying a port number to connect to. If SERVICE is t,
2724 a random port number is selected for the server.
2726 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2727 stream type connection, `datagram' creates a datagram type connection.
2729 :family FAMILY -- FAMILY is the address (and protocol) family for the
2730 service specified by HOST and SERVICE. The default (nil) is to use
2731 whatever address family (IPv4 or IPv6) that is defined for the host
2732 and port number specified by HOST and SERVICE. Other address families
2733 supported are:
2734 local -- for a local (i.e. UNIX) address specified by SERVICE.
2735 ipv4 -- use IPv4 address family only.
2736 ipv6 -- use IPv6 address family only.
2738 :local ADDRESS -- ADDRESS is the local address used for the connection.
2739 This parameter is ignored when opening a client process. When specified
2740 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2742 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2743 connection. This parameter is ignored when opening a stream server
2744 process. For a datagram server process, it specifies the initial
2745 setting of the remote datagram address. When specified for a client
2746 process, the FAMILY, HOST, and SERVICE args are ignored.
2748 The format of ADDRESS depends on the address family:
2749 - An IPv4 address is represented as an vector of integers [A B C D P]
2750 corresponding to numeric IP address A.B.C.D and port number P.
2751 - A local address is represented as a string with the address in the
2752 local address space.
2753 - An "unsupported family" address is represented by a cons (F . AV)
2754 where F is the family number and AV is a vector containing the socket
2755 address data with one element per address data byte. Do not rely on
2756 this format in portable code, as it may depend on implementation
2757 defined constants, data sizes, and data structure alignment.
2759 :coding CODING -- If CODING is a symbol, it specifies the coding
2760 system used for both reading and writing for this process. If CODING
2761 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2762 ENCODING is used for writing.
2764 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2765 return without waiting for the connection to complete; instead, the
2766 sentinel function will be called with second arg matching "open" (if
2767 successful) or "failed" when the connect completes. Default is to use
2768 a blocking connect (i.e. wait) for stream type connections.
2770 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2771 running when Emacs is exited.
2773 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2774 In the stopped state, a server process does not accept new
2775 connections, and a client process does not handle incoming traffic.
2776 The stopped state is cleared by `continue-process' and set by
2777 `stop-process'.
2779 :filter FILTER -- Install FILTER as the process filter.
2781 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2782 process filter are multibyte, otherwise they are unibyte.
2783 If this keyword is not specified, the strings are multibyte if
2784 `default-enable-multibyte-characters' is non-nil.
2786 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2788 :log LOG -- Install LOG as the server process log function. This
2789 function is called when the server accepts a network connection from a
2790 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2791 is the server process, CLIENT is the new process for the connection,
2792 and MESSAGE is a string.
2794 :plist PLIST -- Install PLIST as the new process' initial plist.
2796 :server QLEN -- if QLEN is non-nil, create a server process for the
2797 specified FAMILY, SERVICE, and connection type (stream or datagram).
2798 If QLEN is an integer, it is used as the max. length of the server's
2799 pending connection queue (also known as the backlog); the default
2800 queue length is 5. Default is to create a client process.
2802 The following network options can be specified for this connection:
2804 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2805 :dontroute BOOL -- Only send to directly connected hosts.
2806 :keepalive BOOL -- Send keep-alive messages on network stream.
2807 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2808 :oobinline BOOL -- Place out-of-band data in receive data stream.
2809 :priority INT -- Set protocol defined priority for sent packets.
2810 :reuseaddr BOOL -- Allow reusing a recently used local address
2811 (this is allowed by default for a server process).
2812 :bindtodevice NAME -- bind to interface NAME. Using this may require
2813 special privileges on some systems.
2815 Consult the relevant system programmer's manual pages for more
2816 information on using these options.
2819 A server process will listen for and accept connections from clients.
2820 When a client connection is accepted, a new network process is created
2821 for the connection with the following parameters:
2823 - The client's process name is constructed by concatenating the server
2824 process' NAME and a client identification string.
2825 - If the FILTER argument is non-nil, the client process will not get a
2826 separate process buffer; otherwise, the client's process buffer is a newly
2827 created buffer named after the server process' BUFFER name or process
2828 NAME concatenated with the client identification string.
2829 - The connection type and the process filter and sentinel parameters are
2830 inherited from the server process' TYPE, FILTER and SENTINEL.
2831 - The client process' contact info is set according to the client's
2832 addressing information (typically an IP address and a port number).
2833 - The client process' plist is initialized from the server's plist.
2835 Notice that the FILTER and SENTINEL args are never used directly by
2836 the server process. Also, the BUFFER argument is not used directly by
2837 the server process, but via the optional :log function, accepted (and
2838 failed) connections may be logged in the server process' buffer.
2840 The original argument list, modified with the actual connection
2841 information, is available via the `process-contact' function.
2843 usage: (make-network-process &rest ARGS) */)
2844 (nargs, args)
2845 int nargs;
2846 Lisp_Object *args;
2848 Lisp_Object proc;
2849 Lisp_Object contact;
2850 struct Lisp_Process *p;
2851 #ifdef HAVE_GETADDRINFO
2852 struct addrinfo ai, *res, *lres;
2853 struct addrinfo hints;
2854 char *portstring, portbuf[128];
2855 #else /* HAVE_GETADDRINFO */
2856 struct _emacs_addrinfo
2858 int ai_family;
2859 int ai_socktype;
2860 int ai_protocol;
2861 int ai_addrlen;
2862 struct sockaddr *ai_addr;
2863 struct _emacs_addrinfo *ai_next;
2864 } ai, *res, *lres;
2865 #endif /* HAVE_GETADDRINFO */
2866 struct sockaddr_in address_in;
2867 #ifdef HAVE_LOCAL_SOCKETS
2868 struct sockaddr_un address_un;
2869 #endif
2870 int port;
2871 int ret = 0;
2872 int xerrno = 0;
2873 int s = -1, outch, inch;
2874 struct gcpro gcpro1;
2875 int count = SPECPDL_INDEX ();
2876 int count1;
2877 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2878 Lisp_Object tem;
2879 Lisp_Object name, buffer, host, service, address;
2880 Lisp_Object filter, sentinel;
2881 int is_non_blocking_client = 0;
2882 int is_server = 0, backlog = 5;
2883 int socktype;
2884 int family = -1;
2886 if (nargs == 0)
2887 return Qnil;
2889 /* Save arguments for process-contact and clone-process. */
2890 contact = Flist (nargs, args);
2891 GCPRO1 (contact);
2893 #ifdef WINDOWSNT
2894 /* Ensure socket support is loaded if available. */
2895 init_winsock (TRUE);
2896 #endif
2898 /* :type TYPE (nil: stream, datagram */
2899 tem = Fplist_get (contact, QCtype);
2900 if (NILP (tem))
2901 socktype = SOCK_STREAM;
2902 #ifdef DATAGRAM_SOCKETS
2903 else if (EQ (tem, Qdatagram))
2904 socktype = SOCK_DGRAM;
2905 #endif
2906 else
2907 error ("Unsupported connection type");
2909 /* :server BOOL */
2910 tem = Fplist_get (contact, QCserver);
2911 if (!NILP (tem))
2913 /* Don't support network sockets when non-blocking mode is
2914 not available, since a blocked Emacs is not useful. */
2915 #if defined(TERM) || (!defined(O_NONBLOCK) && !defined(O_NDELAY))
2916 error ("Network servers not supported");
2917 #else
2918 is_server = 1;
2919 if (INTEGERP (tem))
2920 backlog = XINT (tem);
2921 #endif
2924 /* Make QCaddress an alias for :local (server) or :remote (client). */
2925 QCaddress = is_server ? QClocal : QCremote;
2927 /* :nowait BOOL */
2928 if (!is_server && socktype == SOCK_STREAM
2929 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2931 #ifndef NON_BLOCKING_CONNECT
2932 error ("Non-blocking connect not supported");
2933 #else
2934 is_non_blocking_client = 1;
2935 #endif
2938 name = Fplist_get (contact, QCname);
2939 buffer = Fplist_get (contact, QCbuffer);
2940 filter = Fplist_get (contact, QCfilter);
2941 sentinel = Fplist_get (contact, QCsentinel);
2943 CHECK_STRING (name);
2945 #ifdef TERM
2946 /* Let's handle TERM before things get complicated ... */
2947 host = Fplist_get (contact, QChost);
2948 CHECK_STRING (host);
2950 service = Fplist_get (contact, QCservice);
2951 if (INTEGERP (service))
2952 port = htons ((unsigned short) XINT (service));
2953 else
2955 struct servent *svc_info;
2956 CHECK_STRING (service);
2957 svc_info = getservbyname (SDATA (service), "tcp");
2958 if (svc_info == 0)
2959 error ("Unknown service: %s", SDATA (service));
2960 port = svc_info->s_port;
2963 s = connect_server (0);
2964 if (s < 0)
2965 report_file_error ("error creating socket", Fcons (name, Qnil));
2966 send_command (s, C_PORT, 0, "%s:%d", SDATA (host), ntohs (port));
2967 send_command (s, C_DUMB, 1, 0);
2969 #else /* not TERM */
2971 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2972 ai.ai_socktype = socktype;
2973 ai.ai_protocol = 0;
2974 ai.ai_next = NULL;
2975 res = &ai;
2977 /* :local ADDRESS or :remote ADDRESS */
2978 address = Fplist_get (contact, QCaddress);
2979 if (!NILP (address))
2981 host = service = Qnil;
2983 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2984 error ("Malformed :address");
2985 ai.ai_family = family;
2986 ai.ai_addr = alloca (ai.ai_addrlen);
2987 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2988 goto open_socket;
2991 /* :family FAMILY -- nil (for Inet), local, or integer. */
2992 tem = Fplist_get (contact, QCfamily);
2993 if (NILP (tem))
2995 #if defined(HAVE_GETADDRINFO) && defined(AF_INET6)
2996 family = AF_UNSPEC;
2997 #else
2998 family = AF_INET;
2999 #endif
3001 #ifdef HAVE_LOCAL_SOCKETS
3002 else if (EQ (tem, Qlocal))
3003 family = AF_LOCAL;
3004 #endif
3005 #ifdef AF_INET6
3006 else if (EQ (tem, Qipv6))
3007 family = AF_INET6;
3008 #endif
3009 else if (EQ (tem, Qipv4))
3010 family = AF_INET;
3011 else if (INTEGERP (tem))
3012 family = XINT (tem);
3013 else
3014 error ("Unknown address family");
3016 ai.ai_family = family;
3018 /* :service SERVICE -- string, integer (port number), or t (random port). */
3019 service = Fplist_get (contact, QCservice);
3021 #ifdef HAVE_LOCAL_SOCKETS
3022 if (family == AF_LOCAL)
3024 /* Host is not used. */
3025 host = Qnil;
3026 CHECK_STRING (service);
3027 bzero (&address_un, sizeof address_un);
3028 address_un.sun_family = AF_LOCAL;
3029 strncpy (address_un.sun_path, SDATA (service), sizeof address_un.sun_path);
3030 ai.ai_addr = (struct sockaddr *) &address_un;
3031 ai.ai_addrlen = sizeof address_un;
3032 goto open_socket;
3034 #endif
3036 /* :host HOST -- hostname, ip address, or 'local for localhost. */
3037 host = Fplist_get (contact, QChost);
3038 if (!NILP (host))
3040 if (EQ (host, Qlocal))
3041 host = build_string ("localhost");
3042 CHECK_STRING (host);
3045 /* Slow down polling to every ten seconds.
3046 Some kernels have a bug which causes retrying connect to fail
3047 after a connect. Polling can interfere with gethostbyname too. */
3048 #ifdef POLL_FOR_INPUT
3049 if (socktype == SOCK_STREAM)
3051 record_unwind_protect (unwind_stop_other_atimers, Qnil);
3052 bind_polling_period (10);
3054 #endif
3056 #ifdef HAVE_GETADDRINFO
3057 /* If we have a host, use getaddrinfo to resolve both host and service.
3058 Otherwise, use getservbyname to lookup the service. */
3059 if (!NILP (host))
3062 /* SERVICE can either be a string or int.
3063 Convert to a C string for later use by getaddrinfo. */
3064 if (EQ (service, Qt))
3065 portstring = "0";
3066 else if (INTEGERP (service))
3068 sprintf (portbuf, "%ld", (long) XINT (service));
3069 portstring = portbuf;
3071 else
3073 CHECK_STRING (service);
3074 portstring = SDATA (service);
3077 immediate_quit = 1;
3078 QUIT;
3079 memset (&hints, 0, sizeof (hints));
3080 hints.ai_flags = 0;
3081 hints.ai_family = family;
3082 hints.ai_socktype = socktype;
3083 hints.ai_protocol = 0;
3084 ret = getaddrinfo (SDATA (host), portstring, &hints, &res);
3085 if (ret)
3086 #ifdef HAVE_GAI_STRERROR
3087 error ("%s/%s %s", SDATA (host), portstring, gai_strerror(ret));
3088 #else
3089 error ("%s/%s getaddrinfo error %d", SDATA (host), portstring, ret);
3090 #endif
3091 immediate_quit = 0;
3093 goto open_socket;
3095 #endif /* HAVE_GETADDRINFO */
3097 /* We end up here if getaddrinfo is not defined, or in case no hostname
3098 has been specified (e.g. for a local server process). */
3100 if (EQ (service, Qt))
3101 port = 0;
3102 else if (INTEGERP (service))
3103 port = htons ((unsigned short) XINT (service));
3104 else
3106 struct servent *svc_info;
3107 CHECK_STRING (service);
3108 svc_info = getservbyname (SDATA (service),
3109 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3110 if (svc_info == 0)
3111 error ("Unknown service: %s", SDATA (service));
3112 port = svc_info->s_port;
3115 bzero (&address_in, sizeof address_in);
3116 address_in.sin_family = family;
3117 address_in.sin_addr.s_addr = INADDR_ANY;
3118 address_in.sin_port = port;
3120 #ifndef HAVE_GETADDRINFO
3121 if (!NILP (host))
3123 struct hostent *host_info_ptr;
3125 /* gethostbyname may fail with TRY_AGAIN, but we don't honour that,
3126 as it may `hang' Emacs for a very long time. */
3127 immediate_quit = 1;
3128 QUIT;
3129 host_info_ptr = gethostbyname (SDATA (host));
3130 immediate_quit = 0;
3132 if (host_info_ptr)
3134 bcopy (host_info_ptr->h_addr, (char *) &address_in.sin_addr,
3135 host_info_ptr->h_length);
3136 family = host_info_ptr->h_addrtype;
3137 address_in.sin_family = family;
3139 else
3140 /* Attempt to interpret host as numeric inet address */
3142 IN_ADDR numeric_addr;
3143 numeric_addr = inet_addr ((char *) SDATA (host));
3144 if (NUMERIC_ADDR_ERROR)
3145 error ("Unknown host \"%s\"", SDATA (host));
3147 bcopy ((char *)&numeric_addr, (char *) &address_in.sin_addr,
3148 sizeof (address_in.sin_addr));
3152 #endif /* not HAVE_GETADDRINFO */
3154 ai.ai_family = family;
3155 ai.ai_addr = (struct sockaddr *) &address_in;
3156 ai.ai_addrlen = sizeof address_in;
3158 open_socket:
3160 #ifdef __ultrix__
3161 /* Previously this was compiled unconditionally, but that seems
3162 unnecessary on modern systems, and `unrequest_sigio' was a noop
3163 under X anyway. --lorentey */
3164 /* Kernel bugs (on Ultrix at least) cause lossage (not just EINTR)
3165 when connect is interrupted. So let's not let it get interrupted.
3166 Note we do not turn off polling, because polling is only used
3167 when not interrupt_input, and thus not normally used on the systems
3168 which have this bug. On systems which use polling, there's no way
3169 to quit if polling is turned off. */
3170 if (interrupt_input
3171 && !is_server && socktype == SOCK_STREAM)
3173 /* Comment from KFS: The original open-network-stream code
3174 didn't unwind protect this, but it seems like the proper
3175 thing to do. In any case, I don't see how it could harm to
3176 do this -- and it makes cleanup (using unbind_to) easier. */
3177 record_unwind_protect (unwind_request_sigio, Qnil);
3178 unrequest_sigio ();
3180 #endif
3182 /* Do this in case we never enter the for-loop below. */
3183 count1 = SPECPDL_INDEX ();
3184 s = -1;
3186 for (lres = res; lres; lres = lres->ai_next)
3188 int optn, optbits;
3190 retry_connect:
3192 s = socket (lres->ai_family, lres->ai_socktype, lres->ai_protocol);
3193 if (s < 0)
3195 xerrno = errno;
3196 continue;
3199 #ifdef DATAGRAM_SOCKETS
3200 if (!is_server && socktype == SOCK_DGRAM)
3201 break;
3202 #endif /* DATAGRAM_SOCKETS */
3204 #ifdef NON_BLOCKING_CONNECT
3205 if (is_non_blocking_client)
3207 #ifdef O_NONBLOCK
3208 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3209 #else
3210 ret = fcntl (s, F_SETFL, O_NDELAY);
3211 #endif
3212 if (ret < 0)
3214 xerrno = errno;
3215 emacs_close (s);
3216 s = -1;
3217 continue;
3220 #endif
3222 /* Make us close S if quit. */
3223 record_unwind_protect (close_file_unwind, make_number (s));
3225 /* Parse network options in the arg list.
3226 We simply ignore anything which isn't a known option (including other keywords).
3227 An error is signalled if setting a known option fails. */
3228 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3229 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3231 if (is_server)
3233 /* Configure as a server socket. */
3235 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3236 explicit :reuseaddr key to override this. */
3237 #ifdef HAVE_LOCAL_SOCKETS
3238 if (family != AF_LOCAL)
3239 #endif
3240 if (!(optbits & (1 << OPIX_REUSEADDR)))
3242 int optval = 1;
3243 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3244 report_file_error ("Cannot set reuse option on server socket", Qnil);
3247 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3248 report_file_error ("Cannot bind server socket", Qnil);
3250 #ifdef HAVE_GETSOCKNAME
3251 if (EQ (service, Qt))
3253 struct sockaddr_in sa1;
3254 int len1 = sizeof (sa1);
3255 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3257 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3258 service = make_number (ntohs (sa1.sin_port));
3259 contact = Fplist_put (contact, QCservice, service);
3262 #endif
3264 if (socktype == SOCK_STREAM && listen (s, backlog))
3265 report_file_error ("Cannot listen on server socket", Qnil);
3267 break;
3270 immediate_quit = 1;
3271 QUIT;
3273 /* This turns off all alarm-based interrupts; the
3274 bind_polling_period call above doesn't always turn all the
3275 short-interval ones off, especially if interrupt_input is
3276 set.
3278 It'd be nice to be able to control the connect timeout
3279 though. Would non-blocking connect calls be portable?
3281 This used to be conditioned by HAVE_GETADDRINFO. Why? */
3283 turn_on_atimers (0);
3285 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3286 xerrno = errno;
3288 turn_on_atimers (1);
3290 if (ret == 0 || xerrno == EISCONN)
3292 /* The unwind-protect will be discarded afterwards.
3293 Likewise for immediate_quit. */
3294 break;
3297 #ifdef NON_BLOCKING_CONNECT
3298 #ifdef EINPROGRESS
3299 if (is_non_blocking_client && xerrno == EINPROGRESS)
3300 break;
3301 #else
3302 #ifdef EWOULDBLOCK
3303 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3304 break;
3305 #endif
3306 #endif
3307 #endif
3309 immediate_quit = 0;
3311 /* Discard the unwind protect closing S. */
3312 specpdl_ptr = specpdl + count1;
3313 emacs_close (s);
3314 s = -1;
3316 if (xerrno == EINTR)
3317 goto retry_connect;
3320 if (s >= 0)
3322 #ifdef DATAGRAM_SOCKETS
3323 if (socktype == SOCK_DGRAM)
3325 if (datagram_address[s].sa)
3326 abort ();
3327 datagram_address[s].sa = (struct sockaddr *) xmalloc (lres->ai_addrlen);
3328 datagram_address[s].len = lres->ai_addrlen;
3329 if (is_server)
3331 Lisp_Object remote;
3332 bzero (datagram_address[s].sa, lres->ai_addrlen);
3333 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3335 int rfamily, rlen;
3336 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3337 if (rfamily == lres->ai_family && rlen == lres->ai_addrlen)
3338 conv_lisp_to_sockaddr (rfamily, remote,
3339 datagram_address[s].sa, rlen);
3342 else
3343 bcopy (lres->ai_addr, datagram_address[s].sa, lres->ai_addrlen);
3345 #endif
3346 contact = Fplist_put (contact, QCaddress,
3347 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3348 #ifdef HAVE_GETSOCKNAME
3349 if (!is_server)
3351 struct sockaddr_in sa1;
3352 int len1 = sizeof (sa1);
3353 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3354 contact = Fplist_put (contact, QClocal,
3355 conv_sockaddr_to_lisp (&sa1, len1));
3357 #endif
3360 immediate_quit = 0;
3362 #ifdef HAVE_GETADDRINFO
3363 if (res != &ai)
3365 BLOCK_INPUT;
3366 freeaddrinfo (res);
3367 UNBLOCK_INPUT;
3369 #endif
3371 /* Discard the unwind protect for closing S, if any. */
3372 specpdl_ptr = specpdl + count1;
3374 /* Unwind bind_polling_period and request_sigio. */
3375 unbind_to (count, Qnil);
3377 if (s < 0)
3379 /* If non-blocking got this far - and failed - assume non-blocking is
3380 not supported after all. This is probably a wrong assumption, but
3381 the normal blocking calls to open-network-stream handles this error
3382 better. */
3383 if (is_non_blocking_client)
3384 return Qnil;
3386 errno = xerrno;
3387 if (is_server)
3388 report_file_error ("make server process failed", contact);
3389 else
3390 report_file_error ("make client process failed", contact);
3393 #endif /* not TERM */
3395 inch = s;
3396 outch = s;
3398 if (!NILP (buffer))
3399 buffer = Fget_buffer_create (buffer);
3400 proc = make_process (name);
3402 chan_process[inch] = proc;
3404 #ifdef O_NONBLOCK
3405 fcntl (inch, F_SETFL, O_NONBLOCK);
3406 #else
3407 #ifdef O_NDELAY
3408 fcntl (inch, F_SETFL, O_NDELAY);
3409 #endif
3410 #endif
3412 p = XPROCESS (proc);
3414 p->childp = contact;
3415 p->plist = Fcopy_sequence (Fplist_get (contact, QCplist));
3417 p->buffer = buffer;
3418 p->sentinel = sentinel;
3419 p->filter = filter;
3420 p->filter_multibyte = !NILP (buffer_defaults.enable_multibyte_characters);
3421 /* Override the above only if :filter-multibyte is specified. */
3422 if (! NILP (Fplist_member (contact, QCfilter_multibyte)))
3423 p->filter_multibyte = !NILP (Fplist_get (contact, QCfilter_multibyte));
3424 p->log = Fplist_get (contact, QClog);
3425 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3426 p->kill_without_query = 1;
3427 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3428 p->command = Qt;
3429 p->pid = 0;
3430 p->infd = inch;
3431 p->outfd = outch;
3432 if (is_server && socktype == SOCK_STREAM)
3433 p->status = Qlisten;
3435 /* Make the process marker point into the process buffer (if any). */
3436 if (BUFFERP (buffer))
3437 set_marker_both (p->mark, buffer,
3438 BUF_ZV (XBUFFER (buffer)),
3439 BUF_ZV_BYTE (XBUFFER (buffer)));
3441 #ifdef NON_BLOCKING_CONNECT
3442 if (is_non_blocking_client)
3444 /* We may get here if connect did succeed immediately. However,
3445 in that case, we still need to signal this like a non-blocking
3446 connection. */
3447 p->status = Qconnect;
3448 if (!FD_ISSET (inch, &connect_wait_mask))
3450 FD_SET (inch, &connect_wait_mask);
3451 num_pending_connects++;
3454 else
3455 #endif
3456 /* A server may have a client filter setting of Qt, but it must
3457 still listen for incoming connects unless it is stopped. */
3458 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3459 || (EQ (p->status, Qlisten) && NILP (p->command)))
3461 FD_SET (inch, &input_wait_mask);
3462 FD_SET (inch, &non_keyboard_wait_mask);
3465 if (inch > max_process_desc)
3466 max_process_desc = inch;
3468 tem = Fplist_member (contact, QCcoding);
3469 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3470 tem = Qnil; /* No error message (too late!). */
3473 /* Setup coding systems for communicating with the network stream. */
3474 struct gcpro gcpro1;
3475 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3476 Lisp_Object coding_systems = Qt;
3477 Lisp_Object args[5], val;
3479 if (!NILP (tem))
3481 val = XCAR (XCDR (tem));
3482 if (CONSP (val))
3483 val = XCAR (val);
3485 else if (!NILP (Vcoding_system_for_read))
3486 val = Vcoding_system_for_read;
3487 else if ((!NILP (buffer) && NILP (XBUFFER (buffer)->enable_multibyte_characters))
3488 || (NILP (buffer) && NILP (buffer_defaults.enable_multibyte_characters)))
3489 /* We dare not decode end-of-line format by setting VAL to
3490 Qraw_text, because the existing Emacs Lisp libraries
3491 assume that they receive bare code including a sequene of
3492 CR LF. */
3493 val = Qnil;
3494 else
3496 if (NILP (host) || NILP (service))
3497 coding_systems = Qnil;
3498 else
3500 args[0] = Qopen_network_stream, args[1] = name,
3501 args[2] = buffer, args[3] = host, args[4] = service;
3502 GCPRO1 (proc);
3503 coding_systems = Ffind_operation_coding_system (5, args);
3504 UNGCPRO;
3506 if (CONSP (coding_systems))
3507 val = XCAR (coding_systems);
3508 else if (CONSP (Vdefault_process_coding_system))
3509 val = XCAR (Vdefault_process_coding_system);
3510 else
3511 val = Qnil;
3513 p->decode_coding_system = val;
3515 if (!NILP (tem))
3517 val = XCAR (XCDR (tem));
3518 if (CONSP (val))
3519 val = XCDR (val);
3521 else if (!NILP (Vcoding_system_for_write))
3522 val = Vcoding_system_for_write;
3523 else if (NILP (current_buffer->enable_multibyte_characters))
3524 val = Qnil;
3525 else
3527 if (EQ (coding_systems, Qt))
3529 if (NILP (host) || NILP (service))
3530 coding_systems = Qnil;
3531 else
3533 args[0] = Qopen_network_stream, args[1] = name,
3534 args[2] = buffer, args[3] = host, args[4] = service;
3535 GCPRO1 (proc);
3536 coding_systems = Ffind_operation_coding_system (5, args);
3537 UNGCPRO;
3540 if (CONSP (coding_systems))
3541 val = XCDR (coding_systems);
3542 else if (CONSP (Vdefault_process_coding_system))
3543 val = XCDR (Vdefault_process_coding_system);
3544 else
3545 val = Qnil;
3547 p->encode_coding_system = val;
3549 setup_process_coding_systems (proc);
3551 p->decoding_buf = make_uninit_string (0);
3552 p->decoding_carryover = 0;
3553 p->encoding_buf = make_uninit_string (0);
3555 p->inherit_coding_system_flag
3556 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3558 UNGCPRO;
3559 return proc;
3561 #endif /* HAVE_SOCKETS */
3564 #if defined(HAVE_SOCKETS) && defined(HAVE_NET_IF_H) && defined(HAVE_SYS_IOCTL_H)
3566 #ifdef SIOCGIFCONF
3567 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3568 doc: /* Return an alist of all network interfaces and their network address.
3569 Each element is a cons, the car of which is a string containing the
3570 interface name, and the cdr is the network address in internal
3571 format; see the description of ADDRESS in `make-network-process'. */)
3574 struct ifconf ifconf;
3575 struct ifreq *ifreqs = NULL;
3576 int ifaces = 0;
3577 int buf_size, s;
3578 Lisp_Object res;
3580 s = socket (AF_INET, SOCK_STREAM, 0);
3581 if (s < 0)
3582 return Qnil;
3584 again:
3585 ifaces += 25;
3586 buf_size = ifaces * sizeof(ifreqs[0]);
3587 ifreqs = (struct ifreq *)xrealloc(ifreqs, buf_size);
3588 if (!ifreqs)
3590 close (s);
3591 return Qnil;
3594 ifconf.ifc_len = buf_size;
3595 ifconf.ifc_req = ifreqs;
3596 if (ioctl (s, SIOCGIFCONF, &ifconf))
3598 close (s);
3599 return Qnil;
3602 if (ifconf.ifc_len == buf_size)
3603 goto again;
3605 close (s);
3606 ifaces = ifconf.ifc_len / sizeof (ifreqs[0]);
3608 res = Qnil;
3609 while (--ifaces >= 0)
3611 struct ifreq *ifq = &ifreqs[ifaces];
3612 char namebuf[sizeof (ifq->ifr_name) + 1];
3613 if (ifq->ifr_addr.sa_family != AF_INET)
3614 continue;
3615 bcopy (ifq->ifr_name, namebuf, sizeof (ifq->ifr_name));
3616 namebuf[sizeof (ifq->ifr_name)] = 0;
3617 res = Fcons (Fcons (build_string (namebuf),
3618 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3619 sizeof (struct sockaddr))),
3620 res);
3623 return res;
3625 #endif /* SIOCGIFCONF */
3627 #if defined(SIOCGIFADDR) || defined(SIOCGIFHWADDR) || defined(SIOCGIFFLAGS)
3629 struct ifflag_def {
3630 int flag_bit;
3631 char *flag_sym;
3634 static struct ifflag_def ifflag_table[] = {
3635 #ifdef IFF_UP
3636 { IFF_UP, "up" },
3637 #endif
3638 #ifdef IFF_BROADCAST
3639 { IFF_BROADCAST, "broadcast" },
3640 #endif
3641 #ifdef IFF_DEBUG
3642 { IFF_DEBUG, "debug" },
3643 #endif
3644 #ifdef IFF_LOOPBACK
3645 { IFF_LOOPBACK, "loopback" },
3646 #endif
3647 #ifdef IFF_POINTOPOINT
3648 { IFF_POINTOPOINT, "pointopoint" },
3649 #endif
3650 #ifdef IFF_RUNNING
3651 { IFF_RUNNING, "running" },
3652 #endif
3653 #ifdef IFF_NOARP
3654 { IFF_NOARP, "noarp" },
3655 #endif
3656 #ifdef IFF_PROMISC
3657 { IFF_PROMISC, "promisc" },
3658 #endif
3659 #ifdef IFF_NOTRAILERS
3660 { IFF_NOTRAILERS, "notrailers" },
3661 #endif
3662 #ifdef IFF_ALLMULTI
3663 { IFF_ALLMULTI, "allmulti" },
3664 #endif
3665 #ifdef IFF_MASTER
3666 { IFF_MASTER, "master" },
3667 #endif
3668 #ifdef IFF_SLAVE
3669 { IFF_SLAVE, "slave" },
3670 #endif
3671 #ifdef IFF_MULTICAST
3672 { IFF_MULTICAST, "multicast" },
3673 #endif
3674 #ifdef IFF_PORTSEL
3675 { IFF_PORTSEL, "portsel" },
3676 #endif
3677 #ifdef IFF_AUTOMEDIA
3678 { IFF_AUTOMEDIA, "automedia" },
3679 #endif
3680 #ifdef IFF_DYNAMIC
3681 { IFF_DYNAMIC, "dynamic" },
3682 #endif
3683 #ifdef IFF_OACTIVE
3684 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3685 #endif
3686 #ifdef IFF_SIMPLEX
3687 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3688 #endif
3689 #ifdef IFF_LINK0
3690 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3691 #endif
3692 #ifdef IFF_LINK1
3693 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3694 #endif
3695 #ifdef IFF_LINK2
3696 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3697 #endif
3698 { 0, 0 }
3701 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3702 doc: /* Return information about network interface named IFNAME.
3703 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3704 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3705 NETMASK is the layer 3 network mask, HWADDR is the layer 2 addres, and
3706 FLAGS is the current flags of the interface. */)
3707 (ifname)
3708 Lisp_Object ifname;
3710 struct ifreq rq;
3711 Lisp_Object res = Qnil;
3712 Lisp_Object elt;
3713 int s;
3714 int any = 0;
3716 CHECK_STRING (ifname);
3718 bzero (rq.ifr_name, sizeof rq.ifr_name);
3719 strncpy (rq.ifr_name, SDATA (ifname), sizeof (rq.ifr_name));
3721 s = socket (AF_INET, SOCK_STREAM, 0);
3722 if (s < 0)
3723 return Qnil;
3725 elt = Qnil;
3726 #if defined(SIOCGIFFLAGS) && defined(HAVE_STRUCT_IFREQ_IFR_FLAGS)
3727 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3729 int flags = rq.ifr_flags;
3730 struct ifflag_def *fp;
3731 int fnum;
3733 any++;
3734 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3736 if (flags & fp->flag_bit)
3738 elt = Fcons (intern (fp->flag_sym), elt);
3739 flags -= fp->flag_bit;
3742 for (fnum = 0; flags && fnum < 32; fnum++)
3744 if (flags & (1 << fnum))
3746 elt = Fcons (make_number (fnum), elt);
3750 #endif
3751 res = Fcons (elt, res);
3753 elt = Qnil;
3754 #if defined(SIOCGIFHWADDR) && defined(HAVE_STRUCT_IFREQ_IFR_HWADDR)
3755 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3757 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3758 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3759 int n;
3761 any++;
3762 for (n = 0; n < 6; n++)
3763 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3764 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3766 #endif
3767 res = Fcons (elt, res);
3769 elt = Qnil;
3770 #if defined(SIOCGIFNETMASK) && (defined(HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined(HAVE_STRUCT_IFREQ_IFR_ADDR))
3771 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3773 any++;
3774 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3775 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3776 #else
3777 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3778 #endif
3780 #endif
3781 res = Fcons (elt, res);
3783 elt = Qnil;
3784 #if defined(SIOCGIFBRDADDR) && defined(HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3785 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3787 any++;
3788 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3790 #endif
3791 res = Fcons (elt, res);
3793 elt = Qnil;
3794 #if defined(SIOCGIFADDR) && defined(HAVE_STRUCT_IFREQ_IFR_ADDR)
3795 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3797 any++;
3798 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3800 #endif
3801 res = Fcons (elt, res);
3803 close (s);
3805 return any ? res : Qnil;
3807 #endif
3808 #endif /* HAVE_SOCKETS */
3810 /* Turn off input and output for process PROC. */
3812 void
3813 deactivate_process (proc)
3814 Lisp_Object proc;
3816 register int inchannel, outchannel;
3817 register struct Lisp_Process *p = XPROCESS (proc);
3819 inchannel = p->infd;
3820 outchannel = p->outfd;
3822 #ifdef ADAPTIVE_READ_BUFFERING
3823 if (p->read_output_delay > 0)
3825 if (--process_output_delay_count < 0)
3826 process_output_delay_count = 0;
3827 p->read_output_delay = 0;
3828 p->read_output_skip = 0;
3830 #endif
3832 if (inchannel >= 0)
3834 /* Beware SIGCHLD hereabouts. */
3835 flush_pending_output (inchannel);
3836 #ifdef VMS
3838 VMS_PROC_STUFF *get_vms_process_pointer (), *vs;
3839 sys$dassgn (outchannel);
3840 vs = get_vms_process_pointer (p->pid);
3841 if (vs)
3842 give_back_vms_process_stuff (vs);
3844 #else
3845 emacs_close (inchannel);
3846 if (outchannel >= 0 && outchannel != inchannel)
3847 emacs_close (outchannel);
3848 #endif
3850 p->infd = -1;
3851 p->outfd = -1;
3852 #ifdef DATAGRAM_SOCKETS
3853 if (DATAGRAM_CHAN_P (inchannel))
3855 xfree (datagram_address[inchannel].sa);
3856 datagram_address[inchannel].sa = 0;
3857 datagram_address[inchannel].len = 0;
3859 #endif
3860 chan_process[inchannel] = Qnil;
3861 FD_CLR (inchannel, &input_wait_mask);
3862 FD_CLR (inchannel, &non_keyboard_wait_mask);
3863 #ifdef NON_BLOCKING_CONNECT
3864 if (FD_ISSET (inchannel, &connect_wait_mask))
3866 FD_CLR (inchannel, &connect_wait_mask);
3867 if (--num_pending_connects < 0)
3868 abort ();
3870 #endif
3871 if (inchannel == max_process_desc)
3873 int i;
3874 /* We just closed the highest-numbered process input descriptor,
3875 so recompute the highest-numbered one now. */
3876 max_process_desc = 0;
3877 for (i = 0; i < MAXDESC; i++)
3878 if (!NILP (chan_process[i]))
3879 max_process_desc = i;
3884 /* Close all descriptors currently in use for communication
3885 with subprocess. This is used in a newly-forked subprocess
3886 to get rid of irrelevant descriptors. */
3888 void
3889 close_process_descs ()
3891 #ifndef WINDOWSNT
3892 int i;
3893 for (i = 0; i < MAXDESC; i++)
3895 Lisp_Object process;
3896 process = chan_process[i];
3897 if (!NILP (process))
3899 int in = XPROCESS (process)->infd;
3900 int out = XPROCESS (process)->outfd;
3901 if (in >= 0)
3902 emacs_close (in);
3903 if (out >= 0 && in != out)
3904 emacs_close (out);
3907 #endif
3910 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3911 0, 4, 0,
3912 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3913 It is read into the process' buffers or given to their filter functions.
3914 Non-nil arg PROCESS means do not return until some output has been received
3915 from PROCESS.
3917 Non-nil second arg SECONDS and third arg MILLISEC are number of
3918 seconds and milliseconds to wait; return after that much time whether
3919 or not there is input. If SECONDS is a floating point number,
3920 it specifies a fractional number of seconds to wait.
3922 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3923 from PROCESS, suspending reading output from other processes.
3924 If JUST-THIS-ONE is an integer, don't run any timers either.
3925 Return non-nil if we received any output before the timeout expired. */)
3926 (process, seconds, millisec, just_this_one)
3927 register Lisp_Object process, seconds, millisec, just_this_one;
3929 int secs, usecs = 0;
3931 if (! NILP (process))
3932 CHECK_PROCESS (process);
3933 else
3934 just_this_one = Qnil;
3936 if (!NILP (seconds))
3938 if (INTEGERP (seconds))
3939 secs = XINT (seconds);
3940 else if (FLOATP (seconds))
3942 double timeout = XFLOAT_DATA (seconds);
3943 secs = (int) timeout;
3944 usecs = (int) ((timeout - (double) secs) * 1000000);
3946 else
3947 wrong_type_argument (Qnumberp, seconds);
3949 if (INTEGERP (millisec))
3951 int carry;
3952 usecs += XINT (millisec) * 1000;
3953 carry = usecs / 1000000;
3954 secs += carry;
3955 if ((usecs -= carry * 1000000) < 0)
3957 secs--;
3958 usecs += 1000000;
3962 if (secs < 0 || (secs == 0 && usecs == 0))
3963 secs = -1, usecs = 0;
3965 else
3966 secs = NILP (process) ? -1 : 0;
3968 return
3969 (wait_reading_process_output (secs, usecs, 0, 0,
3970 Qnil,
3971 !NILP (process) ? XPROCESS (process) : NULL,
3972 NILP (just_this_one) ? 0 :
3973 !INTEGERP (just_this_one) ? 1 : -1)
3974 ? Qt : Qnil);
3977 /* Accept a connection for server process SERVER on CHANNEL. */
3979 static int connect_counter = 0;
3981 static void
3982 server_accept_connection (server, channel)
3983 Lisp_Object server;
3984 int channel;
3986 Lisp_Object proc, caller, name, buffer;
3987 Lisp_Object contact, host, service;
3988 struct Lisp_Process *ps= XPROCESS (server);
3989 struct Lisp_Process *p;
3990 int s;
3991 union u_sockaddr {
3992 struct sockaddr sa;
3993 struct sockaddr_in in;
3994 #ifdef AF_INET6
3995 struct sockaddr_in6 in6;
3996 #endif
3997 #ifdef HAVE_LOCAL_SOCKETS
3998 struct sockaddr_un un;
3999 #endif
4000 } saddr;
4001 int len = sizeof saddr;
4003 s = accept (channel, &saddr.sa, &len);
4005 if (s < 0)
4007 int code = errno;
4009 if (code == EAGAIN)
4010 return;
4011 #ifdef EWOULDBLOCK
4012 if (code == EWOULDBLOCK)
4013 return;
4014 #endif
4016 if (!NILP (ps->log))
4017 call3 (ps->log, server, Qnil,
4018 concat3 (build_string ("accept failed with code"),
4019 Fnumber_to_string (make_number (code)),
4020 build_string ("\n")));
4021 return;
4024 connect_counter++;
4026 /* Setup a new process to handle the connection. */
4028 /* Generate a unique identification of the caller, and build contact
4029 information for this process. */
4030 host = Qt;
4031 service = Qnil;
4032 switch (saddr.sa.sa_family)
4034 case AF_INET:
4036 Lisp_Object args[5];
4037 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4038 args[0] = build_string ("%d.%d.%d.%d");
4039 args[1] = make_number (*ip++);
4040 args[2] = make_number (*ip++);
4041 args[3] = make_number (*ip++);
4042 args[4] = make_number (*ip++);
4043 host = Fformat (5, args);
4044 service = make_number (ntohs (saddr.in.sin_port));
4046 args[0] = build_string (" <%s:%d>");
4047 args[1] = host;
4048 args[2] = service;
4049 caller = Fformat (3, args);
4051 break;
4053 #ifdef AF_INET6
4054 case AF_INET6:
4056 Lisp_Object args[9];
4057 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4058 int i;
4059 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4060 for (i = 0; i < 8; i++)
4061 args[i+1] = make_number (ntohs(ip6[i]));
4062 host = Fformat (9, args);
4063 service = make_number (ntohs (saddr.in.sin_port));
4065 args[0] = build_string (" <[%s]:%d>");
4066 args[1] = host;
4067 args[2] = service;
4068 caller = Fformat (3, args);
4070 break;
4071 #endif
4073 #ifdef HAVE_LOCAL_SOCKETS
4074 case AF_LOCAL:
4075 #endif
4076 default:
4077 caller = Fnumber_to_string (make_number (connect_counter));
4078 caller = concat3 (build_string (" <*"), caller, build_string ("*>"));
4079 break;
4082 /* Create a new buffer name for this process if it doesn't have a
4083 filter. The new buffer name is based on the buffer name or
4084 process name of the server process concatenated with the caller
4085 identification. */
4087 if (!NILP (ps->filter) && !EQ (ps->filter, Qt))
4088 buffer = Qnil;
4089 else
4091 buffer = ps->buffer;
4092 if (!NILP (buffer))
4093 buffer = Fbuffer_name (buffer);
4094 else
4095 buffer = ps->name;
4096 if (!NILP (buffer))
4098 buffer = concat2 (buffer, caller);
4099 buffer = Fget_buffer_create (buffer);
4103 /* Generate a unique name for the new server process. Combine the
4104 server process name with the caller identification. */
4106 name = concat2 (ps->name, caller);
4107 proc = make_process (name);
4109 chan_process[s] = proc;
4111 #ifdef O_NONBLOCK
4112 fcntl (s, F_SETFL, O_NONBLOCK);
4113 #else
4114 #ifdef O_NDELAY
4115 fcntl (s, F_SETFL, O_NDELAY);
4116 #endif
4117 #endif
4119 p = XPROCESS (proc);
4121 /* Build new contact information for this setup. */
4122 contact = Fcopy_sequence (ps->childp);
4123 contact = Fplist_put (contact, QCserver, Qnil);
4124 contact = Fplist_put (contact, QChost, host);
4125 if (!NILP (service))
4126 contact = Fplist_put (contact, QCservice, service);
4127 contact = Fplist_put (contact, QCremote,
4128 conv_sockaddr_to_lisp (&saddr.sa, len));
4129 #ifdef HAVE_GETSOCKNAME
4130 len = sizeof saddr;
4131 if (getsockname (s, &saddr.sa, &len) == 0)
4132 contact = Fplist_put (contact, QClocal,
4133 conv_sockaddr_to_lisp (&saddr.sa, len));
4134 #endif
4136 p->childp = contact;
4137 p->plist = Fcopy_sequence (ps->plist);
4139 p->buffer = buffer;
4140 p->sentinel = ps->sentinel;
4141 p->filter = ps->filter;
4142 p->command = Qnil;
4143 p->pid = 0;
4144 p->infd = s;
4145 p->outfd = s;
4146 p->status = Qrun;
4148 /* Client processes for accepted connections are not stopped initially. */
4149 if (!EQ (p->filter, Qt))
4151 FD_SET (s, &input_wait_mask);
4152 FD_SET (s, &non_keyboard_wait_mask);
4155 if (s > max_process_desc)
4156 max_process_desc = s;
4158 /* Setup coding system for new process based on server process.
4159 This seems to be the proper thing to do, as the coding system
4160 of the new process should reflect the settings at the time the
4161 server socket was opened; not the current settings. */
4163 p->decode_coding_system = ps->decode_coding_system;
4164 p->encode_coding_system = ps->encode_coding_system;
4165 setup_process_coding_systems (proc);
4167 p->decoding_buf = make_uninit_string (0);
4168 p->decoding_carryover = 0;
4169 p->encoding_buf = make_uninit_string (0);
4171 p->inherit_coding_system_flag
4172 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4174 if (!NILP (ps->log))
4175 call3 (ps->log, server, proc,
4176 concat3 (build_string ("accept from "),
4177 (STRINGP (host) ? host : build_string ("-")),
4178 build_string ("\n")));
4180 if (!NILP (p->sentinel))
4181 exec_sentinel (proc,
4182 concat3 (build_string ("open from "),
4183 (STRINGP (host) ? host : build_string ("-")),
4184 build_string ("\n")));
4187 /* This variable is different from waiting_for_input in keyboard.c.
4188 It is used to communicate to a lisp process-filter/sentinel (via the
4189 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4190 for user-input when that process-filter was called.
4191 waiting_for_input cannot be used as that is by definition 0 when
4192 lisp code is being evalled.
4193 This is also used in record_asynch_buffer_change.
4194 For that purpose, this must be 0
4195 when not inside wait_reading_process_output. */
4196 static int waiting_for_user_input_p;
4198 static Lisp_Object
4199 wait_reading_process_output_unwind (data)
4200 Lisp_Object data;
4202 waiting_for_user_input_p = XINT (data);
4203 return Qnil;
4206 /* This is here so breakpoints can be put on it. */
4207 static void
4208 wait_reading_process_output_1 ()
4212 /* Use a wrapper around select to work around a bug in gdb 5.3.
4213 Normally, the wrapper is optimzed away by inlining.
4215 If emacs is stopped inside select, the gdb backtrace doesn't
4216 show the function which called select, so it is practically
4217 impossible to step through wait_reading_process_output. */
4219 #ifndef select
4220 static INLINE int
4221 select_wrapper (n, rfd, wfd, xfd, tmo)
4222 int n;
4223 SELECT_TYPE *rfd, *wfd, *xfd;
4224 EMACS_TIME *tmo;
4226 return select (n, rfd, wfd, xfd, tmo);
4228 #define select select_wrapper
4229 #endif
4231 /* Read and dispose of subprocess output while waiting for timeout to
4232 elapse and/or keyboard input to be available.
4234 TIME_LIMIT is:
4235 timeout in seconds, or
4236 zero for no limit, or
4237 -1 means gobble data immediately available but don't wait for any.
4239 MICROSECS is:
4240 an additional duration to wait, measured in microseconds.
4241 If this is nonzero and time_limit is 0, then the timeout
4242 consists of MICROSECS only.
4244 READ_KBD is a lisp value:
4245 0 to ignore keyboard input, or
4246 1 to return when input is available, or
4247 -1 meaning caller will actually read the input, so don't throw to
4248 the quit handler, or
4250 DO_DISPLAY != 0 means redisplay should be done to show subprocess
4251 output that arrives.
4253 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4254 (and gobble terminal input into the buffer if any arrives).
4256 If WAIT_PROC is specified, wait until something arrives from that
4257 process. The return value is true if we read some input from
4258 that process.
4260 If JUST_WAIT_PROC is non-nil, handle only output from WAIT_PROC
4261 (suspending output from other processes). A negative value
4262 means don't run any timers either.
4264 If WAIT_PROC is specified, then the function returns true if we
4265 received input from that process before the timeout elapsed.
4266 Otherwise, return true if we received input from any process. */
4269 wait_reading_process_output (time_limit, microsecs, read_kbd, do_display,
4270 wait_for_cell, wait_proc, just_wait_proc)
4271 int time_limit, microsecs, read_kbd, do_display;
4272 Lisp_Object wait_for_cell;
4273 struct Lisp_Process *wait_proc;
4274 int just_wait_proc;
4276 register int channel, nfds;
4277 SELECT_TYPE Available;
4278 #ifdef NON_BLOCKING_CONNECT
4279 SELECT_TYPE Connecting;
4280 int check_connect;
4281 #endif
4282 int check_delay, no_avail;
4283 int xerrno;
4284 Lisp_Object proc;
4285 EMACS_TIME timeout, end_time;
4286 int wait_channel = -1;
4287 int got_some_input = 0;
4288 int count = SPECPDL_INDEX ();
4290 FD_ZERO (&Available);
4291 #ifdef NON_BLOCKING_CONNECT
4292 FD_ZERO (&Connecting);
4293 #endif
4295 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4296 if (wait_proc != NULL)
4297 wait_channel = wait_proc->infd;
4299 record_unwind_protect (wait_reading_process_output_unwind,
4300 make_number (waiting_for_user_input_p));
4301 waiting_for_user_input_p = read_kbd;
4303 /* Since we may need to wait several times,
4304 compute the absolute time to return at. */
4305 if (time_limit || microsecs)
4307 EMACS_GET_TIME (end_time);
4308 EMACS_SET_SECS_USECS (timeout, time_limit, microsecs);
4309 EMACS_ADD_TIME (end_time, end_time, timeout);
4311 #ifdef POLL_INTERRUPTED_SYS_CALL
4312 /* AlainF 5-Jul-1996
4313 HP-UX 10.10 seem to have problems with signals coming in
4314 Causes "poll: interrupted system call" messages when Emacs is run
4315 in an X window
4316 Turn off periodic alarms (in case they are in use),
4317 and then turn off any other atimers. */
4318 stop_polling ();
4319 turn_on_atimers (0);
4320 #endif /* POLL_INTERRUPTED_SYS_CALL */
4322 while (1)
4324 int timeout_reduced_for_timers = 0;
4326 /* If calling from keyboard input, do not quit
4327 since we want to return C-g as an input character.
4328 Otherwise, do pending quit if requested. */
4329 if (read_kbd >= 0)
4330 QUIT;
4331 #ifdef SYNC_INPUT
4332 else if (interrupt_input_pending)
4333 handle_async_input ();
4334 #endif
4336 /* Exit now if the cell we're waiting for became non-nil. */
4337 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4338 break;
4340 /* Compute time from now till when time limit is up */
4341 /* Exit if already run out */
4342 if (time_limit == -1)
4344 /* -1 specified for timeout means
4345 gobble output available now
4346 but don't wait at all. */
4348 EMACS_SET_SECS_USECS (timeout, 0, 0);
4350 else if (time_limit || microsecs)
4352 EMACS_GET_TIME (timeout);
4353 EMACS_SUB_TIME (timeout, end_time, timeout);
4354 if (EMACS_TIME_NEG_P (timeout))
4355 break;
4357 else
4359 EMACS_SET_SECS_USECS (timeout, 100000, 0);
4362 /* Normally we run timers here.
4363 But not if wait_for_cell; in those cases,
4364 the wait is supposed to be short,
4365 and those callers cannot handle running arbitrary Lisp code here. */
4366 if (NILP (wait_for_cell)
4367 && just_wait_proc >= 0)
4369 EMACS_TIME timer_delay;
4373 int old_timers_run = timers_run;
4374 struct buffer *old_buffer = current_buffer;
4376 timer_delay = timer_check (1);
4378 /* If a timer has run, this might have changed buffers
4379 an alike. Make read_key_sequence aware of that. */
4380 if (timers_run != old_timers_run
4381 && old_buffer != current_buffer
4382 && waiting_for_user_input_p == -1)
4383 record_asynch_buffer_change ();
4385 if (timers_run != old_timers_run && do_display)
4386 /* We must retry, since a timer may have requeued itself
4387 and that could alter the time_delay. */
4388 redisplay_preserve_echo_area (9);
4389 else
4390 break;
4392 while (!detect_input_pending ());
4394 /* If there is unread keyboard input, also return. */
4395 if (read_kbd != 0
4396 && requeued_events_pending_p ())
4397 break;
4399 if (! EMACS_TIME_NEG_P (timer_delay) && time_limit != -1)
4401 EMACS_TIME difference;
4402 EMACS_SUB_TIME (difference, timer_delay, timeout);
4403 if (EMACS_TIME_NEG_P (difference))
4405 timeout = timer_delay;
4406 timeout_reduced_for_timers = 1;
4409 /* If time_limit is -1, we are not going to wait at all. */
4410 else if (time_limit != -1)
4412 /* This is so a breakpoint can be put here. */
4413 wait_reading_process_output_1 ();
4417 /* Cause C-g and alarm signals to take immediate action,
4418 and cause input available signals to zero out timeout.
4420 It is important that we do this before checking for process
4421 activity. If we get a SIGCHLD after the explicit checks for
4422 process activity, timeout is the only way we will know. */
4423 if (read_kbd < 0)
4424 set_waiting_for_input (&timeout);
4426 /* If status of something has changed, and no input is
4427 available, notify the user of the change right away. After
4428 this explicit check, we'll let the SIGCHLD handler zap
4429 timeout to get our attention. */
4430 if (update_tick != process_tick && do_display)
4432 SELECT_TYPE Atemp;
4433 #ifdef NON_BLOCKING_CONNECT
4434 SELECT_TYPE Ctemp;
4435 #endif
4437 Atemp = input_wait_mask;
4438 #if 0
4439 /* On Mac OS X 10.0, the SELECT system call always says input is
4440 present (for reading) at stdin, even when none is. This
4441 causes the call to SELECT below to return 1 and
4442 status_notify not to be called. As a result output of
4443 subprocesses are incorrectly discarded.
4445 FD_CLR (0, &Atemp);
4446 #endif
4447 IF_NON_BLOCKING_CONNECT (Ctemp = connect_wait_mask);
4449 EMACS_SET_SECS_USECS (timeout, 0, 0);
4450 if ((select (max (max (max_process_desc, max_keyboard_desc),
4451 max_gpm_desc) + 1,
4452 &Atemp,
4453 #ifdef NON_BLOCKING_CONNECT
4454 (num_pending_connects > 0 ? &Ctemp : (SELECT_TYPE *)0),
4455 #else
4456 (SELECT_TYPE *)0,
4457 #endif
4458 (SELECT_TYPE *)0, &timeout)
4459 <= 0))
4461 /* It's okay for us to do this and then continue with
4462 the loop, since timeout has already been zeroed out. */
4463 clear_waiting_for_input ();
4464 status_notify (NULL);
4468 /* Don't wait for output from a non-running process. Just
4469 read whatever data has already been received. */
4470 if (wait_proc && wait_proc->raw_status_new)
4471 update_status (wait_proc);
4472 if (wait_proc
4473 && ! EQ (wait_proc->status, Qrun)
4474 && ! EQ (wait_proc->status, Qconnect))
4476 int nread, total_nread = 0;
4478 clear_waiting_for_input ();
4479 XSETPROCESS (proc, wait_proc);
4481 /* Read data from the process, until we exhaust it. */
4482 while (wait_proc->infd >= 0)
4484 nread = read_process_output (proc, wait_proc->infd);
4486 if (nread == 0)
4487 break;
4489 if (0 < nread)
4490 total_nread += nread;
4491 #ifdef EIO
4492 else if (nread == -1 && EIO == errno)
4493 break;
4494 #endif
4495 #ifdef EAGAIN
4496 else if (nread == -1 && EAGAIN == errno)
4497 break;
4498 #endif
4499 #ifdef EWOULDBLOCK
4500 else if (nread == -1 && EWOULDBLOCK == errno)
4501 break;
4502 #endif
4504 if (total_nread > 0 && do_display)
4505 redisplay_preserve_echo_area (10);
4507 break;
4510 /* Wait till there is something to do */
4512 if (wait_proc && just_wait_proc)
4514 if (wait_proc->infd < 0) /* Terminated */
4515 break;
4516 FD_SET (wait_proc->infd, &Available);
4517 check_delay = 0;
4518 IF_NON_BLOCKING_CONNECT (check_connect = 0);
4520 else if (!NILP (wait_for_cell))
4522 Available = non_process_wait_mask;
4523 check_delay = 0;
4524 IF_NON_BLOCKING_CONNECT (check_connect = 0);
4526 else
4528 if (! read_kbd)
4529 Available = non_keyboard_wait_mask;
4530 else
4531 Available = input_wait_mask;
4532 IF_NON_BLOCKING_CONNECT (check_connect = (num_pending_connects > 0));
4533 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4536 /* If frame size has changed or the window is newly mapped,
4537 redisplay now, before we start to wait. There is a race
4538 condition here; if a SIGIO arrives between now and the select
4539 and indicates that a frame is trashed, the select may block
4540 displaying a trashed screen. */
4541 if (frame_garbaged && do_display)
4543 clear_waiting_for_input ();
4544 redisplay_preserve_echo_area (11);
4545 if (read_kbd < 0)
4546 set_waiting_for_input (&timeout);
4549 no_avail = 0;
4550 if (read_kbd && detect_input_pending ())
4552 nfds = 0;
4553 no_avail = 1;
4555 else
4557 #ifdef NON_BLOCKING_CONNECT
4558 if (check_connect)
4559 Connecting = connect_wait_mask;
4560 #endif
4562 #ifdef ADAPTIVE_READ_BUFFERING
4563 /* Set the timeout for adaptive read buffering if any
4564 process has non-zero read_output_skip and non-zero
4565 read_output_delay, and we are not reading output for a
4566 specific wait_channel. It is not executed if
4567 Vprocess_adaptive_read_buffering is nil. */
4568 if (process_output_skip && check_delay > 0)
4570 int usecs = EMACS_USECS (timeout);
4571 if (EMACS_SECS (timeout) > 0 || usecs > READ_OUTPUT_DELAY_MAX)
4572 usecs = READ_OUTPUT_DELAY_MAX;
4573 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4575 proc = chan_process[channel];
4576 if (NILP (proc))
4577 continue;
4578 /* Find minimum non-zero read_output_delay among the
4579 processes with non-zero read_output_skip. */
4580 if (XPROCESS (proc)->read_output_delay > 0)
4582 check_delay--;
4583 if (!XPROCESS (proc)->read_output_skip)
4584 continue;
4585 FD_CLR (channel, &Available);
4586 XPROCESS (proc)->read_output_skip = 0;
4587 if (XPROCESS (proc)->read_output_delay < usecs)
4588 usecs = XPROCESS (proc)->read_output_delay;
4591 EMACS_SET_SECS_USECS (timeout, 0, usecs);
4592 process_output_skip = 0;
4594 #endif
4596 nfds = select (max (max (max_process_desc, max_keyboard_desc),
4597 max_gpm_desc) + 1,
4598 &Available,
4599 #ifdef NON_BLOCKING_CONNECT
4600 (check_connect ? &Connecting : (SELECT_TYPE *)0),
4601 #else
4602 (SELECT_TYPE *)0,
4603 #endif
4604 (SELECT_TYPE *)0, &timeout);
4607 xerrno = errno;
4609 /* Make C-g and alarm signals set flags again */
4610 clear_waiting_for_input ();
4612 /* If we woke up due to SIGWINCH, actually change size now. */
4613 do_pending_window_change (0);
4615 if (time_limit && nfds == 0 && ! timeout_reduced_for_timers)
4616 /* We wanted the full specified time, so return now. */
4617 break;
4618 if (nfds < 0)
4620 if (xerrno == EINTR)
4621 no_avail = 1;
4622 #ifdef ultrix
4623 /* Ultrix select seems to return ENOMEM when it is
4624 interrupted. Treat it just like EINTR. Bleah. Note
4625 that we want to test for the "ultrix" CPP symbol, not
4626 "__ultrix__"; the latter is only defined under GCC, but
4627 not by DEC's bundled CC. -JimB */
4628 else if (xerrno == ENOMEM)
4629 no_avail = 1;
4630 #endif
4631 #ifdef ALLIANT
4632 /* This happens for no known reason on ALLIANT.
4633 I am guessing that this is the right response. -- RMS. */
4634 else if (xerrno == EFAULT)
4635 no_avail = 1;
4636 #endif
4637 else if (xerrno == EBADF)
4639 #ifdef AIX
4640 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
4641 the child's closure of the pts gives the parent a SIGHUP, and
4642 the ptc file descriptor is automatically closed,
4643 yielding EBADF here or at select() call above.
4644 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
4645 in m/ibmrt-aix.h), and here we just ignore the select error.
4646 Cleanup occurs c/o status_notify after SIGCLD. */
4647 no_avail = 1; /* Cannot depend on values returned */
4648 #else
4649 abort ();
4650 #endif
4652 else
4653 error ("select error: %s", emacs_strerror (xerrno));
4656 if (no_avail)
4658 FD_ZERO (&Available);
4659 IF_NON_BLOCKING_CONNECT (check_connect = 0);
4662 #if defined(sun) && !defined(USG5_4)
4663 if (nfds > 0 && keyboard_bit_set (&Available)
4664 && interrupt_input)
4665 /* System sometimes fails to deliver SIGIO.
4667 David J. Mackenzie says that Emacs doesn't compile under
4668 Solaris if this code is enabled, thus the USG5_4 in the CPP
4669 conditional. "I haven't noticed any ill effects so far.
4670 If you find a Solaris expert somewhere, they might know
4671 better." */
4672 kill (getpid (), SIGIO);
4673 #endif
4675 #if 0 /* When polling is used, interrupt_input is 0,
4676 so get_input_pending should read the input.
4677 So this should not be needed. */
4678 /* If we are using polling for input,
4679 and we see input available, make it get read now.
4680 Otherwise it might not actually get read for a second.
4681 And on hpux, since we turn off polling in wait_reading_process_output,
4682 it might never get read at all if we don't spend much time
4683 outside of wait_reading_process_output. */
4684 if (read_kbd && interrupt_input
4685 && keyboard_bit_set (&Available)
4686 && input_polling_used ())
4687 kill (getpid (), SIGALRM);
4688 #endif
4690 /* Check for keyboard input */
4691 /* If there is any, return immediately
4692 to give it higher priority than subprocesses */
4694 if (read_kbd != 0)
4696 int old_timers_run = timers_run;
4697 struct buffer *old_buffer = current_buffer;
4698 int leave = 0;
4700 if (detect_input_pending_run_timers (do_display))
4702 swallow_events (do_display);
4703 if (detect_input_pending_run_timers (do_display))
4704 leave = 1;
4707 /* If a timer has run, this might have changed buffers
4708 an alike. Make read_key_sequence aware of that. */
4709 if (timers_run != old_timers_run
4710 && waiting_for_user_input_p == -1
4711 && old_buffer != current_buffer)
4712 record_asynch_buffer_change ();
4714 if (leave)
4715 break;
4718 /* If there is unread keyboard input, also return. */
4719 if (read_kbd != 0
4720 && requeued_events_pending_p ())
4721 break;
4723 /* If we are not checking for keyboard input now,
4724 do process events (but don't run any timers).
4725 This is so that X events will be processed.
4726 Otherwise they may have to wait until polling takes place.
4727 That would causes delays in pasting selections, for example.
4729 (We used to do this only if wait_for_cell.) */
4730 if (read_kbd == 0 && detect_input_pending ())
4732 swallow_events (do_display);
4733 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4734 if (detect_input_pending ())
4735 break;
4736 #endif
4739 /* Exit now if the cell we're waiting for became non-nil. */
4740 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4741 break;
4743 #ifdef SIGIO
4744 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4745 go read it. This can happen with X on BSD after logging out.
4746 In that case, there really is no input and no SIGIO,
4747 but select says there is input. */
4749 if (read_kbd && interrupt_input
4750 && keyboard_bit_set (&Available) && ! noninteractive)
4751 kill (getpid (), SIGIO);
4752 #endif
4754 if (! wait_proc)
4755 got_some_input |= nfds > 0;
4757 /* If checking input just got us a size-change event from X,
4758 obey it now if we should. */
4759 if (read_kbd || ! NILP (wait_for_cell))
4760 do_pending_window_change (0);
4762 /* Check for data from a process. */
4763 if (no_avail || nfds == 0)
4764 continue;
4766 /* Really FIRST_PROC_DESC should be 0 on Unix,
4767 but this is safer in the short run. */
4768 for (channel = 0; channel <= max_process_desc; channel++)
4770 if (FD_ISSET (channel, &Available)
4771 && FD_ISSET (channel, &non_keyboard_wait_mask))
4773 int nread;
4775 /* If waiting for this channel, arrange to return as
4776 soon as no more input to be processed. No more
4777 waiting. */
4778 if (wait_channel == channel)
4780 wait_channel = -1;
4781 time_limit = -1;
4782 got_some_input = 1;
4784 proc = chan_process[channel];
4785 if (NILP (proc))
4786 continue;
4788 /* If this is a server stream socket, accept connection. */
4789 if (EQ (XPROCESS (proc)->status, Qlisten))
4791 server_accept_connection (proc, channel);
4792 continue;
4795 /* Read data from the process, starting with our
4796 buffered-ahead character if we have one. */
4798 nread = read_process_output (proc, channel);
4799 if (nread > 0)
4801 /* Since read_process_output can run a filter,
4802 which can call accept-process-output,
4803 don't try to read from any other processes
4804 before doing the select again. */
4805 FD_ZERO (&Available);
4807 if (do_display)
4808 redisplay_preserve_echo_area (12);
4810 #ifdef EWOULDBLOCK
4811 else if (nread == -1 && errno == EWOULDBLOCK)
4813 #endif
4814 /* ISC 4.1 defines both EWOULDBLOCK and O_NONBLOCK,
4815 and Emacs uses O_NONBLOCK, so what we get is EAGAIN. */
4816 #ifdef O_NONBLOCK
4817 else if (nread == -1 && errno == EAGAIN)
4819 #else
4820 #ifdef O_NDELAY
4821 else if (nread == -1 && errno == EAGAIN)
4823 /* Note that we cannot distinguish between no input
4824 available now and a closed pipe.
4825 With luck, a closed pipe will be accompanied by
4826 subprocess termination and SIGCHLD. */
4827 else if (nread == 0 && !NETCONN_P (proc))
4829 #endif /* O_NDELAY */
4830 #endif /* O_NONBLOCK */
4831 #ifdef HAVE_PTYS
4832 /* On some OSs with ptys, when the process on one end of
4833 a pty exits, the other end gets an error reading with
4834 errno = EIO instead of getting an EOF (0 bytes read).
4835 Therefore, if we get an error reading and errno =
4836 EIO, just continue, because the child process has
4837 exited and should clean itself up soon (e.g. when we
4838 get a SIGCHLD).
4840 However, it has been known to happen that the SIGCHLD
4841 got lost. So raise the signal again just in case.
4842 It can't hurt. */
4843 else if (nread == -1 && errno == EIO)
4845 /* Clear the descriptor now, so we only raise the signal once. */
4846 FD_CLR (channel, &input_wait_mask);
4847 FD_CLR (channel, &non_keyboard_wait_mask);
4849 kill (getpid (), SIGCHLD);
4851 #endif /* HAVE_PTYS */
4852 /* If we can detect process termination, don't consider the process
4853 gone just because its pipe is closed. */
4854 #ifdef SIGCHLD
4855 else if (nread == 0 && !NETCONN_P (proc))
4857 #endif
4858 else
4860 /* Preserve status of processes already terminated. */
4861 XPROCESS (proc)->tick = ++process_tick;
4862 deactivate_process (proc);
4863 if (XPROCESS (proc)->raw_status_new)
4864 update_status (XPROCESS (proc));
4865 if (EQ (XPROCESS (proc)->status, Qrun))
4866 XPROCESS (proc)->status
4867 = Fcons (Qexit, Fcons (make_number (256), Qnil));
4870 #ifdef NON_BLOCKING_CONNECT
4871 if (check_connect && FD_ISSET (channel, &Connecting)
4872 && FD_ISSET (channel, &connect_wait_mask))
4874 struct Lisp_Process *p;
4876 FD_CLR (channel, &connect_wait_mask);
4877 if (--num_pending_connects < 0)
4878 abort ();
4880 proc = chan_process[channel];
4881 if (NILP (proc))
4882 continue;
4884 p = XPROCESS (proc);
4886 #ifdef GNU_LINUX
4887 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4888 So only use it on systems where it is known to work. */
4890 int xlen = sizeof(xerrno);
4891 if (getsockopt(channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4892 xerrno = errno;
4894 #else
4896 struct sockaddr pname;
4897 int pnamelen = sizeof(pname);
4899 /* If connection failed, getpeername will fail. */
4900 xerrno = 0;
4901 if (getpeername(channel, &pname, &pnamelen) < 0)
4903 /* Obtain connect failure code through error slippage. */
4904 char dummy;
4905 xerrno = errno;
4906 if (errno == ENOTCONN && read(channel, &dummy, 1) < 0)
4907 xerrno = errno;
4910 #endif
4911 if (xerrno)
4913 p->tick = ++process_tick;
4914 p->status = Fcons (Qfailed, Fcons (make_number (xerrno), Qnil));
4915 deactivate_process (proc);
4917 else
4919 p->status = Qrun;
4920 /* Execute the sentinel here. If we had relied on
4921 status_notify to do it later, it will read input
4922 from the process before calling the sentinel. */
4923 exec_sentinel (proc, build_string ("open\n"));
4924 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
4926 FD_SET (p->infd, &input_wait_mask);
4927 FD_SET (p->infd, &non_keyboard_wait_mask);
4931 #endif /* NON_BLOCKING_CONNECT */
4932 } /* end for each file descriptor */
4933 } /* end while exit conditions not met */
4935 unbind_to (count, Qnil);
4937 /* If calling from keyboard input, do not quit
4938 since we want to return C-g as an input character.
4939 Otherwise, do pending quit if requested. */
4940 if (read_kbd >= 0)
4942 /* Prevent input_pending from remaining set if we quit. */
4943 clear_input_pending ();
4944 QUIT;
4946 #ifdef POLL_INTERRUPTED_SYS_CALL
4947 /* AlainF 5-Jul-1996
4948 HP-UX 10.10 seems to have problems with signals coming in
4949 Causes "poll: interrupted system call" messages when Emacs is run
4950 in an X window
4951 Turn periodic alarms back on */
4952 start_polling ();
4953 #endif /* POLL_INTERRUPTED_SYS_CALL */
4955 return got_some_input;
4958 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
4960 static Lisp_Object
4961 read_process_output_call (fun_and_args)
4962 Lisp_Object fun_and_args;
4964 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
4967 static Lisp_Object
4968 read_process_output_error_handler (error)
4969 Lisp_Object error;
4971 cmd_error_internal (error, "error in process filter: ");
4972 Vinhibit_quit = Qt;
4973 update_echo_area ();
4974 Fsleep_for (make_number (2), Qnil);
4975 return Qt;
4978 /* Read pending output from the process channel,
4979 starting with our buffered-ahead character if we have one.
4980 Yield number of decoded characters read.
4982 This function reads at most 4096 characters.
4983 If you want to read all available subprocess output,
4984 you must call it repeatedly until it returns zero.
4986 The characters read are decoded according to PROC's coding-system
4987 for decoding. */
4989 static int
4990 read_process_output (proc, channel)
4991 Lisp_Object proc;
4992 register int channel;
4994 register int nbytes;
4995 char *chars;
4996 register Lisp_Object outstream;
4997 register struct buffer *old = current_buffer;
4998 register struct Lisp_Process *p = XPROCESS (proc);
4999 register int opoint;
5000 struct coding_system *coding = proc_decode_coding_system[channel];
5001 int carryover = p->decoding_carryover;
5002 int readmax = 4096;
5004 #ifdef VMS
5005 VMS_PROC_STUFF *vs, *get_vms_process_pointer();
5007 vs = get_vms_process_pointer (p->pid);
5008 if (vs)
5010 if (!vs->iosb[0])
5011 return (0); /* Really weird if it does this */
5012 if (!(vs->iosb[0] & 1))
5013 return -1; /* I/O error */
5015 else
5016 error ("Could not get VMS process pointer");
5017 chars = vs->inputBuffer;
5018 nbytes = clean_vms_buffer (chars, vs->iosb[1]);
5019 if (nbytes <= 0)
5021 start_vms_process_read (vs); /* Crank up the next read on the process */
5022 return 1; /* Nothing worth printing, say we got 1 */
5024 if (carryover > 0)
5026 /* The data carried over in the previous decoding (which are at
5027 the tail of decoding buffer) should be prepended to the new
5028 data read to decode all together. */
5029 chars = (char *) alloca (nbytes + carryover);
5030 bcopy (SDATA (p->decoding_buf), buf, carryover);
5031 bcopy (vs->inputBuffer, chars + carryover, nbytes);
5033 #else /* not VMS */
5035 chars = (char *) alloca (carryover + readmax);
5036 if (carryover)
5037 /* See the comment above. */
5038 bcopy (SDATA (p->decoding_buf), chars, carryover);
5040 #ifdef DATAGRAM_SOCKETS
5041 /* We have a working select, so proc_buffered_char is always -1. */
5042 if (DATAGRAM_CHAN_P (channel))
5044 int len = datagram_address[channel].len;
5045 nbytes = recvfrom (channel, chars + carryover, readmax,
5046 0, datagram_address[channel].sa, &len);
5048 else
5049 #endif
5050 if (proc_buffered_char[channel] < 0)
5052 nbytes = emacs_read (channel, chars + carryover, readmax);
5053 #ifdef ADAPTIVE_READ_BUFFERING
5054 if (nbytes > 0 && p->adaptive_read_buffering)
5056 int delay = p->read_output_delay;
5057 if (nbytes < 256)
5059 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5061 if (delay == 0)
5062 process_output_delay_count++;
5063 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5066 else if (delay > 0 && (nbytes == readmax))
5068 delay -= READ_OUTPUT_DELAY_INCREMENT;
5069 if (delay == 0)
5070 process_output_delay_count--;
5072 p->read_output_delay = delay;
5073 if (delay)
5075 p->read_output_skip = 1;
5076 process_output_skip = 1;
5079 #endif
5081 else
5083 chars[carryover] = proc_buffered_char[channel];
5084 proc_buffered_char[channel] = -1;
5085 nbytes = emacs_read (channel, chars + carryover + 1, readmax - 1);
5086 if (nbytes < 0)
5087 nbytes = 1;
5088 else
5089 nbytes = nbytes + 1;
5091 #endif /* not VMS */
5093 p->decoding_carryover = 0;
5095 /* At this point, NBYTES holds number of bytes just received
5096 (including the one in proc_buffered_char[channel]). */
5097 if (nbytes <= 0)
5099 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5100 return nbytes;
5101 coding->mode |= CODING_MODE_LAST_BLOCK;
5104 /* Now set NBYTES how many bytes we must decode. */
5105 nbytes += carryover;
5107 /* Read and dispose of the process output. */
5108 outstream = p->filter;
5109 if (!NILP (outstream))
5111 /* We inhibit quit here instead of just catching it so that
5112 hitting ^G when a filter happens to be running won't screw
5113 it up. */
5114 int count = SPECPDL_INDEX ();
5115 Lisp_Object odeactivate;
5116 Lisp_Object obuffer, okeymap;
5117 Lisp_Object text;
5118 int outer_running_asynch_code = running_asynch_code;
5119 int waiting = waiting_for_user_input_p;
5121 /* No need to gcpro these, because all we do with them later
5122 is test them for EQness, and none of them should be a string. */
5123 odeactivate = Vdeactivate_mark;
5124 XSETBUFFER (obuffer, current_buffer);
5125 okeymap = current_buffer->keymap;
5127 specbind (Qinhibit_quit, Qt);
5128 specbind (Qlast_nonmenu_event, Qt);
5130 /* In case we get recursively called,
5131 and we already saved the match data nonrecursively,
5132 save the same match data in safely recursive fashion. */
5133 if (outer_running_asynch_code)
5135 Lisp_Object tem;
5136 /* Don't clobber the CURRENT match data, either! */
5137 tem = Fmatch_data (Qnil, Qnil, Qnil);
5138 restore_search_regs ();
5139 record_unwind_save_match_data ();
5140 Fset_match_data (tem, Qt);
5143 /* For speed, if a search happens within this code,
5144 save the match data in a special nonrecursive fashion. */
5145 running_asynch_code = 1;
5147 text = decode_coding_string (make_unibyte_string (chars, nbytes),
5148 coding, 0);
5149 Vlast_coding_system_used = coding->symbol;
5150 /* A new coding system might be found. */
5151 if (!EQ (p->decode_coding_system, coding->symbol))
5153 p->decode_coding_system = coding->symbol;
5155 /* Don't call setup_coding_system for
5156 proc_decode_coding_system[channel] here. It is done in
5157 detect_coding called via decode_coding above. */
5159 /* If a coding system for encoding is not yet decided, we set
5160 it as the same as coding-system for decoding.
5162 But, before doing that we must check if
5163 proc_encode_coding_system[p->outfd] surely points to a
5164 valid memory because p->outfd will be changed once EOF is
5165 sent to the process. */
5166 if (NILP (p->encode_coding_system)
5167 && proc_encode_coding_system[p->outfd])
5169 p->encode_coding_system = coding->symbol;
5170 setup_coding_system (coding->symbol,
5171 proc_encode_coding_system[p->outfd]);
5172 if (proc_encode_coding_system[p->outfd]->eol_type
5173 == CODING_EOL_UNDECIDED)
5174 proc_encode_coding_system[p->outfd]->eol_type
5175 = system_eol_type;
5179 carryover = nbytes - coding->consumed;
5180 if (carryover < 0)
5181 abort ();
5183 if (SCHARS (p->decoding_buf) < carryover)
5184 p->decoding_buf = make_uninit_string (carryover);
5185 bcopy (chars + coding->consumed, SDATA (p->decoding_buf),
5186 carryover);
5187 p->decoding_carryover = carryover;
5188 /* Adjust the multibyteness of TEXT to that of the filter. */
5189 if (!p->filter_multibyte != !STRING_MULTIBYTE (text))
5190 text = (STRING_MULTIBYTE (text)
5191 ? Fstring_as_unibyte (text)
5192 : Fstring_to_multibyte (text));
5193 if (SBYTES (text) > 0)
5194 internal_condition_case_1 (read_process_output_call,
5195 Fcons (outstream,
5196 Fcons (proc, Fcons (text, Qnil))),
5197 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5198 read_process_output_error_handler);
5200 /* If we saved the match data nonrecursively, restore it now. */
5201 restore_search_regs ();
5202 running_asynch_code = outer_running_asynch_code;
5204 /* Handling the process output should not deactivate the mark. */
5205 Vdeactivate_mark = odeactivate;
5207 /* Restore waiting_for_user_input_p as it was
5208 when we were called, in case the filter clobbered it. */
5209 waiting_for_user_input_p = waiting;
5211 #if 0 /* Call record_asynch_buffer_change unconditionally,
5212 because we might have changed minor modes or other things
5213 that affect key bindings. */
5214 if (! EQ (Fcurrent_buffer (), obuffer)
5215 || ! EQ (current_buffer->keymap, okeymap))
5216 #endif
5217 /* But do it only if the caller is actually going to read events.
5218 Otherwise there's no need to make him wake up, and it could
5219 cause trouble (for example it would make sit_for return). */
5220 if (waiting_for_user_input_p == -1)
5221 record_asynch_buffer_change ();
5223 #ifdef VMS
5224 start_vms_process_read (vs);
5225 #endif
5226 unbind_to (count, Qnil);
5227 return nbytes;
5230 /* If no filter, write into buffer if it isn't dead. */
5231 if (!NILP (p->buffer) && !NILP (XBUFFER (p->buffer)->name))
5233 Lisp_Object old_read_only;
5234 int old_begv, old_zv;
5235 int old_begv_byte, old_zv_byte;
5236 Lisp_Object odeactivate;
5237 int before, before_byte;
5238 int opoint_byte;
5239 Lisp_Object text;
5240 struct buffer *b;
5242 odeactivate = Vdeactivate_mark;
5244 Fset_buffer (p->buffer);
5245 opoint = PT;
5246 opoint_byte = PT_BYTE;
5247 old_read_only = current_buffer->read_only;
5248 old_begv = BEGV;
5249 old_zv = ZV;
5250 old_begv_byte = BEGV_BYTE;
5251 old_zv_byte = ZV_BYTE;
5253 current_buffer->read_only = Qnil;
5255 /* Insert new output into buffer
5256 at the current end-of-output marker,
5257 thus preserving logical ordering of input and output. */
5258 if (XMARKER (p->mark)->buffer)
5259 SET_PT_BOTH (clip_to_bounds (BEGV, marker_position (p->mark), ZV),
5260 clip_to_bounds (BEGV_BYTE, marker_byte_position (p->mark),
5261 ZV_BYTE));
5262 else
5263 SET_PT_BOTH (ZV, ZV_BYTE);
5264 before = PT;
5265 before_byte = PT_BYTE;
5267 /* If the output marker is outside of the visible region, save
5268 the restriction and widen. */
5269 if (! (BEGV <= PT && PT <= ZV))
5270 Fwiden ();
5272 text = decode_coding_string (make_unibyte_string (chars, nbytes),
5273 coding, 0);
5274 Vlast_coding_system_used = coding->symbol;
5275 /* A new coding system might be found. See the comment in the
5276 similar code in the previous `if' block. */
5277 if (!EQ (p->decode_coding_system, coding->symbol))
5279 p->decode_coding_system = coding->symbol;
5280 if (NILP (p->encode_coding_system)
5281 && proc_encode_coding_system[p->outfd])
5283 p->encode_coding_system = coding->symbol;
5284 setup_coding_system (coding->symbol,
5285 proc_encode_coding_system[p->outfd]);
5286 if (proc_encode_coding_system[p->outfd]->eol_type
5287 == CODING_EOL_UNDECIDED)
5288 proc_encode_coding_system[p->outfd]->eol_type
5289 = system_eol_type;
5292 carryover = nbytes - coding->consumed;
5293 if (carryover < 0)
5294 abort ();
5296 if (SCHARS (p->decoding_buf) < carryover)
5297 p->decoding_buf = make_uninit_string (carryover);
5298 bcopy (chars + coding->consumed, SDATA (p->decoding_buf),
5299 carryover);
5300 p->decoding_carryover = carryover;
5302 /* Adjust the multibyteness of TEXT to that of the buffer. */
5303 if (NILP (current_buffer->enable_multibyte_characters)
5304 != ! STRING_MULTIBYTE (text))
5305 text = (STRING_MULTIBYTE (text)
5306 ? Fstring_as_unibyte (text)
5307 : Fstring_to_multibyte (text));
5308 /* Insert before markers in case we are inserting where
5309 the buffer's mark is, and the user's next command is Meta-y. */
5310 insert_from_string_before_markers (text, 0, 0,
5311 SCHARS (text), SBYTES (text), 0);
5313 /* Make sure the process marker's position is valid when the
5314 process buffer is changed in the signal_after_change above.
5315 W3 is known to do that. */
5316 if (BUFFERP (p->buffer)
5317 && (b = XBUFFER (p->buffer), b != current_buffer))
5318 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5319 else
5320 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5322 update_mode_lines++;
5324 /* Make sure opoint and the old restrictions
5325 float ahead of any new text just as point would. */
5326 if (opoint >= before)
5328 opoint += PT - before;
5329 opoint_byte += PT_BYTE - before_byte;
5331 if (old_begv > before)
5333 old_begv += PT - before;
5334 old_begv_byte += PT_BYTE - before_byte;
5336 if (old_zv >= before)
5338 old_zv += PT - before;
5339 old_zv_byte += PT_BYTE - before_byte;
5342 /* If the restriction isn't what it should be, set it. */
5343 if (old_begv != BEGV || old_zv != ZV)
5344 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5346 /* Handling the process output should not deactivate the mark. */
5347 Vdeactivate_mark = odeactivate;
5349 current_buffer->read_only = old_read_only;
5350 SET_PT_BOTH (opoint, opoint_byte);
5351 set_buffer_internal (old);
5353 #ifdef VMS
5354 start_vms_process_read (vs);
5355 #endif
5356 return nbytes;
5359 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p, Swaiting_for_user_input_p,
5360 0, 0, 0,
5361 doc: /* Returns non-nil if Emacs is waiting for input from the user.
5362 This is intended for use by asynchronous process output filters and sentinels. */)
5365 return (waiting_for_user_input_p ? Qt : Qnil);
5368 /* Sending data to subprocess */
5370 jmp_buf send_process_frame;
5371 Lisp_Object process_sent_to;
5373 SIGTYPE
5374 send_process_trap ()
5376 SIGNAL_THREAD_CHECK (SIGPIPE);
5377 #ifdef BSD4_1
5378 sigrelse (SIGPIPE);
5379 sigrelse (SIGALRM);
5380 #endif /* BSD4_1 */
5381 sigunblock (sigmask (SIGPIPE));
5382 longjmp (send_process_frame, 1);
5385 /* Send some data to process PROC.
5386 BUF is the beginning of the data; LEN is the number of characters.
5387 OBJECT is the Lisp object that the data comes from. If OBJECT is
5388 nil or t, it means that the data comes from C string.
5390 If OBJECT is not nil, the data is encoded by PROC's coding-system
5391 for encoding before it is sent.
5393 This function can evaluate Lisp code and can garbage collect. */
5395 static void
5396 send_process (proc, buf, len, object)
5397 volatile Lisp_Object proc;
5398 unsigned char *volatile buf;
5399 volatile int len;
5400 volatile Lisp_Object object;
5402 /* Use volatile to protect variables from being clobbered by longjmp. */
5403 struct Lisp_Process *p = XPROCESS (proc);
5404 int rv;
5405 struct coding_system *coding;
5406 struct gcpro gcpro1;
5407 SIGTYPE (*volatile old_sigpipe) ();
5409 GCPRO1 (object);
5411 #ifdef VMS
5412 VMS_PROC_STUFF *vs, *get_vms_process_pointer();
5413 #endif /* VMS */
5415 if (p->raw_status_new)
5416 update_status (p);
5417 if (! EQ (p->status, Qrun))
5418 error ("Process %s not running", SDATA (p->name));
5419 if (p->outfd < 0)
5420 error ("Output file descriptor of %s is closed", SDATA (p->name));
5422 coding = proc_encode_coding_system[p->outfd];
5423 Vlast_coding_system_used = coding->symbol;
5425 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5426 || (BUFFERP (object)
5427 && !NILP (XBUFFER (object)->enable_multibyte_characters))
5428 || EQ (object, Qt))
5430 if (!EQ (coding->symbol, p->encode_coding_system))
5431 /* The coding system for encoding was changed to raw-text
5432 because we sent a unibyte text previously. Now we are
5433 sending a multibyte text, thus we must encode it by the
5434 original coding system specified for the current process. */
5435 setup_coding_system (p->encode_coding_system, coding);
5436 if (coding->eol_type == CODING_EOL_UNDECIDED)
5437 coding->eol_type = system_eol_type;
5438 /* src_multibyte should be set to 1 _after_ a call to
5439 setup_coding_system, since it resets src_multibyte to
5440 zero. */
5441 coding->src_multibyte = 1;
5443 else
5445 /* For sending a unibyte text, character code conversion should
5446 not take place but EOL conversion should. So, setup raw-text
5447 or one of the subsidiary if we have not yet done it. */
5448 if (coding->type != coding_type_raw_text)
5450 if (CODING_REQUIRE_FLUSHING (coding))
5452 /* But, before changing the coding, we must flush out data. */
5453 coding->mode |= CODING_MODE_LAST_BLOCK;
5454 send_process (proc, "", 0, Qt);
5456 coding->src_multibyte = 0;
5457 setup_raw_text_coding_system (coding);
5460 coding->dst_multibyte = 0;
5462 if (CODING_REQUIRE_ENCODING (coding))
5464 int require = encoding_buffer_size (coding, len);
5465 int from_byte = -1, from = -1, to = -1;
5467 if (BUFFERP (object))
5469 from_byte = BUF_PTR_BYTE_POS (XBUFFER (object), buf);
5470 from = buf_bytepos_to_charpos (XBUFFER (object), from_byte);
5471 to = buf_bytepos_to_charpos (XBUFFER (object), from_byte + len);
5473 else if (STRINGP (object))
5475 from_byte = buf - SDATA (object);
5476 from = string_byte_to_char (object, from_byte);
5477 to = string_byte_to_char (object, from_byte + len);
5480 if (coding->composing != COMPOSITION_DISABLED)
5482 if (from_byte >= 0)
5483 coding_save_composition (coding, from, to, object);
5484 else
5485 coding->composing = COMPOSITION_DISABLED;
5488 if (SBYTES (p->encoding_buf) < require)
5489 p->encoding_buf = make_uninit_string (require);
5491 if (from_byte >= 0)
5492 buf = (BUFFERP (object)
5493 ? BUF_BYTE_ADDRESS (XBUFFER (object), from_byte)
5494 : SDATA (object) + from_byte);
5496 object = p->encoding_buf;
5497 encode_coding (coding, (char *) buf, SDATA (object),
5498 len, SBYTES (object));
5499 coding_free_composition_data (coding);
5500 len = coding->produced;
5501 buf = SDATA (object);
5504 #ifdef VMS
5505 vs = get_vms_process_pointer (p->pid);
5506 if (vs == 0)
5507 error ("Could not find this process: %x", p->pid);
5508 else if (write_to_vms_process (vs, buf, len))
5510 #else /* not VMS */
5512 if (pty_max_bytes == 0)
5514 #if defined (HAVE_FPATHCONF) && defined (_PC_MAX_CANON)
5515 pty_max_bytes = fpathconf (p->outfd, _PC_MAX_CANON);
5516 if (pty_max_bytes < 0)
5517 pty_max_bytes = 250;
5518 #else
5519 pty_max_bytes = 250;
5520 #endif
5521 /* Deduct one, to leave space for the eof. */
5522 pty_max_bytes--;
5525 /* 2000-09-21: Emacs 20.7, sparc-sun-solaris-2.6, GCC 2.95.2,
5526 CFLAGS="-g -O": The value of the parameter `proc' is clobbered
5527 when returning with longjmp despite being declared volatile. */
5528 if (!setjmp (send_process_frame))
5530 process_sent_to = proc;
5531 while (len > 0)
5533 int this = len;
5535 /* Decide how much data we can send in one batch.
5536 Long lines need to be split into multiple batches. */
5537 if (p->pty_flag)
5539 /* Starting this at zero is always correct when not the first
5540 iteration because the previous iteration ended by sending C-d.
5541 It may not be correct for the first iteration
5542 if a partial line was sent in a separate send_process call.
5543 If that proves worth handling, we need to save linepos
5544 in the process object. */
5545 int linepos = 0;
5546 unsigned char *ptr = (unsigned char *) buf;
5547 unsigned char *end = (unsigned char *) buf + len;
5549 /* Scan through this text for a line that is too long. */
5550 while (ptr != end && linepos < pty_max_bytes)
5552 if (*ptr == '\n')
5553 linepos = 0;
5554 else
5555 linepos++;
5556 ptr++;
5558 /* If we found one, break the line there
5559 and put in a C-d to force the buffer through. */
5560 this = ptr - buf;
5563 /* Send this batch, using one or more write calls. */
5564 while (this > 0)
5566 int outfd = p->outfd;
5567 old_sigpipe = (SIGTYPE (*) ()) signal (SIGPIPE, send_process_trap);
5568 #ifdef DATAGRAM_SOCKETS
5569 if (DATAGRAM_CHAN_P (outfd))
5571 rv = sendto (outfd, (char *) buf, this,
5572 0, datagram_address[outfd].sa,
5573 datagram_address[outfd].len);
5574 if (rv < 0 && errno == EMSGSIZE)
5576 signal (SIGPIPE, old_sigpipe);
5577 report_file_error ("sending datagram",
5578 Fcons (proc, Qnil));
5581 else
5582 #endif
5584 rv = emacs_write (outfd, (char *) buf, this);
5585 #ifdef ADAPTIVE_READ_BUFFERING
5586 if (p->read_output_delay > 0
5587 && p->adaptive_read_buffering == 1)
5589 p->read_output_delay = 0;
5590 process_output_delay_count--;
5591 p->read_output_skip = 0;
5593 #endif
5595 signal (SIGPIPE, old_sigpipe);
5597 if (rv < 0)
5599 if (0
5600 #ifdef EWOULDBLOCK
5601 || errno == EWOULDBLOCK
5602 #endif
5603 #ifdef EAGAIN
5604 || errno == EAGAIN
5605 #endif
5607 /* Buffer is full. Wait, accepting input;
5608 that may allow the program
5609 to finish doing output and read more. */
5611 int offset = 0;
5613 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5614 /* A gross hack to work around a bug in FreeBSD.
5615 In the following sequence, read(2) returns
5616 bogus data:
5618 write(2) 1022 bytes
5619 write(2) 954 bytes, get EAGAIN
5620 read(2) 1024 bytes in process_read_output
5621 read(2) 11 bytes in process_read_output
5623 That is, read(2) returns more bytes than have
5624 ever been written successfully. The 1033 bytes
5625 read are the 1022 bytes written successfully
5626 after processing (for example with CRs added if
5627 the terminal is set up that way which it is
5628 here). The same bytes will be seen again in a
5629 later read(2), without the CRs. */
5631 if (errno == EAGAIN)
5633 int flags = FWRITE;
5634 ioctl (p->outfd, TIOCFLUSH, &flags);
5636 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5638 /* Running filters might relocate buffers or strings.
5639 Arrange to relocate BUF. */
5640 if (BUFFERP (object))
5641 offset = BUF_PTR_BYTE_POS (XBUFFER (object), buf);
5642 else if (STRINGP (object))
5643 offset = buf - SDATA (object);
5645 #ifdef EMACS_HAS_USECS
5646 wait_reading_process_output (0, 20000, 0, 0, Qnil, NULL, 0);
5647 #else
5648 wait_reading_process_output (1, 0, 0, 0, Qnil, NULL, 0);
5649 #endif
5651 if (BUFFERP (object))
5652 buf = BUF_BYTE_ADDRESS (XBUFFER (object), offset);
5653 else if (STRINGP (object))
5654 buf = offset + SDATA (object);
5656 rv = 0;
5658 else
5659 /* This is a real error. */
5660 report_file_error ("writing to process", Fcons (proc, Qnil));
5662 buf += rv;
5663 len -= rv;
5664 this -= rv;
5667 /* If we sent just part of the string, put in an EOF
5668 to force it through, before we send the rest. */
5669 if (len > 0)
5670 Fprocess_send_eof (proc);
5673 #endif /* not VMS */
5674 else
5676 signal (SIGPIPE, old_sigpipe);
5677 #ifndef VMS
5678 proc = process_sent_to;
5679 p = XPROCESS (proc);
5680 #endif
5681 p->raw_status_new = 0;
5682 p->status = Fcons (Qexit, Fcons (make_number (256), Qnil));
5683 p->tick = ++process_tick;
5684 deactivate_process (proc);
5685 #ifdef VMS
5686 error ("Error writing to process %s; closed it", SDATA (p->name));
5687 #else
5688 error ("SIGPIPE raised on process %s; closed it", SDATA (p->name));
5689 #endif
5692 UNGCPRO;
5695 static Lisp_Object
5696 send_process_object_unwind (buf)
5697 Lisp_Object buf;
5699 Lisp_Object tembuf;
5701 if (XBUFFER (buf) == current_buffer)
5702 return Qnil;
5703 tembuf = Fcurrent_buffer ();
5704 Fset_buffer (buf);
5705 Fkill_buffer (tembuf);
5706 return Qnil;
5709 /* Send current contents of region between START and END to PROC.
5710 If START is a string, send it instead.
5711 This function can evaluate Lisp code and can garbage collect. */
5713 static void
5714 send_process_object (proc, start, end)
5715 Lisp_Object proc, start, end;
5717 int count = SPECPDL_INDEX ();
5718 Lisp_Object object = STRINGP (start) ? start : Fcurrent_buffer ();
5719 struct buffer *given_buffer = current_buffer;
5720 unsigned char *buf;
5721 int len;
5723 record_unwind_protect (send_process_object_unwind, Fcurrent_buffer ());
5725 if (STRINGP (object) ? STRING_MULTIBYTE (object)
5726 : ! NILP (XBUFFER (object)->enable_multibyte_characters))
5728 struct Lisp_Process *p = XPROCESS (proc);
5729 struct coding_system *coding;
5731 if (p->raw_status_new)
5732 update_status (p);
5733 if (! EQ (p->status, Qrun))
5734 error ("Process %s not running", SDATA (p->name));
5735 if (p->outfd < 0)
5736 error ("Output file descriptor of %s is closed", SDATA (p->name));
5738 coding = proc_encode_coding_system[p->outfd];
5739 if (! EQ (coding->symbol, p->encode_coding_system))
5740 /* The coding system for encoding was changed to raw-text
5741 because we sent a unibyte text previously. Now we are
5742 sending a multibyte text, thus we must encode it by the
5743 original coding system specified for the current process. */
5744 setup_coding_system (p->encode_coding_system, coding);
5745 if (! NILP (coding->pre_write_conversion))
5747 struct gcpro gcpro1, gcpro2;
5749 GCPRO2 (proc, object);
5750 call2 (coding->pre_write_conversion, start, end);
5751 UNGCPRO;
5752 if (given_buffer != current_buffer)
5754 start = make_number (BEGV), end = make_number (ZV);
5755 object = Fcurrent_buffer ();
5760 if (BUFFERP (object))
5762 EMACS_INT start_byte;
5764 if (XINT (start) < GPT && XINT (end) > GPT)
5765 move_gap (XINT (end));
5766 start_byte = CHAR_TO_BYTE (XINT (start));
5767 buf = BYTE_POS_ADDR (start_byte);
5768 len = CHAR_TO_BYTE (XINT (end)) - start_byte;
5770 else
5772 buf = SDATA (object);
5773 len = SBYTES (object);
5775 send_process (proc, buf, len, object);
5777 unbind_to (count, Qnil);
5780 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5781 3, 3, 0,
5782 doc: /* Send current contents of region as input to PROCESS.
5783 PROCESS may be a process, a buffer, the name of a process or buffer, or
5784 nil, indicating the current buffer's process.
5785 Called from program, takes three arguments, PROCESS, START and END.
5786 If the region is more than 500 characters long,
5787 it is sent in several bunches. This may happen even for shorter regions.
5788 Output from processes can arrive in between bunches. */)
5789 (process, start, end)
5790 Lisp_Object process, start, end;
5792 Lisp_Object proc;
5794 proc = get_process (process);
5795 validate_region (&start, &end);
5796 send_process_object (proc, start, end);
5797 return Qnil;
5800 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5801 2, 2, 0,
5802 doc: /* Send PROCESS the contents of STRING as input.
5803 PROCESS may be a process, a buffer, the name of a process or buffer, or
5804 nil, indicating the current buffer's process.
5805 If STRING is more than 500 characters long,
5806 it is sent in several bunches. This may happen even for shorter strings.
5807 Output from processes can arrive in between bunches. */)
5808 (process, string)
5809 Lisp_Object process, string;
5811 Lisp_Object proc;
5812 CHECK_STRING (string);
5813 proc = get_process (process);
5814 send_process_object (proc, string, Qnil);
5815 return Qnil;
5818 /* Return the foreground process group for the tty/pty that
5819 the process P uses. */
5820 static int
5821 emacs_get_tty_pgrp (p)
5822 struct Lisp_Process *p;
5824 int gid = -1;
5826 #ifdef TIOCGPGRP
5827 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5829 int fd;
5830 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5831 master side. Try the slave side. */
5832 fd = emacs_open (XSTRING (p->tty_name)->data, O_RDONLY, 0);
5834 if (fd != -1)
5836 ioctl (fd, TIOCGPGRP, &gid);
5837 emacs_close (fd);
5840 #endif /* defined (TIOCGPGRP ) */
5842 return gid;
5845 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5846 Sprocess_running_child_p, 0, 1, 0,
5847 doc: /* Return t if PROCESS has given the terminal to a child.
5848 If the operating system does not make it possible to find out,
5849 return t unconditionally. */)
5850 (process)
5851 Lisp_Object process;
5853 /* Initialize in case ioctl doesn't exist or gives an error,
5854 in a way that will cause returning t. */
5855 int gid;
5856 Lisp_Object proc;
5857 struct Lisp_Process *p;
5859 proc = get_process (process);
5860 p = XPROCESS (proc);
5862 if (!EQ (p->childp, Qt))
5863 error ("Process %s is not a subprocess",
5864 SDATA (p->name));
5865 if (p->infd < 0)
5866 error ("Process %s is not active",
5867 SDATA (p->name));
5869 gid = emacs_get_tty_pgrp (p);
5871 if (gid == p->pid)
5872 return Qnil;
5873 return Qt;
5876 /* send a signal number SIGNO to PROCESS.
5877 If CURRENT_GROUP is t, that means send to the process group
5878 that currently owns the terminal being used to communicate with PROCESS.
5879 This is used for various commands in shell mode.
5880 If CURRENT_GROUP is lambda, that means send to the process group
5881 that currently owns the terminal, but only if it is NOT the shell itself.
5883 If NOMSG is zero, insert signal-announcements into process's buffers
5884 right away.
5886 If we can, we try to signal PROCESS by sending control characters
5887 down the pty. This allows us to signal inferiors who have changed
5888 their uid, for which killpg would return an EPERM error. */
5890 static void
5891 process_send_signal (process, signo, current_group, nomsg)
5892 Lisp_Object process;
5893 int signo;
5894 Lisp_Object current_group;
5895 int nomsg;
5897 Lisp_Object proc;
5898 register struct Lisp_Process *p;
5899 int gid;
5900 int no_pgrp = 0;
5902 proc = get_process (process);
5903 p = XPROCESS (proc);
5905 if (!EQ (p->childp, Qt))
5906 error ("Process %s is not a subprocess",
5907 SDATA (p->name));
5908 if (p->infd < 0)
5909 error ("Process %s is not active",
5910 SDATA (p->name));
5912 if (!p->pty_flag)
5913 current_group = Qnil;
5915 /* If we are using pgrps, get a pgrp number and make it negative. */
5916 if (NILP (current_group))
5917 /* Send the signal to the shell's process group. */
5918 gid = p->pid;
5919 else
5921 #ifdef SIGNALS_VIA_CHARACTERS
5922 /* If possible, send signals to the entire pgrp
5923 by sending an input character to it. */
5925 /* TERMIOS is the latest and bestest, and seems most likely to
5926 work. If the system has it, use it. */
5927 #ifdef HAVE_TERMIOS
5928 struct termios t;
5929 cc_t *sig_char = NULL;
5931 tcgetattr (p->infd, &t);
5933 switch (signo)
5935 case SIGINT:
5936 sig_char = &t.c_cc[VINTR];
5937 break;
5939 case SIGQUIT:
5940 sig_char = &t.c_cc[VQUIT];
5941 break;
5943 case SIGTSTP:
5944 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5945 sig_char = &t.c_cc[VSWTCH];
5946 #else
5947 sig_char = &t.c_cc[VSUSP];
5948 #endif
5949 break;
5952 if (sig_char && *sig_char != CDISABLE)
5954 send_process (proc, sig_char, 1, Qnil);
5955 return;
5957 /* If we can't send the signal with a character,
5958 fall through and send it another way. */
5959 #else /* ! HAVE_TERMIOS */
5961 /* On Berkeley descendants, the following IOCTL's retrieve the
5962 current control characters. */
5963 #if defined (TIOCGLTC) && defined (TIOCGETC)
5965 struct tchars c;
5966 struct ltchars lc;
5968 switch (signo)
5970 case SIGINT:
5971 ioctl (p->infd, TIOCGETC, &c);
5972 send_process (proc, &c.t_intrc, 1, Qnil);
5973 return;
5974 case SIGQUIT:
5975 ioctl (p->infd, TIOCGETC, &c);
5976 send_process (proc, &c.t_quitc, 1, Qnil);
5977 return;
5978 #ifdef SIGTSTP
5979 case SIGTSTP:
5980 ioctl (p->infd, TIOCGLTC, &lc);
5981 send_process (proc, &lc.t_suspc, 1, Qnil);
5982 return;
5983 #endif /* ! defined (SIGTSTP) */
5986 #else /* ! defined (TIOCGLTC) && defined (TIOCGETC) */
5988 /* On SYSV descendants, the TCGETA ioctl retrieves the current control
5989 characters. */
5990 #ifdef TCGETA
5991 struct termio t;
5992 switch (signo)
5994 case SIGINT:
5995 ioctl (p->infd, TCGETA, &t);
5996 send_process (proc, &t.c_cc[VINTR], 1, Qnil);
5997 return;
5998 case SIGQUIT:
5999 ioctl (p->infd, TCGETA, &t);
6000 send_process (proc, &t.c_cc[VQUIT], 1, Qnil);
6001 return;
6002 #ifdef SIGTSTP
6003 case SIGTSTP:
6004 ioctl (p->infd, TCGETA, &t);
6005 send_process (proc, &t.c_cc[VSWTCH], 1, Qnil);
6006 return;
6007 #endif /* ! defined (SIGTSTP) */
6009 #else /* ! defined (TCGETA) */
6010 Your configuration files are messed up.
6011 /* If your system configuration files define SIGNALS_VIA_CHARACTERS,
6012 you'd better be using one of the alternatives above! */
6013 #endif /* ! defined (TCGETA) */
6014 #endif /* ! defined (TIOCGLTC) && defined (TIOCGETC) */
6015 /* In this case, the code above should alway returns. */
6016 abort ();
6017 #endif /* ! defined HAVE_TERMIOS */
6019 /* The code above may fall through if it can't
6020 handle the signal. */
6021 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
6023 #ifdef TIOCGPGRP
6024 /* Get the current pgrp using the tty itself, if we have that.
6025 Otherwise, use the pty to get the pgrp.
6026 On pfa systems, saka@pfu.fujitsu.co.JP writes:
6027 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
6028 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
6029 His patch indicates that if TIOCGPGRP returns an error, then
6030 we should just assume that p->pid is also the process group id. */
6032 gid = emacs_get_tty_pgrp (p);
6034 if (gid == -1)
6035 /* If we can't get the information, assume
6036 the shell owns the tty. */
6037 gid = p->pid;
6039 /* It is not clear whether anything really can set GID to -1.
6040 Perhaps on some system one of those ioctls can or could do so.
6041 Or perhaps this is vestigial. */
6042 if (gid == -1)
6043 no_pgrp = 1;
6044 #else /* ! defined (TIOCGPGRP ) */
6045 /* Can't select pgrps on this system, so we know that
6046 the child itself heads the pgrp. */
6047 gid = p->pid;
6048 #endif /* ! defined (TIOCGPGRP ) */
6050 /* If current_group is lambda, and the shell owns the terminal,
6051 don't send any signal. */
6052 if (EQ (current_group, Qlambda) && gid == p->pid)
6053 return;
6056 switch (signo)
6058 #ifdef SIGCONT
6059 case SIGCONT:
6060 p->raw_status_new = 0;
6061 p->status = Qrun;
6062 p->tick = ++process_tick;
6063 if (!nomsg)
6064 status_notify (NULL);
6065 break;
6066 #endif /* ! defined (SIGCONT) */
6067 case SIGINT:
6068 #ifdef VMS
6069 send_process (proc, "\003", 1, Qnil); /* ^C */
6070 goto whoosh;
6071 #endif
6072 case SIGQUIT:
6073 #ifdef VMS
6074 send_process (proc, "\031", 1, Qnil); /* ^Y */
6075 goto whoosh;
6076 #endif
6077 case SIGKILL:
6078 #ifdef VMS
6079 sys$forcex (&(p->pid), 0, 1);
6080 whoosh:
6081 #endif
6082 flush_pending_output (p->infd);
6083 break;
6086 /* If we don't have process groups, send the signal to the immediate
6087 subprocess. That isn't really right, but it's better than any
6088 obvious alternative. */
6089 if (no_pgrp)
6091 kill (p->pid, signo);
6092 return;
6095 /* gid may be a pid, or minus a pgrp's number */
6096 #ifdef TIOCSIGSEND
6097 if (!NILP (current_group))
6099 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
6100 EMACS_KILLPG (gid, signo);
6102 else
6104 gid = - p->pid;
6105 kill (gid, signo);
6107 #else /* ! defined (TIOCSIGSEND) */
6108 EMACS_KILLPG (gid, signo);
6109 #endif /* ! defined (TIOCSIGSEND) */
6112 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
6113 doc: /* Interrupt process PROCESS.
6114 PROCESS may be a process, a buffer, or the name of a process or buffer.
6115 No arg or nil means current buffer's process.
6116 Second arg CURRENT-GROUP non-nil means send signal to
6117 the current process-group of the process's controlling terminal
6118 rather than to the process's own process group.
6119 If the process is a shell, this means interrupt current subjob
6120 rather than the shell.
6122 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
6123 don't send the signal. */)
6124 (process, current_group)
6125 Lisp_Object process, current_group;
6127 process_send_signal (process, SIGINT, current_group, 0);
6128 return process;
6131 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
6132 doc: /* Kill process PROCESS. May be process or name of one.
6133 See function `interrupt-process' for more details on usage. */)
6134 (process, current_group)
6135 Lisp_Object process, current_group;
6137 process_send_signal (process, SIGKILL, current_group, 0);
6138 return process;
6141 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
6142 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
6143 See function `interrupt-process' for more details on usage. */)
6144 (process, current_group)
6145 Lisp_Object process, current_group;
6147 process_send_signal (process, SIGQUIT, current_group, 0);
6148 return process;
6151 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
6152 doc: /* Stop process PROCESS. May be process or name of one.
6153 See function `interrupt-process' for more details on usage.
6154 If PROCESS is a network process, inhibit handling of incoming traffic. */)
6155 (process, current_group)
6156 Lisp_Object process, current_group;
6158 #ifdef HAVE_SOCKETS
6159 if (PROCESSP (process) && NETCONN_P (process))
6161 struct Lisp_Process *p;
6163 p = XPROCESS (process);
6164 if (NILP (p->command)
6165 && p->infd >= 0)
6167 FD_CLR (p->infd, &input_wait_mask);
6168 FD_CLR (p->infd, &non_keyboard_wait_mask);
6170 p->command = Qt;
6171 return process;
6173 #endif
6174 #ifndef SIGTSTP
6175 error ("No SIGTSTP support");
6176 #else
6177 process_send_signal (process, SIGTSTP, current_group, 0);
6178 #endif
6179 return process;
6182 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
6183 doc: /* Continue process PROCESS. May be process or name of one.
6184 See function `interrupt-process' for more details on usage.
6185 If PROCESS is a network process, resume handling of incoming traffic. */)
6186 (process, current_group)
6187 Lisp_Object process, current_group;
6189 #ifdef HAVE_SOCKETS
6190 if (PROCESSP (process) && NETCONN_P (process))
6192 struct Lisp_Process *p;
6194 p = XPROCESS (process);
6195 if (EQ (p->command, Qt)
6196 && p->infd >= 0
6197 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
6199 FD_SET (p->infd, &input_wait_mask);
6200 FD_SET (p->infd, &non_keyboard_wait_mask);
6202 p->command = Qnil;
6203 return process;
6205 #endif
6206 #ifdef SIGCONT
6207 process_send_signal (process, SIGCONT, current_group, 0);
6208 #else
6209 error ("No SIGCONT support");
6210 #endif
6211 return process;
6214 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
6215 2, 2, "sProcess (name or number): \nnSignal code: ",
6216 doc: /* Send PROCESS the signal with code SIGCODE.
6217 PROCESS may also be a number specifying the process id of the
6218 process to signal; in this case, the process need not be a child of
6219 this Emacs.
6220 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
6221 (process, sigcode)
6222 Lisp_Object process, sigcode;
6224 pid_t pid;
6226 if (INTEGERP (process))
6228 pid = XINT (process);
6229 goto got_it;
6232 if (FLOATP (process))
6234 pid = (pid_t) XFLOAT_DATA (process);
6235 goto got_it;
6238 if (STRINGP (process))
6240 Lisp_Object tem;
6241 if (tem = Fget_process (process), NILP (tem))
6243 pid = XINT (Fstring_to_number (process, make_number (10)));
6244 if (pid > 0)
6245 goto got_it;
6247 process = tem;
6249 else
6250 process = get_process (process);
6252 if (NILP (process))
6253 return process;
6255 CHECK_PROCESS (process);
6256 pid = XPROCESS (process)->pid;
6257 if (pid <= 0)
6258 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
6260 got_it:
6262 #define parse_signal(NAME, VALUE) \
6263 else if (!xstricmp (name, NAME)) \
6264 XSETINT (sigcode, VALUE)
6266 if (INTEGERP (sigcode))
6268 else
6270 unsigned char *name;
6272 CHECK_SYMBOL (sigcode);
6273 name = SDATA (SYMBOL_NAME (sigcode));
6275 if (!strncmp(name, "SIG", 3) || !strncmp(name, "sig", 3))
6276 name += 3;
6278 if (0)
6280 #ifdef SIGUSR1
6281 parse_signal ("usr1", SIGUSR1);
6282 #endif
6283 #ifdef SIGUSR2
6284 parse_signal ("usr2", SIGUSR2);
6285 #endif
6286 #ifdef SIGTERM
6287 parse_signal ("term", SIGTERM);
6288 #endif
6289 #ifdef SIGHUP
6290 parse_signal ("hup", SIGHUP);
6291 #endif
6292 #ifdef SIGINT
6293 parse_signal ("int", SIGINT);
6294 #endif
6295 #ifdef SIGQUIT
6296 parse_signal ("quit", SIGQUIT);
6297 #endif
6298 #ifdef SIGILL
6299 parse_signal ("ill", SIGILL);
6300 #endif
6301 #ifdef SIGABRT
6302 parse_signal ("abrt", SIGABRT);
6303 #endif
6304 #ifdef SIGEMT
6305 parse_signal ("emt", SIGEMT);
6306 #endif
6307 #ifdef SIGKILL
6308 parse_signal ("kill", SIGKILL);
6309 #endif
6310 #ifdef SIGFPE
6311 parse_signal ("fpe", SIGFPE);
6312 #endif
6313 #ifdef SIGBUS
6314 parse_signal ("bus", SIGBUS);
6315 #endif
6316 #ifdef SIGSEGV
6317 parse_signal ("segv", SIGSEGV);
6318 #endif
6319 #ifdef SIGSYS
6320 parse_signal ("sys", SIGSYS);
6321 #endif
6322 #ifdef SIGPIPE
6323 parse_signal ("pipe", SIGPIPE);
6324 #endif
6325 #ifdef SIGALRM
6326 parse_signal ("alrm", SIGALRM);
6327 #endif
6328 #ifdef SIGURG
6329 parse_signal ("urg", SIGURG);
6330 #endif
6331 #ifdef SIGSTOP
6332 parse_signal ("stop", SIGSTOP);
6333 #endif
6334 #ifdef SIGTSTP
6335 parse_signal ("tstp", SIGTSTP);
6336 #endif
6337 #ifdef SIGCONT
6338 parse_signal ("cont", SIGCONT);
6339 #endif
6340 #ifdef SIGCHLD
6341 parse_signal ("chld", SIGCHLD);
6342 #endif
6343 #ifdef SIGTTIN
6344 parse_signal ("ttin", SIGTTIN);
6345 #endif
6346 #ifdef SIGTTOU
6347 parse_signal ("ttou", SIGTTOU);
6348 #endif
6349 #ifdef SIGIO
6350 parse_signal ("io", SIGIO);
6351 #endif
6352 #ifdef SIGXCPU
6353 parse_signal ("xcpu", SIGXCPU);
6354 #endif
6355 #ifdef SIGXFSZ
6356 parse_signal ("xfsz", SIGXFSZ);
6357 #endif
6358 #ifdef SIGVTALRM
6359 parse_signal ("vtalrm", SIGVTALRM);
6360 #endif
6361 #ifdef SIGPROF
6362 parse_signal ("prof", SIGPROF);
6363 #endif
6364 #ifdef SIGWINCH
6365 parse_signal ("winch", SIGWINCH);
6366 #endif
6367 #ifdef SIGINFO
6368 parse_signal ("info", SIGINFO);
6369 #endif
6370 else
6371 error ("Undefined signal name %s", name);
6374 #undef parse_signal
6376 return make_number (kill (pid, XINT (sigcode)));
6379 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6380 doc: /* Make PROCESS see end-of-file in its input.
6381 EOF comes after any text already sent to it.
6382 PROCESS may be a process, a buffer, the name of a process or buffer, or
6383 nil, indicating the current buffer's process.
6384 If PROCESS is a network connection, or is a process communicating
6385 through a pipe (as opposed to a pty), then you cannot send any more
6386 text to PROCESS after you call this function. */)
6387 (process)
6388 Lisp_Object process;
6390 Lisp_Object proc;
6391 struct coding_system *coding;
6393 if (DATAGRAM_CONN_P (process))
6394 return process;
6396 proc = get_process (process);
6397 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6399 /* Make sure the process is really alive. */
6400 if (XPROCESS (proc)->raw_status_new)
6401 update_status (XPROCESS (proc));
6402 if (! EQ (XPROCESS (proc)->status, Qrun))
6403 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6405 if (CODING_REQUIRE_FLUSHING (coding))
6407 coding->mode |= CODING_MODE_LAST_BLOCK;
6408 send_process (proc, "", 0, Qnil);
6411 #ifdef VMS
6412 send_process (proc, "\032", 1, Qnil); /* ^z */
6413 #else
6414 if (XPROCESS (proc)->pty_flag)
6415 send_process (proc, "\004", 1, Qnil);
6416 else
6418 int old_outfd, new_outfd;
6420 #ifdef HAVE_SHUTDOWN
6421 /* If this is a network connection, or socketpair is used
6422 for communication with the subprocess, call shutdown to cause EOF.
6423 (In some old system, shutdown to socketpair doesn't work.
6424 Then we just can't win.) */
6425 if (XPROCESS (proc)->pid == 0
6426 || XPROCESS (proc)->outfd == XPROCESS (proc)->infd)
6427 shutdown (XPROCESS (proc)->outfd, 1);
6428 /* In case of socketpair, outfd == infd, so don't close it. */
6429 if (XPROCESS (proc)->outfd != XPROCESS (proc)->infd)
6430 emacs_close (XPROCESS (proc)->outfd);
6431 #else /* not HAVE_SHUTDOWN */
6432 emacs_close (XPROCESS (proc)->outfd);
6433 #endif /* not HAVE_SHUTDOWN */
6434 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6435 if (new_outfd < 0)
6436 abort ();
6437 old_outfd = XPROCESS (proc)->outfd;
6439 if (!proc_encode_coding_system[new_outfd])
6440 proc_encode_coding_system[new_outfd]
6441 = (struct coding_system *) xmalloc (sizeof (struct coding_system));
6442 bcopy (proc_encode_coding_system[old_outfd],
6443 proc_encode_coding_system[new_outfd],
6444 sizeof (struct coding_system));
6445 bzero (proc_encode_coding_system[old_outfd],
6446 sizeof (struct coding_system));
6448 XPROCESS (proc)->outfd = new_outfd;
6450 #endif /* VMS */
6451 return process;
6454 /* Kill all processes associated with `buffer'.
6455 If `buffer' is nil, kill all processes */
6457 void
6458 kill_buffer_processes (buffer)
6459 Lisp_Object buffer;
6461 Lisp_Object tail, proc;
6463 for (tail = Vprocess_alist; GC_CONSP (tail); tail = XCDR (tail))
6465 proc = XCDR (XCAR (tail));
6466 if (GC_PROCESSP (proc)
6467 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
6469 if (NETCONN_P (proc))
6470 Fdelete_process (proc);
6471 else if (XPROCESS (proc)->infd >= 0)
6472 process_send_signal (proc, SIGHUP, Qnil, 1);
6477 /* On receipt of a signal that a child status has changed, loop asking
6478 about children with changed statuses until the system says there
6479 are no more.
6481 All we do is change the status; we do not run sentinels or print
6482 notifications. That is saved for the next time keyboard input is
6483 done, in order to avoid timing errors.
6485 ** WARNING: this can be called during garbage collection.
6486 Therefore, it must not be fooled by the presence of mark bits in
6487 Lisp objects.
6489 ** USG WARNING: Although it is not obvious from the documentation
6490 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6491 signal() before executing at least one wait(), otherwise the
6492 handler will be called again, resulting in an infinite loop. The
6493 relevant portion of the documentation reads "SIGCLD signals will be
6494 queued and the signal-catching function will be continually
6495 reentered until the queue is empty". Invoking signal() causes the
6496 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6497 Inc.
6499 ** Malloc WARNING: This should never call malloc either directly or
6500 indirectly; if it does, that is a bug */
6502 #ifdef SIGCHLD
6503 SIGTYPE
6504 sigchld_handler (signo)
6505 int signo;
6507 int old_errno = errno;
6508 Lisp_Object proc;
6509 register struct Lisp_Process *p;
6510 extern EMACS_TIME *input_available_clear_time;
6512 SIGNAL_THREAD_CHECK (signo);
6514 #ifdef BSD4_1
6515 extern int sigheld;
6516 sigheld |= sigbit (SIGCHLD);
6517 #endif
6519 while (1)
6521 pid_t pid;
6522 WAITTYPE w;
6523 Lisp_Object tail;
6525 #ifdef WNOHANG
6526 #ifndef WUNTRACED
6527 #define WUNTRACED 0
6528 #endif /* no WUNTRACED */
6529 /* Keep trying to get a status until we get a definitive result. */
6532 errno = 0;
6533 pid = wait3 (&w, WNOHANG | WUNTRACED, 0);
6535 while (pid < 0 && errno == EINTR);
6537 if (pid <= 0)
6539 /* PID == 0 means no processes found, PID == -1 means a real
6540 failure. We have done all our job, so return. */
6542 /* USG systems forget handlers when they are used;
6543 must reestablish each time */
6544 #if defined (USG) && !defined (POSIX_SIGNALS)
6545 signal (signo, sigchld_handler); /* WARNING - must come after wait3() */
6546 #endif
6547 #ifdef BSD4_1
6548 sigheld &= ~sigbit (SIGCHLD);
6549 sigrelse (SIGCHLD);
6550 #endif
6551 errno = old_errno;
6552 return;
6554 #else
6555 pid = wait (&w);
6556 #endif /* no WNOHANG */
6558 /* Find the process that signaled us, and record its status. */
6560 /* The process can have been deleted by Fdelete_process. */
6561 for (tail = deleted_pid_list; GC_CONSP (tail); tail = XCDR (tail))
6563 Lisp_Object xpid = XCAR (tail);
6564 if ((GC_INTEGERP (xpid) && pid == (pid_t) XINT (xpid))
6565 || (GC_FLOATP (xpid) && pid == (pid_t) XFLOAT_DATA (xpid)))
6567 XSETCAR (tail, Qnil);
6568 goto sigchld_end_of_loop;
6572 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6573 p = 0;
6574 for (tail = Vprocess_alist; GC_CONSP (tail); tail = XCDR (tail))
6576 proc = XCDR (XCAR (tail));
6577 p = XPROCESS (proc);
6578 if (GC_EQ (p->childp, Qt) && p->pid == pid)
6579 break;
6580 p = 0;
6583 /* Look for an asynchronous process whose pid hasn't been filled
6584 in yet. */
6585 if (p == 0)
6586 for (tail = Vprocess_alist; GC_CONSP (tail); tail = XCDR (tail))
6588 proc = XCDR (XCAR (tail));
6589 p = XPROCESS (proc);
6590 if (p->pid == -1)
6591 break;
6592 p = 0;
6595 /* Change the status of the process that was found. */
6596 if (p != 0)
6598 union { int i; WAITTYPE wt; } u;
6599 int clear_desc_flag = 0;
6601 p->tick = ++process_tick;
6602 u.wt = w;
6603 p->raw_status = u.i;
6604 p->raw_status_new = 1;
6606 /* If process has terminated, stop waiting for its output. */
6607 if ((WIFSIGNALED (w) || WIFEXITED (w))
6608 && p->infd >= 0)
6609 clear_desc_flag = 1;
6611 /* We use clear_desc_flag to avoid a compiler bug in Microsoft C. */
6612 if (clear_desc_flag)
6614 FD_CLR (p->infd, &input_wait_mask);
6615 FD_CLR (p->infd, &non_keyboard_wait_mask);
6618 /* Tell wait_reading_process_output that it needs to wake up and
6619 look around. */
6620 if (input_available_clear_time)
6621 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
6624 /* There was no asynchronous process found for that pid: we have
6625 a synchronous process. */
6626 else
6628 synch_process_alive = 0;
6630 /* Report the status of the synchronous process. */
6631 if (WIFEXITED (w))
6632 synch_process_retcode = WRETCODE (w);
6633 else if (WIFSIGNALED (w))
6634 synch_process_termsig = WTERMSIG (w);
6636 /* Tell wait_reading_process_output that it needs to wake up and
6637 look around. */
6638 if (input_available_clear_time)
6639 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
6642 sigchld_end_of_loop:
6645 /* On some systems, we must return right away.
6646 If any more processes want to signal us, we will
6647 get another signal.
6648 Otherwise (on systems that have WNOHANG), loop around
6649 to use up all the processes that have something to tell us. */
6650 #if (defined WINDOWSNT \
6651 || (defined USG && !defined GNU_LINUX \
6652 && !(defined HPUX && defined WNOHANG)))
6653 #if defined (USG) && ! defined (POSIX_SIGNALS)
6654 signal (signo, sigchld_handler);
6655 #endif
6656 errno = old_errno;
6657 return;
6658 #endif /* USG, but not HPUX with WNOHANG */
6661 #endif /* SIGCHLD */
6664 static Lisp_Object
6665 exec_sentinel_unwind (data)
6666 Lisp_Object data;
6668 XPROCESS (XCAR (data))->sentinel = XCDR (data);
6669 return Qnil;
6672 static Lisp_Object
6673 exec_sentinel_error_handler (error)
6674 Lisp_Object error;
6676 cmd_error_internal (error, "error in process sentinel: ");
6677 Vinhibit_quit = Qt;
6678 update_echo_area ();
6679 Fsleep_for (make_number (2), Qnil);
6680 return Qt;
6683 static void
6684 exec_sentinel (proc, reason)
6685 Lisp_Object proc, reason;
6687 Lisp_Object sentinel, obuffer, odeactivate, okeymap;
6688 register struct Lisp_Process *p = XPROCESS (proc);
6689 int count = SPECPDL_INDEX ();
6690 int outer_running_asynch_code = running_asynch_code;
6691 int waiting = waiting_for_user_input_p;
6693 if (inhibit_sentinels)
6694 return;
6696 /* No need to gcpro these, because all we do with them later
6697 is test them for EQness, and none of them should be a string. */
6698 odeactivate = Vdeactivate_mark;
6699 XSETBUFFER (obuffer, current_buffer);
6700 okeymap = current_buffer->keymap;
6702 sentinel = p->sentinel;
6703 if (NILP (sentinel))
6704 return;
6706 /* Zilch the sentinel while it's running, to avoid recursive invocations;
6707 assure that it gets restored no matter how the sentinel exits. */
6708 p->sentinel = Qnil;
6709 record_unwind_protect (exec_sentinel_unwind, Fcons (proc, sentinel));
6710 /* Inhibit quit so that random quits don't screw up a running filter. */
6711 specbind (Qinhibit_quit, Qt);
6712 specbind (Qlast_nonmenu_event, Qt);
6714 /* In case we get recursively called,
6715 and we already saved the match data nonrecursively,
6716 save the same match data in safely recursive fashion. */
6717 if (outer_running_asynch_code)
6719 Lisp_Object tem;
6720 tem = Fmatch_data (Qnil, Qnil, Qnil);
6721 restore_search_regs ();
6722 record_unwind_save_match_data ();
6723 Fset_match_data (tem, Qt);
6726 /* For speed, if a search happens within this code,
6727 save the match data in a special nonrecursive fashion. */
6728 running_asynch_code = 1;
6730 internal_condition_case_1 (read_process_output_call,
6731 Fcons (sentinel,
6732 Fcons (proc, Fcons (reason, Qnil))),
6733 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6734 exec_sentinel_error_handler);
6736 /* If we saved the match data nonrecursively, restore it now. */
6737 restore_search_regs ();
6738 running_asynch_code = outer_running_asynch_code;
6740 Vdeactivate_mark = odeactivate;
6742 /* Restore waiting_for_user_input_p as it was
6743 when we were called, in case the filter clobbered it. */
6744 waiting_for_user_input_p = waiting;
6746 #if 0
6747 if (! EQ (Fcurrent_buffer (), obuffer)
6748 || ! EQ (current_buffer->keymap, okeymap))
6749 #endif
6750 /* But do it only if the caller is actually going to read events.
6751 Otherwise there's no need to make him wake up, and it could
6752 cause trouble (for example it would make sit_for return). */
6753 if (waiting_for_user_input_p == -1)
6754 record_asynch_buffer_change ();
6756 unbind_to (count, Qnil);
6759 /* Report all recent events of a change in process status
6760 (either run the sentinel or output a message).
6761 This is usually done while Emacs is waiting for keyboard input
6762 but can be done at other times. */
6764 static void
6765 status_notify (deleting_process)
6766 struct Lisp_Process *deleting_process;
6768 register Lisp_Object proc, buffer;
6769 Lisp_Object tail, msg;
6770 struct gcpro gcpro1, gcpro2;
6772 tail = Qnil;
6773 msg = Qnil;
6774 /* We need to gcpro tail; if read_process_output calls a filter
6775 which deletes a process and removes the cons to which tail points
6776 from Vprocess_alist, and then causes a GC, tail is an unprotected
6777 reference. */
6778 GCPRO2 (tail, msg);
6780 /* Set this now, so that if new processes are created by sentinels
6781 that we run, we get called again to handle their status changes. */
6782 update_tick = process_tick;
6784 for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
6786 Lisp_Object symbol;
6787 register struct Lisp_Process *p;
6789 proc = Fcdr (Fcar (tail));
6790 p = XPROCESS (proc);
6792 if (p->tick != p->update_tick)
6794 p->update_tick = p->tick;
6796 /* If process is still active, read any output that remains. */
6797 while (! EQ (p->filter, Qt)
6798 && ! EQ (p->status, Qconnect)
6799 && ! EQ (p->status, Qlisten)
6800 && ! EQ (p->command, Qt) /* Network process not stopped. */
6801 && p->infd >= 0
6802 && p != deleting_process
6803 && read_process_output (proc, p->infd) > 0);
6805 buffer = p->buffer;
6807 /* Get the text to use for the message. */
6808 if (p->raw_status_new)
6809 update_status (p);
6810 msg = status_message (p);
6812 /* If process is terminated, deactivate it or delete it. */
6813 symbol = p->status;
6814 if (CONSP (p->status))
6815 symbol = XCAR (p->status);
6817 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6818 || EQ (symbol, Qclosed))
6820 if (delete_exited_processes)
6821 remove_process (proc);
6822 else
6823 deactivate_process (proc);
6826 /* The actions above may have further incremented p->tick.
6827 So set p->update_tick again
6828 so that an error in the sentinel will not cause
6829 this code to be run again. */
6830 p->update_tick = p->tick;
6831 /* Now output the message suitably. */
6832 if (!NILP (p->sentinel))
6833 exec_sentinel (proc, msg);
6834 /* Don't bother with a message in the buffer
6835 when a process becomes runnable. */
6836 else if (!EQ (symbol, Qrun) && !NILP (buffer))
6838 Lisp_Object ro, tem;
6839 struct buffer *old = current_buffer;
6840 int opoint, opoint_byte;
6841 int before, before_byte;
6843 ro = XBUFFER (buffer)->read_only;
6845 /* Avoid error if buffer is deleted
6846 (probably that's why the process is dead, too) */
6847 if (NILP (XBUFFER (buffer)->name))
6848 continue;
6849 Fset_buffer (buffer);
6851 opoint = PT;
6852 opoint_byte = PT_BYTE;
6853 /* Insert new output into buffer
6854 at the current end-of-output marker,
6855 thus preserving logical ordering of input and output. */
6856 if (XMARKER (p->mark)->buffer)
6857 Fgoto_char (p->mark);
6858 else
6859 SET_PT_BOTH (ZV, ZV_BYTE);
6861 before = PT;
6862 before_byte = PT_BYTE;
6864 tem = current_buffer->read_only;
6865 current_buffer->read_only = Qnil;
6866 insert_string ("\nProcess ");
6867 Finsert (1, &p->name);
6868 insert_string (" ");
6869 Finsert (1, &msg);
6870 current_buffer->read_only = tem;
6871 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6873 if (opoint >= before)
6874 SET_PT_BOTH (opoint + (PT - before),
6875 opoint_byte + (PT_BYTE - before_byte));
6876 else
6877 SET_PT_BOTH (opoint, opoint_byte);
6879 set_buffer_internal (old);
6882 } /* end for */
6884 update_mode_lines++; /* in case buffers use %s in mode-line-format */
6885 redisplay_preserve_echo_area (13);
6887 UNGCPRO;
6891 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6892 Sset_process_coding_system, 1, 3, 0,
6893 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6894 DECODING will be used to decode subprocess output and ENCODING to
6895 encode subprocess input. */)
6896 (process, decoding, encoding)
6897 register Lisp_Object process, decoding, encoding;
6899 register struct Lisp_Process *p;
6901 CHECK_PROCESS (process);
6902 p = XPROCESS (process);
6903 if (p->infd < 0)
6904 error ("Input file descriptor of %s closed", SDATA (p->name));
6905 if (p->outfd < 0)
6906 error ("Output file descriptor of %s closed", SDATA (p->name));
6907 Fcheck_coding_system (decoding);
6908 Fcheck_coding_system (encoding);
6910 p->decode_coding_system = decoding;
6911 p->encode_coding_system = encoding;
6912 setup_process_coding_systems (process);
6914 return Qnil;
6917 DEFUN ("process-coding-system",
6918 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6919 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6920 (process)
6921 register Lisp_Object process;
6923 CHECK_PROCESS (process);
6924 return Fcons (XPROCESS (process)->decode_coding_system,
6925 XPROCESS (process)->encode_coding_system);
6928 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6929 Sset_process_filter_multibyte, 2, 2, 0,
6930 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6931 If FLAG is non-nil, the filter is given multibyte strings.
6932 If FLAG is nil, the filter is given unibyte strings. In this case,
6933 all character code conversion except for end-of-line conversion is
6934 suppressed. */)
6935 (process, flag)
6936 Lisp_Object process, flag;
6938 register struct Lisp_Process *p;
6940 CHECK_PROCESS (process);
6941 p = XPROCESS (process);
6942 p->filter_multibyte = !NILP (flag);
6943 setup_process_coding_systems (process);
6945 return Qnil;
6948 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6949 Sprocess_filter_multibyte_p, 1, 1, 0,
6950 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6951 (process)
6952 Lisp_Object process;
6954 register struct Lisp_Process *p;
6956 CHECK_PROCESS (process);
6957 p = XPROCESS (process);
6959 return (p->filter_multibyte ? Qt : Qnil);
6964 /* Add DESC to the set of keyboard input descriptors. */
6966 void
6967 add_keyboard_wait_descriptor (desc)
6968 int desc;
6970 FD_SET (desc, &input_wait_mask);
6971 FD_SET (desc, &non_process_wait_mask);
6972 if (desc > max_keyboard_desc)
6973 max_keyboard_desc = desc;
6976 static int add_gpm_wait_descriptor_called_flag;
6978 void
6979 add_gpm_wait_descriptor (desc)
6980 int desc;
6982 if (! add_gpm_wait_descriptor_called_flag)
6983 FD_CLR (0, &input_wait_mask);
6984 add_gpm_wait_descriptor_called_flag = 1;
6985 FD_SET (desc, &input_wait_mask);
6986 FD_SET (desc, &gpm_wait_mask);
6987 if (desc > max_gpm_desc)
6988 max_gpm_desc = desc;
6991 /* From now on, do not expect DESC to give keyboard input. */
6993 void
6994 delete_keyboard_wait_descriptor (desc)
6995 int desc;
6997 int fd;
6998 int lim = max_keyboard_desc;
7000 FD_CLR (desc, &input_wait_mask);
7001 FD_CLR (desc, &non_process_wait_mask);
7003 if (desc == max_keyboard_desc)
7004 for (fd = 0; fd < lim; fd++)
7005 if (FD_ISSET (fd, &input_wait_mask)
7006 && !FD_ISSET (fd, &non_keyboard_wait_mask)
7007 && !FD_ISSET (fd, &gpm_wait_mask))
7008 max_keyboard_desc = fd;
7011 void
7012 delete_gpm_wait_descriptor (desc)
7013 int desc;
7015 int fd;
7016 int lim = max_gpm_desc;
7018 FD_CLR (desc, &input_wait_mask);
7019 FD_CLR (desc, &non_process_wait_mask);
7021 if (desc == max_gpm_desc)
7022 for (fd = 0; fd < lim; fd++)
7023 if (FD_ISSET (fd, &input_wait_mask)
7024 && !FD_ISSET (fd, &non_keyboard_wait_mask)
7025 && !FD_ISSET (fd, &non_process_wait_mask))
7026 max_gpm_desc = fd;
7029 /* Return nonzero if *MASK has a bit set
7030 that corresponds to one of the keyboard input descriptors. */
7032 static int
7033 keyboard_bit_set (mask)
7034 SELECT_TYPE *mask;
7036 int fd;
7038 for (fd = 0; fd <= max_keyboard_desc; fd++)
7039 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
7040 && !FD_ISSET (fd, &non_keyboard_wait_mask))
7041 return 1;
7043 return 0;
7046 void
7047 init_process ()
7049 register int i;
7051 inhibit_sentinels = 0;
7053 #ifdef SIGCHLD
7054 #ifndef CANNOT_DUMP
7055 if (! noninteractive || initialized)
7056 #endif
7057 signal (SIGCHLD, sigchld_handler);
7058 #endif
7060 FD_ZERO (&input_wait_mask);
7061 FD_ZERO (&non_keyboard_wait_mask);
7062 FD_ZERO (&non_process_wait_mask);
7063 max_process_desc = 0;
7065 #ifdef NON_BLOCKING_CONNECT
7066 FD_ZERO (&connect_wait_mask);
7067 num_pending_connects = 0;
7068 #endif
7070 #ifdef ADAPTIVE_READ_BUFFERING
7071 process_output_delay_count = 0;
7072 process_output_skip = 0;
7073 #endif
7075 /* Don't do this, it caused infinite select loops. The display
7076 method should call add_keyboard_wait_descriptor on stdin if it
7077 needs that. */
7078 #if 0
7079 FD_SET (0, &input_wait_mask);
7080 #endif
7082 Vprocess_alist = Qnil;
7083 #ifdef SIGCHLD
7084 deleted_pid_list = Qnil;
7085 #endif
7086 for (i = 0; i < MAXDESC; i++)
7088 chan_process[i] = Qnil;
7089 proc_buffered_char[i] = -1;
7091 bzero (proc_decode_coding_system, sizeof proc_decode_coding_system);
7092 bzero (proc_encode_coding_system, sizeof proc_encode_coding_system);
7093 #ifdef DATAGRAM_SOCKETS
7094 bzero (datagram_address, sizeof datagram_address);
7095 #endif
7097 #ifdef HAVE_SOCKETS
7099 Lisp_Object subfeatures = Qnil;
7100 struct socket_options *sopt;
7102 #define ADD_SUBFEATURE(key, val) \
7103 subfeatures = Fcons (Fcons (key, Fcons (val, Qnil)), subfeatures)
7105 #ifdef NON_BLOCKING_CONNECT
7106 ADD_SUBFEATURE (QCnowait, Qt);
7107 #endif
7108 #ifdef DATAGRAM_SOCKETS
7109 ADD_SUBFEATURE (QCtype, Qdatagram);
7110 #endif
7111 #ifdef HAVE_LOCAL_SOCKETS
7112 ADD_SUBFEATURE (QCfamily, Qlocal);
7113 #endif
7114 ADD_SUBFEATURE (QCfamily, Qipv4);
7115 #ifdef AF_INET6
7116 ADD_SUBFEATURE (QCfamily, Qipv6);
7117 #endif
7118 #ifdef HAVE_GETSOCKNAME
7119 ADD_SUBFEATURE (QCservice, Qt);
7120 #endif
7121 #if !defined(TERM) && (defined(O_NONBLOCK) || defined(O_NDELAY))
7122 ADD_SUBFEATURE (QCserver, Qt);
7123 #endif
7125 for (sopt = socket_options; sopt->name; sopt++)
7126 subfeatures = Fcons (intern (sopt->name), subfeatures);
7128 Fprovide (intern ("make-network-process"), subfeatures);
7130 #endif /* HAVE_SOCKETS */
7132 #if defined (DARWIN) || defined (MAC_OSX)
7133 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7134 processes. As such, we only change the default value. */
7135 if (initialized)
7137 char *release = get_operating_system_release();
7138 if (!release || !release[0] || (release[0] < MIN_PTY_KERNEL_VERSION
7139 && release[1] == '.')) {
7140 Vprocess_connection_type = Qnil;
7143 #endif
7146 void
7147 syms_of_process ()
7149 Qprocessp = intern ("processp");
7150 staticpro (&Qprocessp);
7151 Qrun = intern ("run");
7152 staticpro (&Qrun);
7153 Qstop = intern ("stop");
7154 staticpro (&Qstop);
7155 Qsignal = intern ("signal");
7156 staticpro (&Qsignal);
7158 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7159 here again.
7161 Qexit = intern ("exit");
7162 staticpro (&Qexit); */
7164 Qopen = intern ("open");
7165 staticpro (&Qopen);
7166 Qclosed = intern ("closed");
7167 staticpro (&Qclosed);
7168 Qconnect = intern ("connect");
7169 staticpro (&Qconnect);
7170 Qfailed = intern ("failed");
7171 staticpro (&Qfailed);
7172 Qlisten = intern ("listen");
7173 staticpro (&Qlisten);
7174 Qlocal = intern ("local");
7175 staticpro (&Qlocal);
7176 Qipv4 = intern ("ipv4");
7177 staticpro (&Qipv4);
7178 #ifdef AF_INET6
7179 Qipv6 = intern ("ipv6");
7180 staticpro (&Qipv6);
7181 #endif
7182 Qdatagram = intern ("datagram");
7183 staticpro (&Qdatagram);
7185 QCname = intern (":name");
7186 staticpro (&QCname);
7187 QCbuffer = intern (":buffer");
7188 staticpro (&QCbuffer);
7189 QChost = intern (":host");
7190 staticpro (&QChost);
7191 QCservice = intern (":service");
7192 staticpro (&QCservice);
7193 QCtype = intern (":type");
7194 staticpro (&QCtype);
7195 QClocal = intern (":local");
7196 staticpro (&QClocal);
7197 QCremote = intern (":remote");
7198 staticpro (&QCremote);
7199 QCcoding = intern (":coding");
7200 staticpro (&QCcoding);
7201 QCserver = intern (":server");
7202 staticpro (&QCserver);
7203 QCnowait = intern (":nowait");
7204 staticpro (&QCnowait);
7205 QCsentinel = intern (":sentinel");
7206 staticpro (&QCsentinel);
7207 QClog = intern (":log");
7208 staticpro (&QClog);
7209 QCnoquery = intern (":noquery");
7210 staticpro (&QCnoquery);
7211 QCstop = intern (":stop");
7212 staticpro (&QCstop);
7213 QCoptions = intern (":options");
7214 staticpro (&QCoptions);
7215 QCplist = intern (":plist");
7216 staticpro (&QCplist);
7217 QCfilter_multibyte = intern (":filter-multibyte");
7218 staticpro (&QCfilter_multibyte);
7220 Qlast_nonmenu_event = intern ("last-nonmenu-event");
7221 staticpro (&Qlast_nonmenu_event);
7223 staticpro (&Vprocess_alist);
7224 #ifdef SIGCHLD
7225 staticpro (&deleted_pid_list);
7226 #endif
7228 DEFVAR_BOOL ("delete-exited-processes", &delete_exited_processes,
7229 doc: /* *Non-nil means delete processes immediately when they exit.
7230 A value of nil means don't delete them until `list-processes' is run. */);
7232 delete_exited_processes = 1;
7234 DEFVAR_LISP ("process-connection-type", &Vprocess_connection_type,
7235 doc: /* Control type of device used to communicate with subprocesses.
7236 Values are nil to use a pipe, or t or `pty' to use a pty.
7237 The value has no effect if the system has no ptys or if all ptys are busy:
7238 then a pipe is used in any case.
7239 The value takes effect when `start-process' is called. */);
7240 Vprocess_connection_type = Qt;
7242 #ifdef ADAPTIVE_READ_BUFFERING
7243 DEFVAR_LISP ("process-adaptive-read-buffering", &Vprocess_adaptive_read_buffering,
7244 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7245 On some systems, when Emacs reads the output from a subprocess, the output data
7246 is read in very small blocks, potentially resulting in very poor performance.
7247 This behavior can be remedied to some extent by setting this variable to a
7248 non-nil value, as it will automatically delay reading from such processes, to
7249 allow them to produce more output before Emacs tries to read it.
7250 If the value is t, the delay is reset after each write to the process; any other
7251 non-nil value means that the delay is not reset on write.
7252 The variable takes effect when `start-process' is called. */);
7253 Vprocess_adaptive_read_buffering = Qt;
7254 #endif
7256 defsubr (&Sprocessp);
7257 defsubr (&Sget_process);
7258 defsubr (&Sget_buffer_process);
7259 defsubr (&Sdelete_process);
7260 defsubr (&Sprocess_status);
7261 defsubr (&Sprocess_exit_status);
7262 defsubr (&Sprocess_id);
7263 defsubr (&Sprocess_name);
7264 defsubr (&Sprocess_tty_name);
7265 defsubr (&Sprocess_command);
7266 defsubr (&Sset_process_buffer);
7267 defsubr (&Sprocess_buffer);
7268 defsubr (&Sprocess_mark);
7269 defsubr (&Sset_process_filter);
7270 defsubr (&Sprocess_filter);
7271 defsubr (&Sset_process_sentinel);
7272 defsubr (&Sprocess_sentinel);
7273 defsubr (&Sset_process_window_size);
7274 defsubr (&Sset_process_inherit_coding_system_flag);
7275 defsubr (&Sprocess_inherit_coding_system_flag);
7276 defsubr (&Sset_process_query_on_exit_flag);
7277 defsubr (&Sprocess_query_on_exit_flag);
7278 defsubr (&Sprocess_contact);
7279 defsubr (&Sprocess_plist);
7280 defsubr (&Sset_process_plist);
7281 defsubr (&Slist_processes);
7282 defsubr (&Sprocess_list);
7283 defsubr (&Sstart_process);
7284 #ifdef HAVE_SOCKETS
7285 defsubr (&Sset_network_process_option);
7286 defsubr (&Smake_network_process);
7287 defsubr (&Sformat_network_address);
7288 #endif /* HAVE_SOCKETS */
7289 #if defined(HAVE_SOCKETS) && defined(HAVE_NET_IF_H) && defined(HAVE_SYS_IOCTL_H)
7290 #ifdef SIOCGIFCONF
7291 defsubr (&Snetwork_interface_list);
7292 #endif
7293 #if defined(SIOCGIFADDR) || defined(SIOCGIFHWADDR) || defined(SIOCGIFFLAGS)
7294 defsubr (&Snetwork_interface_info);
7295 #endif
7296 #endif /* HAVE_SOCKETS ... */
7297 #ifdef DATAGRAM_SOCKETS
7298 defsubr (&Sprocess_datagram_address);
7299 defsubr (&Sset_process_datagram_address);
7300 #endif
7301 defsubr (&Saccept_process_output);
7302 defsubr (&Sprocess_send_region);
7303 defsubr (&Sprocess_send_string);
7304 defsubr (&Sinterrupt_process);
7305 defsubr (&Skill_process);
7306 defsubr (&Squit_process);
7307 defsubr (&Sstop_process);
7308 defsubr (&Scontinue_process);
7309 defsubr (&Sprocess_running_child_p);
7310 defsubr (&Sprocess_send_eof);
7311 defsubr (&Ssignal_process);
7312 defsubr (&Swaiting_for_user_input_p);
7313 /* defsubr (&Sprocess_connection); */
7314 defsubr (&Sset_process_coding_system);
7315 defsubr (&Sprocess_coding_system);
7316 defsubr (&Sset_process_filter_multibyte);
7317 defsubr (&Sprocess_filter_multibyte_p);
7321 #else /* not subprocesses */
7323 #include <sys/types.h>
7324 #include <errno.h>
7326 #include "lisp.h"
7327 #include "systime.h"
7328 #include "charset.h"
7329 #include "coding.h"
7330 #include "termopts.h"
7331 #include "sysselect.h"
7333 extern int frame_garbaged;
7335 extern EMACS_TIME timer_check ();
7336 extern int timers_run;
7338 Lisp_Object QCtype;
7340 /* As described above, except assuming that there are no subprocesses:
7342 Wait for timeout to elapse and/or keyboard input to be available.
7344 time_limit is:
7345 timeout in seconds, or
7346 zero for no limit, or
7347 -1 means gobble data immediately available but don't wait for any.
7349 read_kbd is a Lisp_Object:
7350 0 to ignore keyboard input, or
7351 1 to return when input is available, or
7352 -1 means caller will actually read the input, so don't throw to
7353 the quit handler.
7355 see full version for other parameters. We know that wait_proc will
7356 always be NULL, since `subprocesses' isn't defined.
7358 do_display != 0 means redisplay should be done to show subprocess
7359 output that arrives.
7361 Return true if we received input from any process. */
7364 wait_reading_process_output (time_limit, microsecs, read_kbd, do_display,
7365 wait_for_cell, wait_proc, just_wait_proc)
7366 int time_limit, microsecs, read_kbd, do_display;
7367 Lisp_Object wait_for_cell;
7368 struct Lisp_Process *wait_proc;
7369 int just_wait_proc;
7371 register int nfds;
7372 EMACS_TIME end_time, timeout;
7373 SELECT_TYPE waitchannels;
7374 int xerrno;
7376 /* What does time_limit really mean? */
7377 if (time_limit || microsecs)
7379 EMACS_GET_TIME (end_time);
7380 EMACS_SET_SECS_USECS (timeout, time_limit, microsecs);
7381 EMACS_ADD_TIME (end_time, end_time, timeout);
7384 /* Turn off periodic alarms (in case they are in use)
7385 and then turn off any other atimers,
7386 because the select emulator uses alarms. */
7387 stop_polling ();
7388 turn_on_atimers (0);
7390 while (1)
7392 int timeout_reduced_for_timers = 0;
7394 /* If calling from keyboard input, do not quit
7395 since we want to return C-g as an input character.
7396 Otherwise, do pending quit if requested. */
7397 if (read_kbd >= 0)
7398 QUIT;
7400 /* Exit now if the cell we're waiting for became non-nil. */
7401 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7402 break;
7404 /* Compute time from now till when time limit is up */
7405 /* Exit if already run out */
7406 if (time_limit == -1)
7408 /* -1 specified for timeout means
7409 gobble output available now
7410 but don't wait at all. */
7412 EMACS_SET_SECS_USECS (timeout, 0, 0);
7414 else if (time_limit || microsecs)
7416 EMACS_GET_TIME (timeout);
7417 EMACS_SUB_TIME (timeout, end_time, timeout);
7418 if (EMACS_TIME_NEG_P (timeout))
7419 break;
7421 else
7423 EMACS_SET_SECS_USECS (timeout, 100000, 0);
7426 /* If our caller will not immediately handle keyboard events,
7427 run timer events directly.
7428 (Callers that will immediately read keyboard events
7429 call timer_delay on their own.) */
7430 if (NILP (wait_for_cell))
7432 EMACS_TIME timer_delay;
7436 int old_timers_run = timers_run;
7437 timer_delay = timer_check (1);
7438 if (timers_run != old_timers_run && do_display)
7439 /* We must retry, since a timer may have requeued itself
7440 and that could alter the time delay. */
7441 redisplay_preserve_echo_area (14);
7442 else
7443 break;
7445 while (!detect_input_pending ());
7447 /* If there is unread keyboard input, also return. */
7448 if (read_kbd != 0
7449 && requeued_events_pending_p ())
7450 break;
7452 if (! EMACS_TIME_NEG_P (timer_delay) && time_limit != -1)
7454 EMACS_TIME difference;
7455 EMACS_SUB_TIME (difference, timer_delay, timeout);
7456 if (EMACS_TIME_NEG_P (difference))
7458 timeout = timer_delay;
7459 timeout_reduced_for_timers = 1;
7464 /* Cause C-g and alarm signals to take immediate action,
7465 and cause input available signals to zero out timeout. */
7466 if (read_kbd < 0)
7467 set_waiting_for_input (&timeout);
7469 /* Wait till there is something to do. */
7471 if (! read_kbd && NILP (wait_for_cell))
7472 FD_ZERO (&waitchannels);
7473 else
7474 FD_SET (0, &waitchannels);
7476 /* If a frame has been newly mapped and needs updating,
7477 reprocess its display stuff. */
7478 if (frame_garbaged && do_display)
7480 clear_waiting_for_input ();
7481 redisplay_preserve_echo_area (15);
7482 if (read_kbd < 0)
7483 set_waiting_for_input (&timeout);
7486 if (read_kbd && detect_input_pending ())
7488 nfds = 0;
7489 FD_ZERO (&waitchannels);
7491 else
7492 nfds = select (1, &waitchannels, (SELECT_TYPE *)0, (SELECT_TYPE *)0,
7493 &timeout);
7495 xerrno = errno;
7497 /* Make C-g and alarm signals set flags again */
7498 clear_waiting_for_input ();
7500 /* If we woke up due to SIGWINCH, actually change size now. */
7501 do_pending_window_change (0);
7503 if (time_limit && nfds == 0 && ! timeout_reduced_for_timers)
7504 /* We waited the full specified time, so return now. */
7505 break;
7507 if (nfds == -1)
7509 /* If the system call was interrupted, then go around the
7510 loop again. */
7511 if (xerrno == EINTR)
7512 FD_ZERO (&waitchannels);
7513 else
7514 error ("select error: %s", emacs_strerror (xerrno));
7516 #ifdef sun
7517 else if (nfds > 0 && (waitchannels & 1) && interrupt_input)
7518 /* System sometimes fails to deliver SIGIO. */
7519 kill (getpid (), SIGIO);
7520 #endif
7521 #ifdef SIGIO
7522 if (read_kbd && interrupt_input && (waitchannels & 1))
7523 kill (getpid (), SIGIO);
7524 #endif
7526 /* Check for keyboard input */
7528 if (read_kbd
7529 && detect_input_pending_run_timers (do_display))
7531 swallow_events (do_display);
7532 if (detect_input_pending_run_timers (do_display))
7533 break;
7536 /* If there is unread keyboard input, also return. */
7537 if (read_kbd
7538 && requeued_events_pending_p ())
7539 break;
7541 /* If wait_for_cell. check for keyboard input
7542 but don't run any timers.
7543 ??? (It seems wrong to me to check for keyboard
7544 input at all when wait_for_cell, but the code
7545 has been this way since July 1994.
7546 Try changing this after version 19.31.) */
7547 if (! NILP (wait_for_cell)
7548 && detect_input_pending ())
7550 swallow_events (do_display);
7551 if (detect_input_pending ())
7552 break;
7555 /* Exit now if the cell we're waiting for became non-nil. */
7556 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7557 break;
7560 start_polling ();
7562 return 0;
7566 /* Don't confuse make-docfile by having two doc strings for this function.
7567 make-docfile does not pay attention to #if, for good reason! */
7568 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
7570 (name)
7571 register Lisp_Object name;
7573 return Qnil;
7576 /* Don't confuse make-docfile by having two doc strings for this function.
7577 make-docfile does not pay attention to #if, for good reason! */
7578 DEFUN ("process-inherit-coding-system-flag",
7579 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
7580 1, 1, 0,
7582 (process)
7583 register Lisp_Object process;
7585 /* Ignore the argument and return the value of
7586 inherit-process-coding-system. */
7587 return inherit_process_coding_system ? Qt : Qnil;
7590 /* Kill all processes associated with `buffer'.
7591 If `buffer' is nil, kill all processes.
7592 Since we have no subprocesses, this does nothing. */
7594 void
7595 kill_buffer_processes (buffer)
7596 Lisp_Object buffer;
7600 void
7601 init_process ()
7605 void
7606 syms_of_process ()
7608 QCtype = intern (":type");
7609 staticpro (&QCtype);
7611 defsubr (&Sget_buffer_process);
7612 defsubr (&Sprocess_inherit_coding_system_flag);
7616 #endif /* not subprocesses */
7618 /* arch-tag: 3706c011-7b9a-4117-bd4f-59e7f701a4c4
7619 (do not change this comment) */