* admin/admin.el (make-manuals): Don't bother with txt or dvi any more.
[emacs.git] / src / process.c
blobb63a985fcec8111062826722c57806525eeb3dec
1 /* Asynchronous subprocess control for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2013 Free Software
4 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>
24 #define PROCESS_INLINE EXTERN_INLINE
26 #include <stdio.h>
27 #include <errno.h>
28 #include <sys/types.h> /* Some typedefs are used in sys/file.h. */
29 #include <sys/file.h>
30 #include <sys/stat.h>
31 #include <unistd.h>
32 #include <fcntl.h>
34 #include "lisp.h"
36 /* Only MS-DOS does not define `subprocesses'. */
37 #ifdef subprocesses
39 #include <sys/socket.h>
40 #include <netdb.h>
41 #include <netinet/in.h>
42 #include <arpa/inet.h>
44 /* Are local (unix) sockets supported? */
45 #if defined (HAVE_SYS_UN_H)
46 #if !defined (AF_LOCAL) && defined (AF_UNIX)
47 #define AF_LOCAL AF_UNIX
48 #endif
49 #ifdef AF_LOCAL
50 #define HAVE_LOCAL_SOCKETS
51 #include <sys/un.h>
52 #endif
53 #endif
55 #include <sys/ioctl.h>
56 #if defined (HAVE_NET_IF_H)
57 #include <net/if.h>
58 #endif /* HAVE_NET_IF_H */
60 #if defined (HAVE_IFADDRS_H)
61 /* Must be after net/if.h */
62 #include <ifaddrs.h>
64 /* We only use structs from this header when we use getifaddrs. */
65 #if defined (HAVE_NET_IF_DL_H)
66 #include <net/if_dl.h>
67 #endif
69 #endif
71 #ifdef NEED_BSDTTY
72 #include <bsdtty.h>
73 #endif
75 #ifdef USG5_4
76 # include <sys/stream.h>
77 # include <sys/stropts.h>
78 #endif
80 #ifdef HAVE_RES_INIT
81 #include <netinet/in.h>
82 #include <arpa/nameser.h>
83 #include <resolv.h>
84 #endif
86 #ifdef HAVE_UTIL_H
87 #include <util.h>
88 #endif
90 #ifdef HAVE_PTY_H
91 #include <pty.h>
92 #endif
94 #include <c-ctype.h>
95 #include <sig2str.h>
97 #endif /* subprocesses */
99 #include "systime.h"
100 #include "systty.h"
102 #include "window.h"
103 #include "character.h"
104 #include "buffer.h"
105 #include "coding.h"
106 #include "process.h"
107 #include "frame.h"
108 #include "termhooks.h"
109 #include "termopts.h"
110 #include "commands.h"
111 #include "keyboard.h"
112 #include "blockinput.h"
113 #include "dispextern.h"
114 #include "composite.h"
115 #include "atimer.h"
116 #include "sysselect.h"
117 #include "syssignal.h"
118 #include "syswait.h"
119 #ifdef HAVE_GNUTLS
120 #include "gnutls.h"
121 #endif
123 #ifdef HAVE_WINDOW_SYSTEM
124 #include TERM_HEADER
125 #endif /* HAVE_WINDOW_SYSTEM */
127 #ifdef HAVE_GLIB
128 #include "xgselect.h"
129 #ifndef WINDOWSNT
130 #include <glib.h>
131 #endif
132 #endif
134 #ifdef WINDOWSNT
135 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
136 EMACS_TIME *, void *);
137 #endif
139 /* Work around GCC 4.7.0 bug with strict overflow checking; see
140 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
141 These lines can be removed once the GCC bug is fixed. */
142 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
143 # pragma GCC diagnostic ignored "-Wstrict-overflow"
144 #endif
146 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
147 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
148 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
149 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
150 Lisp_Object QCname, QCtype;
152 /* True if keyboard input is on hold, zero otherwise. */
154 static bool kbd_is_on_hold;
156 /* Nonzero means don't run process sentinels. This is used
157 when exiting. */
158 bool inhibit_sentinels;
160 #ifdef subprocesses
162 Lisp_Object Qprocessp;
163 static Lisp_Object Qrun, Qstop, Qsignal;
164 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
165 Lisp_Object Qlocal;
166 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
167 static Lisp_Object Qreal, Qnetwork, Qserial;
168 #ifdef AF_INET6
169 static Lisp_Object Qipv6;
170 #endif
171 static Lisp_Object QCport, QCprocess;
172 Lisp_Object QCspeed;
173 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
174 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
175 static Lisp_Object QCbuffer, QChost, QCservice;
176 static Lisp_Object QClocal, QCremote, QCcoding;
177 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
178 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
179 static Lisp_Object Qlast_nonmenu_event;
180 static Lisp_Object Qinternal_default_process_sentinel;
181 static Lisp_Object Qinternal_default_process_filter;
183 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
184 #define NETCONN1_P(p) (EQ (p->type, Qnetwork))
185 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
186 #define SERIALCONN1_P(p) (EQ (p->type, Qserial))
188 /* Number of events of change of status of a process. */
189 static EMACS_INT process_tick;
190 /* Number of events for which the user or sentinel has been notified. */
191 static EMACS_INT update_tick;
193 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
195 /* Only W32 has this, it really means that select can't take write mask. */
196 #ifdef BROKEN_NON_BLOCKING_CONNECT
197 #undef NON_BLOCKING_CONNECT
198 #define SELECT_CANT_DO_WRITE_MASK
199 #else
200 #ifndef NON_BLOCKING_CONNECT
201 #ifdef HAVE_SELECT
202 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
203 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
204 #define NON_BLOCKING_CONNECT
205 #endif /* EWOULDBLOCK || EINPROGRESS */
206 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
207 #endif /* HAVE_SELECT */
208 #endif /* NON_BLOCKING_CONNECT */
209 #endif /* BROKEN_NON_BLOCKING_CONNECT */
211 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
212 this system. We need to read full packets, so we need a
213 "non-destructive" select. So we require either native select,
214 or emulation of select using FIONREAD. */
216 #ifndef BROKEN_DATAGRAM_SOCKETS
217 # if defined HAVE_SELECT || defined USABLE_FIONREAD
218 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
219 # define DATAGRAM_SOCKETS
220 # endif
221 # endif
222 #endif
224 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
225 # define HAVE_SEQPACKET
226 #endif
228 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
229 #define ADAPTIVE_READ_BUFFERING
230 #endif
232 #ifdef ADAPTIVE_READ_BUFFERING
233 #define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
234 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
235 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
237 /* Number of processes which have a non-zero read_output_delay,
238 and therefore might be delayed for adaptive read buffering. */
240 static int process_output_delay_count;
242 /* True if any process has non-nil read_output_skip. */
244 static bool process_output_skip;
246 #else
247 #define process_output_delay_count 0
248 #endif
250 static void create_process (Lisp_Object, char **, Lisp_Object);
251 #ifdef USABLE_SIGIO
252 static bool keyboard_bit_set (SELECT_TYPE *);
253 #endif
254 static void deactivate_process (Lisp_Object);
255 static void status_notify (struct Lisp_Process *);
256 static int read_process_output (Lisp_Object, int);
257 static void handle_child_signal (int);
258 static void create_pty (Lisp_Object);
260 /* If we support a window system, turn on the code to poll periodically
261 to detect C-g. It isn't actually used when doing interrupt input. */
262 #ifdef HAVE_WINDOW_SYSTEM
263 #define POLL_FOR_INPUT
264 #endif
266 static Lisp_Object get_process (register Lisp_Object name);
267 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
269 /* Mask of bits indicating the descriptors that we wait for input on. */
271 static SELECT_TYPE input_wait_mask;
273 /* Mask that excludes keyboard input descriptor(s). */
275 static SELECT_TYPE non_keyboard_wait_mask;
277 /* Mask that excludes process input descriptor(s). */
279 static SELECT_TYPE non_process_wait_mask;
281 /* Mask for selecting for write. */
283 static SELECT_TYPE write_mask;
285 #ifdef NON_BLOCKING_CONNECT
286 /* Mask of bits indicating the descriptors that we wait for connect to
287 complete on. Once they complete, they are removed from this mask
288 and added to the input_wait_mask and non_keyboard_wait_mask. */
290 static SELECT_TYPE connect_wait_mask;
292 /* Number of bits set in connect_wait_mask. */
293 static int num_pending_connects;
294 #endif /* NON_BLOCKING_CONNECT */
296 /* The largest descriptor currently in use for a process object. */
297 static int max_process_desc;
299 /* The largest descriptor currently in use for input. */
300 static int max_input_desc;
302 /* Indexed by descriptor, gives the process (if any) for that descriptor */
303 static Lisp_Object chan_process[MAXDESC];
305 /* Alist of elements (NAME . PROCESS) */
306 static Lisp_Object Vprocess_alist;
308 /* Buffered-ahead input char from process, indexed by channel.
309 -1 means empty (no char is buffered).
310 Used on sys V where the only way to tell if there is any
311 output from the process is to read at least one char.
312 Always -1 on systems that support FIONREAD. */
314 static int proc_buffered_char[MAXDESC];
316 /* Table of `struct coding-system' for each process. */
317 static struct coding_system *proc_decode_coding_system[MAXDESC];
318 static struct coding_system *proc_encode_coding_system[MAXDESC];
320 #ifdef DATAGRAM_SOCKETS
321 /* Table of `partner address' for datagram sockets. */
322 static struct sockaddr_and_len {
323 struct sockaddr *sa;
324 int len;
325 } datagram_address[MAXDESC];
326 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
327 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
328 #else
329 #define DATAGRAM_CHAN_P(chan) (0)
330 #define DATAGRAM_CONN_P(proc) (0)
331 #endif
333 /* These setters are used only in this file, so they can be private. */
334 static void
335 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
337 p->buffer = val;
339 static void
340 pset_command (struct Lisp_Process *p, Lisp_Object val)
342 p->command = val;
344 static void
345 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
347 p->decode_coding_system = val;
349 static void
350 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
352 p->decoding_buf = val;
354 static void
355 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
357 p->encode_coding_system = val;
359 static void
360 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
362 p->encoding_buf = val;
364 static void
365 pset_filter (struct Lisp_Process *p, Lisp_Object val)
367 p->filter = NILP (val) ? Qinternal_default_process_filter : val;
369 static void
370 pset_log (struct Lisp_Process *p, Lisp_Object val)
372 p->log = val;
374 static void
375 pset_mark (struct Lisp_Process *p, Lisp_Object val)
377 p->mark = val;
379 static void
380 pset_name (struct Lisp_Process *p, Lisp_Object val)
382 p->name = val;
384 static void
385 pset_plist (struct Lisp_Process *p, Lisp_Object val)
387 p->plist = val;
389 static void
390 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
392 p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
394 static void
395 pset_status (struct Lisp_Process *p, Lisp_Object val)
397 p->status = val;
399 static void
400 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
402 p->tty_name = val;
404 static void
405 pset_type (struct Lisp_Process *p, Lisp_Object val)
407 p->type = val;
409 static void
410 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
412 p->write_queue = val;
417 static struct fd_callback_data
419 fd_callback func;
420 void *data;
421 #define FOR_READ 1
422 #define FOR_WRITE 2
423 int condition; /* mask of the defines above. */
424 } fd_callback_info[MAXDESC];
427 /* Add a file descriptor FD to be monitored for when read is possible.
428 When read is possible, call FUNC with argument DATA. */
430 void
431 add_read_fd (int fd, fd_callback func, void *data)
433 eassert (fd < MAXDESC);
434 add_keyboard_wait_descriptor (fd);
436 fd_callback_info[fd].func = func;
437 fd_callback_info[fd].data = data;
438 fd_callback_info[fd].condition |= FOR_READ;
441 /* Stop monitoring file descriptor FD for when read is possible. */
443 void
444 delete_read_fd (int fd)
446 eassert (fd < MAXDESC);
447 delete_keyboard_wait_descriptor (fd);
449 fd_callback_info[fd].condition &= ~FOR_READ;
450 if (fd_callback_info[fd].condition == 0)
452 fd_callback_info[fd].func = 0;
453 fd_callback_info[fd].data = 0;
457 /* Add a file descriptor FD to be monitored for when write is possible.
458 When write is possible, call FUNC with argument DATA. */
460 void
461 add_write_fd (int fd, fd_callback func, void *data)
463 eassert (fd < MAXDESC);
464 FD_SET (fd, &write_mask);
465 if (fd > max_input_desc)
466 max_input_desc = fd;
468 fd_callback_info[fd].func = func;
469 fd_callback_info[fd].data = data;
470 fd_callback_info[fd].condition |= FOR_WRITE;
473 /* Stop monitoring file descriptor FD for when write is possible. */
475 void
476 delete_write_fd (int fd)
478 int lim = max_input_desc;
480 eassert (fd < MAXDESC);
481 FD_CLR (fd, &write_mask);
482 fd_callback_info[fd].condition &= ~FOR_WRITE;
483 if (fd_callback_info[fd].condition == 0)
485 fd_callback_info[fd].func = 0;
486 fd_callback_info[fd].data = 0;
488 if (fd == max_input_desc)
489 for (fd = lim; fd >= 0; fd--)
490 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
492 max_input_desc = fd;
493 break;
500 /* Compute the Lisp form of the process status, p->status, from
501 the numeric status that was returned by `wait'. */
503 static Lisp_Object status_convert (int);
505 static void
506 update_status (struct Lisp_Process *p)
508 eassert (p->raw_status_new);
509 pset_status (p, status_convert (p->raw_status));
510 p->raw_status_new = 0;
513 /* Convert a process status word in Unix format to
514 the list that we use internally. */
516 static Lisp_Object
517 status_convert (int w)
519 if (WIFSTOPPED (w))
520 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
521 else if (WIFEXITED (w))
522 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
523 WCOREDUMP (w) ? Qt : Qnil));
524 else if (WIFSIGNALED (w))
525 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
526 WCOREDUMP (w) ? Qt : Qnil));
527 else
528 return Qrun;
531 /* Given a status-list, extract the three pieces of information
532 and store them individually through the three pointers. */
534 static void
535 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
537 Lisp_Object tem;
539 if (SYMBOLP (l))
541 *symbol = l;
542 *code = 0;
543 *coredump = 0;
545 else
547 *symbol = XCAR (l);
548 tem = XCDR (l);
549 *code = XFASTINT (XCAR (tem));
550 tem = XCDR (tem);
551 *coredump = !NILP (tem);
555 /* Return a string describing a process status list. */
557 static Lisp_Object
558 status_message (struct Lisp_Process *p)
560 Lisp_Object status = p->status;
561 Lisp_Object symbol;
562 int code;
563 bool coredump;
564 Lisp_Object string, string2;
566 decode_status (status, &symbol, &code, &coredump);
568 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
570 char const *signame;
571 synchronize_system_messages_locale ();
572 signame = strsignal (code);
573 if (signame == 0)
574 string = build_string ("unknown");
575 else
577 int c1, c2;
579 string = build_unibyte_string (signame);
580 if (! NILP (Vlocale_coding_system))
581 string = (code_convert_string_norecord
582 (string, Vlocale_coding_system, 0));
583 c1 = STRING_CHAR (SDATA (string));
584 c2 = downcase (c1);
585 if (c1 != c2)
586 Faset (string, make_number (0), make_number (c2));
588 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
589 return concat2 (string, string2);
591 else if (EQ (symbol, Qexit))
593 if (NETCONN1_P (p))
594 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
595 if (code == 0)
596 return build_string ("finished\n");
597 string = Fnumber_to_string (make_number (code));
598 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
599 return concat3 (build_string ("exited abnormally with code "),
600 string, string2);
602 else if (EQ (symbol, Qfailed))
604 string = Fnumber_to_string (make_number (code));
605 string2 = build_string ("\n");
606 return concat3 (build_string ("failed with code "),
607 string, string2);
609 else
610 return Fcopy_sequence (Fsymbol_name (symbol));
613 #ifdef HAVE_PTYS
615 /* The file name of the pty opened by allocate_pty. */
616 static char pty_name[24];
618 /* Open an available pty, returning a file descriptor.
619 Return -1 on failure.
620 The file name of the terminal corresponding to the pty
621 is left in the variable pty_name. */
623 static int
624 allocate_pty (void)
626 int fd;
628 #ifdef PTY_ITERATION
629 PTY_ITERATION
630 #else
631 register int c, i;
632 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
633 for (i = 0; i < 16; i++)
634 #endif
636 #ifdef PTY_NAME_SPRINTF
637 PTY_NAME_SPRINTF
638 #else
639 sprintf (pty_name, "/dev/pty%c%x", c, i);
640 #endif /* no PTY_NAME_SPRINTF */
642 #ifdef PTY_OPEN
643 PTY_OPEN;
644 #else /* no PTY_OPEN */
645 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
646 #endif /* no PTY_OPEN */
648 if (fd >= 0)
650 /* check to make certain that both sides are available
651 this avoids a nasty yet stupid bug in rlogins */
652 #ifdef PTY_TTY_NAME_SPRINTF
653 PTY_TTY_NAME_SPRINTF
654 #else
655 sprintf (pty_name, "/dev/tty%c%x", c, i);
656 #endif /* no PTY_TTY_NAME_SPRINTF */
657 if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
659 emacs_close (fd);
660 # ifndef __sgi
661 continue;
662 # else
663 return -1;
664 # endif /* __sgi */
666 setup_pty (fd);
667 return fd;
670 return -1;
672 #endif /* HAVE_PTYS */
674 static Lisp_Object
675 make_process (Lisp_Object name)
677 register Lisp_Object val, tem, name1;
678 register struct Lisp_Process *p;
679 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
680 printmax_t i;
682 p = allocate_process ();
683 /* Initialize Lisp data. Note that allocate_process initializes all
684 Lisp data to nil, so do it only for slots which should not be nil. */
685 pset_status (p, Qrun);
686 pset_mark (p, Fmake_marker ());
688 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
689 non-Lisp data, so do it only for slots which should not be zero. */
690 p->infd = -1;
691 p->outfd = -1;
693 #ifdef HAVE_GNUTLS
694 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
695 #endif
697 /* If name is already in use, modify it until it is unused. */
699 name1 = name;
700 for (i = 1; ; i++)
702 tem = Fget_process (name1);
703 if (NILP (tem)) break;
704 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
706 name = name1;
707 pset_name (p, name);
708 pset_sentinel (p, Qinternal_default_process_sentinel);
709 pset_filter (p, Qinternal_default_process_filter);
710 XSETPROCESS (val, p);
711 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
712 return val;
715 static void
716 remove_process (register Lisp_Object proc)
718 register Lisp_Object pair;
720 pair = Frassq (proc, Vprocess_alist);
721 Vprocess_alist = Fdelq (pair, Vprocess_alist);
723 deactivate_process (proc);
727 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
728 doc: /* Return t if OBJECT is a process. */)
729 (Lisp_Object object)
731 return PROCESSP (object) ? Qt : Qnil;
734 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
735 doc: /* Return the process named NAME, or nil if there is none. */)
736 (register Lisp_Object name)
738 if (PROCESSP (name))
739 return name;
740 CHECK_STRING (name);
741 return Fcdr (Fassoc (name, Vprocess_alist));
744 /* This is how commands for the user decode process arguments. It
745 accepts a process, a process name, a buffer, a buffer name, or nil.
746 Buffers denote the first process in the buffer, and nil denotes the
747 current buffer. */
749 static Lisp_Object
750 get_process (register Lisp_Object name)
752 register Lisp_Object proc, obj;
753 if (STRINGP (name))
755 obj = Fget_process (name);
756 if (NILP (obj))
757 obj = Fget_buffer (name);
758 if (NILP (obj))
759 error ("Process %s does not exist", SDATA (name));
761 else if (NILP (name))
762 obj = Fcurrent_buffer ();
763 else
764 obj = name;
766 /* Now obj should be either a buffer object or a process object.
768 if (BUFFERP (obj))
770 proc = Fget_buffer_process (obj);
771 if (NILP (proc))
772 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
774 else
776 CHECK_PROCESS (obj);
777 proc = obj;
779 return proc;
783 /* Fdelete_process promises to immediately forget about the process, but in
784 reality, Emacs needs to remember those processes until they have been
785 treated by the SIGCHLD handler and waitpid has been invoked on them;
786 otherwise they might fill up the kernel's process table.
788 Some processes created by call-process are also put onto this list. */
789 static Lisp_Object deleted_pid_list;
791 void
792 record_deleted_pid (pid_t pid)
794 deleted_pid_list = Fcons (make_fixnum_or_float (pid),
795 /* GC treated elements set to nil. */
796 Fdelq (Qnil, deleted_pid_list));
800 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
801 doc: /* Delete PROCESS: kill it and forget about it immediately.
802 PROCESS may be a process, a buffer, the name of a process or buffer, or
803 nil, indicating the current buffer's process. */)
804 (register Lisp_Object process)
806 register struct Lisp_Process *p;
808 process = get_process (process);
809 p = XPROCESS (process);
811 p->raw_status_new = 0;
812 if (NETCONN1_P (p) || SERIALCONN1_P (p))
814 pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
815 p->tick = ++process_tick;
816 status_notify (p);
817 redisplay_preserve_echo_area (13);
819 else
821 if (p->alive)
822 record_kill_process (p);
824 if (p->infd >= 0)
826 /* Update P's status, since record_kill_process will make the
827 SIGCHLD handler update deleted_pid_list, not *P. */
828 Lisp_Object symbol;
829 if (p->raw_status_new)
830 update_status (p);
831 symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
832 if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
833 pset_status (p, list2 (Qsignal, make_number (SIGKILL)));
835 p->tick = ++process_tick;
836 status_notify (p);
837 redisplay_preserve_echo_area (13);
840 remove_process (process);
841 return Qnil;
844 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
845 doc: /* Return the status of PROCESS.
846 The returned value is one of the following symbols:
847 run -- for a process that is running.
848 stop -- for a process stopped but continuable.
849 exit -- for a process that has exited.
850 signal -- for a process that has got a fatal signal.
851 open -- for a network stream connection that is open.
852 listen -- for a network stream server that is listening.
853 closed -- for a network stream connection that is closed.
854 connect -- when waiting for a non-blocking connection to complete.
855 failed -- when a non-blocking connection has failed.
856 nil -- if arg is a process name and no such process exists.
857 PROCESS may be a process, a buffer, the name of a process, or
858 nil, indicating the current buffer's process. */)
859 (register Lisp_Object process)
861 register struct Lisp_Process *p;
862 register Lisp_Object status;
864 if (STRINGP (process))
865 process = Fget_process (process);
866 else
867 process = get_process (process);
869 if (NILP (process))
870 return process;
872 p = XPROCESS (process);
873 if (p->raw_status_new)
874 update_status (p);
875 status = p->status;
876 if (CONSP (status))
877 status = XCAR (status);
878 if (NETCONN1_P (p) || SERIALCONN1_P (p))
880 if (EQ (status, Qexit))
881 status = Qclosed;
882 else if (EQ (p->command, Qt))
883 status = Qstop;
884 else if (EQ (status, Qrun))
885 status = Qopen;
887 return status;
890 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
891 1, 1, 0,
892 doc: /* Return the exit status of PROCESS or the signal number that killed it.
893 If PROCESS has not yet exited or died, return 0. */)
894 (register Lisp_Object process)
896 CHECK_PROCESS (process);
897 if (XPROCESS (process)->raw_status_new)
898 update_status (XPROCESS (process));
899 if (CONSP (XPROCESS (process)->status))
900 return XCAR (XCDR (XPROCESS (process)->status));
901 return make_number (0);
904 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
905 doc: /* Return the process id of PROCESS.
906 This is the pid of the external process which PROCESS uses or talks to.
907 For a network connection, this value is nil. */)
908 (register Lisp_Object process)
910 pid_t pid;
912 CHECK_PROCESS (process);
913 pid = XPROCESS (process)->pid;
914 return (pid ? make_fixnum_or_float (pid) : Qnil);
917 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
918 doc: /* Return the name of PROCESS, as a string.
919 This is the name of the program invoked in PROCESS,
920 possibly modified to make it unique among process names. */)
921 (register Lisp_Object process)
923 CHECK_PROCESS (process);
924 return XPROCESS (process)->name;
927 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
928 doc: /* Return the command that was executed to start PROCESS.
929 This is a list of strings, the first string being the program executed
930 and the rest of the strings being the arguments given to it.
931 For a network or serial process, this is nil (process is running) or t
932 \(process is stopped). */)
933 (register Lisp_Object process)
935 CHECK_PROCESS (process);
936 return XPROCESS (process)->command;
939 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
940 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
941 This is the terminal that the process itself reads and writes on,
942 not the name of the pty that Emacs uses to talk with that terminal. */)
943 (register Lisp_Object process)
945 CHECK_PROCESS (process);
946 return XPROCESS (process)->tty_name;
949 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
950 2, 2, 0,
951 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
952 Return BUFFER. */)
953 (register Lisp_Object process, Lisp_Object buffer)
955 struct Lisp_Process *p;
957 CHECK_PROCESS (process);
958 if (!NILP (buffer))
959 CHECK_BUFFER (buffer);
960 p = XPROCESS (process);
961 pset_buffer (p, buffer);
962 if (NETCONN1_P (p) || SERIALCONN1_P (p))
963 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
964 setup_process_coding_systems (process);
965 return buffer;
968 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
969 1, 1, 0,
970 doc: /* Return the buffer PROCESS is associated with.
971 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
972 (register Lisp_Object process)
974 CHECK_PROCESS (process);
975 return XPROCESS (process)->buffer;
978 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
979 1, 1, 0,
980 doc: /* Return the marker for the end of the last output from PROCESS. */)
981 (register Lisp_Object process)
983 CHECK_PROCESS (process);
984 return XPROCESS (process)->mark;
987 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
988 2, 2, 0,
989 doc: /* Give PROCESS the filter function FILTER; nil means default.
990 A value of t means stop accepting output from the process.
992 When a process has a non-default filter, its buffer is not used for output.
993 Instead, each time it does output, the entire string of output is
994 passed to the filter.
996 The filter gets two arguments: the process and the string of output.
997 The string argument is normally a multibyte string, except:
998 - if the process' input coding system is no-conversion or raw-text,
999 it is a unibyte string (the non-converted input), or else
1000 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1001 string (the result of converting the decoded input multibyte
1002 string to unibyte with `string-make-unibyte'). */)
1003 (register Lisp_Object process, Lisp_Object filter)
1005 struct Lisp_Process *p;
1007 CHECK_PROCESS (process);
1008 p = XPROCESS (process);
1010 /* Don't signal an error if the process' input file descriptor
1011 is closed. This could make debugging Lisp more difficult,
1012 for example when doing something like
1014 (setq process (start-process ...))
1015 (debug)
1016 (set-process-filter process ...) */
1018 if (NILP (filter))
1019 filter = Qinternal_default_process_filter;
1021 if (p->infd >= 0)
1023 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1025 FD_CLR (p->infd, &input_wait_mask);
1026 FD_CLR (p->infd, &non_keyboard_wait_mask);
1028 else if (EQ (p->filter, Qt)
1029 /* Network or serial process not stopped: */
1030 && !EQ (p->command, Qt))
1032 FD_SET (p->infd, &input_wait_mask);
1033 FD_SET (p->infd, &non_keyboard_wait_mask);
1037 pset_filter (p, filter);
1038 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1039 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1040 setup_process_coding_systems (process);
1041 return filter;
1044 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1045 1, 1, 0,
1046 doc: /* Return the filter function of PROCESS.
1047 See `set-process-filter' for more info on filter functions. */)
1048 (register Lisp_Object process)
1050 CHECK_PROCESS (process);
1051 return XPROCESS (process)->filter;
1054 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1055 2, 2, 0,
1056 doc: /* Give PROCESS the sentinel SENTINEL; nil for default.
1057 The sentinel is called as a function when the process changes state.
1058 It gets two arguments: the process, and a string describing the change. */)
1059 (register Lisp_Object process, Lisp_Object sentinel)
1061 struct Lisp_Process *p;
1063 CHECK_PROCESS (process);
1064 p = XPROCESS (process);
1066 if (NILP (sentinel))
1067 sentinel = Qinternal_default_process_sentinel;
1069 pset_sentinel (p, sentinel);
1070 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1071 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1072 return sentinel;
1075 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1076 1, 1, 0,
1077 doc: /* Return the sentinel of PROCESS.
1078 See `set-process-sentinel' for more info on sentinels. */)
1079 (register Lisp_Object process)
1081 CHECK_PROCESS (process);
1082 return XPROCESS (process)->sentinel;
1085 DEFUN ("set-process-window-size", Fset_process_window_size,
1086 Sset_process_window_size, 3, 3, 0,
1087 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1088 (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1090 CHECK_PROCESS (process);
1091 CHECK_RANGED_INTEGER (height, 0, INT_MAX);
1092 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
1094 if (XPROCESS (process)->infd < 0
1095 || set_window_size (XPROCESS (process)->infd,
1096 XINT (height), XINT (width)) <= 0)
1097 return Qnil;
1098 else
1099 return Qt;
1102 DEFUN ("set-process-inherit-coding-system-flag",
1103 Fset_process_inherit_coding_system_flag,
1104 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1105 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1106 If the second argument FLAG is non-nil, then the variable
1107 `buffer-file-coding-system' of the buffer associated with PROCESS
1108 will be bound to the value of the coding system used to decode
1109 the process output.
1111 This is useful when the coding system specified for the process buffer
1112 leaves either the character code conversion or the end-of-line conversion
1113 unspecified, or if the coding system used to decode the process output
1114 is more appropriate for saving the process buffer.
1116 Binding the variable `inherit-process-coding-system' to non-nil before
1117 starting the process is an alternative way of setting the inherit flag
1118 for the process which will run.
1120 This function returns FLAG. */)
1121 (register Lisp_Object process, Lisp_Object flag)
1123 CHECK_PROCESS (process);
1124 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1125 return flag;
1128 DEFUN ("set-process-query-on-exit-flag",
1129 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1130 2, 2, 0,
1131 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1132 If the second argument FLAG is non-nil, Emacs will query the user before
1133 exiting or killing a buffer if PROCESS is running. This function
1134 returns FLAG. */)
1135 (register Lisp_Object process, Lisp_Object flag)
1137 CHECK_PROCESS (process);
1138 XPROCESS (process)->kill_without_query = NILP (flag);
1139 return flag;
1142 DEFUN ("process-query-on-exit-flag",
1143 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1144 1, 1, 0,
1145 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1146 (register Lisp_Object process)
1148 CHECK_PROCESS (process);
1149 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1152 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1153 1, 2, 0,
1154 doc: /* Return the contact info of PROCESS; t for a real child.
1155 For a network or serial connection, the value depends on the optional
1156 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1157 SERVICE) for a network connection or (PORT SPEED) for a serial
1158 connection. If KEY is t, the complete contact information for the
1159 connection is returned, else the specific value for the keyword KEY is
1160 returned. See `make-network-process' or `make-serial-process' for a
1161 list of keywords. */)
1162 (register Lisp_Object process, Lisp_Object key)
1164 Lisp_Object contact;
1166 CHECK_PROCESS (process);
1167 contact = XPROCESS (process)->childp;
1169 #ifdef DATAGRAM_SOCKETS
1170 if (DATAGRAM_CONN_P (process)
1171 && (EQ (key, Qt) || EQ (key, QCremote)))
1172 contact = Fplist_put (contact, QCremote,
1173 Fprocess_datagram_address (process));
1174 #endif
1176 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1177 return contact;
1178 if (NILP (key) && NETCONN_P (process))
1179 return Fcons (Fplist_get (contact, QChost),
1180 Fcons (Fplist_get (contact, QCservice), Qnil));
1181 if (NILP (key) && SERIALCONN_P (process))
1182 return Fcons (Fplist_get (contact, QCport),
1183 Fcons (Fplist_get (contact, QCspeed), Qnil));
1184 return Fplist_get (contact, key);
1187 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1188 1, 1, 0,
1189 doc: /* Return the plist of PROCESS. */)
1190 (register Lisp_Object process)
1192 CHECK_PROCESS (process);
1193 return XPROCESS (process)->plist;
1196 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1197 2, 2, 0,
1198 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1199 (register Lisp_Object process, Lisp_Object plist)
1201 CHECK_PROCESS (process);
1202 CHECK_LIST (plist);
1204 pset_plist (XPROCESS (process), plist);
1205 return plist;
1208 #if 0 /* Turned off because we don't currently record this info
1209 in the process. Perhaps add it. */
1210 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1211 doc: /* Return the connection type of PROCESS.
1212 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1213 a socket connection. */)
1214 (Lisp_Object process)
1216 return XPROCESS (process)->type;
1218 #endif
1220 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1221 doc: /* Return the connection type of PROCESS.
1222 The value is either the symbol `real', `network', or `serial'.
1223 PROCESS may be a process, a buffer, the name of a process or buffer, or
1224 nil, indicating the current buffer's process. */)
1225 (Lisp_Object process)
1227 Lisp_Object proc;
1228 proc = get_process (process);
1229 return XPROCESS (proc)->type;
1232 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1233 1, 2, 0,
1234 doc: /* Convert network ADDRESS from internal format to a string.
1235 A 4 or 5 element vector represents an IPv4 address (with port number).
1236 An 8 or 9 element vector represents an IPv6 address (with port number).
1237 If optional second argument OMIT-PORT is non-nil, don't include a port
1238 number in the string, even when present in ADDRESS.
1239 Returns nil if format of ADDRESS is invalid. */)
1240 (Lisp_Object address, Lisp_Object omit_port)
1242 if (NILP (address))
1243 return Qnil;
1245 if (STRINGP (address)) /* AF_LOCAL */
1246 return address;
1248 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1250 register struct Lisp_Vector *p = XVECTOR (address);
1251 ptrdiff_t size = p->header.size;
1252 Lisp_Object args[10];
1253 int nargs, i;
1255 if (size == 4 || (size == 5 && !NILP (omit_port)))
1257 args[0] = build_string ("%d.%d.%d.%d");
1258 nargs = 4;
1260 else if (size == 5)
1262 args[0] = build_string ("%d.%d.%d.%d:%d");
1263 nargs = 5;
1265 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1267 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1268 nargs = 8;
1270 else if (size == 9)
1272 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1273 nargs = 9;
1275 else
1276 return Qnil;
1278 for (i = 0; i < nargs; i++)
1280 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1281 return Qnil;
1283 if (nargs <= 5 /* IPv4 */
1284 && i < 4 /* host, not port */
1285 && XINT (p->contents[i]) > 255)
1286 return Qnil;
1288 args[i+1] = p->contents[i];
1291 return Fformat (nargs+1, args);
1294 if (CONSP (address))
1296 Lisp_Object args[2];
1297 args[0] = build_string ("<Family %d>");
1298 args[1] = Fcar (address);
1299 return Fformat (2, args);
1302 return Qnil;
1305 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1306 doc: /* Return a list of all processes. */)
1307 (void)
1309 return Fmapcar (Qcdr, Vprocess_alist);
1312 /* Starting asynchronous inferior processes. */
1314 static Lisp_Object start_process_unwind (Lisp_Object proc);
1316 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1317 doc: /* Start a program in a subprocess. Return the process object for it.
1318 NAME is name for process. It is modified if necessary to make it unique.
1319 BUFFER is the buffer (or buffer name) to associate with the process.
1321 Process output (both standard output and standard error streams) goes
1322 at end of BUFFER, unless you specify an output stream or filter
1323 function to handle the output. BUFFER may also be nil, meaning that
1324 this process is not associated with any buffer.
1326 PROGRAM is the program file name. It is searched for in `exec-path'
1327 (which see). If nil, just associate a pty with the buffer. Remaining
1328 arguments are strings to give program as arguments.
1330 If you want to separate standard output from standard error, invoke
1331 the command through a shell and redirect one of them using the shell
1332 syntax.
1334 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1335 (ptrdiff_t nargs, Lisp_Object *args)
1337 Lisp_Object buffer, name, program, proc, current_dir, tem;
1338 register unsigned char **new_argv;
1339 ptrdiff_t i;
1340 ptrdiff_t count = SPECPDL_INDEX ();
1342 buffer = args[1];
1343 if (!NILP (buffer))
1344 buffer = Fget_buffer_create (buffer);
1346 /* Make sure that the child will be able to chdir to the current
1347 buffer's current directory, or its unhandled equivalent. We
1348 can't just have the child check for an error when it does the
1349 chdir, since it's in a vfork.
1351 We have to GCPRO around this because Fexpand_file_name and
1352 Funhandled_file_name_directory might call a file name handling
1353 function. The argument list is protected by the caller, so all
1354 we really have to worry about is buffer. */
1356 struct gcpro gcpro1, gcpro2;
1358 current_dir = BVAR (current_buffer, directory);
1360 GCPRO2 (buffer, current_dir);
1362 current_dir = Funhandled_file_name_directory (current_dir);
1363 if (NILP (current_dir))
1364 /* If the file name handler says that current_dir is unreachable, use
1365 a sensible default. */
1366 current_dir = build_string ("~/");
1367 current_dir = expand_and_dir_to_file (current_dir, Qnil);
1368 if (NILP (Ffile_accessible_directory_p (current_dir)))
1369 report_file_error ("Setting current directory",
1370 Fcons (BVAR (current_buffer, directory), Qnil));
1372 UNGCPRO;
1375 name = args[0];
1376 CHECK_STRING (name);
1378 program = args[2];
1380 if (!NILP (program))
1381 CHECK_STRING (program);
1383 proc = make_process (name);
1384 /* If an error occurs and we can't start the process, we want to
1385 remove it from the process list. This means that each error
1386 check in create_process doesn't need to call remove_process
1387 itself; it's all taken care of here. */
1388 record_unwind_protect (start_process_unwind, proc);
1390 pset_childp (XPROCESS (proc), Qt);
1391 pset_plist (XPROCESS (proc), Qnil);
1392 pset_type (XPROCESS (proc), Qreal);
1393 pset_buffer (XPROCESS (proc), buffer);
1394 pset_sentinel (XPROCESS (proc), Qinternal_default_process_sentinel);
1395 pset_filter (XPROCESS (proc), Qinternal_default_process_filter);
1396 pset_command (XPROCESS (proc), Flist (nargs - 2, args + 2));
1398 #ifdef HAVE_GNUTLS
1399 /* AKA GNUTLS_INITSTAGE(proc). */
1400 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1401 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1402 #endif
1404 #ifdef ADAPTIVE_READ_BUFFERING
1405 XPROCESS (proc)->adaptive_read_buffering
1406 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1407 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1408 #endif
1410 /* Make the process marker point into the process buffer (if any). */
1411 if (BUFFERP (buffer))
1412 set_marker_both (XPROCESS (proc)->mark, buffer,
1413 BUF_ZV (XBUFFER (buffer)),
1414 BUF_ZV_BYTE (XBUFFER (buffer)));
1417 /* Decide coding systems for communicating with the process. Here
1418 we don't setup the structure coding_system nor pay attention to
1419 unibyte mode. They are done in create_process. */
1421 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1422 Lisp_Object coding_systems = Qt;
1423 Lisp_Object val, *args2;
1424 struct gcpro gcpro1, gcpro2;
1426 val = Vcoding_system_for_read;
1427 if (NILP (val))
1429 args2 = alloca ((nargs + 1) * sizeof *args2);
1430 args2[0] = Qstart_process;
1431 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1432 GCPRO2 (proc, current_dir);
1433 if (!NILP (program))
1434 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1435 UNGCPRO;
1436 if (CONSP (coding_systems))
1437 val = XCAR (coding_systems);
1438 else if (CONSP (Vdefault_process_coding_system))
1439 val = XCAR (Vdefault_process_coding_system);
1441 pset_decode_coding_system (XPROCESS (proc), val);
1443 val = Vcoding_system_for_write;
1444 if (NILP (val))
1446 if (EQ (coding_systems, Qt))
1448 args2 = alloca ((nargs + 1) * sizeof *args2);
1449 args2[0] = Qstart_process;
1450 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1451 GCPRO2 (proc, current_dir);
1452 if (!NILP (program))
1453 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1454 UNGCPRO;
1456 if (CONSP (coding_systems))
1457 val = XCDR (coding_systems);
1458 else if (CONSP (Vdefault_process_coding_system))
1459 val = XCDR (Vdefault_process_coding_system);
1461 pset_encode_coding_system (XPROCESS (proc), val);
1462 /* Note: At this moment, the above coding system may leave
1463 text-conversion or eol-conversion unspecified. They will be
1464 decided after we read output from the process and decode it by
1465 some coding system, or just before we actually send a text to
1466 the process. */
1470 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1471 XPROCESS (proc)->decoding_carryover = 0;
1472 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1474 XPROCESS (proc)->inherit_coding_system_flag
1475 = !(NILP (buffer) || !inherit_process_coding_system);
1477 if (!NILP (program))
1479 /* If program file name is not absolute, search our path for it.
1480 Put the name we will really use in TEM. */
1481 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1482 && !(SCHARS (program) > 1
1483 && IS_DEVICE_SEP (SREF (program, 1))))
1485 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1487 tem = Qnil;
1488 GCPRO4 (name, program, buffer, current_dir);
1489 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1490 UNGCPRO;
1491 if (NILP (tem))
1492 report_file_error ("Searching for program", Fcons (program, Qnil));
1493 tem = Fexpand_file_name (tem, Qnil);
1495 else
1497 if (!NILP (Ffile_directory_p (program)))
1498 error ("Specified program for new process is a directory");
1499 tem = program;
1502 /* If program file name starts with /: for quoting a magic name,
1503 discard that. */
1504 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1505 && SREF (tem, 1) == ':')
1506 tem = Fsubstring (tem, make_number (2), Qnil);
1509 Lisp_Object arg_encoding = Qnil;
1510 struct gcpro gcpro1;
1511 GCPRO1 (tem);
1513 /* Encode the file name and put it in NEW_ARGV.
1514 That's where the child will use it to execute the program. */
1515 tem = Fcons (ENCODE_FILE (tem), Qnil);
1517 /* Here we encode arguments by the coding system used for sending
1518 data to the process. We don't support using different coding
1519 systems for encoding arguments and for encoding data sent to the
1520 process. */
1522 for (i = 3; i < nargs; i++)
1524 tem = Fcons (args[i], tem);
1525 CHECK_STRING (XCAR (tem));
1526 if (STRING_MULTIBYTE (XCAR (tem)))
1528 if (NILP (arg_encoding))
1529 arg_encoding = (complement_process_encoding_system
1530 (XPROCESS (proc)->encode_coding_system));
1531 XSETCAR (tem,
1532 code_convert_string_norecord
1533 (XCAR (tem), arg_encoding, 1));
1537 UNGCPRO;
1540 /* Now that everything is encoded we can collect the strings into
1541 NEW_ARGV. */
1542 new_argv = alloca ((nargs - 1) * sizeof *new_argv);
1543 new_argv[nargs - 2] = 0;
1545 for (i = nargs - 2; i-- != 0; )
1547 new_argv[i] = SDATA (XCAR (tem));
1548 tem = XCDR (tem);
1551 create_process (proc, (char **) new_argv, current_dir);
1553 else
1554 create_pty (proc);
1556 return unbind_to (count, proc);
1559 /* This function is the unwind_protect form for Fstart_process. If
1560 PROC doesn't have its pid set, then we know someone has signaled
1561 an error and the process wasn't started successfully, so we should
1562 remove it from the process list. */
1563 static Lisp_Object
1564 start_process_unwind (Lisp_Object proc)
1566 if (!PROCESSP (proc))
1567 emacs_abort ();
1569 /* Was PROC started successfully?
1570 -2 is used for a pty with no process, eg for gdb. */
1571 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1572 remove_process (proc);
1574 return Qnil;
1577 static void
1578 create_process_1 (struct atimer *timer)
1580 /* Nothing to do. */
1584 static void
1585 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1587 int inchannel, outchannel;
1588 pid_t pid;
1589 int sv[2];
1590 #ifndef WINDOWSNT
1591 int wait_child_setup[2];
1592 #endif
1593 int forkin, forkout;
1594 bool pty_flag = 0;
1595 Lisp_Object lisp_pty_name = Qnil;
1596 Lisp_Object encoded_current_dir;
1598 inchannel = outchannel = -1;
1600 #ifdef HAVE_PTYS
1601 if (!NILP (Vprocess_connection_type))
1602 outchannel = inchannel = allocate_pty ();
1604 if (inchannel >= 0)
1606 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1607 /* On most USG systems it does not work to open the pty's tty here,
1608 then close it and reopen it in the child. */
1609 /* Don't let this terminal become our controlling terminal
1610 (in case we don't have one). */
1611 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1612 if (forkin < 0)
1613 report_file_error ("Opening pty", Qnil);
1614 #else
1615 forkin = forkout = -1;
1616 #endif /* not USG, or USG_SUBTTY_WORKS */
1617 pty_flag = 1;
1618 lisp_pty_name = build_string (pty_name);
1620 else
1621 #endif /* HAVE_PTYS */
1623 int tem;
1624 tem = pipe (sv);
1625 if (tem < 0)
1626 report_file_error ("Creating pipe", Qnil);
1627 inchannel = sv[0];
1628 forkout = sv[1];
1629 tem = pipe (sv);
1630 if (tem < 0)
1632 emacs_close (inchannel);
1633 emacs_close (forkout);
1634 report_file_error ("Creating pipe", Qnil);
1636 outchannel = sv[1];
1637 forkin = sv[0];
1640 #ifndef WINDOWSNT
1642 int tem;
1644 tem = pipe (wait_child_setup);
1645 if (tem < 0)
1646 report_file_error ("Creating pipe", Qnil);
1647 tem = fcntl (wait_child_setup[1], F_GETFD, 0);
1648 if (tem >= 0)
1649 tem = fcntl (wait_child_setup[1], F_SETFD, tem | FD_CLOEXEC);
1650 if (tem < 0)
1652 emacs_close (wait_child_setup[0]);
1653 emacs_close (wait_child_setup[1]);
1654 report_file_error ("Setting file descriptor flags", Qnil);
1657 #endif
1659 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1660 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1662 /* Record this as an active process, with its channels.
1663 As a result, child_setup will close Emacs's side of the pipes. */
1664 chan_process[inchannel] = process;
1665 XPROCESS (process)->infd = inchannel;
1666 XPROCESS (process)->outfd = outchannel;
1668 /* Previously we recorded the tty descriptor used in the subprocess.
1669 It was only used for getting the foreground tty process, so now
1670 we just reopen the device (see emacs_get_tty_pgrp) as this is
1671 more portable (see USG_SUBTTY_WORKS above). */
1673 XPROCESS (process)->pty_flag = pty_flag;
1674 pset_status (XPROCESS (process), Qrun);
1676 FD_SET (inchannel, &input_wait_mask);
1677 FD_SET (inchannel, &non_keyboard_wait_mask);
1678 if (inchannel > max_process_desc)
1679 max_process_desc = inchannel;
1681 /* This may signal an error. */
1682 setup_process_coding_systems (process);
1684 encoded_current_dir = ENCODE_FILE (current_dir);
1686 block_input ();
1687 block_child_signal ();
1689 #ifndef WINDOWSNT
1690 /* vfork, and prevent local vars from being clobbered by the vfork. */
1692 Lisp_Object volatile encoded_current_dir_volatile = encoded_current_dir;
1693 Lisp_Object volatile lisp_pty_name_volatile = lisp_pty_name;
1694 Lisp_Object volatile process_volatile = process;
1695 bool volatile pty_flag_volatile = pty_flag;
1696 char **volatile new_argv_volatile = new_argv;
1697 int volatile forkin_volatile = forkin;
1698 int volatile forkout_volatile = forkout;
1699 int volatile wait_child_setup_0_volatile = wait_child_setup[0];
1700 int volatile wait_child_setup_1_volatile = wait_child_setup[1];
1702 pid = vfork ();
1704 encoded_current_dir = encoded_current_dir_volatile;
1705 lisp_pty_name = lisp_pty_name_volatile;
1706 process = process_volatile;
1707 pty_flag = pty_flag_volatile;
1708 new_argv = new_argv_volatile;
1709 forkin = forkin_volatile;
1710 forkout = forkout_volatile;
1711 wait_child_setup[0] = wait_child_setup_0_volatile;
1712 wait_child_setup[1] = wait_child_setup_1_volatile;
1715 if (pid == 0)
1716 #endif /* not WINDOWSNT */
1718 int xforkin = forkin;
1719 int xforkout = forkout;
1721 /* Make the pty be the controlling terminal of the process. */
1722 #ifdef HAVE_PTYS
1723 /* First, disconnect its current controlling terminal. */
1724 /* We tried doing setsid only if pty_flag, but it caused
1725 process_set_signal to fail on SGI when using a pipe. */
1726 setsid ();
1727 /* Make the pty's terminal the controlling terminal. */
1728 if (pty_flag && xforkin >= 0)
1730 #ifdef TIOCSCTTY
1731 /* We ignore the return value
1732 because faith@cs.unc.edu says that is necessary on Linux. */
1733 ioctl (xforkin, TIOCSCTTY, 0);
1734 #endif
1736 #if defined (LDISC1)
1737 if (pty_flag && xforkin >= 0)
1739 struct termios t;
1740 tcgetattr (xforkin, &t);
1741 t.c_lflag = LDISC1;
1742 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1743 emacs_write (1, "create_process/tcsetattr LDISC1 failed\n", 39);
1745 #else
1746 #if defined (NTTYDISC) && defined (TIOCSETD)
1747 if (pty_flag && xforkin >= 0)
1749 /* Use new line discipline. */
1750 int ldisc = NTTYDISC;
1751 ioctl (xforkin, TIOCSETD, &ldisc);
1753 #endif
1754 #endif
1755 #ifdef TIOCNOTTY
1756 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1757 can do TIOCSPGRP only to the process's controlling tty. */
1758 if (pty_flag)
1760 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1761 I can't test it since I don't have 4.3. */
1762 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1763 if (j >= 0)
1765 ioctl (j, TIOCNOTTY, 0);
1766 emacs_close (j);
1769 #endif /* TIOCNOTTY */
1771 #if !defined (DONT_REOPEN_PTY)
1772 /*** There is a suggestion that this ought to be a
1773 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
1774 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1775 that system does seem to need this code, even though
1776 both TIOCSCTTY is defined. */
1777 /* Now close the pty (if we had it open) and reopen it.
1778 This makes the pty the controlling terminal of the subprocess. */
1779 if (pty_flag)
1782 /* I wonder if emacs_close (emacs_open (pty_name, ...))
1783 would work? */
1784 if (xforkin >= 0)
1785 emacs_close (xforkin);
1786 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
1788 if (xforkin < 0)
1790 emacs_write (1, "Couldn't open the pty terminal ", 31);
1791 emacs_write (1, pty_name, strlen (pty_name));
1792 emacs_write (1, "\n", 1);
1793 _exit (1);
1797 #endif /* not DONT_REOPEN_PTY */
1799 #ifdef SETUP_SLAVE_PTY
1800 if (pty_flag)
1802 SETUP_SLAVE_PTY;
1804 #endif /* SETUP_SLAVE_PTY */
1805 #ifdef AIX
1806 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
1807 Now reenable it in the child, so it will die when we want it to. */
1808 if (pty_flag)
1809 signal (SIGHUP, SIG_DFL);
1810 #endif
1811 #endif /* HAVE_PTYS */
1813 signal (SIGINT, SIG_DFL);
1814 signal (SIGQUIT, SIG_DFL);
1816 /* Emacs ignores SIGPIPE, but the child should not. */
1817 signal (SIGPIPE, SIG_DFL);
1819 /* Stop blocking SIGCHLD in the child. */
1820 unblock_child_signal ();
1822 if (pty_flag)
1823 child_setup_tty (xforkout);
1824 #ifdef WINDOWSNT
1825 pid = child_setup (xforkin, xforkout, xforkout,
1826 new_argv, 1, encoded_current_dir);
1827 #else /* not WINDOWSNT */
1828 emacs_close (wait_child_setup[0]);
1829 child_setup (xforkin, xforkout, xforkout,
1830 new_argv, 1, encoded_current_dir);
1831 #endif /* not WINDOWSNT */
1834 /* Back in the parent process. */
1836 XPROCESS (process)->pid = pid;
1837 if (pid >= 0)
1838 XPROCESS (process)->alive = 1;
1840 /* Stop blocking in the parent. */
1841 unblock_child_signal ();
1842 unblock_input ();
1844 if (pid < 0)
1846 if (forkin >= 0)
1847 emacs_close (forkin);
1848 if (forkin != forkout && forkout >= 0)
1849 emacs_close (forkout);
1851 else
1853 /* vfork succeeded. */
1855 #ifdef WINDOWSNT
1856 register_child (pid, inchannel);
1857 #endif /* WINDOWSNT */
1859 /* If the subfork execv fails, and it exits,
1860 this close hangs. I don't know why.
1861 So have an interrupt jar it loose. */
1863 struct atimer *timer;
1864 EMACS_TIME offset = make_emacs_time (1, 0);
1866 stop_polling ();
1867 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
1869 if (forkin >= 0)
1870 emacs_close (forkin);
1872 cancel_atimer (timer);
1873 start_polling ();
1876 if (forkin != forkout && forkout >= 0)
1877 emacs_close (forkout);
1879 pset_tty_name (XPROCESS (process), lisp_pty_name);
1881 #ifndef WINDOWSNT
1882 /* Wait for child_setup to complete in case that vfork is
1883 actually defined as fork. The descriptor wait_child_setup[1]
1884 of a pipe is closed at the child side either by close-on-exec
1885 on successful execve or the _exit call in child_setup. */
1887 char dummy;
1889 emacs_close (wait_child_setup[1]);
1890 emacs_read (wait_child_setup[0], &dummy, 1);
1891 emacs_close (wait_child_setup[0]);
1893 #endif
1896 /* Now generate the error if vfork failed. */
1897 if (pid < 0)
1898 report_file_error ("Doing vfork", Qnil);
1901 void
1902 create_pty (Lisp_Object process)
1904 int inchannel, outchannel;
1905 bool pty_flag = 0;
1907 inchannel = outchannel = -1;
1909 #ifdef HAVE_PTYS
1910 if (!NILP (Vprocess_connection_type))
1911 outchannel = inchannel = allocate_pty ();
1913 if (inchannel >= 0)
1915 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1916 /* On most USG systems it does not work to open the pty's tty here,
1917 then close it and reopen it in the child. */
1918 /* Don't let this terminal become our controlling terminal
1919 (in case we don't have one). */
1920 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1921 if (forkout < 0)
1922 report_file_error ("Opening pty", Qnil);
1923 #if defined (DONT_REOPEN_PTY)
1924 /* In the case that vfork is defined as fork, the parent process
1925 (Emacs) may send some data before the child process completes
1926 tty options setup. So we setup tty before forking. */
1927 child_setup_tty (forkout);
1928 #endif /* DONT_REOPEN_PTY */
1929 #endif /* not USG, or USG_SUBTTY_WORKS */
1930 pty_flag = 1;
1932 #endif /* HAVE_PTYS */
1934 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1935 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1937 /* Record this as an active process, with its channels.
1938 As a result, child_setup will close Emacs's side of the pipes. */
1939 chan_process[inchannel] = process;
1940 XPROCESS (process)->infd = inchannel;
1941 XPROCESS (process)->outfd = outchannel;
1943 /* Previously we recorded the tty descriptor used in the subprocess.
1944 It was only used for getting the foreground tty process, so now
1945 we just reopen the device (see emacs_get_tty_pgrp) as this is
1946 more portable (see USG_SUBTTY_WORKS above). */
1948 XPROCESS (process)->pty_flag = pty_flag;
1949 pset_status (XPROCESS (process), Qrun);
1950 setup_process_coding_systems (process);
1952 FD_SET (inchannel, &input_wait_mask);
1953 FD_SET (inchannel, &non_keyboard_wait_mask);
1954 if (inchannel > max_process_desc)
1955 max_process_desc = inchannel;
1957 XPROCESS (process)->pid = -2;
1958 #ifdef HAVE_PTYS
1959 if (pty_flag)
1960 pset_tty_name (XPROCESS (process), build_string (pty_name));
1961 else
1962 #endif
1963 pset_tty_name (XPROCESS (process), Qnil);
1967 /* Convert an internal struct sockaddr to a lisp object (vector or string).
1968 The address family of sa is not included in the result. */
1970 static Lisp_Object
1971 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
1973 Lisp_Object address;
1974 int i;
1975 unsigned char *cp;
1976 register struct Lisp_Vector *p;
1978 /* Workaround for a bug in getsockname on BSD: Names bound to
1979 sockets in the UNIX domain are inaccessible; getsockname returns
1980 a zero length name. */
1981 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
1982 return empty_unibyte_string;
1984 switch (sa->sa_family)
1986 case AF_INET:
1988 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
1989 len = sizeof (sin->sin_addr) + 1;
1990 address = Fmake_vector (make_number (len), Qnil);
1991 p = XVECTOR (address);
1992 p->contents[--len] = make_number (ntohs (sin->sin_port));
1993 cp = (unsigned char *) &sin->sin_addr;
1994 break;
1996 #ifdef AF_INET6
1997 case AF_INET6:
1999 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2000 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
2001 len = sizeof (sin6->sin6_addr)/2 + 1;
2002 address = Fmake_vector (make_number (len), Qnil);
2003 p = XVECTOR (address);
2004 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2005 for (i = 0; i < len; i++)
2006 p->contents[i] = make_number (ntohs (ip6[i]));
2007 return address;
2009 #endif
2010 #ifdef HAVE_LOCAL_SOCKETS
2011 case AF_LOCAL:
2013 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2014 for (i = 0; i < sizeof (sockun->sun_path); i++)
2015 if (sockun->sun_path[i] == 0)
2016 break;
2017 return make_unibyte_string (sockun->sun_path, i);
2019 #endif
2020 default:
2021 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2022 address = Fcons (make_number (sa->sa_family),
2023 Fmake_vector (make_number (len), Qnil));
2024 p = XVECTOR (XCDR (address));
2025 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2026 break;
2029 i = 0;
2030 while (i < len)
2031 p->contents[i++] = make_number (*cp++);
2033 return address;
2037 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2039 static int
2040 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2042 register struct Lisp_Vector *p;
2044 if (VECTORP (address))
2046 p = XVECTOR (address);
2047 if (p->header.size == 5)
2049 *familyp = AF_INET;
2050 return sizeof (struct sockaddr_in);
2052 #ifdef AF_INET6
2053 else if (p->header.size == 9)
2055 *familyp = AF_INET6;
2056 return sizeof (struct sockaddr_in6);
2058 #endif
2060 #ifdef HAVE_LOCAL_SOCKETS
2061 else if (STRINGP (address))
2063 *familyp = AF_LOCAL;
2064 return sizeof (struct sockaddr_un);
2066 #endif
2067 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2068 && VECTORP (XCDR (address)))
2070 struct sockaddr *sa;
2071 *familyp = XINT (XCAR (address));
2072 p = XVECTOR (XCDR (address));
2073 return p->header.size + sizeof (sa->sa_family);
2075 return 0;
2078 /* Convert an address object (vector or string) to an internal sockaddr.
2080 The address format has been basically validated by
2081 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2082 it could have come from user data. So if FAMILY is not valid,
2083 we return after zeroing *SA. */
2085 static void
2086 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2088 register struct Lisp_Vector *p;
2089 register unsigned char *cp = NULL;
2090 register int i;
2091 EMACS_INT hostport;
2093 memset (sa, 0, len);
2095 if (VECTORP (address))
2097 p = XVECTOR (address);
2098 if (family == AF_INET)
2100 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2101 len = sizeof (sin->sin_addr) + 1;
2102 hostport = XINT (p->contents[--len]);
2103 sin->sin_port = htons (hostport);
2104 cp = (unsigned char *)&sin->sin_addr;
2105 sa->sa_family = family;
2107 #ifdef AF_INET6
2108 else if (family == AF_INET6)
2110 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2111 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2112 len = sizeof (sin6->sin6_addr) + 1;
2113 hostport = XINT (p->contents[--len]);
2114 sin6->sin6_port = htons (hostport);
2115 for (i = 0; i < len; i++)
2116 if (INTEGERP (p->contents[i]))
2118 int j = XFASTINT (p->contents[i]) & 0xffff;
2119 ip6[i] = ntohs (j);
2121 sa->sa_family = family;
2122 return;
2124 #endif
2125 else
2126 return;
2128 else if (STRINGP (address))
2130 #ifdef HAVE_LOCAL_SOCKETS
2131 if (family == AF_LOCAL)
2133 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2134 cp = SDATA (address);
2135 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2136 sockun->sun_path[i] = *cp++;
2137 sa->sa_family = family;
2139 #endif
2140 return;
2142 else
2144 p = XVECTOR (XCDR (address));
2145 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2148 for (i = 0; i < len; i++)
2149 if (INTEGERP (p->contents[i]))
2150 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2153 #ifdef DATAGRAM_SOCKETS
2154 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2155 1, 1, 0,
2156 doc: /* Get the current datagram address associated with PROCESS. */)
2157 (Lisp_Object process)
2159 int channel;
2161 CHECK_PROCESS (process);
2163 if (!DATAGRAM_CONN_P (process))
2164 return Qnil;
2166 channel = XPROCESS (process)->infd;
2167 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2168 datagram_address[channel].len);
2171 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2172 2, 2, 0,
2173 doc: /* Set the datagram address for PROCESS to ADDRESS.
2174 Returns nil upon error setting address, ADDRESS otherwise. */)
2175 (Lisp_Object process, Lisp_Object address)
2177 int channel;
2178 int family, len;
2180 CHECK_PROCESS (process);
2182 if (!DATAGRAM_CONN_P (process))
2183 return Qnil;
2185 channel = XPROCESS (process)->infd;
2187 len = get_lisp_to_sockaddr_size (address, &family);
2188 if (len == 0 || datagram_address[channel].len != len)
2189 return Qnil;
2190 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2191 return address;
2193 #endif
2196 static const struct socket_options {
2197 /* The name of this option. Should be lowercase version of option
2198 name without SO_ prefix. */
2199 const char *name;
2200 /* Option level SOL_... */
2201 int optlevel;
2202 /* Option number SO_... */
2203 int optnum;
2204 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2205 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2206 } socket_options[] =
2208 #ifdef SO_BINDTODEVICE
2209 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2210 #endif
2211 #ifdef SO_BROADCAST
2212 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2213 #endif
2214 #ifdef SO_DONTROUTE
2215 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2216 #endif
2217 #ifdef SO_KEEPALIVE
2218 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2219 #endif
2220 #ifdef SO_LINGER
2221 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2222 #endif
2223 #ifdef SO_OOBINLINE
2224 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2225 #endif
2226 #ifdef SO_PRIORITY
2227 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2228 #endif
2229 #ifdef SO_REUSEADDR
2230 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2231 #endif
2232 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2235 /* Set option OPT to value VAL on socket S.
2237 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2238 Signals an error if setting a known option fails.
2241 static int
2242 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2244 char *name;
2245 const struct socket_options *sopt;
2246 int ret = 0;
2248 CHECK_SYMBOL (opt);
2250 name = SSDATA (SYMBOL_NAME (opt));
2251 for (sopt = socket_options; sopt->name; sopt++)
2252 if (strcmp (name, sopt->name) == 0)
2253 break;
2255 switch (sopt->opttype)
2257 case SOPT_BOOL:
2259 int optval;
2260 optval = NILP (val) ? 0 : 1;
2261 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2262 &optval, sizeof (optval));
2263 break;
2266 case SOPT_INT:
2268 int optval;
2269 if (TYPE_RANGED_INTEGERP (int, val))
2270 optval = XINT (val);
2271 else
2272 error ("Bad option value for %s", name);
2273 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2274 &optval, sizeof (optval));
2275 break;
2278 #ifdef SO_BINDTODEVICE
2279 case SOPT_IFNAME:
2281 char devname[IFNAMSIZ+1];
2283 /* This is broken, at least in the Linux 2.4 kernel.
2284 To unbind, the arg must be a zero integer, not the empty string.
2285 This should work on all systems. KFS. 2003-09-23. */
2286 memset (devname, 0, sizeof devname);
2287 if (STRINGP (val))
2289 char *arg = SSDATA (val);
2290 int len = min (strlen (arg), IFNAMSIZ);
2291 memcpy (devname, arg, len);
2293 else if (!NILP (val))
2294 error ("Bad option value for %s", name);
2295 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2296 devname, IFNAMSIZ);
2297 break;
2299 #endif
2301 #ifdef SO_LINGER
2302 case SOPT_LINGER:
2304 struct linger linger;
2306 linger.l_onoff = 1;
2307 linger.l_linger = 0;
2308 if (TYPE_RANGED_INTEGERP (int, val))
2309 linger.l_linger = XINT (val);
2310 else
2311 linger.l_onoff = NILP (val) ? 0 : 1;
2312 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2313 &linger, sizeof (linger));
2314 break;
2316 #endif
2318 default:
2319 return 0;
2322 if (ret < 0)
2323 report_file_error ("Cannot set network option",
2324 Fcons (opt, Fcons (val, Qnil)));
2325 return (1 << sopt->optbit);
2329 DEFUN ("set-network-process-option",
2330 Fset_network_process_option, Sset_network_process_option,
2331 3, 4, 0,
2332 doc: /* For network process PROCESS set option OPTION to value VALUE.
2333 See `make-network-process' for a list of options and values.
2334 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2335 OPTION is not a supported option, return nil instead; otherwise return t. */)
2336 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2338 int s;
2339 struct Lisp_Process *p;
2341 CHECK_PROCESS (process);
2342 p = XPROCESS (process);
2343 if (!NETCONN1_P (p))
2344 error ("Process is not a network process");
2346 s = p->infd;
2347 if (s < 0)
2348 error ("Process is not running");
2350 if (set_socket_option (s, option, value))
2352 pset_childp (p, Fplist_put (p->childp, option, value));
2353 return Qt;
2356 if (NILP (no_error))
2357 error ("Unknown or unsupported option");
2359 return Qnil;
2363 DEFUN ("serial-process-configure",
2364 Fserial_process_configure,
2365 Sserial_process_configure,
2366 0, MANY, 0,
2367 doc: /* Configure speed, bytesize, etc. of a serial process.
2369 Arguments are specified as keyword/argument pairs. Attributes that
2370 are not given are re-initialized from the process's current
2371 configuration (available via the function `process-contact') or set to
2372 reasonable default values. The following arguments are defined:
2374 :process PROCESS
2375 :name NAME
2376 :buffer BUFFER
2377 :port PORT
2378 -- Any of these arguments can be given to identify the process that is
2379 to be configured. If none of these arguments is given, the current
2380 buffer's process is used.
2382 :speed SPEED -- SPEED is the speed of the serial port in bits per
2383 second, also called baud rate. Any value can be given for SPEED, but
2384 most serial ports work only at a few defined values between 1200 and
2385 115200, with 9600 being the most common value. If SPEED is nil, the
2386 serial port is not configured any further, i.e., all other arguments
2387 are ignored. This may be useful for special serial ports such as
2388 Bluetooth-to-serial converters which can only be configured through AT
2389 commands. A value of nil for SPEED can be used only when passed
2390 through `make-serial-process' or `serial-term'.
2392 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2393 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2395 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2396 `odd' (use odd parity), or the symbol `even' (use even parity). If
2397 PARITY is not given, no parity is used.
2399 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2400 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2401 is not given or nil, 1 stopbit is used.
2403 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2404 flowcontrol to be used, which is either nil (don't use flowcontrol),
2405 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2406 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2407 flowcontrol is used.
2409 `serial-process-configure' is called by `make-serial-process' for the
2410 initial configuration of the serial port.
2412 Examples:
2414 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2416 \(serial-process-configure
2417 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2419 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2421 usage: (serial-process-configure &rest ARGS) */)
2422 (ptrdiff_t nargs, Lisp_Object *args)
2424 struct Lisp_Process *p;
2425 Lisp_Object contact = Qnil;
2426 Lisp_Object proc = Qnil;
2427 struct gcpro gcpro1;
2429 contact = Flist (nargs, args);
2430 GCPRO1 (contact);
2432 proc = Fplist_get (contact, QCprocess);
2433 if (NILP (proc))
2434 proc = Fplist_get (contact, QCname);
2435 if (NILP (proc))
2436 proc = Fplist_get (contact, QCbuffer);
2437 if (NILP (proc))
2438 proc = Fplist_get (contact, QCport);
2439 proc = get_process (proc);
2440 p = XPROCESS (proc);
2441 if (!EQ (p->type, Qserial))
2442 error ("Not a serial process");
2444 if (NILP (Fplist_get (p->childp, QCspeed)))
2446 UNGCPRO;
2447 return Qnil;
2450 serial_configure (p, contact);
2452 UNGCPRO;
2453 return Qnil;
2456 /* Used by make-serial-process to recover from errors. */
2457 static Lisp_Object
2458 make_serial_process_unwind (Lisp_Object proc)
2460 if (!PROCESSP (proc))
2461 emacs_abort ();
2462 remove_process (proc);
2463 return Qnil;
2466 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2467 0, MANY, 0,
2468 doc: /* Create and return a serial port process.
2470 In Emacs, serial port connections are represented by process objects,
2471 so input and output work as for subprocesses, and `delete-process'
2472 closes a serial port connection. However, a serial process has no
2473 process id, it cannot be signaled, and the status codes are different
2474 from normal processes.
2476 `make-serial-process' creates a process and a buffer, on which you
2477 probably want to use `process-send-string'. Try \\[serial-term] for
2478 an interactive terminal. See below for examples.
2480 Arguments are specified as keyword/argument pairs. The following
2481 arguments are defined:
2483 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2484 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2485 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2486 the backslashes in strings).
2488 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2489 which this function calls.
2491 :name NAME -- NAME is the name of the process. If NAME is not given,
2492 the value of PORT is used.
2494 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2495 with the process. Process output goes at the end of that buffer,
2496 unless you specify an output stream or filter function to handle the
2497 output. If BUFFER is not given, the value of NAME is used.
2499 :coding CODING -- If CODING is a symbol, it specifies the coding
2500 system used for both reading and writing for this process. If CODING
2501 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2502 ENCODING is used for writing.
2504 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2505 the process is running. If BOOL is not given, query before exiting.
2507 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2508 In the stopped state, a serial process does not accept incoming data,
2509 but you can send outgoing data. The stopped state is cleared by
2510 `continue-process' and set by `stop-process'.
2512 :filter FILTER -- Install FILTER as the process filter.
2514 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2516 :plist PLIST -- Install PLIST as the initial plist of the process.
2518 :bytesize
2519 :parity
2520 :stopbits
2521 :flowcontrol
2522 -- This function calls `serial-process-configure' to handle these
2523 arguments.
2525 The original argument list, possibly modified by later configuration,
2526 is available via the function `process-contact'.
2528 Examples:
2530 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2532 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2534 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2536 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2538 usage: (make-serial-process &rest ARGS) */)
2539 (ptrdiff_t nargs, Lisp_Object *args)
2541 int fd = -1;
2542 Lisp_Object proc, contact, port;
2543 struct Lisp_Process *p;
2544 struct gcpro gcpro1;
2545 Lisp_Object name, buffer;
2546 Lisp_Object tem, val;
2547 ptrdiff_t specpdl_count;
2549 if (nargs == 0)
2550 return Qnil;
2552 contact = Flist (nargs, args);
2553 GCPRO1 (contact);
2555 port = Fplist_get (contact, QCport);
2556 if (NILP (port))
2557 error ("No port specified");
2558 CHECK_STRING (port);
2560 if (NILP (Fplist_member (contact, QCspeed)))
2561 error (":speed not specified");
2562 if (!NILP (Fplist_get (contact, QCspeed)))
2563 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2565 name = Fplist_get (contact, QCname);
2566 if (NILP (name))
2567 name = port;
2568 CHECK_STRING (name);
2569 proc = make_process (name);
2570 specpdl_count = SPECPDL_INDEX ();
2571 record_unwind_protect (make_serial_process_unwind, proc);
2572 p = XPROCESS (proc);
2574 fd = serial_open (SSDATA (port));
2575 p->infd = fd;
2576 p->outfd = fd;
2577 if (fd > max_process_desc)
2578 max_process_desc = fd;
2579 chan_process[fd] = proc;
2581 buffer = Fplist_get (contact, QCbuffer);
2582 if (NILP (buffer))
2583 buffer = name;
2584 buffer = Fget_buffer_create (buffer);
2585 pset_buffer (p, buffer);
2587 pset_childp (p, contact);
2588 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2589 pset_type (p, Qserial);
2590 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2591 pset_filter (p, Fplist_get (contact, QCfilter));
2592 pset_log (p, Qnil);
2593 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2594 p->kill_without_query = 1;
2595 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2596 pset_command (p, Qt);
2597 p->pty_flag = 0;
2599 if (!EQ (p->command, Qt))
2601 FD_SET (fd, &input_wait_mask);
2602 FD_SET (fd, &non_keyboard_wait_mask);
2605 if (BUFFERP (buffer))
2607 set_marker_both (p->mark, buffer,
2608 BUF_ZV (XBUFFER (buffer)),
2609 BUF_ZV_BYTE (XBUFFER (buffer)));
2612 tem = Fplist_member (contact, QCcoding);
2613 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2614 tem = Qnil;
2616 val = Qnil;
2617 if (!NILP (tem))
2619 val = XCAR (XCDR (tem));
2620 if (CONSP (val))
2621 val = XCAR (val);
2623 else if (!NILP (Vcoding_system_for_read))
2624 val = Vcoding_system_for_read;
2625 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2626 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2627 val = Qnil;
2628 pset_decode_coding_system (p, val);
2630 val = Qnil;
2631 if (!NILP (tem))
2633 val = XCAR (XCDR (tem));
2634 if (CONSP (val))
2635 val = XCDR (val);
2637 else if (!NILP (Vcoding_system_for_write))
2638 val = Vcoding_system_for_write;
2639 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2640 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2641 val = Qnil;
2642 pset_encode_coding_system (p, val);
2644 setup_process_coding_systems (proc);
2645 pset_decoding_buf (p, empty_unibyte_string);
2646 p->decoding_carryover = 0;
2647 pset_encoding_buf (p, empty_unibyte_string);
2648 p->inherit_coding_system_flag
2649 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2651 Fserial_process_configure (nargs, args);
2653 specpdl_ptr = specpdl + specpdl_count;
2655 UNGCPRO;
2656 return proc;
2659 /* Create a network stream/datagram client/server process. Treated
2660 exactly like a normal process when reading and writing. Primary
2661 differences are in status display and process deletion. A network
2662 connection has no PID; you cannot signal it. All you can do is
2663 stop/continue it and deactivate/close it via delete-process */
2665 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2666 0, MANY, 0,
2667 doc: /* Create and return a network server or client process.
2669 In Emacs, network connections are represented by process objects, so
2670 input and output work as for subprocesses and `delete-process' closes
2671 a network connection. However, a network process has no process id,
2672 it cannot be signaled, and the status codes are different from normal
2673 processes.
2675 Arguments are specified as keyword/argument pairs. The following
2676 arguments are defined:
2678 :name NAME -- NAME is name for process. It is modified if necessary
2679 to make it unique.
2681 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2682 with the process. Process output goes at end of that buffer, unless
2683 you specify an output stream or filter function to handle the output.
2684 BUFFER may be also nil, meaning that this process is not associated
2685 with any buffer.
2687 :host HOST -- HOST is name of the host to connect to, or its IP
2688 address. The symbol `local' specifies the local host. If specified
2689 for a server process, it must be a valid name or address for the local
2690 host, and only clients connecting to that address will be accepted.
2692 :service SERVICE -- SERVICE is name of the service desired, or an
2693 integer specifying a port number to connect to. If SERVICE is t,
2694 a random port number is selected for the server. (If Emacs was
2695 compiled with getaddrinfo, a port number can also be specified as a
2696 string, e.g. "80", as well as an integer. This is not portable.)
2698 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2699 stream type connection, `datagram' creates a datagram type connection,
2700 `seqpacket' creates a reliable datagram connection.
2702 :family FAMILY -- FAMILY is the address (and protocol) family for the
2703 service specified by HOST and SERVICE. The default (nil) is to use
2704 whatever address family (IPv4 or IPv6) that is defined for the host
2705 and port number specified by HOST and SERVICE. Other address families
2706 supported are:
2707 local -- for a local (i.e. UNIX) address specified by SERVICE.
2708 ipv4 -- use IPv4 address family only.
2709 ipv6 -- use IPv6 address family only.
2711 :local ADDRESS -- ADDRESS is the local address used for the connection.
2712 This parameter is ignored when opening a client process. When specified
2713 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2715 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2716 connection. This parameter is ignored when opening a stream server
2717 process. For a datagram server process, it specifies the initial
2718 setting of the remote datagram address. When specified for a client
2719 process, the FAMILY, HOST, and SERVICE args are ignored.
2721 The format of ADDRESS depends on the address family:
2722 - An IPv4 address is represented as an vector of integers [A B C D P]
2723 corresponding to numeric IP address A.B.C.D and port number P.
2724 - A local address is represented as a string with the address in the
2725 local address space.
2726 - An "unsupported family" address is represented by a cons (F . AV)
2727 where F is the family number and AV is a vector containing the socket
2728 address data with one element per address data byte. Do not rely on
2729 this format in portable code, as it may depend on implementation
2730 defined constants, data sizes, and data structure alignment.
2732 :coding CODING -- If CODING is a symbol, it specifies the coding
2733 system used for both reading and writing for this process. If CODING
2734 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2735 ENCODING is used for writing.
2737 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2738 return without waiting for the connection to complete; instead, the
2739 sentinel function will be called with second arg matching "open" (if
2740 successful) or "failed" when the connect completes. Default is to use
2741 a blocking connect (i.e. wait) for stream type connections.
2743 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2744 running when Emacs is exited.
2746 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2747 In the stopped state, a server process does not accept new
2748 connections, and a client process does not handle incoming traffic.
2749 The stopped state is cleared by `continue-process' and set by
2750 `stop-process'.
2752 :filter FILTER -- Install FILTER as the process filter.
2754 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2755 process filter are multibyte, otherwise they are unibyte.
2756 If this keyword is not specified, the strings are multibyte if
2757 the default value of `enable-multibyte-characters' is non-nil.
2759 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2761 :log LOG -- Install LOG as the server process log function. This
2762 function is called when the server accepts a network connection from a
2763 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2764 is the server process, CLIENT is the new process for the connection,
2765 and MESSAGE is a string.
2767 :plist PLIST -- Install PLIST as the new process' initial plist.
2769 :server QLEN -- if QLEN is non-nil, create a server process for the
2770 specified FAMILY, SERVICE, and connection type (stream or datagram).
2771 If QLEN is an integer, it is used as the max. length of the server's
2772 pending connection queue (also known as the backlog); the default
2773 queue length is 5. Default is to create a client process.
2775 The following network options can be specified for this connection:
2777 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2778 :dontroute BOOL -- Only send to directly connected hosts.
2779 :keepalive BOOL -- Send keep-alive messages on network stream.
2780 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2781 :oobinline BOOL -- Place out-of-band data in receive data stream.
2782 :priority INT -- Set protocol defined priority for sent packets.
2783 :reuseaddr BOOL -- Allow reusing a recently used local address
2784 (this is allowed by default for a server process).
2785 :bindtodevice NAME -- bind to interface NAME. Using this may require
2786 special privileges on some systems.
2788 Consult the relevant system programmer's manual pages for more
2789 information on using these options.
2792 A server process will listen for and accept connections from clients.
2793 When a client connection is accepted, a new network process is created
2794 for the connection with the following parameters:
2796 - The client's process name is constructed by concatenating the server
2797 process' NAME and a client identification string.
2798 - If the FILTER argument is non-nil, the client process will not get a
2799 separate process buffer; otherwise, the client's process buffer is a newly
2800 created buffer named after the server process' BUFFER name or process
2801 NAME concatenated with the client identification string.
2802 - The connection type and the process filter and sentinel parameters are
2803 inherited from the server process' TYPE, FILTER and SENTINEL.
2804 - The client process' contact info is set according to the client's
2805 addressing information (typically an IP address and a port number).
2806 - The client process' plist is initialized from the server's plist.
2808 Notice that the FILTER and SENTINEL args are never used directly by
2809 the server process. Also, the BUFFER argument is not used directly by
2810 the server process, but via the optional :log function, accepted (and
2811 failed) connections may be logged in the server process' buffer.
2813 The original argument list, modified with the actual connection
2814 information, is available via the `process-contact' function.
2816 usage: (make-network-process &rest ARGS) */)
2817 (ptrdiff_t nargs, Lisp_Object *args)
2819 Lisp_Object proc;
2820 Lisp_Object contact;
2821 struct Lisp_Process *p;
2822 #ifdef HAVE_GETADDRINFO
2823 struct addrinfo ai, *res, *lres;
2824 struct addrinfo hints;
2825 const char *portstring;
2826 char portbuf[128];
2827 #else /* HAVE_GETADDRINFO */
2828 struct _emacs_addrinfo
2830 int ai_family;
2831 int ai_socktype;
2832 int ai_protocol;
2833 int ai_addrlen;
2834 struct sockaddr *ai_addr;
2835 struct _emacs_addrinfo *ai_next;
2836 } ai, *res, *lres;
2837 #endif /* HAVE_GETADDRINFO */
2838 struct sockaddr_in address_in;
2839 #ifdef HAVE_LOCAL_SOCKETS
2840 struct sockaddr_un address_un;
2841 #endif
2842 int port;
2843 int ret = 0;
2844 int xerrno = 0;
2845 int s = -1, outch, inch;
2846 struct gcpro gcpro1;
2847 ptrdiff_t count = SPECPDL_INDEX ();
2848 ptrdiff_t count1;
2849 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2850 Lisp_Object tem;
2851 Lisp_Object name, buffer, host, service, address;
2852 Lisp_Object filter, sentinel;
2853 bool is_non_blocking_client = 0;
2854 bool is_server = 0;
2855 int backlog = 5;
2856 int socktype;
2857 int family = -1;
2859 if (nargs == 0)
2860 return Qnil;
2862 /* Save arguments for process-contact and clone-process. */
2863 contact = Flist (nargs, args);
2864 GCPRO1 (contact);
2866 #ifdef WINDOWSNT
2867 /* Ensure socket support is loaded if available. */
2868 init_winsock (TRUE);
2869 #endif
2871 /* :type TYPE (nil: stream, datagram */
2872 tem = Fplist_get (contact, QCtype);
2873 if (NILP (tem))
2874 socktype = SOCK_STREAM;
2875 #ifdef DATAGRAM_SOCKETS
2876 else if (EQ (tem, Qdatagram))
2877 socktype = SOCK_DGRAM;
2878 #endif
2879 #ifdef HAVE_SEQPACKET
2880 else if (EQ (tem, Qseqpacket))
2881 socktype = SOCK_SEQPACKET;
2882 #endif
2883 else
2884 error ("Unsupported connection type");
2886 /* :server BOOL */
2887 tem = Fplist_get (contact, QCserver);
2888 if (!NILP (tem))
2890 /* Don't support network sockets when non-blocking mode is
2891 not available, since a blocked Emacs is not useful. */
2892 is_server = 1;
2893 if (TYPE_RANGED_INTEGERP (int, tem))
2894 backlog = XINT (tem);
2897 /* Make QCaddress an alias for :local (server) or :remote (client). */
2898 QCaddress = is_server ? QClocal : QCremote;
2900 /* :nowait BOOL */
2901 if (!is_server && socktype != SOCK_DGRAM
2902 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2904 #ifndef NON_BLOCKING_CONNECT
2905 error ("Non-blocking connect not supported");
2906 #else
2907 is_non_blocking_client = 1;
2908 #endif
2911 name = Fplist_get (contact, QCname);
2912 buffer = Fplist_get (contact, QCbuffer);
2913 filter = Fplist_get (contact, QCfilter);
2914 sentinel = Fplist_get (contact, QCsentinel);
2916 CHECK_STRING (name);
2918 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2919 ai.ai_socktype = socktype;
2920 ai.ai_protocol = 0;
2921 ai.ai_next = NULL;
2922 res = &ai;
2924 /* :local ADDRESS or :remote ADDRESS */
2925 address = Fplist_get (contact, QCaddress);
2926 if (!NILP (address))
2928 host = service = Qnil;
2930 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2931 error ("Malformed :address");
2932 ai.ai_family = family;
2933 ai.ai_addr = alloca (ai.ai_addrlen);
2934 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2935 goto open_socket;
2938 /* :family FAMILY -- nil (for Inet), local, or integer. */
2939 tem = Fplist_get (contact, QCfamily);
2940 if (NILP (tem))
2942 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
2943 family = AF_UNSPEC;
2944 #else
2945 family = AF_INET;
2946 #endif
2948 #ifdef HAVE_LOCAL_SOCKETS
2949 else if (EQ (tem, Qlocal))
2950 family = AF_LOCAL;
2951 #endif
2952 #ifdef AF_INET6
2953 else if (EQ (tem, Qipv6))
2954 family = AF_INET6;
2955 #endif
2956 else if (EQ (tem, Qipv4))
2957 family = AF_INET;
2958 else if (TYPE_RANGED_INTEGERP (int, tem))
2959 family = XINT (tem);
2960 else
2961 error ("Unknown address family");
2963 ai.ai_family = family;
2965 /* :service SERVICE -- string, integer (port number), or t (random port). */
2966 service = Fplist_get (contact, QCservice);
2968 /* :host HOST -- hostname, ip address, or 'local for localhost. */
2969 host = Fplist_get (contact, QChost);
2970 if (!NILP (host))
2972 if (EQ (host, Qlocal))
2973 /* Depending on setup, "localhost" may map to different IPv4 and/or
2974 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
2975 host = build_string ("127.0.0.1");
2976 CHECK_STRING (host);
2979 #ifdef HAVE_LOCAL_SOCKETS
2980 if (family == AF_LOCAL)
2982 if (!NILP (host))
2984 message (":family local ignores the :host \"%s\" property",
2985 SDATA (host));
2986 contact = Fplist_put (contact, QChost, Qnil);
2987 host = Qnil;
2989 CHECK_STRING (service);
2990 memset (&address_un, 0, sizeof address_un);
2991 address_un.sun_family = AF_LOCAL;
2992 if (sizeof address_un.sun_path <= SBYTES (service))
2993 error ("Service name too long");
2994 strcpy (address_un.sun_path, SSDATA (service));
2995 ai.ai_addr = (struct sockaddr *) &address_un;
2996 ai.ai_addrlen = sizeof address_un;
2997 goto open_socket;
2999 #endif
3001 /* Slow down polling to every ten seconds.
3002 Some kernels have a bug which causes retrying connect to fail
3003 after a connect. Polling can interfere with gethostbyname too. */
3004 #ifdef POLL_FOR_INPUT
3005 if (socktype != SOCK_DGRAM)
3007 record_unwind_protect (unwind_stop_other_atimers, Qnil);
3008 bind_polling_period (10);
3010 #endif
3012 #ifdef HAVE_GETADDRINFO
3013 /* If we have a host, use getaddrinfo to resolve both host and service.
3014 Otherwise, use getservbyname to lookup the service. */
3015 if (!NILP (host))
3018 /* SERVICE can either be a string or int.
3019 Convert to a C string for later use by getaddrinfo. */
3020 if (EQ (service, Qt))
3021 portstring = "0";
3022 else if (INTEGERP (service))
3024 sprintf (portbuf, "%"pI"d", XINT (service));
3025 portstring = portbuf;
3027 else
3029 CHECK_STRING (service);
3030 portstring = SSDATA (service);
3033 immediate_quit = 1;
3034 QUIT;
3035 memset (&hints, 0, sizeof (hints));
3036 hints.ai_flags = 0;
3037 hints.ai_family = family;
3038 hints.ai_socktype = socktype;
3039 hints.ai_protocol = 0;
3041 #ifdef HAVE_RES_INIT
3042 res_init ();
3043 #endif
3045 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3046 if (ret)
3047 #ifdef HAVE_GAI_STRERROR
3048 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3049 #else
3050 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3051 #endif
3052 immediate_quit = 0;
3054 goto open_socket;
3056 #endif /* HAVE_GETADDRINFO */
3058 /* We end up here if getaddrinfo is not defined, or in case no hostname
3059 has been specified (e.g. for a local server process). */
3061 if (EQ (service, Qt))
3062 port = 0;
3063 else if (INTEGERP (service))
3064 port = htons ((unsigned short) XINT (service));
3065 else
3067 struct servent *svc_info;
3068 CHECK_STRING (service);
3069 svc_info = getservbyname (SSDATA (service),
3070 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3071 if (svc_info == 0)
3072 error ("Unknown service: %s", SDATA (service));
3073 port = svc_info->s_port;
3076 memset (&address_in, 0, sizeof address_in);
3077 address_in.sin_family = family;
3078 address_in.sin_addr.s_addr = INADDR_ANY;
3079 address_in.sin_port = port;
3081 #ifndef HAVE_GETADDRINFO
3082 if (!NILP (host))
3084 struct hostent *host_info_ptr;
3086 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3087 as it may `hang' Emacs for a very long time. */
3088 immediate_quit = 1;
3089 QUIT;
3091 #ifdef HAVE_RES_INIT
3092 res_init ();
3093 #endif
3095 host_info_ptr = gethostbyname (SDATA (host));
3096 immediate_quit = 0;
3098 if (host_info_ptr)
3100 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3101 host_info_ptr->h_length);
3102 family = host_info_ptr->h_addrtype;
3103 address_in.sin_family = family;
3105 else
3106 /* Attempt to interpret host as numeric inet address */
3108 unsigned long numeric_addr;
3109 numeric_addr = inet_addr (SSDATA (host));
3110 if (numeric_addr == -1)
3111 error ("Unknown host \"%s\"", SDATA (host));
3113 memcpy (&address_in.sin_addr, &numeric_addr,
3114 sizeof (address_in.sin_addr));
3118 #endif /* not HAVE_GETADDRINFO */
3120 ai.ai_family = family;
3121 ai.ai_addr = (struct sockaddr *) &address_in;
3122 ai.ai_addrlen = sizeof address_in;
3124 open_socket:
3126 /* Do this in case we never enter the for-loop below. */
3127 count1 = SPECPDL_INDEX ();
3128 s = -1;
3130 for (lres = res; lres; lres = lres->ai_next)
3132 ptrdiff_t optn;
3133 int optbits;
3135 #ifdef WINDOWSNT
3136 retry_connect:
3137 #endif
3139 s = socket (lres->ai_family, lres->ai_socktype, lres->ai_protocol);
3140 if (s < 0)
3142 xerrno = errno;
3143 continue;
3146 #ifdef DATAGRAM_SOCKETS
3147 if (!is_server && socktype == SOCK_DGRAM)
3148 break;
3149 #endif /* DATAGRAM_SOCKETS */
3151 #ifdef NON_BLOCKING_CONNECT
3152 if (is_non_blocking_client)
3154 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3155 if (ret < 0)
3157 xerrno = errno;
3158 emacs_close (s);
3159 s = -1;
3160 continue;
3163 #endif
3165 /* Make us close S if quit. */
3166 record_unwind_protect (close_file_unwind, make_number (s));
3168 /* Parse network options in the arg list.
3169 We simply ignore anything which isn't a known option (including other keywords).
3170 An error is signaled if setting a known option fails. */
3171 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3172 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3174 if (is_server)
3176 /* Configure as a server socket. */
3178 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3179 explicit :reuseaddr key to override this. */
3180 #ifdef HAVE_LOCAL_SOCKETS
3181 if (family != AF_LOCAL)
3182 #endif
3183 if (!(optbits & (1 << OPIX_REUSEADDR)))
3185 int optval = 1;
3186 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3187 report_file_error ("Cannot set reuse option on server socket", Qnil);
3190 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3191 report_file_error ("Cannot bind server socket", Qnil);
3193 #ifdef HAVE_GETSOCKNAME
3194 if (EQ (service, Qt))
3196 struct sockaddr_in sa1;
3197 socklen_t len1 = sizeof (sa1);
3198 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3200 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3201 service = make_number (ntohs (sa1.sin_port));
3202 contact = Fplist_put (contact, QCservice, service);
3205 #endif
3207 if (socktype != SOCK_DGRAM && listen (s, backlog))
3208 report_file_error ("Cannot listen on server socket", Qnil);
3210 break;
3213 immediate_quit = 1;
3214 QUIT;
3216 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3217 xerrno = errno;
3219 if (ret == 0 || xerrno == EISCONN)
3221 /* The unwind-protect will be discarded afterwards.
3222 Likewise for immediate_quit. */
3223 break;
3226 #ifdef NON_BLOCKING_CONNECT
3227 #ifdef EINPROGRESS
3228 if (is_non_blocking_client && xerrno == EINPROGRESS)
3229 break;
3230 #else
3231 #ifdef EWOULDBLOCK
3232 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3233 break;
3234 #endif
3235 #endif
3236 #endif
3238 #ifndef WINDOWSNT
3239 if (xerrno == EINTR)
3241 /* Unlike most other syscalls connect() cannot be called
3242 again. (That would return EALREADY.) The proper way to
3243 wait for completion is pselect(). */
3244 int sc;
3245 socklen_t len;
3246 SELECT_TYPE fdset;
3247 retry_select:
3248 FD_ZERO (&fdset);
3249 FD_SET (s, &fdset);
3250 QUIT;
3251 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3252 if (sc == -1)
3254 if (errno == EINTR)
3255 goto retry_select;
3256 else
3257 report_file_error ("select failed", Qnil);
3259 eassert (sc > 0);
3261 len = sizeof xerrno;
3262 eassert (FD_ISSET (s, &fdset));
3263 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) == -1)
3264 report_file_error ("getsockopt failed", Qnil);
3265 if (xerrno)
3266 errno = xerrno, report_file_error ("error during connect", Qnil);
3267 else
3268 break;
3270 #endif /* !WINDOWSNT */
3272 immediate_quit = 0;
3274 /* Discard the unwind protect closing S. */
3275 specpdl_ptr = specpdl + count1;
3276 emacs_close (s);
3277 s = -1;
3279 #ifdef WINDOWSNT
3280 if (xerrno == EINTR)
3281 goto retry_connect;
3282 #endif
3285 if (s >= 0)
3287 #ifdef DATAGRAM_SOCKETS
3288 if (socktype == SOCK_DGRAM)
3290 if (datagram_address[s].sa)
3291 emacs_abort ();
3292 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3293 datagram_address[s].len = lres->ai_addrlen;
3294 if (is_server)
3296 Lisp_Object remote;
3297 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3298 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3300 int rfamily, rlen;
3301 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3302 if (rlen != 0 && rfamily == lres->ai_family
3303 && rlen == lres->ai_addrlen)
3304 conv_lisp_to_sockaddr (rfamily, remote,
3305 datagram_address[s].sa, rlen);
3308 else
3309 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3311 #endif
3312 contact = Fplist_put (contact, QCaddress,
3313 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3314 #ifdef HAVE_GETSOCKNAME
3315 if (!is_server)
3317 struct sockaddr_in sa1;
3318 socklen_t len1 = sizeof (sa1);
3319 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3320 contact = Fplist_put (contact, QClocal,
3321 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3323 #endif
3326 immediate_quit = 0;
3328 #ifdef HAVE_GETADDRINFO
3329 if (res != &ai)
3331 block_input ();
3332 freeaddrinfo (res);
3333 unblock_input ();
3335 #endif
3337 /* Discard the unwind protect for closing S, if any. */
3338 specpdl_ptr = specpdl + count1;
3340 /* Unwind bind_polling_period and request_sigio. */
3341 unbind_to (count, Qnil);
3343 if (s < 0)
3345 /* If non-blocking got this far - and failed - assume non-blocking is
3346 not supported after all. This is probably a wrong assumption, but
3347 the normal blocking calls to open-network-stream handles this error
3348 better. */
3349 if (is_non_blocking_client)
3350 return Qnil;
3352 errno = xerrno;
3353 if (is_server)
3354 report_file_error ("make server process failed", contact);
3355 else
3356 report_file_error ("make client process failed", contact);
3359 inch = s;
3360 outch = s;
3362 if (!NILP (buffer))
3363 buffer = Fget_buffer_create (buffer);
3364 proc = make_process (name);
3366 chan_process[inch] = proc;
3368 fcntl (inch, F_SETFL, O_NONBLOCK);
3370 p = XPROCESS (proc);
3372 pset_childp (p, contact);
3373 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3374 pset_type (p, Qnetwork);
3376 pset_buffer (p, buffer);
3377 pset_sentinel (p, sentinel);
3378 pset_filter (p, filter);
3379 pset_log (p, Fplist_get (contact, QClog));
3380 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3381 p->kill_without_query = 1;
3382 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3383 pset_command (p, Qt);
3384 p->pid = 0;
3385 p->infd = inch;
3386 p->outfd = outch;
3387 if (is_server && socktype != SOCK_DGRAM)
3388 pset_status (p, Qlisten);
3390 /* Make the process marker point into the process buffer (if any). */
3391 if (BUFFERP (buffer))
3392 set_marker_both (p->mark, buffer,
3393 BUF_ZV (XBUFFER (buffer)),
3394 BUF_ZV_BYTE (XBUFFER (buffer)));
3396 #ifdef NON_BLOCKING_CONNECT
3397 if (is_non_blocking_client)
3399 /* We may get here if connect did succeed immediately. However,
3400 in that case, we still need to signal this like a non-blocking
3401 connection. */
3402 pset_status (p, Qconnect);
3403 if (!FD_ISSET (inch, &connect_wait_mask))
3405 FD_SET (inch, &connect_wait_mask);
3406 FD_SET (inch, &write_mask);
3407 num_pending_connects++;
3410 else
3411 #endif
3412 /* A server may have a client filter setting of Qt, but it must
3413 still listen for incoming connects unless it is stopped. */
3414 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3415 || (EQ (p->status, Qlisten) && NILP (p->command)))
3417 FD_SET (inch, &input_wait_mask);
3418 FD_SET (inch, &non_keyboard_wait_mask);
3421 if (inch > max_process_desc)
3422 max_process_desc = inch;
3424 tem = Fplist_member (contact, QCcoding);
3425 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3426 tem = Qnil; /* No error message (too late!). */
3429 /* Setup coding systems for communicating with the network stream. */
3430 struct gcpro gcpro1;
3431 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3432 Lisp_Object coding_systems = Qt;
3433 Lisp_Object fargs[5], val;
3435 if (!NILP (tem))
3437 val = XCAR (XCDR (tem));
3438 if (CONSP (val))
3439 val = XCAR (val);
3441 else if (!NILP (Vcoding_system_for_read))
3442 val = Vcoding_system_for_read;
3443 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3444 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3445 /* We dare not decode end-of-line format by setting VAL to
3446 Qraw_text, because the existing Emacs Lisp libraries
3447 assume that they receive bare code including a sequence of
3448 CR LF. */
3449 val = Qnil;
3450 else
3452 if (NILP (host) || NILP (service))
3453 coding_systems = Qnil;
3454 else
3456 fargs[0] = Qopen_network_stream, fargs[1] = name,
3457 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3458 GCPRO1 (proc);
3459 coding_systems = Ffind_operation_coding_system (5, fargs);
3460 UNGCPRO;
3462 if (CONSP (coding_systems))
3463 val = XCAR (coding_systems);
3464 else if (CONSP (Vdefault_process_coding_system))
3465 val = XCAR (Vdefault_process_coding_system);
3466 else
3467 val = Qnil;
3469 pset_decode_coding_system (p, val);
3471 if (!NILP (tem))
3473 val = XCAR (XCDR (tem));
3474 if (CONSP (val))
3475 val = XCDR (val);
3477 else if (!NILP (Vcoding_system_for_write))
3478 val = Vcoding_system_for_write;
3479 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3480 val = Qnil;
3481 else
3483 if (EQ (coding_systems, Qt))
3485 if (NILP (host) || NILP (service))
3486 coding_systems = Qnil;
3487 else
3489 fargs[0] = Qopen_network_stream, fargs[1] = name,
3490 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3491 GCPRO1 (proc);
3492 coding_systems = Ffind_operation_coding_system (5, fargs);
3493 UNGCPRO;
3496 if (CONSP (coding_systems))
3497 val = XCDR (coding_systems);
3498 else if (CONSP (Vdefault_process_coding_system))
3499 val = XCDR (Vdefault_process_coding_system);
3500 else
3501 val = Qnil;
3503 pset_encode_coding_system (p, val);
3505 setup_process_coding_systems (proc);
3507 pset_decoding_buf (p, empty_unibyte_string);
3508 p->decoding_carryover = 0;
3509 pset_encoding_buf (p, empty_unibyte_string);
3511 p->inherit_coding_system_flag
3512 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3514 UNGCPRO;
3515 return proc;
3519 #if defined (HAVE_NET_IF_H)
3521 #ifdef SIOCGIFCONF
3522 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3523 doc: /* Return an alist of all network interfaces and their network address.
3524 Each element is a cons, the car of which is a string containing the
3525 interface name, and the cdr is the network address in internal
3526 format; see the description of ADDRESS in `make-network-process'. */)
3527 (void)
3529 struct ifconf ifconf;
3530 struct ifreq *ifreq;
3531 void *buf = NULL;
3532 ptrdiff_t buf_size = 512;
3533 int s;
3534 Lisp_Object res;
3536 s = socket (AF_INET, SOCK_STREAM, 0);
3537 if (s < 0)
3538 return Qnil;
3542 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3543 ifconf.ifc_buf = buf;
3544 ifconf.ifc_len = buf_size;
3545 if (ioctl (s, SIOCGIFCONF, &ifconf))
3547 close (s);
3548 xfree (buf);
3549 return Qnil;
3552 while (ifconf.ifc_len == buf_size);
3554 close (s);
3556 res = Qnil;
3557 ifreq = ifconf.ifc_req;
3558 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3560 struct ifreq *ifq = ifreq;
3561 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3562 #define SIZEOF_IFREQ(sif) \
3563 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3564 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3566 int len = SIZEOF_IFREQ (ifq);
3567 #else
3568 int len = sizeof (*ifreq);
3569 #endif
3570 char namebuf[sizeof (ifq->ifr_name) + 1];
3571 ifreq = (struct ifreq *) ((char *) ifreq + len);
3573 if (ifq->ifr_addr.sa_family != AF_INET)
3574 continue;
3576 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3577 namebuf[sizeof (ifq->ifr_name)] = 0;
3578 res = Fcons (Fcons (build_string (namebuf),
3579 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3580 sizeof (struct sockaddr))),
3581 res);
3584 xfree (buf);
3585 return res;
3587 #endif /* SIOCGIFCONF */
3589 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3591 struct ifflag_def {
3592 int flag_bit;
3593 const char *flag_sym;
3596 static const struct ifflag_def ifflag_table[] = {
3597 #ifdef IFF_UP
3598 { IFF_UP, "up" },
3599 #endif
3600 #ifdef IFF_BROADCAST
3601 { IFF_BROADCAST, "broadcast" },
3602 #endif
3603 #ifdef IFF_DEBUG
3604 { IFF_DEBUG, "debug" },
3605 #endif
3606 #ifdef IFF_LOOPBACK
3607 { IFF_LOOPBACK, "loopback" },
3608 #endif
3609 #ifdef IFF_POINTOPOINT
3610 { IFF_POINTOPOINT, "pointopoint" },
3611 #endif
3612 #ifdef IFF_RUNNING
3613 { IFF_RUNNING, "running" },
3614 #endif
3615 #ifdef IFF_NOARP
3616 { IFF_NOARP, "noarp" },
3617 #endif
3618 #ifdef IFF_PROMISC
3619 { IFF_PROMISC, "promisc" },
3620 #endif
3621 #ifdef IFF_NOTRAILERS
3622 #ifdef NS_IMPL_COCOA
3623 /* Really means smart, notrailers is obsolete */
3624 { IFF_NOTRAILERS, "smart" },
3625 #else
3626 { IFF_NOTRAILERS, "notrailers" },
3627 #endif
3628 #endif
3629 #ifdef IFF_ALLMULTI
3630 { IFF_ALLMULTI, "allmulti" },
3631 #endif
3632 #ifdef IFF_MASTER
3633 { IFF_MASTER, "master" },
3634 #endif
3635 #ifdef IFF_SLAVE
3636 { IFF_SLAVE, "slave" },
3637 #endif
3638 #ifdef IFF_MULTICAST
3639 { IFF_MULTICAST, "multicast" },
3640 #endif
3641 #ifdef IFF_PORTSEL
3642 { IFF_PORTSEL, "portsel" },
3643 #endif
3644 #ifdef IFF_AUTOMEDIA
3645 { IFF_AUTOMEDIA, "automedia" },
3646 #endif
3647 #ifdef IFF_DYNAMIC
3648 { IFF_DYNAMIC, "dynamic" },
3649 #endif
3650 #ifdef IFF_OACTIVE
3651 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3652 #endif
3653 #ifdef IFF_SIMPLEX
3654 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3655 #endif
3656 #ifdef IFF_LINK0
3657 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3658 #endif
3659 #ifdef IFF_LINK1
3660 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3661 #endif
3662 #ifdef IFF_LINK2
3663 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3664 #endif
3665 { 0, 0 }
3668 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3669 doc: /* Return information about network interface named IFNAME.
3670 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3671 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3672 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
3673 FLAGS is the current flags of the interface. */)
3674 (Lisp_Object ifname)
3676 struct ifreq rq;
3677 Lisp_Object res = Qnil;
3678 Lisp_Object elt;
3679 int s;
3680 bool any = 0;
3681 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3682 && defined HAVE_GETIFADDRS && defined LLADDR)
3683 struct ifaddrs *ifap;
3684 #endif
3686 CHECK_STRING (ifname);
3688 if (sizeof rq.ifr_name <= SBYTES (ifname))
3689 error ("interface name too long");
3690 strcpy (rq.ifr_name, SSDATA (ifname));
3692 s = socket (AF_INET, SOCK_STREAM, 0);
3693 if (s < 0)
3694 return Qnil;
3696 elt = Qnil;
3697 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3698 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3700 int flags = rq.ifr_flags;
3701 const struct ifflag_def *fp;
3702 int fnum;
3704 /* If flags is smaller than int (i.e. short) it may have the high bit set
3705 due to IFF_MULTICAST. In that case, sign extending it into
3706 an int is wrong. */
3707 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3708 flags = (unsigned short) rq.ifr_flags;
3710 any = 1;
3711 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3713 if (flags & fp->flag_bit)
3715 elt = Fcons (intern (fp->flag_sym), elt);
3716 flags -= fp->flag_bit;
3719 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3721 if (flags & 1)
3723 elt = Fcons (make_number (fnum), elt);
3727 #endif
3728 res = Fcons (elt, res);
3730 elt = Qnil;
3731 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3732 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3734 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3735 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3736 int n;
3738 any = 1;
3739 for (n = 0; n < 6; n++)
3740 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3741 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3743 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3744 if (getifaddrs (&ifap) != -1)
3746 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3747 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3748 struct ifaddrs *it;
3750 for (it = ifap; it != NULL; it = it->ifa_next)
3752 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3753 unsigned char linkaddr[6];
3754 int n;
3756 if (it->ifa_addr->sa_family != AF_LINK
3757 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3758 || sdl->sdl_alen != 6)
3759 continue;
3761 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3762 for (n = 0; n < 6; n++)
3763 p->contents[n] = make_number (linkaddr[n]);
3765 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3766 break;
3769 #ifdef HAVE_FREEIFADDRS
3770 freeifaddrs (ifap);
3771 #endif
3773 #endif /* HAVE_GETIFADDRS && LLADDR */
3775 res = Fcons (elt, res);
3777 elt = Qnil;
3778 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3779 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3781 any = 1;
3782 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3783 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3784 #else
3785 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3786 #endif
3788 #endif
3789 res = Fcons (elt, res);
3791 elt = Qnil;
3792 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3793 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3795 any = 1;
3796 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3798 #endif
3799 res = Fcons (elt, res);
3801 elt = Qnil;
3802 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3803 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3805 any = 1;
3806 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3808 #endif
3809 res = Fcons (elt, res);
3811 close (s);
3813 return any ? res : Qnil;
3815 #endif
3816 #endif /* defined (HAVE_NET_IF_H) */
3818 /* Turn off input and output for process PROC. */
3820 static void
3821 deactivate_process (Lisp_Object proc)
3823 register int inchannel, outchannel;
3824 register struct Lisp_Process *p = XPROCESS (proc);
3826 #ifdef HAVE_GNUTLS
3827 /* Delete GnuTLS structures in PROC, if any. */
3828 emacs_gnutls_deinit (proc);
3829 #endif /* HAVE_GNUTLS */
3831 inchannel = p->infd;
3832 outchannel = p->outfd;
3834 #ifdef ADAPTIVE_READ_BUFFERING
3835 if (p->read_output_delay > 0)
3837 if (--process_output_delay_count < 0)
3838 process_output_delay_count = 0;
3839 p->read_output_delay = 0;
3840 p->read_output_skip = 0;
3842 #endif
3844 if (inchannel >= 0)
3846 /* Beware SIGCHLD hereabouts. */
3847 flush_pending_output (inchannel);
3848 emacs_close (inchannel);
3849 if (outchannel >= 0 && outchannel != inchannel)
3850 emacs_close (outchannel);
3852 p->infd = -1;
3853 p->outfd = -1;
3854 #ifdef DATAGRAM_SOCKETS
3855 if (DATAGRAM_CHAN_P (inchannel))
3857 xfree (datagram_address[inchannel].sa);
3858 datagram_address[inchannel].sa = 0;
3859 datagram_address[inchannel].len = 0;
3861 #endif
3862 chan_process[inchannel] = Qnil;
3863 FD_CLR (inchannel, &input_wait_mask);
3864 FD_CLR (inchannel, &non_keyboard_wait_mask);
3865 #ifdef NON_BLOCKING_CONNECT
3866 if (FD_ISSET (inchannel, &connect_wait_mask))
3868 FD_CLR (inchannel, &connect_wait_mask);
3869 FD_CLR (inchannel, &write_mask);
3870 if (--num_pending_connects < 0)
3871 emacs_abort ();
3873 #endif
3874 if (inchannel == max_process_desc)
3876 int i;
3877 /* We just closed the highest-numbered process input descriptor,
3878 so recompute the highest-numbered one now. */
3879 max_process_desc = 0;
3880 for (i = 0; i < MAXDESC; i++)
3881 if (!NILP (chan_process[i]))
3882 max_process_desc = i;
3888 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3889 0, 4, 0,
3890 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3891 It is read into the process' buffers or given to their filter functions.
3892 Non-nil arg PROCESS means do not return until some output has been received
3893 from PROCESS.
3895 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3896 and milliseconds to wait; return after that much time whether or not
3897 there is any subprocess output. If SECONDS is a floating point number,
3898 it specifies a fractional number of seconds to wait.
3899 The MILLISEC argument is obsolete and should be avoided.
3901 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3902 from PROCESS, suspending reading output from other processes.
3903 If JUST-THIS-ONE is an integer, don't run any timers either.
3904 Return non-nil if we received any output before the timeout expired. */)
3905 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3907 intmax_t secs;
3908 int nsecs;
3910 if (! NILP (process))
3911 CHECK_PROCESS (process);
3912 else
3913 just_this_one = Qnil;
3915 if (!NILP (millisec))
3916 { /* Obsolete calling convention using integers rather than floats. */
3917 CHECK_NUMBER (millisec);
3918 if (NILP (seconds))
3919 seconds = make_float (XINT (millisec) / 1000.0);
3920 else
3922 CHECK_NUMBER (seconds);
3923 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3927 secs = 0;
3928 nsecs = -1;
3930 if (!NILP (seconds))
3932 if (INTEGERP (seconds))
3934 if (XINT (seconds) > 0)
3936 secs = XINT (seconds);
3937 nsecs = 0;
3940 else if (FLOATP (seconds))
3942 if (XFLOAT_DATA (seconds) > 0)
3944 EMACS_TIME t = EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (seconds));
3945 secs = min (EMACS_SECS (t), WAIT_READING_MAX);
3946 nsecs = EMACS_NSECS (t);
3949 else
3950 wrong_type_argument (Qnumberp, seconds);
3952 else if (! NILP (process))
3953 nsecs = 0;
3955 return
3956 (wait_reading_process_output (secs, nsecs, 0, 0,
3957 Qnil,
3958 !NILP (process) ? XPROCESS (process) : NULL,
3959 NILP (just_this_one) ? 0 :
3960 !INTEGERP (just_this_one) ? 1 : -1)
3961 ? Qt : Qnil);
3964 /* Accept a connection for server process SERVER on CHANNEL. */
3966 static EMACS_INT connect_counter = 0;
3968 static void
3969 server_accept_connection (Lisp_Object server, int channel)
3971 Lisp_Object proc, caller, name, buffer;
3972 Lisp_Object contact, host, service;
3973 struct Lisp_Process *ps= XPROCESS (server);
3974 struct Lisp_Process *p;
3975 int s;
3976 union u_sockaddr {
3977 struct sockaddr sa;
3978 struct sockaddr_in in;
3979 #ifdef AF_INET6
3980 struct sockaddr_in6 in6;
3981 #endif
3982 #ifdef HAVE_LOCAL_SOCKETS
3983 struct sockaddr_un un;
3984 #endif
3985 } saddr;
3986 socklen_t len = sizeof saddr;
3988 s = accept (channel, &saddr.sa, &len);
3990 if (s < 0)
3992 int code = errno;
3994 if (code == EAGAIN)
3995 return;
3996 #ifdef EWOULDBLOCK
3997 if (code == EWOULDBLOCK)
3998 return;
3999 #endif
4001 if (!NILP (ps->log))
4002 call3 (ps->log, server, Qnil,
4003 concat3 (build_string ("accept failed with code"),
4004 Fnumber_to_string (make_number (code)),
4005 build_string ("\n")));
4006 return;
4009 connect_counter++;
4011 /* Setup a new process to handle the connection. */
4013 /* Generate a unique identification of the caller, and build contact
4014 information for this process. */
4015 host = Qt;
4016 service = Qnil;
4017 switch (saddr.sa.sa_family)
4019 case AF_INET:
4021 Lisp_Object args[5];
4022 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4023 args[0] = build_string ("%d.%d.%d.%d");
4024 args[1] = make_number (*ip++);
4025 args[2] = make_number (*ip++);
4026 args[3] = make_number (*ip++);
4027 args[4] = make_number (*ip++);
4028 host = Fformat (5, args);
4029 service = make_number (ntohs (saddr.in.sin_port));
4031 args[0] = build_string (" <%s:%d>");
4032 args[1] = host;
4033 args[2] = service;
4034 caller = Fformat (3, args);
4036 break;
4038 #ifdef AF_INET6
4039 case AF_INET6:
4041 Lisp_Object args[9];
4042 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4043 int i;
4044 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4045 for (i = 0; i < 8; i++)
4046 args[i+1] = make_number (ntohs (ip6[i]));
4047 host = Fformat (9, args);
4048 service = make_number (ntohs (saddr.in.sin_port));
4050 args[0] = build_string (" <[%s]:%d>");
4051 args[1] = host;
4052 args[2] = service;
4053 caller = Fformat (3, args);
4055 break;
4056 #endif
4058 #ifdef HAVE_LOCAL_SOCKETS
4059 case AF_LOCAL:
4060 #endif
4061 default:
4062 caller = Fnumber_to_string (make_number (connect_counter));
4063 caller = concat3 (build_string (" <"), caller, build_string (">"));
4064 break;
4067 /* Create a new buffer name for this process if it doesn't have a
4068 filter. The new buffer name is based on the buffer name or
4069 process name of the server process concatenated with the caller
4070 identification. */
4072 if (!(EQ (ps->filter, Qinternal_default_process_filter)
4073 || EQ (ps->filter, Qt)))
4074 buffer = Qnil;
4075 else
4077 buffer = ps->buffer;
4078 if (!NILP (buffer))
4079 buffer = Fbuffer_name (buffer);
4080 else
4081 buffer = ps->name;
4082 if (!NILP (buffer))
4084 buffer = concat2 (buffer, caller);
4085 buffer = Fget_buffer_create (buffer);
4089 /* Generate a unique name for the new server process. Combine the
4090 server process name with the caller identification. */
4092 name = concat2 (ps->name, caller);
4093 proc = make_process (name);
4095 chan_process[s] = proc;
4097 fcntl (s, F_SETFL, O_NONBLOCK);
4099 p = XPROCESS (proc);
4101 /* Build new contact information for this setup. */
4102 contact = Fcopy_sequence (ps->childp);
4103 contact = Fplist_put (contact, QCserver, Qnil);
4104 contact = Fplist_put (contact, QChost, host);
4105 if (!NILP (service))
4106 contact = Fplist_put (contact, QCservice, service);
4107 contact = Fplist_put (contact, QCremote,
4108 conv_sockaddr_to_lisp (&saddr.sa, len));
4109 #ifdef HAVE_GETSOCKNAME
4110 len = sizeof saddr;
4111 if (getsockname (s, &saddr.sa, &len) == 0)
4112 contact = Fplist_put (contact, QClocal,
4113 conv_sockaddr_to_lisp (&saddr.sa, len));
4114 #endif
4116 pset_childp (p, contact);
4117 pset_plist (p, Fcopy_sequence (ps->plist));
4118 pset_type (p, Qnetwork);
4120 pset_buffer (p, buffer);
4121 pset_sentinel (p, ps->sentinel);
4122 pset_filter (p, ps->filter);
4123 pset_command (p, Qnil);
4124 p->pid = 0;
4125 p->infd = s;
4126 p->outfd = s;
4127 pset_status (p, Qrun);
4129 /* Client processes for accepted connections are not stopped initially. */
4130 if (!EQ (p->filter, Qt))
4132 FD_SET (s, &input_wait_mask);
4133 FD_SET (s, &non_keyboard_wait_mask);
4136 if (s > max_process_desc)
4137 max_process_desc = s;
4139 /* Setup coding system for new process based on server process.
4140 This seems to be the proper thing to do, as the coding system
4141 of the new process should reflect the settings at the time the
4142 server socket was opened; not the current settings. */
4144 pset_decode_coding_system (p, ps->decode_coding_system);
4145 pset_encode_coding_system (p, ps->encode_coding_system);
4146 setup_process_coding_systems (proc);
4148 pset_decoding_buf (p, empty_unibyte_string);
4149 p->decoding_carryover = 0;
4150 pset_encoding_buf (p, empty_unibyte_string);
4152 p->inherit_coding_system_flag
4153 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4155 if (!NILP (ps->log))
4156 call3 (ps->log, server, proc,
4157 concat3 (build_string ("accept from "),
4158 (STRINGP (host) ? host : build_string ("-")),
4159 build_string ("\n")));
4161 exec_sentinel (proc,
4162 concat3 (build_string ("open from "),
4163 (STRINGP (host) ? host : build_string ("-")),
4164 build_string ("\n")));
4167 /* This variable is different from waiting_for_input in keyboard.c.
4168 It is used to communicate to a lisp process-filter/sentinel (via the
4169 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4170 for user-input when that process-filter was called.
4171 waiting_for_input cannot be used as that is by definition 0 when
4172 lisp code is being evalled.
4173 This is also used in record_asynch_buffer_change.
4174 For that purpose, this must be 0
4175 when not inside wait_reading_process_output. */
4176 static int waiting_for_user_input_p;
4178 static Lisp_Object
4179 wait_reading_process_output_unwind (Lisp_Object data)
4181 waiting_for_user_input_p = XINT (data);
4182 return Qnil;
4185 /* This is here so breakpoints can be put on it. */
4186 static void
4187 wait_reading_process_output_1 (void)
4191 /* Read and dispose of subprocess output while waiting for timeout to
4192 elapse and/or keyboard input to be available.
4194 TIME_LIMIT is:
4195 timeout in seconds
4196 If negative, gobble data immediately available but don't wait for any.
4198 NSECS is:
4199 an additional duration to wait, measured in nanoseconds
4200 If TIME_LIMIT is zero, then:
4201 If NSECS == 0, there is no limit.
4202 If NSECS > 0, the timeout consists of NSECS only.
4203 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4205 READ_KBD is:
4206 0 to ignore keyboard input, or
4207 1 to return when input is available, or
4208 -1 meaning caller will actually read the input, so don't throw to
4209 the quit handler, or
4211 DO_DISPLAY means redisplay should be done to show subprocess
4212 output that arrives.
4214 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4215 (and gobble terminal input into the buffer if any arrives).
4217 If WAIT_PROC is specified, wait until something arrives from that
4218 process. The return value is true if we read some input from
4219 that process.
4221 If JUST_WAIT_PROC is nonzero, handle only output from WAIT_PROC
4222 (suspending output from other processes). A negative value
4223 means don't run any timers either.
4225 If WAIT_PROC is specified, then the function returns true if we
4226 received input from that process before the timeout elapsed.
4227 Otherwise, return true if we received input from any process. */
4229 bool
4230 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4231 bool do_display,
4232 Lisp_Object wait_for_cell,
4233 struct Lisp_Process *wait_proc, int just_wait_proc)
4235 int channel, nfds;
4236 SELECT_TYPE Available;
4237 SELECT_TYPE Writeok;
4238 bool check_write;
4239 int check_delay;
4240 bool no_avail;
4241 int xerrno;
4242 Lisp_Object proc;
4243 EMACS_TIME timeout, end_time;
4244 int wait_channel = -1;
4245 bool got_some_input = 0;
4246 ptrdiff_t count = SPECPDL_INDEX ();
4248 FD_ZERO (&Available);
4249 FD_ZERO (&Writeok);
4251 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4252 && !(CONSP (wait_proc->status)
4253 && EQ (XCAR (wait_proc->status), Qexit)))
4254 message1 ("Blocking call to accept-process-output with quit inhibited!!");
4256 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4257 if (wait_proc != NULL)
4258 wait_channel = wait_proc->infd;
4260 record_unwind_protect (wait_reading_process_output_unwind,
4261 make_number (waiting_for_user_input_p));
4262 waiting_for_user_input_p = read_kbd;
4264 if (time_limit < 0)
4266 time_limit = 0;
4267 nsecs = -1;
4269 else if (TYPE_MAXIMUM (time_t) < time_limit)
4270 time_limit = TYPE_MAXIMUM (time_t);
4272 /* Since we may need to wait several times,
4273 compute the absolute time to return at. */
4274 if (time_limit || nsecs > 0)
4276 timeout = make_emacs_time (time_limit, nsecs);
4277 end_time = add_emacs_time (current_emacs_time (), timeout);
4280 while (1)
4282 bool timeout_reduced_for_timers = 0;
4284 /* If calling from keyboard input, do not quit
4285 since we want to return C-g as an input character.
4286 Otherwise, do pending quit if requested. */
4287 if (read_kbd >= 0)
4288 QUIT;
4289 else if (pending_signals)
4290 process_pending_signals ();
4292 /* Exit now if the cell we're waiting for became non-nil. */
4293 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4294 break;
4296 /* Compute time from now till when time limit is up. */
4297 /* Exit if already run out. */
4298 if (nsecs < 0)
4300 /* A negative timeout means
4301 gobble output available now
4302 but don't wait at all. */
4304 timeout = make_emacs_time (0, 0);
4306 else if (time_limit || nsecs > 0)
4308 EMACS_TIME now = current_emacs_time ();
4309 if (EMACS_TIME_LE (end_time, now))
4310 break;
4311 timeout = sub_emacs_time (end_time, now);
4313 else
4315 timeout = make_emacs_time (100000, 0);
4318 /* Normally we run timers here.
4319 But not if wait_for_cell; in those cases,
4320 the wait is supposed to be short,
4321 and those callers cannot handle running arbitrary Lisp code here. */
4322 if (NILP (wait_for_cell)
4323 && just_wait_proc >= 0)
4325 EMACS_TIME timer_delay;
4329 unsigned old_timers_run = timers_run;
4330 struct buffer *old_buffer = current_buffer;
4331 Lisp_Object old_window = selected_window;
4333 timer_delay = timer_check ();
4335 /* If a timer has run, this might have changed buffers
4336 an alike. Make read_key_sequence aware of that. */
4337 if (timers_run != old_timers_run
4338 && (old_buffer != current_buffer
4339 || !EQ (old_window, selected_window))
4340 && waiting_for_user_input_p == -1)
4341 record_asynch_buffer_change ();
4343 if (timers_run != old_timers_run && do_display)
4344 /* We must retry, since a timer may have requeued itself
4345 and that could alter the time_delay. */
4346 redisplay_preserve_echo_area (9);
4347 else
4348 break;
4350 while (!detect_input_pending ());
4352 /* If there is unread keyboard input, also return. */
4353 if (read_kbd != 0
4354 && requeued_events_pending_p ())
4355 break;
4357 /* A negative timeout means do not wait at all. */
4358 if (nsecs >= 0)
4360 if (EMACS_TIME_VALID_P (timer_delay))
4362 if (EMACS_TIME_LT (timer_delay, timeout))
4364 timeout = timer_delay;
4365 timeout_reduced_for_timers = 1;
4368 else
4370 /* This is so a breakpoint can be put here. */
4371 wait_reading_process_output_1 ();
4376 /* Cause C-g and alarm signals to take immediate action,
4377 and cause input available signals to zero out timeout.
4379 It is important that we do this before checking for process
4380 activity. If we get a SIGCHLD after the explicit checks for
4381 process activity, timeout is the only way we will know. */
4382 if (read_kbd < 0)
4383 set_waiting_for_input (&timeout);
4385 /* If status of something has changed, and no input is
4386 available, notify the user of the change right away. After
4387 this explicit check, we'll let the SIGCHLD handler zap
4388 timeout to get our attention. */
4389 if (update_tick != process_tick)
4391 SELECT_TYPE Atemp;
4392 SELECT_TYPE Ctemp;
4394 if (kbd_on_hold_p ())
4395 FD_ZERO (&Atemp);
4396 else
4397 Atemp = input_wait_mask;
4398 Ctemp = write_mask;
4400 timeout = make_emacs_time (0, 0);
4401 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4402 &Atemp,
4403 #ifdef NON_BLOCKING_CONNECT
4404 (num_pending_connects > 0 ? &Ctemp : NULL),
4405 #else
4406 NULL,
4407 #endif
4408 NULL, &timeout, NULL)
4409 <= 0))
4411 /* It's okay for us to do this and then continue with
4412 the loop, since timeout has already been zeroed out. */
4413 clear_waiting_for_input ();
4414 status_notify (NULL);
4415 if (do_display) redisplay_preserve_echo_area (13);
4419 /* Don't wait for output from a non-running process. Just
4420 read whatever data has already been received. */
4421 if (wait_proc && wait_proc->raw_status_new)
4422 update_status (wait_proc);
4423 if (wait_proc
4424 && ! EQ (wait_proc->status, Qrun)
4425 && ! EQ (wait_proc->status, Qconnect))
4427 bool read_some_bytes = 0;
4429 clear_waiting_for_input ();
4430 XSETPROCESS (proc, wait_proc);
4432 /* Read data from the process, until we exhaust it. */
4433 while (wait_proc->infd >= 0)
4435 int nread = read_process_output (proc, wait_proc->infd);
4437 if (nread == 0)
4438 break;
4440 if (nread > 0)
4441 got_some_input = read_some_bytes = 1;
4442 else if (nread == -1 && (errno == EIO || errno == EAGAIN))
4443 break;
4444 #ifdef EWOULDBLOCK
4445 else if (nread == -1 && EWOULDBLOCK == errno)
4446 break;
4447 #endif
4449 if (read_some_bytes && do_display)
4450 redisplay_preserve_echo_area (10);
4452 break;
4455 /* Wait till there is something to do */
4457 if (wait_proc && just_wait_proc)
4459 if (wait_proc->infd < 0) /* Terminated */
4460 break;
4461 FD_SET (wait_proc->infd, &Available);
4462 check_delay = 0;
4463 check_write = 0;
4465 else if (!NILP (wait_for_cell))
4467 Available = non_process_wait_mask;
4468 check_delay = 0;
4469 check_write = 0;
4471 else
4473 if (! read_kbd)
4474 Available = non_keyboard_wait_mask;
4475 else
4476 Available = input_wait_mask;
4477 Writeok = write_mask;
4478 #ifdef SELECT_CANT_DO_WRITE_MASK
4479 check_write = 0;
4480 #else
4481 check_write = 1;
4482 #endif
4483 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4486 /* If frame size has changed or the window is newly mapped,
4487 redisplay now, before we start to wait. There is a race
4488 condition here; if a SIGIO arrives between now and the select
4489 and indicates that a frame is trashed, the select may block
4490 displaying a trashed screen. */
4491 if (frame_garbaged && do_display)
4493 clear_waiting_for_input ();
4494 redisplay_preserve_echo_area (11);
4495 if (read_kbd < 0)
4496 set_waiting_for_input (&timeout);
4499 /* Skip the `select' call if input is available and we're
4500 waiting for keyboard input or a cell change (which can be
4501 triggered by processing X events). In the latter case, set
4502 nfds to 1 to avoid breaking the loop. */
4503 no_avail = 0;
4504 if ((read_kbd || !NILP (wait_for_cell))
4505 && detect_input_pending ())
4507 nfds = read_kbd ? 0 : 1;
4508 no_avail = 1;
4511 if (!no_avail)
4514 #ifdef ADAPTIVE_READ_BUFFERING
4515 /* Set the timeout for adaptive read buffering if any
4516 process has non-zero read_output_skip and non-zero
4517 read_output_delay, and we are not reading output for a
4518 specific wait_channel. It is not executed if
4519 Vprocess_adaptive_read_buffering is nil. */
4520 if (process_output_skip && check_delay > 0)
4522 int nsecs = EMACS_NSECS (timeout);
4523 if (EMACS_SECS (timeout) > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4524 nsecs = READ_OUTPUT_DELAY_MAX;
4525 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4527 proc = chan_process[channel];
4528 if (NILP (proc))
4529 continue;
4530 /* Find minimum non-zero read_output_delay among the
4531 processes with non-zero read_output_skip. */
4532 if (XPROCESS (proc)->read_output_delay > 0)
4534 check_delay--;
4535 if (!XPROCESS (proc)->read_output_skip)
4536 continue;
4537 FD_CLR (channel, &Available);
4538 XPROCESS (proc)->read_output_skip = 0;
4539 if (XPROCESS (proc)->read_output_delay < nsecs)
4540 nsecs = XPROCESS (proc)->read_output_delay;
4543 timeout = make_emacs_time (0, nsecs);
4544 process_output_skip = 0;
4546 #endif
4548 #if defined (HAVE_NS)
4549 nfds = ns_select
4550 #elif defined (HAVE_GLIB)
4551 nfds = xg_select
4552 #else
4553 nfds = pselect
4554 #endif
4555 (max (max_process_desc, max_input_desc) + 1,
4556 &Available,
4557 (check_write ? &Writeok : (SELECT_TYPE *)0),
4558 NULL, &timeout, NULL);
4560 #ifdef HAVE_GNUTLS
4561 /* GnuTLS buffers data internally. In lowat mode it leaves
4562 some data in the TCP buffers so that select works, but
4563 with custom pull/push functions we need to check if some
4564 data is available in the buffers manually. */
4565 if (nfds == 0)
4567 if (! wait_proc)
4569 /* We're not waiting on a specific process, so loop
4570 through all the channels and check for data.
4571 This is a workaround needed for some versions of
4572 the gnutls library -- 2.12.14 has been confirmed
4573 to need it. See
4574 http://comments.gmane.org/gmane.emacs.devel/145074 */
4575 for (channel = 0; channel < MAXDESC; ++channel)
4576 if (! NILP (chan_process[channel]))
4578 struct Lisp_Process *p =
4579 XPROCESS (chan_process[channel]);
4580 if (p && p->gnutls_p && p->infd
4581 && ((emacs_gnutls_record_check_pending
4582 (p->gnutls_state))
4583 > 0))
4585 nfds++;
4586 FD_SET (p->infd, &Available);
4590 else
4592 /* Check this specific channel. */
4593 if (wait_proc->gnutls_p /* Check for valid process. */
4594 /* Do we have pending data? */
4595 && ((emacs_gnutls_record_check_pending
4596 (wait_proc->gnutls_state))
4597 > 0))
4599 nfds = 1;
4600 /* Set to Available. */
4601 FD_SET (wait_proc->infd, &Available);
4605 #endif
4608 xerrno = errno;
4610 /* Make C-g and alarm signals set flags again */
4611 clear_waiting_for_input ();
4613 /* If we woke up due to SIGWINCH, actually change size now. */
4614 do_pending_window_change (0);
4616 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4617 /* We waited the full specified time, so return now. */
4618 break;
4619 if (nfds < 0)
4621 if (xerrno == EINTR)
4622 no_avail = 1;
4623 else if (xerrno == EBADF)
4625 #ifdef AIX
4626 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
4627 the child's closure of the pts gives the parent a SIGHUP, and
4628 the ptc file descriptor is automatically closed,
4629 yielding EBADF here or at select() call above.
4630 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
4631 in m/ibmrt-aix.h), and here we just ignore the select error.
4632 Cleanup occurs c/o status_notify after SIGCHLD. */
4633 no_avail = 1; /* Cannot depend on values returned */
4634 #else
4635 emacs_abort ();
4636 #endif
4638 else
4639 error ("select error: %s", emacs_strerror (xerrno));
4642 if (no_avail)
4644 FD_ZERO (&Available);
4645 check_write = 0;
4648 /* Check for keyboard input */
4649 /* If there is any, return immediately
4650 to give it higher priority than subprocesses */
4652 if (read_kbd != 0)
4654 unsigned old_timers_run = timers_run;
4655 struct buffer *old_buffer = current_buffer;
4656 Lisp_Object old_window = selected_window;
4657 bool leave = 0;
4659 if (detect_input_pending_run_timers (do_display))
4661 swallow_events (do_display);
4662 if (detect_input_pending_run_timers (do_display))
4663 leave = 1;
4666 /* If a timer has run, this might have changed buffers
4667 an alike. Make read_key_sequence aware of that. */
4668 if (timers_run != old_timers_run
4669 && waiting_for_user_input_p == -1
4670 && (old_buffer != current_buffer
4671 || !EQ (old_window, selected_window)))
4672 record_asynch_buffer_change ();
4674 if (leave)
4675 break;
4678 /* If there is unread keyboard input, also return. */
4679 if (read_kbd != 0
4680 && requeued_events_pending_p ())
4681 break;
4683 /* If we are not checking for keyboard input now,
4684 do process events (but don't run any timers).
4685 This is so that X events will be processed.
4686 Otherwise they may have to wait until polling takes place.
4687 That would causes delays in pasting selections, for example.
4689 (We used to do this only if wait_for_cell.) */
4690 if (read_kbd == 0 && detect_input_pending ())
4692 swallow_events (do_display);
4693 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4694 if (detect_input_pending ())
4695 break;
4696 #endif
4699 /* Exit now if the cell we're waiting for became non-nil. */
4700 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4701 break;
4703 #ifdef USABLE_SIGIO
4704 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4705 go read it. This can happen with X on BSD after logging out.
4706 In that case, there really is no input and no SIGIO,
4707 but select says there is input. */
4709 if (read_kbd && interrupt_input
4710 && keyboard_bit_set (&Available) && ! noninteractive)
4711 handle_input_available_signal (SIGIO);
4712 #endif
4714 if (! wait_proc)
4715 got_some_input |= nfds > 0;
4717 /* If checking input just got us a size-change event from X,
4718 obey it now if we should. */
4719 if (read_kbd || ! NILP (wait_for_cell))
4720 do_pending_window_change (0);
4722 /* Check for data from a process. */
4723 if (no_avail || nfds == 0)
4724 continue;
4726 for (channel = 0; channel <= max_input_desc; ++channel)
4728 struct fd_callback_data *d = &fd_callback_info[channel];
4729 if (d->func
4730 && ((d->condition & FOR_READ
4731 && FD_ISSET (channel, &Available))
4732 || (d->condition & FOR_WRITE
4733 && FD_ISSET (channel, &write_mask))))
4734 d->func (channel, d->data);
4737 for (channel = 0; channel <= max_process_desc; channel++)
4739 if (FD_ISSET (channel, &Available)
4740 && FD_ISSET (channel, &non_keyboard_wait_mask)
4741 && !FD_ISSET (channel, &non_process_wait_mask))
4743 int nread;
4745 /* If waiting for this channel, arrange to return as
4746 soon as no more input to be processed. No more
4747 waiting. */
4748 if (wait_channel == channel)
4750 wait_channel = -1;
4751 nsecs = -1;
4752 got_some_input = 1;
4754 proc = chan_process[channel];
4755 if (NILP (proc))
4756 continue;
4758 /* If this is a server stream socket, accept connection. */
4759 if (EQ (XPROCESS (proc)->status, Qlisten))
4761 server_accept_connection (proc, channel);
4762 continue;
4765 /* Read data from the process, starting with our
4766 buffered-ahead character if we have one. */
4768 nread = read_process_output (proc, channel);
4769 if (nread > 0)
4771 /* Since read_process_output can run a filter,
4772 which can call accept-process-output,
4773 don't try to read from any other processes
4774 before doing the select again. */
4775 FD_ZERO (&Available);
4777 if (do_display)
4778 redisplay_preserve_echo_area (12);
4780 #ifdef EWOULDBLOCK
4781 else if (nread == -1 && errno == EWOULDBLOCK)
4783 #endif
4784 else if (nread == -1 && errno == EAGAIN)
4786 #ifdef WINDOWSNT
4787 /* FIXME: Is this special case still needed? */
4788 /* Note that we cannot distinguish between no input
4789 available now and a closed pipe.
4790 With luck, a closed pipe will be accompanied by
4791 subprocess termination and SIGCHLD. */
4792 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4794 #endif
4795 #ifdef HAVE_PTYS
4796 /* On some OSs with ptys, when the process on one end of
4797 a pty exits, the other end gets an error reading with
4798 errno = EIO instead of getting an EOF (0 bytes read).
4799 Therefore, if we get an error reading and errno =
4800 EIO, just continue, because the child process has
4801 exited and should clean itself up soon (e.g. when we
4802 get a SIGCHLD). */
4803 else if (nread == -1 && errno == EIO)
4805 struct Lisp_Process *p = XPROCESS (proc);
4807 /* Clear the descriptor now, so we only raise the
4808 signal once. */
4809 FD_CLR (channel, &input_wait_mask);
4810 FD_CLR (channel, &non_keyboard_wait_mask);
4812 if (p->pid == -2)
4814 /* If the EIO occurs on a pty, the SIGCHLD handler's
4815 waitpid call will not find the process object to
4816 delete. Do it here. */
4817 p->tick = ++process_tick;
4818 pset_status (p, Qfailed);
4821 #endif /* HAVE_PTYS */
4822 /* If we can detect process termination, don't consider the
4823 process gone just because its pipe is closed. */
4824 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4826 else
4828 /* Preserve status of processes already terminated. */
4829 XPROCESS (proc)->tick = ++process_tick;
4830 deactivate_process (proc);
4831 if (XPROCESS (proc)->raw_status_new)
4832 update_status (XPROCESS (proc));
4833 if (EQ (XPROCESS (proc)->status, Qrun))
4834 pset_status (XPROCESS (proc),
4835 list2 (Qexit, make_number (256)));
4838 #ifdef NON_BLOCKING_CONNECT
4839 if (FD_ISSET (channel, &Writeok)
4840 && FD_ISSET (channel, &connect_wait_mask))
4842 struct Lisp_Process *p;
4844 FD_CLR (channel, &connect_wait_mask);
4845 FD_CLR (channel, &write_mask);
4846 if (--num_pending_connects < 0)
4847 emacs_abort ();
4849 proc = chan_process[channel];
4850 if (NILP (proc))
4851 continue;
4853 p = XPROCESS (proc);
4855 #ifdef GNU_LINUX
4856 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4857 So only use it on systems where it is known to work. */
4859 socklen_t xlen = sizeof (xerrno);
4860 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4861 xerrno = errno;
4863 #else
4865 struct sockaddr pname;
4866 int pnamelen = sizeof (pname);
4868 /* If connection failed, getpeername will fail. */
4869 xerrno = 0;
4870 if (getpeername (channel, &pname, &pnamelen) < 0)
4872 /* Obtain connect failure code through error slippage. */
4873 char dummy;
4874 xerrno = errno;
4875 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4876 xerrno = errno;
4879 #endif
4880 if (xerrno)
4882 p->tick = ++process_tick;
4883 pset_status (p, list2 (Qfailed, make_number (xerrno)));
4884 deactivate_process (proc);
4886 else
4888 pset_status (p, Qrun);
4889 /* Execute the sentinel here. If we had relied on
4890 status_notify to do it later, it will read input
4891 from the process before calling the sentinel. */
4892 exec_sentinel (proc, build_string ("open\n"));
4893 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
4895 FD_SET (p->infd, &input_wait_mask);
4896 FD_SET (p->infd, &non_keyboard_wait_mask);
4900 #endif /* NON_BLOCKING_CONNECT */
4901 } /* End for each file descriptor. */
4902 } /* End while exit conditions not met. */
4904 unbind_to (count, Qnil);
4906 /* If calling from keyboard input, do not quit
4907 since we want to return C-g as an input character.
4908 Otherwise, do pending quit if requested. */
4909 if (read_kbd >= 0)
4911 /* Prevent input_pending from remaining set if we quit. */
4912 clear_input_pending ();
4913 QUIT;
4916 return got_some_input;
4919 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
4921 static Lisp_Object
4922 read_process_output_call (Lisp_Object fun_and_args)
4924 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
4927 static Lisp_Object
4928 read_process_output_error_handler (Lisp_Object error_val)
4930 cmd_error_internal (error_val, "error in process filter: ");
4931 Vinhibit_quit = Qt;
4932 update_echo_area ();
4933 Fsleep_for (make_number (2), Qnil);
4934 return Qt;
4937 static void
4938 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
4939 ssize_t nbytes,
4940 struct coding_system *coding);
4942 /* Read pending output from the process channel,
4943 starting with our buffered-ahead character if we have one.
4944 Yield number of decoded characters read.
4946 This function reads at most 4096 characters.
4947 If you want to read all available subprocess output,
4948 you must call it repeatedly until it returns zero.
4950 The characters read are decoded according to PROC's coding-system
4951 for decoding. */
4953 static int
4954 read_process_output (Lisp_Object proc, register int channel)
4956 register ssize_t nbytes;
4957 char *chars;
4958 register struct Lisp_Process *p = XPROCESS (proc);
4959 struct coding_system *coding = proc_decode_coding_system[channel];
4960 int carryover = p->decoding_carryover;
4961 int readmax = 4096;
4962 ptrdiff_t count = SPECPDL_INDEX ();
4963 Lisp_Object odeactivate;
4965 chars = alloca (carryover + readmax);
4966 if (carryover)
4967 /* See the comment above. */
4968 memcpy (chars, SDATA (p->decoding_buf), carryover);
4970 #ifdef DATAGRAM_SOCKETS
4971 /* We have a working select, so proc_buffered_char is always -1. */
4972 if (DATAGRAM_CHAN_P (channel))
4974 socklen_t len = datagram_address[channel].len;
4975 nbytes = recvfrom (channel, chars + carryover, readmax,
4976 0, datagram_address[channel].sa, &len);
4978 else
4979 #endif
4981 bool buffered = proc_buffered_char[channel] >= 0;
4982 if (buffered)
4984 chars[carryover] = proc_buffered_char[channel];
4985 proc_buffered_char[channel] = -1;
4987 #ifdef HAVE_GNUTLS
4988 if (p->gnutls_p)
4989 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
4990 readmax - buffered);
4991 else
4992 #endif
4993 nbytes = emacs_read (channel, chars + carryover + buffered,
4994 readmax - buffered);
4995 #ifdef ADAPTIVE_READ_BUFFERING
4996 if (nbytes > 0 && p->adaptive_read_buffering)
4998 int delay = p->read_output_delay;
4999 if (nbytes < 256)
5001 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5003 if (delay == 0)
5004 process_output_delay_count++;
5005 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5008 else if (delay > 0 && nbytes == readmax - buffered)
5010 delay -= READ_OUTPUT_DELAY_INCREMENT;
5011 if (delay == 0)
5012 process_output_delay_count--;
5014 p->read_output_delay = delay;
5015 if (delay)
5017 p->read_output_skip = 1;
5018 process_output_skip = 1;
5021 #endif
5022 nbytes += buffered;
5023 nbytes += buffered && nbytes <= 0;
5026 p->decoding_carryover = 0;
5028 /* At this point, NBYTES holds number of bytes just received
5029 (including the one in proc_buffered_char[channel]). */
5030 if (nbytes <= 0)
5032 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5033 return nbytes;
5034 coding->mode |= CODING_MODE_LAST_BLOCK;
5037 /* Now set NBYTES how many bytes we must decode. */
5038 nbytes += carryover;
5040 odeactivate = Vdeactivate_mark;
5041 /* There's no good reason to let process filters change the current
5042 buffer, and many callers of accept-process-output, sit-for, and
5043 friends don't expect current-buffer to be changed from under them. */
5044 record_unwind_current_buffer ();
5046 read_and_dispose_of_process_output (p, chars, nbytes, coding);
5048 /* Handling the process output should not deactivate the mark. */
5049 Vdeactivate_mark = odeactivate;
5051 unbind_to (count, Qnil);
5052 return nbytes;
5055 static void
5056 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5057 ssize_t nbytes,
5058 struct coding_system *coding)
5060 Lisp_Object outstream = p->filter;
5061 Lisp_Object text;
5062 bool outer_running_asynch_code = running_asynch_code;
5063 int waiting = waiting_for_user_input_p;
5065 /* No need to gcpro these, because all we do with them later
5066 is test them for EQness, and none of them should be a string. */
5067 #if 0
5068 Lisp_Object obuffer, okeymap;
5069 XSETBUFFER (obuffer, current_buffer);
5070 okeymap = BVAR (current_buffer, keymap);
5071 #endif
5073 /* We inhibit quit here instead of just catching it so that
5074 hitting ^G when a filter happens to be running won't screw
5075 it up. */
5076 specbind (Qinhibit_quit, Qt);
5077 specbind (Qlast_nonmenu_event, Qt);
5079 /* In case we get recursively called,
5080 and we already saved the match data nonrecursively,
5081 save the same match data in safely recursive fashion. */
5082 if (outer_running_asynch_code)
5084 Lisp_Object tem;
5085 /* Don't clobber the CURRENT match data, either! */
5086 tem = Fmatch_data (Qnil, Qnil, Qnil);
5087 restore_search_regs ();
5088 record_unwind_save_match_data ();
5089 Fset_match_data (tem, Qt);
5092 /* For speed, if a search happens within this code,
5093 save the match data in a special nonrecursive fashion. */
5094 running_asynch_code = 1;
5096 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5097 text = coding->dst_object;
5098 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5099 /* A new coding system might be found. */
5100 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5102 pset_decode_coding_system (p, Vlast_coding_system_used);
5104 /* Don't call setup_coding_system for
5105 proc_decode_coding_system[channel] here. It is done in
5106 detect_coding called via decode_coding above. */
5108 /* If a coding system for encoding is not yet decided, we set
5109 it as the same as coding-system for decoding.
5111 But, before doing that we must check if
5112 proc_encode_coding_system[p->outfd] surely points to a
5113 valid memory because p->outfd will be changed once EOF is
5114 sent to the process. */
5115 if (NILP (p->encode_coding_system)
5116 && proc_encode_coding_system[p->outfd])
5118 pset_encode_coding_system
5119 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5120 setup_coding_system (p->encode_coding_system,
5121 proc_encode_coding_system[p->outfd]);
5125 if (coding->carryover_bytes > 0)
5127 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5128 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5129 memcpy (SDATA (p->decoding_buf), coding->carryover,
5130 coding->carryover_bytes);
5131 p->decoding_carryover = coding->carryover_bytes;
5133 if (SBYTES (text) > 0)
5134 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5135 sometimes it's simply wrong to wrap (e.g. when called from
5136 accept-process-output). */
5137 internal_condition_case_1 (read_process_output_call,
5138 Fcons (outstream,
5139 Fcons (make_lisp_proc (p),
5140 Fcons (text, Qnil))),
5141 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5142 read_process_output_error_handler);
5144 /* If we saved the match data nonrecursively, restore it now. */
5145 restore_search_regs ();
5146 running_asynch_code = outer_running_asynch_code;
5148 /* Restore waiting_for_user_input_p as it was
5149 when we were called, in case the filter clobbered it. */
5150 waiting_for_user_input_p = waiting;
5152 #if 0 /* Call record_asynch_buffer_change unconditionally,
5153 because we might have changed minor modes or other things
5154 that affect key bindings. */
5155 if (! EQ (Fcurrent_buffer (), obuffer)
5156 || ! EQ (current_buffer->keymap, okeymap))
5157 #endif
5158 /* But do it only if the caller is actually going to read events.
5159 Otherwise there's no need to make him wake up, and it could
5160 cause trouble (for example it would make sit_for return). */
5161 if (waiting_for_user_input_p == -1)
5162 record_asynch_buffer_change ();
5165 DEFUN ("internal-default-process-filter", Finternal_default_process_filter,
5166 Sinternal_default_process_filter, 2, 2, 0,
5167 doc: /* Function used as default process filter. */)
5168 (Lisp_Object proc, Lisp_Object text)
5170 struct Lisp_Process *p;
5171 ptrdiff_t opoint;
5173 CHECK_PROCESS (proc);
5174 p = XPROCESS (proc);
5175 CHECK_STRING (text);
5177 if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5179 Lisp_Object old_read_only;
5180 ptrdiff_t old_begv, old_zv;
5181 ptrdiff_t old_begv_byte, old_zv_byte;
5182 ptrdiff_t before, before_byte;
5183 ptrdiff_t opoint_byte;
5184 struct buffer *b;
5186 Fset_buffer (p->buffer);
5187 opoint = PT;
5188 opoint_byte = PT_BYTE;
5189 old_read_only = BVAR (current_buffer, read_only);
5190 old_begv = BEGV;
5191 old_zv = ZV;
5192 old_begv_byte = BEGV_BYTE;
5193 old_zv_byte = ZV_BYTE;
5195 bset_read_only (current_buffer, Qnil);
5197 /* Insert new output into buffer
5198 at the current end-of-output marker,
5199 thus preserving logical ordering of input and output. */
5200 if (XMARKER (p->mark)->buffer)
5201 SET_PT_BOTH (clip_to_bounds (BEGV,
5202 marker_position (p->mark), ZV),
5203 clip_to_bounds (BEGV_BYTE,
5204 marker_byte_position (p->mark),
5205 ZV_BYTE));
5206 else
5207 SET_PT_BOTH (ZV, ZV_BYTE);
5208 before = PT;
5209 before_byte = PT_BYTE;
5211 /* If the output marker is outside of the visible region, save
5212 the restriction and widen. */
5213 if (! (BEGV <= PT && PT <= ZV))
5214 Fwiden ();
5216 /* Adjust the multibyteness of TEXT to that of the buffer. */
5217 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5218 != ! STRING_MULTIBYTE (text))
5219 text = (STRING_MULTIBYTE (text)
5220 ? Fstring_as_unibyte (text)
5221 : Fstring_to_multibyte (text));
5222 /* Insert before markers in case we are inserting where
5223 the buffer's mark is, and the user's next command is Meta-y. */
5224 insert_from_string_before_markers (text, 0, 0,
5225 SCHARS (text), SBYTES (text), 0);
5227 /* Make sure the process marker's position is valid when the
5228 process buffer is changed in the signal_after_change above.
5229 W3 is known to do that. */
5230 if (BUFFERP (p->buffer)
5231 && (b = XBUFFER (p->buffer), b != current_buffer))
5232 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5233 else
5234 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5236 update_mode_lines++;
5238 /* Make sure opoint and the old restrictions
5239 float ahead of any new text just as point would. */
5240 if (opoint >= before)
5242 opoint += PT - before;
5243 opoint_byte += PT_BYTE - before_byte;
5245 if (old_begv > before)
5247 old_begv += PT - before;
5248 old_begv_byte += PT_BYTE - before_byte;
5250 if (old_zv >= before)
5252 old_zv += PT - before;
5253 old_zv_byte += PT_BYTE - before_byte;
5256 /* If the restriction isn't what it should be, set it. */
5257 if (old_begv != BEGV || old_zv != ZV)
5258 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5260 bset_read_only (current_buffer, old_read_only);
5261 SET_PT_BOTH (opoint, opoint_byte);
5263 return Qnil;
5266 /* Sending data to subprocess. */
5268 /* In send_process, when a write fails temporarily,
5269 wait_reading_process_output is called. It may execute user code,
5270 e.g. timers, that attempts to write new data to the same process.
5271 We must ensure that data is sent in the right order, and not
5272 interspersed half-completed with other writes (Bug#10815). This is
5273 handled by the write_queue element of struct process. It is a list
5274 with each entry having the form
5276 (string . (offset . length))
5278 where STRING is a lisp string, OFFSET is the offset into the
5279 string's byte sequence from which we should begin to send, and
5280 LENGTH is the number of bytes left to send. */
5282 /* Create a new entry in write_queue.
5283 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5284 BUF is a pointer to the string sequence of the input_obj or a C
5285 string in case of Qt or Qnil. */
5287 static void
5288 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5289 const char *buf, ptrdiff_t len, bool front)
5291 ptrdiff_t offset;
5292 Lisp_Object entry, obj;
5294 if (STRINGP (input_obj))
5296 offset = buf - SSDATA (input_obj);
5297 obj = input_obj;
5299 else
5301 offset = 0;
5302 obj = make_unibyte_string (buf, len);
5305 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5307 if (front)
5308 pset_write_queue (p, Fcons (entry, p->write_queue));
5309 else
5310 pset_write_queue (p, nconc2 (p->write_queue, Fcons (entry, Qnil)));
5313 /* Remove the first element in the write_queue of process P, put its
5314 contents in OBJ, BUF and LEN, and return true. If the
5315 write_queue is empty, return false. */
5317 static bool
5318 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5319 const char **buf, ptrdiff_t *len)
5321 Lisp_Object entry, offset_length;
5322 ptrdiff_t offset;
5324 if (NILP (p->write_queue))
5325 return 0;
5327 entry = XCAR (p->write_queue);
5328 pset_write_queue (p, XCDR (p->write_queue));
5330 *obj = XCAR (entry);
5331 offset_length = XCDR (entry);
5333 *len = XINT (XCDR (offset_length));
5334 offset = XINT (XCAR (offset_length));
5335 *buf = SSDATA (*obj) + offset;
5337 return 1;
5340 /* Send some data to process PROC.
5341 BUF is the beginning of the data; LEN is the number of characters.
5342 OBJECT is the Lisp object that the data comes from. If OBJECT is
5343 nil or t, it means that the data comes from C string.
5345 If OBJECT is not nil, the data is encoded by PROC's coding-system
5346 for encoding before it is sent.
5348 This function can evaluate Lisp code and can garbage collect. */
5350 static void
5351 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
5352 Lisp_Object object)
5354 struct Lisp_Process *p = XPROCESS (proc);
5355 ssize_t rv;
5356 struct coding_system *coding;
5358 if (p->raw_status_new)
5359 update_status (p);
5360 if (! EQ (p->status, Qrun))
5361 error ("Process %s not running", SDATA (p->name));
5362 if (p->outfd < 0)
5363 error ("Output file descriptor of %s is closed", SDATA (p->name));
5365 coding = proc_encode_coding_system[p->outfd];
5366 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5368 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5369 || (BUFFERP (object)
5370 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5371 || EQ (object, Qt))
5373 pset_encode_coding_system
5374 (p, complement_process_encoding_system (p->encode_coding_system));
5375 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5377 /* The coding system for encoding was changed to raw-text
5378 because we sent a unibyte text previously. Now we are
5379 sending a multibyte text, thus we must encode it by the
5380 original coding system specified for the current process.
5382 Another reason we come here is that the coding system
5383 was just complemented and a new one was returned by
5384 complement_process_encoding_system. */
5385 setup_coding_system (p->encode_coding_system, coding);
5386 Vlast_coding_system_used = p->encode_coding_system;
5388 coding->src_multibyte = 1;
5390 else
5392 coding->src_multibyte = 0;
5393 /* For sending a unibyte text, character code conversion should
5394 not take place but EOL conversion should. So, setup raw-text
5395 or one of the subsidiary if we have not yet done it. */
5396 if (CODING_REQUIRE_ENCODING (coding))
5398 if (CODING_REQUIRE_FLUSHING (coding))
5400 /* But, before changing the coding, we must flush out data. */
5401 coding->mode |= CODING_MODE_LAST_BLOCK;
5402 send_process (proc, "", 0, Qt);
5403 coding->mode &= CODING_MODE_LAST_BLOCK;
5405 setup_coding_system (raw_text_coding_system
5406 (Vlast_coding_system_used),
5407 coding);
5408 coding->src_multibyte = 0;
5411 coding->dst_multibyte = 0;
5413 if (CODING_REQUIRE_ENCODING (coding))
5415 coding->dst_object = Qt;
5416 if (BUFFERP (object))
5418 ptrdiff_t from_byte, from, to;
5419 ptrdiff_t save_pt, save_pt_byte;
5420 struct buffer *cur = current_buffer;
5422 set_buffer_internal (XBUFFER (object));
5423 save_pt = PT, save_pt_byte = PT_BYTE;
5425 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5426 from = BYTE_TO_CHAR (from_byte);
5427 to = BYTE_TO_CHAR (from_byte + len);
5428 TEMP_SET_PT_BOTH (from, from_byte);
5429 encode_coding_object (coding, object, from, from_byte,
5430 to, from_byte + len, Qt);
5431 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5432 set_buffer_internal (cur);
5434 else if (STRINGP (object))
5436 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5437 SBYTES (object), Qt);
5439 else
5441 coding->dst_object = make_unibyte_string (buf, len);
5442 coding->produced = len;
5445 len = coding->produced;
5446 object = coding->dst_object;
5447 buf = SSDATA (object);
5450 /* If there is already data in the write_queue, put the new data
5451 in the back of queue. Otherwise, ignore it. */
5452 if (!NILP (p->write_queue))
5453 write_queue_push (p, object, buf, len, 0);
5455 do /* while !NILP (p->write_queue) */
5457 ptrdiff_t cur_len = -1;
5458 const char *cur_buf;
5459 Lisp_Object cur_object;
5461 /* If write_queue is empty, ignore it. */
5462 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5464 cur_len = len;
5465 cur_buf = buf;
5466 cur_object = object;
5469 while (cur_len > 0)
5471 /* Send this batch, using one or more write calls. */
5472 ptrdiff_t written = 0;
5473 int outfd = p->outfd;
5474 #ifdef DATAGRAM_SOCKETS
5475 if (DATAGRAM_CHAN_P (outfd))
5477 rv = sendto (outfd, cur_buf, cur_len,
5478 0, datagram_address[outfd].sa,
5479 datagram_address[outfd].len);
5480 if (rv >= 0)
5481 written = rv;
5482 else if (errno == EMSGSIZE)
5483 report_file_error ("sending datagram", Fcons (proc, Qnil));
5485 else
5486 #endif
5488 #ifdef HAVE_GNUTLS
5489 if (p->gnutls_p)
5490 written = emacs_gnutls_write (p, cur_buf, cur_len);
5491 else
5492 #endif
5493 written = emacs_write (outfd, cur_buf, cur_len);
5494 rv = (written ? 0 : -1);
5495 #ifdef ADAPTIVE_READ_BUFFERING
5496 if (p->read_output_delay > 0
5497 && p->adaptive_read_buffering == 1)
5499 p->read_output_delay = 0;
5500 process_output_delay_count--;
5501 p->read_output_skip = 0;
5503 #endif
5506 if (rv < 0)
5508 if (errno == EAGAIN
5509 #ifdef EWOULDBLOCK
5510 || errno == EWOULDBLOCK
5511 #endif
5513 /* Buffer is full. Wait, accepting input;
5514 that may allow the program
5515 to finish doing output and read more. */
5517 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5518 /* A gross hack to work around a bug in FreeBSD.
5519 In the following sequence, read(2) returns
5520 bogus data:
5522 write(2) 1022 bytes
5523 write(2) 954 bytes, get EAGAIN
5524 read(2) 1024 bytes in process_read_output
5525 read(2) 11 bytes in process_read_output
5527 That is, read(2) returns more bytes than have
5528 ever been written successfully. The 1033 bytes
5529 read are the 1022 bytes written successfully
5530 after processing (for example with CRs added if
5531 the terminal is set up that way which it is
5532 here). The same bytes will be seen again in a
5533 later read(2), without the CRs. */
5535 if (errno == EAGAIN)
5537 int flags = FWRITE;
5538 ioctl (p->outfd, TIOCFLUSH, &flags);
5540 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5542 /* Put what we should have written in wait_queue. */
5543 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5544 wait_reading_process_output (0, 20 * 1000 * 1000,
5545 0, 0, Qnil, NULL, 0);
5546 /* Reread queue, to see what is left. */
5547 break;
5549 else if (errno == EPIPE)
5551 p->raw_status_new = 0;
5552 pset_status (p, list2 (Qexit, make_number (256)));
5553 p->tick = ++process_tick;
5554 deactivate_process (proc);
5555 error ("process %s no longer connected to pipe; closed it",
5556 SDATA (p->name));
5558 else
5559 /* This is a real error. */
5560 report_file_error ("writing to process", Fcons (proc, Qnil));
5562 cur_buf += written;
5563 cur_len -= written;
5566 while (!NILP (p->write_queue));
5569 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5570 3, 3, 0,
5571 doc: /* Send current contents of region as input to PROCESS.
5572 PROCESS may be a process, a buffer, the name of a process or buffer, or
5573 nil, indicating the current buffer's process.
5574 Called from program, takes three arguments, PROCESS, START and END.
5575 If the region is more than 500 characters long,
5576 it is sent in several bunches. This may happen even for shorter regions.
5577 Output from processes can arrive in between bunches. */)
5578 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5580 Lisp_Object proc = get_process (process);
5581 ptrdiff_t start_byte, end_byte;
5583 validate_region (&start, &end);
5585 start_byte = CHAR_TO_BYTE (XINT (start));
5586 end_byte = CHAR_TO_BYTE (XINT (end));
5588 if (XINT (start) < GPT && XINT (end) > GPT)
5589 move_gap_both (XINT (start), start_byte);
5591 send_process (proc, (char *) BYTE_POS_ADDR (start_byte),
5592 end_byte - start_byte, Fcurrent_buffer ());
5594 return Qnil;
5597 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5598 2, 2, 0,
5599 doc: /* Send PROCESS the contents of STRING as input.
5600 PROCESS may be a process, a buffer, the name of a process or buffer, or
5601 nil, indicating the current buffer's process.
5602 If STRING is more than 500 characters long,
5603 it is sent in several bunches. This may happen even for shorter strings.
5604 Output from processes can arrive in between bunches. */)
5605 (Lisp_Object process, Lisp_Object string)
5607 Lisp_Object proc;
5608 CHECK_STRING (string);
5609 proc = get_process (process);
5610 send_process (proc, SSDATA (string),
5611 SBYTES (string), string);
5612 return Qnil;
5615 /* Return the foreground process group for the tty/pty that
5616 the process P uses. */
5617 static pid_t
5618 emacs_get_tty_pgrp (struct Lisp_Process *p)
5620 pid_t gid = -1;
5622 #ifdef TIOCGPGRP
5623 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5625 int fd;
5626 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5627 master side. Try the slave side. */
5628 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5630 if (fd != -1)
5632 ioctl (fd, TIOCGPGRP, &gid);
5633 emacs_close (fd);
5636 #endif /* defined (TIOCGPGRP ) */
5638 return gid;
5641 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5642 Sprocess_running_child_p, 0, 1, 0,
5643 doc: /* Return t if PROCESS has given the terminal to a child.
5644 If the operating system does not make it possible to find out,
5645 return t unconditionally. */)
5646 (Lisp_Object process)
5648 /* Initialize in case ioctl doesn't exist or gives an error,
5649 in a way that will cause returning t. */
5650 pid_t gid;
5651 Lisp_Object proc;
5652 struct Lisp_Process *p;
5654 proc = get_process (process);
5655 p = XPROCESS (proc);
5657 if (!EQ (p->type, Qreal))
5658 error ("Process %s is not a subprocess",
5659 SDATA (p->name));
5660 if (p->infd < 0)
5661 error ("Process %s is not active",
5662 SDATA (p->name));
5664 gid = emacs_get_tty_pgrp (p);
5666 if (gid == p->pid)
5667 return Qnil;
5668 return Qt;
5671 /* send a signal number SIGNO to PROCESS.
5672 If CURRENT_GROUP is t, that means send to the process group
5673 that currently owns the terminal being used to communicate with PROCESS.
5674 This is used for various commands in shell mode.
5675 If CURRENT_GROUP is lambda, that means send to the process group
5676 that currently owns the terminal, but only if it is NOT the shell itself.
5678 If NOMSG is false, insert signal-announcements into process's buffers
5679 right away.
5681 If we can, we try to signal PROCESS by sending control characters
5682 down the pty. This allows us to signal inferiors who have changed
5683 their uid, for which kill would return an EPERM error. */
5685 static void
5686 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5687 bool nomsg)
5689 Lisp_Object proc;
5690 struct Lisp_Process *p;
5691 pid_t gid;
5692 bool no_pgrp = 0;
5694 proc = get_process (process);
5695 p = XPROCESS (proc);
5697 if (!EQ (p->type, Qreal))
5698 error ("Process %s is not a subprocess",
5699 SDATA (p->name));
5700 if (p->infd < 0)
5701 error ("Process %s is not active",
5702 SDATA (p->name));
5704 if (!p->pty_flag)
5705 current_group = Qnil;
5707 /* If we are using pgrps, get a pgrp number and make it negative. */
5708 if (NILP (current_group))
5709 /* Send the signal to the shell's process group. */
5710 gid = p->pid;
5711 else
5713 #ifdef SIGNALS_VIA_CHARACTERS
5714 /* If possible, send signals to the entire pgrp
5715 by sending an input character to it. */
5717 struct termios t;
5718 cc_t *sig_char = NULL;
5720 tcgetattr (p->infd, &t);
5722 switch (signo)
5724 case SIGINT:
5725 sig_char = &t.c_cc[VINTR];
5726 break;
5728 case SIGQUIT:
5729 sig_char = &t.c_cc[VQUIT];
5730 break;
5732 case SIGTSTP:
5733 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5734 sig_char = &t.c_cc[VSWTCH];
5735 #else
5736 sig_char = &t.c_cc[VSUSP];
5737 #endif
5738 break;
5741 if (sig_char && *sig_char != CDISABLE)
5743 send_process (proc, (char *) sig_char, 1, Qnil);
5744 return;
5746 /* If we can't send the signal with a character,
5747 fall through and send it another way. */
5749 /* The code above may fall through if it can't
5750 handle the signal. */
5751 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5753 #ifdef TIOCGPGRP
5754 /* Get the current pgrp using the tty itself, if we have that.
5755 Otherwise, use the pty to get the pgrp.
5756 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5757 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5758 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5759 His patch indicates that if TIOCGPGRP returns an error, then
5760 we should just assume that p->pid is also the process group id. */
5762 gid = emacs_get_tty_pgrp (p);
5764 if (gid == -1)
5765 /* If we can't get the information, assume
5766 the shell owns the tty. */
5767 gid = p->pid;
5769 /* It is not clear whether anything really can set GID to -1.
5770 Perhaps on some system one of those ioctls can or could do so.
5771 Or perhaps this is vestigial. */
5772 if (gid == -1)
5773 no_pgrp = 1;
5774 #else /* ! defined (TIOCGPGRP ) */
5775 /* Can't select pgrps on this system, so we know that
5776 the child itself heads the pgrp. */
5777 gid = p->pid;
5778 #endif /* ! defined (TIOCGPGRP ) */
5780 /* If current_group is lambda, and the shell owns the terminal,
5781 don't send any signal. */
5782 if (EQ (current_group, Qlambda) && gid == p->pid)
5783 return;
5786 switch (signo)
5788 #ifdef SIGCONT
5789 case SIGCONT:
5790 p->raw_status_new = 0;
5791 pset_status (p, Qrun);
5792 p->tick = ++process_tick;
5793 if (!nomsg)
5795 status_notify (NULL);
5796 redisplay_preserve_echo_area (13);
5798 break;
5799 #endif /* ! defined (SIGCONT) */
5800 case SIGINT:
5801 case SIGQUIT:
5802 case SIGKILL:
5803 flush_pending_output (p->infd);
5804 break;
5807 /* If we don't have process groups, send the signal to the immediate
5808 subprocess. That isn't really right, but it's better than any
5809 obvious alternative. */
5810 if (no_pgrp)
5812 kill (p->pid, signo);
5813 return;
5816 /* gid may be a pid, or minus a pgrp's number */
5817 #ifdef TIOCSIGSEND
5818 if (!NILP (current_group))
5820 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5821 kill (-gid, signo);
5823 else
5825 gid = - p->pid;
5826 kill (gid, signo);
5828 #else /* ! defined (TIOCSIGSEND) */
5829 kill (-gid, signo);
5830 #endif /* ! defined (TIOCSIGSEND) */
5833 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5834 doc: /* Interrupt process PROCESS.
5835 PROCESS may be a process, a buffer, or the name of a process or buffer.
5836 No arg or nil means current buffer's process.
5837 Second arg CURRENT-GROUP non-nil means send signal to
5838 the current process-group of the process's controlling terminal
5839 rather than to the process's own process group.
5840 If the process is a shell, this means interrupt current subjob
5841 rather than the shell.
5843 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5844 don't send the signal. */)
5845 (Lisp_Object process, Lisp_Object current_group)
5847 process_send_signal (process, SIGINT, current_group, 0);
5848 return process;
5851 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5852 doc: /* Kill process PROCESS. May be process or name of one.
5853 See function `interrupt-process' for more details on usage. */)
5854 (Lisp_Object process, Lisp_Object current_group)
5856 process_send_signal (process, SIGKILL, current_group, 0);
5857 return process;
5860 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5861 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5862 See function `interrupt-process' for more details on usage. */)
5863 (Lisp_Object process, Lisp_Object current_group)
5865 process_send_signal (process, SIGQUIT, current_group, 0);
5866 return process;
5869 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
5870 doc: /* Stop process PROCESS. May be process or name of one.
5871 See function `interrupt-process' for more details on usage.
5872 If PROCESS is a network or serial process, inhibit handling of incoming
5873 traffic. */)
5874 (Lisp_Object process, Lisp_Object current_group)
5876 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5878 struct Lisp_Process *p;
5880 p = XPROCESS (process);
5881 if (NILP (p->command)
5882 && p->infd >= 0)
5884 FD_CLR (p->infd, &input_wait_mask);
5885 FD_CLR (p->infd, &non_keyboard_wait_mask);
5887 pset_command (p, Qt);
5888 return process;
5890 #ifndef SIGTSTP
5891 error ("No SIGTSTP support");
5892 #else
5893 process_send_signal (process, SIGTSTP, current_group, 0);
5894 #endif
5895 return process;
5898 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
5899 doc: /* Continue process PROCESS. May be process or name of one.
5900 See function `interrupt-process' for more details on usage.
5901 If PROCESS is a network or serial process, resume handling of incoming
5902 traffic. */)
5903 (Lisp_Object process, Lisp_Object current_group)
5905 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5907 struct Lisp_Process *p;
5909 p = XPROCESS (process);
5910 if (EQ (p->command, Qt)
5911 && p->infd >= 0
5912 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
5914 FD_SET (p->infd, &input_wait_mask);
5915 FD_SET (p->infd, &non_keyboard_wait_mask);
5916 #ifdef WINDOWSNT
5917 if (fd_info[ p->infd ].flags & FILE_SERIAL)
5918 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
5919 #else /* not WINDOWSNT */
5920 tcflush (p->infd, TCIFLUSH);
5921 #endif /* not WINDOWSNT */
5923 pset_command (p, Qnil);
5924 return process;
5926 #ifdef SIGCONT
5927 process_send_signal (process, SIGCONT, current_group, 0);
5928 #else
5929 error ("No SIGCONT support");
5930 #endif
5931 return process;
5934 /* Return the integer value of the signal whose abbreviation is ABBR,
5935 or a negative number if there is no such signal. */
5936 static int
5937 abbr_to_signal (char const *name)
5939 int i, signo;
5940 char sigbuf[20]; /* Large enough for all valid signal abbreviations. */
5942 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
5943 name += 3;
5945 for (i = 0; i < sizeof sigbuf; i++)
5947 sigbuf[i] = c_toupper (name[i]);
5948 if (! sigbuf[i])
5949 return str2sig (sigbuf, &signo) == 0 ? signo : -1;
5952 return -1;
5955 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
5956 2, 2, "sProcess (name or number): \nnSignal code: ",
5957 doc: /* Send PROCESS the signal with code SIGCODE.
5958 PROCESS may also be a number specifying the process id of the
5959 process to signal; in this case, the process need not be a child of
5960 this Emacs.
5961 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
5962 (Lisp_Object process, Lisp_Object sigcode)
5964 pid_t pid;
5965 int signo;
5967 if (STRINGP (process))
5969 Lisp_Object tem = Fget_process (process);
5970 if (NILP (tem))
5972 Lisp_Object process_number =
5973 string_to_number (SSDATA (process), 10, 1);
5974 if (INTEGERP (process_number) || FLOATP (process_number))
5975 tem = process_number;
5977 process = tem;
5979 else if (!NUMBERP (process))
5980 process = get_process (process);
5982 if (NILP (process))
5983 return process;
5985 if (NUMBERP (process))
5986 CONS_TO_INTEGER (process, pid_t, pid);
5987 else
5989 CHECK_PROCESS (process);
5990 pid = XPROCESS (process)->pid;
5991 if (pid <= 0)
5992 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
5995 if (INTEGERP (sigcode))
5997 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
5998 signo = XINT (sigcode);
6000 else
6002 char *name;
6004 CHECK_SYMBOL (sigcode);
6005 name = SSDATA (SYMBOL_NAME (sigcode));
6007 signo = abbr_to_signal (name);
6008 if (signo < 0)
6009 error ("Undefined signal name %s", name);
6012 return make_number (kill (pid, signo));
6015 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6016 doc: /* Make PROCESS see end-of-file in its input.
6017 EOF comes after any text already sent to it.
6018 PROCESS may be a process, a buffer, the name of a process or buffer, or
6019 nil, indicating the current buffer's process.
6020 If PROCESS is a network connection, or is a process communicating
6021 through a pipe (as opposed to a pty), then you cannot send any more
6022 text to PROCESS after you call this function.
6023 If PROCESS is a serial process, wait until all output written to the
6024 process has been transmitted to the serial port. */)
6025 (Lisp_Object process)
6027 Lisp_Object proc;
6028 struct coding_system *coding;
6030 if (DATAGRAM_CONN_P (process))
6031 return process;
6033 proc = get_process (process);
6034 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6036 /* Make sure the process is really alive. */
6037 if (XPROCESS (proc)->raw_status_new)
6038 update_status (XPROCESS (proc));
6039 if (! EQ (XPROCESS (proc)->status, Qrun))
6040 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6042 if (CODING_REQUIRE_FLUSHING (coding))
6044 coding->mode |= CODING_MODE_LAST_BLOCK;
6045 send_process (proc, "", 0, Qnil);
6048 if (XPROCESS (proc)->pty_flag)
6049 send_process (proc, "\004", 1, Qnil);
6050 else if (EQ (XPROCESS (proc)->type, Qserial))
6052 #ifndef WINDOWSNT
6053 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6054 error ("tcdrain() failed: %s", emacs_strerror (errno));
6055 #endif /* not WINDOWSNT */
6056 /* Do nothing on Windows because writes are blocking. */
6058 else
6060 int old_outfd, new_outfd;
6062 #ifdef HAVE_SHUTDOWN
6063 /* If this is a network connection, or socketpair is used
6064 for communication with the subprocess, call shutdown to cause EOF.
6065 (In some old system, shutdown to socketpair doesn't work.
6066 Then we just can't win.) */
6067 if (EQ (XPROCESS (proc)->type, Qnetwork)
6068 || XPROCESS (proc)->outfd == XPROCESS (proc)->infd)
6069 shutdown (XPROCESS (proc)->outfd, 1);
6070 /* In case of socketpair, outfd == infd, so don't close it. */
6071 if (XPROCESS (proc)->outfd != XPROCESS (proc)->infd)
6072 emacs_close (XPROCESS (proc)->outfd);
6073 #else /* not HAVE_SHUTDOWN */
6074 emacs_close (XPROCESS (proc)->outfd);
6075 #endif /* not HAVE_SHUTDOWN */
6076 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6077 if (new_outfd < 0)
6078 emacs_abort ();
6079 old_outfd = XPROCESS (proc)->outfd;
6081 if (!proc_encode_coding_system[new_outfd])
6082 proc_encode_coding_system[new_outfd]
6083 = xmalloc (sizeof (struct coding_system));
6084 *proc_encode_coding_system[new_outfd]
6085 = *proc_encode_coding_system[old_outfd];
6086 memset (proc_encode_coding_system[old_outfd], 0,
6087 sizeof (struct coding_system));
6089 XPROCESS (proc)->outfd = new_outfd;
6091 return process;
6094 /* The main Emacs thread records child processes in three places:
6096 - Vprocess_alist, for asynchronous subprocesses, which are child
6097 processes visible to Lisp.
6099 - deleted_pid_list, for child processes invisible to Lisp,
6100 typically because of delete-process. These are recorded so that
6101 the processes can be reaped when they exit, so that the operating
6102 system's process table is not cluttered by zombies.
6104 - the local variable PID in Fcall_process, call_process_cleanup and
6105 call_process_kill, for synchronous subprocesses.
6106 record_unwind_protect is used to make sure this process is not
6107 forgotten: if the user interrupts call-process and the child
6108 process refuses to exit immediately even with two C-g's,
6109 call_process_kill adds PID's contents to deleted_pid_list before
6110 returning.
6112 The main Emacs thread invokes waitpid only on child processes that
6113 it creates and that have not been reaped. This avoid races on
6114 platforms such as GTK, where other threads create their own
6115 subprocesses which the main thread should not reap. For example,
6116 if the main thread attempted to reap an already-reaped child, it
6117 might inadvertently reap a GTK-created process that happened to
6118 have the same process ID. */
6120 /* LIB_CHILD_HANDLER is a SIGCHLD handler that Emacs calls while doing
6121 its own SIGCHLD handling. On POSIXish systems, glib needs this to
6122 keep track of its own children. GNUstep is similar. */
6124 static void dummy_handler (int sig) {}
6125 static signal_handler_t volatile lib_child_handler;
6127 /* Handle a SIGCHLD signal by looking for known child processes of
6128 Emacs whose status have changed. For each one found, record its
6129 new status.
6131 All we do is change the status; we do not run sentinels or print
6132 notifications. That is saved for the next time keyboard input is
6133 done, in order to avoid timing errors.
6135 ** WARNING: this can be called during garbage collection.
6136 Therefore, it must not be fooled by the presence of mark bits in
6137 Lisp objects.
6139 ** USG WARNING: Although it is not obvious from the documentation
6140 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6141 signal() before executing at least one wait(), otherwise the
6142 handler will be called again, resulting in an infinite loop. The
6143 relevant portion of the documentation reads "SIGCLD signals will be
6144 queued and the signal-catching function will be continually
6145 reentered until the queue is empty". Invoking signal() causes the
6146 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6147 Inc.
6149 ** Malloc WARNING: This should never call malloc either directly or
6150 indirectly; if it does, that is a bug */
6152 static void
6153 handle_child_signal (int sig)
6155 Lisp_Object tail;
6157 /* Find the process that signaled us, and record its status. */
6159 /* The process can have been deleted by Fdelete_process, or have
6160 been started asynchronously by Fcall_process. */
6161 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6163 bool all_pids_are_fixnums
6164 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
6165 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
6166 Lisp_Object xpid = XCAR (tail);
6167 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
6169 pid_t deleted_pid;
6170 if (INTEGERP (xpid))
6171 deleted_pid = XINT (xpid);
6172 else
6173 deleted_pid = XFLOAT_DATA (xpid);
6174 if (child_status_changed (deleted_pid, 0, 0))
6175 XSETCAR (tail, Qnil);
6179 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6180 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6182 Lisp_Object proc = XCDR (XCAR (tail));
6183 struct Lisp_Process *p = XPROCESS (proc);
6184 int status;
6186 if (p->alive
6187 && child_status_changed (p->pid, &status, WUNTRACED | WCONTINUED))
6189 /* Change the status of the process that was found. */
6190 p->tick = ++process_tick;
6191 p->raw_status = status;
6192 p->raw_status_new = 1;
6194 /* If process has terminated, stop waiting for its output. */
6195 if (WIFSIGNALED (status) || WIFEXITED (status))
6197 bool clear_desc_flag = 0;
6198 p->alive = 0;
6199 if (p->infd >= 0)
6200 clear_desc_flag = 1;
6202 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
6203 if (clear_desc_flag)
6205 FD_CLR (p->infd, &input_wait_mask);
6206 FD_CLR (p->infd, &non_keyboard_wait_mask);
6212 lib_child_handler (sig);
6215 static void
6216 deliver_child_signal (int sig)
6218 deliver_process_signal (sig, handle_child_signal);
6222 static Lisp_Object
6223 exec_sentinel_error_handler (Lisp_Object error_val)
6225 cmd_error_internal (error_val, "error in process sentinel: ");
6226 Vinhibit_quit = Qt;
6227 update_echo_area ();
6228 Fsleep_for (make_number (2), Qnil);
6229 return Qt;
6232 static void
6233 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6235 Lisp_Object sentinel, odeactivate;
6236 struct Lisp_Process *p = XPROCESS (proc);
6237 ptrdiff_t count = SPECPDL_INDEX ();
6238 bool outer_running_asynch_code = running_asynch_code;
6239 int waiting = waiting_for_user_input_p;
6241 if (inhibit_sentinels)
6242 return;
6244 /* No need to gcpro these, because all we do with them later
6245 is test them for EQness, and none of them should be a string. */
6246 odeactivate = Vdeactivate_mark;
6247 #if 0
6248 Lisp_Object obuffer, okeymap;
6249 XSETBUFFER (obuffer, current_buffer);
6250 okeymap = BVAR (current_buffer, keymap);
6251 #endif
6253 /* There's no good reason to let sentinels change the current
6254 buffer, and many callers of accept-process-output, sit-for, and
6255 friends don't expect current-buffer to be changed from under them. */
6256 record_unwind_current_buffer ();
6258 sentinel = p->sentinel;
6260 /* Inhibit quit so that random quits don't screw up a running filter. */
6261 specbind (Qinhibit_quit, Qt);
6262 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6264 /* In case we get recursively called,
6265 and we already saved the match data nonrecursively,
6266 save the same match data in safely recursive fashion. */
6267 if (outer_running_asynch_code)
6269 Lisp_Object tem;
6270 tem = Fmatch_data (Qnil, Qnil, Qnil);
6271 restore_search_regs ();
6272 record_unwind_save_match_data ();
6273 Fset_match_data (tem, Qt);
6276 /* For speed, if a search happens within this code,
6277 save the match data in a special nonrecursive fashion. */
6278 running_asynch_code = 1;
6280 internal_condition_case_1 (read_process_output_call,
6281 Fcons (sentinel,
6282 Fcons (proc, Fcons (reason, Qnil))),
6283 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6284 exec_sentinel_error_handler);
6286 /* If we saved the match data nonrecursively, restore it now. */
6287 restore_search_regs ();
6288 running_asynch_code = outer_running_asynch_code;
6290 Vdeactivate_mark = odeactivate;
6292 /* Restore waiting_for_user_input_p as it was
6293 when we were called, in case the filter clobbered it. */
6294 waiting_for_user_input_p = waiting;
6296 #if 0
6297 if (! EQ (Fcurrent_buffer (), obuffer)
6298 || ! EQ (current_buffer->keymap, okeymap))
6299 #endif
6300 /* But do it only if the caller is actually going to read events.
6301 Otherwise there's no need to make him wake up, and it could
6302 cause trouble (for example it would make sit_for return). */
6303 if (waiting_for_user_input_p == -1)
6304 record_asynch_buffer_change ();
6306 unbind_to (count, Qnil);
6309 /* Report all recent events of a change in process status
6310 (either run the sentinel or output a message).
6311 This is usually done while Emacs is waiting for keyboard input
6312 but can be done at other times. */
6314 static void
6315 status_notify (struct Lisp_Process *deleting_process)
6317 register Lisp_Object proc;
6318 Lisp_Object tail, msg;
6319 struct gcpro gcpro1, gcpro2;
6321 tail = Qnil;
6322 msg = Qnil;
6323 /* We need to gcpro tail; if read_process_output calls a filter
6324 which deletes a process and removes the cons to which tail points
6325 from Vprocess_alist, and then causes a GC, tail is an unprotected
6326 reference. */
6327 GCPRO2 (tail, msg);
6329 /* Set this now, so that if new processes are created by sentinels
6330 that we run, we get called again to handle their status changes. */
6331 update_tick = process_tick;
6333 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6335 Lisp_Object symbol;
6336 register struct Lisp_Process *p;
6338 proc = Fcdr (XCAR (tail));
6339 p = XPROCESS (proc);
6341 if (p->tick != p->update_tick)
6343 p->update_tick = p->tick;
6345 /* If process is still active, read any output that remains. */
6346 while (! EQ (p->filter, Qt)
6347 && ! EQ (p->status, Qconnect)
6348 && ! EQ (p->status, Qlisten)
6349 /* Network or serial process not stopped: */
6350 && ! EQ (p->command, Qt)
6351 && p->infd >= 0
6352 && p != deleting_process
6353 && read_process_output (proc, p->infd) > 0);
6355 /* Get the text to use for the message. */
6356 if (p->raw_status_new)
6357 update_status (p);
6358 msg = status_message (p);
6360 /* If process is terminated, deactivate it or delete it. */
6361 symbol = p->status;
6362 if (CONSP (p->status))
6363 symbol = XCAR (p->status);
6365 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6366 || EQ (symbol, Qclosed))
6368 if (delete_exited_processes)
6369 remove_process (proc);
6370 else
6371 deactivate_process (proc);
6374 /* The actions above may have further incremented p->tick.
6375 So set p->update_tick again so that an error in the sentinel will
6376 not cause this code to be run again. */
6377 p->update_tick = p->tick;
6378 /* Now output the message suitably. */
6379 exec_sentinel (proc, msg);
6381 } /* end for */
6383 update_mode_lines++; /* In case buffers use %s in mode-line-format. */
6384 UNGCPRO;
6387 DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel,
6388 Sinternal_default_process_sentinel, 2, 2, 0,
6389 doc: /* Function used as default sentinel for processes. */)
6390 (Lisp_Object proc, Lisp_Object msg)
6392 Lisp_Object buffer, symbol;
6393 struct Lisp_Process *p;
6394 CHECK_PROCESS (proc);
6395 p = XPROCESS (proc);
6396 buffer = p->buffer;
6397 symbol = p->status;
6398 if (CONSP (symbol))
6399 symbol = XCAR (symbol);
6401 if (!EQ (symbol, Qrun) && !NILP (buffer))
6403 Lisp_Object tem;
6404 struct buffer *old = current_buffer;
6405 ptrdiff_t opoint, opoint_byte;
6406 ptrdiff_t before, before_byte;
6408 /* Avoid error if buffer is deleted
6409 (probably that's why the process is dead, too). */
6410 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
6411 return Qnil;
6412 Fset_buffer (buffer);
6414 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
6415 msg = (code_convert_string_norecord
6416 (msg, Vlocale_coding_system, 1));
6418 opoint = PT;
6419 opoint_byte = PT_BYTE;
6420 /* Insert new output into buffer
6421 at the current end-of-output marker,
6422 thus preserving logical ordering of input and output. */
6423 if (XMARKER (p->mark)->buffer)
6424 Fgoto_char (p->mark);
6425 else
6426 SET_PT_BOTH (ZV, ZV_BYTE);
6428 before = PT;
6429 before_byte = PT_BYTE;
6431 tem = BVAR (current_buffer, read_only);
6432 bset_read_only (current_buffer, Qnil);
6433 insert_string ("\nProcess ");
6434 { /* FIXME: temporary kludge. */
6435 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
6436 insert_string (" ");
6437 Finsert (1, &msg);
6438 bset_read_only (current_buffer, tem);
6439 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6441 if (opoint >= before)
6442 SET_PT_BOTH (opoint + (PT - before),
6443 opoint_byte + (PT_BYTE - before_byte));
6444 else
6445 SET_PT_BOTH (opoint, opoint_byte);
6447 set_buffer_internal (old);
6449 return Qnil;
6453 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6454 Sset_process_coding_system, 1, 3, 0,
6455 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6456 DECODING will be used to decode subprocess output and ENCODING to
6457 encode subprocess input. */)
6458 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6460 register struct Lisp_Process *p;
6462 CHECK_PROCESS (process);
6463 p = XPROCESS (process);
6464 if (p->infd < 0)
6465 error ("Input file descriptor of %s closed", SDATA (p->name));
6466 if (p->outfd < 0)
6467 error ("Output file descriptor of %s closed", SDATA (p->name));
6468 Fcheck_coding_system (decoding);
6469 Fcheck_coding_system (encoding);
6470 encoding = coding_inherit_eol_type (encoding, Qnil);
6471 pset_decode_coding_system (p, decoding);
6472 pset_encode_coding_system (p, encoding);
6473 setup_process_coding_systems (process);
6475 return Qnil;
6478 DEFUN ("process-coding-system",
6479 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6480 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6481 (register Lisp_Object process)
6483 CHECK_PROCESS (process);
6484 return Fcons (XPROCESS (process)->decode_coding_system,
6485 XPROCESS (process)->encode_coding_system);
6488 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6489 Sset_process_filter_multibyte, 2, 2, 0,
6490 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6491 If FLAG is non-nil, the filter is given multibyte strings.
6492 If FLAG is nil, the filter is given unibyte strings. In this case,
6493 all character code conversion except for end-of-line conversion is
6494 suppressed. */)
6495 (Lisp_Object process, Lisp_Object flag)
6497 register struct Lisp_Process *p;
6499 CHECK_PROCESS (process);
6500 p = XPROCESS (process);
6501 if (NILP (flag))
6502 pset_decode_coding_system
6503 (p, raw_text_coding_system (p->decode_coding_system));
6504 setup_process_coding_systems (process);
6506 return Qnil;
6509 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6510 Sprocess_filter_multibyte_p, 1, 1, 0,
6511 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6512 (Lisp_Object process)
6514 register struct Lisp_Process *p;
6515 struct coding_system *coding;
6517 CHECK_PROCESS (process);
6518 p = XPROCESS (process);
6519 coding = proc_decode_coding_system[p->infd];
6520 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6526 # ifdef HAVE_GPM
6528 void
6529 add_gpm_wait_descriptor (int desc)
6531 add_keyboard_wait_descriptor (desc);
6534 void
6535 delete_gpm_wait_descriptor (int desc)
6537 delete_keyboard_wait_descriptor (desc);
6540 # endif
6542 # ifdef USABLE_SIGIO
6544 /* Return true if *MASK has a bit set
6545 that corresponds to one of the keyboard input descriptors. */
6547 static bool
6548 keyboard_bit_set (fd_set *mask)
6550 int fd;
6552 for (fd = 0; fd <= max_input_desc; fd++)
6553 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6554 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6555 return 1;
6557 return 0;
6559 # endif
6561 #else /* not subprocesses */
6563 /* Defined on msdos.c. */
6564 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
6565 EMACS_TIME *, void *);
6567 /* Implementation of wait_reading_process_output, assuming that there
6568 are no subprocesses. Used only by the MS-DOS build.
6570 Wait for timeout to elapse and/or keyboard input to be available.
6572 TIME_LIMIT is:
6573 timeout in seconds
6574 If negative, gobble data immediately available but don't wait for any.
6576 NSECS is:
6577 an additional duration to wait, measured in nanoseconds
6578 If TIME_LIMIT is zero, then:
6579 If NSECS == 0, there is no limit.
6580 If NSECS > 0, the timeout consists of NSECS only.
6581 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6583 READ_KBD is:
6584 0 to ignore keyboard input, or
6585 1 to return when input is available, or
6586 -1 means caller will actually read the input, so don't throw to
6587 the quit handler.
6589 see full version for other parameters. We know that wait_proc will
6590 always be NULL, since `subprocesses' isn't defined.
6592 DO_DISPLAY means redisplay should be done to show subprocess
6593 output that arrives.
6595 Return true if we received input from any process. */
6597 bool
6598 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6599 bool do_display,
6600 Lisp_Object wait_for_cell,
6601 struct Lisp_Process *wait_proc, int just_wait_proc)
6603 register int nfds;
6604 EMACS_TIME end_time, timeout;
6606 if (time_limit < 0)
6608 time_limit = 0;
6609 nsecs = -1;
6611 else if (TYPE_MAXIMUM (time_t) < time_limit)
6612 time_limit = TYPE_MAXIMUM (time_t);
6614 /* What does time_limit really mean? */
6615 if (time_limit || nsecs > 0)
6617 timeout = make_emacs_time (time_limit, nsecs);
6618 end_time = add_emacs_time (current_emacs_time (), timeout);
6621 /* Turn off periodic alarms (in case they are in use)
6622 and then turn off any other atimers,
6623 because the select emulator uses alarms. */
6624 stop_polling ();
6625 turn_on_atimers (0);
6627 while (1)
6629 bool timeout_reduced_for_timers = 0;
6630 SELECT_TYPE waitchannels;
6631 int xerrno;
6633 /* If calling from keyboard input, do not quit
6634 since we want to return C-g as an input character.
6635 Otherwise, do pending quit if requested. */
6636 if (read_kbd >= 0)
6637 QUIT;
6639 /* Exit now if the cell we're waiting for became non-nil. */
6640 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6641 break;
6643 /* Compute time from now till when time limit is up. */
6644 /* Exit if already run out. */
6645 if (nsecs < 0)
6647 /* A negative timeout means
6648 gobble output available now
6649 but don't wait at all. */
6651 timeout = make_emacs_time (0, 0);
6653 else if (time_limit || nsecs > 0)
6655 EMACS_TIME now = current_emacs_time ();
6656 if (EMACS_TIME_LE (end_time, now))
6657 break;
6658 timeout = sub_emacs_time (end_time, now);
6660 else
6662 timeout = make_emacs_time (100000, 0);
6665 /* If our caller will not immediately handle keyboard events,
6666 run timer events directly.
6667 (Callers that will immediately read keyboard events
6668 call timer_delay on their own.) */
6669 if (NILP (wait_for_cell))
6671 EMACS_TIME timer_delay;
6675 unsigned old_timers_run = timers_run;
6676 timer_delay = timer_check ();
6677 if (timers_run != old_timers_run && do_display)
6678 /* We must retry, since a timer may have requeued itself
6679 and that could alter the time delay. */
6680 redisplay_preserve_echo_area (14);
6681 else
6682 break;
6684 while (!detect_input_pending ());
6686 /* If there is unread keyboard input, also return. */
6687 if (read_kbd != 0
6688 && requeued_events_pending_p ())
6689 break;
6691 if (EMACS_TIME_VALID_P (timer_delay) && nsecs >= 0)
6693 if (EMACS_TIME_LT (timer_delay, timeout))
6695 timeout = timer_delay;
6696 timeout_reduced_for_timers = 1;
6701 /* Cause C-g and alarm signals to take immediate action,
6702 and cause input available signals to zero out timeout. */
6703 if (read_kbd < 0)
6704 set_waiting_for_input (&timeout);
6706 /* If a frame has been newly mapped and needs updating,
6707 reprocess its display stuff. */
6708 if (frame_garbaged && do_display)
6710 clear_waiting_for_input ();
6711 redisplay_preserve_echo_area (15);
6712 if (read_kbd < 0)
6713 set_waiting_for_input (&timeout);
6716 /* Wait till there is something to do. */
6717 FD_ZERO (&waitchannels);
6718 if (read_kbd && detect_input_pending ())
6719 nfds = 0;
6720 else
6722 if (read_kbd || !NILP (wait_for_cell))
6723 FD_SET (0, &waitchannels);
6724 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6727 xerrno = errno;
6729 /* Make C-g and alarm signals set flags again */
6730 clear_waiting_for_input ();
6732 /* If we woke up due to SIGWINCH, actually change size now. */
6733 do_pending_window_change (0);
6735 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6736 /* We waited the full specified time, so return now. */
6737 break;
6739 if (nfds == -1)
6741 /* If the system call was interrupted, then go around the
6742 loop again. */
6743 if (xerrno == EINTR)
6744 FD_ZERO (&waitchannels);
6745 else
6746 error ("select error: %s", emacs_strerror (xerrno));
6749 /* Check for keyboard input */
6751 if (read_kbd
6752 && detect_input_pending_run_timers (do_display))
6754 swallow_events (do_display);
6755 if (detect_input_pending_run_timers (do_display))
6756 break;
6759 /* If there is unread keyboard input, also return. */
6760 if (read_kbd
6761 && requeued_events_pending_p ())
6762 break;
6764 /* If wait_for_cell. check for keyboard input
6765 but don't run any timers.
6766 ??? (It seems wrong to me to check for keyboard
6767 input at all when wait_for_cell, but the code
6768 has been this way since July 1994.
6769 Try changing this after version 19.31.) */
6770 if (! NILP (wait_for_cell)
6771 && detect_input_pending ())
6773 swallow_events (do_display);
6774 if (detect_input_pending ())
6775 break;
6778 /* Exit now if the cell we're waiting for became non-nil. */
6779 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6780 break;
6783 start_polling ();
6785 return 0;
6788 #endif /* not subprocesses */
6790 /* The following functions are needed even if async subprocesses are
6791 not supported. Some of them are no-op stubs in that case. */
6793 /* Add DESC to the set of keyboard input descriptors. */
6795 void
6796 add_keyboard_wait_descriptor (int desc)
6798 #ifdef subprocesses /* actually means "not MSDOS" */
6799 FD_SET (desc, &input_wait_mask);
6800 FD_SET (desc, &non_process_wait_mask);
6801 if (desc > max_input_desc)
6802 max_input_desc = desc;
6803 #endif
6806 /* From now on, do not expect DESC to give keyboard input. */
6808 void
6809 delete_keyboard_wait_descriptor (int desc)
6811 #ifdef subprocesses
6812 int fd;
6813 int lim = max_input_desc;
6815 FD_CLR (desc, &input_wait_mask);
6816 FD_CLR (desc, &non_process_wait_mask);
6818 if (desc == max_input_desc)
6819 for (fd = 0; fd < lim; fd++)
6820 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
6821 max_input_desc = fd;
6822 #endif
6825 /* Setup coding systems of PROCESS. */
6827 void
6828 setup_process_coding_systems (Lisp_Object process)
6830 #ifdef subprocesses
6831 struct Lisp_Process *p = XPROCESS (process);
6832 int inch = p->infd;
6833 int outch = p->outfd;
6834 Lisp_Object coding_system;
6836 if (inch < 0 || outch < 0)
6837 return;
6839 if (!proc_decode_coding_system[inch])
6840 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
6841 coding_system = p->decode_coding_system;
6842 if (EQ (p->filter, Qinternal_default_process_filter)
6843 && BUFFERP (p->buffer))
6845 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
6846 coding_system = raw_text_coding_system (coding_system);
6848 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
6850 if (!proc_encode_coding_system[outch])
6851 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
6852 setup_coding_system (p->encode_coding_system,
6853 proc_encode_coding_system[outch]);
6854 #endif
6857 /* Close all descriptors currently in use for communication
6858 with subprocess. This is used in a newly-forked subprocess
6859 to get rid of irrelevant descriptors. */
6861 void
6862 close_process_descs (void)
6864 #ifndef DOS_NT
6865 int i;
6866 for (i = 0; i < MAXDESC; i++)
6868 Lisp_Object process;
6869 process = chan_process[i];
6870 if (!NILP (process))
6872 int in = XPROCESS (process)->infd;
6873 int out = XPROCESS (process)->outfd;
6874 if (in >= 0)
6875 emacs_close (in);
6876 if (out >= 0 && in != out)
6877 emacs_close (out);
6880 #endif
6883 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
6884 doc: /* Return the (or a) process associated with BUFFER.
6885 BUFFER may be a buffer or the name of one. */)
6886 (register Lisp_Object buffer)
6888 #ifdef subprocesses
6889 register Lisp_Object buf, tail, proc;
6891 if (NILP (buffer)) return Qnil;
6892 buf = Fget_buffer (buffer);
6893 if (NILP (buf)) return Qnil;
6895 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6897 proc = Fcdr (XCAR (tail));
6898 if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
6899 return proc;
6901 #endif /* subprocesses */
6902 return Qnil;
6905 DEFUN ("process-inherit-coding-system-flag",
6906 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
6907 1, 1, 0,
6908 doc: /* Return the value of inherit-coding-system flag for PROCESS.
6909 If this flag is t, `buffer-file-coding-system' of the buffer
6910 associated with PROCESS will inherit the coding system used to decode
6911 the process output. */)
6912 (register Lisp_Object process)
6914 #ifdef subprocesses
6915 CHECK_PROCESS (process);
6916 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
6917 #else
6918 /* Ignore the argument and return the value of
6919 inherit-process-coding-system. */
6920 return inherit_process_coding_system ? Qt : Qnil;
6921 #endif
6924 /* Kill all processes associated with `buffer'.
6925 If `buffer' is nil, kill all processes */
6927 void
6928 kill_buffer_processes (Lisp_Object buffer)
6930 #ifdef subprocesses
6931 Lisp_Object tail, proc;
6933 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6935 proc = XCDR (XCAR (tail));
6936 if (PROCESSP (proc)
6937 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
6939 if (NETCONN_P (proc) || SERIALCONN_P (proc))
6940 Fdelete_process (proc);
6941 else if (XPROCESS (proc)->infd >= 0)
6942 process_send_signal (proc, SIGHUP, Qnil, 1);
6945 #else /* subprocesses */
6946 /* Since we have no subprocesses, this does nothing. */
6947 #endif /* subprocesses */
6950 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
6951 Swaiting_for_user_input_p, 0, 0, 0,
6952 doc: /* Return non-nil if Emacs is waiting for input from the user.
6953 This is intended for use by asynchronous process output filters and sentinels. */)
6954 (void)
6956 #ifdef subprocesses
6957 return (waiting_for_user_input_p ? Qt : Qnil);
6958 #else
6959 return Qnil;
6960 #endif
6963 /* Stop reading input from keyboard sources. */
6965 void
6966 hold_keyboard_input (void)
6968 kbd_is_on_hold = 1;
6971 /* Resume reading input from keyboard sources. */
6973 void
6974 unhold_keyboard_input (void)
6976 kbd_is_on_hold = 0;
6979 /* Return true if keyboard input is on hold, zero otherwise. */
6981 bool
6982 kbd_on_hold_p (void)
6984 return kbd_is_on_hold;
6988 /* Enumeration of and access to system processes a-la ps(1). */
6990 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
6991 0, 0, 0,
6992 doc: /* Return a list of numerical process IDs of all running processes.
6993 If this functionality is unsupported, return nil.
6995 See `process-attributes' for getting attributes of a process given its ID. */)
6996 (void)
6998 return list_system_processes ();
7001 DEFUN ("process-attributes", Fprocess_attributes,
7002 Sprocess_attributes, 1, 1, 0,
7003 doc: /* Return attributes of the process given by its PID, a number.
7005 Value is an alist where each element is a cons cell of the form
7007 \(KEY . VALUE)
7009 If this functionality is unsupported, the value is nil.
7011 See `list-system-processes' for getting a list of all process IDs.
7013 The KEYs of the attributes that this function may return are listed
7014 below, together with the type of the associated VALUE (in parentheses).
7015 Not all platforms support all of these attributes; unsupported
7016 attributes will not appear in the returned alist.
7017 Unless explicitly indicated otherwise, numbers can have either
7018 integer or floating point values.
7020 euid -- Effective user User ID of the process (number)
7021 user -- User name corresponding to euid (string)
7022 egid -- Effective user Group ID of the process (number)
7023 group -- Group name corresponding to egid (string)
7024 comm -- Command name (executable name only) (string)
7025 state -- Process state code, such as "S", "R", or "T" (string)
7026 ppid -- Parent process ID (number)
7027 pgrp -- Process group ID (number)
7028 sess -- Session ID, i.e. process ID of session leader (number)
7029 ttname -- Controlling tty name (string)
7030 tpgid -- ID of foreground process group on the process's tty (number)
7031 minflt -- number of minor page faults (number)
7032 majflt -- number of major page faults (number)
7033 cminflt -- cumulative number of minor page faults (number)
7034 cmajflt -- cumulative number of major page faults (number)
7035 utime -- user time used by the process, in (current-time) format,
7036 which is a list of integers (HIGH LOW USEC PSEC)
7037 stime -- system time used by the process (current-time)
7038 time -- sum of utime and stime (current-time)
7039 cutime -- user time used by the process and its children (current-time)
7040 cstime -- system time used by the process and its children (current-time)
7041 ctime -- sum of cutime and cstime (current-time)
7042 pri -- priority of the process (number)
7043 nice -- nice value of the process (number)
7044 thcount -- process thread count (number)
7045 start -- time the process started (current-time)
7046 vsize -- virtual memory size of the process in KB's (number)
7047 rss -- resident set size of the process in KB's (number)
7048 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7049 pcpu -- percents of CPU time used by the process (floating-point number)
7050 pmem -- percents of total physical memory used by process's resident set
7051 (floating-point number)
7052 args -- command line which invoked the process (string). */)
7053 ( Lisp_Object pid)
7055 return system_process_attributes (pid);
7058 /* Arrange to catch SIGCHLD if this hasn't already been arranged.
7059 Invoke this after init_process_emacs, and after glib and/or GNUstep
7060 futz with the SIGCHLD handler, but before Emacs forks any children.
7061 This function's caller should block SIGCHLD. */
7063 #ifndef NS_IMPL_GNUSTEP
7064 static
7065 #endif
7066 void
7067 catch_child_signal (void)
7069 struct sigaction action, old_action;
7070 emacs_sigaction_init (&action, deliver_child_signal);
7071 block_child_signal ();
7072 sigaction (SIGCHLD, &action, &old_action);
7073 eassert (! (old_action.sa_flags & SA_SIGINFO));
7075 if (old_action.sa_handler != deliver_child_signal)
7076 lib_child_handler
7077 = (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7078 ? dummy_handler
7079 : old_action.sa_handler);
7080 unblock_child_signal ();
7084 /* This is not called "init_process" because that is the name of a
7085 Mach system call, so it would cause problems on Darwin systems. */
7086 void
7087 init_process_emacs (void)
7089 #ifdef subprocesses
7090 register int i;
7092 inhibit_sentinels = 0;
7094 #ifndef CANNOT_DUMP
7095 if (! noninteractive || initialized)
7096 #endif
7098 #if defined HAVE_GLIB && !defined WINDOWSNT && !defined CYGWIN
7099 /* Tickle glib's child-handling code. Ask glib to wait for Emacs itself;
7100 this should always fail, but is enough to initialize glib's
7101 private SIGCHLD handler, allowing the code below to copy it into
7102 LIB_CHILD_HANDLER.
7104 For some reason tickling causes Cygwin bootstrap to fail, so it's
7105 skipped under Cygwin. FIXME: Skipping the tickling likely causes
7106 bugs in subprocess handling under Cygwin (Bug#14569). */
7107 g_source_unref (g_child_watch_source_new (getpid ()));
7108 #endif
7109 catch_child_signal ();
7112 FD_ZERO (&input_wait_mask);
7113 FD_ZERO (&non_keyboard_wait_mask);
7114 FD_ZERO (&non_process_wait_mask);
7115 FD_ZERO (&write_mask);
7116 max_process_desc = 0;
7117 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7119 #ifdef NON_BLOCKING_CONNECT
7120 FD_ZERO (&connect_wait_mask);
7121 num_pending_connects = 0;
7122 #endif
7124 #ifdef ADAPTIVE_READ_BUFFERING
7125 process_output_delay_count = 0;
7126 process_output_skip = 0;
7127 #endif
7129 /* Don't do this, it caused infinite select loops. The display
7130 method should call add_keyboard_wait_descriptor on stdin if it
7131 needs that. */
7132 #if 0
7133 FD_SET (0, &input_wait_mask);
7134 #endif
7136 Vprocess_alist = Qnil;
7137 deleted_pid_list = Qnil;
7138 for (i = 0; i < MAXDESC; i++)
7140 chan_process[i] = Qnil;
7141 proc_buffered_char[i] = -1;
7143 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7144 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7145 #ifdef DATAGRAM_SOCKETS
7146 memset (datagram_address, 0, sizeof datagram_address);
7147 #endif
7150 Lisp_Object subfeatures = Qnil;
7151 const struct socket_options *sopt;
7153 #define ADD_SUBFEATURE(key, val) \
7154 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7156 #ifdef NON_BLOCKING_CONNECT
7157 ADD_SUBFEATURE (QCnowait, Qt);
7158 #endif
7159 #ifdef DATAGRAM_SOCKETS
7160 ADD_SUBFEATURE (QCtype, Qdatagram);
7161 #endif
7162 #ifdef HAVE_SEQPACKET
7163 ADD_SUBFEATURE (QCtype, Qseqpacket);
7164 #endif
7165 #ifdef HAVE_LOCAL_SOCKETS
7166 ADD_SUBFEATURE (QCfamily, Qlocal);
7167 #endif
7168 ADD_SUBFEATURE (QCfamily, Qipv4);
7169 #ifdef AF_INET6
7170 ADD_SUBFEATURE (QCfamily, Qipv6);
7171 #endif
7172 #ifdef HAVE_GETSOCKNAME
7173 ADD_SUBFEATURE (QCservice, Qt);
7174 #endif
7175 ADD_SUBFEATURE (QCserver, Qt);
7177 for (sopt = socket_options; sopt->name; sopt++)
7178 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7180 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7183 #if defined (DARWIN_OS)
7184 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7185 processes. As such, we only change the default value. */
7186 if (initialized)
7188 char const *release = (STRINGP (Voperating_system_release)
7189 ? SSDATA (Voperating_system_release)
7190 : 0);
7191 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7192 Vprocess_connection_type = Qnil;
7195 #endif
7196 #endif /* subprocesses */
7197 kbd_is_on_hold = 0;
7200 void
7201 syms_of_process (void)
7203 #ifdef subprocesses
7205 DEFSYM (Qprocessp, "processp");
7206 DEFSYM (Qrun, "run");
7207 DEFSYM (Qstop, "stop");
7208 DEFSYM (Qsignal, "signal");
7210 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7211 here again.
7213 Qexit = intern_c_string ("exit");
7214 staticpro (&Qexit); */
7216 DEFSYM (Qopen, "open");
7217 DEFSYM (Qclosed, "closed");
7218 DEFSYM (Qconnect, "connect");
7219 DEFSYM (Qfailed, "failed");
7220 DEFSYM (Qlisten, "listen");
7221 DEFSYM (Qlocal, "local");
7222 DEFSYM (Qipv4, "ipv4");
7223 #ifdef AF_INET6
7224 DEFSYM (Qipv6, "ipv6");
7225 #endif
7226 DEFSYM (Qdatagram, "datagram");
7227 DEFSYM (Qseqpacket, "seqpacket");
7229 DEFSYM (QCport, ":port");
7230 DEFSYM (QCspeed, ":speed");
7231 DEFSYM (QCprocess, ":process");
7233 DEFSYM (QCbytesize, ":bytesize");
7234 DEFSYM (QCstopbits, ":stopbits");
7235 DEFSYM (QCparity, ":parity");
7236 DEFSYM (Qodd, "odd");
7237 DEFSYM (Qeven, "even");
7238 DEFSYM (QCflowcontrol, ":flowcontrol");
7239 DEFSYM (Qhw, "hw");
7240 DEFSYM (Qsw, "sw");
7241 DEFSYM (QCsummary, ":summary");
7243 DEFSYM (Qreal, "real");
7244 DEFSYM (Qnetwork, "network");
7245 DEFSYM (Qserial, "serial");
7246 DEFSYM (QCbuffer, ":buffer");
7247 DEFSYM (QChost, ":host");
7248 DEFSYM (QCservice, ":service");
7249 DEFSYM (QClocal, ":local");
7250 DEFSYM (QCremote, ":remote");
7251 DEFSYM (QCcoding, ":coding");
7252 DEFSYM (QCserver, ":server");
7253 DEFSYM (QCnowait, ":nowait");
7254 DEFSYM (QCsentinel, ":sentinel");
7255 DEFSYM (QClog, ":log");
7256 DEFSYM (QCnoquery, ":noquery");
7257 DEFSYM (QCstop, ":stop");
7258 DEFSYM (QCoptions, ":options");
7259 DEFSYM (QCplist, ":plist");
7261 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7263 staticpro (&Vprocess_alist);
7264 staticpro (&deleted_pid_list);
7266 #endif /* subprocesses */
7268 DEFSYM (QCname, ":name");
7269 DEFSYM (QCtype, ":type");
7271 DEFSYM (Qeuid, "euid");
7272 DEFSYM (Qegid, "egid");
7273 DEFSYM (Quser, "user");
7274 DEFSYM (Qgroup, "group");
7275 DEFSYM (Qcomm, "comm");
7276 DEFSYM (Qstate, "state");
7277 DEFSYM (Qppid, "ppid");
7278 DEFSYM (Qpgrp, "pgrp");
7279 DEFSYM (Qsess, "sess");
7280 DEFSYM (Qttname, "ttname");
7281 DEFSYM (Qtpgid, "tpgid");
7282 DEFSYM (Qminflt, "minflt");
7283 DEFSYM (Qmajflt, "majflt");
7284 DEFSYM (Qcminflt, "cminflt");
7285 DEFSYM (Qcmajflt, "cmajflt");
7286 DEFSYM (Qutime, "utime");
7287 DEFSYM (Qstime, "stime");
7288 DEFSYM (Qtime, "time");
7289 DEFSYM (Qcutime, "cutime");
7290 DEFSYM (Qcstime, "cstime");
7291 DEFSYM (Qctime, "ctime");
7292 DEFSYM (Qinternal_default_process_sentinel,
7293 "internal-default-process-sentinel");
7294 DEFSYM (Qinternal_default_process_filter,
7295 "internal-default-process-filter");
7296 DEFSYM (Qpri, "pri");
7297 DEFSYM (Qnice, "nice");
7298 DEFSYM (Qthcount, "thcount");
7299 DEFSYM (Qstart, "start");
7300 DEFSYM (Qvsize, "vsize");
7301 DEFSYM (Qrss, "rss");
7302 DEFSYM (Qetime, "etime");
7303 DEFSYM (Qpcpu, "pcpu");
7304 DEFSYM (Qpmem, "pmem");
7305 DEFSYM (Qargs, "args");
7307 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7308 doc: /* Non-nil means delete processes immediately when they exit.
7309 A value of nil means don't delete them until `list-processes' is run. */);
7311 delete_exited_processes = 1;
7313 #ifdef subprocesses
7314 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7315 doc: /* Control type of device used to communicate with subprocesses.
7316 Values are nil to use a pipe, or t or `pty' to use a pty.
7317 The value has no effect if the system has no ptys or if all ptys are busy:
7318 then a pipe is used in any case.
7319 The value takes effect when `start-process' is called. */);
7320 Vprocess_connection_type = Qt;
7322 #ifdef ADAPTIVE_READ_BUFFERING
7323 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7324 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7325 On some systems, when Emacs reads the output from a subprocess, the output data
7326 is read in very small blocks, potentially resulting in very poor performance.
7327 This behavior can be remedied to some extent by setting this variable to a
7328 non-nil value, as it will automatically delay reading from such processes, to
7329 allow them to produce more output before Emacs tries to read it.
7330 If the value is t, the delay is reset after each write to the process; any other
7331 non-nil value means that the delay is not reset on write.
7332 The variable takes effect when `start-process' is called. */);
7333 Vprocess_adaptive_read_buffering = Qt;
7334 #endif
7336 defsubr (&Sprocessp);
7337 defsubr (&Sget_process);
7338 defsubr (&Sdelete_process);
7339 defsubr (&Sprocess_status);
7340 defsubr (&Sprocess_exit_status);
7341 defsubr (&Sprocess_id);
7342 defsubr (&Sprocess_name);
7343 defsubr (&Sprocess_tty_name);
7344 defsubr (&Sprocess_command);
7345 defsubr (&Sset_process_buffer);
7346 defsubr (&Sprocess_buffer);
7347 defsubr (&Sprocess_mark);
7348 defsubr (&Sset_process_filter);
7349 defsubr (&Sprocess_filter);
7350 defsubr (&Sset_process_sentinel);
7351 defsubr (&Sprocess_sentinel);
7352 defsubr (&Sset_process_window_size);
7353 defsubr (&Sset_process_inherit_coding_system_flag);
7354 defsubr (&Sset_process_query_on_exit_flag);
7355 defsubr (&Sprocess_query_on_exit_flag);
7356 defsubr (&Sprocess_contact);
7357 defsubr (&Sprocess_plist);
7358 defsubr (&Sset_process_plist);
7359 defsubr (&Sprocess_list);
7360 defsubr (&Sstart_process);
7361 defsubr (&Sserial_process_configure);
7362 defsubr (&Smake_serial_process);
7363 defsubr (&Sset_network_process_option);
7364 defsubr (&Smake_network_process);
7365 defsubr (&Sformat_network_address);
7366 #if defined (HAVE_NET_IF_H)
7367 #ifdef SIOCGIFCONF
7368 defsubr (&Snetwork_interface_list);
7369 #endif
7370 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
7371 defsubr (&Snetwork_interface_info);
7372 #endif
7373 #endif /* defined (HAVE_NET_IF_H) */
7374 #ifdef DATAGRAM_SOCKETS
7375 defsubr (&Sprocess_datagram_address);
7376 defsubr (&Sset_process_datagram_address);
7377 #endif
7378 defsubr (&Saccept_process_output);
7379 defsubr (&Sprocess_send_region);
7380 defsubr (&Sprocess_send_string);
7381 defsubr (&Sinterrupt_process);
7382 defsubr (&Skill_process);
7383 defsubr (&Squit_process);
7384 defsubr (&Sstop_process);
7385 defsubr (&Scontinue_process);
7386 defsubr (&Sprocess_running_child_p);
7387 defsubr (&Sprocess_send_eof);
7388 defsubr (&Ssignal_process);
7389 defsubr (&Swaiting_for_user_input_p);
7390 defsubr (&Sprocess_type);
7391 defsubr (&Sinternal_default_process_sentinel);
7392 defsubr (&Sinternal_default_process_filter);
7393 defsubr (&Sset_process_coding_system);
7394 defsubr (&Sprocess_coding_system);
7395 defsubr (&Sset_process_filter_multibyte);
7396 defsubr (&Sprocess_filter_multibyte_p);
7398 #endif /* subprocesses */
7400 defsubr (&Sget_buffer_process);
7401 defsubr (&Sprocess_inherit_coding_system_flag);
7402 defsubr (&Slist_system_processes);
7403 defsubr (&Sprocess_attributes);