* textmodes/reftex-vars.el (reftex-label-alist): Docfix.
[emacs.git] / src / process.c
blob2d2a1b5ac0e9be03c4b27dcc83ffbb93e1b2040b
1 /* Asynchronous subprocess control for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2012
4 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 of the License, or
11 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <errno.h>
26 #include <setjmp.h>
27 #include <sys/types.h> /* Some typedefs are used in sys/file.h. */
28 #include <sys/file.h>
29 #include <sys/stat.h>
30 #include <setjmp.h>
32 #include <unistd.h>
33 #include <fcntl.h>
35 #include "lisp.h"
37 /* Only MS-DOS does not define `subprocesses'. */
38 #ifdef subprocesses
40 #include <sys/socket.h>
41 #include <netdb.h>
42 #include <netinet/in.h>
43 #include <arpa/inet.h>
45 /* Are local (unix) sockets supported? */
46 #if defined (HAVE_SYS_UN_H)
47 #if !defined (AF_LOCAL) && defined (AF_UNIX)
48 #define AF_LOCAL AF_UNIX
49 #endif
50 #ifdef AF_LOCAL
51 #define HAVE_LOCAL_SOCKETS
52 #include <sys/un.h>
53 #endif
54 #endif
56 #include <sys/ioctl.h>
57 #if defined (HAVE_NET_IF_H)
58 #include <net/if.h>
59 #endif /* HAVE_NET_IF_H */
61 #if defined (HAVE_IFADDRS_H)
62 /* Must be after net/if.h */
63 #include <ifaddrs.h>
65 /* We only use structs from this header when we use getifaddrs. */
66 #if defined (HAVE_NET_IF_DL_H)
67 #include <net/if_dl.h>
68 #endif
70 #endif
72 #ifdef NEED_BSDTTY
73 #include <bsdtty.h>
74 #endif
76 #ifdef HAVE_RES_INIT
77 #include <netinet/in.h>
78 #include <arpa/nameser.h>
79 #include <resolv.h>
80 #endif
82 #ifdef HAVE_UTIL_H
83 #include <util.h>
84 #endif
86 #ifdef HAVE_PTY_H
87 #include <pty.h>
88 #endif
90 #endif /* subprocesses */
92 #include "systime.h"
93 #include "systty.h"
95 #include "window.h"
96 #include "character.h"
97 #include "buffer.h"
98 #include "coding.h"
99 #include "process.h"
100 #include "frame.h"
101 #include "termhooks.h"
102 #include "termopts.h"
103 #include "commands.h"
104 #include "keyboard.h"
105 #include "blockinput.h"
106 #include "dispextern.h"
107 #include "composite.h"
108 #include "atimer.h"
109 #include "sysselect.h"
110 #include "syssignal.h"
111 #include "syswait.h"
112 #ifdef HAVE_GNUTLS
113 #include "gnutls.h"
114 #endif
116 #if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
117 #include "xgselect.h"
118 #endif
119 #ifdef HAVE_NS
120 #include "nsterm.h"
121 #endif
123 /* Work around GCC 4.7.0 bug with strict overflow checking; see
124 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
125 These lines can be removed once the GCC bug is fixed. */
126 #if (__GNUC__ == 4 && 3 <= __GNUC_MINOR__) || 4 < __GNUC__
127 # pragma GCC diagnostic ignored "-Wstrict-overflow"
128 #endif
130 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
131 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
132 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
133 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
134 Lisp_Object QCname, QCtype;
136 /* Non-zero if keyboard input is on hold, zero otherwise. */
138 static int kbd_is_on_hold;
140 /* Nonzero means don't run process sentinels. This is used
141 when exiting. */
142 int inhibit_sentinels;
144 #ifdef subprocesses
146 Lisp_Object Qprocessp;
147 static Lisp_Object Qrun, Qstop, Qsignal;
148 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
149 Lisp_Object Qlocal;
150 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
151 static Lisp_Object Qreal, Qnetwork, Qserial;
152 #ifdef AF_INET6
153 static Lisp_Object Qipv6;
154 #endif
155 static Lisp_Object QCport, QCprocess;
156 Lisp_Object QCspeed;
157 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
158 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
159 static Lisp_Object QCbuffer, QChost, QCservice;
160 static Lisp_Object QClocal, QCremote, QCcoding;
161 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
162 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
163 static Lisp_Object Qlast_nonmenu_event;
164 /* QCfamily is declared and initialized in xfaces.c,
165 QCfilter in keyboard.c. */
166 extern Lisp_Object QCfamily, QCfilter;
168 /* Qexit is declared and initialized in eval.c. */
170 /* QCfamily is defined in xfaces.c. */
171 extern Lisp_Object QCfamily;
172 /* QCfilter is defined in keyboard.c. */
173 extern Lisp_Object QCfilter;
175 #define NETCONN_P(p) (EQ (PVAR (XPROCESS (p), type), Qnetwork))
176 #define NETCONN1_P(p) (EQ (PVAR (p, type), Qnetwork))
177 #define SERIALCONN_P(p) (EQ (PVAR (XPROCESS (p), type), Qserial))
178 #define SERIALCONN1_P(p) (EQ (PVAR (p, type), Qserial))
180 #ifndef HAVE_H_ERRNO
181 extern int h_errno;
182 #endif
184 /* Number of events of change of status of a process. */
185 static EMACS_INT process_tick;
186 /* Number of events for which the user or sentinel has been notified. */
187 static EMACS_INT update_tick;
189 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
191 /* Only W32 has this, it really means that select can't take write mask. */
192 #ifdef BROKEN_NON_BLOCKING_CONNECT
193 #undef NON_BLOCKING_CONNECT
194 #define SELECT_CANT_DO_WRITE_MASK
195 #else
196 #ifndef NON_BLOCKING_CONNECT
197 #ifdef HAVE_SELECT
198 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
199 #if defined (O_NONBLOCK) || defined (O_NDELAY)
200 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
201 #define NON_BLOCKING_CONNECT
202 #endif /* EWOULDBLOCK || EINPROGRESS */
203 #endif /* O_NONBLOCK || O_NDELAY */
204 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
205 #endif /* HAVE_SELECT */
206 #endif /* NON_BLOCKING_CONNECT */
207 #endif /* BROKEN_NON_BLOCKING_CONNECT */
209 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
210 this system. We need to read full packets, so we need a
211 "non-destructive" select. So we require either native select,
212 or emulation of select using FIONREAD. */
214 #ifdef BROKEN_DATAGRAM_SOCKETS
215 #undef DATAGRAM_SOCKETS
216 #else
217 #ifndef DATAGRAM_SOCKETS
218 #if defined (HAVE_SELECT) || defined (FIONREAD)
219 #if defined (HAVE_SENDTO) && defined (HAVE_RECVFROM) && defined (EMSGSIZE)
220 #define DATAGRAM_SOCKETS
221 #endif /* HAVE_SENDTO && HAVE_RECVFROM && EMSGSIZE */
222 #endif /* HAVE_SELECT || FIONREAD */
223 #endif /* DATAGRAM_SOCKETS */
224 #endif /* BROKEN_DATAGRAM_SOCKETS */
226 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
227 # define HAVE_SEQPACKET
228 #endif
230 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
231 #define ADAPTIVE_READ_BUFFERING
232 #endif
234 #ifdef ADAPTIVE_READ_BUFFERING
235 #define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
236 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
237 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
239 /* Number of processes which have a non-zero read_output_delay,
240 and therefore might be delayed for adaptive read buffering. */
242 static int process_output_delay_count;
244 /* Non-zero if any process has non-nil read_output_skip. */
246 static int process_output_skip;
248 #else
249 #define process_output_delay_count 0
250 #endif
252 static void create_process (Lisp_Object, char **, Lisp_Object);
253 #ifdef SIGIO
254 static int keyboard_bit_set (SELECT_TYPE *);
255 #endif
256 static void deactivate_process (Lisp_Object);
257 static void status_notify (struct Lisp_Process *);
258 static int read_process_output (Lisp_Object, int);
259 static void create_pty (Lisp_Object);
261 /* If we support a window system, turn on the code to poll periodically
262 to detect C-g. It isn't actually used when doing interrupt input. */
263 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
264 #define POLL_FOR_INPUT
265 #endif
267 static Lisp_Object get_process (register Lisp_Object name);
268 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
270 /* Mask of bits indicating the descriptors that we wait for input on. */
272 static SELECT_TYPE input_wait_mask;
274 /* Mask that excludes keyboard input descriptor(s). */
276 static SELECT_TYPE non_keyboard_wait_mask;
278 /* Mask that excludes process input descriptor(s). */
280 static SELECT_TYPE non_process_wait_mask;
282 /* Mask for selecting for write. */
284 static SELECT_TYPE write_mask;
286 #ifdef NON_BLOCKING_CONNECT
287 /* Mask of bits indicating the descriptors that we wait for connect to
288 complete on. Once they complete, they are removed from this mask
289 and added to the input_wait_mask and non_keyboard_wait_mask. */
291 static SELECT_TYPE connect_wait_mask;
293 /* Number of bits set in connect_wait_mask. */
294 static int num_pending_connects;
295 #endif /* NON_BLOCKING_CONNECT */
297 /* The largest descriptor currently in use for a process object. */
298 static int max_process_desc;
300 /* The largest descriptor currently in use for input. */
301 static int max_input_desc;
303 /* Indexed by descriptor, gives the process (if any) for that descriptor */
304 static Lisp_Object chan_process[MAXDESC];
306 /* Alist of elements (NAME . PROCESS) */
307 static Lisp_Object Vprocess_alist;
309 /* Buffered-ahead input char from process, indexed by channel.
310 -1 means empty (no char is buffered).
311 Used on sys V where the only way to tell if there is any
312 output from the process is to read at least one char.
313 Always -1 on systems that support FIONREAD. */
315 static int proc_buffered_char[MAXDESC];
317 /* Table of `struct coding-system' for each process. */
318 static struct coding_system *proc_decode_coding_system[MAXDESC];
319 static struct coding_system *proc_encode_coding_system[MAXDESC];
321 #ifdef DATAGRAM_SOCKETS
322 /* Table of `partner address' for datagram sockets. */
323 static struct sockaddr_and_len {
324 struct sockaddr *sa;
325 int len;
326 } datagram_address[MAXDESC];
327 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
328 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
329 #else
330 #define DATAGRAM_CHAN_P(chan) (0)
331 #define DATAGRAM_CONN_P(proc) (0)
332 #endif
334 /* Maximum number of bytes to send to a pty without an eof. */
335 static int pty_max_bytes;
339 static struct fd_callback_data
341 fd_callback func;
342 void *data;
343 #define FOR_READ 1
344 #define FOR_WRITE 2
345 int condition; /* mask of the defines above. */
346 } fd_callback_info[MAXDESC];
349 /* Add a file descriptor FD to be monitored for when read is possible.
350 When read is possible, call FUNC with argument DATA. */
352 void
353 add_read_fd (int fd, fd_callback func, void *data)
355 eassert (fd < MAXDESC);
356 add_keyboard_wait_descriptor (fd);
358 fd_callback_info[fd].func = func;
359 fd_callback_info[fd].data = data;
360 fd_callback_info[fd].condition |= FOR_READ;
363 /* Stop monitoring file descriptor FD for when read is possible. */
365 void
366 delete_read_fd (int fd)
368 eassert (fd < MAXDESC);
369 delete_keyboard_wait_descriptor (fd);
371 fd_callback_info[fd].condition &= ~FOR_READ;
372 if (fd_callback_info[fd].condition == 0)
374 fd_callback_info[fd].func = 0;
375 fd_callback_info[fd].data = 0;
379 /* Add a file descriptor FD to be monitored for when write is possible.
380 When write is possible, call FUNC with argument DATA. */
382 void
383 add_write_fd (int fd, fd_callback func, void *data)
385 eassert (fd < MAXDESC);
386 FD_SET (fd, &write_mask);
387 if (fd > max_input_desc)
388 max_input_desc = fd;
390 fd_callback_info[fd].func = func;
391 fd_callback_info[fd].data = data;
392 fd_callback_info[fd].condition |= FOR_WRITE;
395 /* Stop monitoring file descriptor FD for when write is possible. */
397 void
398 delete_write_fd (int fd)
400 int lim = max_input_desc;
402 eassert (fd < MAXDESC);
403 FD_CLR (fd, &write_mask);
404 fd_callback_info[fd].condition &= ~FOR_WRITE;
405 if (fd_callback_info[fd].condition == 0)
407 fd_callback_info[fd].func = 0;
408 fd_callback_info[fd].data = 0;
410 if (fd == max_input_desc)
411 for (fd = lim; fd >= 0; fd--)
412 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
414 max_input_desc = fd;
415 break;
422 /* Compute the Lisp form of the process status, p->status, from
423 the numeric status that was returned by `wait'. */
425 static Lisp_Object status_convert (int);
427 static void
428 update_status (struct Lisp_Process *p)
430 eassert (p->raw_status_new);
431 PVAR (p, status) = status_convert (p->raw_status);
432 p->raw_status_new = 0;
435 /* Convert a process status word in Unix format to
436 the list that we use internally. */
438 static Lisp_Object
439 status_convert (int w)
441 if (WIFSTOPPED (w))
442 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
443 else if (WIFEXITED (w))
444 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
445 WCOREDUMP (w) ? Qt : Qnil));
446 else if (WIFSIGNALED (w))
447 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
448 WCOREDUMP (w) ? Qt : Qnil));
449 else
450 return Qrun;
453 /* Given a status-list, extract the three pieces of information
454 and store them individually through the three pointers. */
456 static void
457 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
459 Lisp_Object tem;
461 if (SYMBOLP (l))
463 *symbol = l;
464 *code = 0;
465 *coredump = 0;
467 else
469 *symbol = XCAR (l);
470 tem = XCDR (l);
471 *code = XFASTINT (XCAR (tem));
472 tem = XCDR (tem);
473 *coredump = !NILP (tem);
477 /* Return a string describing a process status list. */
479 static Lisp_Object
480 status_message (struct Lisp_Process *p)
482 Lisp_Object status = PVAR (p, status);
483 Lisp_Object symbol;
484 int code, coredump;
485 Lisp_Object string, string2;
487 decode_status (status, &symbol, &code, &coredump);
489 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
491 char *signame;
492 synchronize_system_messages_locale ();
493 signame = strsignal (code);
494 if (signame == 0)
495 string = build_string ("unknown");
496 else
498 int c1, c2;
500 string = build_unibyte_string (signame);
501 if (! NILP (Vlocale_coding_system))
502 string = (code_convert_string_norecord
503 (string, Vlocale_coding_system, 0));
504 c1 = STRING_CHAR (SDATA (string));
505 c2 = downcase (c1);
506 if (c1 != c2)
507 Faset (string, make_number (0), make_number (c2));
509 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
510 return concat2 (string, string2);
512 else if (EQ (symbol, Qexit))
514 if (NETCONN1_P (p))
515 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
516 if (code == 0)
517 return build_string ("finished\n");
518 string = Fnumber_to_string (make_number (code));
519 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
520 return concat3 (build_string ("exited abnormally with code "),
521 string, string2);
523 else if (EQ (symbol, Qfailed))
525 string = Fnumber_to_string (make_number (code));
526 string2 = build_string ("\n");
527 return concat3 (build_string ("failed with code "),
528 string, string2);
530 else
531 return Fcopy_sequence (Fsymbol_name (symbol));
534 #ifdef HAVE_PTYS
536 /* The file name of the pty opened by allocate_pty. */
537 static char pty_name[24];
539 /* Open an available pty, returning a file descriptor.
540 Return -1 on failure.
541 The file name of the terminal corresponding to the pty
542 is left in the variable pty_name. */
544 static int
545 allocate_pty (void)
547 int fd;
549 #ifdef PTY_ITERATION
550 PTY_ITERATION
551 #else
552 register int c, i;
553 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
554 for (i = 0; i < 16; i++)
555 #endif
557 #ifdef PTY_NAME_SPRINTF
558 PTY_NAME_SPRINTF
559 #else
560 sprintf (pty_name, "/dev/pty%c%x", c, i);
561 #endif /* no PTY_NAME_SPRINTF */
563 #ifdef PTY_OPEN
564 PTY_OPEN;
565 #else /* no PTY_OPEN */
567 { /* Some systems name their pseudoterminals so that there are gaps in
568 the usual sequence - for example, on HP9000/S700 systems, there
569 are no pseudoterminals with names ending in 'f'. So we wait for
570 three failures in a row before deciding that we've reached the
571 end of the ptys. */
572 int failed_count = 0;
573 struct stat stb;
575 if (stat (pty_name, &stb) < 0)
577 failed_count++;
578 if (failed_count >= 3)
579 return -1;
581 else
582 failed_count = 0;
584 # ifdef O_NONBLOCK
585 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
586 # else
587 fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
588 # endif
590 #endif /* no PTY_OPEN */
592 if (fd >= 0)
594 /* check to make certain that both sides are available
595 this avoids a nasty yet stupid bug in rlogins */
596 #ifdef PTY_TTY_NAME_SPRINTF
597 PTY_TTY_NAME_SPRINTF
598 #else
599 sprintf (pty_name, "/dev/tty%c%x", c, i);
600 #endif /* no PTY_TTY_NAME_SPRINTF */
601 if (access (pty_name, 6) != 0)
603 emacs_close (fd);
604 # ifndef __sgi
605 continue;
606 # else
607 return -1;
608 # endif /* __sgi */
610 setup_pty (fd);
611 return fd;
614 return -1;
616 #endif /* HAVE_PTYS */
618 static Lisp_Object
619 make_process (Lisp_Object name)
621 register Lisp_Object val, tem, name1;
622 register struct Lisp_Process *p;
623 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
624 printmax_t i;
626 p = allocate_process ();
627 /* Initialize Lisp data. Note that allocate_process initializes all
628 Lisp data to nil, so do it only for slots which should not be nil. */
629 PVAR (p, status) = Qrun;
630 PVAR (p, mark) = Fmake_marker ();
632 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
633 non-Lisp data, so do it only for slots which should not be zero. */
634 p->infd = -1;
635 p->outfd = -1;
637 #ifdef HAVE_GNUTLS
638 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
639 #endif
641 /* If name is already in use, modify it until it is unused. */
643 name1 = name;
644 for (i = 1; ; i++)
646 tem = Fget_process (name1);
647 if (NILP (tem)) break;
648 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
650 name = name1;
651 PVAR (p, name) = name;
652 XSETPROCESS (val, p);
653 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
654 return val;
657 static void
658 remove_process (register Lisp_Object proc)
660 register Lisp_Object pair;
662 pair = Frassq (proc, Vprocess_alist);
663 Vprocess_alist = Fdelq (pair, Vprocess_alist);
665 deactivate_process (proc);
669 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
670 doc: /* Return t if OBJECT is a process. */)
671 (Lisp_Object object)
673 return PROCESSP (object) ? Qt : Qnil;
676 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
677 doc: /* Return the process named NAME, or nil if there is none. */)
678 (register Lisp_Object name)
680 if (PROCESSP (name))
681 return name;
682 CHECK_STRING (name);
683 return Fcdr (Fassoc (name, Vprocess_alist));
686 /* This is how commands for the user decode process arguments. It
687 accepts a process, a process name, a buffer, a buffer name, or nil.
688 Buffers denote the first process in the buffer, and nil denotes the
689 current buffer. */
691 static Lisp_Object
692 get_process (register Lisp_Object name)
694 register Lisp_Object proc, obj;
695 if (STRINGP (name))
697 obj = Fget_process (name);
698 if (NILP (obj))
699 obj = Fget_buffer (name);
700 if (NILP (obj))
701 error ("Process %s does not exist", SDATA (name));
703 else if (NILP (name))
704 obj = Fcurrent_buffer ();
705 else
706 obj = name;
708 /* Now obj should be either a buffer object or a process object.
710 if (BUFFERP (obj))
712 proc = Fget_buffer_process (obj);
713 if (NILP (proc))
714 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
716 else
718 CHECK_PROCESS (obj);
719 proc = obj;
721 return proc;
725 #ifdef SIGCHLD
726 /* Fdelete_process promises to immediately forget about the process, but in
727 reality, Emacs needs to remember those processes until they have been
728 treated by sigchld_handler; otherwise this handler would consider the
729 process as being synchronous and say that the synchronous process is
730 dead. */
731 static Lisp_Object deleted_pid_list;
732 #endif
734 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
735 doc: /* Delete PROCESS: kill it and forget about it immediately.
736 PROCESS may be a process, a buffer, the name of a process or buffer, or
737 nil, indicating the current buffer's process. */)
738 (register Lisp_Object process)
740 register struct Lisp_Process *p;
742 process = get_process (process);
743 p = XPROCESS (process);
745 p->raw_status_new = 0;
746 if (NETCONN1_P (p) || SERIALCONN1_P (p))
748 PVAR (p, status) = Fcons (Qexit, Fcons (make_number (0), Qnil));
749 p->tick = ++process_tick;
750 status_notify (p);
751 redisplay_preserve_echo_area (13);
753 else if (p->infd >= 0)
755 #ifdef SIGCHLD
756 Lisp_Object symbol;
757 pid_t pid = p->pid;
759 /* No problem storing the pid here, as it is still in Vprocess_alist. */
760 deleted_pid_list = Fcons (make_fixnum_or_float (pid),
761 /* GC treated elements set to nil. */
762 Fdelq (Qnil, deleted_pid_list));
763 /* If the process has already signaled, remove it from the list. */
764 if (p->raw_status_new)
765 update_status (p);
766 symbol = PVAR (p, status);
767 if (CONSP (PVAR (p, status)))
768 symbol = XCAR (PVAR (p, status));
769 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
770 deleted_pid_list
771 = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
772 else
773 #endif
775 Fkill_process (process, Qnil);
776 /* Do this now, since remove_process will make sigchld_handler do nothing. */
777 PVAR (p, status)
778 = Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
779 p->tick = ++process_tick;
780 status_notify (p);
781 redisplay_preserve_echo_area (13);
784 remove_process (process);
785 return Qnil;
788 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
789 doc: /* Return the status of PROCESS.
790 The returned value is one of the following symbols:
791 run -- for a process that is running.
792 stop -- for a process stopped but continuable.
793 exit -- for a process that has exited.
794 signal -- for a process that has got a fatal signal.
795 open -- for a network stream connection that is open.
796 listen -- for a network stream server that is listening.
797 closed -- for a network stream connection that is closed.
798 connect -- when waiting for a non-blocking connection to complete.
799 failed -- when a non-blocking connection has failed.
800 nil -- if arg is a process name and no such process exists.
801 PROCESS may be a process, a buffer, the name of a process, or
802 nil, indicating the current buffer's process. */)
803 (register Lisp_Object process)
805 register struct Lisp_Process *p;
806 register Lisp_Object status;
808 if (STRINGP (process))
809 process = Fget_process (process);
810 else
811 process = get_process (process);
813 if (NILP (process))
814 return process;
816 p = XPROCESS (process);
817 if (p->raw_status_new)
818 update_status (p);
819 status = PVAR (p, status);
820 if (CONSP (status))
821 status = XCAR (status);
822 if (NETCONN1_P (p) || SERIALCONN1_P (p))
824 if (EQ (status, Qexit))
825 status = Qclosed;
826 else if (EQ (PVAR (p, command), Qt))
827 status = Qstop;
828 else if (EQ (status, Qrun))
829 status = Qopen;
831 return status;
834 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
835 1, 1, 0,
836 doc: /* Return the exit status of PROCESS or the signal number that killed it.
837 If PROCESS has not yet exited or died, return 0. */)
838 (register Lisp_Object process)
840 CHECK_PROCESS (process);
841 if (XPROCESS (process)->raw_status_new)
842 update_status (XPROCESS (process));
843 if (CONSP (PVAR (XPROCESS (process), status)))
844 return XCAR (XCDR (PVAR (XPROCESS (process), status)));
845 return make_number (0);
848 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
849 doc: /* Return the process id of PROCESS.
850 This is the pid of the external process which PROCESS uses or talks to.
851 For a network connection, this value is nil. */)
852 (register Lisp_Object process)
854 pid_t pid;
856 CHECK_PROCESS (process);
857 pid = XPROCESS (process)->pid;
858 return (pid ? make_fixnum_or_float (pid) : Qnil);
861 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
862 doc: /* Return the name of PROCESS, as a string.
863 This is the name of the program invoked in PROCESS,
864 possibly modified to make it unique among process names. */)
865 (register Lisp_Object process)
867 CHECK_PROCESS (process);
868 return PVAR (XPROCESS (process), name);
871 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
872 doc: /* Return the command that was executed to start PROCESS.
873 This is a list of strings, the first string being the program executed
874 and the rest of the strings being the arguments given to it.
875 For a network or serial process, this is nil (process is running) or t
876 \(process is stopped). */)
877 (register Lisp_Object process)
879 CHECK_PROCESS (process);
880 return PVAR (XPROCESS (process), command);
883 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
884 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
885 This is the terminal that the process itself reads and writes on,
886 not the name of the pty that Emacs uses to talk with that terminal. */)
887 (register Lisp_Object process)
889 CHECK_PROCESS (process);
890 return PVAR (XPROCESS (process), tty_name);
893 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
894 2, 2, 0,
895 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
896 Return BUFFER. */)
897 (register Lisp_Object process, Lisp_Object buffer)
899 struct Lisp_Process *p;
901 CHECK_PROCESS (process);
902 if (!NILP (buffer))
903 CHECK_BUFFER (buffer);
904 p = XPROCESS (process);
905 PVAR (p, buffer) = buffer;
906 if (NETCONN1_P (p) || SERIALCONN1_P (p))
907 PVAR (p, childp) = Fplist_put (PVAR (p, childp), QCbuffer, buffer);
908 setup_process_coding_systems (process);
909 return buffer;
912 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
913 1, 1, 0,
914 doc: /* Return the buffer PROCESS is associated with.
915 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
916 (register Lisp_Object process)
918 CHECK_PROCESS (process);
919 return PVAR (XPROCESS (process), buffer);
922 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
923 1, 1, 0,
924 doc: /* Return the marker for the end of the last output from PROCESS. */)
925 (register Lisp_Object process)
927 CHECK_PROCESS (process);
928 return PVAR (XPROCESS (process), mark);
931 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
932 2, 2, 0,
933 doc: /* Give PROCESS the filter function FILTER; nil means no filter.
934 A value of t means stop accepting output from the process.
936 When a process has a filter, its buffer is not used for output.
937 Instead, each time it does output, the entire string of output is
938 passed to the filter.
940 The filter gets two arguments: the process and the string of output.
941 The string argument is normally a multibyte string, except:
942 - if the process' input coding system is no-conversion or raw-text,
943 it is a unibyte string (the non-converted input), or else
944 - if `default-enable-multibyte-characters' is nil, it is a unibyte
945 string (the result of converting the decoded input multibyte
946 string to unibyte with `string-make-unibyte'). */)
947 (register Lisp_Object process, Lisp_Object filter)
949 struct Lisp_Process *p;
951 CHECK_PROCESS (process);
952 p = XPROCESS (process);
954 /* Don't signal an error if the process' input file descriptor
955 is closed. This could make debugging Lisp more difficult,
956 for example when doing something like
958 (setq process (start-process ...))
959 (debug)
960 (set-process-filter process ...) */
962 if (p->infd >= 0)
964 if (EQ (filter, Qt) && !EQ (PVAR (p, status), Qlisten))
966 FD_CLR (p->infd, &input_wait_mask);
967 FD_CLR (p->infd, &non_keyboard_wait_mask);
969 else if (EQ (PVAR (p, filter), Qt)
970 /* Network or serial process not stopped: */
971 && !EQ (PVAR (p, command), Qt))
973 FD_SET (p->infd, &input_wait_mask);
974 FD_SET (p->infd, &non_keyboard_wait_mask);
978 PVAR (p, filter) = filter;
979 if (NETCONN1_P (p) || SERIALCONN1_P (p))
980 PVAR (p, childp) = Fplist_put (PVAR (p, childp), QCfilter, filter);
981 setup_process_coding_systems (process);
982 return filter;
985 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
986 1, 1, 0,
987 doc: /* Returns the filter function of PROCESS; nil if none.
988 See `set-process-filter' for more info on filter functions. */)
989 (register Lisp_Object process)
991 CHECK_PROCESS (process);
992 return PVAR (XPROCESS (process), filter);
995 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
996 2, 2, 0,
997 doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
998 The sentinel is called as a function when the process changes state.
999 It gets two arguments: the process, and a string describing the change. */)
1000 (register Lisp_Object process, Lisp_Object sentinel)
1002 struct Lisp_Process *p;
1004 CHECK_PROCESS (process);
1005 p = XPROCESS (process);
1007 PVAR (p, sentinel) = sentinel;
1008 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1009 PVAR (p, childp) = Fplist_put (PVAR (p, childp), QCsentinel, sentinel);
1010 return sentinel;
1013 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1014 1, 1, 0,
1015 doc: /* Return the sentinel of PROCESS; nil if none.
1016 See `set-process-sentinel' for more info on sentinels. */)
1017 (register Lisp_Object process)
1019 CHECK_PROCESS (process);
1020 return PVAR (XPROCESS (process), sentinel);
1023 DEFUN ("set-process-window-size", Fset_process_window_size,
1024 Sset_process_window_size, 3, 3, 0,
1025 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1026 (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1028 CHECK_PROCESS (process);
1029 CHECK_RANGED_INTEGER (height, 0, INT_MAX);
1030 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
1032 if (XPROCESS (process)->infd < 0
1033 || set_window_size (XPROCESS (process)->infd,
1034 XINT (height), XINT (width)) <= 0)
1035 return Qnil;
1036 else
1037 return Qt;
1040 DEFUN ("set-process-inherit-coding-system-flag",
1041 Fset_process_inherit_coding_system_flag,
1042 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1043 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1044 If the second argument FLAG is non-nil, then the variable
1045 `buffer-file-coding-system' of the buffer associated with PROCESS
1046 will be bound to the value of the coding system used to decode
1047 the process output.
1049 This is useful when the coding system specified for the process buffer
1050 leaves either the character code conversion or the end-of-line conversion
1051 unspecified, or if the coding system used to decode the process output
1052 is more appropriate for saving the process buffer.
1054 Binding the variable `inherit-process-coding-system' to non-nil before
1055 starting the process is an alternative way of setting the inherit flag
1056 for the process which will run.
1058 This function returns FLAG. */)
1059 (register Lisp_Object process, Lisp_Object flag)
1061 CHECK_PROCESS (process);
1062 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1063 return flag;
1066 DEFUN ("set-process-query-on-exit-flag",
1067 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1068 2, 2, 0,
1069 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1070 If the second argument FLAG is non-nil, Emacs will query the user before
1071 exiting or killing a buffer if PROCESS is running. This function
1072 returns FLAG. */)
1073 (register Lisp_Object process, Lisp_Object flag)
1075 CHECK_PROCESS (process);
1076 XPROCESS (process)->kill_without_query = NILP (flag);
1077 return flag;
1080 DEFUN ("process-query-on-exit-flag",
1081 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1082 1, 1, 0,
1083 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1084 (register Lisp_Object process)
1086 CHECK_PROCESS (process);
1087 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1090 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1091 1, 2, 0,
1092 doc: /* Return the contact info of PROCESS; t for a real child.
1093 For a network or serial connection, the value depends on the optional
1094 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1095 SERVICE) for a network connection or (PORT SPEED) for a serial
1096 connection. If KEY is t, the complete contact information for the
1097 connection is returned, else the specific value for the keyword KEY is
1098 returned. See `make-network-process' or `make-serial-process' for a
1099 list of keywords. */)
1100 (register Lisp_Object process, Lisp_Object key)
1102 Lisp_Object contact;
1104 CHECK_PROCESS (process);
1105 contact = PVAR (XPROCESS (process), childp);
1107 #ifdef DATAGRAM_SOCKETS
1108 if (DATAGRAM_CONN_P (process)
1109 && (EQ (key, Qt) || EQ (key, QCremote)))
1110 contact = Fplist_put (contact, QCremote,
1111 Fprocess_datagram_address (process));
1112 #endif
1114 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1115 return contact;
1116 if (NILP (key) && NETCONN_P (process))
1117 return Fcons (Fplist_get (contact, QChost),
1118 Fcons (Fplist_get (contact, QCservice), Qnil));
1119 if (NILP (key) && SERIALCONN_P (process))
1120 return Fcons (Fplist_get (contact, QCport),
1121 Fcons (Fplist_get (contact, QCspeed), Qnil));
1122 return Fplist_get (contact, key);
1125 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1126 1, 1, 0,
1127 doc: /* Return the plist of PROCESS. */)
1128 (register Lisp_Object process)
1130 CHECK_PROCESS (process);
1131 return PVAR (XPROCESS (process), plist);
1134 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1135 2, 2, 0,
1136 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1137 (register Lisp_Object process, Lisp_Object plist)
1139 CHECK_PROCESS (process);
1140 CHECK_LIST (plist);
1142 PVAR (XPROCESS (process), plist) = plist;
1143 return plist;
1146 #if 0 /* Turned off because we don't currently record this info
1147 in the process. Perhaps add it. */
1148 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1149 doc: /* Return the connection type of PROCESS.
1150 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1151 a socket connection. */)
1152 (Lisp_Object process)
1154 return PVAR (XPROCESS (process), type);
1156 #endif
1158 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1159 doc: /* Return the connection type of PROCESS.
1160 The value is either the symbol `real', `network', or `serial'.
1161 PROCESS may be a process, a buffer, the name of a process or buffer, or
1162 nil, indicating the current buffer's process. */)
1163 (Lisp_Object process)
1165 Lisp_Object proc;
1166 proc = get_process (process);
1167 return PVAR (XPROCESS (proc), type);
1170 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1171 1, 2, 0,
1172 doc: /* Convert network ADDRESS from internal format to a string.
1173 A 4 or 5 element vector represents an IPv4 address (with port number).
1174 An 8 or 9 element vector represents an IPv6 address (with port number).
1175 If optional second argument OMIT-PORT is non-nil, don't include a port
1176 number in the string, even when present in ADDRESS.
1177 Returns nil if format of ADDRESS is invalid. */)
1178 (Lisp_Object address, Lisp_Object omit_port)
1180 if (NILP (address))
1181 return Qnil;
1183 if (STRINGP (address)) /* AF_LOCAL */
1184 return address;
1186 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1188 register struct Lisp_Vector *p = XVECTOR (address);
1189 ptrdiff_t size = p->header.size;
1190 Lisp_Object args[10];
1191 int nargs, i;
1193 if (size == 4 || (size == 5 && !NILP (omit_port)))
1195 args[0] = build_string ("%d.%d.%d.%d");
1196 nargs = 4;
1198 else if (size == 5)
1200 args[0] = build_string ("%d.%d.%d.%d:%d");
1201 nargs = 5;
1203 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1205 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1206 nargs = 8;
1208 else if (size == 9)
1210 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1211 nargs = 9;
1213 else
1214 return Qnil;
1216 for (i = 0; i < nargs; i++)
1218 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1219 return Qnil;
1221 if (nargs <= 5 /* IPv4 */
1222 && i < 4 /* host, not port */
1223 && XINT (p->contents[i]) > 255)
1224 return Qnil;
1226 args[i+1] = p->contents[i];
1229 return Fformat (nargs+1, args);
1232 if (CONSP (address))
1234 Lisp_Object args[2];
1235 args[0] = build_string ("<Family %d>");
1236 args[1] = Fcar (address);
1237 return Fformat (2, args);
1240 return Qnil;
1243 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1244 doc: /* Return a list of all processes. */)
1245 (void)
1247 return Fmapcar (Qcdr, Vprocess_alist);
1250 /* Starting asynchronous inferior processes. */
1252 static Lisp_Object start_process_unwind (Lisp_Object proc);
1254 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1255 doc: /* Start a program in a subprocess. Return the process object for it.
1256 NAME is name for process. It is modified if necessary to make it unique.
1257 BUFFER is the buffer (or buffer name) to associate with the process.
1259 Process output (both standard output and standard error streams) goes
1260 at end of BUFFER, unless you specify an output stream or filter
1261 function to handle the output. BUFFER may also be nil, meaning that
1262 this process is not associated with any buffer.
1264 PROGRAM is the program file name. It is searched for in `exec-path'
1265 (which see). If nil, just associate a pty with the buffer. Remaining
1266 arguments are strings to give program as arguments.
1268 If you want to separate standard output from standard error, invoke
1269 the command through a shell and redirect one of them using the shell
1270 syntax.
1272 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1273 (ptrdiff_t nargs, Lisp_Object *args)
1275 Lisp_Object buffer, name, program, proc, current_dir, tem;
1276 register unsigned char **new_argv;
1277 ptrdiff_t i;
1278 ptrdiff_t count = SPECPDL_INDEX ();
1280 buffer = args[1];
1281 if (!NILP (buffer))
1282 buffer = Fget_buffer_create (buffer);
1284 /* Make sure that the child will be able to chdir to the current
1285 buffer's current directory, or its unhandled equivalent. We
1286 can't just have the child check for an error when it does the
1287 chdir, since it's in a vfork.
1289 We have to GCPRO around this because Fexpand_file_name and
1290 Funhandled_file_name_directory might call a file name handling
1291 function. The argument list is protected by the caller, so all
1292 we really have to worry about is buffer. */
1294 struct gcpro gcpro1, gcpro2;
1296 current_dir = BVAR (current_buffer, directory);
1298 GCPRO2 (buffer, current_dir);
1300 current_dir = Funhandled_file_name_directory (current_dir);
1301 if (NILP (current_dir))
1302 /* If the file name handler says that current_dir is unreachable, use
1303 a sensible default. */
1304 current_dir = build_string ("~/");
1305 current_dir = expand_and_dir_to_file (current_dir, Qnil);
1306 if (NILP (Ffile_accessible_directory_p (current_dir)))
1307 report_file_error ("Setting current directory",
1308 Fcons (BVAR (current_buffer, directory), Qnil));
1310 UNGCPRO;
1313 name = args[0];
1314 CHECK_STRING (name);
1316 program = args[2];
1318 if (!NILP (program))
1319 CHECK_STRING (program);
1321 proc = make_process (name);
1322 /* If an error occurs and we can't start the process, we want to
1323 remove it from the process list. This means that each error
1324 check in create_process doesn't need to call remove_process
1325 itself; it's all taken care of here. */
1326 record_unwind_protect (start_process_unwind, proc);
1328 PVAR (XPROCESS (proc), childp) = Qt;
1329 PVAR (XPROCESS (proc), plist) = Qnil;
1330 PVAR (XPROCESS (proc), type) = Qreal;
1331 PVAR (XPROCESS (proc), buffer) = buffer;
1332 PVAR (XPROCESS (proc), sentinel) = Qnil;
1333 PVAR (XPROCESS (proc), filter) = Qnil;
1334 PVAR (XPROCESS (proc), command) = Flist (nargs - 2, args + 2);
1336 #ifdef HAVE_GNUTLS
1337 /* AKA GNUTLS_INITSTAGE(proc). */
1338 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1339 XPROCESS (proc)->gnutls_cred_type = Qnil;
1340 #endif
1342 #ifdef ADAPTIVE_READ_BUFFERING
1343 XPROCESS (proc)->adaptive_read_buffering
1344 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1345 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1346 #endif
1348 /* Make the process marker point into the process buffer (if any). */
1349 if (BUFFERP (buffer))
1350 set_marker_both (PVAR (XPROCESS (proc), mark), buffer,
1351 BUF_ZV (XBUFFER (buffer)),
1352 BUF_ZV_BYTE (XBUFFER (buffer)));
1355 /* Decide coding systems for communicating with the process. Here
1356 we don't setup the structure coding_system nor pay attention to
1357 unibyte mode. They are done in create_process. */
1359 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1360 Lisp_Object coding_systems = Qt;
1361 Lisp_Object val, *args2;
1362 struct gcpro gcpro1, gcpro2;
1364 val = Vcoding_system_for_read;
1365 if (NILP (val))
1367 args2 = alloca ((nargs + 1) * sizeof *args2);
1368 args2[0] = Qstart_process;
1369 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1370 GCPRO2 (proc, current_dir);
1371 if (!NILP (program))
1372 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1373 UNGCPRO;
1374 if (CONSP (coding_systems))
1375 val = XCAR (coding_systems);
1376 else if (CONSP (Vdefault_process_coding_system))
1377 val = XCAR (Vdefault_process_coding_system);
1379 PVAR (XPROCESS (proc), decode_coding_system) = val;
1381 val = Vcoding_system_for_write;
1382 if (NILP (val))
1384 if (EQ (coding_systems, Qt))
1386 args2 = alloca ((nargs + 1) * sizeof *args2);
1387 args2[0] = Qstart_process;
1388 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1389 GCPRO2 (proc, current_dir);
1390 if (!NILP (program))
1391 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1392 UNGCPRO;
1394 if (CONSP (coding_systems))
1395 val = XCDR (coding_systems);
1396 else if (CONSP (Vdefault_process_coding_system))
1397 val = XCDR (Vdefault_process_coding_system);
1399 PVAR (XPROCESS (proc), encode_coding_system) = val;
1400 /* Note: At this moment, the above coding system may leave
1401 text-conversion or eol-conversion unspecified. They will be
1402 decided after we read output from the process and decode it by
1403 some coding system, or just before we actually send a text to
1404 the process. */
1408 PVAR (XPROCESS (proc), decoding_buf) = empty_unibyte_string;
1409 XPROCESS (proc)->decoding_carryover = 0;
1410 PVAR (XPROCESS (proc), encoding_buf) = empty_unibyte_string;
1412 XPROCESS (proc)->inherit_coding_system_flag
1413 = !(NILP (buffer) || !inherit_process_coding_system);
1415 if (!NILP (program))
1417 /* If program file name is not absolute, search our path for it.
1418 Put the name we will really use in TEM. */
1419 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1420 && !(SCHARS (program) > 1
1421 && IS_DEVICE_SEP (SREF (program, 1))))
1423 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1425 tem = Qnil;
1426 GCPRO4 (name, program, buffer, current_dir);
1427 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1428 UNGCPRO;
1429 if (NILP (tem))
1430 report_file_error ("Searching for program", Fcons (program, Qnil));
1431 tem = Fexpand_file_name (tem, Qnil);
1433 else
1435 if (!NILP (Ffile_directory_p (program)))
1436 error ("Specified program for new process is a directory");
1437 tem = program;
1440 /* If program file name starts with /: for quoting a magic name,
1441 discard that. */
1442 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1443 && SREF (tem, 1) == ':')
1444 tem = Fsubstring (tem, make_number (2), Qnil);
1447 Lisp_Object arg_encoding = Qnil;
1448 struct gcpro gcpro1;
1449 GCPRO1 (tem);
1451 /* Encode the file name and put it in NEW_ARGV.
1452 That's where the child will use it to execute the program. */
1453 tem = Fcons (ENCODE_FILE (tem), Qnil);
1455 /* Here we encode arguments by the coding system used for sending
1456 data to the process. We don't support using different coding
1457 systems for encoding arguments and for encoding data sent to the
1458 process. */
1460 for (i = 3; i < nargs; i++)
1462 tem = Fcons (args[i], tem);
1463 CHECK_STRING (XCAR (tem));
1464 if (STRING_MULTIBYTE (XCAR (tem)))
1466 if (NILP (arg_encoding))
1467 arg_encoding = (complement_process_encoding_system
1468 (PVAR (XPROCESS (proc), encode_coding_system)));
1469 XSETCAR (tem,
1470 code_convert_string_norecord
1471 (XCAR (tem), arg_encoding, 1));
1475 UNGCPRO;
1478 /* Now that everything is encoded we can collect the strings into
1479 NEW_ARGV. */
1480 new_argv = alloca ((nargs - 1) * sizeof *new_argv);
1481 new_argv[nargs - 2] = 0;
1483 for (i = nargs - 2; i-- != 0; )
1485 new_argv[i] = SDATA (XCAR (tem));
1486 tem = XCDR (tem);
1489 create_process (proc, (char **) new_argv, current_dir);
1491 else
1492 create_pty (proc);
1494 return unbind_to (count, proc);
1497 /* This function is the unwind_protect form for Fstart_process. If
1498 PROC doesn't have its pid set, then we know someone has signaled
1499 an error and the process wasn't started successfully, so we should
1500 remove it from the process list. */
1501 static Lisp_Object
1502 start_process_unwind (Lisp_Object proc)
1504 if (!PROCESSP (proc))
1505 abort ();
1507 /* Was PROC started successfully?
1508 -2 is used for a pty with no process, eg for gdb. */
1509 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1510 remove_process (proc);
1512 return Qnil;
1515 static void
1516 create_process_1 (struct atimer *timer)
1518 /* Nothing to do. */
1522 static void
1523 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1525 int inchannel, outchannel;
1526 pid_t pid;
1527 int sv[2];
1528 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1529 int wait_child_setup[2];
1530 #endif
1531 sigset_t procmask;
1532 sigset_t blocked;
1533 struct sigaction sigint_action;
1534 struct sigaction sigquit_action;
1535 struct sigaction sigpipe_action;
1536 #ifdef AIX
1537 struct sigaction sighup_action;
1538 #endif
1539 /* Use volatile to protect variables from being clobbered by longjmp. */
1540 volatile int forkin, forkout;
1541 volatile int pty_flag = 0;
1542 #ifndef USE_CRT_DLL
1543 extern char **environ;
1544 #endif
1546 inchannel = outchannel = -1;
1548 #ifdef HAVE_PTYS
1549 if (!NILP (Vprocess_connection_type))
1550 outchannel = inchannel = allocate_pty ();
1552 if (inchannel >= 0)
1554 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1555 /* On most USG systems it does not work to open the pty's tty here,
1556 then close it and reopen it in the child. */
1557 #ifdef O_NOCTTY
1558 /* Don't let this terminal become our controlling terminal
1559 (in case we don't have one). */
1560 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1561 #else
1562 forkout = forkin = emacs_open (pty_name, O_RDWR, 0);
1563 #endif
1564 if (forkin < 0)
1565 report_file_error ("Opening pty", Qnil);
1566 #else
1567 forkin = forkout = -1;
1568 #endif /* not USG, or USG_SUBTTY_WORKS */
1569 pty_flag = 1;
1571 else
1572 #endif /* HAVE_PTYS */
1574 int tem;
1575 tem = pipe (sv);
1576 if (tem < 0)
1577 report_file_error ("Creating pipe", Qnil);
1578 inchannel = sv[0];
1579 forkout = sv[1];
1580 tem = pipe (sv);
1581 if (tem < 0)
1583 emacs_close (inchannel);
1584 emacs_close (forkout);
1585 report_file_error ("Creating pipe", Qnil);
1587 outchannel = sv[1];
1588 forkin = sv[0];
1591 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1593 int tem;
1595 tem = pipe (wait_child_setup);
1596 if (tem < 0)
1597 report_file_error ("Creating pipe", Qnil);
1598 tem = fcntl (wait_child_setup[1], F_GETFD, 0);
1599 if (tem >= 0)
1600 tem = fcntl (wait_child_setup[1], F_SETFD, tem | FD_CLOEXEC);
1601 if (tem < 0)
1603 emacs_close (wait_child_setup[0]);
1604 emacs_close (wait_child_setup[1]);
1605 report_file_error ("Setting file descriptor flags", Qnil);
1608 #endif
1610 #ifdef O_NONBLOCK
1611 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1612 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1613 #else
1614 #ifdef O_NDELAY
1615 fcntl (inchannel, F_SETFL, O_NDELAY);
1616 fcntl (outchannel, F_SETFL, O_NDELAY);
1617 #endif
1618 #endif
1620 /* Record this as an active process, with its channels.
1621 As a result, child_setup will close Emacs's side of the pipes. */
1622 chan_process[inchannel] = process;
1623 XPROCESS (process)->infd = inchannel;
1624 XPROCESS (process)->outfd = outchannel;
1626 /* Previously we recorded the tty descriptor used in the subprocess.
1627 It was only used for getting the foreground tty process, so now
1628 we just reopen the device (see emacs_get_tty_pgrp) as this is
1629 more portable (see USG_SUBTTY_WORKS above). */
1631 XPROCESS (process)->pty_flag = pty_flag;
1632 PVAR (XPROCESS (process), status) = Qrun;
1634 /* Delay interrupts until we have a chance to store
1635 the new fork's pid in its process structure */
1636 sigemptyset (&blocked);
1637 #ifdef SIGCHLD
1638 sigaddset (&blocked, SIGCHLD);
1639 #endif
1640 #ifdef HAVE_WORKING_VFORK
1641 /* On many hosts (e.g. Solaris 2.4), if a vforked child calls `signal',
1642 this sets the parent's signal handlers as well as the child's.
1643 So delay all interrupts whose handlers the child might munge,
1644 and record the current handlers so they can be restored later. */
1645 sigaddset (&blocked, SIGINT ); sigaction (SIGINT , 0, &sigint_action );
1646 sigaddset (&blocked, SIGQUIT); sigaction (SIGQUIT, 0, &sigquit_action);
1647 sigaddset (&blocked, SIGPIPE); sigaction (SIGPIPE, 0, &sigpipe_action);
1648 #ifdef AIX
1649 sigaddset (&blocked, SIGHUP ); sigaction (SIGHUP , 0, &sighup_action );
1650 #endif
1651 #endif /* HAVE_WORKING_VFORK */
1652 pthread_sigmask (SIG_BLOCK, &blocked, &procmask);
1654 FD_SET (inchannel, &input_wait_mask);
1655 FD_SET (inchannel, &non_keyboard_wait_mask);
1656 if (inchannel > max_process_desc)
1657 max_process_desc = inchannel;
1659 /* Until we store the proper pid, enable sigchld_handler
1660 to recognize an unknown pid as standing for this process.
1661 It is very important not to let this `marker' value stay
1662 in the table after this function has returned; if it does
1663 it might cause call-process to hang and subsequent asynchronous
1664 processes to get their return values scrambled. */
1665 XPROCESS (process)->pid = -1;
1667 /* This must be called after the above line because it may signal an
1668 error. */
1669 setup_process_coding_systems (process);
1671 BLOCK_INPUT;
1674 /* child_setup must clobber environ on systems with true vfork.
1675 Protect it from permanent change. */
1676 char **save_environ = environ;
1677 volatile Lisp_Object encoded_current_dir = ENCODE_FILE (current_dir);
1679 #ifndef WINDOWSNT
1680 pid = vfork ();
1681 if (pid == 0)
1682 #endif /* not WINDOWSNT */
1684 int xforkin = forkin;
1685 int xforkout = forkout;
1687 #if 0 /* This was probably a mistake--it duplicates code later on,
1688 but fails to handle all the cases. */
1689 /* Make sure SIGCHLD is not blocked in the child. */
1690 sigsetmask (SIGEMPTYMASK);
1691 #endif
1693 /* Make the pty be the controlling terminal of the process. */
1694 #ifdef HAVE_PTYS
1695 /* First, disconnect its current controlling terminal. */
1696 #ifdef HAVE_SETSID
1697 /* We tried doing setsid only if pty_flag, but it caused
1698 process_set_signal to fail on SGI when using a pipe. */
1699 setsid ();
1700 /* Make the pty's terminal the controlling terminal. */
1701 if (pty_flag && xforkin >= 0)
1703 #ifdef TIOCSCTTY
1704 /* We ignore the return value
1705 because faith@cs.unc.edu says that is necessary on Linux. */
1706 ioctl (xforkin, TIOCSCTTY, 0);
1707 #endif
1709 #else /* not HAVE_SETSID */
1710 #ifdef USG
1711 /* It's very important to call setpgrp here and no time
1712 afterwards. Otherwise, we lose our controlling tty which
1713 is set when we open the pty. */
1714 setpgrp ();
1715 #endif /* USG */
1716 #endif /* not HAVE_SETSID */
1717 #if defined (LDISC1)
1718 if (pty_flag && xforkin >= 0)
1720 struct termios t;
1721 tcgetattr (xforkin, &t);
1722 t.c_lflag = LDISC1;
1723 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1724 emacs_write (1, "create_process/tcsetattr LDISC1 failed\n", 39);
1726 #else
1727 #if defined (NTTYDISC) && defined (TIOCSETD)
1728 if (pty_flag && xforkin >= 0)
1730 /* Use new line discipline. */
1731 int ldisc = NTTYDISC;
1732 ioctl (xforkin, TIOCSETD, &ldisc);
1734 #endif
1735 #endif
1736 #ifdef TIOCNOTTY
1737 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1738 can do TIOCSPGRP only to the process's controlling tty. */
1739 if (pty_flag)
1741 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1742 I can't test it since I don't have 4.3. */
1743 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1744 if (j >= 0)
1746 ioctl (j, TIOCNOTTY, 0);
1747 emacs_close (j);
1749 #ifndef USG
1750 /* In order to get a controlling terminal on some versions
1751 of BSD, it is necessary to put the process in pgrp 0
1752 before it opens the terminal. */
1753 #ifdef HAVE_SETPGID
1754 setpgid (0, 0);
1755 #else
1756 setpgrp (0, 0);
1757 #endif
1758 #endif
1760 #endif /* TIOCNOTTY */
1762 #if !defined (DONT_REOPEN_PTY)
1763 /*** There is a suggestion that this ought to be a
1764 conditional on TIOCSPGRP,
1765 or !(defined (HAVE_SETSID) && defined (TIOCSCTTY)).
1766 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1767 that system does seem to need this code, even though
1768 both HAVE_SETSID and TIOCSCTTY are defined. */
1769 /* Now close the pty (if we had it open) and reopen it.
1770 This makes the pty the controlling terminal of the subprocess. */
1771 if (pty_flag)
1774 /* I wonder if emacs_close (emacs_open (pty_name, ...))
1775 would work? */
1776 if (xforkin >= 0)
1777 emacs_close (xforkin);
1778 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
1780 if (xforkin < 0)
1782 emacs_write (1, "Couldn't open the pty terminal ", 31);
1783 emacs_write (1, pty_name, strlen (pty_name));
1784 emacs_write (1, "\n", 1);
1785 _exit (1);
1789 #endif /* not DONT_REOPEN_PTY */
1791 #ifdef SETUP_SLAVE_PTY
1792 if (pty_flag)
1794 SETUP_SLAVE_PTY;
1796 #endif /* SETUP_SLAVE_PTY */
1797 #ifdef AIX
1798 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
1799 Now reenable it in the child, so it will die when we want it to. */
1800 if (pty_flag)
1801 signal (SIGHUP, SIG_DFL);
1802 #endif
1803 #endif /* HAVE_PTYS */
1805 signal (SIGINT, SIG_DFL);
1806 signal (SIGQUIT, SIG_DFL);
1807 /* GConf causes us to ignore SIGPIPE, make sure it is restored
1808 in the child. */
1809 signal (SIGPIPE, SIG_DFL);
1811 /* Stop blocking signals in the child. */
1812 pthread_sigmask (SIG_SETMASK, &procmask, 0);
1814 if (pty_flag)
1815 child_setup_tty (xforkout);
1816 #ifdef WINDOWSNT
1817 pid = child_setup (xforkin, xforkout, xforkout,
1818 new_argv, 1, encoded_current_dir);
1819 #else /* not WINDOWSNT */
1820 #ifdef FD_CLOEXEC
1821 emacs_close (wait_child_setup[0]);
1822 #endif
1823 child_setup (xforkin, xforkout, xforkout,
1824 new_argv, 1, encoded_current_dir);
1825 #endif /* not WINDOWSNT */
1827 environ = save_environ;
1830 UNBLOCK_INPUT;
1832 /* This runs in the Emacs process. */
1833 if (pid < 0)
1835 if (forkin >= 0)
1836 emacs_close (forkin);
1837 if (forkin != forkout && forkout >= 0)
1838 emacs_close (forkout);
1840 else
1842 /* vfork succeeded. */
1843 XPROCESS (process)->pid = pid;
1845 #ifdef WINDOWSNT
1846 register_child (pid, inchannel);
1847 #endif /* WINDOWSNT */
1849 /* If the subfork execv fails, and it exits,
1850 this close hangs. I don't know why.
1851 So have an interrupt jar it loose. */
1853 struct atimer *timer;
1854 EMACS_TIME offset = make_emacs_time (1, 0);
1856 stop_polling ();
1857 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
1859 if (forkin >= 0)
1860 emacs_close (forkin);
1862 cancel_atimer (timer);
1863 start_polling ();
1866 if (forkin != forkout && forkout >= 0)
1867 emacs_close (forkout);
1869 #ifdef HAVE_PTYS
1870 if (pty_flag)
1871 PVAR (XPROCESS (process), tty_name) = build_string (pty_name);
1872 else
1873 #endif
1874 PVAR (XPROCESS (process), tty_name) = Qnil;
1876 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1877 /* Wait for child_setup to complete in case that vfork is
1878 actually defined as fork. The descriptor wait_child_setup[1]
1879 of a pipe is closed at the child side either by close-on-exec
1880 on successful execvp or the _exit call in child_setup. */
1882 char dummy;
1884 emacs_close (wait_child_setup[1]);
1885 emacs_read (wait_child_setup[0], &dummy, 1);
1886 emacs_close (wait_child_setup[0]);
1888 #endif
1891 /* Restore the signal state whether vfork succeeded or not.
1892 (We will signal an error, below, if it failed.) */
1893 #ifdef HAVE_WORKING_VFORK
1894 /* Restore the parent's signal handlers. */
1895 sigaction (SIGINT, &sigint_action, 0);
1896 sigaction (SIGQUIT, &sigquit_action, 0);
1897 sigaction (SIGPIPE, &sigpipe_action, 0);
1898 #ifdef AIX
1899 sigaction (SIGHUP, &sighup_action, 0);
1900 #endif
1901 #endif /* HAVE_WORKING_VFORK */
1902 /* Stop blocking signals in the parent. */
1903 pthread_sigmask (SIG_SETMASK, &procmask, 0);
1905 /* Now generate the error if vfork failed. */
1906 if (pid < 0)
1907 report_file_error ("Doing vfork", Qnil);
1910 void
1911 create_pty (Lisp_Object process)
1913 int inchannel, outchannel;
1914 int pty_flag = 0;
1916 inchannel = outchannel = -1;
1918 #ifdef HAVE_PTYS
1919 if (!NILP (Vprocess_connection_type))
1920 outchannel = inchannel = allocate_pty ();
1922 if (inchannel >= 0)
1924 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1925 /* On most USG systems it does not work to open the pty's tty here,
1926 then close it and reopen it in the child. */
1927 #ifdef O_NOCTTY
1928 /* Don't let this terminal become our controlling terminal
1929 (in case we don't have one). */
1930 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1931 #else
1932 int forkout = emacs_open (pty_name, O_RDWR, 0);
1933 #endif
1934 if (forkout < 0)
1935 report_file_error ("Opening pty", Qnil);
1936 #if defined (DONT_REOPEN_PTY)
1937 /* In the case that vfork is defined as fork, the parent process
1938 (Emacs) may send some data before the child process completes
1939 tty options setup. So we setup tty before forking. */
1940 child_setup_tty (forkout);
1941 #endif /* DONT_REOPEN_PTY */
1942 #endif /* not USG, or USG_SUBTTY_WORKS */
1943 pty_flag = 1;
1945 #endif /* HAVE_PTYS */
1947 #ifdef O_NONBLOCK
1948 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1949 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1950 #else
1951 #ifdef O_NDELAY
1952 fcntl (inchannel, F_SETFL, O_NDELAY);
1953 fcntl (outchannel, F_SETFL, O_NDELAY);
1954 #endif
1955 #endif
1957 /* Record this as an active process, with its channels.
1958 As a result, child_setup will close Emacs's side of the pipes. */
1959 chan_process[inchannel] = process;
1960 XPROCESS (process)->infd = inchannel;
1961 XPROCESS (process)->outfd = outchannel;
1963 /* Previously we recorded the tty descriptor used in the subprocess.
1964 It was only used for getting the foreground tty process, so now
1965 we just reopen the device (see emacs_get_tty_pgrp) as this is
1966 more portable (see USG_SUBTTY_WORKS above). */
1968 XPROCESS (process)->pty_flag = pty_flag;
1969 PVAR (XPROCESS (process), status) = Qrun;
1970 setup_process_coding_systems (process);
1972 FD_SET (inchannel, &input_wait_mask);
1973 FD_SET (inchannel, &non_keyboard_wait_mask);
1974 if (inchannel > max_process_desc)
1975 max_process_desc = inchannel;
1977 XPROCESS (process)->pid = -2;
1978 #ifdef HAVE_PTYS
1979 if (pty_flag)
1980 PVAR (XPROCESS (process), tty_name) = build_string (pty_name);
1981 else
1982 #endif
1983 PVAR (XPROCESS (process), tty_name) = Qnil;
1987 /* Convert an internal struct sockaddr to a lisp object (vector or string).
1988 The address family of sa is not included in the result. */
1990 static Lisp_Object
1991 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
1993 Lisp_Object address;
1994 int i;
1995 unsigned char *cp;
1996 register struct Lisp_Vector *p;
1998 /* Workaround for a bug in getsockname on BSD: Names bound to
1999 sockets in the UNIX domain are inaccessible; getsockname returns
2000 a zero length name. */
2001 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
2002 return empty_unibyte_string;
2004 switch (sa->sa_family)
2006 case AF_INET:
2008 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2009 len = sizeof (sin->sin_addr) + 1;
2010 address = Fmake_vector (make_number (len), Qnil);
2011 p = XVECTOR (address);
2012 p->contents[--len] = make_number (ntohs (sin->sin_port));
2013 cp = (unsigned char *) &sin->sin_addr;
2014 break;
2016 #ifdef AF_INET6
2017 case AF_INET6:
2019 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2020 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
2021 len = sizeof (sin6->sin6_addr)/2 + 1;
2022 address = Fmake_vector (make_number (len), Qnil);
2023 p = XVECTOR (address);
2024 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2025 for (i = 0; i < len; i++)
2026 p->contents[i] = make_number (ntohs (ip6[i]));
2027 return address;
2029 #endif
2030 #ifdef HAVE_LOCAL_SOCKETS
2031 case AF_LOCAL:
2033 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2034 for (i = 0; i < sizeof (sockun->sun_path); i++)
2035 if (sockun->sun_path[i] == 0)
2036 break;
2037 return make_unibyte_string (sockun->sun_path, i);
2039 #endif
2040 default:
2041 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2042 address = Fcons (make_number (sa->sa_family),
2043 Fmake_vector (make_number (len), Qnil));
2044 p = XVECTOR (XCDR (address));
2045 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2046 break;
2049 i = 0;
2050 while (i < len)
2051 p->contents[i++] = make_number (*cp++);
2053 return address;
2057 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2059 static int
2060 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2062 register struct Lisp_Vector *p;
2064 if (VECTORP (address))
2066 p = XVECTOR (address);
2067 if (p->header.size == 5)
2069 *familyp = AF_INET;
2070 return sizeof (struct sockaddr_in);
2072 #ifdef AF_INET6
2073 else if (p->header.size == 9)
2075 *familyp = AF_INET6;
2076 return sizeof (struct sockaddr_in6);
2078 #endif
2080 #ifdef HAVE_LOCAL_SOCKETS
2081 else if (STRINGP (address))
2083 *familyp = AF_LOCAL;
2084 return sizeof (struct sockaddr_un);
2086 #endif
2087 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2088 && VECTORP (XCDR (address)))
2090 struct sockaddr *sa;
2091 *familyp = XINT (XCAR (address));
2092 p = XVECTOR (XCDR (address));
2093 return p->header.size + sizeof (sa->sa_family);
2095 return 0;
2098 /* Convert an address object (vector or string) to an internal sockaddr.
2100 The address format has been basically validated by
2101 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2102 it could have come from user data. So if FAMILY is not valid,
2103 we return after zeroing *SA. */
2105 static void
2106 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2108 register struct Lisp_Vector *p;
2109 register unsigned char *cp = NULL;
2110 register int i;
2111 EMACS_INT hostport;
2113 memset (sa, 0, len);
2115 if (VECTORP (address))
2117 p = XVECTOR (address);
2118 if (family == AF_INET)
2120 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2121 len = sizeof (sin->sin_addr) + 1;
2122 hostport = XINT (p->contents[--len]);
2123 sin->sin_port = htons (hostport);
2124 cp = (unsigned char *)&sin->sin_addr;
2125 sa->sa_family = family;
2127 #ifdef AF_INET6
2128 else if (family == AF_INET6)
2130 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2131 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2132 len = sizeof (sin6->sin6_addr) + 1;
2133 hostport = XINT (p->contents[--len]);
2134 sin6->sin6_port = htons (hostport);
2135 for (i = 0; i < len; i++)
2136 if (INTEGERP (p->contents[i]))
2138 int j = XFASTINT (p->contents[i]) & 0xffff;
2139 ip6[i] = ntohs (j);
2141 sa->sa_family = family;
2142 return;
2144 #endif
2145 else
2146 return;
2148 else if (STRINGP (address))
2150 #ifdef HAVE_LOCAL_SOCKETS
2151 if (family == AF_LOCAL)
2153 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2154 cp = SDATA (address);
2155 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2156 sockun->sun_path[i] = *cp++;
2157 sa->sa_family = family;
2159 #endif
2160 return;
2162 else
2164 p = XVECTOR (XCDR (address));
2165 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2168 for (i = 0; i < len; i++)
2169 if (INTEGERP (p->contents[i]))
2170 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2173 #ifdef DATAGRAM_SOCKETS
2174 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2175 1, 1, 0,
2176 doc: /* Get the current datagram address associated with PROCESS. */)
2177 (Lisp_Object process)
2179 int channel;
2181 CHECK_PROCESS (process);
2183 if (!DATAGRAM_CONN_P (process))
2184 return Qnil;
2186 channel = XPROCESS (process)->infd;
2187 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2188 datagram_address[channel].len);
2191 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2192 2, 2, 0,
2193 doc: /* Set the datagram address for PROCESS to ADDRESS.
2194 Returns nil upon error setting address, ADDRESS otherwise. */)
2195 (Lisp_Object process, Lisp_Object address)
2197 int channel;
2198 int family, len;
2200 CHECK_PROCESS (process);
2202 if (!DATAGRAM_CONN_P (process))
2203 return Qnil;
2205 channel = XPROCESS (process)->infd;
2207 len = get_lisp_to_sockaddr_size (address, &family);
2208 if (datagram_address[channel].len != len)
2209 return Qnil;
2210 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2211 return address;
2213 #endif
2216 static const struct socket_options {
2217 /* The name of this option. Should be lowercase version of option
2218 name without SO_ prefix. */
2219 const char *name;
2220 /* Option level SOL_... */
2221 int optlevel;
2222 /* Option number SO_... */
2223 int optnum;
2224 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2225 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2226 } socket_options[] =
2228 #ifdef SO_BINDTODEVICE
2229 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2230 #endif
2231 #ifdef SO_BROADCAST
2232 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2233 #endif
2234 #ifdef SO_DONTROUTE
2235 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2236 #endif
2237 #ifdef SO_KEEPALIVE
2238 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2239 #endif
2240 #ifdef SO_LINGER
2241 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2242 #endif
2243 #ifdef SO_OOBINLINE
2244 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2245 #endif
2246 #ifdef SO_PRIORITY
2247 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2248 #endif
2249 #ifdef SO_REUSEADDR
2250 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2251 #endif
2252 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2255 /* Set option OPT to value VAL on socket S.
2257 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2258 Signals an error if setting a known option fails.
2261 static int
2262 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2264 char *name;
2265 const struct socket_options *sopt;
2266 int ret = 0;
2268 CHECK_SYMBOL (opt);
2270 name = SSDATA (SYMBOL_NAME (opt));
2271 for (sopt = socket_options; sopt->name; sopt++)
2272 if (strcmp (name, sopt->name) == 0)
2273 break;
2275 switch (sopt->opttype)
2277 case SOPT_BOOL:
2279 int optval;
2280 optval = NILP (val) ? 0 : 1;
2281 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2282 &optval, sizeof (optval));
2283 break;
2286 case SOPT_INT:
2288 int optval;
2289 if (TYPE_RANGED_INTEGERP (int, val))
2290 optval = XINT (val);
2291 else
2292 error ("Bad option value for %s", name);
2293 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2294 &optval, sizeof (optval));
2295 break;
2298 #ifdef SO_BINDTODEVICE
2299 case SOPT_IFNAME:
2301 char devname[IFNAMSIZ+1];
2303 /* This is broken, at least in the Linux 2.4 kernel.
2304 To unbind, the arg must be a zero integer, not the empty string.
2305 This should work on all systems. KFS. 2003-09-23. */
2306 memset (devname, 0, sizeof devname);
2307 if (STRINGP (val))
2309 char *arg = SSDATA (val);
2310 int len = min (strlen (arg), IFNAMSIZ);
2311 memcpy (devname, arg, len);
2313 else if (!NILP (val))
2314 error ("Bad option value for %s", name);
2315 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2316 devname, IFNAMSIZ);
2317 break;
2319 #endif
2321 #ifdef SO_LINGER
2322 case SOPT_LINGER:
2324 struct linger linger;
2326 linger.l_onoff = 1;
2327 linger.l_linger = 0;
2328 if (TYPE_RANGED_INTEGERP (int, val))
2329 linger.l_linger = XINT (val);
2330 else
2331 linger.l_onoff = NILP (val) ? 0 : 1;
2332 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2333 &linger, sizeof (linger));
2334 break;
2336 #endif
2338 default:
2339 return 0;
2342 if (ret < 0)
2343 report_file_error ("Cannot set network option",
2344 Fcons (opt, Fcons (val, Qnil)));
2345 return (1 << sopt->optbit);
2349 DEFUN ("set-network-process-option",
2350 Fset_network_process_option, Sset_network_process_option,
2351 3, 4, 0,
2352 doc: /* For network process PROCESS set option OPTION to value VALUE.
2353 See `make-network-process' for a list of options and values.
2354 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2355 OPTION is not a supported option, return nil instead; otherwise return t. */)
2356 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2358 int s;
2359 struct Lisp_Process *p;
2361 CHECK_PROCESS (process);
2362 p = XPROCESS (process);
2363 if (!NETCONN1_P (p))
2364 error ("Process is not a network process");
2366 s = p->infd;
2367 if (s < 0)
2368 error ("Process is not running");
2370 if (set_socket_option (s, option, value))
2372 PVAR (p, childp) = Fplist_put (PVAR (p, childp), option, value);
2373 return Qt;
2376 if (NILP (no_error))
2377 error ("Unknown or unsupported option");
2379 return Qnil;
2383 DEFUN ("serial-process-configure",
2384 Fserial_process_configure,
2385 Sserial_process_configure,
2386 0, MANY, 0,
2387 doc: /* Configure speed, bytesize, etc. of a serial process.
2389 Arguments are specified as keyword/argument pairs. Attributes that
2390 are not given are re-initialized from the process's current
2391 configuration (available via the function `process-contact') or set to
2392 reasonable default values. The following arguments are defined:
2394 :process PROCESS
2395 :name NAME
2396 :buffer BUFFER
2397 :port PORT
2398 -- Any of these arguments can be given to identify the process that is
2399 to be configured. If none of these arguments is given, the current
2400 buffer's process is used.
2402 :speed SPEED -- SPEED is the speed of the serial port in bits per
2403 second, also called baud rate. Any value can be given for SPEED, but
2404 most serial ports work only at a few defined values between 1200 and
2405 115200, with 9600 being the most common value. If SPEED is nil, the
2406 serial port is not configured any further, i.e., all other arguments
2407 are ignored. This may be useful for special serial ports such as
2408 Bluetooth-to-serial converters which can only be configured through AT
2409 commands. A value of nil for SPEED can be used only when passed
2410 through `make-serial-process' or `serial-term'.
2412 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2413 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2415 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2416 `odd' (use odd parity), or the symbol `even' (use even parity). If
2417 PARITY is not given, no parity is used.
2419 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2420 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2421 is not given or nil, 1 stopbit is used.
2423 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2424 flowcontrol to be used, which is either nil (don't use flowcontrol),
2425 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2426 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2427 flowcontrol is used.
2429 `serial-process-configure' is called by `make-serial-process' for the
2430 initial configuration of the serial port.
2432 Examples:
2434 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2436 \(serial-process-configure
2437 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2439 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2441 usage: (serial-process-configure &rest ARGS) */)
2442 (ptrdiff_t nargs, Lisp_Object *args)
2444 struct Lisp_Process *p;
2445 Lisp_Object contact = Qnil;
2446 Lisp_Object proc = Qnil;
2447 struct gcpro gcpro1;
2449 contact = Flist (nargs, args);
2450 GCPRO1 (contact);
2452 proc = Fplist_get (contact, QCprocess);
2453 if (NILP (proc))
2454 proc = Fplist_get (contact, QCname);
2455 if (NILP (proc))
2456 proc = Fplist_get (contact, QCbuffer);
2457 if (NILP (proc))
2458 proc = Fplist_get (contact, QCport);
2459 proc = get_process (proc);
2460 p = XPROCESS (proc);
2461 if (!EQ (PVAR (p, type), Qserial))
2462 error ("Not a serial process");
2464 if (NILP (Fplist_get (PVAR (p, childp), QCspeed)))
2466 UNGCPRO;
2467 return Qnil;
2470 serial_configure (p, contact);
2472 UNGCPRO;
2473 return Qnil;
2476 /* Used by make-serial-process to recover from errors. */
2477 static Lisp_Object
2478 make_serial_process_unwind (Lisp_Object proc)
2480 if (!PROCESSP (proc))
2481 abort ();
2482 remove_process (proc);
2483 return Qnil;
2486 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2487 0, MANY, 0,
2488 doc: /* Create and return a serial port process.
2490 In Emacs, serial port connections are represented by process objects,
2491 so input and output work as for subprocesses, and `delete-process'
2492 closes a serial port connection. However, a serial process has no
2493 process id, it cannot be signaled, and the status codes are different
2494 from normal processes.
2496 `make-serial-process' creates a process and a buffer, on which you
2497 probably want to use `process-send-string'. Try \\[serial-term] for
2498 an interactive terminal. See below for examples.
2500 Arguments are specified as keyword/argument pairs. The following
2501 arguments are defined:
2503 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2504 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2505 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2506 the backslashes in strings).
2508 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2509 which this function calls.
2511 :name NAME -- NAME is the name of the process. If NAME is not given,
2512 the value of PORT is used.
2514 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2515 with the process. Process output goes at the end of that buffer,
2516 unless you specify an output stream or filter function to handle the
2517 output. If BUFFER is not given, the value of NAME is used.
2519 :coding CODING -- If CODING is a symbol, it specifies the coding
2520 system used for both reading and writing for this process. If CODING
2521 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2522 ENCODING is used for writing.
2524 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2525 the process is running. If BOOL is not given, query before exiting.
2527 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2528 In the stopped state, a serial process does not accept incoming data,
2529 but you can send outgoing data. The stopped state is cleared by
2530 `continue-process' and set by `stop-process'.
2532 :filter FILTER -- Install FILTER as the process filter.
2534 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2536 :plist PLIST -- Install PLIST as the initial plist of the process.
2538 :bytesize
2539 :parity
2540 :stopbits
2541 :flowcontrol
2542 -- This function calls `serial-process-configure' to handle these
2543 arguments.
2545 The original argument list, possibly modified by later configuration,
2546 is available via the function `process-contact'.
2548 Examples:
2550 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2552 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2554 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2556 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2558 usage: (make-serial-process &rest ARGS) */)
2559 (ptrdiff_t nargs, Lisp_Object *args)
2561 int fd = -1;
2562 Lisp_Object proc, contact, port;
2563 struct Lisp_Process *p;
2564 struct gcpro gcpro1;
2565 Lisp_Object name, buffer;
2566 Lisp_Object tem, val;
2567 ptrdiff_t specpdl_count = -1;
2569 if (nargs == 0)
2570 return Qnil;
2572 contact = Flist (nargs, args);
2573 GCPRO1 (contact);
2575 port = Fplist_get (contact, QCport);
2576 if (NILP (port))
2577 error ("No port specified");
2578 CHECK_STRING (port);
2580 if (NILP (Fplist_member (contact, QCspeed)))
2581 error (":speed not specified");
2582 if (!NILP (Fplist_get (contact, QCspeed)))
2583 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2585 name = Fplist_get (contact, QCname);
2586 if (NILP (name))
2587 name = port;
2588 CHECK_STRING (name);
2589 proc = make_process (name);
2590 specpdl_count = SPECPDL_INDEX ();
2591 record_unwind_protect (make_serial_process_unwind, proc);
2592 p = XPROCESS (proc);
2594 fd = serial_open (SSDATA (port));
2595 p->infd = fd;
2596 p->outfd = fd;
2597 if (fd > max_process_desc)
2598 max_process_desc = fd;
2599 chan_process[fd] = proc;
2601 buffer = Fplist_get (contact, QCbuffer);
2602 if (NILP (buffer))
2603 buffer = name;
2604 buffer = Fget_buffer_create (buffer);
2605 PVAR (p, buffer) = buffer;
2607 PVAR (p, childp) = contact;
2608 PVAR (p, plist) = Fcopy_sequence (Fplist_get (contact, QCplist));
2609 PVAR (p, type) = Qserial;
2610 PVAR (p, sentinel) = Fplist_get (contact, QCsentinel);
2611 PVAR (p, filter) = Fplist_get (contact, QCfilter);
2612 PVAR (p, log) = Qnil;
2613 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2614 p->kill_without_query = 1;
2615 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2616 PVAR (p, command) = Qt;
2617 p->pty_flag = 0;
2619 if (!EQ (PVAR (p, command), Qt))
2621 FD_SET (fd, &input_wait_mask);
2622 FD_SET (fd, &non_keyboard_wait_mask);
2625 if (BUFFERP (buffer))
2627 set_marker_both (PVAR (p, mark), buffer,
2628 BUF_ZV (XBUFFER (buffer)),
2629 BUF_ZV_BYTE (XBUFFER (buffer)));
2632 tem = Fplist_member (contact, QCcoding);
2633 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2634 tem = Qnil;
2636 val = Qnil;
2637 if (!NILP (tem))
2639 val = XCAR (XCDR (tem));
2640 if (CONSP (val))
2641 val = XCAR (val);
2643 else if (!NILP (Vcoding_system_for_read))
2644 val = Vcoding_system_for_read;
2645 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2646 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2647 val = Qnil;
2648 PVAR (p, decode_coding_system) = val;
2650 val = Qnil;
2651 if (!NILP (tem))
2653 val = XCAR (XCDR (tem));
2654 if (CONSP (val))
2655 val = XCDR (val);
2657 else if (!NILP (Vcoding_system_for_write))
2658 val = Vcoding_system_for_write;
2659 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2660 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2661 val = Qnil;
2662 PVAR (p, encode_coding_system) = val;
2664 setup_process_coding_systems (proc);
2665 PVAR (p, decoding_buf) = empty_unibyte_string;
2666 p->decoding_carryover = 0;
2667 PVAR (p, encoding_buf) = empty_unibyte_string;
2668 p->inherit_coding_system_flag
2669 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2671 Fserial_process_configure (nargs, args);
2673 specpdl_ptr = specpdl + specpdl_count;
2675 UNGCPRO;
2676 return proc;
2679 /* Create a network stream/datagram client/server process. Treated
2680 exactly like a normal process when reading and writing. Primary
2681 differences are in status display and process deletion. A network
2682 connection has no PID; you cannot signal it. All you can do is
2683 stop/continue it and deactivate/close it via delete-process */
2685 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2686 0, MANY, 0,
2687 doc: /* Create and return a network server or client process.
2689 In Emacs, network connections are represented by process objects, so
2690 input and output work as for subprocesses and `delete-process' closes
2691 a network connection. However, a network process has no process id,
2692 it cannot be signaled, and the status codes are different from normal
2693 processes.
2695 Arguments are specified as keyword/argument pairs. The following
2696 arguments are defined:
2698 :name NAME -- NAME is name for process. It is modified if necessary
2699 to make it unique.
2701 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2702 with the process. Process output goes at end of that buffer, unless
2703 you specify an output stream or filter function to handle the output.
2704 BUFFER may be also nil, meaning that this process is not associated
2705 with any buffer.
2707 :host HOST -- HOST is name of the host to connect to, or its IP
2708 address. The symbol `local' specifies the local host. If specified
2709 for a server process, it must be a valid name or address for the local
2710 host, and only clients connecting to that address will be accepted.
2712 :service SERVICE -- SERVICE is name of the service desired, or an
2713 integer specifying a port number to connect to. If SERVICE is t,
2714 a random port number is selected for the server. (If Emacs was
2715 compiled with getaddrinfo, a port number can also be specified as a
2716 string, e.g. "80", as well as an integer. This is not portable.)
2718 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2719 stream type connection, `datagram' creates a datagram type connection,
2720 `seqpacket' creates a reliable datagram connection.
2722 :family FAMILY -- FAMILY is the address (and protocol) family for the
2723 service specified by HOST and SERVICE. The default (nil) is to use
2724 whatever address family (IPv4 or IPv6) that is defined for the host
2725 and port number specified by HOST and SERVICE. Other address families
2726 supported are:
2727 local -- for a local (i.e. UNIX) address specified by SERVICE.
2728 ipv4 -- use IPv4 address family only.
2729 ipv6 -- use IPv6 address family only.
2731 :local ADDRESS -- ADDRESS is the local address used for the connection.
2732 This parameter is ignored when opening a client process. When specified
2733 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2735 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2736 connection. This parameter is ignored when opening a stream server
2737 process. For a datagram server process, it specifies the initial
2738 setting of the remote datagram address. When specified for a client
2739 process, the FAMILY, HOST, and SERVICE args are ignored.
2741 The format of ADDRESS depends on the address family:
2742 - An IPv4 address is represented as an vector of integers [A B C D P]
2743 corresponding to numeric IP address A.B.C.D and port number P.
2744 - A local address is represented as a string with the address in the
2745 local address space.
2746 - An "unsupported family" address is represented by a cons (F . AV)
2747 where F is the family number and AV is a vector containing the socket
2748 address data with one element per address data byte. Do not rely on
2749 this format in portable code, as it may depend on implementation
2750 defined constants, data sizes, and data structure alignment.
2752 :coding CODING -- If CODING is a symbol, it specifies the coding
2753 system used for both reading and writing for this process. If CODING
2754 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2755 ENCODING is used for writing.
2757 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2758 return without waiting for the connection to complete; instead, the
2759 sentinel function will be called with second arg matching "open" (if
2760 successful) or "failed" when the connect completes. Default is to use
2761 a blocking connect (i.e. wait) for stream type connections.
2763 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2764 running when Emacs is exited.
2766 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2767 In the stopped state, a server process does not accept new
2768 connections, and a client process does not handle incoming traffic.
2769 The stopped state is cleared by `continue-process' and set by
2770 `stop-process'.
2772 :filter FILTER -- Install FILTER as the process filter.
2774 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2775 process filter are multibyte, otherwise they are unibyte.
2776 If this keyword is not specified, the strings are multibyte if
2777 the default value of `enable-multibyte-characters' is non-nil.
2779 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2781 :log LOG -- Install LOG as the server process log function. This
2782 function is called when the server accepts a network connection from a
2783 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2784 is the server process, CLIENT is the new process for the connection,
2785 and MESSAGE is a string.
2787 :plist PLIST -- Install PLIST as the new process' initial plist.
2789 :server QLEN -- if QLEN is non-nil, create a server process for the
2790 specified FAMILY, SERVICE, and connection type (stream or datagram).
2791 If QLEN is an integer, it is used as the max. length of the server's
2792 pending connection queue (also known as the backlog); the default
2793 queue length is 5. Default is to create a client process.
2795 The following network options can be specified for this connection:
2797 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2798 :dontroute BOOL -- Only send to directly connected hosts.
2799 :keepalive BOOL -- Send keep-alive messages on network stream.
2800 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2801 :oobinline BOOL -- Place out-of-band data in receive data stream.
2802 :priority INT -- Set protocol defined priority for sent packets.
2803 :reuseaddr BOOL -- Allow reusing a recently used local address
2804 (this is allowed by default for a server process).
2805 :bindtodevice NAME -- bind to interface NAME. Using this may require
2806 special privileges on some systems.
2808 Consult the relevant system programmer's manual pages for more
2809 information on using these options.
2812 A server process will listen for and accept connections from clients.
2813 When a client connection is accepted, a new network process is created
2814 for the connection with the following parameters:
2816 - The client's process name is constructed by concatenating the server
2817 process' NAME and a client identification string.
2818 - If the FILTER argument is non-nil, the client process will not get a
2819 separate process buffer; otherwise, the client's process buffer is a newly
2820 created buffer named after the server process' BUFFER name or process
2821 NAME concatenated with the client identification string.
2822 - The connection type and the process filter and sentinel parameters are
2823 inherited from the server process' TYPE, FILTER and SENTINEL.
2824 - The client process' contact info is set according to the client's
2825 addressing information (typically an IP address and a port number).
2826 - The client process' plist is initialized from the server's plist.
2828 Notice that the FILTER and SENTINEL args are never used directly by
2829 the server process. Also, the BUFFER argument is not used directly by
2830 the server process, but via the optional :log function, accepted (and
2831 failed) connections may be logged in the server process' buffer.
2833 The original argument list, modified with the actual connection
2834 information, is available via the `process-contact' function.
2836 usage: (make-network-process &rest ARGS) */)
2837 (ptrdiff_t nargs, Lisp_Object *args)
2839 Lisp_Object proc;
2840 Lisp_Object contact;
2841 struct Lisp_Process *p;
2842 #ifdef HAVE_GETADDRINFO
2843 struct addrinfo ai, *res, *lres;
2844 struct addrinfo hints;
2845 const char *portstring;
2846 char portbuf[128];
2847 #else /* HAVE_GETADDRINFO */
2848 struct _emacs_addrinfo
2850 int ai_family;
2851 int ai_socktype;
2852 int ai_protocol;
2853 int ai_addrlen;
2854 struct sockaddr *ai_addr;
2855 struct _emacs_addrinfo *ai_next;
2856 } ai, *res, *lres;
2857 #endif /* HAVE_GETADDRINFO */
2858 struct sockaddr_in address_in;
2859 #ifdef HAVE_LOCAL_SOCKETS
2860 struct sockaddr_un address_un;
2861 #endif
2862 int port;
2863 int ret = 0;
2864 int xerrno = 0;
2865 int s = -1, outch, inch;
2866 struct gcpro gcpro1;
2867 ptrdiff_t count = SPECPDL_INDEX ();
2868 ptrdiff_t count1;
2869 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2870 Lisp_Object tem;
2871 Lisp_Object name, buffer, host, service, address;
2872 Lisp_Object filter, sentinel;
2873 int is_non_blocking_client = 0;
2874 int is_server = 0, backlog = 5;
2875 int socktype;
2876 int family = -1;
2878 if (nargs == 0)
2879 return Qnil;
2881 /* Save arguments for process-contact and clone-process. */
2882 contact = Flist (nargs, args);
2883 GCPRO1 (contact);
2885 #ifdef WINDOWSNT
2886 /* Ensure socket support is loaded if available. */
2887 init_winsock (TRUE);
2888 #endif
2890 /* :type TYPE (nil: stream, datagram */
2891 tem = Fplist_get (contact, QCtype);
2892 if (NILP (tem))
2893 socktype = SOCK_STREAM;
2894 #ifdef DATAGRAM_SOCKETS
2895 else if (EQ (tem, Qdatagram))
2896 socktype = SOCK_DGRAM;
2897 #endif
2898 #ifdef HAVE_SEQPACKET
2899 else if (EQ (tem, Qseqpacket))
2900 socktype = SOCK_SEQPACKET;
2901 #endif
2902 else
2903 error ("Unsupported connection type");
2905 /* :server BOOL */
2906 tem = Fplist_get (contact, QCserver);
2907 if (!NILP (tem))
2909 /* Don't support network sockets when non-blocking mode is
2910 not available, since a blocked Emacs is not useful. */
2911 #if !defined (O_NONBLOCK) && !defined (O_NDELAY)
2912 error ("Network servers not supported");
2913 #else
2914 is_server = 1;
2915 if (TYPE_RANGED_INTEGERP (int, tem))
2916 backlog = XINT (tem);
2917 #endif
2920 /* Make QCaddress an alias for :local (server) or :remote (client). */
2921 QCaddress = is_server ? QClocal : QCremote;
2923 /* :nowait BOOL */
2924 if (!is_server && socktype != SOCK_DGRAM
2925 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2927 #ifndef NON_BLOCKING_CONNECT
2928 error ("Non-blocking connect not supported");
2929 #else
2930 is_non_blocking_client = 1;
2931 #endif
2934 name = Fplist_get (contact, QCname);
2935 buffer = Fplist_get (contact, QCbuffer);
2936 filter = Fplist_get (contact, QCfilter);
2937 sentinel = Fplist_get (contact, QCsentinel);
2939 CHECK_STRING (name);
2941 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2942 ai.ai_socktype = socktype;
2943 ai.ai_protocol = 0;
2944 ai.ai_next = NULL;
2945 res = &ai;
2947 /* :local ADDRESS or :remote ADDRESS */
2948 address = Fplist_get (contact, QCaddress);
2949 if (!NILP (address))
2951 host = service = Qnil;
2953 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2954 error ("Malformed :address");
2955 ai.ai_family = family;
2956 ai.ai_addr = alloca (ai.ai_addrlen);
2957 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2958 goto open_socket;
2961 /* :family FAMILY -- nil (for Inet), local, or integer. */
2962 tem = Fplist_get (contact, QCfamily);
2963 if (NILP (tem))
2965 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
2966 family = AF_UNSPEC;
2967 #else
2968 family = AF_INET;
2969 #endif
2971 #ifdef HAVE_LOCAL_SOCKETS
2972 else if (EQ (tem, Qlocal))
2973 family = AF_LOCAL;
2974 #endif
2975 #ifdef AF_INET6
2976 else if (EQ (tem, Qipv6))
2977 family = AF_INET6;
2978 #endif
2979 else if (EQ (tem, Qipv4))
2980 family = AF_INET;
2981 else if (TYPE_RANGED_INTEGERP (int, tem))
2982 family = XINT (tem);
2983 else
2984 error ("Unknown address family");
2986 ai.ai_family = family;
2988 /* :service SERVICE -- string, integer (port number), or t (random port). */
2989 service = Fplist_get (contact, QCservice);
2991 /* :host HOST -- hostname, ip address, or 'local for localhost. */
2992 host = Fplist_get (contact, QChost);
2993 if (!NILP (host))
2995 if (EQ (host, Qlocal))
2996 /* Depending on setup, "localhost" may map to different IPv4 and/or
2997 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
2998 host = build_string ("127.0.0.1");
2999 CHECK_STRING (host);
3002 #ifdef HAVE_LOCAL_SOCKETS
3003 if (family == AF_LOCAL)
3005 if (!NILP (host))
3007 message (":family local ignores the :host \"%s\" property",
3008 SDATA (host));
3009 contact = Fplist_put (contact, QChost, Qnil);
3010 host = Qnil;
3012 CHECK_STRING (service);
3013 memset (&address_un, 0, sizeof address_un);
3014 address_un.sun_family = AF_LOCAL;
3015 if (sizeof address_un.sun_path <= SBYTES (service))
3016 error ("Service name too long");
3017 strcpy (address_un.sun_path, SSDATA (service));
3018 ai.ai_addr = (struct sockaddr *) &address_un;
3019 ai.ai_addrlen = sizeof address_un;
3020 goto open_socket;
3022 #endif
3024 /* Slow down polling to every ten seconds.
3025 Some kernels have a bug which causes retrying connect to fail
3026 after a connect. Polling can interfere with gethostbyname too. */
3027 #ifdef POLL_FOR_INPUT
3028 if (socktype != SOCK_DGRAM)
3030 record_unwind_protect (unwind_stop_other_atimers, Qnil);
3031 bind_polling_period (10);
3033 #endif
3035 #ifdef HAVE_GETADDRINFO
3036 /* If we have a host, use getaddrinfo to resolve both host and service.
3037 Otherwise, use getservbyname to lookup the service. */
3038 if (!NILP (host))
3041 /* SERVICE can either be a string or int.
3042 Convert to a C string for later use by getaddrinfo. */
3043 if (EQ (service, Qt))
3044 portstring = "0";
3045 else if (INTEGERP (service))
3047 sprintf (portbuf, "%"pI"d", XINT (service));
3048 portstring = portbuf;
3050 else
3052 CHECK_STRING (service);
3053 portstring = SSDATA (service);
3056 immediate_quit = 1;
3057 QUIT;
3058 memset (&hints, 0, sizeof (hints));
3059 hints.ai_flags = 0;
3060 hints.ai_family = family;
3061 hints.ai_socktype = socktype;
3062 hints.ai_protocol = 0;
3064 #ifdef HAVE_RES_INIT
3065 res_init ();
3066 #endif
3068 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3069 if (ret)
3070 #ifdef HAVE_GAI_STRERROR
3071 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3072 #else
3073 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3074 #endif
3075 immediate_quit = 0;
3077 goto open_socket;
3079 #endif /* HAVE_GETADDRINFO */
3081 /* We end up here if getaddrinfo is not defined, or in case no hostname
3082 has been specified (e.g. for a local server process). */
3084 if (EQ (service, Qt))
3085 port = 0;
3086 else if (INTEGERP (service))
3087 port = htons ((unsigned short) XINT (service));
3088 else
3090 struct servent *svc_info;
3091 CHECK_STRING (service);
3092 svc_info = getservbyname (SSDATA (service),
3093 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3094 if (svc_info == 0)
3095 error ("Unknown service: %s", SDATA (service));
3096 port = svc_info->s_port;
3099 memset (&address_in, 0, sizeof address_in);
3100 address_in.sin_family = family;
3101 address_in.sin_addr.s_addr = INADDR_ANY;
3102 address_in.sin_port = port;
3104 #ifndef HAVE_GETADDRINFO
3105 if (!NILP (host))
3107 struct hostent *host_info_ptr;
3109 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3110 as it may `hang' Emacs for a very long time. */
3111 immediate_quit = 1;
3112 QUIT;
3114 #ifdef HAVE_RES_INIT
3115 res_init ();
3116 #endif
3118 host_info_ptr = gethostbyname (SDATA (host));
3119 immediate_quit = 0;
3121 if (host_info_ptr)
3123 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3124 host_info_ptr->h_length);
3125 family = host_info_ptr->h_addrtype;
3126 address_in.sin_family = family;
3128 else
3129 /* Attempt to interpret host as numeric inet address */
3131 unsigned long numeric_addr;
3132 numeric_addr = inet_addr (SSDATA (host));
3133 if (numeric_addr == -1)
3134 error ("Unknown host \"%s\"", SDATA (host));
3136 memcpy (&address_in.sin_addr, &numeric_addr,
3137 sizeof (address_in.sin_addr));
3141 #endif /* not HAVE_GETADDRINFO */
3143 ai.ai_family = family;
3144 ai.ai_addr = (struct sockaddr *) &address_in;
3145 ai.ai_addrlen = sizeof address_in;
3147 open_socket:
3149 /* Do this in case we never enter the for-loop below. */
3150 count1 = SPECPDL_INDEX ();
3151 s = -1;
3153 for (lres = res; lres; lres = lres->ai_next)
3155 ptrdiff_t optn;
3156 int optbits;
3158 #ifdef WINDOWSNT
3159 retry_connect:
3160 #endif
3162 s = socket (lres->ai_family, lres->ai_socktype, lres->ai_protocol);
3163 if (s < 0)
3165 xerrno = errno;
3166 continue;
3169 #ifdef DATAGRAM_SOCKETS
3170 if (!is_server && socktype == SOCK_DGRAM)
3171 break;
3172 #endif /* DATAGRAM_SOCKETS */
3174 #ifdef NON_BLOCKING_CONNECT
3175 if (is_non_blocking_client)
3177 #ifdef O_NONBLOCK
3178 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3179 #else
3180 ret = fcntl (s, F_SETFL, O_NDELAY);
3181 #endif
3182 if (ret < 0)
3184 xerrno = errno;
3185 emacs_close (s);
3186 s = -1;
3187 continue;
3190 #endif
3192 /* Make us close S if quit. */
3193 record_unwind_protect (close_file_unwind, make_number (s));
3195 /* Parse network options in the arg list.
3196 We simply ignore anything which isn't a known option (including other keywords).
3197 An error is signaled if setting a known option fails. */
3198 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3199 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3201 if (is_server)
3203 /* Configure as a server socket. */
3205 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3206 explicit :reuseaddr key to override this. */
3207 #ifdef HAVE_LOCAL_SOCKETS
3208 if (family != AF_LOCAL)
3209 #endif
3210 if (!(optbits & (1 << OPIX_REUSEADDR)))
3212 int optval = 1;
3213 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3214 report_file_error ("Cannot set reuse option on server socket", Qnil);
3217 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3218 report_file_error ("Cannot bind server socket", Qnil);
3220 #ifdef HAVE_GETSOCKNAME
3221 if (EQ (service, Qt))
3223 struct sockaddr_in sa1;
3224 socklen_t len1 = sizeof (sa1);
3225 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3227 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3228 service = make_number (ntohs (sa1.sin_port));
3229 contact = Fplist_put (contact, QCservice, service);
3232 #endif
3234 if (socktype != SOCK_DGRAM && listen (s, backlog))
3235 report_file_error ("Cannot listen on server socket", Qnil);
3237 break;
3240 immediate_quit = 1;
3241 QUIT;
3243 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3244 xerrno = errno;
3246 if (ret == 0 || xerrno == EISCONN)
3248 /* The unwind-protect will be discarded afterwards.
3249 Likewise for immediate_quit. */
3250 break;
3253 #ifdef NON_BLOCKING_CONNECT
3254 #ifdef EINPROGRESS
3255 if (is_non_blocking_client && xerrno == EINPROGRESS)
3256 break;
3257 #else
3258 #ifdef EWOULDBLOCK
3259 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3260 break;
3261 #endif
3262 #endif
3263 #endif
3265 #ifndef WINDOWSNT
3266 if (xerrno == EINTR)
3268 /* Unlike most other syscalls connect() cannot be called
3269 again. (That would return EALREADY.) The proper way to
3270 wait for completion is pselect(). */
3271 int sc;
3272 socklen_t len;
3273 SELECT_TYPE fdset;
3274 retry_select:
3275 FD_ZERO (&fdset);
3276 FD_SET (s, &fdset);
3277 QUIT;
3278 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3279 if (sc == -1)
3281 if (errno == EINTR)
3282 goto retry_select;
3283 else
3284 report_file_error ("select failed", Qnil);
3286 eassert (sc > 0);
3288 len = sizeof xerrno;
3289 eassert (FD_ISSET (s, &fdset));
3290 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) == -1)
3291 report_file_error ("getsockopt failed", Qnil);
3292 if (xerrno)
3293 errno = xerrno, report_file_error ("error during connect", Qnil);
3294 else
3295 break;
3297 #endif /* !WINDOWSNT */
3299 immediate_quit = 0;
3301 /* Discard the unwind protect closing S. */
3302 specpdl_ptr = specpdl + count1;
3303 emacs_close (s);
3304 s = -1;
3306 #ifdef WINDOWSNT
3307 if (xerrno == EINTR)
3308 goto retry_connect;
3309 #endif
3312 if (s >= 0)
3314 #ifdef DATAGRAM_SOCKETS
3315 if (socktype == SOCK_DGRAM)
3317 if (datagram_address[s].sa)
3318 abort ();
3319 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3320 datagram_address[s].len = lres->ai_addrlen;
3321 if (is_server)
3323 Lisp_Object remote;
3324 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3325 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3327 int rfamily, rlen;
3328 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3329 if (rfamily == lres->ai_family && rlen == lres->ai_addrlen)
3330 conv_lisp_to_sockaddr (rfamily, remote,
3331 datagram_address[s].sa, rlen);
3334 else
3335 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3337 #endif
3338 contact = Fplist_put (contact, QCaddress,
3339 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3340 #ifdef HAVE_GETSOCKNAME
3341 if (!is_server)
3343 struct sockaddr_in sa1;
3344 socklen_t len1 = sizeof (sa1);
3345 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3346 contact = Fplist_put (contact, QClocal,
3347 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3349 #endif
3352 immediate_quit = 0;
3354 #ifdef HAVE_GETADDRINFO
3355 if (res != &ai)
3357 BLOCK_INPUT;
3358 freeaddrinfo (res);
3359 UNBLOCK_INPUT;
3361 #endif
3363 /* Discard the unwind protect for closing S, if any. */
3364 specpdl_ptr = specpdl + count1;
3366 /* Unwind bind_polling_period and request_sigio. */
3367 unbind_to (count, Qnil);
3369 if (s < 0)
3371 /* If non-blocking got this far - and failed - assume non-blocking is
3372 not supported after all. This is probably a wrong assumption, but
3373 the normal blocking calls to open-network-stream handles this error
3374 better. */
3375 if (is_non_blocking_client)
3376 return Qnil;
3378 errno = xerrno;
3379 if (is_server)
3380 report_file_error ("make server process failed", contact);
3381 else
3382 report_file_error ("make client process failed", contact);
3385 inch = s;
3386 outch = s;
3388 if (!NILP (buffer))
3389 buffer = Fget_buffer_create (buffer);
3390 proc = make_process (name);
3392 chan_process[inch] = proc;
3394 #ifdef O_NONBLOCK
3395 fcntl (inch, F_SETFL, O_NONBLOCK);
3396 #else
3397 #ifdef O_NDELAY
3398 fcntl (inch, F_SETFL, O_NDELAY);
3399 #endif
3400 #endif
3402 p = XPROCESS (proc);
3404 PVAR (p, childp) = contact;
3405 PVAR (p, plist) = Fcopy_sequence (Fplist_get (contact, QCplist));
3406 PVAR (p, type) = Qnetwork;
3408 PVAR (p, buffer) = buffer;
3409 PVAR (p, sentinel) = sentinel;
3410 PVAR (p, filter) = filter;
3411 PVAR (p, log) = Fplist_get (contact, QClog);
3412 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3413 p->kill_without_query = 1;
3414 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3415 PVAR (p, command) = Qt;
3416 p->pid = 0;
3417 p->infd = inch;
3418 p->outfd = outch;
3419 if (is_server && socktype != SOCK_DGRAM)
3420 PVAR (p, status) = Qlisten;
3422 /* Make the process marker point into the process buffer (if any). */
3423 if (BUFFERP (buffer))
3424 set_marker_both (PVAR (p, mark), buffer,
3425 BUF_ZV (XBUFFER (buffer)),
3426 BUF_ZV_BYTE (XBUFFER (buffer)));
3428 #ifdef NON_BLOCKING_CONNECT
3429 if (is_non_blocking_client)
3431 /* We may get here if connect did succeed immediately. However,
3432 in that case, we still need to signal this like a non-blocking
3433 connection. */
3434 PVAR (p, status) = Qconnect;
3435 if (!FD_ISSET (inch, &connect_wait_mask))
3437 FD_SET (inch, &connect_wait_mask);
3438 FD_SET (inch, &write_mask);
3439 num_pending_connects++;
3442 else
3443 #endif
3444 /* A server may have a client filter setting of Qt, but it must
3445 still listen for incoming connects unless it is stopped. */
3446 if ((!EQ (PVAR (p, filter), Qt) && !EQ (PVAR (p, command), Qt))
3447 || (EQ (PVAR (p, status), Qlisten) && NILP (PVAR (p, command))))
3449 FD_SET (inch, &input_wait_mask);
3450 FD_SET (inch, &non_keyboard_wait_mask);
3453 if (inch > max_process_desc)
3454 max_process_desc = inch;
3456 tem = Fplist_member (contact, QCcoding);
3457 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3458 tem = Qnil; /* No error message (too late!). */
3461 /* Setup coding systems for communicating with the network stream. */
3462 struct gcpro gcpro1;
3463 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3464 Lisp_Object coding_systems = Qt;
3465 Lisp_Object fargs[5], val;
3467 if (!NILP (tem))
3469 val = XCAR (XCDR (tem));
3470 if (CONSP (val))
3471 val = XCAR (val);
3473 else if (!NILP (Vcoding_system_for_read))
3474 val = Vcoding_system_for_read;
3475 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3476 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3477 /* We dare not decode end-of-line format by setting VAL to
3478 Qraw_text, because the existing Emacs Lisp libraries
3479 assume that they receive bare code including a sequence of
3480 CR LF. */
3481 val = Qnil;
3482 else
3484 if (NILP (host) || NILP (service))
3485 coding_systems = Qnil;
3486 else
3488 fargs[0] = Qopen_network_stream, fargs[1] = name,
3489 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3490 GCPRO1 (proc);
3491 coding_systems = Ffind_operation_coding_system (5, fargs);
3492 UNGCPRO;
3494 if (CONSP (coding_systems))
3495 val = XCAR (coding_systems);
3496 else if (CONSP (Vdefault_process_coding_system))
3497 val = XCAR (Vdefault_process_coding_system);
3498 else
3499 val = Qnil;
3501 PVAR (p, decode_coding_system) = val;
3503 if (!NILP (tem))
3505 val = XCAR (XCDR (tem));
3506 if (CONSP (val))
3507 val = XCDR (val);
3509 else if (!NILP (Vcoding_system_for_write))
3510 val = Vcoding_system_for_write;
3511 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3512 val = Qnil;
3513 else
3515 if (EQ (coding_systems, Qt))
3517 if (NILP (host) || NILP (service))
3518 coding_systems = Qnil;
3519 else
3521 fargs[0] = Qopen_network_stream, fargs[1] = name,
3522 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3523 GCPRO1 (proc);
3524 coding_systems = Ffind_operation_coding_system (5, fargs);
3525 UNGCPRO;
3528 if (CONSP (coding_systems))
3529 val = XCDR (coding_systems);
3530 else if (CONSP (Vdefault_process_coding_system))
3531 val = XCDR (Vdefault_process_coding_system);
3532 else
3533 val = Qnil;
3535 PVAR (p, encode_coding_system) = val;
3537 setup_process_coding_systems (proc);
3539 PVAR (p, decoding_buf) = empty_unibyte_string;
3540 p->decoding_carryover = 0;
3541 PVAR (p, encoding_buf) = empty_unibyte_string;
3543 p->inherit_coding_system_flag
3544 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3546 UNGCPRO;
3547 return proc;
3551 #if defined (HAVE_NET_IF_H)
3553 #ifdef SIOCGIFCONF
3554 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3555 doc: /* Return an alist of all network interfaces and their network address.
3556 Each element is a cons, the car of which is a string containing the
3557 interface name, and the cdr is the network address in internal
3558 format; see the description of ADDRESS in `make-network-process'. */)
3559 (void)
3561 struct ifconf ifconf;
3562 struct ifreq *ifreq;
3563 void *buf = NULL;
3564 ptrdiff_t buf_size = 512;
3565 int s, i;
3566 Lisp_Object res;
3568 s = socket (AF_INET, SOCK_STREAM, 0);
3569 if (s < 0)
3570 return Qnil;
3574 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3575 ifconf.ifc_buf = buf;
3576 ifconf.ifc_len = buf_size;
3577 if (ioctl (s, SIOCGIFCONF, &ifconf))
3579 close (s);
3580 xfree (buf);
3581 return Qnil;
3584 while (ifconf.ifc_len == buf_size);
3586 close (s);
3588 res = Qnil;
3589 ifreq = ifconf.ifc_req;
3590 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3592 struct ifreq *ifq = ifreq;
3593 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3594 #define SIZEOF_IFREQ(sif) \
3595 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3596 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3598 int len = SIZEOF_IFREQ (ifq);
3599 #else
3600 int len = sizeof (*ifreq);
3601 #endif
3602 char namebuf[sizeof (ifq->ifr_name) + 1];
3603 i += len;
3604 ifreq = (struct ifreq *) ((char *) ifreq + len);
3606 if (ifq->ifr_addr.sa_family != AF_INET)
3607 continue;
3609 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3610 namebuf[sizeof (ifq->ifr_name)] = 0;
3611 res = Fcons (Fcons (build_string (namebuf),
3612 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3613 sizeof (struct sockaddr))),
3614 res);
3617 xfree (buf);
3618 return res;
3620 #endif /* SIOCGIFCONF */
3622 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3624 struct ifflag_def {
3625 int flag_bit;
3626 const char *flag_sym;
3629 static const struct ifflag_def ifflag_table[] = {
3630 #ifdef IFF_UP
3631 { IFF_UP, "up" },
3632 #endif
3633 #ifdef IFF_BROADCAST
3634 { IFF_BROADCAST, "broadcast" },
3635 #endif
3636 #ifdef IFF_DEBUG
3637 { IFF_DEBUG, "debug" },
3638 #endif
3639 #ifdef IFF_LOOPBACK
3640 { IFF_LOOPBACK, "loopback" },
3641 #endif
3642 #ifdef IFF_POINTOPOINT
3643 { IFF_POINTOPOINT, "pointopoint" },
3644 #endif
3645 #ifdef IFF_RUNNING
3646 { IFF_RUNNING, "running" },
3647 #endif
3648 #ifdef IFF_NOARP
3649 { IFF_NOARP, "noarp" },
3650 #endif
3651 #ifdef IFF_PROMISC
3652 { IFF_PROMISC, "promisc" },
3653 #endif
3654 #ifdef IFF_NOTRAILERS
3655 #ifdef NS_IMPL_COCOA
3656 /* Really means smart, notrailers is obsolete */
3657 { IFF_NOTRAILERS, "smart" },
3658 #else
3659 { IFF_NOTRAILERS, "notrailers" },
3660 #endif
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 address, and
3706 FLAGS is the current flags of the interface. */)
3707 (Lisp_Object ifname)
3709 struct ifreq rq;
3710 Lisp_Object res = Qnil;
3711 Lisp_Object elt;
3712 int s;
3713 int any = 0;
3714 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3715 && defined HAVE_GETIFADDRS && defined LLADDR)
3716 struct ifaddrs *ifap;
3717 #endif
3719 CHECK_STRING (ifname);
3721 if (sizeof rq.ifr_name <= SBYTES (ifname))
3722 error ("interface name too long");
3723 strcpy (rq.ifr_name, SSDATA (ifname));
3725 s = socket (AF_INET, SOCK_STREAM, 0);
3726 if (s < 0)
3727 return Qnil;
3729 elt = Qnil;
3730 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3731 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3733 int flags = rq.ifr_flags;
3734 const struct ifflag_def *fp;
3735 int fnum;
3737 /* If flags is smaller than int (i.e. short) it may have the high bit set
3738 due to IFF_MULTICAST. In that case, sign extending it into
3739 an int is wrong. */
3740 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3741 flags = (unsigned short) rq.ifr_flags;
3743 any = 1;
3744 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3746 if (flags & fp->flag_bit)
3748 elt = Fcons (intern (fp->flag_sym), elt);
3749 flags -= fp->flag_bit;
3752 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3754 if (flags & 1)
3756 elt = Fcons (make_number (fnum), elt);
3760 #endif
3761 res = Fcons (elt, res);
3763 elt = Qnil;
3764 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3765 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3767 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3768 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3769 int n;
3771 any = 1;
3772 for (n = 0; n < 6; n++)
3773 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3774 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3776 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3777 if (getifaddrs (&ifap) != -1)
3779 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3780 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3781 struct ifaddrs *it;
3783 for (it = ifap; it != NULL; it = it->ifa_next)
3785 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3786 unsigned char linkaddr[6];
3787 int n;
3789 if (it->ifa_addr->sa_family != AF_LINK
3790 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3791 || sdl->sdl_alen != 6)
3792 continue;
3794 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3795 for (n = 0; n < 6; n++)
3796 p->contents[n] = make_number (linkaddr[n]);
3798 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3799 break;
3802 #ifdef HAVE_FREEIFADDRS
3803 freeifaddrs (ifap);
3804 #endif
3806 #endif /* HAVE_GETIFADDRS && LLADDR */
3808 res = Fcons (elt, res);
3810 elt = Qnil;
3811 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3812 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3814 any = 1;
3815 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3816 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3817 #else
3818 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3819 #endif
3821 #endif
3822 res = Fcons (elt, res);
3824 elt = Qnil;
3825 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3826 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3828 any = 1;
3829 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3831 #endif
3832 res = Fcons (elt, res);
3834 elt = Qnil;
3835 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3836 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3838 any = 1;
3839 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3841 #endif
3842 res = Fcons (elt, res);
3844 close (s);
3846 return any ? res : Qnil;
3848 #endif
3849 #endif /* defined (HAVE_NET_IF_H) */
3851 /* Turn off input and output for process PROC. */
3853 static void
3854 deactivate_process (Lisp_Object proc)
3856 register int inchannel, outchannel;
3857 register struct Lisp_Process *p = XPROCESS (proc);
3859 #ifdef HAVE_GNUTLS
3860 /* Delete GnuTLS structures in PROC, if any. */
3861 emacs_gnutls_deinit (proc);
3862 #endif /* HAVE_GNUTLS */
3864 inchannel = p->infd;
3865 outchannel = p->outfd;
3867 #ifdef ADAPTIVE_READ_BUFFERING
3868 if (p->read_output_delay > 0)
3870 if (--process_output_delay_count < 0)
3871 process_output_delay_count = 0;
3872 p->read_output_delay = 0;
3873 p->read_output_skip = 0;
3875 #endif
3877 if (inchannel >= 0)
3879 /* Beware SIGCHLD hereabouts. */
3880 flush_pending_output (inchannel);
3881 emacs_close (inchannel);
3882 if (outchannel >= 0 && outchannel != inchannel)
3883 emacs_close (outchannel);
3885 p->infd = -1;
3886 p->outfd = -1;
3887 #ifdef DATAGRAM_SOCKETS
3888 if (DATAGRAM_CHAN_P (inchannel))
3890 xfree (datagram_address[inchannel].sa);
3891 datagram_address[inchannel].sa = 0;
3892 datagram_address[inchannel].len = 0;
3894 #endif
3895 chan_process[inchannel] = Qnil;
3896 FD_CLR (inchannel, &input_wait_mask);
3897 FD_CLR (inchannel, &non_keyboard_wait_mask);
3898 #ifdef NON_BLOCKING_CONNECT
3899 if (FD_ISSET (inchannel, &connect_wait_mask))
3901 FD_CLR (inchannel, &connect_wait_mask);
3902 FD_CLR (inchannel, &write_mask);
3903 if (--num_pending_connects < 0)
3904 abort ();
3906 #endif
3907 if (inchannel == max_process_desc)
3909 int i;
3910 /* We just closed the highest-numbered process input descriptor,
3911 so recompute the highest-numbered one now. */
3912 max_process_desc = 0;
3913 for (i = 0; i < MAXDESC; i++)
3914 if (!NILP (chan_process[i]))
3915 max_process_desc = i;
3921 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3922 0, 4, 0,
3923 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3924 It is read into the process' buffers or given to their filter functions.
3925 Non-nil arg PROCESS means do not return until some output has been received
3926 from PROCESS.
3928 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3929 and milliseconds to wait; return after that much time whether or not
3930 there is any subprocess output. If SECONDS is a floating point number,
3931 it specifies a fractional number of seconds to wait.
3932 The MILLISEC argument is obsolete and should be avoided.
3934 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3935 from PROCESS, suspending reading output from other processes.
3936 If JUST-THIS-ONE is an integer, don't run any timers either.
3937 Return non-nil if we received any output before the timeout expired. */)
3938 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3940 intmax_t secs;
3941 int nsecs;
3943 if (! NILP (process))
3944 CHECK_PROCESS (process);
3945 else
3946 just_this_one = Qnil;
3948 if (!NILP (millisec))
3949 { /* Obsolete calling convention using integers rather than floats. */
3950 CHECK_NUMBER (millisec);
3951 if (NILP (seconds))
3952 seconds = make_float (XINT (millisec) / 1000.0);
3953 else
3955 CHECK_NUMBER (seconds);
3956 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3960 secs = 0;
3961 nsecs = -1;
3963 if (!NILP (seconds))
3965 if (INTEGERP (seconds))
3967 if (0 < XINT (seconds))
3969 secs = XINT (seconds);
3970 nsecs = 0;
3973 else if (FLOATP (seconds))
3975 if (0 < XFLOAT_DATA (seconds))
3977 EMACS_TIME t = EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (seconds));
3978 secs = min (EMACS_SECS (t), WAIT_READING_MAX);
3979 nsecs = EMACS_NSECS (t);
3982 else
3983 wrong_type_argument (Qnumberp, seconds);
3985 else if (! NILP (process))
3986 nsecs = 0;
3988 return
3989 (wait_reading_process_output (secs, nsecs, 0, 0,
3990 Qnil,
3991 !NILP (process) ? XPROCESS (process) : NULL,
3992 NILP (just_this_one) ? 0 :
3993 !INTEGERP (just_this_one) ? 1 : -1)
3994 ? Qt : Qnil);
3997 /* Accept a connection for server process SERVER on CHANNEL. */
3999 static int connect_counter = 0;
4001 static void
4002 server_accept_connection (Lisp_Object server, int channel)
4004 Lisp_Object proc, caller, name, buffer;
4005 Lisp_Object contact, host, service;
4006 struct Lisp_Process *ps= XPROCESS (server);
4007 struct Lisp_Process *p;
4008 int s;
4009 union u_sockaddr {
4010 struct sockaddr sa;
4011 struct sockaddr_in in;
4012 #ifdef AF_INET6
4013 struct sockaddr_in6 in6;
4014 #endif
4015 #ifdef HAVE_LOCAL_SOCKETS
4016 struct sockaddr_un un;
4017 #endif
4018 } saddr;
4019 socklen_t len = sizeof saddr;
4021 s = accept (channel, &saddr.sa, &len);
4023 if (s < 0)
4025 int code = errno;
4027 if (code == EAGAIN)
4028 return;
4029 #ifdef EWOULDBLOCK
4030 if (code == EWOULDBLOCK)
4031 return;
4032 #endif
4034 if (!NILP (PVAR (ps, log)))
4035 call3 (PVAR (ps, log), server, Qnil,
4036 concat3 (build_string ("accept failed with code"),
4037 Fnumber_to_string (make_number (code)),
4038 build_string ("\n")));
4039 return;
4042 connect_counter++;
4044 /* Setup a new process to handle the connection. */
4046 /* Generate a unique identification of the caller, and build contact
4047 information for this process. */
4048 host = Qt;
4049 service = Qnil;
4050 switch (saddr.sa.sa_family)
4052 case AF_INET:
4054 Lisp_Object args[5];
4055 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4056 args[0] = build_string ("%d.%d.%d.%d");
4057 args[1] = make_number (*ip++);
4058 args[2] = make_number (*ip++);
4059 args[3] = make_number (*ip++);
4060 args[4] = make_number (*ip++);
4061 host = Fformat (5, args);
4062 service = make_number (ntohs (saddr.in.sin_port));
4064 args[0] = build_string (" <%s:%d>");
4065 args[1] = host;
4066 args[2] = service;
4067 caller = Fformat (3, args);
4069 break;
4071 #ifdef AF_INET6
4072 case AF_INET6:
4074 Lisp_Object args[9];
4075 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4076 int i;
4077 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4078 for (i = 0; i < 8; i++)
4079 args[i+1] = make_number (ntohs (ip6[i]));
4080 host = Fformat (9, args);
4081 service = make_number (ntohs (saddr.in.sin_port));
4083 args[0] = build_string (" <[%s]:%d>");
4084 args[1] = host;
4085 args[2] = service;
4086 caller = Fformat (3, args);
4088 break;
4089 #endif
4091 #ifdef HAVE_LOCAL_SOCKETS
4092 case AF_LOCAL:
4093 #endif
4094 default:
4095 caller = Fnumber_to_string (make_number (connect_counter));
4096 caller = concat3 (build_string (" <"), caller, build_string (">"));
4097 break;
4100 /* Create a new buffer name for this process if it doesn't have a
4101 filter. The new buffer name is based on the buffer name or
4102 process name of the server process concatenated with the caller
4103 identification. */
4105 if (!NILP (PVAR (ps, filter)) && !EQ (PVAR (ps, filter), Qt))
4106 buffer = Qnil;
4107 else
4109 buffer = PVAR (ps, buffer);
4110 if (!NILP (buffer))
4111 buffer = Fbuffer_name (buffer);
4112 else
4113 buffer = PVAR (ps, name);
4114 if (!NILP (buffer))
4116 buffer = concat2 (buffer, caller);
4117 buffer = Fget_buffer_create (buffer);
4121 /* Generate a unique name for the new server process. Combine the
4122 server process name with the caller identification. */
4124 name = concat2 (PVAR (ps, name), caller);
4125 proc = make_process (name);
4127 chan_process[s] = proc;
4129 #ifdef O_NONBLOCK
4130 fcntl (s, F_SETFL, O_NONBLOCK);
4131 #else
4132 #ifdef O_NDELAY
4133 fcntl (s, F_SETFL, O_NDELAY);
4134 #endif
4135 #endif
4137 p = XPROCESS (proc);
4139 /* Build new contact information for this setup. */
4140 contact = Fcopy_sequence (PVAR (ps, childp));
4141 contact = Fplist_put (contact, QCserver, Qnil);
4142 contact = Fplist_put (contact, QChost, host);
4143 if (!NILP (service))
4144 contact = Fplist_put (contact, QCservice, service);
4145 contact = Fplist_put (contact, QCremote,
4146 conv_sockaddr_to_lisp (&saddr.sa, len));
4147 #ifdef HAVE_GETSOCKNAME
4148 len = sizeof saddr;
4149 if (getsockname (s, &saddr.sa, &len) == 0)
4150 contact = Fplist_put (contact, QClocal,
4151 conv_sockaddr_to_lisp (&saddr.sa, len));
4152 #endif
4154 PVAR (p, childp) = contact;
4155 PVAR (p, plist) = Fcopy_sequence (PVAR (ps, plist));
4156 PVAR (p, type) = Qnetwork;
4158 PVAR (p, buffer) = buffer;
4159 PVAR (p, sentinel) = PVAR (ps, sentinel);
4160 PVAR (p, filter) = PVAR (ps, filter);
4161 PVAR (p, command) = Qnil;
4162 p->pid = 0;
4163 p->infd = s;
4164 p->outfd = s;
4165 PVAR (p, status) = Qrun;
4167 /* Client processes for accepted connections are not stopped initially. */
4168 if (!EQ (PVAR (p, filter), Qt))
4170 FD_SET (s, &input_wait_mask);
4171 FD_SET (s, &non_keyboard_wait_mask);
4174 if (s > max_process_desc)
4175 max_process_desc = s;
4177 /* Setup coding system for new process based on server process.
4178 This seems to be the proper thing to do, as the coding system
4179 of the new process should reflect the settings at the time the
4180 server socket was opened; not the current settings. */
4182 PVAR (p, decode_coding_system) = PVAR (ps, decode_coding_system);
4183 PVAR (p, encode_coding_system) = PVAR (ps, encode_coding_system);
4184 setup_process_coding_systems (proc);
4186 PVAR (p, decoding_buf) = empty_unibyte_string;
4187 p->decoding_carryover = 0;
4188 PVAR (p, encoding_buf) = empty_unibyte_string;
4190 p->inherit_coding_system_flag
4191 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4193 if (!NILP (PVAR (ps, log)))
4194 call3 (PVAR (ps, log), server, proc,
4195 concat3 (build_string ("accept from "),
4196 (STRINGP (host) ? host : build_string ("-")),
4197 build_string ("\n")));
4199 if (!NILP (PVAR (p, sentinel)))
4200 exec_sentinel (proc,
4201 concat3 (build_string ("open from "),
4202 (STRINGP (host) ? host : build_string ("-")),
4203 build_string ("\n")));
4206 /* This variable is different from waiting_for_input in keyboard.c.
4207 It is used to communicate to a lisp process-filter/sentinel (via the
4208 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4209 for user-input when that process-filter was called.
4210 waiting_for_input cannot be used as that is by definition 0 when
4211 lisp code is being evalled.
4212 This is also used in record_asynch_buffer_change.
4213 For that purpose, this must be 0
4214 when not inside wait_reading_process_output. */
4215 static int waiting_for_user_input_p;
4217 static Lisp_Object
4218 wait_reading_process_output_unwind (Lisp_Object data)
4220 waiting_for_user_input_p = XINT (data);
4221 return Qnil;
4224 /* This is here so breakpoints can be put on it. */
4225 static void
4226 wait_reading_process_output_1 (void)
4230 /* Read and dispose of subprocess output while waiting for timeout to
4231 elapse and/or keyboard input to be available.
4233 TIME_LIMIT is:
4234 timeout in seconds
4235 If negative, gobble data immediately available but don't wait for any.
4237 NSECS is:
4238 an additional duration to wait, measured in nanoseconds
4239 If TIME_LIMIT is zero, then:
4240 If NSECS == 0, there is no limit.
4241 If NSECS > 0, the timeout consists of NSECS only.
4242 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4244 READ_KBD is:
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 (intmax_t time_limit, int nsecs, int read_kbd,
4270 int do_display,
4271 Lisp_Object wait_for_cell,
4272 struct Lisp_Process *wait_proc, int just_wait_proc)
4274 register int channel, nfds;
4275 SELECT_TYPE Available;
4276 SELECT_TYPE Writeok;
4277 int check_write;
4278 int check_delay, no_avail;
4279 int xerrno;
4280 Lisp_Object proc;
4281 EMACS_TIME timeout, end_time;
4282 int wait_channel = -1;
4283 int got_some_input = 0;
4284 ptrdiff_t count = SPECPDL_INDEX ();
4286 FD_ZERO (&Available);
4287 FD_ZERO (&Writeok);
4289 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4290 && !(CONSP (PVAR (wait_proc, status))
4291 && EQ (XCAR (PVAR (wait_proc, status)), Qexit)))
4292 message ("Blocking call to accept-process-output with quit inhibited!!");
4294 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4295 if (wait_proc != NULL)
4296 wait_channel = wait_proc->infd;
4298 record_unwind_protect (wait_reading_process_output_unwind,
4299 make_number (waiting_for_user_input_p));
4300 waiting_for_user_input_p = read_kbd;
4302 if (time_limit < 0)
4304 time_limit = 0;
4305 nsecs = -1;
4307 else if (TYPE_MAXIMUM (time_t) < time_limit)
4308 time_limit = TYPE_MAXIMUM (time_t);
4310 /* Since we may need to wait several times,
4311 compute the absolute time to return at. */
4312 if (time_limit || 0 < nsecs)
4314 timeout = make_emacs_time (time_limit, nsecs);
4315 end_time = add_emacs_time (current_emacs_time (), timeout);
4318 while (1)
4320 int timeout_reduced_for_timers = 0;
4322 /* If calling from keyboard input, do not quit
4323 since we want to return C-g as an input character.
4324 Otherwise, do pending quit if requested. */
4325 if (read_kbd >= 0)
4326 QUIT;
4327 #ifdef SYNC_INPUT
4328 else
4329 process_pending_signals ();
4330 #endif
4332 /* Exit now if the cell we're waiting for became non-nil. */
4333 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4334 break;
4336 /* Compute time from now till when time limit is up */
4337 /* Exit if already run out */
4338 if (nsecs < 0)
4340 /* A negative timeout means
4341 gobble output available now
4342 but don't wait at all. */
4344 timeout = make_emacs_time (0, 0);
4346 else if (time_limit || 0 < nsecs)
4348 EMACS_TIME now = current_emacs_time ();
4349 if (EMACS_TIME_LE (end_time, now))
4350 break;
4351 timeout = sub_emacs_time (end_time, now);
4353 else
4355 timeout = make_emacs_time (100000, 0);
4358 /* Normally we run timers here.
4359 But not if wait_for_cell; in those cases,
4360 the wait is supposed to be short,
4361 and those callers cannot handle running arbitrary Lisp code here. */
4362 if (NILP (wait_for_cell)
4363 && just_wait_proc >= 0)
4365 EMACS_TIME timer_delay;
4369 int old_timers_run = timers_run;
4370 struct buffer *old_buffer = current_buffer;
4371 Lisp_Object old_window = selected_window;
4373 timer_delay = timer_check ();
4375 /* If a timer has run, this might have changed buffers
4376 an alike. Make read_key_sequence aware of that. */
4377 if (timers_run != old_timers_run
4378 && (old_buffer != current_buffer
4379 || !EQ (old_window, selected_window))
4380 && waiting_for_user_input_p == -1)
4381 record_asynch_buffer_change ();
4383 if (timers_run != old_timers_run && do_display)
4384 /* We must retry, since a timer may have requeued itself
4385 and that could alter the time_delay. */
4386 redisplay_preserve_echo_area (9);
4387 else
4388 break;
4390 while (!detect_input_pending ());
4392 /* If there is unread keyboard input, also return. */
4393 if (read_kbd != 0
4394 && requeued_events_pending_p ())
4395 break;
4397 /* A negative timeout means do not wait at all. */
4398 if (0 <= nsecs)
4400 if (EMACS_TIME_VALID_P (timer_delay))
4402 if (EMACS_TIME_LT (timer_delay, timeout))
4404 timeout = timer_delay;
4405 timeout_reduced_for_timers = 1;
4408 else
4410 /* This is so a breakpoint can be put here. */
4411 wait_reading_process_output_1 ();
4416 /* Cause C-g and alarm signals to take immediate action,
4417 and cause input available signals to zero out timeout.
4419 It is important that we do this before checking for process
4420 activity. If we get a SIGCHLD after the explicit checks for
4421 process activity, timeout is the only way we will know. */
4422 if (read_kbd < 0)
4423 set_waiting_for_input (&timeout);
4425 /* If status of something has changed, and no input is
4426 available, notify the user of the change right away. After
4427 this explicit check, we'll let the SIGCHLD handler zap
4428 timeout to get our attention. */
4429 if (update_tick != process_tick)
4431 SELECT_TYPE Atemp;
4432 SELECT_TYPE Ctemp;
4434 if (kbd_on_hold_p ())
4435 FD_ZERO (&Atemp);
4436 else
4437 Atemp = input_wait_mask;
4438 Ctemp = write_mask;
4440 timeout = make_emacs_time (0, 0);
4441 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4442 &Atemp,
4443 #ifdef NON_BLOCKING_CONNECT
4444 (num_pending_connects > 0 ? &Ctemp : NULL),
4445 #else
4446 NULL,
4447 #endif
4448 NULL, &timeout, NULL)
4449 <= 0))
4451 /* It's okay for us to do this and then continue with
4452 the loop, since timeout has already been zeroed out. */
4453 clear_waiting_for_input ();
4454 status_notify (NULL);
4455 if (do_display) redisplay_preserve_echo_area (13);
4459 /* Don't wait for output from a non-running process. Just
4460 read whatever data has already been received. */
4461 if (wait_proc && wait_proc->raw_status_new)
4462 update_status (wait_proc);
4463 if (wait_proc
4464 && ! EQ (PVAR (wait_proc, status), Qrun)
4465 && ! EQ (PVAR (wait_proc, status), Qconnect))
4467 int nread, total_nread = 0;
4469 clear_waiting_for_input ();
4470 XSETPROCESS (proc, wait_proc);
4472 /* Read data from the process, until we exhaust it. */
4473 while (wait_proc->infd >= 0)
4475 nread = read_process_output (proc, wait_proc->infd);
4477 if (nread == 0)
4478 break;
4480 if (0 < nread)
4482 total_nread += nread;
4483 got_some_input = 1;
4485 #ifdef EIO
4486 else if (nread == -1 && EIO == errno)
4487 break;
4488 #endif
4489 #ifdef EAGAIN
4490 else if (nread == -1 && EAGAIN == errno)
4491 break;
4492 #endif
4493 #ifdef EWOULDBLOCK
4494 else if (nread == -1 && EWOULDBLOCK == errno)
4495 break;
4496 #endif
4498 if (total_nread > 0 && do_display)
4499 redisplay_preserve_echo_area (10);
4501 break;
4504 /* Wait till there is something to do */
4506 if (wait_proc && just_wait_proc)
4508 if (wait_proc->infd < 0) /* Terminated */
4509 break;
4510 FD_SET (wait_proc->infd, &Available);
4511 check_delay = 0;
4512 check_write = 0;
4514 else if (!NILP (wait_for_cell))
4516 Available = non_process_wait_mask;
4517 check_delay = 0;
4518 check_write = 0;
4520 else
4522 if (! read_kbd)
4523 Available = non_keyboard_wait_mask;
4524 else
4525 Available = input_wait_mask;
4526 Writeok = write_mask;
4527 #ifdef SELECT_CANT_DO_WRITE_MASK
4528 check_write = 0;
4529 #else
4530 check_write = 1;
4531 #endif
4532 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4535 /* If frame size has changed or the window is newly mapped,
4536 redisplay now, before we start to wait. There is a race
4537 condition here; if a SIGIO arrives between now and the select
4538 and indicates that a frame is trashed, the select may block
4539 displaying a trashed screen. */
4540 if (frame_garbaged && do_display)
4542 clear_waiting_for_input ();
4543 redisplay_preserve_echo_area (11);
4544 if (read_kbd < 0)
4545 set_waiting_for_input (&timeout);
4548 /* Skip the `select' call if input is available and we're
4549 waiting for keyboard input or a cell change (which can be
4550 triggered by processing X events). In the latter case, set
4551 nfds to 1 to avoid breaking the loop. */
4552 no_avail = 0;
4553 if ((read_kbd || !NILP (wait_for_cell))
4554 && detect_input_pending ())
4556 nfds = read_kbd ? 0 : 1;
4557 no_avail = 1;
4560 if (!no_avail)
4563 #ifdef ADAPTIVE_READ_BUFFERING
4564 /* Set the timeout for adaptive read buffering if any
4565 process has non-zero read_output_skip and non-zero
4566 read_output_delay, and we are not reading output for a
4567 specific wait_channel. It is not executed if
4568 Vprocess_adaptive_read_buffering is nil. */
4569 if (process_output_skip && check_delay > 0)
4571 int nsecs = EMACS_NSECS (timeout);
4572 if (EMACS_SECS (timeout) > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4573 nsecs = READ_OUTPUT_DELAY_MAX;
4574 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4576 proc = chan_process[channel];
4577 if (NILP (proc))
4578 continue;
4579 /* Find minimum non-zero read_output_delay among the
4580 processes with non-zero read_output_skip. */
4581 if (XPROCESS (proc)->read_output_delay > 0)
4583 check_delay--;
4584 if (!XPROCESS (proc)->read_output_skip)
4585 continue;
4586 FD_CLR (channel, &Available);
4587 XPROCESS (proc)->read_output_skip = 0;
4588 if (XPROCESS (proc)->read_output_delay < nsecs)
4589 nsecs = XPROCESS (proc)->read_output_delay;
4592 timeout = make_emacs_time (0, nsecs);
4593 process_output_skip = 0;
4595 #endif
4596 #if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
4597 nfds = xg_select
4598 #elif defined (HAVE_NS)
4599 nfds = ns_select
4600 #else
4601 nfds = pselect
4602 #endif
4603 (max (max_process_desc, max_input_desc) + 1,
4604 &Available,
4605 (check_write ? &Writeok : (SELECT_TYPE *)0),
4606 NULL, &timeout, NULL);
4608 #ifdef HAVE_GNUTLS
4609 /* GnuTLS buffers data internally. In lowat mode it leaves
4610 some data in the TCP buffers so that select works, but
4611 with custom pull/push functions we need to check if some
4612 data is available in the buffers manually. */
4613 if (nfds == 0)
4615 if (! wait_proc)
4617 /* We're not waiting on a specific process, so loop
4618 through all the channels and check for data.
4619 This is a workaround needed for some versions of
4620 the gnutls library -- 2.12.14 has been confirmed
4621 to need it. See
4622 http://comments.gmane.org/gmane.emacs.devel/145074 */
4623 for (channel = 0; channel < MAXDESC; ++channel)
4624 if (! NILP (chan_process[channel]))
4626 struct Lisp_Process *p =
4627 XPROCESS (chan_process[channel]);
4628 if (p && p->gnutls_p && p->infd
4629 && ((emacs_gnutls_record_check_pending
4630 (p->gnutls_state))
4631 > 0))
4633 nfds++;
4634 FD_SET (p->infd, &Available);
4638 else
4640 /* Check this specific channel. */
4641 if (wait_proc->gnutls_p /* Check for valid process. */
4642 /* Do we have pending data? */
4643 && ((emacs_gnutls_record_check_pending
4644 (wait_proc->gnutls_state))
4645 > 0))
4647 nfds = 1;
4648 /* Set to Available. */
4649 FD_SET (wait_proc->infd, &Available);
4653 #endif
4656 xerrno = errno;
4658 /* Make C-g and alarm signals set flags again */
4659 clear_waiting_for_input ();
4661 /* If we woke up due to SIGWINCH, actually change size now. */
4662 do_pending_window_change (0);
4664 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4665 /* We waited the full specified time, so return now. */
4666 break;
4667 if (nfds < 0)
4669 if (xerrno == EINTR)
4670 no_avail = 1;
4671 else if (xerrno == EBADF)
4673 #ifdef AIX
4674 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
4675 the child's closure of the pts gives the parent a SIGHUP, and
4676 the ptc file descriptor is automatically closed,
4677 yielding EBADF here or at select() call above.
4678 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
4679 in m/ibmrt-aix.h), and here we just ignore the select error.
4680 Cleanup occurs c/o status_notify after SIGCLD. */
4681 no_avail = 1; /* Cannot depend on values returned */
4682 #else
4683 abort ();
4684 #endif
4686 else
4687 error ("select error: %s", emacs_strerror (xerrno));
4690 if (no_avail)
4692 FD_ZERO (&Available);
4693 check_write = 0;
4696 #if 0 /* When polling is used, interrupt_input is 0,
4697 so get_input_pending should read the input.
4698 So this should not be needed. */
4699 /* If we are using polling for input,
4700 and we see input available, make it get read now.
4701 Otherwise it might not actually get read for a second.
4702 And on hpux, since we turn off polling in wait_reading_process_output,
4703 it might never get read at all if we don't spend much time
4704 outside of wait_reading_process_output. */
4705 if (read_kbd && interrupt_input
4706 && keyboard_bit_set (&Available)
4707 && input_polling_used ())
4708 kill (getpid (), SIGALRM);
4709 #endif
4711 /* Check for keyboard input */
4712 /* If there is any, return immediately
4713 to give it higher priority than subprocesses */
4715 if (read_kbd != 0)
4717 int old_timers_run = timers_run;
4718 struct buffer *old_buffer = current_buffer;
4719 Lisp_Object old_window = selected_window;
4720 int leave = 0;
4722 if (detect_input_pending_run_timers (do_display))
4724 swallow_events (do_display);
4725 if (detect_input_pending_run_timers (do_display))
4726 leave = 1;
4729 /* If a timer has run, this might have changed buffers
4730 an alike. Make read_key_sequence aware of that. */
4731 if (timers_run != old_timers_run
4732 && waiting_for_user_input_p == -1
4733 && (old_buffer != current_buffer
4734 || !EQ (old_window, selected_window)))
4735 record_asynch_buffer_change ();
4737 if (leave)
4738 break;
4741 /* If there is unread keyboard input, also return. */
4742 if (read_kbd != 0
4743 && requeued_events_pending_p ())
4744 break;
4746 /* If we are not checking for keyboard input now,
4747 do process events (but don't run any timers).
4748 This is so that X events will be processed.
4749 Otherwise they may have to wait until polling takes place.
4750 That would causes delays in pasting selections, for example.
4752 (We used to do this only if wait_for_cell.) */
4753 if (read_kbd == 0 && detect_input_pending ())
4755 swallow_events (do_display);
4756 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4757 if (detect_input_pending ())
4758 break;
4759 #endif
4762 /* Exit now if the cell we're waiting for became non-nil. */
4763 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4764 break;
4766 #ifdef SIGIO
4767 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4768 go read it. This can happen with X on BSD after logging out.
4769 In that case, there really is no input and no SIGIO,
4770 but select says there is input. */
4772 if (read_kbd && interrupt_input
4773 && keyboard_bit_set (&Available) && ! noninteractive)
4774 kill (getpid (), SIGIO);
4775 #endif
4777 if (! wait_proc)
4778 got_some_input |= nfds > 0;
4780 /* If checking input just got us a size-change event from X,
4781 obey it now if we should. */
4782 if (read_kbd || ! NILP (wait_for_cell))
4783 do_pending_window_change (0);
4785 /* Check for data from a process. */
4786 if (no_avail || nfds == 0)
4787 continue;
4789 for (channel = 0; channel <= max_input_desc; ++channel)
4791 struct fd_callback_data *d = &fd_callback_info[channel];
4792 if (FD_ISSET (channel, &Available)
4793 && d->func != 0
4794 && (d->condition & FOR_READ) != 0)
4795 d->func (channel, d->data, 1);
4796 if (FD_ISSET (channel, &write_mask)
4797 && d->func != 0
4798 && (d->condition & FOR_WRITE) != 0)
4799 d->func (channel, d->data, 0);
4802 for (channel = 0; channel <= max_process_desc; channel++)
4804 if (FD_ISSET (channel, &Available)
4805 && FD_ISSET (channel, &non_keyboard_wait_mask)
4806 && !FD_ISSET (channel, &non_process_wait_mask))
4808 int nread;
4810 /* If waiting for this channel, arrange to return as
4811 soon as no more input to be processed. No more
4812 waiting. */
4813 if (wait_channel == channel)
4815 wait_channel = -1;
4816 nsecs = -1;
4817 got_some_input = 1;
4819 proc = chan_process[channel];
4820 if (NILP (proc))
4821 continue;
4823 /* If this is a server stream socket, accept connection. */
4824 if (EQ (PVAR (XPROCESS (proc), status), Qlisten))
4826 server_accept_connection (proc, channel);
4827 continue;
4830 /* Read data from the process, starting with our
4831 buffered-ahead character if we have one. */
4833 nread = read_process_output (proc, channel);
4834 if (nread > 0)
4836 /* Since read_process_output can run a filter,
4837 which can call accept-process-output,
4838 don't try to read from any other processes
4839 before doing the select again. */
4840 FD_ZERO (&Available);
4842 if (do_display)
4843 redisplay_preserve_echo_area (12);
4845 #ifdef EWOULDBLOCK
4846 else if (nread == -1 && errno == EWOULDBLOCK)
4848 #endif
4849 /* ISC 4.1 defines both EWOULDBLOCK and O_NONBLOCK,
4850 and Emacs uses O_NONBLOCK, so what we get is EAGAIN. */
4851 #ifdef O_NONBLOCK
4852 else if (nread == -1 && errno == EAGAIN)
4854 #else
4855 #ifdef O_NDELAY
4856 else if (nread == -1 && errno == EAGAIN)
4858 /* Note that we cannot distinguish between no input
4859 available now and a closed pipe.
4860 With luck, a closed pipe will be accompanied by
4861 subprocess termination and SIGCHLD. */
4862 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4864 #endif /* O_NDELAY */
4865 #endif /* O_NONBLOCK */
4866 #ifdef HAVE_PTYS
4867 /* On some OSs with ptys, when the process on one end of
4868 a pty exits, the other end gets an error reading with
4869 errno = EIO instead of getting an EOF (0 bytes read).
4870 Therefore, if we get an error reading and errno =
4871 EIO, just continue, because the child process has
4872 exited and should clean itself up soon (e.g. when we
4873 get a SIGCHLD).
4875 However, it has been known to happen that the SIGCHLD
4876 got lost. So raise the signal again just in case.
4877 It can't hurt. */
4878 else if (nread == -1 && errno == EIO)
4880 struct Lisp_Process *p = XPROCESS (proc);
4882 /* Clear the descriptor now, so we only raise the
4883 signal once. */
4884 FD_CLR (channel, &input_wait_mask);
4885 FD_CLR (channel, &non_keyboard_wait_mask);
4887 if (p->pid == -2)
4889 /* If the EIO occurs on a pty, sigchld_handler's
4890 waitpid() will not find the process object to
4891 delete. Do it here. */
4892 p->tick = ++process_tick;
4893 PVAR (p, status) = Qfailed;
4895 else
4896 kill (getpid (), SIGCHLD);
4898 #endif /* HAVE_PTYS */
4899 /* If we can detect process termination, don't consider the
4900 process gone just because its pipe is closed. */
4901 #ifdef SIGCHLD
4902 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4904 #endif
4905 else
4907 /* Preserve status of processes already terminated. */
4908 XPROCESS (proc)->tick = ++process_tick;
4909 deactivate_process (proc);
4910 if (XPROCESS (proc)->raw_status_new)
4911 update_status (XPROCESS (proc));
4912 if (EQ (PVAR (XPROCESS (proc), status), Qrun))
4913 PVAR (XPROCESS (proc), status)
4914 = Fcons (Qexit, Fcons (make_number (256), Qnil));
4917 #ifdef NON_BLOCKING_CONNECT
4918 if (FD_ISSET (channel, &Writeok)
4919 && FD_ISSET (channel, &connect_wait_mask))
4921 struct Lisp_Process *p;
4923 FD_CLR (channel, &connect_wait_mask);
4924 FD_CLR (channel, &write_mask);
4925 if (--num_pending_connects < 0)
4926 abort ();
4928 proc = chan_process[channel];
4929 if (NILP (proc))
4930 continue;
4932 p = XPROCESS (proc);
4934 #ifdef GNU_LINUX
4935 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4936 So only use it on systems where it is known to work. */
4938 socklen_t xlen = sizeof (xerrno);
4939 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4940 xerrno = errno;
4942 #else
4944 struct sockaddr pname;
4945 int pnamelen = sizeof (pname);
4947 /* If connection failed, getpeername will fail. */
4948 xerrno = 0;
4949 if (getpeername (channel, &pname, &pnamelen) < 0)
4951 /* Obtain connect failure code through error slippage. */
4952 char dummy;
4953 xerrno = errno;
4954 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4955 xerrno = errno;
4958 #endif
4959 if (xerrno)
4961 p->tick = ++process_tick;
4962 PVAR (p, status)
4963 = Fcons (Qfailed, Fcons (make_number (xerrno), Qnil));
4964 deactivate_process (proc);
4966 else
4968 PVAR (p, status) = Qrun;
4969 /* Execute the sentinel here. If we had relied on
4970 status_notify to do it later, it will read input
4971 from the process before calling the sentinel. */
4972 exec_sentinel (proc, build_string ("open\n"));
4973 if (!EQ (PVAR (p, filter), Qt) && !EQ (PVAR (p, command), Qt))
4975 FD_SET (p->infd, &input_wait_mask);
4976 FD_SET (p->infd, &non_keyboard_wait_mask);
4980 #endif /* NON_BLOCKING_CONNECT */
4981 } /* end for each file descriptor */
4982 } /* end while exit conditions not met */
4984 unbind_to (count, Qnil);
4986 /* If calling from keyboard input, do not quit
4987 since we want to return C-g as an input character.
4988 Otherwise, do pending quit if requested. */
4989 if (read_kbd >= 0)
4991 /* Prevent input_pending from remaining set if we quit. */
4992 clear_input_pending ();
4993 QUIT;
4996 return got_some_input;
4999 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
5001 static Lisp_Object
5002 read_process_output_call (Lisp_Object fun_and_args)
5004 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
5007 static Lisp_Object
5008 read_process_output_error_handler (Lisp_Object error_val)
5010 cmd_error_internal (error_val, "error in process filter: ");
5011 Vinhibit_quit = Qt;
5012 update_echo_area ();
5013 Fsleep_for (make_number (2), Qnil);
5014 return Qt;
5017 /* Read pending output from the process channel,
5018 starting with our buffered-ahead character if we have one.
5019 Yield number of decoded characters read.
5021 This function reads at most 4096 characters.
5022 If you want to read all available subprocess output,
5023 you must call it repeatedly until it returns zero.
5025 The characters read are decoded according to PROC's coding-system
5026 for decoding. */
5028 static int
5029 read_process_output (Lisp_Object proc, register int channel)
5031 register ssize_t nbytes;
5032 char *chars;
5033 register Lisp_Object outstream;
5034 register struct Lisp_Process *p = XPROCESS (proc);
5035 register ptrdiff_t opoint;
5036 struct coding_system *coding = proc_decode_coding_system[channel];
5037 int carryover = p->decoding_carryover;
5038 int readmax = 4096;
5039 ptrdiff_t count = SPECPDL_INDEX ();
5040 Lisp_Object odeactivate;
5042 chars = alloca (carryover + readmax);
5043 if (carryover)
5044 /* See the comment above. */
5045 memcpy (chars, SDATA (PVAR (p, decoding_buf)), carryover);
5047 #ifdef DATAGRAM_SOCKETS
5048 /* We have a working select, so proc_buffered_char is always -1. */
5049 if (DATAGRAM_CHAN_P (channel))
5051 socklen_t len = datagram_address[channel].len;
5052 nbytes = recvfrom (channel, chars + carryover, readmax,
5053 0, datagram_address[channel].sa, &len);
5055 else
5056 #endif
5058 int buffered = 0 <= proc_buffered_char[channel];
5059 if (buffered)
5061 chars[carryover] = proc_buffered_char[channel];
5062 proc_buffered_char[channel] = -1;
5064 #ifdef HAVE_GNUTLS
5065 if (p->gnutls_p)
5066 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
5067 readmax - buffered);
5068 else
5069 #endif
5070 nbytes = emacs_read (channel, chars + carryover + buffered,
5071 readmax - buffered);
5072 #ifdef ADAPTIVE_READ_BUFFERING
5073 if (nbytes > 0 && p->adaptive_read_buffering)
5075 int delay = p->read_output_delay;
5076 if (nbytes < 256)
5078 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5080 if (delay == 0)
5081 process_output_delay_count++;
5082 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5085 else if (delay > 0 && nbytes == readmax - buffered)
5087 delay -= READ_OUTPUT_DELAY_INCREMENT;
5088 if (delay == 0)
5089 process_output_delay_count--;
5091 p->read_output_delay = delay;
5092 if (delay)
5094 p->read_output_skip = 1;
5095 process_output_skip = 1;
5098 #endif
5099 nbytes += buffered;
5100 nbytes += buffered && nbytes <= 0;
5103 p->decoding_carryover = 0;
5105 /* At this point, NBYTES holds number of bytes just received
5106 (including the one in proc_buffered_char[channel]). */
5107 if (nbytes <= 0)
5109 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5110 return nbytes;
5111 coding->mode |= CODING_MODE_LAST_BLOCK;
5114 /* Now set NBYTES how many bytes we must decode. */
5115 nbytes += carryover;
5117 odeactivate = Vdeactivate_mark;
5118 /* There's no good reason to let process filters change the current
5119 buffer, and many callers of accept-process-output, sit-for, and
5120 friends don't expect current-buffer to be changed from under them. */
5121 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
5123 /* Read and dispose of the process output. */
5124 outstream = PVAR (p, filter);
5125 if (!NILP (outstream))
5127 Lisp_Object text;
5128 int outer_running_asynch_code = running_asynch_code;
5129 int waiting = waiting_for_user_input_p;
5131 /* No need to gcpro these, because all we do with them later
5132 is test them for EQness, and none of them should be a string. */
5133 #if 0
5134 Lisp_Object obuffer, okeymap;
5135 XSETBUFFER (obuffer, current_buffer);
5136 okeymap = BVAR (current_buffer, keymap);
5137 #endif
5139 /* We inhibit quit here instead of just catching it so that
5140 hitting ^G when a filter happens to be running won't screw
5141 it up. */
5142 specbind (Qinhibit_quit, Qt);
5143 specbind (Qlast_nonmenu_event, Qt);
5145 /* In case we get recursively called,
5146 and we already saved the match data nonrecursively,
5147 save the same match data in safely recursive fashion. */
5148 if (outer_running_asynch_code)
5150 Lisp_Object tem;
5151 /* Don't clobber the CURRENT match data, either! */
5152 tem = Fmatch_data (Qnil, Qnil, Qnil);
5153 restore_search_regs ();
5154 record_unwind_save_match_data ();
5155 Fset_match_data (tem, Qt);
5158 /* For speed, if a search happens within this code,
5159 save the match data in a special nonrecursive fashion. */
5160 running_asynch_code = 1;
5162 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5163 text = coding->dst_object;
5164 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5165 /* A new coding system might be found. */
5166 if (!EQ (PVAR (p, decode_coding_system), Vlast_coding_system_used))
5168 PVAR (p, decode_coding_system) = Vlast_coding_system_used;
5170 /* Don't call setup_coding_system for
5171 proc_decode_coding_system[channel] here. It is done in
5172 detect_coding called via decode_coding above. */
5174 /* If a coding system for encoding is not yet decided, we set
5175 it as the same as coding-system for decoding.
5177 But, before doing that we must check if
5178 proc_encode_coding_system[p->outfd] surely points to a
5179 valid memory because p->outfd will be changed once EOF is
5180 sent to the process. */
5181 if (NILP (PVAR (p, encode_coding_system))
5182 && proc_encode_coding_system[p->outfd])
5184 PVAR (p, encode_coding_system)
5185 = coding_inherit_eol_type (Vlast_coding_system_used, Qnil);
5186 setup_coding_system (PVAR (p, encode_coding_system),
5187 proc_encode_coding_system[p->outfd]);
5191 if (coding->carryover_bytes > 0)
5193 if (SCHARS (PVAR (p, decoding_buf)) < coding->carryover_bytes)
5194 PVAR (p, decoding_buf) = make_uninit_string (coding->carryover_bytes);
5195 memcpy (SDATA (PVAR (p, decoding_buf)), coding->carryover,
5196 coding->carryover_bytes);
5197 p->decoding_carryover = coding->carryover_bytes;
5199 if (SBYTES (text) > 0)
5200 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5201 sometimes it's simply wrong to wrap (e.g. when called from
5202 accept-process-output). */
5203 internal_condition_case_1 (read_process_output_call,
5204 Fcons (outstream,
5205 Fcons (proc, Fcons (text, Qnil))),
5206 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5207 read_process_output_error_handler);
5209 /* If we saved the match data nonrecursively, restore it now. */
5210 restore_search_regs ();
5211 running_asynch_code = outer_running_asynch_code;
5213 /* Restore waiting_for_user_input_p as it was
5214 when we were called, in case the filter clobbered it. */
5215 waiting_for_user_input_p = waiting;
5217 #if 0 /* Call record_asynch_buffer_change unconditionally,
5218 because we might have changed minor modes or other things
5219 that affect key bindings. */
5220 if (! EQ (Fcurrent_buffer (), obuffer)
5221 || ! EQ (current_buffer->keymap, okeymap))
5222 #endif
5223 /* But do it only if the caller is actually going to read events.
5224 Otherwise there's no need to make him wake up, and it could
5225 cause trouble (for example it would make sit_for return). */
5226 if (waiting_for_user_input_p == -1)
5227 record_asynch_buffer_change ();
5230 /* If no filter, write into buffer if it isn't dead. */
5231 else if (!NILP (PVAR (p, buffer)) && !NILP (BVAR (XBUFFER (PVAR (p, buffer)), name)))
5233 Lisp_Object old_read_only;
5234 ptrdiff_t old_begv, old_zv;
5235 ptrdiff_t old_begv_byte, old_zv_byte;
5236 ptrdiff_t before, before_byte;
5237 ptrdiff_t opoint_byte;
5238 Lisp_Object text;
5239 struct buffer *b;
5241 Fset_buffer (PVAR (p, buffer));
5242 opoint = PT;
5243 opoint_byte = PT_BYTE;
5244 old_read_only = BVAR (current_buffer, read_only);
5245 old_begv = BEGV;
5246 old_zv = ZV;
5247 old_begv_byte = BEGV_BYTE;
5248 old_zv_byte = ZV_BYTE;
5250 BVAR (current_buffer, read_only) = Qnil;
5252 /* Insert new output into buffer
5253 at the current end-of-output marker,
5254 thus preserving logical ordering of input and output. */
5255 if (XMARKER (PVAR (p, mark))->buffer)
5256 SET_PT_BOTH (clip_to_bounds (BEGV,
5257 marker_position (PVAR (p, mark)), ZV),
5258 clip_to_bounds (BEGV_BYTE,
5259 marker_byte_position (PVAR (p, mark)),
5260 ZV_BYTE));
5261 else
5262 SET_PT_BOTH (ZV, ZV_BYTE);
5263 before = PT;
5264 before_byte = PT_BYTE;
5266 /* If the output marker is outside of the visible region, save
5267 the restriction and widen. */
5268 if (! (BEGV <= PT && PT <= ZV))
5269 Fwiden ();
5271 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5272 text = coding->dst_object;
5273 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5274 /* A new coding system might be found. See the comment in the
5275 similar code in the previous `if' block. */
5276 if (!EQ (PVAR (p, decode_coding_system), Vlast_coding_system_used))
5278 PVAR (p, decode_coding_system) = Vlast_coding_system_used;
5279 if (NILP (PVAR (p, encode_coding_system))
5280 && proc_encode_coding_system[p->outfd])
5282 PVAR (p, encode_coding_system)
5283 = coding_inherit_eol_type (Vlast_coding_system_used, Qnil);
5284 setup_coding_system (PVAR (p, encode_coding_system),
5285 proc_encode_coding_system[p->outfd]);
5288 if (coding->carryover_bytes > 0)
5290 if (SCHARS (PVAR (p, decoding_buf)) < coding->carryover_bytes)
5291 PVAR (p, decoding_buf) = make_uninit_string (coding->carryover_bytes);
5292 memcpy (SDATA (PVAR (p, decoding_buf)), coding->carryover,
5293 coding->carryover_bytes);
5294 p->decoding_carryover = coding->carryover_bytes;
5296 /* Adjust the multibyteness of TEXT to that of the buffer. */
5297 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5298 != ! STRING_MULTIBYTE (text))
5299 text = (STRING_MULTIBYTE (text)
5300 ? Fstring_as_unibyte (text)
5301 : Fstring_to_multibyte (text));
5302 /* Insert before markers in case we are inserting where
5303 the buffer's mark is, and the user's next command is Meta-y. */
5304 insert_from_string_before_markers (text, 0, 0,
5305 SCHARS (text), SBYTES (text), 0);
5307 /* Make sure the process marker's position is valid when the
5308 process buffer is changed in the signal_after_change above.
5309 W3 is known to do that. */
5310 if (BUFFERP (PVAR (p, buffer))
5311 && (b = XBUFFER (PVAR (p, buffer)), b != current_buffer))
5312 set_marker_both (PVAR (p, mark), PVAR (p, buffer), BUF_PT (b), BUF_PT_BYTE (b));
5313 else
5314 set_marker_both (PVAR (p, mark), PVAR (p, buffer), PT, PT_BYTE);
5316 update_mode_lines++;
5318 /* Make sure opoint and the old restrictions
5319 float ahead of any new text just as point would. */
5320 if (opoint >= before)
5322 opoint += PT - before;
5323 opoint_byte += PT_BYTE - before_byte;
5325 if (old_begv > before)
5327 old_begv += PT - before;
5328 old_begv_byte += PT_BYTE - before_byte;
5330 if (old_zv >= before)
5332 old_zv += PT - before;
5333 old_zv_byte += PT_BYTE - before_byte;
5336 /* If the restriction isn't what it should be, set it. */
5337 if (old_begv != BEGV || old_zv != ZV)
5338 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5341 BVAR (current_buffer, read_only) = old_read_only;
5342 SET_PT_BOTH (opoint, opoint_byte);
5344 /* Handling the process output should not deactivate the mark. */
5345 Vdeactivate_mark = odeactivate;
5347 unbind_to (count, Qnil);
5348 return nbytes;
5351 /* Sending data to subprocess */
5353 static jmp_buf send_process_frame;
5354 static Lisp_Object process_sent_to;
5356 #ifndef FORWARD_SIGNAL_TO_MAIN_THREAD
5357 static _Noreturn void send_process_trap (int);
5358 #endif
5360 static void
5361 send_process_trap (int ignore)
5363 SIGNAL_THREAD_CHECK (SIGPIPE);
5364 sigunblock (sigmask (SIGPIPE));
5365 longjmp (send_process_frame, 1);
5368 /* In send_process, when a write fails temporarily,
5369 wait_reading_process_output is called. It may execute user code,
5370 e.g. timers, that attempts to write new data to the same process.
5371 We must ensure that data is sent in the right order, and not
5372 interspersed half-completed with other writes (Bug#10815). This is
5373 handled by the write_queue element of struct process. It is a list
5374 with each entry having the form
5376 (string . (offset . length))
5378 where STRING is a lisp string, OFFSET is the offset into the
5379 string's byte sequence from which we should begin to send, and
5380 LENGTH is the number of bytes left to send. */
5382 /* Create a new entry in write_queue.
5383 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5384 BUF is a pointer to the string sequence of the input_obj or a C
5385 string in case of Qt or Qnil. */
5387 static void
5388 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5389 const char *buf, ptrdiff_t len, int front)
5391 ptrdiff_t offset;
5392 Lisp_Object entry, obj;
5394 if (STRINGP (input_obj))
5396 offset = buf - SSDATA (input_obj);
5397 obj = input_obj;
5399 else
5401 offset = 0;
5402 obj = make_unibyte_string (buf, len);
5405 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5407 if (front)
5408 PVAR (p, write_queue) = Fcons (entry, PVAR (p, write_queue));
5409 else
5410 PVAR (p, write_queue) = nconc2 (PVAR (p, write_queue), Fcons (entry, Qnil));
5413 /* Remove the first element in the write_queue of process P, put its
5414 contents in OBJ, BUF and LEN, and return non-zero. If the
5415 write_queue is empty, return zero. */
5417 static int
5418 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5419 const char **buf, ptrdiff_t *len)
5421 Lisp_Object entry, offset_length;
5422 ptrdiff_t offset;
5424 if (NILP (PVAR (p, write_queue)))
5425 return 0;
5427 entry = XCAR (PVAR (p, write_queue));
5428 PVAR (p, write_queue) = XCDR (PVAR (p, write_queue));
5430 *obj = XCAR (entry);
5431 offset_length = XCDR (entry);
5433 *len = XINT (XCDR (offset_length));
5434 offset = XINT (XCAR (offset_length));
5435 *buf = SSDATA (*obj) + offset;
5437 return 1;
5440 /* Send some data to process PROC.
5441 BUF is the beginning of the data; LEN is the number of characters.
5442 OBJECT is the Lisp object that the data comes from. If OBJECT is
5443 nil or t, it means that the data comes from C string.
5445 If OBJECT is not nil, the data is encoded by PROC's coding-system
5446 for encoding before it is sent.
5448 This function can evaluate Lisp code and can garbage collect. */
5450 static void
5451 send_process (volatile Lisp_Object proc, const char *volatile buf,
5452 volatile ptrdiff_t len, volatile Lisp_Object object)
5454 /* Use volatile to protect variables from being clobbered by longjmp. */
5455 struct Lisp_Process *p = XPROCESS (proc);
5456 ssize_t rv;
5457 struct coding_system *coding;
5458 void (*volatile old_sigpipe) (int);
5460 if (p->raw_status_new)
5461 update_status (p);
5462 if (! EQ (PVAR (p, status), Qrun))
5463 error ("Process %s not running", SDATA (PVAR (p, name)));
5464 if (p->outfd < 0)
5465 error ("Output file descriptor of %s is closed", SDATA (PVAR (p, name)));
5467 coding = proc_encode_coding_system[p->outfd];
5468 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5470 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5471 || (BUFFERP (object)
5472 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5473 || EQ (object, Qt))
5475 PVAR (p, encode_coding_system)
5476 = complement_process_encoding_system (PVAR (p, encode_coding_system));
5477 if (!EQ (Vlast_coding_system_used, PVAR (p, encode_coding_system)))
5479 /* The coding system for encoding was changed to raw-text
5480 because we sent a unibyte text previously. Now we are
5481 sending a multibyte text, thus we must encode it by the
5482 original coding system specified for the current process.
5484 Another reason we come here is that the coding system
5485 was just complemented and a new one was returned by
5486 complement_process_encoding_system. */
5487 setup_coding_system (PVAR (p, encode_coding_system), coding);
5488 Vlast_coding_system_used = PVAR (p, encode_coding_system);
5490 coding->src_multibyte = 1;
5492 else
5494 coding->src_multibyte = 0;
5495 /* For sending a unibyte text, character code conversion should
5496 not take place but EOL conversion should. So, setup raw-text
5497 or one of the subsidiary if we have not yet done it. */
5498 if (CODING_REQUIRE_ENCODING (coding))
5500 if (CODING_REQUIRE_FLUSHING (coding))
5502 /* But, before changing the coding, we must flush out data. */
5503 coding->mode |= CODING_MODE_LAST_BLOCK;
5504 send_process (proc, "", 0, Qt);
5505 coding->mode &= CODING_MODE_LAST_BLOCK;
5507 setup_coding_system (raw_text_coding_system
5508 (Vlast_coding_system_used),
5509 coding);
5510 coding->src_multibyte = 0;
5513 coding->dst_multibyte = 0;
5515 if (CODING_REQUIRE_ENCODING (coding))
5517 coding->dst_object = Qt;
5518 if (BUFFERP (object))
5520 ptrdiff_t from_byte, from, to;
5521 ptrdiff_t save_pt, save_pt_byte;
5522 struct buffer *cur = current_buffer;
5524 set_buffer_internal (XBUFFER (object));
5525 save_pt = PT, save_pt_byte = PT_BYTE;
5527 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5528 from = BYTE_TO_CHAR (from_byte);
5529 to = BYTE_TO_CHAR (from_byte + len);
5530 TEMP_SET_PT_BOTH (from, from_byte);
5531 encode_coding_object (coding, object, from, from_byte,
5532 to, from_byte + len, Qt);
5533 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5534 set_buffer_internal (cur);
5536 else if (STRINGP (object))
5538 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5539 SBYTES (object), Qt);
5541 else
5543 coding->dst_object = make_unibyte_string (buf, len);
5544 coding->produced = len;
5547 len = coding->produced;
5548 object = coding->dst_object;
5549 buf = SSDATA (object);
5552 if (pty_max_bytes == 0)
5554 #if defined (HAVE_FPATHCONF) && defined (_PC_MAX_CANON)
5555 pty_max_bytes = fpathconf (p->outfd, _PC_MAX_CANON);
5556 if (pty_max_bytes < 0)
5557 pty_max_bytes = 250;
5558 #else
5559 pty_max_bytes = 250;
5560 #endif
5561 /* Deduct one, to leave space for the eof. */
5562 pty_max_bytes--;
5565 /* 2000-09-21: Emacs 20.7, sparc-sun-solaris-2.6, GCC 2.95.2,
5566 CFLAGS="-g -O": The value of the parameter `proc' is clobbered
5567 when returning with longjmp despite being declared volatile. */
5568 if (!setjmp (send_process_frame))
5570 p = XPROCESS (proc); /* Repair any setjmp clobbering. */
5571 process_sent_to = proc;
5573 /* If there is already data in the write_queue, put the new data
5574 in the back of queue. Otherwise, ignore it. */
5575 if (!NILP (PVAR (p, write_queue)))
5576 write_queue_push (p, object, buf, len, 0);
5578 do /* while !NILP (p->write_queue) */
5580 ptrdiff_t cur_len = -1;
5581 const char *cur_buf;
5582 Lisp_Object cur_object;
5584 /* If write_queue is empty, ignore it. */
5585 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5587 cur_len = len;
5588 cur_buf = buf;
5589 cur_object = object;
5592 while (cur_len > 0)
5594 /* Send this batch, using one or more write calls. */
5595 ptrdiff_t written = 0;
5596 int outfd = p->outfd;
5597 old_sigpipe = (void (*) (int)) signal (SIGPIPE, send_process_trap);
5598 #ifdef DATAGRAM_SOCKETS
5599 if (DATAGRAM_CHAN_P (outfd))
5601 rv = sendto (outfd, cur_buf, cur_len,
5602 0, datagram_address[outfd].sa,
5603 datagram_address[outfd].len);
5604 if (0 <= rv)
5605 written = rv;
5606 else if (errno == EMSGSIZE)
5608 signal (SIGPIPE, old_sigpipe);
5609 report_file_error ("sending datagram",
5610 Fcons (proc, Qnil));
5613 else
5614 #endif
5616 #ifdef HAVE_GNUTLS
5617 if (p->gnutls_p)
5618 written = emacs_gnutls_write (p, cur_buf, cur_len);
5619 else
5620 #endif
5621 written = emacs_write (outfd, cur_buf, cur_len);
5622 rv = (written ? 0 : -1);
5623 #ifdef ADAPTIVE_READ_BUFFERING
5624 if (p->read_output_delay > 0
5625 && p->adaptive_read_buffering == 1)
5627 p->read_output_delay = 0;
5628 process_output_delay_count--;
5629 p->read_output_skip = 0;
5631 #endif
5633 signal (SIGPIPE, old_sigpipe);
5635 if (rv < 0)
5637 if (0
5638 #ifdef EWOULDBLOCK
5639 || errno == EWOULDBLOCK
5640 #endif
5641 #ifdef EAGAIN
5642 || errno == EAGAIN
5643 #endif
5645 /* Buffer is full. Wait, accepting input;
5646 that may allow the program
5647 to finish doing output and read more. */
5649 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5650 /* A gross hack to work around a bug in FreeBSD.
5651 In the following sequence, read(2) returns
5652 bogus data:
5654 write(2) 1022 bytes
5655 write(2) 954 bytes, get EAGAIN
5656 read(2) 1024 bytes in process_read_output
5657 read(2) 11 bytes in process_read_output
5659 That is, read(2) returns more bytes than have
5660 ever been written successfully. The 1033 bytes
5661 read are the 1022 bytes written successfully
5662 after processing (for example with CRs added if
5663 the terminal is set up that way which it is
5664 here). The same bytes will be seen again in a
5665 later read(2), without the CRs. */
5667 if (errno == EAGAIN)
5669 int flags = FWRITE;
5670 ioctl (p->outfd, TIOCFLUSH, &flags);
5672 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5674 /* Put what we should have written in wait_queue. */
5675 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5676 wait_reading_process_output (0, 20 * 1000 * 1000,
5677 0, 0, Qnil, NULL, 0);
5678 /* Reread queue, to see what is left. */
5679 break;
5681 else
5682 /* This is a real error. */
5683 report_file_error ("writing to process", Fcons (proc, Qnil));
5685 cur_buf += written;
5686 cur_len -= written;
5689 while (!NILP (PVAR (p, write_queue)));
5691 else
5693 signal (SIGPIPE, old_sigpipe);
5694 proc = process_sent_to;
5695 p = XPROCESS (proc);
5696 p->raw_status_new = 0;
5697 PVAR (p, status) = Fcons (Qexit, Fcons (make_number (256), Qnil));
5698 p->tick = ++process_tick;
5699 deactivate_process (proc);
5700 error ("SIGPIPE raised on process %s; closed it", SDATA (PVAR (p, name)));
5704 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5705 3, 3, 0,
5706 doc: /* Send current contents of region as input to PROCESS.
5707 PROCESS may be a process, a buffer, the name of a process or buffer, or
5708 nil, indicating the current buffer's process.
5709 Called from program, takes three arguments, PROCESS, START and END.
5710 If the region is more than 500 characters long,
5711 it is sent in several bunches. This may happen even for shorter regions.
5712 Output from processes can arrive in between bunches. */)
5713 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5715 Lisp_Object proc;
5716 ptrdiff_t start1, end1;
5718 proc = get_process (process);
5719 validate_region (&start, &end);
5721 if (XINT (start) < GPT && XINT (end) > GPT)
5722 move_gap (XINT (start));
5724 start1 = CHAR_TO_BYTE (XINT (start));
5725 end1 = CHAR_TO_BYTE (XINT (end));
5726 send_process (proc, (char *) BYTE_POS_ADDR (start1), end1 - start1,
5727 Fcurrent_buffer ());
5729 return Qnil;
5732 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5733 2, 2, 0,
5734 doc: /* Send PROCESS the contents of STRING as input.
5735 PROCESS may be a process, a buffer, the name of a process or buffer, or
5736 nil, indicating the current buffer's process.
5737 If STRING is more than 500 characters long,
5738 it is sent in several bunches. This may happen even for shorter strings.
5739 Output from processes can arrive in between bunches. */)
5740 (Lisp_Object process, Lisp_Object string)
5742 Lisp_Object proc;
5743 CHECK_STRING (string);
5744 proc = get_process (process);
5745 send_process (proc, SSDATA (string),
5746 SBYTES (string), string);
5747 return Qnil;
5750 /* Return the foreground process group for the tty/pty that
5751 the process P uses. */
5752 static pid_t
5753 emacs_get_tty_pgrp (struct Lisp_Process *p)
5755 pid_t gid = -1;
5757 #ifdef TIOCGPGRP
5758 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (PVAR (p, tty_name)))
5760 int fd;
5761 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5762 master side. Try the slave side. */
5763 fd = emacs_open (SSDATA (PVAR (p, tty_name)), O_RDONLY, 0);
5765 if (fd != -1)
5767 ioctl (fd, TIOCGPGRP, &gid);
5768 emacs_close (fd);
5771 #endif /* defined (TIOCGPGRP ) */
5773 return gid;
5776 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5777 Sprocess_running_child_p, 0, 1, 0,
5778 doc: /* Return t if PROCESS has given the terminal to a child.
5779 If the operating system does not make it possible to find out,
5780 return t unconditionally. */)
5781 (Lisp_Object process)
5783 /* Initialize in case ioctl doesn't exist or gives an error,
5784 in a way that will cause returning t. */
5785 pid_t gid;
5786 Lisp_Object proc;
5787 struct Lisp_Process *p;
5789 proc = get_process (process);
5790 p = XPROCESS (proc);
5792 if (!EQ (PVAR (p, type), Qreal))
5793 error ("Process %s is not a subprocess",
5794 SDATA (PVAR (p, name)));
5795 if (p->infd < 0)
5796 error ("Process %s is not active",
5797 SDATA (PVAR (p, name)));
5799 gid = emacs_get_tty_pgrp (p);
5801 if (gid == p->pid)
5802 return Qnil;
5803 return Qt;
5806 /* send a signal number SIGNO to PROCESS.
5807 If CURRENT_GROUP is t, that means send to the process group
5808 that currently owns the terminal being used to communicate with PROCESS.
5809 This is used for various commands in shell mode.
5810 If CURRENT_GROUP is lambda, that means send to the process group
5811 that currently owns the terminal, but only if it is NOT the shell itself.
5813 If NOMSG is zero, insert signal-announcements into process's buffers
5814 right away.
5816 If we can, we try to signal PROCESS by sending control characters
5817 down the pty. This allows us to signal inferiors who have changed
5818 their uid, for which killpg would return an EPERM error. */
5820 static void
5821 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5822 int nomsg)
5824 Lisp_Object proc;
5825 register struct Lisp_Process *p;
5826 pid_t gid;
5827 int no_pgrp = 0;
5829 proc = get_process (process);
5830 p = XPROCESS (proc);
5832 if (!EQ (PVAR (p, type), Qreal))
5833 error ("Process %s is not a subprocess",
5834 SDATA (PVAR (p, name)));
5835 if (p->infd < 0)
5836 error ("Process %s is not active",
5837 SDATA (PVAR (p, name)));
5839 if (!p->pty_flag)
5840 current_group = Qnil;
5842 /* If we are using pgrps, get a pgrp number and make it negative. */
5843 if (NILP (current_group))
5844 /* Send the signal to the shell's process group. */
5845 gid = p->pid;
5846 else
5848 #ifdef SIGNALS_VIA_CHARACTERS
5849 /* If possible, send signals to the entire pgrp
5850 by sending an input character to it. */
5852 struct termios t;
5853 cc_t *sig_char = NULL;
5855 tcgetattr (p->infd, &t);
5857 switch (signo)
5859 case SIGINT:
5860 sig_char = &t.c_cc[VINTR];
5861 break;
5863 case SIGQUIT:
5864 sig_char = &t.c_cc[VQUIT];
5865 break;
5867 case SIGTSTP:
5868 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5869 sig_char = &t.c_cc[VSWTCH];
5870 #else
5871 sig_char = &t.c_cc[VSUSP];
5872 #endif
5873 break;
5876 if (sig_char && *sig_char != CDISABLE)
5878 send_process (proc, (char *) sig_char, 1, Qnil);
5879 return;
5881 /* If we can't send the signal with a character,
5882 fall through and send it another way. */
5884 /* The code above may fall through if it can't
5885 handle the signal. */
5886 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5888 #ifdef TIOCGPGRP
5889 /* Get the current pgrp using the tty itself, if we have that.
5890 Otherwise, use the pty to get the pgrp.
5891 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5892 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5893 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5894 His patch indicates that if TIOCGPGRP returns an error, then
5895 we should just assume that p->pid is also the process group id. */
5897 gid = emacs_get_tty_pgrp (p);
5899 if (gid == -1)
5900 /* If we can't get the information, assume
5901 the shell owns the tty. */
5902 gid = p->pid;
5904 /* It is not clear whether anything really can set GID to -1.
5905 Perhaps on some system one of those ioctls can or could do so.
5906 Or perhaps this is vestigial. */
5907 if (gid == -1)
5908 no_pgrp = 1;
5909 #else /* ! defined (TIOCGPGRP ) */
5910 /* Can't select pgrps on this system, so we know that
5911 the child itself heads the pgrp. */
5912 gid = p->pid;
5913 #endif /* ! defined (TIOCGPGRP ) */
5915 /* If current_group is lambda, and the shell owns the terminal,
5916 don't send any signal. */
5917 if (EQ (current_group, Qlambda) && gid == p->pid)
5918 return;
5921 switch (signo)
5923 #ifdef SIGCONT
5924 case SIGCONT:
5925 p->raw_status_new = 0;
5926 PVAR (p, status) = Qrun;
5927 p->tick = ++process_tick;
5928 if (!nomsg)
5930 status_notify (NULL);
5931 redisplay_preserve_echo_area (13);
5933 break;
5934 #endif /* ! defined (SIGCONT) */
5935 case SIGINT:
5936 case SIGQUIT:
5937 case SIGKILL:
5938 flush_pending_output (p->infd);
5939 break;
5942 /* If we don't have process groups, send the signal to the immediate
5943 subprocess. That isn't really right, but it's better than any
5944 obvious alternative. */
5945 if (no_pgrp)
5947 kill (p->pid, signo);
5948 return;
5951 /* gid may be a pid, or minus a pgrp's number */
5952 #ifdef TIOCSIGSEND
5953 if (!NILP (current_group))
5955 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5956 EMACS_KILLPG (gid, signo);
5958 else
5960 gid = - p->pid;
5961 kill (gid, signo);
5963 #else /* ! defined (TIOCSIGSEND) */
5964 EMACS_KILLPG (gid, signo);
5965 #endif /* ! defined (TIOCSIGSEND) */
5968 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5969 doc: /* Interrupt process PROCESS.
5970 PROCESS may be a process, a buffer, or the name of a process or buffer.
5971 No arg or nil means current buffer's process.
5972 Second arg CURRENT-GROUP non-nil means send signal to
5973 the current process-group of the process's controlling terminal
5974 rather than to the process's own process group.
5975 If the process is a shell, this means interrupt current subjob
5976 rather than the shell.
5978 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5979 don't send the signal. */)
5980 (Lisp_Object process, Lisp_Object current_group)
5982 process_send_signal (process, SIGINT, current_group, 0);
5983 return process;
5986 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5987 doc: /* Kill process PROCESS. May be process or name of one.
5988 See function `interrupt-process' for more details on usage. */)
5989 (Lisp_Object process, Lisp_Object current_group)
5991 process_send_signal (process, SIGKILL, current_group, 0);
5992 return process;
5995 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5996 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5997 See function `interrupt-process' for more details on usage. */)
5998 (Lisp_Object process, Lisp_Object current_group)
6000 process_send_signal (process, SIGQUIT, current_group, 0);
6001 return process;
6004 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
6005 doc: /* Stop process PROCESS. May be process or name of one.
6006 See function `interrupt-process' for more details on usage.
6007 If PROCESS is a network or serial process, inhibit handling of incoming
6008 traffic. */)
6009 (Lisp_Object process, Lisp_Object current_group)
6011 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
6013 struct Lisp_Process *p;
6015 p = XPROCESS (process);
6016 if (NILP (PVAR (p, command))
6017 && p->infd >= 0)
6019 FD_CLR (p->infd, &input_wait_mask);
6020 FD_CLR (p->infd, &non_keyboard_wait_mask);
6022 PVAR (p, command) = Qt;
6023 return process;
6025 #ifndef SIGTSTP
6026 error ("No SIGTSTP support");
6027 #else
6028 process_send_signal (process, SIGTSTP, current_group, 0);
6029 #endif
6030 return process;
6033 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
6034 doc: /* Continue process PROCESS. May be process or name of one.
6035 See function `interrupt-process' for more details on usage.
6036 If PROCESS is a network or serial process, resume handling of incoming
6037 traffic. */)
6038 (Lisp_Object process, Lisp_Object current_group)
6040 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
6042 struct Lisp_Process *p;
6044 p = XPROCESS (process);
6045 if (EQ (PVAR (p, command), Qt)
6046 && p->infd >= 0
6047 && (!EQ (PVAR (p, filter), Qt) || EQ (PVAR (p, status), Qlisten)))
6049 FD_SET (p->infd, &input_wait_mask);
6050 FD_SET (p->infd, &non_keyboard_wait_mask);
6051 #ifdef WINDOWSNT
6052 if (fd_info[ p->infd ].flags & FILE_SERIAL)
6053 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
6054 #else /* not WINDOWSNT */
6055 tcflush (p->infd, TCIFLUSH);
6056 #endif /* not WINDOWSNT */
6058 PVAR (p, command) = Qnil;
6059 return process;
6061 #ifdef SIGCONT
6062 process_send_signal (process, SIGCONT, current_group, 0);
6063 #else
6064 error ("No SIGCONT support");
6065 #endif
6066 return process;
6069 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
6070 2, 2, "sProcess (name or number): \nnSignal code: ",
6071 doc: /* Send PROCESS the signal with code SIGCODE.
6072 PROCESS may also be a number specifying the process id of the
6073 process to signal; in this case, the process need not be a child of
6074 this Emacs.
6075 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
6076 (Lisp_Object process, Lisp_Object sigcode)
6078 pid_t pid;
6080 if (STRINGP (process))
6082 Lisp_Object tem = Fget_process (process);
6083 if (NILP (tem))
6085 Lisp_Object process_number =
6086 string_to_number (SSDATA (process), 10, 1);
6087 if (INTEGERP (process_number) || FLOATP (process_number))
6088 tem = process_number;
6090 process = tem;
6092 else if (!NUMBERP (process))
6093 process = get_process (process);
6095 if (NILP (process))
6096 return process;
6098 if (NUMBERP (process))
6099 CONS_TO_INTEGER (process, pid_t, pid);
6100 else
6102 CHECK_PROCESS (process);
6103 pid = XPROCESS (process)->pid;
6104 if (pid <= 0)
6105 error ("Cannot signal process %s",
6106 SDATA (PVAR (XPROCESS (process), name)));
6109 #define parse_signal(NAME, VALUE) \
6110 else if (!xstrcasecmp (name, NAME)) \
6111 XSETINT (sigcode, VALUE)
6113 if (INTEGERP (sigcode))
6114 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
6115 else
6117 char *name;
6119 CHECK_SYMBOL (sigcode);
6120 name = SSDATA (SYMBOL_NAME (sigcode));
6122 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
6123 name += 3;
6125 if (0)
6127 #ifdef SIGUSR1
6128 parse_signal ("usr1", SIGUSR1);
6129 #endif
6130 #ifdef SIGUSR2
6131 parse_signal ("usr2", SIGUSR2);
6132 #endif
6133 #ifdef SIGTERM
6134 parse_signal ("term", SIGTERM);
6135 #endif
6136 #ifdef SIGHUP
6137 parse_signal ("hup", SIGHUP);
6138 #endif
6139 #ifdef SIGINT
6140 parse_signal ("int", SIGINT);
6141 #endif
6142 #ifdef SIGQUIT
6143 parse_signal ("quit", SIGQUIT);
6144 #endif
6145 #ifdef SIGILL
6146 parse_signal ("ill", SIGILL);
6147 #endif
6148 #ifdef SIGABRT
6149 parse_signal ("abrt", SIGABRT);
6150 #endif
6151 #ifdef SIGEMT
6152 parse_signal ("emt", SIGEMT);
6153 #endif
6154 #ifdef SIGKILL
6155 parse_signal ("kill", SIGKILL);
6156 #endif
6157 #ifdef SIGFPE
6158 parse_signal ("fpe", SIGFPE);
6159 #endif
6160 #ifdef SIGBUS
6161 parse_signal ("bus", SIGBUS);
6162 #endif
6163 #ifdef SIGSEGV
6164 parse_signal ("segv", SIGSEGV);
6165 #endif
6166 #ifdef SIGSYS
6167 parse_signal ("sys", SIGSYS);
6168 #endif
6169 #ifdef SIGPIPE
6170 parse_signal ("pipe", SIGPIPE);
6171 #endif
6172 #ifdef SIGALRM
6173 parse_signal ("alrm", SIGALRM);
6174 #endif
6175 #ifdef SIGURG
6176 parse_signal ("urg", SIGURG);
6177 #endif
6178 #ifdef SIGSTOP
6179 parse_signal ("stop", SIGSTOP);
6180 #endif
6181 #ifdef SIGTSTP
6182 parse_signal ("tstp", SIGTSTP);
6183 #endif
6184 #ifdef SIGCONT
6185 parse_signal ("cont", SIGCONT);
6186 #endif
6187 #ifdef SIGCHLD
6188 parse_signal ("chld", SIGCHLD);
6189 #endif
6190 #ifdef SIGTTIN
6191 parse_signal ("ttin", SIGTTIN);
6192 #endif
6193 #ifdef SIGTTOU
6194 parse_signal ("ttou", SIGTTOU);
6195 #endif
6196 #ifdef SIGIO
6197 parse_signal ("io", SIGIO);
6198 #endif
6199 #ifdef SIGXCPU
6200 parse_signal ("xcpu", SIGXCPU);
6201 #endif
6202 #ifdef SIGXFSZ
6203 parse_signal ("xfsz", SIGXFSZ);
6204 #endif
6205 #ifdef SIGVTALRM
6206 parse_signal ("vtalrm", SIGVTALRM);
6207 #endif
6208 #ifdef SIGPROF
6209 parse_signal ("prof", SIGPROF);
6210 #endif
6211 #ifdef SIGWINCH
6212 parse_signal ("winch", SIGWINCH);
6213 #endif
6214 #ifdef SIGINFO
6215 parse_signal ("info", SIGINFO);
6216 #endif
6217 else
6218 error ("Undefined signal name %s", name);
6221 #undef parse_signal
6223 return make_number (kill (pid, XINT (sigcode)));
6226 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6227 doc: /* Make PROCESS see end-of-file in its input.
6228 EOF comes after any text already sent to it.
6229 PROCESS may be a process, a buffer, the name of a process or buffer, or
6230 nil, indicating the current buffer's process.
6231 If PROCESS is a network connection, or is a process communicating
6232 through a pipe (as opposed to a pty), then you cannot send any more
6233 text to PROCESS after you call this function.
6234 If PROCESS is a serial process, wait until all output written to the
6235 process has been transmitted to the serial port. */)
6236 (Lisp_Object process)
6238 Lisp_Object proc;
6239 struct coding_system *coding;
6241 if (DATAGRAM_CONN_P (process))
6242 return process;
6244 proc = get_process (process);
6245 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6247 /* Make sure the process is really alive. */
6248 if (XPROCESS (proc)->raw_status_new)
6249 update_status (XPROCESS (proc));
6250 if (! EQ (PVAR (XPROCESS (proc), status), Qrun))
6251 error ("Process %s not running", SDATA (PVAR (XPROCESS (proc), name)));
6253 if (CODING_REQUIRE_FLUSHING (coding))
6255 coding->mode |= CODING_MODE_LAST_BLOCK;
6256 send_process (proc, "", 0, Qnil);
6259 if (XPROCESS (proc)->pty_flag)
6260 send_process (proc, "\004", 1, Qnil);
6261 else if (EQ (PVAR (XPROCESS (proc), type), Qserial))
6263 #ifndef WINDOWSNT
6264 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6265 error ("tcdrain() failed: %s", emacs_strerror (errno));
6266 #endif /* not WINDOWSNT */
6267 /* Do nothing on Windows because writes are blocking. */
6269 else
6271 int old_outfd, new_outfd;
6273 #ifdef HAVE_SHUTDOWN
6274 /* If this is a network connection, or socketpair is used
6275 for communication with the subprocess, call shutdown to cause EOF.
6276 (In some old system, shutdown to socketpair doesn't work.
6277 Then we just can't win.) */
6278 if (EQ (PVAR (XPROCESS (proc), type), Qnetwork)
6279 || XPROCESS (proc)->outfd == XPROCESS (proc)->infd)
6280 shutdown (XPROCESS (proc)->outfd, 1);
6281 /* In case of socketpair, outfd == infd, so don't close it. */
6282 if (XPROCESS (proc)->outfd != XPROCESS (proc)->infd)
6283 emacs_close (XPROCESS (proc)->outfd);
6284 #else /* not HAVE_SHUTDOWN */
6285 emacs_close (XPROCESS (proc)->outfd);
6286 #endif /* not HAVE_SHUTDOWN */
6287 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6288 if (new_outfd < 0)
6289 abort ();
6290 old_outfd = XPROCESS (proc)->outfd;
6292 if (!proc_encode_coding_system[new_outfd])
6293 proc_encode_coding_system[new_outfd]
6294 = xmalloc (sizeof (struct coding_system));
6295 memcpy (proc_encode_coding_system[new_outfd],
6296 proc_encode_coding_system[old_outfd],
6297 sizeof (struct coding_system));
6298 memset (proc_encode_coding_system[old_outfd], 0,
6299 sizeof (struct coding_system));
6301 XPROCESS (proc)->outfd = new_outfd;
6303 return process;
6306 /* On receipt of a signal that a child status has changed, loop asking
6307 about children with changed statuses until the system says there
6308 are no more.
6310 All we do is change the status; we do not run sentinels or print
6311 notifications. That is saved for the next time keyboard input is
6312 done, in order to avoid timing errors.
6314 ** WARNING: this can be called during garbage collection.
6315 Therefore, it must not be fooled by the presence of mark bits in
6316 Lisp objects.
6318 ** USG WARNING: Although it is not obvious from the documentation
6319 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6320 signal() before executing at least one wait(), otherwise the
6321 handler will be called again, resulting in an infinite loop. The
6322 relevant portion of the documentation reads "SIGCLD signals will be
6323 queued and the signal-catching function will be continually
6324 reentered until the queue is empty". Invoking signal() causes the
6325 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6326 Inc.
6328 ** Malloc WARNING: This should never call malloc either directly or
6329 indirectly; if it does, that is a bug */
6331 #ifdef SIGCHLD
6332 static void
6333 sigchld_handler (int signo)
6335 int old_errno = errno;
6336 Lisp_Object proc;
6337 struct Lisp_Process *p;
6339 SIGNAL_THREAD_CHECK (signo);
6341 while (1)
6343 pid_t pid;
6344 int w;
6345 Lisp_Object tail;
6347 #ifdef WNOHANG
6348 #ifndef WUNTRACED
6349 #define WUNTRACED 0
6350 #endif /* no WUNTRACED */
6351 /* Keep trying to get a status until we get a definitive result. */
6354 errno = 0;
6355 pid = waitpid (-1, &w, WNOHANG | WUNTRACED);
6357 while (pid < 0 && errno == EINTR);
6359 if (pid <= 0)
6361 /* PID == 0 means no processes found, PID == -1 means a real
6362 failure. We have done all our job, so return. */
6364 errno = old_errno;
6365 return;
6367 #else
6368 pid = wait (&w);
6369 #endif /* no WNOHANG */
6371 /* Find the process that signaled us, and record its status. */
6373 /* The process can have been deleted by Fdelete_process. */
6374 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6376 Lisp_Object xpid = XCAR (tail);
6377 if ((INTEGERP (xpid) && pid == XINT (xpid))
6378 || (FLOATP (xpid) && pid == XFLOAT_DATA (xpid)))
6380 XSETCAR (tail, Qnil);
6381 goto sigchld_end_of_loop;
6385 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6386 p = 0;
6387 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6389 proc = XCDR (XCAR (tail));
6390 p = XPROCESS (proc);
6391 if (EQ (PVAR (p, type), Qreal) && p->pid == pid)
6392 break;
6393 p = 0;
6396 /* Look for an asynchronous process whose pid hasn't been filled
6397 in yet. */
6398 if (p == 0)
6399 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6401 proc = XCDR (XCAR (tail));
6402 p = XPROCESS (proc);
6403 if (p->pid == -1)
6404 break;
6405 p = 0;
6408 /* Change the status of the process that was found. */
6409 if (p != 0)
6411 int clear_desc_flag = 0;
6413 p->tick = ++process_tick;
6414 p->raw_status = w;
6415 p->raw_status_new = 1;
6417 /* If process has terminated, stop waiting for its output. */
6418 if ((WIFSIGNALED (w) || WIFEXITED (w))
6419 && p->infd >= 0)
6420 clear_desc_flag = 1;
6422 /* We use clear_desc_flag to avoid a compiler bug in Microsoft C. */
6423 if (clear_desc_flag)
6425 FD_CLR (p->infd, &input_wait_mask);
6426 FD_CLR (p->infd, &non_keyboard_wait_mask);
6429 /* Tell wait_reading_process_output that it needs to wake up and
6430 look around. */
6431 if (input_available_clear_time)
6432 *input_available_clear_time = make_emacs_time (0, 0);
6435 /* There was no asynchronous process found for that pid: we have
6436 a synchronous process. */
6437 else
6439 synch_process_alive = 0;
6441 /* Report the status of the synchronous process. */
6442 if (WIFEXITED (w))
6443 synch_process_retcode = WEXITSTATUS (w);
6444 else if (WIFSIGNALED (w))
6445 synch_process_termsig = WTERMSIG (w);
6447 /* Tell wait_reading_process_output that it needs to wake up and
6448 look around. */
6449 if (input_available_clear_time)
6450 *input_available_clear_time = make_emacs_time (0, 0);
6453 sigchld_end_of_loop:
6456 /* On some systems, we must return right away.
6457 If any more processes want to signal us, we will
6458 get another signal.
6459 Otherwise (on systems that have WNOHANG), loop around
6460 to use up all the processes that have something to tell us. */
6461 #if (defined WINDOWSNT \
6462 || (defined USG && !defined GNU_LINUX \
6463 && !(defined HPUX && defined WNOHANG)))
6464 errno = old_errno;
6465 return;
6466 #endif /* USG, but not HPUX with WNOHANG */
6469 #endif /* SIGCHLD */
6472 static Lisp_Object
6473 exec_sentinel_unwind (Lisp_Object data)
6475 PVAR (XPROCESS (XCAR (data)), sentinel) = XCDR (data);
6476 return Qnil;
6479 static Lisp_Object
6480 exec_sentinel_error_handler (Lisp_Object error_val)
6482 cmd_error_internal (error_val, "error in process sentinel: ");
6483 Vinhibit_quit = Qt;
6484 update_echo_area ();
6485 Fsleep_for (make_number (2), Qnil);
6486 return Qt;
6489 static void
6490 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6492 Lisp_Object sentinel, odeactivate;
6493 register struct Lisp_Process *p = XPROCESS (proc);
6494 ptrdiff_t count = SPECPDL_INDEX ();
6495 int outer_running_asynch_code = running_asynch_code;
6496 int waiting = waiting_for_user_input_p;
6498 if (inhibit_sentinels)
6499 return;
6501 /* No need to gcpro these, because all we do with them later
6502 is test them for EQness, and none of them should be a string. */
6503 odeactivate = Vdeactivate_mark;
6504 #if 0
6505 Lisp_Object obuffer, okeymap;
6506 XSETBUFFER (obuffer, current_buffer);
6507 okeymap = BVAR (current_buffer, keymap);
6508 #endif
6510 /* There's no good reason to let sentinels change the current
6511 buffer, and many callers of accept-process-output, sit-for, and
6512 friends don't expect current-buffer to be changed from under them. */
6513 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
6515 sentinel = PVAR (p, sentinel);
6516 if (NILP (sentinel))
6517 return;
6519 /* Zilch the sentinel while it's running, to avoid recursive invocations;
6520 assure that it gets restored no matter how the sentinel exits. */
6521 PVAR (p, sentinel) = Qnil;
6522 record_unwind_protect (exec_sentinel_unwind, Fcons (proc, sentinel));
6523 /* Inhibit quit so that random quits don't screw up a running filter. */
6524 specbind (Qinhibit_quit, Qt);
6525 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6527 /* In case we get recursively called,
6528 and we already saved the match data nonrecursively,
6529 save the same match data in safely recursive fashion. */
6530 if (outer_running_asynch_code)
6532 Lisp_Object tem;
6533 tem = Fmatch_data (Qnil, Qnil, Qnil);
6534 restore_search_regs ();
6535 record_unwind_save_match_data ();
6536 Fset_match_data (tem, Qt);
6539 /* For speed, if a search happens within this code,
6540 save the match data in a special nonrecursive fashion. */
6541 running_asynch_code = 1;
6543 internal_condition_case_1 (read_process_output_call,
6544 Fcons (sentinel,
6545 Fcons (proc, Fcons (reason, Qnil))),
6546 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6547 exec_sentinel_error_handler);
6549 /* If we saved the match data nonrecursively, restore it now. */
6550 restore_search_regs ();
6551 running_asynch_code = outer_running_asynch_code;
6553 Vdeactivate_mark = odeactivate;
6555 /* Restore waiting_for_user_input_p as it was
6556 when we were called, in case the filter clobbered it. */
6557 waiting_for_user_input_p = waiting;
6559 #if 0
6560 if (! EQ (Fcurrent_buffer (), obuffer)
6561 || ! EQ (current_buffer->keymap, okeymap))
6562 #endif
6563 /* But do it only if the caller is actually going to read events.
6564 Otherwise there's no need to make him wake up, and it could
6565 cause trouble (for example it would make sit_for return). */
6566 if (waiting_for_user_input_p == -1)
6567 record_asynch_buffer_change ();
6569 unbind_to (count, Qnil);
6572 /* Report all recent events of a change in process status
6573 (either run the sentinel or output a message).
6574 This is usually done while Emacs is waiting for keyboard input
6575 but can be done at other times. */
6577 static void
6578 status_notify (struct Lisp_Process *deleting_process)
6580 register Lisp_Object proc, buffer;
6581 Lisp_Object tail, msg;
6582 struct gcpro gcpro1, gcpro2;
6584 tail = Qnil;
6585 msg = Qnil;
6586 /* We need to gcpro tail; if read_process_output calls a filter
6587 which deletes a process and removes the cons to which tail points
6588 from Vprocess_alist, and then causes a GC, tail is an unprotected
6589 reference. */
6590 GCPRO2 (tail, msg);
6592 /* Set this now, so that if new processes are created by sentinels
6593 that we run, we get called again to handle their status changes. */
6594 update_tick = process_tick;
6596 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6598 Lisp_Object symbol;
6599 register struct Lisp_Process *p;
6601 proc = Fcdr (XCAR (tail));
6602 p = XPROCESS (proc);
6604 if (p->tick != p->update_tick)
6606 p->update_tick = p->tick;
6608 /* If process is still active, read any output that remains. */
6609 while (! EQ (PVAR (p, filter), Qt)
6610 && ! EQ (PVAR (p, status), Qconnect)
6611 && ! EQ (PVAR (p, status), Qlisten)
6612 /* Network or serial process not stopped: */
6613 && ! EQ (PVAR (p, command), Qt)
6614 && p->infd >= 0
6615 && p != deleting_process
6616 && read_process_output (proc, p->infd) > 0);
6618 buffer = PVAR (p, buffer);
6620 /* Get the text to use for the message. */
6621 if (p->raw_status_new)
6622 update_status (p);
6623 msg = status_message (p);
6625 /* If process is terminated, deactivate it or delete it. */
6626 symbol = PVAR (p, status);
6627 if (CONSP (PVAR (p, status)))
6628 symbol = XCAR (PVAR (p, status));
6630 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6631 || EQ (symbol, Qclosed))
6633 if (delete_exited_processes)
6634 remove_process (proc);
6635 else
6636 deactivate_process (proc);
6639 /* The actions above may have further incremented p->tick.
6640 So set p->update_tick again
6641 so that an error in the sentinel will not cause
6642 this code to be run again. */
6643 p->update_tick = p->tick;
6644 /* Now output the message suitably. */
6645 if (!NILP (PVAR (p, sentinel)))
6646 exec_sentinel (proc, msg);
6647 /* Don't bother with a message in the buffer
6648 when a process becomes runnable. */
6649 else if (!EQ (symbol, Qrun) && !NILP (buffer))
6651 Lisp_Object tem;
6652 struct buffer *old = current_buffer;
6653 ptrdiff_t opoint, opoint_byte;
6654 ptrdiff_t before, before_byte;
6656 /* Avoid error if buffer is deleted
6657 (probably that's why the process is dead, too) */
6658 if (NILP (BVAR (XBUFFER (buffer), name)))
6659 continue;
6660 Fset_buffer (buffer);
6662 opoint = PT;
6663 opoint_byte = PT_BYTE;
6664 /* Insert new output into buffer
6665 at the current end-of-output marker,
6666 thus preserving logical ordering of input and output. */
6667 if (XMARKER (PVAR (p, mark))->buffer)
6668 Fgoto_char (PVAR (p, mark));
6669 else
6670 SET_PT_BOTH (ZV, ZV_BYTE);
6672 before = PT;
6673 before_byte = PT_BYTE;
6675 tem = BVAR (current_buffer, read_only);
6676 BVAR (current_buffer, read_only) = Qnil;
6677 insert_string ("\nProcess ");
6678 Finsert (1, &PVAR (p, name));
6679 insert_string (" ");
6680 Finsert (1, &msg);
6681 BVAR (current_buffer, read_only) = tem;
6682 set_marker_both (PVAR (p, mark), PVAR (p, buffer), PT, PT_BYTE);
6684 if (opoint >= before)
6685 SET_PT_BOTH (opoint + (PT - before),
6686 opoint_byte + (PT_BYTE - before_byte));
6687 else
6688 SET_PT_BOTH (opoint, opoint_byte);
6690 set_buffer_internal (old);
6693 } /* end for */
6695 update_mode_lines++; /* in case buffers use %s in mode-line-format */
6696 UNGCPRO;
6700 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6701 Sset_process_coding_system, 1, 3, 0,
6702 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6703 DECODING will be used to decode subprocess output and ENCODING to
6704 encode subprocess input. */)
6705 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6707 register struct Lisp_Process *p;
6709 CHECK_PROCESS (process);
6710 p = XPROCESS (process);
6711 if (p->infd < 0)
6712 error ("Input file descriptor of %s closed", SDATA (PVAR (p, name)));
6713 if (p->outfd < 0)
6714 error ("Output file descriptor of %s closed", SDATA (PVAR (p, name)));
6715 Fcheck_coding_system (decoding);
6716 Fcheck_coding_system (encoding);
6717 encoding = coding_inherit_eol_type (encoding, Qnil);
6718 PVAR (p, decode_coding_system) = decoding;
6719 PVAR (p, encode_coding_system) = encoding;
6720 setup_process_coding_systems (process);
6722 return Qnil;
6725 DEFUN ("process-coding-system",
6726 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6727 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6728 (register Lisp_Object process)
6730 CHECK_PROCESS (process);
6731 return Fcons (PVAR (XPROCESS (process), decode_coding_system),
6732 PVAR (XPROCESS (process), encode_coding_system));
6735 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6736 Sset_process_filter_multibyte, 2, 2, 0,
6737 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6738 If FLAG is non-nil, the filter is given multibyte strings.
6739 If FLAG is nil, the filter is given unibyte strings. In this case,
6740 all character code conversion except for end-of-line conversion is
6741 suppressed. */)
6742 (Lisp_Object process, Lisp_Object flag)
6744 register struct Lisp_Process *p;
6746 CHECK_PROCESS (process);
6747 p = XPROCESS (process);
6748 if (NILP (flag))
6749 PVAR (p, decode_coding_system)
6750 = raw_text_coding_system (PVAR (p, decode_coding_system));
6751 setup_process_coding_systems (process);
6753 return Qnil;
6756 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6757 Sprocess_filter_multibyte_p, 1, 1, 0,
6758 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6759 (Lisp_Object process)
6761 register struct Lisp_Process *p;
6762 struct coding_system *coding;
6764 CHECK_PROCESS (process);
6765 p = XPROCESS (process);
6766 coding = proc_decode_coding_system[p->infd];
6767 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6773 # ifdef HAVE_GPM
6775 void
6776 add_gpm_wait_descriptor (int desc)
6778 add_keyboard_wait_descriptor (desc);
6781 void
6782 delete_gpm_wait_descriptor (int desc)
6784 delete_keyboard_wait_descriptor (desc);
6787 # endif
6789 # ifdef SIGIO
6791 /* Return nonzero if *MASK has a bit set
6792 that corresponds to one of the keyboard input descriptors. */
6794 static int
6795 keyboard_bit_set (fd_set *mask)
6797 int fd;
6799 for (fd = 0; fd <= max_input_desc; fd++)
6800 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6801 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6802 return 1;
6804 return 0;
6806 # endif
6808 #else /* not subprocesses */
6810 /* Defined on msdos.c. */
6811 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
6812 EMACS_TIME *, void *);
6814 /* Implementation of wait_reading_process_output, assuming that there
6815 are no subprocesses. Used only by the MS-DOS build.
6817 Wait for timeout to elapse and/or keyboard input to be available.
6819 TIME_LIMIT is:
6820 timeout in seconds
6821 If negative, gobble data immediately available but don't wait for any.
6823 NSECS is:
6824 an additional duration to wait, measured in nanoseconds
6825 If TIME_LIMIT is zero, then:
6826 If NSECS == 0, there is no limit.
6827 If NSECS > 0, the timeout consists of NSECS only.
6828 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6830 READ_KBD is:
6831 0 to ignore keyboard input, or
6832 1 to return when input is available, or
6833 -1 means caller will actually read the input, so don't throw to
6834 the quit handler.
6836 see full version for other parameters. We know that wait_proc will
6837 always be NULL, since `subprocesses' isn't defined.
6839 DO_DISPLAY != 0 means redisplay should be done to show subprocess
6840 output that arrives.
6842 Return true if we received input from any process. */
6845 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6846 int do_display,
6847 Lisp_Object wait_for_cell,
6848 struct Lisp_Process *wait_proc, int just_wait_proc)
6850 register int nfds;
6851 EMACS_TIME end_time, timeout;
6853 if (time_limit < 0)
6855 time_limit = 0;
6856 nsecs = -1;
6858 else if (TYPE_MAXIMUM (time_t) < time_limit)
6859 time_limit = TYPE_MAXIMUM (time_t);
6861 /* What does time_limit really mean? */
6862 if (time_limit || 0 < nsecs)
6864 timeout = make_emacs_time (time_limit, nsecs);
6865 end_time = add_emacs_time (current_emacs_time (), timeout);
6868 /* Turn off periodic alarms (in case they are in use)
6869 and then turn off any other atimers,
6870 because the select emulator uses alarms. */
6871 stop_polling ();
6872 turn_on_atimers (0);
6874 while (1)
6876 int timeout_reduced_for_timers = 0;
6877 SELECT_TYPE waitchannels;
6878 int xerrno;
6880 /* If calling from keyboard input, do not quit
6881 since we want to return C-g as an input character.
6882 Otherwise, do pending quit if requested. */
6883 if (read_kbd >= 0)
6884 QUIT;
6886 /* Exit now if the cell we're waiting for became non-nil. */
6887 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6888 break;
6890 /* Compute time from now till when time limit is up */
6891 /* Exit if already run out */
6892 if (nsecs < 0)
6894 /* A negative timeout means
6895 gobble output available now
6896 but don't wait at all. */
6898 timeout = make_emacs_time (0, 0);
6900 else if (time_limit || 0 < nsecs)
6902 EMACS_TIME now = current_emacs_time ();
6903 if (EMACS_TIME_LE (end_time, now))
6904 break;
6905 timeout = sub_emacs_time (end_time, now);
6907 else
6909 timeout = make_emacs_time (100000, 0);
6912 /* If our caller will not immediately handle keyboard events,
6913 run timer events directly.
6914 (Callers that will immediately read keyboard events
6915 call timer_delay on their own.) */
6916 if (NILP (wait_for_cell))
6918 EMACS_TIME timer_delay;
6922 int old_timers_run = timers_run;
6923 timer_delay = timer_check ();
6924 if (timers_run != old_timers_run && do_display)
6925 /* We must retry, since a timer may have requeued itself
6926 and that could alter the time delay. */
6927 redisplay_preserve_echo_area (14);
6928 else
6929 break;
6931 while (!detect_input_pending ());
6933 /* If there is unread keyboard input, also return. */
6934 if (read_kbd != 0
6935 && requeued_events_pending_p ())
6936 break;
6938 if (EMACS_TIME_VALID_P (timer_delay) && 0 <= nsecs)
6940 if (EMACS_TIME_LT (timer_delay, timeout))
6942 timeout = timer_delay;
6943 timeout_reduced_for_timers = 1;
6948 /* Cause C-g and alarm signals to take immediate action,
6949 and cause input available signals to zero out timeout. */
6950 if (read_kbd < 0)
6951 set_waiting_for_input (&timeout);
6953 /* If a frame has been newly mapped and needs updating,
6954 reprocess its display stuff. */
6955 if (frame_garbaged && do_display)
6957 clear_waiting_for_input ();
6958 redisplay_preserve_echo_area (15);
6959 if (read_kbd < 0)
6960 set_waiting_for_input (&timeout);
6963 /* Wait till there is something to do. */
6964 FD_ZERO (&waitchannels);
6965 if (read_kbd && detect_input_pending ())
6966 nfds = 0;
6967 else
6969 if (read_kbd || !NILP (wait_for_cell))
6970 FD_SET (0, &waitchannels);
6971 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6974 xerrno = errno;
6976 /* Make C-g and alarm signals set flags again */
6977 clear_waiting_for_input ();
6979 /* If we woke up due to SIGWINCH, actually change size now. */
6980 do_pending_window_change (0);
6982 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6983 /* We waited the full specified time, so return now. */
6984 break;
6986 if (nfds == -1)
6988 /* If the system call was interrupted, then go around the
6989 loop again. */
6990 if (xerrno == EINTR)
6991 FD_ZERO (&waitchannels);
6992 else
6993 error ("select error: %s", emacs_strerror (xerrno));
6996 /* Check for keyboard input */
6998 if (read_kbd
6999 && detect_input_pending_run_timers (do_display))
7001 swallow_events (do_display);
7002 if (detect_input_pending_run_timers (do_display))
7003 break;
7006 /* If there is unread keyboard input, also return. */
7007 if (read_kbd
7008 && requeued_events_pending_p ())
7009 break;
7011 /* If wait_for_cell. check for keyboard input
7012 but don't run any timers.
7013 ??? (It seems wrong to me to check for keyboard
7014 input at all when wait_for_cell, but the code
7015 has been this way since July 1994.
7016 Try changing this after version 19.31.) */
7017 if (! NILP (wait_for_cell)
7018 && detect_input_pending ())
7020 swallow_events (do_display);
7021 if (detect_input_pending ())
7022 break;
7025 /* Exit now if the cell we're waiting for became non-nil. */
7026 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7027 break;
7030 start_polling ();
7032 return 0;
7035 #endif /* not subprocesses */
7037 /* The following functions are needed even if async subprocesses are
7038 not supported. Some of them are no-op stubs in that case. */
7040 /* Add DESC to the set of keyboard input descriptors. */
7042 void
7043 add_keyboard_wait_descriptor (int desc)
7045 #ifdef subprocesses /* actually means "not MSDOS" */
7046 FD_SET (desc, &input_wait_mask);
7047 FD_SET (desc, &non_process_wait_mask);
7048 if (desc > max_input_desc)
7049 max_input_desc = desc;
7050 #endif
7053 /* From now on, do not expect DESC to give keyboard input. */
7055 void
7056 delete_keyboard_wait_descriptor (int desc)
7058 #ifdef subprocesses
7059 int fd;
7060 int lim = max_input_desc;
7062 FD_CLR (desc, &input_wait_mask);
7063 FD_CLR (desc, &non_process_wait_mask);
7065 if (desc == max_input_desc)
7066 for (fd = 0; fd < lim; fd++)
7067 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
7068 max_input_desc = fd;
7069 #endif
7072 /* Setup coding systems of PROCESS. */
7074 void
7075 setup_process_coding_systems (Lisp_Object process)
7077 #ifdef subprocesses
7078 struct Lisp_Process *p = XPROCESS (process);
7079 int inch = p->infd;
7080 int outch = p->outfd;
7081 Lisp_Object coding_system;
7083 if (inch < 0 || outch < 0)
7084 return;
7086 if (!proc_decode_coding_system[inch])
7087 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
7088 coding_system = PVAR (p, decode_coding_system);
7089 if (! NILP (PVAR (p, filter)))
7091 else if (BUFFERP (PVAR (p, buffer)))
7093 if (NILP (BVAR (XBUFFER (PVAR (p, buffer)), enable_multibyte_characters)))
7094 coding_system = raw_text_coding_system (coding_system);
7096 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
7098 if (!proc_encode_coding_system[outch])
7099 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
7100 setup_coding_system (PVAR (p, encode_coding_system),
7101 proc_encode_coding_system[outch]);
7102 #endif
7105 /* Close all descriptors currently in use for communication
7106 with subprocess. This is used in a newly-forked subprocess
7107 to get rid of irrelevant descriptors. */
7109 void
7110 close_process_descs (void)
7112 #ifndef DOS_NT
7113 int i;
7114 for (i = 0; i < MAXDESC; i++)
7116 Lisp_Object process;
7117 process = chan_process[i];
7118 if (!NILP (process))
7120 int in = XPROCESS (process)->infd;
7121 int out = XPROCESS (process)->outfd;
7122 if (in >= 0)
7123 emacs_close (in);
7124 if (out >= 0 && in != out)
7125 emacs_close (out);
7128 #endif
7131 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
7132 doc: /* Return the (or a) process associated with BUFFER.
7133 BUFFER may be a buffer or the name of one. */)
7134 (register Lisp_Object buffer)
7136 #ifdef subprocesses
7137 register Lisp_Object buf, tail, proc;
7139 if (NILP (buffer)) return Qnil;
7140 buf = Fget_buffer (buffer);
7141 if (NILP (buf)) return Qnil;
7143 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
7145 proc = Fcdr (XCAR (tail));
7146 if (PROCESSP (proc) && EQ (PVAR (XPROCESS (proc), buffer), buf))
7147 return proc;
7149 #endif /* subprocesses */
7150 return Qnil;
7153 DEFUN ("process-inherit-coding-system-flag",
7154 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
7155 1, 1, 0,
7156 doc: /* Return the value of inherit-coding-system flag for PROCESS.
7157 If this flag is t, `buffer-file-coding-system' of the buffer
7158 associated with PROCESS will inherit the coding system used to decode
7159 the process output. */)
7160 (register Lisp_Object process)
7162 #ifdef subprocesses
7163 CHECK_PROCESS (process);
7164 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
7165 #else
7166 /* Ignore the argument and return the value of
7167 inherit-process-coding-system. */
7168 return inherit_process_coding_system ? Qt : Qnil;
7169 #endif
7172 /* Kill all processes associated with `buffer'.
7173 If `buffer' is nil, kill all processes */
7175 void
7176 kill_buffer_processes (Lisp_Object buffer)
7178 #ifdef subprocesses
7179 Lisp_Object tail, proc;
7181 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
7183 proc = XCDR (XCAR (tail));
7184 if (PROCESSP (proc)
7185 && (NILP (buffer) || EQ (PVAR (XPROCESS (proc), buffer), buffer)))
7187 if (NETCONN_P (proc) || SERIALCONN_P (proc))
7188 Fdelete_process (proc);
7189 else if (XPROCESS (proc)->infd >= 0)
7190 process_send_signal (proc, SIGHUP, Qnil, 1);
7193 #else /* subprocesses */
7194 /* Since we have no subprocesses, this does nothing. */
7195 #endif /* subprocesses */
7198 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
7199 Swaiting_for_user_input_p, 0, 0, 0,
7200 doc: /* Returns non-nil if Emacs is waiting for input from the user.
7201 This is intended for use by asynchronous process output filters and sentinels. */)
7202 (void)
7204 #ifdef subprocesses
7205 return (waiting_for_user_input_p ? Qt : Qnil);
7206 #else
7207 return Qnil;
7208 #endif
7211 /* Stop reading input from keyboard sources. */
7213 void
7214 hold_keyboard_input (void)
7216 kbd_is_on_hold = 1;
7219 /* Resume reading input from keyboard sources. */
7221 void
7222 unhold_keyboard_input (void)
7224 kbd_is_on_hold = 0;
7227 /* Return non-zero if keyboard input is on hold, zero otherwise. */
7230 kbd_on_hold_p (void)
7232 return kbd_is_on_hold;
7236 /* Enumeration of and access to system processes a-la ps(1). */
7238 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
7239 0, 0, 0,
7240 doc: /* Return a list of numerical process IDs of all running processes.
7241 If this functionality is unsupported, return nil.
7243 See `process-attributes' for getting attributes of a process given its ID. */)
7244 (void)
7246 return list_system_processes ();
7249 DEFUN ("process-attributes", Fprocess_attributes,
7250 Sprocess_attributes, 1, 1, 0,
7251 doc: /* Return attributes of the process given by its PID, a number.
7253 Value is an alist where each element is a cons cell of the form
7255 \(KEY . VALUE)
7257 If this functionality is unsupported, the value is nil.
7259 See `list-system-processes' for getting a list of all process IDs.
7261 The KEYs of the attributes that this function may return are listed
7262 below, together with the type of the associated VALUE (in parentheses).
7263 Not all platforms support all of these attributes; unsupported
7264 attributes will not appear in the returned alist.
7265 Unless explicitly indicated otherwise, numbers can have either
7266 integer or floating point values.
7268 euid -- Effective user User ID of the process (number)
7269 user -- User name corresponding to euid (string)
7270 egid -- Effective user Group ID of the process (number)
7271 group -- Group name corresponding to egid (string)
7272 comm -- Command name (executable name only) (string)
7273 state -- Process state code, such as "S", "R", or "T" (string)
7274 ppid -- Parent process ID (number)
7275 pgrp -- Process group ID (number)
7276 sess -- Session ID, i.e. process ID of session leader (number)
7277 ttname -- Controlling tty name (string)
7278 tpgid -- ID of foreground process group on the process's tty (number)
7279 minflt -- number of minor page faults (number)
7280 majflt -- number of major page faults (number)
7281 cminflt -- cumulative number of minor page faults (number)
7282 cmajflt -- cumulative number of major page faults (number)
7283 utime -- user time used by the process, in (current-time) format,
7284 which is a list of integers (HIGH LOW USEC PSEC)
7285 stime -- system time used by the process (current-time)
7286 time -- sum of utime and stime (current-time)
7287 cutime -- user time used by the process and its children (current-time)
7288 cstime -- system time used by the process and its children (current-time)
7289 ctime -- sum of cutime and cstime (current-time)
7290 pri -- priority of the process (number)
7291 nice -- nice value of the process (number)
7292 thcount -- process thread count (number)
7293 start -- time the process started (current-time)
7294 vsize -- virtual memory size of the process in KB's (number)
7295 rss -- resident set size of the process in KB's (number)
7296 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7297 pcpu -- percents of CPU time used by the process (floating-point number)
7298 pmem -- percents of total physical memory used by process's resident set
7299 (floating-point number)
7300 args -- command line which invoked the process (string). */)
7301 ( Lisp_Object pid)
7303 return system_process_attributes (pid);
7307 /* This is not called "init_process" because that is the name of a
7308 Mach system call, so it would cause problems on Darwin systems. */
7309 void
7310 init_process_emacs (void)
7312 #ifdef subprocesses
7313 register int i;
7315 inhibit_sentinels = 0;
7317 #ifdef SIGCHLD
7318 #ifndef CANNOT_DUMP
7319 if (! noninteractive || initialized)
7320 #endif
7321 signal (SIGCHLD, sigchld_handler);
7322 #endif
7324 FD_ZERO (&input_wait_mask);
7325 FD_ZERO (&non_keyboard_wait_mask);
7326 FD_ZERO (&non_process_wait_mask);
7327 FD_ZERO (&write_mask);
7328 max_process_desc = 0;
7329 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7331 #ifdef NON_BLOCKING_CONNECT
7332 FD_ZERO (&connect_wait_mask);
7333 num_pending_connects = 0;
7334 #endif
7336 #ifdef ADAPTIVE_READ_BUFFERING
7337 process_output_delay_count = 0;
7338 process_output_skip = 0;
7339 #endif
7341 /* Don't do this, it caused infinite select loops. The display
7342 method should call add_keyboard_wait_descriptor on stdin if it
7343 needs that. */
7344 #if 0
7345 FD_SET (0, &input_wait_mask);
7346 #endif
7348 Vprocess_alist = Qnil;
7349 #ifdef SIGCHLD
7350 deleted_pid_list = Qnil;
7351 #endif
7352 for (i = 0; i < MAXDESC; i++)
7354 chan_process[i] = Qnil;
7355 proc_buffered_char[i] = -1;
7357 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7358 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7359 #ifdef DATAGRAM_SOCKETS
7360 memset (datagram_address, 0, sizeof datagram_address);
7361 #endif
7364 Lisp_Object subfeatures = Qnil;
7365 const struct socket_options *sopt;
7367 #define ADD_SUBFEATURE(key, val) \
7368 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7370 #ifdef NON_BLOCKING_CONNECT
7371 ADD_SUBFEATURE (QCnowait, Qt);
7372 #endif
7373 #ifdef DATAGRAM_SOCKETS
7374 ADD_SUBFEATURE (QCtype, Qdatagram);
7375 #endif
7376 #ifdef HAVE_SEQPACKET
7377 ADD_SUBFEATURE (QCtype, Qseqpacket);
7378 #endif
7379 #ifdef HAVE_LOCAL_SOCKETS
7380 ADD_SUBFEATURE (QCfamily, Qlocal);
7381 #endif
7382 ADD_SUBFEATURE (QCfamily, Qipv4);
7383 #ifdef AF_INET6
7384 ADD_SUBFEATURE (QCfamily, Qipv6);
7385 #endif
7386 #ifdef HAVE_GETSOCKNAME
7387 ADD_SUBFEATURE (QCservice, Qt);
7388 #endif
7389 #if defined (O_NONBLOCK) || defined (O_NDELAY)
7390 ADD_SUBFEATURE (QCserver, Qt);
7391 #endif
7393 for (sopt = socket_options; sopt->name; sopt++)
7394 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7396 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7399 #if defined (DARWIN_OS)
7400 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7401 processes. As such, we only change the default value. */
7402 if (initialized)
7404 char const *release = (STRINGP (Voperating_system_release)
7405 ? SSDATA (Voperating_system_release)
7406 : 0);
7407 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7408 Vprocess_connection_type = Qnil;
7411 #endif
7412 #endif /* subprocesses */
7413 kbd_is_on_hold = 0;
7416 void
7417 syms_of_process (void)
7419 #ifdef subprocesses
7421 DEFSYM (Qprocessp, "processp");
7422 DEFSYM (Qrun, "run");
7423 DEFSYM (Qstop, "stop");
7424 DEFSYM (Qsignal, "signal");
7426 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7427 here again.
7429 Qexit = intern_c_string ("exit");
7430 staticpro (&Qexit); */
7432 DEFSYM (Qopen, "open");
7433 DEFSYM (Qclosed, "closed");
7434 DEFSYM (Qconnect, "connect");
7435 DEFSYM (Qfailed, "failed");
7436 DEFSYM (Qlisten, "listen");
7437 DEFSYM (Qlocal, "local");
7438 DEFSYM (Qipv4, "ipv4");
7439 #ifdef AF_INET6
7440 DEFSYM (Qipv6, "ipv6");
7441 #endif
7442 DEFSYM (Qdatagram, "datagram");
7443 DEFSYM (Qseqpacket, "seqpacket");
7445 DEFSYM (QCport, ":port");
7446 DEFSYM (QCspeed, ":speed");
7447 DEFSYM (QCprocess, ":process");
7449 DEFSYM (QCbytesize, ":bytesize");
7450 DEFSYM (QCstopbits, ":stopbits");
7451 DEFSYM (QCparity, ":parity");
7452 DEFSYM (Qodd, "odd");
7453 DEFSYM (Qeven, "even");
7454 DEFSYM (QCflowcontrol, ":flowcontrol");
7455 DEFSYM (Qhw, "hw");
7456 DEFSYM (Qsw, "sw");
7457 DEFSYM (QCsummary, ":summary");
7459 DEFSYM (Qreal, "real");
7460 DEFSYM (Qnetwork, "network");
7461 DEFSYM (Qserial, "serial");
7462 DEFSYM (QCbuffer, ":buffer");
7463 DEFSYM (QChost, ":host");
7464 DEFSYM (QCservice, ":service");
7465 DEFSYM (QClocal, ":local");
7466 DEFSYM (QCremote, ":remote");
7467 DEFSYM (QCcoding, ":coding");
7468 DEFSYM (QCserver, ":server");
7469 DEFSYM (QCnowait, ":nowait");
7470 DEFSYM (QCsentinel, ":sentinel");
7471 DEFSYM (QClog, ":log");
7472 DEFSYM (QCnoquery, ":noquery");
7473 DEFSYM (QCstop, ":stop");
7474 DEFSYM (QCoptions, ":options");
7475 DEFSYM (QCplist, ":plist");
7477 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7479 staticpro (&Vprocess_alist);
7480 #ifdef SIGCHLD
7481 staticpro (&deleted_pid_list);
7482 #endif
7484 #endif /* subprocesses */
7486 DEFSYM (QCname, ":name");
7487 DEFSYM (QCtype, ":type");
7489 DEFSYM (Qeuid, "euid");
7490 DEFSYM (Qegid, "egid");
7491 DEFSYM (Quser, "user");
7492 DEFSYM (Qgroup, "group");
7493 DEFSYM (Qcomm, "comm");
7494 DEFSYM (Qstate, "state");
7495 DEFSYM (Qppid, "ppid");
7496 DEFSYM (Qpgrp, "pgrp");
7497 DEFSYM (Qsess, "sess");
7498 DEFSYM (Qttname, "ttname");
7499 DEFSYM (Qtpgid, "tpgid");
7500 DEFSYM (Qminflt, "minflt");
7501 DEFSYM (Qmajflt, "majflt");
7502 DEFSYM (Qcminflt, "cminflt");
7503 DEFSYM (Qcmajflt, "cmajflt");
7504 DEFSYM (Qutime, "utime");
7505 DEFSYM (Qstime, "stime");
7506 DEFSYM (Qtime, "time");
7507 DEFSYM (Qcutime, "cutime");
7508 DEFSYM (Qcstime, "cstime");
7509 DEFSYM (Qctime, "ctime");
7510 DEFSYM (Qpri, "pri");
7511 DEFSYM (Qnice, "nice");
7512 DEFSYM (Qthcount, "thcount");
7513 DEFSYM (Qstart, "start");
7514 DEFSYM (Qvsize, "vsize");
7515 DEFSYM (Qrss, "rss");
7516 DEFSYM (Qetime, "etime");
7517 DEFSYM (Qpcpu, "pcpu");
7518 DEFSYM (Qpmem, "pmem");
7519 DEFSYM (Qargs, "args");
7521 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7522 doc: /* Non-nil means delete processes immediately when they exit.
7523 A value of nil means don't delete them until `list-processes' is run. */);
7525 delete_exited_processes = 1;
7527 #ifdef subprocesses
7528 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7529 doc: /* Control type of device used to communicate with subprocesses.
7530 Values are nil to use a pipe, or t or `pty' to use a pty.
7531 The value has no effect if the system has no ptys or if all ptys are busy:
7532 then a pipe is used in any case.
7533 The value takes effect when `start-process' is called. */);
7534 Vprocess_connection_type = Qt;
7536 #ifdef ADAPTIVE_READ_BUFFERING
7537 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7538 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7539 On some systems, when Emacs reads the output from a subprocess, the output data
7540 is read in very small blocks, potentially resulting in very poor performance.
7541 This behavior can be remedied to some extent by setting this variable to a
7542 non-nil value, as it will automatically delay reading from such processes, to
7543 allow them to produce more output before Emacs tries to read it.
7544 If the value is t, the delay is reset after each write to the process; any other
7545 non-nil value means that the delay is not reset on write.
7546 The variable takes effect when `start-process' is called. */);
7547 Vprocess_adaptive_read_buffering = Qt;
7548 #endif
7550 defsubr (&Sprocessp);
7551 defsubr (&Sget_process);
7552 defsubr (&Sdelete_process);
7553 defsubr (&Sprocess_status);
7554 defsubr (&Sprocess_exit_status);
7555 defsubr (&Sprocess_id);
7556 defsubr (&Sprocess_name);
7557 defsubr (&Sprocess_tty_name);
7558 defsubr (&Sprocess_command);
7559 defsubr (&Sset_process_buffer);
7560 defsubr (&Sprocess_buffer);
7561 defsubr (&Sprocess_mark);
7562 defsubr (&Sset_process_filter);
7563 defsubr (&Sprocess_filter);
7564 defsubr (&Sset_process_sentinel);
7565 defsubr (&Sprocess_sentinel);
7566 defsubr (&Sset_process_window_size);
7567 defsubr (&Sset_process_inherit_coding_system_flag);
7568 defsubr (&Sset_process_query_on_exit_flag);
7569 defsubr (&Sprocess_query_on_exit_flag);
7570 defsubr (&Sprocess_contact);
7571 defsubr (&Sprocess_plist);
7572 defsubr (&Sset_process_plist);
7573 defsubr (&Sprocess_list);
7574 defsubr (&Sstart_process);
7575 defsubr (&Sserial_process_configure);
7576 defsubr (&Smake_serial_process);
7577 defsubr (&Sset_network_process_option);
7578 defsubr (&Smake_network_process);
7579 defsubr (&Sformat_network_address);
7580 #if defined (HAVE_NET_IF_H)
7581 #ifdef SIOCGIFCONF
7582 defsubr (&Snetwork_interface_list);
7583 #endif
7584 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
7585 defsubr (&Snetwork_interface_info);
7586 #endif
7587 #endif /* defined (HAVE_NET_IF_H) */
7588 #ifdef DATAGRAM_SOCKETS
7589 defsubr (&Sprocess_datagram_address);
7590 defsubr (&Sset_process_datagram_address);
7591 #endif
7592 defsubr (&Saccept_process_output);
7593 defsubr (&Sprocess_send_region);
7594 defsubr (&Sprocess_send_string);
7595 defsubr (&Sinterrupt_process);
7596 defsubr (&Skill_process);
7597 defsubr (&Squit_process);
7598 defsubr (&Sstop_process);
7599 defsubr (&Scontinue_process);
7600 defsubr (&Sprocess_running_child_p);
7601 defsubr (&Sprocess_send_eof);
7602 defsubr (&Ssignal_process);
7603 defsubr (&Swaiting_for_user_input_p);
7604 defsubr (&Sprocess_type);
7605 defsubr (&Sset_process_coding_system);
7606 defsubr (&Sprocess_coding_system);
7607 defsubr (&Sset_process_filter_multibyte);
7608 defsubr (&Sprocess_filter_multibyte_p);
7610 #endif /* subprocesses */
7612 defsubr (&Sget_buffer_process);
7613 defsubr (&Sprocess_inherit_coding_system_flag);
7614 defsubr (&Slist_system_processes);
7615 defsubr (&Sprocess_attributes);