* callproc.c (child_setup, relocate_fd) [!DOS_NT]:
[emacs.git] / src / process.c
blob8589acaa8b516b0e530a98f38913487649835bbd
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 <arpa/nameser.h>
82 #include <resolv.h>
83 #endif
85 #ifdef HAVE_UTIL_H
86 #include <util.h>
87 #endif
89 #ifdef HAVE_PTY_H
90 #include <pty.h>
91 #endif
93 #include <c-ctype.h>
94 #include <sig2str.h>
96 #endif /* subprocesses */
98 #include "systime.h"
99 #include "systty.h"
101 #include "window.h"
102 #include "character.h"
103 #include "buffer.h"
104 #include "coding.h"
105 #include "process.h"
106 #include "frame.h"
107 #include "termhooks.h"
108 #include "termopts.h"
109 #include "commands.h"
110 #include "keyboard.h"
111 #include "blockinput.h"
112 #include "dispextern.h"
113 #include "composite.h"
114 #include "atimer.h"
115 #include "sysselect.h"
116 #include "syssignal.h"
117 #include "syswait.h"
118 #ifdef HAVE_GNUTLS
119 #include "gnutls.h"
120 #endif
122 #ifdef HAVE_WINDOW_SYSTEM
123 #include TERM_HEADER
124 #endif /* HAVE_WINDOW_SYSTEM */
126 #ifdef HAVE_GLIB
127 #include "xgselect.h"
128 #ifndef WINDOWSNT
129 #include <glib.h>
130 #endif
131 #endif
133 #ifdef WINDOWSNT
134 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
135 EMACS_TIME *, void *);
136 #endif
138 #ifndef SOCK_CLOEXEC
139 # define SOCK_CLOEXEC 0
140 #endif
142 #ifndef HAVE_ACCEPT4
144 /* Emulate GNU/Linux accept4 and socket well enough for this module. */
146 static int
147 close_on_exec (int fd)
149 if (0 <= fd)
150 fcntl (fd, F_SETFD, FD_CLOEXEC);
151 return fd;
154 static int
155 accept4 (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags)
157 return close_on_exec (accept (sockfd, addr, addrlen));
160 static int
161 process_socket (int domain, int type, int protocol)
163 return close_on_exec (socket (domain, type, protocol));
165 # undef socket
166 # define socket(domain, type, protocol) process_socket (domain, type, protocol)
167 #endif
169 /* Work around GCC 4.7.0 bug with strict overflow checking; see
170 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
171 These lines can be removed once the GCC bug is fixed. */
172 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
173 # pragma GCC diagnostic ignored "-Wstrict-overflow"
174 #endif
176 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
177 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
178 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
179 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
180 Lisp_Object QCname, QCtype;
182 /* True if keyboard input is on hold, zero otherwise. */
184 static bool kbd_is_on_hold;
186 /* Nonzero means don't run process sentinels. This is used
187 when exiting. */
188 bool inhibit_sentinels;
190 #ifdef subprocesses
192 Lisp_Object Qprocessp;
193 static Lisp_Object Qrun, Qstop, Qsignal;
194 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
195 Lisp_Object Qlocal;
196 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
197 static Lisp_Object Qreal, Qnetwork, Qserial;
198 #ifdef AF_INET6
199 static Lisp_Object Qipv6;
200 #endif
201 static Lisp_Object QCport, QCprocess;
202 Lisp_Object QCspeed;
203 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
204 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
205 static Lisp_Object QCbuffer, QChost, QCservice;
206 static Lisp_Object QClocal, QCremote, QCcoding;
207 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
208 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
209 static Lisp_Object Qlast_nonmenu_event;
210 static Lisp_Object Qinternal_default_process_sentinel;
211 static Lisp_Object Qinternal_default_process_filter;
213 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
214 #define NETCONN1_P(p) (EQ (p->type, Qnetwork))
215 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
216 #define SERIALCONN1_P(p) (EQ (p->type, Qserial))
218 /* Number of events of change of status of a process. */
219 static EMACS_INT process_tick;
220 /* Number of events for which the user or sentinel has been notified. */
221 static EMACS_INT update_tick;
223 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
225 /* Only W32 has this, it really means that select can't take write mask. */
226 #ifdef BROKEN_NON_BLOCKING_CONNECT
227 #undef NON_BLOCKING_CONNECT
228 #define SELECT_CANT_DO_WRITE_MASK
229 #else
230 #ifndef NON_BLOCKING_CONNECT
231 #ifdef HAVE_SELECT
232 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
233 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
234 #define NON_BLOCKING_CONNECT
235 #endif /* EWOULDBLOCK || EINPROGRESS */
236 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
237 #endif /* HAVE_SELECT */
238 #endif /* NON_BLOCKING_CONNECT */
239 #endif /* BROKEN_NON_BLOCKING_CONNECT */
241 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
242 this system. We need to read full packets, so we need a
243 "non-destructive" select. So we require either native select,
244 or emulation of select using FIONREAD. */
246 #ifndef BROKEN_DATAGRAM_SOCKETS
247 # if defined HAVE_SELECT || defined USABLE_FIONREAD
248 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
249 # define DATAGRAM_SOCKETS
250 # endif
251 # endif
252 #endif
254 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
255 # define HAVE_SEQPACKET
256 #endif
258 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
259 #define ADAPTIVE_READ_BUFFERING
260 #endif
262 #ifdef ADAPTIVE_READ_BUFFERING
263 #define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
264 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
265 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
267 /* Number of processes which have a non-zero read_output_delay,
268 and therefore might be delayed for adaptive read buffering. */
270 static int process_output_delay_count;
272 /* True if any process has non-nil read_output_skip. */
274 static bool process_output_skip;
276 #else
277 #define process_output_delay_count 0
278 #endif
280 static void create_process (Lisp_Object, char **, Lisp_Object);
281 #ifdef USABLE_SIGIO
282 static bool keyboard_bit_set (SELECT_TYPE *);
283 #endif
284 static void deactivate_process (Lisp_Object);
285 static void status_notify (struct Lisp_Process *);
286 static int read_process_output (Lisp_Object, int);
287 static void handle_child_signal (int);
288 static void create_pty (Lisp_Object);
290 /* If we support a window system, turn on the code to poll periodically
291 to detect C-g. It isn't actually used when doing interrupt input. */
292 #ifdef HAVE_WINDOW_SYSTEM
293 #define POLL_FOR_INPUT
294 #endif
296 static Lisp_Object get_process (register Lisp_Object name);
297 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
299 /* Mask of bits indicating the descriptors that we wait for input on. */
301 static SELECT_TYPE input_wait_mask;
303 /* Mask that excludes keyboard input descriptor(s). */
305 static SELECT_TYPE non_keyboard_wait_mask;
307 /* Mask that excludes process input descriptor(s). */
309 static SELECT_TYPE non_process_wait_mask;
311 /* Mask for selecting for write. */
313 static SELECT_TYPE write_mask;
315 #ifdef NON_BLOCKING_CONNECT
316 /* Mask of bits indicating the descriptors that we wait for connect to
317 complete on. Once they complete, they are removed from this mask
318 and added to the input_wait_mask and non_keyboard_wait_mask. */
320 static SELECT_TYPE connect_wait_mask;
322 /* Number of bits set in connect_wait_mask. */
323 static int num_pending_connects;
324 #endif /* NON_BLOCKING_CONNECT */
326 /* The largest descriptor currently in use for a process object. */
327 static int max_process_desc;
329 /* The largest descriptor currently in use for input. */
330 static int max_input_desc;
332 /* Indexed by descriptor, gives the process (if any) for that descriptor */
333 static Lisp_Object chan_process[MAXDESC];
335 /* Alist of elements (NAME . PROCESS) */
336 static Lisp_Object Vprocess_alist;
338 /* Buffered-ahead input char from process, indexed by channel.
339 -1 means empty (no char is buffered).
340 Used on sys V where the only way to tell if there is any
341 output from the process is to read at least one char.
342 Always -1 on systems that support FIONREAD. */
344 static int proc_buffered_char[MAXDESC];
346 /* Table of `struct coding-system' for each process. */
347 static struct coding_system *proc_decode_coding_system[MAXDESC];
348 static struct coding_system *proc_encode_coding_system[MAXDESC];
350 #ifdef DATAGRAM_SOCKETS
351 /* Table of `partner address' for datagram sockets. */
352 static struct sockaddr_and_len {
353 struct sockaddr *sa;
354 int len;
355 } datagram_address[MAXDESC];
356 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
357 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
358 #else
359 #define DATAGRAM_CHAN_P(chan) (0)
360 #define DATAGRAM_CONN_P(proc) (0)
361 #endif
363 /* These setters are used only in this file, so they can be private. */
364 static void
365 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
367 p->buffer = val;
369 static void
370 pset_command (struct Lisp_Process *p, Lisp_Object val)
372 p->command = val;
374 static void
375 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
377 p->decode_coding_system = val;
379 static void
380 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
382 p->decoding_buf = val;
384 static void
385 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
387 p->encode_coding_system = val;
389 static void
390 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
392 p->encoding_buf = val;
394 static void
395 pset_filter (struct Lisp_Process *p, Lisp_Object val)
397 p->filter = NILP (val) ? Qinternal_default_process_filter : val;
399 static void
400 pset_log (struct Lisp_Process *p, Lisp_Object val)
402 p->log = val;
404 static void
405 pset_mark (struct Lisp_Process *p, Lisp_Object val)
407 p->mark = val;
409 static void
410 pset_name (struct Lisp_Process *p, Lisp_Object val)
412 p->name = val;
414 static void
415 pset_plist (struct Lisp_Process *p, Lisp_Object val)
417 p->plist = val;
419 static void
420 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
422 p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
424 static void
425 pset_status (struct Lisp_Process *p, Lisp_Object val)
427 p->status = val;
429 static void
430 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
432 p->tty_name = val;
434 static void
435 pset_type (struct Lisp_Process *p, Lisp_Object val)
437 p->type = val;
439 static void
440 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
442 p->write_queue = val;
447 static struct fd_callback_data
449 fd_callback func;
450 void *data;
451 #define FOR_READ 1
452 #define FOR_WRITE 2
453 int condition; /* mask of the defines above. */
454 } fd_callback_info[MAXDESC];
457 /* Add a file descriptor FD to be monitored for when read is possible.
458 When read is possible, call FUNC with argument DATA. */
460 void
461 add_read_fd (int fd, fd_callback func, void *data)
463 eassert (fd < MAXDESC);
464 add_keyboard_wait_descriptor (fd);
466 fd_callback_info[fd].func = func;
467 fd_callback_info[fd].data = data;
468 fd_callback_info[fd].condition |= FOR_READ;
471 /* Stop monitoring file descriptor FD for when read is possible. */
473 void
474 delete_read_fd (int fd)
476 eassert (fd < MAXDESC);
477 delete_keyboard_wait_descriptor (fd);
479 fd_callback_info[fd].condition &= ~FOR_READ;
480 if (fd_callback_info[fd].condition == 0)
482 fd_callback_info[fd].func = 0;
483 fd_callback_info[fd].data = 0;
487 /* Add a file descriptor FD to be monitored for when write is possible.
488 When write is possible, call FUNC with argument DATA. */
490 void
491 add_write_fd (int fd, fd_callback func, void *data)
493 eassert (fd < MAXDESC);
494 FD_SET (fd, &write_mask);
495 if (fd > max_input_desc)
496 max_input_desc = fd;
498 fd_callback_info[fd].func = func;
499 fd_callback_info[fd].data = data;
500 fd_callback_info[fd].condition |= FOR_WRITE;
503 /* Stop monitoring file descriptor FD for when write is possible. */
505 void
506 delete_write_fd (int fd)
508 int lim = max_input_desc;
510 eassert (fd < MAXDESC);
511 FD_CLR (fd, &write_mask);
512 fd_callback_info[fd].condition &= ~FOR_WRITE;
513 if (fd_callback_info[fd].condition == 0)
515 fd_callback_info[fd].func = 0;
516 fd_callback_info[fd].data = 0;
518 if (fd == max_input_desc)
519 for (fd = lim; fd >= 0; fd--)
520 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
522 max_input_desc = fd;
523 break;
530 /* Compute the Lisp form of the process status, p->status, from
531 the numeric status that was returned by `wait'. */
533 static Lisp_Object status_convert (int);
535 static void
536 update_status (struct Lisp_Process *p)
538 eassert (p->raw_status_new);
539 pset_status (p, status_convert (p->raw_status));
540 p->raw_status_new = 0;
543 /* Convert a process status word in Unix format to
544 the list that we use internally. */
546 static Lisp_Object
547 status_convert (int w)
549 if (WIFSTOPPED (w))
550 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
551 else if (WIFEXITED (w))
552 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
553 WCOREDUMP (w) ? Qt : Qnil));
554 else if (WIFSIGNALED (w))
555 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
556 WCOREDUMP (w) ? Qt : Qnil));
557 else
558 return Qrun;
561 /* Given a status-list, extract the three pieces of information
562 and store them individually through the three pointers. */
564 static void
565 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
567 Lisp_Object tem;
569 if (SYMBOLP (l))
571 *symbol = l;
572 *code = 0;
573 *coredump = 0;
575 else
577 *symbol = XCAR (l);
578 tem = XCDR (l);
579 *code = XFASTINT (XCAR (tem));
580 tem = XCDR (tem);
581 *coredump = !NILP (tem);
585 /* Return a string describing a process status list. */
587 static Lisp_Object
588 status_message (struct Lisp_Process *p)
590 Lisp_Object status = p->status;
591 Lisp_Object symbol;
592 int code;
593 bool coredump;
594 Lisp_Object string, string2;
596 decode_status (status, &symbol, &code, &coredump);
598 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
600 char const *signame;
601 synchronize_system_messages_locale ();
602 signame = strsignal (code);
603 if (signame == 0)
604 string = build_string ("unknown");
605 else
607 int c1, c2;
609 string = build_unibyte_string (signame);
610 if (! NILP (Vlocale_coding_system))
611 string = (code_convert_string_norecord
612 (string, Vlocale_coding_system, 0));
613 c1 = STRING_CHAR (SDATA (string));
614 c2 = downcase (c1);
615 if (c1 != c2)
616 Faset (string, make_number (0), make_number (c2));
618 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
619 return concat2 (string, string2);
621 else if (EQ (symbol, Qexit))
623 if (NETCONN1_P (p))
624 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
625 if (code == 0)
626 return build_string ("finished\n");
627 string = Fnumber_to_string (make_number (code));
628 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
629 return concat3 (build_string ("exited abnormally with code "),
630 string, string2);
632 else if (EQ (symbol, Qfailed))
634 string = Fnumber_to_string (make_number (code));
635 string2 = build_string ("\n");
636 return concat3 (build_string ("failed with code "),
637 string, string2);
639 else
640 return Fcopy_sequence (Fsymbol_name (symbol));
643 #ifdef HAVE_PTYS
645 /* The file name of the pty opened by allocate_pty. */
646 static char pty_name[24];
648 /* Open an available pty, returning a file descriptor.
649 Return -1 on failure.
650 The file name of the terminal corresponding to the pty
651 is left in the variable pty_name. */
653 static int
654 allocate_pty (void)
656 int fd;
658 #ifdef PTY_ITERATION
659 PTY_ITERATION
660 #else
661 register int c, i;
662 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
663 for (i = 0; i < 16; i++)
664 #endif
666 #ifdef PTY_NAME_SPRINTF
667 PTY_NAME_SPRINTF
668 #else
669 sprintf (pty_name, "/dev/pty%c%x", c, i);
670 #endif /* no PTY_NAME_SPRINTF */
672 #ifdef PTY_OPEN
673 PTY_OPEN;
674 #else /* no PTY_OPEN */
675 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
676 #endif /* no PTY_OPEN */
678 if (fd >= 0)
680 /* check to make certain that both sides are available
681 this avoids a nasty yet stupid bug in rlogins */
682 #ifdef PTY_TTY_NAME_SPRINTF
683 PTY_TTY_NAME_SPRINTF
684 #else
685 sprintf (pty_name, "/dev/tty%c%x", c, i);
686 #endif /* no PTY_TTY_NAME_SPRINTF */
687 if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
689 emacs_close (fd);
690 # ifndef __sgi
691 continue;
692 # else
693 return -1;
694 # endif /* __sgi */
696 setup_pty (fd);
697 return fd;
700 return -1;
702 #endif /* HAVE_PTYS */
704 static Lisp_Object
705 make_process (Lisp_Object name)
707 register Lisp_Object val, tem, name1;
708 register struct Lisp_Process *p;
709 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
710 printmax_t i;
712 p = allocate_process ();
713 /* Initialize Lisp data. Note that allocate_process initializes all
714 Lisp data to nil, so do it only for slots which should not be nil. */
715 pset_status (p, Qrun);
716 pset_mark (p, Fmake_marker ());
718 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
719 non-Lisp data, so do it only for slots which should not be zero. */
720 p->infd = -1;
721 p->outfd = -1;
723 #ifdef HAVE_GNUTLS
724 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
725 #endif
727 /* If name is already in use, modify it until it is unused. */
729 name1 = name;
730 for (i = 1; ; i++)
732 tem = Fget_process (name1);
733 if (NILP (tem)) break;
734 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
736 name = name1;
737 pset_name (p, name);
738 pset_sentinel (p, Qinternal_default_process_sentinel);
739 pset_filter (p, Qinternal_default_process_filter);
740 XSETPROCESS (val, p);
741 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
742 return val;
745 static void
746 remove_process (register Lisp_Object proc)
748 register Lisp_Object pair;
750 pair = Frassq (proc, Vprocess_alist);
751 Vprocess_alist = Fdelq (pair, Vprocess_alist);
753 deactivate_process (proc);
757 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
758 doc: /* Return t if OBJECT is a process. */)
759 (Lisp_Object object)
761 return PROCESSP (object) ? Qt : Qnil;
764 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
765 doc: /* Return the process named NAME, or nil if there is none. */)
766 (register Lisp_Object name)
768 if (PROCESSP (name))
769 return name;
770 CHECK_STRING (name);
771 return Fcdr (Fassoc (name, Vprocess_alist));
774 /* This is how commands for the user decode process arguments. It
775 accepts a process, a process name, a buffer, a buffer name, or nil.
776 Buffers denote the first process in the buffer, and nil denotes the
777 current buffer. */
779 static Lisp_Object
780 get_process (register Lisp_Object name)
782 register Lisp_Object proc, obj;
783 if (STRINGP (name))
785 obj = Fget_process (name);
786 if (NILP (obj))
787 obj = Fget_buffer (name);
788 if (NILP (obj))
789 error ("Process %s does not exist", SDATA (name));
791 else if (NILP (name))
792 obj = Fcurrent_buffer ();
793 else
794 obj = name;
796 /* Now obj should be either a buffer object or a process object.
798 if (BUFFERP (obj))
800 proc = Fget_buffer_process (obj);
801 if (NILP (proc))
802 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
804 else
806 CHECK_PROCESS (obj);
807 proc = obj;
809 return proc;
813 /* Fdelete_process promises to immediately forget about the process, but in
814 reality, Emacs needs to remember those processes until they have been
815 treated by the SIGCHLD handler and waitpid has been invoked on them;
816 otherwise they might fill up the kernel's process table.
818 Some processes created by call-process are also put onto this list. */
819 static Lisp_Object deleted_pid_list;
821 void
822 record_deleted_pid (pid_t pid)
824 deleted_pid_list = Fcons (make_fixnum_or_float (pid),
825 /* GC treated elements set to nil. */
826 Fdelq (Qnil, deleted_pid_list));
830 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
831 doc: /* Delete PROCESS: kill it and forget about it immediately.
832 PROCESS may be a process, a buffer, the name of a process or buffer, or
833 nil, indicating the current buffer's process. */)
834 (register Lisp_Object process)
836 register struct Lisp_Process *p;
838 process = get_process (process);
839 p = XPROCESS (process);
841 p->raw_status_new = 0;
842 if (NETCONN1_P (p) || SERIALCONN1_P (p))
844 pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
845 p->tick = ++process_tick;
846 status_notify (p);
847 redisplay_preserve_echo_area (13);
849 else
851 if (p->alive)
852 record_kill_process (p);
854 if (p->infd >= 0)
856 /* Update P's status, since record_kill_process will make the
857 SIGCHLD handler update deleted_pid_list, not *P. */
858 Lisp_Object symbol;
859 if (p->raw_status_new)
860 update_status (p);
861 symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
862 if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
863 pset_status (p, list2 (Qsignal, make_number (SIGKILL)));
865 p->tick = ++process_tick;
866 status_notify (p);
867 redisplay_preserve_echo_area (13);
870 remove_process (process);
871 return Qnil;
874 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
875 doc: /* Return the status of PROCESS.
876 The returned value is one of the following symbols:
877 run -- for a process that is running.
878 stop -- for a process stopped but continuable.
879 exit -- for a process that has exited.
880 signal -- for a process that has got a fatal signal.
881 open -- for a network stream connection that is open.
882 listen -- for a network stream server that is listening.
883 closed -- for a network stream connection that is closed.
884 connect -- when waiting for a non-blocking connection to complete.
885 failed -- when a non-blocking connection has failed.
886 nil -- if arg is a process name and no such process exists.
887 PROCESS may be a process, a buffer, the name of a process, or
888 nil, indicating the current buffer's process. */)
889 (register Lisp_Object process)
891 register struct Lisp_Process *p;
892 register Lisp_Object status;
894 if (STRINGP (process))
895 process = Fget_process (process);
896 else
897 process = get_process (process);
899 if (NILP (process))
900 return process;
902 p = XPROCESS (process);
903 if (p->raw_status_new)
904 update_status (p);
905 status = p->status;
906 if (CONSP (status))
907 status = XCAR (status);
908 if (NETCONN1_P (p) || SERIALCONN1_P (p))
910 if (EQ (status, Qexit))
911 status = Qclosed;
912 else if (EQ (p->command, Qt))
913 status = Qstop;
914 else if (EQ (status, Qrun))
915 status = Qopen;
917 return status;
920 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
921 1, 1, 0,
922 doc: /* Return the exit status of PROCESS or the signal number that killed it.
923 If PROCESS has not yet exited or died, return 0. */)
924 (register Lisp_Object process)
926 CHECK_PROCESS (process);
927 if (XPROCESS (process)->raw_status_new)
928 update_status (XPROCESS (process));
929 if (CONSP (XPROCESS (process)->status))
930 return XCAR (XCDR (XPROCESS (process)->status));
931 return make_number (0);
934 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
935 doc: /* Return the process id of PROCESS.
936 This is the pid of the external process which PROCESS uses or talks to.
937 For a network connection, this value is nil. */)
938 (register Lisp_Object process)
940 pid_t pid;
942 CHECK_PROCESS (process);
943 pid = XPROCESS (process)->pid;
944 return (pid ? make_fixnum_or_float (pid) : Qnil);
947 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
948 doc: /* Return the name of PROCESS, as a string.
949 This is the name of the program invoked in PROCESS,
950 possibly modified to make it unique among process names. */)
951 (register Lisp_Object process)
953 CHECK_PROCESS (process);
954 return XPROCESS (process)->name;
957 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
958 doc: /* Return the command that was executed to start PROCESS.
959 This is a list of strings, the first string being the program executed
960 and the rest of the strings being the arguments given to it.
961 For a network or serial process, this is nil (process is running) or t
962 \(process is stopped). */)
963 (register Lisp_Object process)
965 CHECK_PROCESS (process);
966 return XPROCESS (process)->command;
969 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
970 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
971 This is the terminal that the process itself reads and writes on,
972 not the name of the pty that Emacs uses to talk with that terminal. */)
973 (register Lisp_Object process)
975 CHECK_PROCESS (process);
976 return XPROCESS (process)->tty_name;
979 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
980 2, 2, 0,
981 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
982 Return BUFFER. */)
983 (register Lisp_Object process, Lisp_Object buffer)
985 struct Lisp_Process *p;
987 CHECK_PROCESS (process);
988 if (!NILP (buffer))
989 CHECK_BUFFER (buffer);
990 p = XPROCESS (process);
991 pset_buffer (p, buffer);
992 if (NETCONN1_P (p) || SERIALCONN1_P (p))
993 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
994 setup_process_coding_systems (process);
995 return buffer;
998 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
999 1, 1, 0,
1000 doc: /* Return the buffer PROCESS is associated with.
1001 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
1002 (register Lisp_Object process)
1004 CHECK_PROCESS (process);
1005 return XPROCESS (process)->buffer;
1008 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1009 1, 1, 0,
1010 doc: /* Return the marker for the end of the last output from PROCESS. */)
1011 (register Lisp_Object process)
1013 CHECK_PROCESS (process);
1014 return XPROCESS (process)->mark;
1017 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1018 2, 2, 0,
1019 doc: /* Give PROCESS the filter function FILTER; nil means default.
1020 A value of t means stop accepting output from the process.
1022 When a process has a non-default filter, its buffer is not used for output.
1023 Instead, each time it does output, the entire string of output is
1024 passed to the filter.
1026 The filter gets two arguments: the process and the string of output.
1027 The string argument is normally a multibyte string, except:
1028 - if the process' input coding system is no-conversion or raw-text,
1029 it is a unibyte string (the non-converted input), or else
1030 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1031 string (the result of converting the decoded input multibyte
1032 string to unibyte with `string-make-unibyte'). */)
1033 (register Lisp_Object process, Lisp_Object filter)
1035 struct Lisp_Process *p;
1037 CHECK_PROCESS (process);
1038 p = XPROCESS (process);
1040 /* Don't signal an error if the process' input file descriptor
1041 is closed. This could make debugging Lisp more difficult,
1042 for example when doing something like
1044 (setq process (start-process ...))
1045 (debug)
1046 (set-process-filter process ...) */
1048 if (NILP (filter))
1049 filter = Qinternal_default_process_filter;
1051 if (p->infd >= 0)
1053 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1055 FD_CLR (p->infd, &input_wait_mask);
1056 FD_CLR (p->infd, &non_keyboard_wait_mask);
1058 else if (EQ (p->filter, Qt)
1059 /* Network or serial process not stopped: */
1060 && !EQ (p->command, Qt))
1062 FD_SET (p->infd, &input_wait_mask);
1063 FD_SET (p->infd, &non_keyboard_wait_mask);
1067 pset_filter (p, filter);
1068 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1069 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1070 setup_process_coding_systems (process);
1071 return filter;
1074 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1075 1, 1, 0,
1076 doc: /* Return the filter function of PROCESS.
1077 See `set-process-filter' for more info on filter functions. */)
1078 (register Lisp_Object process)
1080 CHECK_PROCESS (process);
1081 return XPROCESS (process)->filter;
1084 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1085 2, 2, 0,
1086 doc: /* Give PROCESS the sentinel SENTINEL; nil for default.
1087 The sentinel is called as a function when the process changes state.
1088 It gets two arguments: the process, and a string describing the change. */)
1089 (register Lisp_Object process, Lisp_Object sentinel)
1091 struct Lisp_Process *p;
1093 CHECK_PROCESS (process);
1094 p = XPROCESS (process);
1096 if (NILP (sentinel))
1097 sentinel = Qinternal_default_process_sentinel;
1099 pset_sentinel (p, sentinel);
1100 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1101 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1102 return sentinel;
1105 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1106 1, 1, 0,
1107 doc: /* Return the sentinel of PROCESS.
1108 See `set-process-sentinel' for more info on sentinels. */)
1109 (register Lisp_Object process)
1111 CHECK_PROCESS (process);
1112 return XPROCESS (process)->sentinel;
1115 DEFUN ("set-process-window-size", Fset_process_window_size,
1116 Sset_process_window_size, 3, 3, 0,
1117 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1118 (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1120 CHECK_PROCESS (process);
1121 CHECK_RANGED_INTEGER (height, 0, INT_MAX);
1122 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
1124 if (XPROCESS (process)->infd < 0
1125 || set_window_size (XPROCESS (process)->infd,
1126 XINT (height), XINT (width)) <= 0)
1127 return Qnil;
1128 else
1129 return Qt;
1132 DEFUN ("set-process-inherit-coding-system-flag",
1133 Fset_process_inherit_coding_system_flag,
1134 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1135 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1136 If the second argument FLAG is non-nil, then the variable
1137 `buffer-file-coding-system' of the buffer associated with PROCESS
1138 will be bound to the value of the coding system used to decode
1139 the process output.
1141 This is useful when the coding system specified for the process buffer
1142 leaves either the character code conversion or the end-of-line conversion
1143 unspecified, or if the coding system used to decode the process output
1144 is more appropriate for saving the process buffer.
1146 Binding the variable `inherit-process-coding-system' to non-nil before
1147 starting the process is an alternative way of setting the inherit flag
1148 for the process which will run.
1150 This function returns FLAG. */)
1151 (register Lisp_Object process, Lisp_Object flag)
1153 CHECK_PROCESS (process);
1154 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1155 return flag;
1158 DEFUN ("set-process-query-on-exit-flag",
1159 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1160 2, 2, 0,
1161 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1162 If the second argument FLAG is non-nil, Emacs will query the user before
1163 exiting or killing a buffer if PROCESS is running. This function
1164 returns FLAG. */)
1165 (register Lisp_Object process, Lisp_Object flag)
1167 CHECK_PROCESS (process);
1168 XPROCESS (process)->kill_without_query = NILP (flag);
1169 return flag;
1172 DEFUN ("process-query-on-exit-flag",
1173 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1174 1, 1, 0,
1175 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1176 (register Lisp_Object process)
1178 CHECK_PROCESS (process);
1179 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1182 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1183 1, 2, 0,
1184 doc: /* Return the contact info of PROCESS; t for a real child.
1185 For a network or serial connection, the value depends on the optional
1186 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1187 SERVICE) for a network connection or (PORT SPEED) for a serial
1188 connection. If KEY is t, the complete contact information for the
1189 connection is returned, else the specific value for the keyword KEY is
1190 returned. See `make-network-process' or `make-serial-process' for a
1191 list of keywords. */)
1192 (register Lisp_Object process, Lisp_Object key)
1194 Lisp_Object contact;
1196 CHECK_PROCESS (process);
1197 contact = XPROCESS (process)->childp;
1199 #ifdef DATAGRAM_SOCKETS
1200 if (DATAGRAM_CONN_P (process)
1201 && (EQ (key, Qt) || EQ (key, QCremote)))
1202 contact = Fplist_put (contact, QCremote,
1203 Fprocess_datagram_address (process));
1204 #endif
1206 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1207 return contact;
1208 if (NILP (key) && NETCONN_P (process))
1209 return Fcons (Fplist_get (contact, QChost),
1210 Fcons (Fplist_get (contact, QCservice), Qnil));
1211 if (NILP (key) && SERIALCONN_P (process))
1212 return Fcons (Fplist_get (contact, QCport),
1213 Fcons (Fplist_get (contact, QCspeed), Qnil));
1214 return Fplist_get (contact, key);
1217 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1218 1, 1, 0,
1219 doc: /* Return the plist of PROCESS. */)
1220 (register Lisp_Object process)
1222 CHECK_PROCESS (process);
1223 return XPROCESS (process)->plist;
1226 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1227 2, 2, 0,
1228 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1229 (register Lisp_Object process, Lisp_Object plist)
1231 CHECK_PROCESS (process);
1232 CHECK_LIST (plist);
1234 pset_plist (XPROCESS (process), plist);
1235 return plist;
1238 #if 0 /* Turned off because we don't currently record this info
1239 in the process. Perhaps add it. */
1240 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1241 doc: /* Return the connection type of PROCESS.
1242 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1243 a socket connection. */)
1244 (Lisp_Object process)
1246 return XPROCESS (process)->type;
1248 #endif
1250 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1251 doc: /* Return the connection type of PROCESS.
1252 The value is either the symbol `real', `network', or `serial'.
1253 PROCESS may be a process, a buffer, the name of a process or buffer, or
1254 nil, indicating the current buffer's process. */)
1255 (Lisp_Object process)
1257 Lisp_Object proc;
1258 proc = get_process (process);
1259 return XPROCESS (proc)->type;
1262 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1263 1, 2, 0,
1264 doc: /* Convert network ADDRESS from internal format to a string.
1265 A 4 or 5 element vector represents an IPv4 address (with port number).
1266 An 8 or 9 element vector represents an IPv6 address (with port number).
1267 If optional second argument OMIT-PORT is non-nil, don't include a port
1268 number in the string, even when present in ADDRESS.
1269 Returns nil if format of ADDRESS is invalid. */)
1270 (Lisp_Object address, Lisp_Object omit_port)
1272 if (NILP (address))
1273 return Qnil;
1275 if (STRINGP (address)) /* AF_LOCAL */
1276 return address;
1278 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1280 register struct Lisp_Vector *p = XVECTOR (address);
1281 ptrdiff_t size = p->header.size;
1282 Lisp_Object args[10];
1283 int nargs, i;
1285 if (size == 4 || (size == 5 && !NILP (omit_port)))
1287 args[0] = build_string ("%d.%d.%d.%d");
1288 nargs = 4;
1290 else if (size == 5)
1292 args[0] = build_string ("%d.%d.%d.%d:%d");
1293 nargs = 5;
1295 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1297 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1298 nargs = 8;
1300 else if (size == 9)
1302 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1303 nargs = 9;
1305 else
1306 return Qnil;
1308 for (i = 0; i < nargs; i++)
1310 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1311 return Qnil;
1313 if (nargs <= 5 /* IPv4 */
1314 && i < 4 /* host, not port */
1315 && XINT (p->contents[i]) > 255)
1316 return Qnil;
1318 args[i+1] = p->contents[i];
1321 return Fformat (nargs+1, args);
1324 if (CONSP (address))
1326 Lisp_Object args[2];
1327 args[0] = build_string ("<Family %d>");
1328 args[1] = Fcar (address);
1329 return Fformat (2, args);
1332 return Qnil;
1335 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1336 doc: /* Return a list of all processes. */)
1337 (void)
1339 return Fmapcar (Qcdr, Vprocess_alist);
1342 /* Starting asynchronous inferior processes. */
1344 static Lisp_Object start_process_unwind (Lisp_Object proc);
1346 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1347 doc: /* Start a program in a subprocess. Return the process object for it.
1348 NAME is name for process. It is modified if necessary to make it unique.
1349 BUFFER is the buffer (or buffer name) to associate with the process.
1351 Process output (both standard output and standard error streams) goes
1352 at end of BUFFER, unless you specify an output stream or filter
1353 function to handle the output. BUFFER may also be nil, meaning that
1354 this process is not associated with any buffer.
1356 PROGRAM is the program file name. It is searched for in `exec-path'
1357 (which see). If nil, just associate a pty with the buffer. Remaining
1358 arguments are strings to give program as arguments.
1360 If you want to separate standard output from standard error, invoke
1361 the command through a shell and redirect one of them using the shell
1362 syntax.
1364 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1365 (ptrdiff_t nargs, Lisp_Object *args)
1367 Lisp_Object buffer, name, program, proc, current_dir, tem;
1368 register unsigned char **new_argv;
1369 ptrdiff_t i;
1370 ptrdiff_t count = SPECPDL_INDEX ();
1372 buffer = args[1];
1373 if (!NILP (buffer))
1374 buffer = Fget_buffer_create (buffer);
1376 /* Make sure that the child will be able to chdir to the current
1377 buffer's current directory, or its unhandled equivalent. We
1378 can't just have the child check for an error when it does the
1379 chdir, since it's in a vfork.
1381 We have to GCPRO around this because Fexpand_file_name and
1382 Funhandled_file_name_directory might call a file name handling
1383 function. The argument list is protected by the caller, so all
1384 we really have to worry about is buffer. */
1386 struct gcpro gcpro1, gcpro2;
1388 current_dir = BVAR (current_buffer, directory);
1390 GCPRO2 (buffer, current_dir);
1392 current_dir = Funhandled_file_name_directory (current_dir);
1393 if (NILP (current_dir))
1394 /* If the file name handler says that current_dir is unreachable, use
1395 a sensible default. */
1396 current_dir = build_string ("~/");
1397 current_dir = expand_and_dir_to_file (current_dir, Qnil);
1398 if (NILP (Ffile_accessible_directory_p (current_dir)))
1399 report_file_error ("Setting current directory",
1400 Fcons (BVAR (current_buffer, directory), Qnil));
1402 UNGCPRO;
1405 name = args[0];
1406 CHECK_STRING (name);
1408 program = args[2];
1410 if (!NILP (program))
1411 CHECK_STRING (program);
1413 proc = make_process (name);
1414 /* If an error occurs and we can't start the process, we want to
1415 remove it from the process list. This means that each error
1416 check in create_process doesn't need to call remove_process
1417 itself; it's all taken care of here. */
1418 record_unwind_protect (start_process_unwind, proc);
1420 pset_childp (XPROCESS (proc), Qt);
1421 pset_plist (XPROCESS (proc), Qnil);
1422 pset_type (XPROCESS (proc), Qreal);
1423 pset_buffer (XPROCESS (proc), buffer);
1424 pset_sentinel (XPROCESS (proc), Qinternal_default_process_sentinel);
1425 pset_filter (XPROCESS (proc), Qinternal_default_process_filter);
1426 pset_command (XPROCESS (proc), Flist (nargs - 2, args + 2));
1428 #ifdef HAVE_GNUTLS
1429 /* AKA GNUTLS_INITSTAGE(proc). */
1430 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1431 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1432 #endif
1434 #ifdef ADAPTIVE_READ_BUFFERING
1435 XPROCESS (proc)->adaptive_read_buffering
1436 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1437 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1438 #endif
1440 /* Make the process marker point into the process buffer (if any). */
1441 if (BUFFERP (buffer))
1442 set_marker_both (XPROCESS (proc)->mark, buffer,
1443 BUF_ZV (XBUFFER (buffer)),
1444 BUF_ZV_BYTE (XBUFFER (buffer)));
1447 /* Decide coding systems for communicating with the process. Here
1448 we don't setup the structure coding_system nor pay attention to
1449 unibyte mode. They are done in create_process. */
1451 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1452 Lisp_Object coding_systems = Qt;
1453 Lisp_Object val, *args2;
1454 struct gcpro gcpro1, gcpro2;
1456 val = Vcoding_system_for_read;
1457 if (NILP (val))
1459 args2 = alloca ((nargs + 1) * sizeof *args2);
1460 args2[0] = Qstart_process;
1461 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1462 GCPRO2 (proc, current_dir);
1463 if (!NILP (program))
1464 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1465 UNGCPRO;
1466 if (CONSP (coding_systems))
1467 val = XCAR (coding_systems);
1468 else if (CONSP (Vdefault_process_coding_system))
1469 val = XCAR (Vdefault_process_coding_system);
1471 pset_decode_coding_system (XPROCESS (proc), val);
1473 val = Vcoding_system_for_write;
1474 if (NILP (val))
1476 if (EQ (coding_systems, Qt))
1478 args2 = alloca ((nargs + 1) * sizeof *args2);
1479 args2[0] = Qstart_process;
1480 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1481 GCPRO2 (proc, current_dir);
1482 if (!NILP (program))
1483 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1484 UNGCPRO;
1486 if (CONSP (coding_systems))
1487 val = XCDR (coding_systems);
1488 else if (CONSP (Vdefault_process_coding_system))
1489 val = XCDR (Vdefault_process_coding_system);
1491 pset_encode_coding_system (XPROCESS (proc), val);
1492 /* Note: At this moment, the above coding system may leave
1493 text-conversion or eol-conversion unspecified. They will be
1494 decided after we read output from the process and decode it by
1495 some coding system, or just before we actually send a text to
1496 the process. */
1500 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1501 XPROCESS (proc)->decoding_carryover = 0;
1502 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1504 XPROCESS (proc)->inherit_coding_system_flag
1505 = !(NILP (buffer) || !inherit_process_coding_system);
1507 if (!NILP (program))
1509 /* If program file name is not absolute, search our path for it.
1510 Put the name we will really use in TEM. */
1511 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1512 && !(SCHARS (program) > 1
1513 && IS_DEVICE_SEP (SREF (program, 1))))
1515 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1517 tem = Qnil;
1518 GCPRO4 (name, program, buffer, current_dir);
1519 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1520 UNGCPRO;
1521 if (NILP (tem))
1522 report_file_error ("Searching for program", Fcons (program, Qnil));
1523 tem = Fexpand_file_name (tem, Qnil);
1525 else
1527 if (!NILP (Ffile_directory_p (program)))
1528 error ("Specified program for new process is a directory");
1529 tem = program;
1532 /* If program file name starts with /: for quoting a magic name,
1533 discard that. */
1534 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1535 && SREF (tem, 1) == ':')
1536 tem = Fsubstring (tem, make_number (2), Qnil);
1539 Lisp_Object arg_encoding = Qnil;
1540 struct gcpro gcpro1;
1541 GCPRO1 (tem);
1543 /* Encode the file name and put it in NEW_ARGV.
1544 That's where the child will use it to execute the program. */
1545 tem = Fcons (ENCODE_FILE (tem), Qnil);
1547 /* Here we encode arguments by the coding system used for sending
1548 data to the process. We don't support using different coding
1549 systems for encoding arguments and for encoding data sent to the
1550 process. */
1552 for (i = 3; i < nargs; i++)
1554 tem = Fcons (args[i], tem);
1555 CHECK_STRING (XCAR (tem));
1556 if (STRING_MULTIBYTE (XCAR (tem)))
1558 if (NILP (arg_encoding))
1559 arg_encoding = (complement_process_encoding_system
1560 (XPROCESS (proc)->encode_coding_system));
1561 XSETCAR (tem,
1562 code_convert_string_norecord
1563 (XCAR (tem), arg_encoding, 1));
1567 UNGCPRO;
1570 /* Now that everything is encoded we can collect the strings into
1571 NEW_ARGV. */
1572 new_argv = alloca ((nargs - 1) * sizeof *new_argv);
1573 new_argv[nargs - 2] = 0;
1575 for (i = nargs - 2; i-- != 0; )
1577 new_argv[i] = SDATA (XCAR (tem));
1578 tem = XCDR (tem);
1581 create_process (proc, (char **) new_argv, current_dir);
1583 else
1584 create_pty (proc);
1586 return unbind_to (count, proc);
1589 /* This function is the unwind_protect form for Fstart_process. If
1590 PROC doesn't have its pid set, then we know someone has signaled
1591 an error and the process wasn't started successfully, so we should
1592 remove it from the process list. */
1593 static Lisp_Object
1594 start_process_unwind (Lisp_Object proc)
1596 if (!PROCESSP (proc))
1597 emacs_abort ();
1599 /* Was PROC started successfully?
1600 -2 is used for a pty with no process, eg for gdb. */
1601 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1602 remove_process (proc);
1604 return Qnil;
1607 static void
1608 create_process_1 (struct atimer *timer)
1610 /* Nothing to do. */
1614 static void
1615 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1617 int inchannel, outchannel;
1618 pid_t pid;
1619 int vfork_errno;
1620 int sv[2];
1621 #ifndef WINDOWSNT
1622 int wait_child_setup[2];
1623 #endif
1624 int forkin, forkout;
1625 bool pty_flag = 0;
1626 Lisp_Object lisp_pty_name = Qnil;
1627 Lisp_Object encoded_current_dir;
1629 inchannel = outchannel = -1;
1631 #ifdef HAVE_PTYS
1632 if (!NILP (Vprocess_connection_type))
1633 outchannel = inchannel = allocate_pty ();
1635 if (inchannel >= 0)
1637 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1638 /* On most USG systems it does not work to open the pty's tty here,
1639 then close it and reopen it in the child. */
1640 /* Don't let this terminal become our controlling terminal
1641 (in case we don't have one). */
1642 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1643 if (forkin < 0)
1644 report_file_error ("Opening pty", Qnil);
1645 #else
1646 forkin = forkout = -1;
1647 #endif /* not USG, or USG_SUBTTY_WORKS */
1648 pty_flag = 1;
1649 lisp_pty_name = build_string (pty_name);
1651 else
1652 #endif /* HAVE_PTYS */
1654 if (pipe2 (sv, O_CLOEXEC) != 0)
1655 report_file_error ("Creating pipe", Qnil);
1656 inchannel = sv[0];
1657 forkout = sv[1];
1658 if (pipe2 (sv, O_CLOEXEC) != 0)
1660 int pipe_errno = errno;
1661 emacs_close (inchannel);
1662 emacs_close (forkout);
1663 report_file_errno ("Creating pipe", Qnil, pipe_errno);
1665 outchannel = sv[1];
1666 forkin = sv[0];
1669 #ifndef WINDOWSNT
1670 if (pipe2 (wait_child_setup, O_CLOEXEC) != 0)
1671 report_file_error ("Creating pipe", Qnil);
1672 #endif
1674 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1675 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1677 /* Record this as an active process, with its channels. */
1678 chan_process[inchannel] = process;
1679 XPROCESS (process)->infd = inchannel;
1680 XPROCESS (process)->outfd = outchannel;
1682 /* Previously we recorded the tty descriptor used in the subprocess.
1683 It was only used for getting the foreground tty process, so now
1684 we just reopen the device (see emacs_get_tty_pgrp) as this is
1685 more portable (see USG_SUBTTY_WORKS above). */
1687 XPROCESS (process)->pty_flag = pty_flag;
1688 pset_status (XPROCESS (process), Qrun);
1690 FD_SET (inchannel, &input_wait_mask);
1691 FD_SET (inchannel, &non_keyboard_wait_mask);
1692 if (inchannel > max_process_desc)
1693 max_process_desc = inchannel;
1695 /* This may signal an error. */
1696 setup_process_coding_systems (process);
1698 encoded_current_dir = ENCODE_FILE (current_dir);
1700 block_input ();
1701 block_child_signal ();
1703 #ifndef WINDOWSNT
1704 /* vfork, and prevent local vars from being clobbered by the vfork. */
1706 Lisp_Object volatile encoded_current_dir_volatile = encoded_current_dir;
1707 Lisp_Object volatile lisp_pty_name_volatile = lisp_pty_name;
1708 Lisp_Object volatile process_volatile = process;
1709 bool volatile pty_flag_volatile = pty_flag;
1710 char **volatile new_argv_volatile = new_argv;
1711 int volatile forkin_volatile = forkin;
1712 int volatile forkout_volatile = forkout;
1713 int volatile wait_child_setup_0_volatile = wait_child_setup[0];
1714 int volatile wait_child_setup_1_volatile = wait_child_setup[1];
1716 pid = vfork ();
1718 encoded_current_dir = encoded_current_dir_volatile;
1719 lisp_pty_name = lisp_pty_name_volatile;
1720 process = process_volatile;
1721 pty_flag = pty_flag_volatile;
1722 new_argv = new_argv_volatile;
1723 forkin = forkin_volatile;
1724 forkout = forkout_volatile;
1725 wait_child_setup[0] = wait_child_setup_0_volatile;
1726 wait_child_setup[1] = wait_child_setup_1_volatile;
1729 if (pid == 0)
1730 #endif /* not WINDOWSNT */
1732 int xforkin = forkin;
1733 int xforkout = forkout;
1735 /* Make the pty be the controlling terminal of the process. */
1736 #ifdef HAVE_PTYS
1737 /* First, disconnect its current controlling terminal. */
1738 /* We tried doing setsid only if pty_flag, but it caused
1739 process_set_signal to fail on SGI when using a pipe. */
1740 setsid ();
1741 /* Make the pty's terminal the controlling terminal. */
1742 if (pty_flag && xforkin >= 0)
1744 #ifdef TIOCSCTTY
1745 /* We ignore the return value
1746 because faith@cs.unc.edu says that is necessary on Linux. */
1747 ioctl (xforkin, TIOCSCTTY, 0);
1748 #endif
1750 #if defined (LDISC1)
1751 if (pty_flag && xforkin >= 0)
1753 struct termios t;
1754 tcgetattr (xforkin, &t);
1755 t.c_lflag = LDISC1;
1756 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1757 emacs_perror ("create_process/tcsetattr LDISC1");
1759 #else
1760 #if defined (NTTYDISC) && defined (TIOCSETD)
1761 if (pty_flag && xforkin >= 0)
1763 /* Use new line discipline. */
1764 int ldisc = NTTYDISC;
1765 ioctl (xforkin, TIOCSETD, &ldisc);
1767 #endif
1768 #endif
1769 #ifdef TIOCNOTTY
1770 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1771 can do TIOCSPGRP only to the process's controlling tty. */
1772 if (pty_flag)
1774 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1775 I can't test it since I don't have 4.3. */
1776 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1777 if (j >= 0)
1779 ioctl (j, TIOCNOTTY, 0);
1780 emacs_close (j);
1783 #endif /* TIOCNOTTY */
1785 #if !defined (DONT_REOPEN_PTY)
1786 /*** There is a suggestion that this ought to be a
1787 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
1788 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1789 that system does seem to need this code, even though
1790 both TIOCSCTTY is defined. */
1791 /* Now close the pty (if we had it open) and reopen it.
1792 This makes the pty the controlling terminal of the subprocess. */
1793 if (pty_flag)
1796 /* I wonder if emacs_close (emacs_open (pty_name, ...))
1797 would work? */
1798 if (xforkin >= 0)
1799 emacs_close (xforkin);
1800 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
1802 if (xforkin < 0)
1804 emacs_perror (pty_name);
1805 _exit (EXIT_CANCELED);
1809 #endif /* not DONT_REOPEN_PTY */
1811 #ifdef SETUP_SLAVE_PTY
1812 if (pty_flag)
1814 SETUP_SLAVE_PTY;
1816 #endif /* SETUP_SLAVE_PTY */
1817 #endif /* HAVE_PTYS */
1819 signal (SIGINT, SIG_DFL);
1820 signal (SIGQUIT, SIG_DFL);
1822 /* Emacs ignores SIGPIPE, but the child should not. */
1823 signal (SIGPIPE, SIG_DFL);
1825 /* Stop blocking SIGCHLD in the child. */
1826 unblock_child_signal ();
1828 if (pty_flag)
1829 child_setup_tty (xforkout);
1830 #ifdef WINDOWSNT
1831 pid = child_setup (xforkin, xforkout, xforkout,
1832 new_argv, 1, encoded_current_dir);
1833 #else /* not WINDOWSNT */
1834 child_setup (xforkin, xforkout, xforkout,
1835 new_argv, 1, encoded_current_dir);
1836 #endif /* not WINDOWSNT */
1839 /* Back in the parent process. */
1841 vfork_errno = errno;
1842 XPROCESS (process)->pid = pid;
1843 if (pid >= 0)
1844 XPROCESS (process)->alive = 1;
1846 /* Stop blocking in the parent. */
1847 unblock_child_signal ();
1848 unblock_input ();
1850 if (pid < 0)
1852 if (forkin >= 0)
1853 emacs_close (forkin);
1854 if (forkin != forkout && forkout >= 0)
1855 emacs_close (forkout);
1856 report_file_errno ("Doing vfork", Qnil, vfork_errno);
1858 else
1860 /* vfork succeeded. */
1862 #ifdef WINDOWSNT
1863 register_child (pid, inchannel);
1864 #endif /* WINDOWSNT */
1866 /* If the subfork execv fails, and it exits,
1867 this close hangs. I don't know why.
1868 So have an interrupt jar it loose. */
1870 struct atimer *timer;
1871 EMACS_TIME offset = make_emacs_time (1, 0);
1873 stop_polling ();
1874 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
1876 if (forkin >= 0)
1877 emacs_close (forkin);
1879 cancel_atimer (timer);
1880 start_polling ();
1883 if (forkin != forkout && forkout >= 0)
1884 emacs_close (forkout);
1886 pset_tty_name (XPROCESS (process), lisp_pty_name);
1888 #ifndef WINDOWSNT
1889 /* Wait for child_setup to complete in case that vfork is
1890 actually defined as fork. The descriptor wait_child_setup[1]
1891 of a pipe is closed at the child side either by close-on-exec
1892 on successful execve or the _exit call in child_setup. */
1894 char dummy;
1896 emacs_close (wait_child_setup[1]);
1897 emacs_read (wait_child_setup[0], &dummy, 1);
1898 emacs_close (wait_child_setup[0]);
1900 #endif
1904 void
1905 create_pty (Lisp_Object process)
1907 int inchannel, outchannel;
1908 bool pty_flag = 0;
1910 inchannel = outchannel = -1;
1912 #ifdef HAVE_PTYS
1913 if (!NILP (Vprocess_connection_type))
1914 outchannel = inchannel = allocate_pty ();
1916 if (inchannel >= 0)
1918 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1919 /* On most USG systems it does not work to open the pty's tty here,
1920 then close it and reopen it in the child. */
1921 /* Don't let this terminal become our controlling terminal
1922 (in case we don't have one). */
1923 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1924 if (forkout < 0)
1925 report_file_error ("Opening pty", Qnil);
1926 #if defined (DONT_REOPEN_PTY)
1927 /* In the case that vfork is defined as fork, the parent process
1928 (Emacs) may send some data before the child process completes
1929 tty options setup. So we setup tty before forking. */
1930 child_setup_tty (forkout);
1931 #endif /* DONT_REOPEN_PTY */
1932 #endif /* not USG, or USG_SUBTTY_WORKS */
1933 pty_flag = 1;
1935 #endif /* HAVE_PTYS */
1937 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1938 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1940 /* Record this as an active process, with its channels.
1941 As a result, child_setup will close Emacs's side of the pipes. */
1942 chan_process[inchannel] = process;
1943 XPROCESS (process)->infd = inchannel;
1944 XPROCESS (process)->outfd = outchannel;
1946 /* Previously we recorded the tty descriptor used in the subprocess.
1947 It was only used for getting the foreground tty process, so now
1948 we just reopen the device (see emacs_get_tty_pgrp) as this is
1949 more portable (see USG_SUBTTY_WORKS above). */
1951 XPROCESS (process)->pty_flag = pty_flag;
1952 pset_status (XPROCESS (process), Qrun);
1953 setup_process_coding_systems (process);
1955 FD_SET (inchannel, &input_wait_mask);
1956 FD_SET (inchannel, &non_keyboard_wait_mask);
1957 if (inchannel > max_process_desc)
1958 max_process_desc = inchannel;
1960 XPROCESS (process)->pid = -2;
1961 #ifdef HAVE_PTYS
1962 if (pty_flag)
1963 pset_tty_name (XPROCESS (process), build_string (pty_name));
1964 else
1965 #endif
1966 pset_tty_name (XPROCESS (process), Qnil);
1970 /* Convert an internal struct sockaddr to a lisp object (vector or string).
1971 The address family of sa is not included in the result. */
1973 static Lisp_Object
1974 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
1976 Lisp_Object address;
1977 int i;
1978 unsigned char *cp;
1979 register struct Lisp_Vector *p;
1981 /* Workaround for a bug in getsockname on BSD: Names bound to
1982 sockets in the UNIX domain are inaccessible; getsockname returns
1983 a zero length name. */
1984 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
1985 return empty_unibyte_string;
1987 switch (sa->sa_family)
1989 case AF_INET:
1991 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
1992 len = sizeof (sin->sin_addr) + 1;
1993 address = Fmake_vector (make_number (len), Qnil);
1994 p = XVECTOR (address);
1995 p->contents[--len] = make_number (ntohs (sin->sin_port));
1996 cp = (unsigned char *) &sin->sin_addr;
1997 break;
1999 #ifdef AF_INET6
2000 case AF_INET6:
2002 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2003 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
2004 len = sizeof (sin6->sin6_addr)/2 + 1;
2005 address = Fmake_vector (make_number (len), Qnil);
2006 p = XVECTOR (address);
2007 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2008 for (i = 0; i < len; i++)
2009 p->contents[i] = make_number (ntohs (ip6[i]));
2010 return address;
2012 #endif
2013 #ifdef HAVE_LOCAL_SOCKETS
2014 case AF_LOCAL:
2016 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2017 for (i = 0; i < sizeof (sockun->sun_path); i++)
2018 if (sockun->sun_path[i] == 0)
2019 break;
2020 return make_unibyte_string (sockun->sun_path, i);
2022 #endif
2023 default:
2024 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2025 address = Fcons (make_number (sa->sa_family),
2026 Fmake_vector (make_number (len), Qnil));
2027 p = XVECTOR (XCDR (address));
2028 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2029 break;
2032 i = 0;
2033 while (i < len)
2034 p->contents[i++] = make_number (*cp++);
2036 return address;
2040 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2042 static int
2043 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2045 register struct Lisp_Vector *p;
2047 if (VECTORP (address))
2049 p = XVECTOR (address);
2050 if (p->header.size == 5)
2052 *familyp = AF_INET;
2053 return sizeof (struct sockaddr_in);
2055 #ifdef AF_INET6
2056 else if (p->header.size == 9)
2058 *familyp = AF_INET6;
2059 return sizeof (struct sockaddr_in6);
2061 #endif
2063 #ifdef HAVE_LOCAL_SOCKETS
2064 else if (STRINGP (address))
2066 *familyp = AF_LOCAL;
2067 return sizeof (struct sockaddr_un);
2069 #endif
2070 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2071 && VECTORP (XCDR (address)))
2073 struct sockaddr *sa;
2074 *familyp = XINT (XCAR (address));
2075 p = XVECTOR (XCDR (address));
2076 return p->header.size + sizeof (sa->sa_family);
2078 return 0;
2081 /* Convert an address object (vector or string) to an internal sockaddr.
2083 The address format has been basically validated by
2084 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2085 it could have come from user data. So if FAMILY is not valid,
2086 we return after zeroing *SA. */
2088 static void
2089 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2091 register struct Lisp_Vector *p;
2092 register unsigned char *cp = NULL;
2093 register int i;
2094 EMACS_INT hostport;
2096 memset (sa, 0, len);
2098 if (VECTORP (address))
2100 p = XVECTOR (address);
2101 if (family == AF_INET)
2103 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2104 len = sizeof (sin->sin_addr) + 1;
2105 hostport = XINT (p->contents[--len]);
2106 sin->sin_port = htons (hostport);
2107 cp = (unsigned char *)&sin->sin_addr;
2108 sa->sa_family = family;
2110 #ifdef AF_INET6
2111 else if (family == AF_INET6)
2113 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2114 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2115 len = sizeof (sin6->sin6_addr) + 1;
2116 hostport = XINT (p->contents[--len]);
2117 sin6->sin6_port = htons (hostport);
2118 for (i = 0; i < len; i++)
2119 if (INTEGERP (p->contents[i]))
2121 int j = XFASTINT (p->contents[i]) & 0xffff;
2122 ip6[i] = ntohs (j);
2124 sa->sa_family = family;
2125 return;
2127 #endif
2128 else
2129 return;
2131 else if (STRINGP (address))
2133 #ifdef HAVE_LOCAL_SOCKETS
2134 if (family == AF_LOCAL)
2136 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2137 cp = SDATA (address);
2138 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2139 sockun->sun_path[i] = *cp++;
2140 sa->sa_family = family;
2142 #endif
2143 return;
2145 else
2147 p = XVECTOR (XCDR (address));
2148 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2151 for (i = 0; i < len; i++)
2152 if (INTEGERP (p->contents[i]))
2153 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2156 #ifdef DATAGRAM_SOCKETS
2157 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2158 1, 1, 0,
2159 doc: /* Get the current datagram address associated with PROCESS. */)
2160 (Lisp_Object process)
2162 int channel;
2164 CHECK_PROCESS (process);
2166 if (!DATAGRAM_CONN_P (process))
2167 return Qnil;
2169 channel = XPROCESS (process)->infd;
2170 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2171 datagram_address[channel].len);
2174 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2175 2, 2, 0,
2176 doc: /* Set the datagram address for PROCESS to ADDRESS.
2177 Returns nil upon error setting address, ADDRESS otherwise. */)
2178 (Lisp_Object process, Lisp_Object address)
2180 int channel;
2181 int family, len;
2183 CHECK_PROCESS (process);
2185 if (!DATAGRAM_CONN_P (process))
2186 return Qnil;
2188 channel = XPROCESS (process)->infd;
2190 len = get_lisp_to_sockaddr_size (address, &family);
2191 if (len == 0 || datagram_address[channel].len != len)
2192 return Qnil;
2193 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2194 return address;
2196 #endif
2199 static const struct socket_options {
2200 /* The name of this option. Should be lowercase version of option
2201 name without SO_ prefix. */
2202 const char *name;
2203 /* Option level SOL_... */
2204 int optlevel;
2205 /* Option number SO_... */
2206 int optnum;
2207 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2208 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2209 } socket_options[] =
2211 #ifdef SO_BINDTODEVICE
2212 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2213 #endif
2214 #ifdef SO_BROADCAST
2215 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2216 #endif
2217 #ifdef SO_DONTROUTE
2218 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2219 #endif
2220 #ifdef SO_KEEPALIVE
2221 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2222 #endif
2223 #ifdef SO_LINGER
2224 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2225 #endif
2226 #ifdef SO_OOBINLINE
2227 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2228 #endif
2229 #ifdef SO_PRIORITY
2230 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2231 #endif
2232 #ifdef SO_REUSEADDR
2233 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2234 #endif
2235 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2238 /* Set option OPT to value VAL on socket S.
2240 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2241 Signals an error if setting a known option fails.
2244 static int
2245 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2247 char *name;
2248 const struct socket_options *sopt;
2249 int ret = 0;
2251 CHECK_SYMBOL (opt);
2253 name = SSDATA (SYMBOL_NAME (opt));
2254 for (sopt = socket_options; sopt->name; sopt++)
2255 if (strcmp (name, sopt->name) == 0)
2256 break;
2258 switch (sopt->opttype)
2260 case SOPT_BOOL:
2262 int optval;
2263 optval = NILP (val) ? 0 : 1;
2264 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2265 &optval, sizeof (optval));
2266 break;
2269 case SOPT_INT:
2271 int optval;
2272 if (TYPE_RANGED_INTEGERP (int, val))
2273 optval = XINT (val);
2274 else
2275 error ("Bad option value for %s", name);
2276 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2277 &optval, sizeof (optval));
2278 break;
2281 #ifdef SO_BINDTODEVICE
2282 case SOPT_IFNAME:
2284 char devname[IFNAMSIZ+1];
2286 /* This is broken, at least in the Linux 2.4 kernel.
2287 To unbind, the arg must be a zero integer, not the empty string.
2288 This should work on all systems. KFS. 2003-09-23. */
2289 memset (devname, 0, sizeof devname);
2290 if (STRINGP (val))
2292 char *arg = SSDATA (val);
2293 int len = min (strlen (arg), IFNAMSIZ);
2294 memcpy (devname, arg, len);
2296 else if (!NILP (val))
2297 error ("Bad option value for %s", name);
2298 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2299 devname, IFNAMSIZ);
2300 break;
2302 #endif
2304 #ifdef SO_LINGER
2305 case SOPT_LINGER:
2307 struct linger linger;
2309 linger.l_onoff = 1;
2310 linger.l_linger = 0;
2311 if (TYPE_RANGED_INTEGERP (int, val))
2312 linger.l_linger = XINT (val);
2313 else
2314 linger.l_onoff = NILP (val) ? 0 : 1;
2315 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2316 &linger, sizeof (linger));
2317 break;
2319 #endif
2321 default:
2322 return 0;
2325 if (ret < 0)
2326 report_file_error ("Cannot set network option",
2327 Fcons (opt, Fcons (val, Qnil)));
2328 return (1 << sopt->optbit);
2332 DEFUN ("set-network-process-option",
2333 Fset_network_process_option, Sset_network_process_option,
2334 3, 4, 0,
2335 doc: /* For network process PROCESS set option OPTION to value VALUE.
2336 See `make-network-process' for a list of options and values.
2337 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2338 OPTION is not a supported option, return nil instead; otherwise return t. */)
2339 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2341 int s;
2342 struct Lisp_Process *p;
2344 CHECK_PROCESS (process);
2345 p = XPROCESS (process);
2346 if (!NETCONN1_P (p))
2347 error ("Process is not a network process");
2349 s = p->infd;
2350 if (s < 0)
2351 error ("Process is not running");
2353 if (set_socket_option (s, option, value))
2355 pset_childp (p, Fplist_put (p->childp, option, value));
2356 return Qt;
2359 if (NILP (no_error))
2360 error ("Unknown or unsupported option");
2362 return Qnil;
2366 DEFUN ("serial-process-configure",
2367 Fserial_process_configure,
2368 Sserial_process_configure,
2369 0, MANY, 0,
2370 doc: /* Configure speed, bytesize, etc. of a serial process.
2372 Arguments are specified as keyword/argument pairs. Attributes that
2373 are not given are re-initialized from the process's current
2374 configuration (available via the function `process-contact') or set to
2375 reasonable default values. The following arguments are defined:
2377 :process PROCESS
2378 :name NAME
2379 :buffer BUFFER
2380 :port PORT
2381 -- Any of these arguments can be given to identify the process that is
2382 to be configured. If none of these arguments is given, the current
2383 buffer's process is used.
2385 :speed SPEED -- SPEED is the speed of the serial port in bits per
2386 second, also called baud rate. Any value can be given for SPEED, but
2387 most serial ports work only at a few defined values between 1200 and
2388 115200, with 9600 being the most common value. If SPEED is nil, the
2389 serial port is not configured any further, i.e., all other arguments
2390 are ignored. This may be useful for special serial ports such as
2391 Bluetooth-to-serial converters which can only be configured through AT
2392 commands. A value of nil for SPEED can be used only when passed
2393 through `make-serial-process' or `serial-term'.
2395 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2396 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2398 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2399 `odd' (use odd parity), or the symbol `even' (use even parity). If
2400 PARITY is not given, no parity is used.
2402 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2403 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2404 is not given or nil, 1 stopbit is used.
2406 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2407 flowcontrol to be used, which is either nil (don't use flowcontrol),
2408 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2409 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2410 flowcontrol is used.
2412 `serial-process-configure' is called by `make-serial-process' for the
2413 initial configuration of the serial port.
2415 Examples:
2417 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2419 \(serial-process-configure
2420 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2422 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2424 usage: (serial-process-configure &rest ARGS) */)
2425 (ptrdiff_t nargs, Lisp_Object *args)
2427 struct Lisp_Process *p;
2428 Lisp_Object contact = Qnil;
2429 Lisp_Object proc = Qnil;
2430 struct gcpro gcpro1;
2432 contact = Flist (nargs, args);
2433 GCPRO1 (contact);
2435 proc = Fplist_get (contact, QCprocess);
2436 if (NILP (proc))
2437 proc = Fplist_get (contact, QCname);
2438 if (NILP (proc))
2439 proc = Fplist_get (contact, QCbuffer);
2440 if (NILP (proc))
2441 proc = Fplist_get (contact, QCport);
2442 proc = get_process (proc);
2443 p = XPROCESS (proc);
2444 if (!EQ (p->type, Qserial))
2445 error ("Not a serial process");
2447 if (NILP (Fplist_get (p->childp, QCspeed)))
2449 UNGCPRO;
2450 return Qnil;
2453 serial_configure (p, contact);
2455 UNGCPRO;
2456 return Qnil;
2459 /* Used by make-serial-process to recover from errors. */
2460 static Lisp_Object
2461 make_serial_process_unwind (Lisp_Object proc)
2463 if (!PROCESSP (proc))
2464 emacs_abort ();
2465 remove_process (proc);
2466 return Qnil;
2469 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2470 0, MANY, 0,
2471 doc: /* Create and return a serial port process.
2473 In Emacs, serial port connections are represented by process objects,
2474 so input and output work as for subprocesses, and `delete-process'
2475 closes a serial port connection. However, a serial process has no
2476 process id, it cannot be signaled, and the status codes are different
2477 from normal processes.
2479 `make-serial-process' creates a process and a buffer, on which you
2480 probably want to use `process-send-string'. Try \\[serial-term] for
2481 an interactive terminal. See below for examples.
2483 Arguments are specified as keyword/argument pairs. The following
2484 arguments are defined:
2486 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2487 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2488 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2489 the backslashes in strings).
2491 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2492 which this function calls.
2494 :name NAME -- NAME is the name of the process. If NAME is not given,
2495 the value of PORT is used.
2497 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2498 with the process. Process output goes at the end of that buffer,
2499 unless you specify an output stream or filter function to handle the
2500 output. If BUFFER is not given, the value of NAME is used.
2502 :coding CODING -- If CODING is a symbol, it specifies the coding
2503 system used for both reading and writing for this process. If CODING
2504 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2505 ENCODING is used for writing.
2507 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2508 the process is running. If BOOL is not given, query before exiting.
2510 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2511 In the stopped state, a serial process does not accept incoming data,
2512 but you can send outgoing data. The stopped state is cleared by
2513 `continue-process' and set by `stop-process'.
2515 :filter FILTER -- Install FILTER as the process filter.
2517 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2519 :plist PLIST -- Install PLIST as the initial plist of the process.
2521 :bytesize
2522 :parity
2523 :stopbits
2524 :flowcontrol
2525 -- This function calls `serial-process-configure' to handle these
2526 arguments.
2528 The original argument list, possibly modified by later configuration,
2529 is available via the function `process-contact'.
2531 Examples:
2533 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2535 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2537 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2539 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2541 usage: (make-serial-process &rest ARGS) */)
2542 (ptrdiff_t nargs, Lisp_Object *args)
2544 int fd = -1;
2545 Lisp_Object proc, contact, port;
2546 struct Lisp_Process *p;
2547 struct gcpro gcpro1;
2548 Lisp_Object name, buffer;
2549 Lisp_Object tem, val;
2550 ptrdiff_t specpdl_count;
2552 if (nargs == 0)
2553 return Qnil;
2555 contact = Flist (nargs, args);
2556 GCPRO1 (contact);
2558 port = Fplist_get (contact, QCport);
2559 if (NILP (port))
2560 error ("No port specified");
2561 CHECK_STRING (port);
2563 if (NILP (Fplist_member (contact, QCspeed)))
2564 error (":speed not specified");
2565 if (!NILP (Fplist_get (contact, QCspeed)))
2566 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2568 name = Fplist_get (contact, QCname);
2569 if (NILP (name))
2570 name = port;
2571 CHECK_STRING (name);
2572 proc = make_process (name);
2573 specpdl_count = SPECPDL_INDEX ();
2574 record_unwind_protect (make_serial_process_unwind, proc);
2575 p = XPROCESS (proc);
2577 fd = serial_open (SSDATA (port));
2578 p->infd = fd;
2579 p->outfd = fd;
2580 if (fd > max_process_desc)
2581 max_process_desc = fd;
2582 chan_process[fd] = proc;
2584 buffer = Fplist_get (contact, QCbuffer);
2585 if (NILP (buffer))
2586 buffer = name;
2587 buffer = Fget_buffer_create (buffer);
2588 pset_buffer (p, buffer);
2590 pset_childp (p, contact);
2591 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2592 pset_type (p, Qserial);
2593 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2594 pset_filter (p, Fplist_get (contact, QCfilter));
2595 pset_log (p, Qnil);
2596 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2597 p->kill_without_query = 1;
2598 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2599 pset_command (p, Qt);
2600 p->pty_flag = 0;
2602 if (!EQ (p->command, Qt))
2604 FD_SET (fd, &input_wait_mask);
2605 FD_SET (fd, &non_keyboard_wait_mask);
2608 if (BUFFERP (buffer))
2610 set_marker_both (p->mark, buffer,
2611 BUF_ZV (XBUFFER (buffer)),
2612 BUF_ZV_BYTE (XBUFFER (buffer)));
2615 tem = Fplist_member (contact, QCcoding);
2616 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2617 tem = Qnil;
2619 val = Qnil;
2620 if (!NILP (tem))
2622 val = XCAR (XCDR (tem));
2623 if (CONSP (val))
2624 val = XCAR (val);
2626 else if (!NILP (Vcoding_system_for_read))
2627 val = Vcoding_system_for_read;
2628 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2629 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2630 val = Qnil;
2631 pset_decode_coding_system (p, val);
2633 val = Qnil;
2634 if (!NILP (tem))
2636 val = XCAR (XCDR (tem));
2637 if (CONSP (val))
2638 val = XCDR (val);
2640 else if (!NILP (Vcoding_system_for_write))
2641 val = Vcoding_system_for_write;
2642 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2643 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2644 val = Qnil;
2645 pset_encode_coding_system (p, val);
2647 setup_process_coding_systems (proc);
2648 pset_decoding_buf (p, empty_unibyte_string);
2649 p->decoding_carryover = 0;
2650 pset_encoding_buf (p, empty_unibyte_string);
2651 p->inherit_coding_system_flag
2652 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2654 Fserial_process_configure (nargs, args);
2656 specpdl_ptr = specpdl + specpdl_count;
2658 UNGCPRO;
2659 return proc;
2662 /* Create a network stream/datagram client/server process. Treated
2663 exactly like a normal process when reading and writing. Primary
2664 differences are in status display and process deletion. A network
2665 connection has no PID; you cannot signal it. All you can do is
2666 stop/continue it and deactivate/close it via delete-process */
2668 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2669 0, MANY, 0,
2670 doc: /* Create and return a network server or client process.
2672 In Emacs, network connections are represented by process objects, so
2673 input and output work as for subprocesses and `delete-process' closes
2674 a network connection. However, a network process has no process id,
2675 it cannot be signaled, and the status codes are different from normal
2676 processes.
2678 Arguments are specified as keyword/argument pairs. The following
2679 arguments are defined:
2681 :name NAME -- NAME is name for process. It is modified if necessary
2682 to make it unique.
2684 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2685 with the process. Process output goes at end of that buffer, unless
2686 you specify an output stream or filter function to handle the output.
2687 BUFFER may be also nil, meaning that this process is not associated
2688 with any buffer.
2690 :host HOST -- HOST is name of the host to connect to, or its IP
2691 address. The symbol `local' specifies the local host. If specified
2692 for a server process, it must be a valid name or address for the local
2693 host, and only clients connecting to that address will be accepted.
2695 :service SERVICE -- SERVICE is name of the service desired, or an
2696 integer specifying a port number to connect to. If SERVICE is t,
2697 a random port number is selected for the server. (If Emacs was
2698 compiled with getaddrinfo, a port number can also be specified as a
2699 string, e.g. "80", as well as an integer. This is not portable.)
2701 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2702 stream type connection, `datagram' creates a datagram type connection,
2703 `seqpacket' creates a reliable datagram connection.
2705 :family FAMILY -- FAMILY is the address (and protocol) family for the
2706 service specified by HOST and SERVICE. The default (nil) is to use
2707 whatever address family (IPv4 or IPv6) that is defined for the host
2708 and port number specified by HOST and SERVICE. Other address families
2709 supported are:
2710 local -- for a local (i.e. UNIX) address specified by SERVICE.
2711 ipv4 -- use IPv4 address family only.
2712 ipv6 -- use IPv6 address family only.
2714 :local ADDRESS -- ADDRESS is the local address used for the connection.
2715 This parameter is ignored when opening a client process. When specified
2716 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2718 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2719 connection. This parameter is ignored when opening a stream server
2720 process. For a datagram server process, it specifies the initial
2721 setting of the remote datagram address. When specified for a client
2722 process, the FAMILY, HOST, and SERVICE args are ignored.
2724 The format of ADDRESS depends on the address family:
2725 - An IPv4 address is represented as an vector of integers [A B C D P]
2726 corresponding to numeric IP address A.B.C.D and port number P.
2727 - A local address is represented as a string with the address in the
2728 local address space.
2729 - An "unsupported family" address is represented by a cons (F . AV)
2730 where F is the family number and AV is a vector containing the socket
2731 address data with one element per address data byte. Do not rely on
2732 this format in portable code, as it may depend on implementation
2733 defined constants, data sizes, and data structure alignment.
2735 :coding CODING -- If CODING is a symbol, it specifies the coding
2736 system used for both reading and writing for this process. If CODING
2737 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2738 ENCODING is used for writing.
2740 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2741 return without waiting for the connection to complete; instead, the
2742 sentinel function will be called with second arg matching "open" (if
2743 successful) or "failed" when the connect completes. Default is to use
2744 a blocking connect (i.e. wait) for stream type connections.
2746 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2747 running when Emacs is exited.
2749 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2750 In the stopped state, a server process does not accept new
2751 connections, and a client process does not handle incoming traffic.
2752 The stopped state is cleared by `continue-process' and set by
2753 `stop-process'.
2755 :filter FILTER -- Install FILTER as the process filter.
2757 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2758 process filter are multibyte, otherwise they are unibyte.
2759 If this keyword is not specified, the strings are multibyte if
2760 the default value of `enable-multibyte-characters' is non-nil.
2762 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2764 :log LOG -- Install LOG as the server process log function. This
2765 function is called when the server accepts a network connection from a
2766 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2767 is the server process, CLIENT is the new process for the connection,
2768 and MESSAGE is a string.
2770 :plist PLIST -- Install PLIST as the new process' initial plist.
2772 :server QLEN -- if QLEN is non-nil, create a server process for the
2773 specified FAMILY, SERVICE, and connection type (stream or datagram).
2774 If QLEN is an integer, it is used as the max. length of the server's
2775 pending connection queue (also known as the backlog); the default
2776 queue length is 5. Default is to create a client process.
2778 The following network options can be specified for this connection:
2780 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2781 :dontroute BOOL -- Only send to directly connected hosts.
2782 :keepalive BOOL -- Send keep-alive messages on network stream.
2783 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2784 :oobinline BOOL -- Place out-of-band data in receive data stream.
2785 :priority INT -- Set protocol defined priority for sent packets.
2786 :reuseaddr BOOL -- Allow reusing a recently used local address
2787 (this is allowed by default for a server process).
2788 :bindtodevice NAME -- bind to interface NAME. Using this may require
2789 special privileges on some systems.
2791 Consult the relevant system programmer's manual pages for more
2792 information on using these options.
2795 A server process will listen for and accept connections from clients.
2796 When a client connection is accepted, a new network process is created
2797 for the connection with the following parameters:
2799 - The client's process name is constructed by concatenating the server
2800 process' NAME and a client identification string.
2801 - If the FILTER argument is non-nil, the client process will not get a
2802 separate process buffer; otherwise, the client's process buffer is a newly
2803 created buffer named after the server process' BUFFER name or process
2804 NAME concatenated with the client identification string.
2805 - The connection type and the process filter and sentinel parameters are
2806 inherited from the server process' TYPE, FILTER and SENTINEL.
2807 - The client process' contact info is set according to the client's
2808 addressing information (typically an IP address and a port number).
2809 - The client process' plist is initialized from the server's plist.
2811 Notice that the FILTER and SENTINEL args are never used directly by
2812 the server process. Also, the BUFFER argument is not used directly by
2813 the server process, but via the optional :log function, accepted (and
2814 failed) connections may be logged in the server process' buffer.
2816 The original argument list, modified with the actual connection
2817 information, is available via the `process-contact' function.
2819 usage: (make-network-process &rest ARGS) */)
2820 (ptrdiff_t nargs, Lisp_Object *args)
2822 Lisp_Object proc;
2823 Lisp_Object contact;
2824 struct Lisp_Process *p;
2825 #ifdef HAVE_GETADDRINFO
2826 struct addrinfo ai, *res, *lres;
2827 struct addrinfo hints;
2828 const char *portstring;
2829 char portbuf[128];
2830 #else /* HAVE_GETADDRINFO */
2831 struct _emacs_addrinfo
2833 int ai_family;
2834 int ai_socktype;
2835 int ai_protocol;
2836 int ai_addrlen;
2837 struct sockaddr *ai_addr;
2838 struct _emacs_addrinfo *ai_next;
2839 } ai, *res, *lres;
2840 #endif /* HAVE_GETADDRINFO */
2841 struct sockaddr_in address_in;
2842 #ifdef HAVE_LOCAL_SOCKETS
2843 struct sockaddr_un address_un;
2844 #endif
2845 int port;
2846 int ret = 0;
2847 int xerrno = 0;
2848 int s = -1, outch, inch;
2849 struct gcpro gcpro1;
2850 ptrdiff_t count = SPECPDL_INDEX ();
2851 ptrdiff_t count1;
2852 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2853 Lisp_Object tem;
2854 Lisp_Object name, buffer, host, service, address;
2855 Lisp_Object filter, sentinel;
2856 bool is_non_blocking_client = 0;
2857 bool is_server = 0;
2858 int backlog = 5;
2859 int socktype;
2860 int family = -1;
2862 if (nargs == 0)
2863 return Qnil;
2865 /* Save arguments for process-contact and clone-process. */
2866 contact = Flist (nargs, args);
2867 GCPRO1 (contact);
2869 #ifdef WINDOWSNT
2870 /* Ensure socket support is loaded if available. */
2871 init_winsock (TRUE);
2872 #endif
2874 /* :type TYPE (nil: stream, datagram */
2875 tem = Fplist_get (contact, QCtype);
2876 if (NILP (tem))
2877 socktype = SOCK_STREAM;
2878 #ifdef DATAGRAM_SOCKETS
2879 else if (EQ (tem, Qdatagram))
2880 socktype = SOCK_DGRAM;
2881 #endif
2882 #ifdef HAVE_SEQPACKET
2883 else if (EQ (tem, Qseqpacket))
2884 socktype = SOCK_SEQPACKET;
2885 #endif
2886 else
2887 error ("Unsupported connection type");
2889 /* :server BOOL */
2890 tem = Fplist_get (contact, QCserver);
2891 if (!NILP (tem))
2893 /* Don't support network sockets when non-blocking mode is
2894 not available, since a blocked Emacs is not useful. */
2895 is_server = 1;
2896 if (TYPE_RANGED_INTEGERP (int, tem))
2897 backlog = XINT (tem);
2900 /* Make QCaddress an alias for :local (server) or :remote (client). */
2901 QCaddress = is_server ? QClocal : QCremote;
2903 /* :nowait BOOL */
2904 if (!is_server && socktype != SOCK_DGRAM
2905 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2907 #ifndef NON_BLOCKING_CONNECT
2908 error ("Non-blocking connect not supported");
2909 #else
2910 is_non_blocking_client = 1;
2911 #endif
2914 name = Fplist_get (contact, QCname);
2915 buffer = Fplist_get (contact, QCbuffer);
2916 filter = Fplist_get (contact, QCfilter);
2917 sentinel = Fplist_get (contact, QCsentinel);
2919 CHECK_STRING (name);
2921 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2922 ai.ai_socktype = socktype;
2923 ai.ai_protocol = 0;
2924 ai.ai_next = NULL;
2925 res = &ai;
2927 /* :local ADDRESS or :remote ADDRESS */
2928 address = Fplist_get (contact, QCaddress);
2929 if (!NILP (address))
2931 host = service = Qnil;
2933 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2934 error ("Malformed :address");
2935 ai.ai_family = family;
2936 ai.ai_addr = alloca (ai.ai_addrlen);
2937 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2938 goto open_socket;
2941 /* :family FAMILY -- nil (for Inet), local, or integer. */
2942 tem = Fplist_get (contact, QCfamily);
2943 if (NILP (tem))
2945 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
2946 family = AF_UNSPEC;
2947 #else
2948 family = AF_INET;
2949 #endif
2951 #ifdef HAVE_LOCAL_SOCKETS
2952 else if (EQ (tem, Qlocal))
2953 family = AF_LOCAL;
2954 #endif
2955 #ifdef AF_INET6
2956 else if (EQ (tem, Qipv6))
2957 family = AF_INET6;
2958 #endif
2959 else if (EQ (tem, Qipv4))
2960 family = AF_INET;
2961 else if (TYPE_RANGED_INTEGERP (int, tem))
2962 family = XINT (tem);
2963 else
2964 error ("Unknown address family");
2966 ai.ai_family = family;
2968 /* :service SERVICE -- string, integer (port number), or t (random port). */
2969 service = Fplist_get (contact, QCservice);
2971 /* :host HOST -- hostname, ip address, or 'local for localhost. */
2972 host = Fplist_get (contact, QChost);
2973 if (!NILP (host))
2975 if (EQ (host, Qlocal))
2976 /* Depending on setup, "localhost" may map to different IPv4 and/or
2977 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
2978 host = build_string ("127.0.0.1");
2979 CHECK_STRING (host);
2982 #ifdef HAVE_LOCAL_SOCKETS
2983 if (family == AF_LOCAL)
2985 if (!NILP (host))
2987 message (":family local ignores the :host \"%s\" property",
2988 SDATA (host));
2989 contact = Fplist_put (contact, QChost, Qnil);
2990 host = Qnil;
2992 CHECK_STRING (service);
2993 memset (&address_un, 0, sizeof address_un);
2994 address_un.sun_family = AF_LOCAL;
2995 if (sizeof address_un.sun_path <= SBYTES (service))
2996 error ("Service name too long");
2997 strcpy (address_un.sun_path, SSDATA (service));
2998 ai.ai_addr = (struct sockaddr *) &address_un;
2999 ai.ai_addrlen = sizeof address_un;
3000 goto open_socket;
3002 #endif
3004 /* Slow down polling to every ten seconds.
3005 Some kernels have a bug which causes retrying connect to fail
3006 after a connect. Polling can interfere with gethostbyname too. */
3007 #ifdef POLL_FOR_INPUT
3008 if (socktype != SOCK_DGRAM)
3010 record_unwind_protect (unwind_stop_other_atimers, Qnil);
3011 bind_polling_period (10);
3013 #endif
3015 #ifdef HAVE_GETADDRINFO
3016 /* If we have a host, use getaddrinfo to resolve both host and service.
3017 Otherwise, use getservbyname to lookup the service. */
3018 if (!NILP (host))
3021 /* SERVICE can either be a string or int.
3022 Convert to a C string for later use by getaddrinfo. */
3023 if (EQ (service, Qt))
3024 portstring = "0";
3025 else if (INTEGERP (service))
3027 sprintf (portbuf, "%"pI"d", XINT (service));
3028 portstring = portbuf;
3030 else
3032 CHECK_STRING (service);
3033 portstring = SSDATA (service);
3036 immediate_quit = 1;
3037 QUIT;
3038 memset (&hints, 0, sizeof (hints));
3039 hints.ai_flags = 0;
3040 hints.ai_family = family;
3041 hints.ai_socktype = socktype;
3042 hints.ai_protocol = 0;
3044 #ifdef HAVE_RES_INIT
3045 res_init ();
3046 #endif
3048 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3049 if (ret)
3050 #ifdef HAVE_GAI_STRERROR
3051 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3052 #else
3053 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3054 #endif
3055 immediate_quit = 0;
3057 goto open_socket;
3059 #endif /* HAVE_GETADDRINFO */
3061 /* We end up here if getaddrinfo is not defined, or in case no hostname
3062 has been specified (e.g. for a local server process). */
3064 if (EQ (service, Qt))
3065 port = 0;
3066 else if (INTEGERP (service))
3067 port = htons ((unsigned short) XINT (service));
3068 else
3070 struct servent *svc_info;
3071 CHECK_STRING (service);
3072 svc_info = getservbyname (SSDATA (service),
3073 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3074 if (svc_info == 0)
3075 error ("Unknown service: %s", SDATA (service));
3076 port = svc_info->s_port;
3079 memset (&address_in, 0, sizeof address_in);
3080 address_in.sin_family = family;
3081 address_in.sin_addr.s_addr = INADDR_ANY;
3082 address_in.sin_port = port;
3084 #ifndef HAVE_GETADDRINFO
3085 if (!NILP (host))
3087 struct hostent *host_info_ptr;
3089 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3090 as it may `hang' Emacs for a very long time. */
3091 immediate_quit = 1;
3092 QUIT;
3094 #ifdef HAVE_RES_INIT
3095 res_init ();
3096 #endif
3098 host_info_ptr = gethostbyname (SDATA (host));
3099 immediate_quit = 0;
3101 if (host_info_ptr)
3103 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3104 host_info_ptr->h_length);
3105 family = host_info_ptr->h_addrtype;
3106 address_in.sin_family = family;
3108 else
3109 /* Attempt to interpret host as numeric inet address */
3111 unsigned long numeric_addr;
3112 numeric_addr = inet_addr (SSDATA (host));
3113 if (numeric_addr == -1)
3114 error ("Unknown host \"%s\"", SDATA (host));
3116 memcpy (&address_in.sin_addr, &numeric_addr,
3117 sizeof (address_in.sin_addr));
3121 #endif /* not HAVE_GETADDRINFO */
3123 ai.ai_family = family;
3124 ai.ai_addr = (struct sockaddr *) &address_in;
3125 ai.ai_addrlen = sizeof address_in;
3127 open_socket:
3129 /* Do this in case we never enter the for-loop below. */
3130 count1 = SPECPDL_INDEX ();
3131 s = -1;
3133 for (lres = res; lres; lres = lres->ai_next)
3135 ptrdiff_t optn;
3136 int optbits;
3138 #ifdef WINDOWSNT
3139 retry_connect:
3140 #endif
3142 s = socket (lres->ai_family, lres->ai_socktype | SOCK_CLOEXEC,
3143 lres->ai_protocol);
3144 if (s < 0)
3146 xerrno = errno;
3147 continue;
3150 #ifdef DATAGRAM_SOCKETS
3151 if (!is_server && socktype == SOCK_DGRAM)
3152 break;
3153 #endif /* DATAGRAM_SOCKETS */
3155 #ifdef NON_BLOCKING_CONNECT
3156 if (is_non_blocking_client)
3158 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3159 if (ret < 0)
3161 xerrno = errno;
3162 emacs_close (s);
3163 s = -1;
3164 continue;
3167 #endif
3169 /* Make us close S if quit. */
3170 record_unwind_protect (close_file_unwind, make_number (s));
3172 /* Parse network options in the arg list.
3173 We simply ignore anything which isn't a known option (including other keywords).
3174 An error is signaled if setting a known option fails. */
3175 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3176 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3178 if (is_server)
3180 /* Configure as a server socket. */
3182 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3183 explicit :reuseaddr key to override this. */
3184 #ifdef HAVE_LOCAL_SOCKETS
3185 if (family != AF_LOCAL)
3186 #endif
3187 if (!(optbits & (1 << OPIX_REUSEADDR)))
3189 int optval = 1;
3190 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3191 report_file_error ("Cannot set reuse option on server socket", Qnil);
3194 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3195 report_file_error ("Cannot bind server socket", Qnil);
3197 #ifdef HAVE_GETSOCKNAME
3198 if (EQ (service, Qt))
3200 struct sockaddr_in sa1;
3201 socklen_t len1 = sizeof (sa1);
3202 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3204 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3205 service = make_number (ntohs (sa1.sin_port));
3206 contact = Fplist_put (contact, QCservice, service);
3209 #endif
3211 if (socktype != SOCK_DGRAM && listen (s, backlog))
3212 report_file_error ("Cannot listen on server socket", Qnil);
3214 break;
3217 immediate_quit = 1;
3218 QUIT;
3220 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3221 xerrno = errno;
3223 if (ret == 0 || xerrno == EISCONN)
3225 /* The unwind-protect will be discarded afterwards.
3226 Likewise for immediate_quit. */
3227 break;
3230 #ifdef NON_BLOCKING_CONNECT
3231 #ifdef EINPROGRESS
3232 if (is_non_blocking_client && xerrno == EINPROGRESS)
3233 break;
3234 #else
3235 #ifdef EWOULDBLOCK
3236 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3237 break;
3238 #endif
3239 #endif
3240 #endif
3242 #ifndef WINDOWSNT
3243 if (xerrno == EINTR)
3245 /* Unlike most other syscalls connect() cannot be called
3246 again. (That would return EALREADY.) The proper way to
3247 wait for completion is pselect(). */
3248 int sc;
3249 socklen_t len;
3250 SELECT_TYPE fdset;
3251 retry_select:
3252 FD_ZERO (&fdset);
3253 FD_SET (s, &fdset);
3254 QUIT;
3255 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3256 if (sc == -1)
3258 if (errno == EINTR)
3259 goto retry_select;
3260 else
3261 report_file_error ("select failed", Qnil);
3263 eassert (sc > 0);
3265 len = sizeof xerrno;
3266 eassert (FD_ISSET (s, &fdset));
3267 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) < 0)
3268 report_file_error ("getsockopt failed", Qnil);
3269 if (xerrno)
3270 report_file_errno ("error during connect", Qnil, xerrno);
3271 break;
3273 #endif /* !WINDOWSNT */
3275 immediate_quit = 0;
3277 /* Discard the unwind protect closing S. */
3278 specpdl_ptr = specpdl + count1;
3279 emacs_close (s);
3280 s = -1;
3282 #ifdef WINDOWSNT
3283 if (xerrno == EINTR)
3284 goto retry_connect;
3285 #endif
3288 if (s >= 0)
3290 #ifdef DATAGRAM_SOCKETS
3291 if (socktype == SOCK_DGRAM)
3293 if (datagram_address[s].sa)
3294 emacs_abort ();
3295 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3296 datagram_address[s].len = lres->ai_addrlen;
3297 if (is_server)
3299 Lisp_Object remote;
3300 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3301 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3303 int rfamily, rlen;
3304 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3305 if (rlen != 0 && rfamily == lres->ai_family
3306 && rlen == lres->ai_addrlen)
3307 conv_lisp_to_sockaddr (rfamily, remote,
3308 datagram_address[s].sa, rlen);
3311 else
3312 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3314 #endif
3315 contact = Fplist_put (contact, QCaddress,
3316 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3317 #ifdef HAVE_GETSOCKNAME
3318 if (!is_server)
3320 struct sockaddr_in sa1;
3321 socklen_t len1 = sizeof (sa1);
3322 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3323 contact = Fplist_put (contact, QClocal,
3324 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3326 #endif
3329 immediate_quit = 0;
3331 #ifdef HAVE_GETADDRINFO
3332 if (res != &ai)
3334 block_input ();
3335 freeaddrinfo (res);
3336 unblock_input ();
3338 #endif
3340 /* Discard the unwind protect for closing S, if any. */
3341 specpdl_ptr = specpdl + count1;
3343 /* Unwind bind_polling_period and request_sigio. */
3344 unbind_to (count, Qnil);
3346 if (s < 0)
3348 /* If non-blocking got this far - and failed - assume non-blocking is
3349 not supported after all. This is probably a wrong assumption, but
3350 the normal blocking calls to open-network-stream handles this error
3351 better. */
3352 if (is_non_blocking_client)
3353 return Qnil;
3355 report_file_errno ((is_server
3356 ? "make server process failed"
3357 : "make client process failed"),
3358 contact, xerrno);
3361 inch = s;
3362 outch = s;
3364 if (!NILP (buffer))
3365 buffer = Fget_buffer_create (buffer);
3366 proc = make_process (name);
3368 chan_process[inch] = proc;
3370 fcntl (inch, F_SETFL, O_NONBLOCK);
3372 p = XPROCESS (proc);
3374 pset_childp (p, contact);
3375 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3376 pset_type (p, Qnetwork);
3378 pset_buffer (p, buffer);
3379 pset_sentinel (p, sentinel);
3380 pset_filter (p, filter);
3381 pset_log (p, Fplist_get (contact, QClog));
3382 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3383 p->kill_without_query = 1;
3384 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3385 pset_command (p, Qt);
3386 p->pid = 0;
3387 p->infd = inch;
3388 p->outfd = outch;
3389 if (is_server && socktype != SOCK_DGRAM)
3390 pset_status (p, Qlisten);
3392 /* Make the process marker point into the process buffer (if any). */
3393 if (BUFFERP (buffer))
3394 set_marker_both (p->mark, buffer,
3395 BUF_ZV (XBUFFER (buffer)),
3396 BUF_ZV_BYTE (XBUFFER (buffer)));
3398 #ifdef NON_BLOCKING_CONNECT
3399 if (is_non_blocking_client)
3401 /* We may get here if connect did succeed immediately. However,
3402 in that case, we still need to signal this like a non-blocking
3403 connection. */
3404 pset_status (p, Qconnect);
3405 if (!FD_ISSET (inch, &connect_wait_mask))
3407 FD_SET (inch, &connect_wait_mask);
3408 FD_SET (inch, &write_mask);
3409 num_pending_connects++;
3412 else
3413 #endif
3414 /* A server may have a client filter setting of Qt, but it must
3415 still listen for incoming connects unless it is stopped. */
3416 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3417 || (EQ (p->status, Qlisten) && NILP (p->command)))
3419 FD_SET (inch, &input_wait_mask);
3420 FD_SET (inch, &non_keyboard_wait_mask);
3423 if (inch > max_process_desc)
3424 max_process_desc = inch;
3426 tem = Fplist_member (contact, QCcoding);
3427 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3428 tem = Qnil; /* No error message (too late!). */
3431 /* Setup coding systems for communicating with the network stream. */
3432 struct gcpro gcpro1;
3433 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3434 Lisp_Object coding_systems = Qt;
3435 Lisp_Object fargs[5], val;
3437 if (!NILP (tem))
3439 val = XCAR (XCDR (tem));
3440 if (CONSP (val))
3441 val = XCAR (val);
3443 else if (!NILP (Vcoding_system_for_read))
3444 val = Vcoding_system_for_read;
3445 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3446 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3447 /* We dare not decode end-of-line format by setting VAL to
3448 Qraw_text, because the existing Emacs Lisp libraries
3449 assume that they receive bare code including a sequence of
3450 CR LF. */
3451 val = Qnil;
3452 else
3454 if (NILP (host) || NILP (service))
3455 coding_systems = Qnil;
3456 else
3458 fargs[0] = Qopen_network_stream, fargs[1] = name,
3459 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3460 GCPRO1 (proc);
3461 coding_systems = Ffind_operation_coding_system (5, fargs);
3462 UNGCPRO;
3464 if (CONSP (coding_systems))
3465 val = XCAR (coding_systems);
3466 else if (CONSP (Vdefault_process_coding_system))
3467 val = XCAR (Vdefault_process_coding_system);
3468 else
3469 val = Qnil;
3471 pset_decode_coding_system (p, val);
3473 if (!NILP (tem))
3475 val = XCAR (XCDR (tem));
3476 if (CONSP (val))
3477 val = XCDR (val);
3479 else if (!NILP (Vcoding_system_for_write))
3480 val = Vcoding_system_for_write;
3481 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3482 val = Qnil;
3483 else
3485 if (EQ (coding_systems, Qt))
3487 if (NILP (host) || NILP (service))
3488 coding_systems = Qnil;
3489 else
3491 fargs[0] = Qopen_network_stream, fargs[1] = name,
3492 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3493 GCPRO1 (proc);
3494 coding_systems = Ffind_operation_coding_system (5, fargs);
3495 UNGCPRO;
3498 if (CONSP (coding_systems))
3499 val = XCDR (coding_systems);
3500 else if (CONSP (Vdefault_process_coding_system))
3501 val = XCDR (Vdefault_process_coding_system);
3502 else
3503 val = Qnil;
3505 pset_encode_coding_system (p, val);
3507 setup_process_coding_systems (proc);
3509 pset_decoding_buf (p, empty_unibyte_string);
3510 p->decoding_carryover = 0;
3511 pset_encoding_buf (p, empty_unibyte_string);
3513 p->inherit_coding_system_flag
3514 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3516 UNGCPRO;
3517 return proc;
3521 #if defined (HAVE_NET_IF_H)
3523 #ifdef SIOCGIFCONF
3524 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3525 doc: /* Return an alist of all network interfaces and their network address.
3526 Each element is a cons, the car of which is a string containing the
3527 interface name, and the cdr is the network address in internal
3528 format; see the description of ADDRESS in `make-network-process'. */)
3529 (void)
3531 struct ifconf ifconf;
3532 struct ifreq *ifreq;
3533 void *buf = NULL;
3534 ptrdiff_t buf_size = 512;
3535 int s;
3536 Lisp_Object res;
3538 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
3539 if (s < 0)
3540 return Qnil;
3544 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3545 ifconf.ifc_buf = buf;
3546 ifconf.ifc_len = buf_size;
3547 if (ioctl (s, SIOCGIFCONF, &ifconf))
3549 emacs_close (s);
3550 xfree (buf);
3551 return Qnil;
3554 while (ifconf.ifc_len == buf_size);
3556 emacs_close (s);
3558 res = Qnil;
3559 ifreq = ifconf.ifc_req;
3560 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3562 struct ifreq *ifq = ifreq;
3563 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3564 #define SIZEOF_IFREQ(sif) \
3565 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3566 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3568 int len = SIZEOF_IFREQ (ifq);
3569 #else
3570 int len = sizeof (*ifreq);
3571 #endif
3572 char namebuf[sizeof (ifq->ifr_name) + 1];
3573 ifreq = (struct ifreq *) ((char *) ifreq + len);
3575 if (ifq->ifr_addr.sa_family != AF_INET)
3576 continue;
3578 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3579 namebuf[sizeof (ifq->ifr_name)] = 0;
3580 res = Fcons (Fcons (build_string (namebuf),
3581 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3582 sizeof (struct sockaddr))),
3583 res);
3586 xfree (buf);
3587 return res;
3589 #endif /* SIOCGIFCONF */
3591 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3593 struct ifflag_def {
3594 int flag_bit;
3595 const char *flag_sym;
3598 static const struct ifflag_def ifflag_table[] = {
3599 #ifdef IFF_UP
3600 { IFF_UP, "up" },
3601 #endif
3602 #ifdef IFF_BROADCAST
3603 { IFF_BROADCAST, "broadcast" },
3604 #endif
3605 #ifdef IFF_DEBUG
3606 { IFF_DEBUG, "debug" },
3607 #endif
3608 #ifdef IFF_LOOPBACK
3609 { IFF_LOOPBACK, "loopback" },
3610 #endif
3611 #ifdef IFF_POINTOPOINT
3612 { IFF_POINTOPOINT, "pointopoint" },
3613 #endif
3614 #ifdef IFF_RUNNING
3615 { IFF_RUNNING, "running" },
3616 #endif
3617 #ifdef IFF_NOARP
3618 { IFF_NOARP, "noarp" },
3619 #endif
3620 #ifdef IFF_PROMISC
3621 { IFF_PROMISC, "promisc" },
3622 #endif
3623 #ifdef IFF_NOTRAILERS
3624 #ifdef NS_IMPL_COCOA
3625 /* Really means smart, notrailers is obsolete */
3626 { IFF_NOTRAILERS, "smart" },
3627 #else
3628 { IFF_NOTRAILERS, "notrailers" },
3629 #endif
3630 #endif
3631 #ifdef IFF_ALLMULTI
3632 { IFF_ALLMULTI, "allmulti" },
3633 #endif
3634 #ifdef IFF_MASTER
3635 { IFF_MASTER, "master" },
3636 #endif
3637 #ifdef IFF_SLAVE
3638 { IFF_SLAVE, "slave" },
3639 #endif
3640 #ifdef IFF_MULTICAST
3641 { IFF_MULTICAST, "multicast" },
3642 #endif
3643 #ifdef IFF_PORTSEL
3644 { IFF_PORTSEL, "portsel" },
3645 #endif
3646 #ifdef IFF_AUTOMEDIA
3647 { IFF_AUTOMEDIA, "automedia" },
3648 #endif
3649 #ifdef IFF_DYNAMIC
3650 { IFF_DYNAMIC, "dynamic" },
3651 #endif
3652 #ifdef IFF_OACTIVE
3653 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3654 #endif
3655 #ifdef IFF_SIMPLEX
3656 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3657 #endif
3658 #ifdef IFF_LINK0
3659 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3660 #endif
3661 #ifdef IFF_LINK1
3662 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3663 #endif
3664 #ifdef IFF_LINK2
3665 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3666 #endif
3667 { 0, 0 }
3670 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3671 doc: /* Return information about network interface named IFNAME.
3672 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3673 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3674 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
3675 FLAGS is the current flags of the interface. */)
3676 (Lisp_Object ifname)
3678 struct ifreq rq;
3679 Lisp_Object res = Qnil;
3680 Lisp_Object elt;
3681 int s;
3682 bool any = 0;
3683 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3684 && defined HAVE_GETIFADDRS && defined LLADDR)
3685 struct ifaddrs *ifap;
3686 #endif
3688 CHECK_STRING (ifname);
3690 if (sizeof rq.ifr_name <= SBYTES (ifname))
3691 error ("interface name too long");
3692 strcpy (rq.ifr_name, SSDATA (ifname));
3694 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
3695 if (s < 0)
3696 return Qnil;
3698 elt = Qnil;
3699 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3700 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3702 int flags = rq.ifr_flags;
3703 const struct ifflag_def *fp;
3704 int fnum;
3706 /* If flags is smaller than int (i.e. short) it may have the high bit set
3707 due to IFF_MULTICAST. In that case, sign extending it into
3708 an int is wrong. */
3709 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3710 flags = (unsigned short) rq.ifr_flags;
3712 any = 1;
3713 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3715 if (flags & fp->flag_bit)
3717 elt = Fcons (intern (fp->flag_sym), elt);
3718 flags -= fp->flag_bit;
3721 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3723 if (flags & 1)
3725 elt = Fcons (make_number (fnum), elt);
3729 #endif
3730 res = Fcons (elt, res);
3732 elt = Qnil;
3733 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3734 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3736 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3737 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3738 int n;
3740 any = 1;
3741 for (n = 0; n < 6; n++)
3742 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3743 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3745 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3746 if (getifaddrs (&ifap) != -1)
3748 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3749 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3750 struct ifaddrs *it;
3752 for (it = ifap; it != NULL; it = it->ifa_next)
3754 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3755 unsigned char linkaddr[6];
3756 int n;
3758 if (it->ifa_addr->sa_family != AF_LINK
3759 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3760 || sdl->sdl_alen != 6)
3761 continue;
3763 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3764 for (n = 0; n < 6; n++)
3765 p->contents[n] = make_number (linkaddr[n]);
3767 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3768 break;
3771 #ifdef HAVE_FREEIFADDRS
3772 freeifaddrs (ifap);
3773 #endif
3775 #endif /* HAVE_GETIFADDRS && LLADDR */
3777 res = Fcons (elt, res);
3779 elt = Qnil;
3780 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3781 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3783 any = 1;
3784 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3785 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3786 #else
3787 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3788 #endif
3790 #endif
3791 res = Fcons (elt, res);
3793 elt = Qnil;
3794 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3795 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3797 any = 1;
3798 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3800 #endif
3801 res = Fcons (elt, res);
3803 elt = Qnil;
3804 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3805 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3807 any = 1;
3808 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3810 #endif
3811 res = Fcons (elt, res);
3813 emacs_close (s);
3815 return any ? res : Qnil;
3817 #endif
3818 #endif /* defined (HAVE_NET_IF_H) */
3820 /* Turn off input and output for process PROC. */
3822 static void
3823 deactivate_process (Lisp_Object proc)
3825 register int inchannel, outchannel;
3826 register struct Lisp_Process *p = XPROCESS (proc);
3828 #ifdef HAVE_GNUTLS
3829 /* Delete GnuTLS structures in PROC, if any. */
3830 emacs_gnutls_deinit (proc);
3831 #endif /* HAVE_GNUTLS */
3833 inchannel = p->infd;
3834 outchannel = p->outfd;
3836 #ifdef ADAPTIVE_READ_BUFFERING
3837 if (p->read_output_delay > 0)
3839 if (--process_output_delay_count < 0)
3840 process_output_delay_count = 0;
3841 p->read_output_delay = 0;
3842 p->read_output_skip = 0;
3844 #endif
3846 if (inchannel >= 0)
3848 /* Beware SIGCHLD hereabouts. */
3849 flush_pending_output (inchannel);
3850 emacs_close (inchannel);
3851 if (outchannel >= 0 && outchannel != inchannel)
3852 emacs_close (outchannel);
3854 p->infd = -1;
3855 p->outfd = -1;
3856 #ifdef DATAGRAM_SOCKETS
3857 if (DATAGRAM_CHAN_P (inchannel))
3859 xfree (datagram_address[inchannel].sa);
3860 datagram_address[inchannel].sa = 0;
3861 datagram_address[inchannel].len = 0;
3863 #endif
3864 chan_process[inchannel] = Qnil;
3865 FD_CLR (inchannel, &input_wait_mask);
3866 FD_CLR (inchannel, &non_keyboard_wait_mask);
3867 #ifdef NON_BLOCKING_CONNECT
3868 if (FD_ISSET (inchannel, &connect_wait_mask))
3870 FD_CLR (inchannel, &connect_wait_mask);
3871 FD_CLR (inchannel, &write_mask);
3872 if (--num_pending_connects < 0)
3873 emacs_abort ();
3875 #endif
3876 if (inchannel == max_process_desc)
3878 int i;
3879 /* We just closed the highest-numbered process input descriptor,
3880 so recompute the highest-numbered one now. */
3881 max_process_desc = 0;
3882 for (i = 0; i < MAXDESC; i++)
3883 if (!NILP (chan_process[i]))
3884 max_process_desc = i;
3890 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3891 0, 4, 0,
3892 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3893 It is read into the process' buffers or given to their filter functions.
3894 Non-nil arg PROCESS means do not return until some output has been received
3895 from PROCESS.
3897 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3898 and milliseconds to wait; return after that much time whether or not
3899 there is any subprocess output. If SECONDS is a floating point number,
3900 it specifies a fractional number of seconds to wait.
3901 The MILLISEC argument is obsolete and should be avoided.
3903 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3904 from PROCESS, suspending reading output from other processes.
3905 If JUST-THIS-ONE is an integer, don't run any timers either.
3906 Return non-nil if we received any output before the timeout expired. */)
3907 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3909 intmax_t secs;
3910 int nsecs;
3912 if (! NILP (process))
3913 CHECK_PROCESS (process);
3914 else
3915 just_this_one = Qnil;
3917 if (!NILP (millisec))
3918 { /* Obsolete calling convention using integers rather than floats. */
3919 CHECK_NUMBER (millisec);
3920 if (NILP (seconds))
3921 seconds = make_float (XINT (millisec) / 1000.0);
3922 else
3924 CHECK_NUMBER (seconds);
3925 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3929 secs = 0;
3930 nsecs = -1;
3932 if (!NILP (seconds))
3934 if (INTEGERP (seconds))
3936 if (XINT (seconds) > 0)
3938 secs = XINT (seconds);
3939 nsecs = 0;
3942 else if (FLOATP (seconds))
3944 if (XFLOAT_DATA (seconds) > 0)
3946 EMACS_TIME t = EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (seconds));
3947 secs = min (EMACS_SECS (t), WAIT_READING_MAX);
3948 nsecs = EMACS_NSECS (t);
3951 else
3952 wrong_type_argument (Qnumberp, seconds);
3954 else if (! NILP (process))
3955 nsecs = 0;
3957 return
3958 (wait_reading_process_output (secs, nsecs, 0, 0,
3959 Qnil,
3960 !NILP (process) ? XPROCESS (process) : NULL,
3961 NILP (just_this_one) ? 0 :
3962 !INTEGERP (just_this_one) ? 1 : -1)
3963 ? Qt : Qnil);
3966 /* Accept a connection for server process SERVER on CHANNEL. */
3968 static EMACS_INT connect_counter = 0;
3970 static void
3971 server_accept_connection (Lisp_Object server, int channel)
3973 Lisp_Object proc, caller, name, buffer;
3974 Lisp_Object contact, host, service;
3975 struct Lisp_Process *ps= XPROCESS (server);
3976 struct Lisp_Process *p;
3977 int s;
3978 union u_sockaddr {
3979 struct sockaddr sa;
3980 struct sockaddr_in in;
3981 #ifdef AF_INET6
3982 struct sockaddr_in6 in6;
3983 #endif
3984 #ifdef HAVE_LOCAL_SOCKETS
3985 struct sockaddr_un un;
3986 #endif
3987 } saddr;
3988 socklen_t len = sizeof saddr;
3990 s = accept4 (channel, &saddr.sa, &len, SOCK_CLOEXEC);
3992 if (s < 0)
3994 int code = errno;
3996 if (code == EAGAIN)
3997 return;
3998 #ifdef EWOULDBLOCK
3999 if (code == EWOULDBLOCK)
4000 return;
4001 #endif
4003 if (!NILP (ps->log))
4004 call3 (ps->log, server, Qnil,
4005 concat3 (build_string ("accept failed with code"),
4006 Fnumber_to_string (make_number (code)),
4007 build_string ("\n")));
4008 return;
4011 connect_counter++;
4013 /* Setup a new process to handle the connection. */
4015 /* Generate a unique identification of the caller, and build contact
4016 information for this process. */
4017 host = Qt;
4018 service = Qnil;
4019 switch (saddr.sa.sa_family)
4021 case AF_INET:
4023 Lisp_Object args[5];
4024 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4025 args[0] = build_string ("%d.%d.%d.%d");
4026 args[1] = make_number (*ip++);
4027 args[2] = make_number (*ip++);
4028 args[3] = make_number (*ip++);
4029 args[4] = make_number (*ip++);
4030 host = Fformat (5, args);
4031 service = make_number (ntohs (saddr.in.sin_port));
4033 args[0] = build_string (" <%s:%d>");
4034 args[1] = host;
4035 args[2] = service;
4036 caller = Fformat (3, args);
4038 break;
4040 #ifdef AF_INET6
4041 case AF_INET6:
4043 Lisp_Object args[9];
4044 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4045 int i;
4046 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4047 for (i = 0; i < 8; i++)
4048 args[i+1] = make_number (ntohs (ip6[i]));
4049 host = Fformat (9, args);
4050 service = make_number (ntohs (saddr.in.sin_port));
4052 args[0] = build_string (" <[%s]:%d>");
4053 args[1] = host;
4054 args[2] = service;
4055 caller = Fformat (3, args);
4057 break;
4058 #endif
4060 #ifdef HAVE_LOCAL_SOCKETS
4061 case AF_LOCAL:
4062 #endif
4063 default:
4064 caller = Fnumber_to_string (make_number (connect_counter));
4065 caller = concat3 (build_string (" <"), caller, build_string (">"));
4066 break;
4069 /* Create a new buffer name for this process if it doesn't have a
4070 filter. The new buffer name is based on the buffer name or
4071 process name of the server process concatenated with the caller
4072 identification. */
4074 if (!(EQ (ps->filter, Qinternal_default_process_filter)
4075 || EQ (ps->filter, Qt)))
4076 buffer = Qnil;
4077 else
4079 buffer = ps->buffer;
4080 if (!NILP (buffer))
4081 buffer = Fbuffer_name (buffer);
4082 else
4083 buffer = ps->name;
4084 if (!NILP (buffer))
4086 buffer = concat2 (buffer, caller);
4087 buffer = Fget_buffer_create (buffer);
4091 /* Generate a unique name for the new server process. Combine the
4092 server process name with the caller identification. */
4094 name = concat2 (ps->name, caller);
4095 proc = make_process (name);
4097 chan_process[s] = proc;
4099 fcntl (s, F_SETFL, O_NONBLOCK);
4101 p = XPROCESS (proc);
4103 /* Build new contact information for this setup. */
4104 contact = Fcopy_sequence (ps->childp);
4105 contact = Fplist_put (contact, QCserver, Qnil);
4106 contact = Fplist_put (contact, QChost, host);
4107 if (!NILP (service))
4108 contact = Fplist_put (contact, QCservice, service);
4109 contact = Fplist_put (contact, QCremote,
4110 conv_sockaddr_to_lisp (&saddr.sa, len));
4111 #ifdef HAVE_GETSOCKNAME
4112 len = sizeof saddr;
4113 if (getsockname (s, &saddr.sa, &len) == 0)
4114 contact = Fplist_put (contact, QClocal,
4115 conv_sockaddr_to_lisp (&saddr.sa, len));
4116 #endif
4118 pset_childp (p, contact);
4119 pset_plist (p, Fcopy_sequence (ps->plist));
4120 pset_type (p, Qnetwork);
4122 pset_buffer (p, buffer);
4123 pset_sentinel (p, ps->sentinel);
4124 pset_filter (p, ps->filter);
4125 pset_command (p, Qnil);
4126 p->pid = 0;
4127 p->infd = s;
4128 p->outfd = s;
4129 pset_status (p, Qrun);
4131 /* Client processes for accepted connections are not stopped initially. */
4132 if (!EQ (p->filter, Qt))
4134 FD_SET (s, &input_wait_mask);
4135 FD_SET (s, &non_keyboard_wait_mask);
4138 if (s > max_process_desc)
4139 max_process_desc = s;
4141 /* Setup coding system for new process based on server process.
4142 This seems to be the proper thing to do, as the coding system
4143 of the new process should reflect the settings at the time the
4144 server socket was opened; not the current settings. */
4146 pset_decode_coding_system (p, ps->decode_coding_system);
4147 pset_encode_coding_system (p, ps->encode_coding_system);
4148 setup_process_coding_systems (proc);
4150 pset_decoding_buf (p, empty_unibyte_string);
4151 p->decoding_carryover = 0;
4152 pset_encoding_buf (p, empty_unibyte_string);
4154 p->inherit_coding_system_flag
4155 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4157 if (!NILP (ps->log))
4158 call3 (ps->log, server, proc,
4159 concat3 (build_string ("accept from "),
4160 (STRINGP (host) ? host : build_string ("-")),
4161 build_string ("\n")));
4163 exec_sentinel (proc,
4164 concat3 (build_string ("open from "),
4165 (STRINGP (host) ? host : build_string ("-")),
4166 build_string ("\n")));
4169 /* This variable is different from waiting_for_input in keyboard.c.
4170 It is used to communicate to a lisp process-filter/sentinel (via the
4171 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4172 for user-input when that process-filter was called.
4173 waiting_for_input cannot be used as that is by definition 0 when
4174 lisp code is being evalled.
4175 This is also used in record_asynch_buffer_change.
4176 For that purpose, this must be 0
4177 when not inside wait_reading_process_output. */
4178 static int waiting_for_user_input_p;
4180 static Lisp_Object
4181 wait_reading_process_output_unwind (Lisp_Object data)
4183 waiting_for_user_input_p = XINT (data);
4184 return Qnil;
4187 /* This is here so breakpoints can be put on it. */
4188 static void
4189 wait_reading_process_output_1 (void)
4193 /* Read and dispose of subprocess output while waiting for timeout to
4194 elapse and/or keyboard input to be available.
4196 TIME_LIMIT is:
4197 timeout in seconds
4198 If negative, gobble data immediately available but don't wait for any.
4200 NSECS is:
4201 an additional duration to wait, measured in nanoseconds
4202 If TIME_LIMIT is zero, then:
4203 If NSECS == 0, there is no limit.
4204 If NSECS > 0, the timeout consists of NSECS only.
4205 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4207 READ_KBD is:
4208 0 to ignore keyboard input, or
4209 1 to return when input is available, or
4210 -1 meaning caller will actually read the input, so don't throw to
4211 the quit handler, or
4213 DO_DISPLAY means redisplay should be done to show subprocess
4214 output that arrives.
4216 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4217 (and gobble terminal input into the buffer if any arrives).
4219 If WAIT_PROC is specified, wait until something arrives from that
4220 process. The return value is true if we read some input from
4221 that process.
4223 If JUST_WAIT_PROC is nonzero, handle only output from WAIT_PROC
4224 (suspending output from other processes). A negative value
4225 means don't run any timers either.
4227 If WAIT_PROC is specified, then the function returns true if we
4228 received input from that process before the timeout elapsed.
4229 Otherwise, return true if we received input from any process. */
4231 bool
4232 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4233 bool do_display,
4234 Lisp_Object wait_for_cell,
4235 struct Lisp_Process *wait_proc, int just_wait_proc)
4237 int channel, nfds;
4238 SELECT_TYPE Available;
4239 SELECT_TYPE Writeok;
4240 bool check_write;
4241 int check_delay;
4242 bool no_avail;
4243 int xerrno;
4244 Lisp_Object proc;
4245 EMACS_TIME timeout, end_time;
4246 int wait_channel = -1;
4247 bool got_some_input = 0;
4248 ptrdiff_t count = SPECPDL_INDEX ();
4250 FD_ZERO (&Available);
4251 FD_ZERO (&Writeok);
4253 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4254 && !(CONSP (wait_proc->status)
4255 && EQ (XCAR (wait_proc->status), Qexit)))
4256 message1 ("Blocking call to accept-process-output with quit inhibited!!");
4258 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4259 if (wait_proc != NULL)
4260 wait_channel = wait_proc->infd;
4262 record_unwind_protect (wait_reading_process_output_unwind,
4263 make_number (waiting_for_user_input_p));
4264 waiting_for_user_input_p = read_kbd;
4266 if (time_limit < 0)
4268 time_limit = 0;
4269 nsecs = -1;
4271 else if (TYPE_MAXIMUM (time_t) < time_limit)
4272 time_limit = TYPE_MAXIMUM (time_t);
4274 /* Since we may need to wait several times,
4275 compute the absolute time to return at. */
4276 if (time_limit || nsecs > 0)
4278 timeout = make_emacs_time (time_limit, nsecs);
4279 end_time = add_emacs_time (current_emacs_time (), timeout);
4282 while (1)
4284 bool timeout_reduced_for_timers = 0;
4286 /* If calling from keyboard input, do not quit
4287 since we want to return C-g as an input character.
4288 Otherwise, do pending quit if requested. */
4289 if (read_kbd >= 0)
4290 QUIT;
4291 else if (pending_signals)
4292 process_pending_signals ();
4294 /* Exit now if the cell we're waiting for became non-nil. */
4295 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4296 break;
4298 /* Compute time from now till when time limit is up. */
4299 /* Exit if already run out. */
4300 if (nsecs < 0)
4302 /* A negative timeout means
4303 gobble output available now
4304 but don't wait at all. */
4306 timeout = make_emacs_time (0, 0);
4308 else if (time_limit || nsecs > 0)
4310 EMACS_TIME now = current_emacs_time ();
4311 if (EMACS_TIME_LE (end_time, now))
4312 break;
4313 timeout = sub_emacs_time (end_time, now);
4315 else
4317 timeout = make_emacs_time (100000, 0);
4320 /* Normally we run timers here.
4321 But not if wait_for_cell; in those cases,
4322 the wait is supposed to be short,
4323 and those callers cannot handle running arbitrary Lisp code here. */
4324 if (NILP (wait_for_cell)
4325 && just_wait_proc >= 0)
4327 EMACS_TIME timer_delay;
4331 unsigned old_timers_run = timers_run;
4332 struct buffer *old_buffer = current_buffer;
4333 Lisp_Object old_window = selected_window;
4335 timer_delay = timer_check ();
4337 /* If a timer has run, this might have changed buffers
4338 an alike. Make read_key_sequence aware of that. */
4339 if (timers_run != old_timers_run
4340 && (old_buffer != current_buffer
4341 || !EQ (old_window, selected_window))
4342 && waiting_for_user_input_p == -1)
4343 record_asynch_buffer_change ();
4345 if (timers_run != old_timers_run && do_display)
4346 /* We must retry, since a timer may have requeued itself
4347 and that could alter the time_delay. */
4348 redisplay_preserve_echo_area (9);
4349 else
4350 break;
4352 while (!detect_input_pending ());
4354 /* If there is unread keyboard input, also return. */
4355 if (read_kbd != 0
4356 && requeued_events_pending_p ())
4357 break;
4359 /* A negative timeout means do not wait at all. */
4360 if (nsecs >= 0)
4362 if (EMACS_TIME_VALID_P (timer_delay))
4364 if (EMACS_TIME_LT (timer_delay, timeout))
4366 timeout = timer_delay;
4367 timeout_reduced_for_timers = 1;
4370 else
4372 /* This is so a breakpoint can be put here. */
4373 wait_reading_process_output_1 ();
4378 /* Cause C-g and alarm signals to take immediate action,
4379 and cause input available signals to zero out timeout.
4381 It is important that we do this before checking for process
4382 activity. If we get a SIGCHLD after the explicit checks for
4383 process activity, timeout is the only way we will know. */
4384 if (read_kbd < 0)
4385 set_waiting_for_input (&timeout);
4387 /* If status of something has changed, and no input is
4388 available, notify the user of the change right away. After
4389 this explicit check, we'll let the SIGCHLD handler zap
4390 timeout to get our attention. */
4391 if (update_tick != process_tick)
4393 SELECT_TYPE Atemp;
4394 SELECT_TYPE Ctemp;
4396 if (kbd_on_hold_p ())
4397 FD_ZERO (&Atemp);
4398 else
4399 Atemp = input_wait_mask;
4400 Ctemp = write_mask;
4402 timeout = make_emacs_time (0, 0);
4403 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4404 &Atemp,
4405 #ifdef NON_BLOCKING_CONNECT
4406 (num_pending_connects > 0 ? &Ctemp : NULL),
4407 #else
4408 NULL,
4409 #endif
4410 NULL, &timeout, NULL)
4411 <= 0))
4413 /* It's okay for us to do this and then continue with
4414 the loop, since timeout has already been zeroed out. */
4415 clear_waiting_for_input ();
4416 status_notify (NULL);
4417 if (do_display) redisplay_preserve_echo_area (13);
4421 /* Don't wait for output from a non-running process. Just
4422 read whatever data has already been received. */
4423 if (wait_proc && wait_proc->raw_status_new)
4424 update_status (wait_proc);
4425 if (wait_proc
4426 && ! EQ (wait_proc->status, Qrun)
4427 && ! EQ (wait_proc->status, Qconnect))
4429 bool read_some_bytes = 0;
4431 clear_waiting_for_input ();
4432 XSETPROCESS (proc, wait_proc);
4434 /* Read data from the process, until we exhaust it. */
4435 while (wait_proc->infd >= 0)
4437 int nread = read_process_output (proc, wait_proc->infd);
4439 if (nread == 0)
4440 break;
4442 if (nread > 0)
4443 got_some_input = read_some_bytes = 1;
4444 else if (nread == -1 && (errno == EIO || errno == EAGAIN))
4445 break;
4446 #ifdef EWOULDBLOCK
4447 else if (nread == -1 && EWOULDBLOCK == errno)
4448 break;
4449 #endif
4451 if (read_some_bytes && do_display)
4452 redisplay_preserve_echo_area (10);
4454 break;
4457 /* Wait till there is something to do */
4459 if (wait_proc && just_wait_proc)
4461 if (wait_proc->infd < 0) /* Terminated */
4462 break;
4463 FD_SET (wait_proc->infd, &Available);
4464 check_delay = 0;
4465 check_write = 0;
4467 else if (!NILP (wait_for_cell))
4469 Available = non_process_wait_mask;
4470 check_delay = 0;
4471 check_write = 0;
4473 else
4475 if (! read_kbd)
4476 Available = non_keyboard_wait_mask;
4477 else
4478 Available = input_wait_mask;
4479 Writeok = write_mask;
4480 #ifdef SELECT_CANT_DO_WRITE_MASK
4481 check_write = 0;
4482 #else
4483 check_write = 1;
4484 #endif
4485 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4488 /* If frame size has changed or the window is newly mapped,
4489 redisplay now, before we start to wait. There is a race
4490 condition here; if a SIGIO arrives between now and the select
4491 and indicates that a frame is trashed, the select may block
4492 displaying a trashed screen. */
4493 if (frame_garbaged && do_display)
4495 clear_waiting_for_input ();
4496 redisplay_preserve_echo_area (11);
4497 if (read_kbd < 0)
4498 set_waiting_for_input (&timeout);
4501 /* Skip the `select' call if input is available and we're
4502 waiting for keyboard input or a cell change (which can be
4503 triggered by processing X events). In the latter case, set
4504 nfds to 1 to avoid breaking the loop. */
4505 no_avail = 0;
4506 if ((read_kbd || !NILP (wait_for_cell))
4507 && detect_input_pending ())
4509 nfds = read_kbd ? 0 : 1;
4510 no_avail = 1;
4513 if (!no_avail)
4516 #ifdef ADAPTIVE_READ_BUFFERING
4517 /* Set the timeout for adaptive read buffering if any
4518 process has non-zero read_output_skip and non-zero
4519 read_output_delay, and we are not reading output for a
4520 specific wait_channel. It is not executed if
4521 Vprocess_adaptive_read_buffering is nil. */
4522 if (process_output_skip && check_delay > 0)
4524 int nsecs = EMACS_NSECS (timeout);
4525 if (EMACS_SECS (timeout) > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4526 nsecs = READ_OUTPUT_DELAY_MAX;
4527 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4529 proc = chan_process[channel];
4530 if (NILP (proc))
4531 continue;
4532 /* Find minimum non-zero read_output_delay among the
4533 processes with non-zero read_output_skip. */
4534 if (XPROCESS (proc)->read_output_delay > 0)
4536 check_delay--;
4537 if (!XPROCESS (proc)->read_output_skip)
4538 continue;
4539 FD_CLR (channel, &Available);
4540 XPROCESS (proc)->read_output_skip = 0;
4541 if (XPROCESS (proc)->read_output_delay < nsecs)
4542 nsecs = XPROCESS (proc)->read_output_delay;
4545 timeout = make_emacs_time (0, nsecs);
4546 process_output_skip = 0;
4548 #endif
4550 #if defined (HAVE_NS)
4551 nfds = ns_select
4552 #elif defined (HAVE_GLIB)
4553 nfds = xg_select
4554 #else
4555 nfds = pselect
4556 #endif
4557 (max (max_process_desc, max_input_desc) + 1,
4558 &Available,
4559 (check_write ? &Writeok : (SELECT_TYPE *)0),
4560 NULL, &timeout, NULL);
4562 #ifdef HAVE_GNUTLS
4563 /* GnuTLS buffers data internally. In lowat mode it leaves
4564 some data in the TCP buffers so that select works, but
4565 with custom pull/push functions we need to check if some
4566 data is available in the buffers manually. */
4567 if (nfds == 0)
4569 if (! wait_proc)
4571 /* We're not waiting on a specific process, so loop
4572 through all the channels and check for data.
4573 This is a workaround needed for some versions of
4574 the gnutls library -- 2.12.14 has been confirmed
4575 to need it. See
4576 http://comments.gmane.org/gmane.emacs.devel/145074 */
4577 for (channel = 0; channel < MAXDESC; ++channel)
4578 if (! NILP (chan_process[channel]))
4580 struct Lisp_Process *p =
4581 XPROCESS (chan_process[channel]);
4582 if (p && p->gnutls_p && p->infd
4583 && ((emacs_gnutls_record_check_pending
4584 (p->gnutls_state))
4585 > 0))
4587 nfds++;
4588 FD_SET (p->infd, &Available);
4592 else
4594 /* Check this specific channel. */
4595 if (wait_proc->gnutls_p /* Check for valid process. */
4596 /* Do we have pending data? */
4597 && ((emacs_gnutls_record_check_pending
4598 (wait_proc->gnutls_state))
4599 > 0))
4601 nfds = 1;
4602 /* Set to Available. */
4603 FD_SET (wait_proc->infd, &Available);
4607 #endif
4610 xerrno = errno;
4612 /* Make C-g and alarm signals set flags again */
4613 clear_waiting_for_input ();
4615 /* If we woke up due to SIGWINCH, actually change size now. */
4616 do_pending_window_change (0);
4618 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4619 /* We waited the full specified time, so return now. */
4620 break;
4621 if (nfds < 0)
4623 if (xerrno == EINTR)
4624 no_avail = 1;
4625 else if (xerrno == EBADF)
4626 emacs_abort ();
4627 else
4628 error ("select error: %s", emacs_strerror (xerrno));
4631 if (no_avail)
4633 FD_ZERO (&Available);
4634 check_write = 0;
4637 /* Check for keyboard input */
4638 /* If there is any, return immediately
4639 to give it higher priority than subprocesses */
4641 if (read_kbd != 0)
4643 unsigned old_timers_run = timers_run;
4644 struct buffer *old_buffer = current_buffer;
4645 Lisp_Object old_window = selected_window;
4646 bool leave = 0;
4648 if (detect_input_pending_run_timers (do_display))
4650 swallow_events (do_display);
4651 if (detect_input_pending_run_timers (do_display))
4652 leave = 1;
4655 /* If a timer has run, this might have changed buffers
4656 an alike. Make read_key_sequence aware of that. */
4657 if (timers_run != old_timers_run
4658 && waiting_for_user_input_p == -1
4659 && (old_buffer != current_buffer
4660 || !EQ (old_window, selected_window)))
4661 record_asynch_buffer_change ();
4663 if (leave)
4664 break;
4667 /* If there is unread keyboard input, also return. */
4668 if (read_kbd != 0
4669 && requeued_events_pending_p ())
4670 break;
4672 /* If we are not checking for keyboard input now,
4673 do process events (but don't run any timers).
4674 This is so that X events will be processed.
4675 Otherwise they may have to wait until polling takes place.
4676 That would causes delays in pasting selections, for example.
4678 (We used to do this only if wait_for_cell.) */
4679 if (read_kbd == 0 && detect_input_pending ())
4681 swallow_events (do_display);
4682 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4683 if (detect_input_pending ())
4684 break;
4685 #endif
4688 /* Exit now if the cell we're waiting for became non-nil. */
4689 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4690 break;
4692 #ifdef USABLE_SIGIO
4693 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4694 go read it. This can happen with X on BSD after logging out.
4695 In that case, there really is no input and no SIGIO,
4696 but select says there is input. */
4698 if (read_kbd && interrupt_input
4699 && keyboard_bit_set (&Available) && ! noninteractive)
4700 handle_input_available_signal (SIGIO);
4701 #endif
4703 if (! wait_proc)
4704 got_some_input |= nfds > 0;
4706 /* If checking input just got us a size-change event from X,
4707 obey it now if we should. */
4708 if (read_kbd || ! NILP (wait_for_cell))
4709 do_pending_window_change (0);
4711 /* Check for data from a process. */
4712 if (no_avail || nfds == 0)
4713 continue;
4715 for (channel = 0; channel <= max_input_desc; ++channel)
4717 struct fd_callback_data *d = &fd_callback_info[channel];
4718 if (d->func
4719 && ((d->condition & FOR_READ
4720 && FD_ISSET (channel, &Available))
4721 || (d->condition & FOR_WRITE
4722 && FD_ISSET (channel, &write_mask))))
4723 d->func (channel, d->data);
4726 for (channel = 0; channel <= max_process_desc; channel++)
4728 if (FD_ISSET (channel, &Available)
4729 && FD_ISSET (channel, &non_keyboard_wait_mask)
4730 && !FD_ISSET (channel, &non_process_wait_mask))
4732 int nread;
4734 /* If waiting for this channel, arrange to return as
4735 soon as no more input to be processed. No more
4736 waiting. */
4737 if (wait_channel == channel)
4739 wait_channel = -1;
4740 nsecs = -1;
4741 got_some_input = 1;
4743 proc = chan_process[channel];
4744 if (NILP (proc))
4745 continue;
4747 /* If this is a server stream socket, accept connection. */
4748 if (EQ (XPROCESS (proc)->status, Qlisten))
4750 server_accept_connection (proc, channel);
4751 continue;
4754 /* Read data from the process, starting with our
4755 buffered-ahead character if we have one. */
4757 nread = read_process_output (proc, channel);
4758 if (nread > 0)
4760 /* Since read_process_output can run a filter,
4761 which can call accept-process-output,
4762 don't try to read from any other processes
4763 before doing the select again. */
4764 FD_ZERO (&Available);
4766 if (do_display)
4767 redisplay_preserve_echo_area (12);
4769 #ifdef EWOULDBLOCK
4770 else if (nread == -1 && errno == EWOULDBLOCK)
4772 #endif
4773 else if (nread == -1 && errno == EAGAIN)
4775 #ifdef WINDOWSNT
4776 /* FIXME: Is this special case still needed? */
4777 /* Note that we cannot distinguish between no input
4778 available now and a closed pipe.
4779 With luck, a closed pipe will be accompanied by
4780 subprocess termination and SIGCHLD. */
4781 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4783 #endif
4784 #ifdef HAVE_PTYS
4785 /* On some OSs with ptys, when the process on one end of
4786 a pty exits, the other end gets an error reading with
4787 errno = EIO instead of getting an EOF (0 bytes read).
4788 Therefore, if we get an error reading and errno =
4789 EIO, just continue, because the child process has
4790 exited and should clean itself up soon (e.g. when we
4791 get a SIGCHLD). */
4792 else if (nread == -1 && errno == EIO)
4794 struct Lisp_Process *p = XPROCESS (proc);
4796 /* Clear the descriptor now, so we only raise the
4797 signal once. */
4798 FD_CLR (channel, &input_wait_mask);
4799 FD_CLR (channel, &non_keyboard_wait_mask);
4801 if (p->pid == -2)
4803 /* If the EIO occurs on a pty, the SIGCHLD handler's
4804 waitpid call will not find the process object to
4805 delete. Do it here. */
4806 p->tick = ++process_tick;
4807 pset_status (p, Qfailed);
4810 #endif /* HAVE_PTYS */
4811 /* If we can detect process termination, don't consider the
4812 process gone just because its pipe is closed. */
4813 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4815 else
4817 /* Preserve status of processes already terminated. */
4818 XPROCESS (proc)->tick = ++process_tick;
4819 deactivate_process (proc);
4820 if (XPROCESS (proc)->raw_status_new)
4821 update_status (XPROCESS (proc));
4822 if (EQ (XPROCESS (proc)->status, Qrun))
4823 pset_status (XPROCESS (proc),
4824 list2 (Qexit, make_number (256)));
4827 #ifdef NON_BLOCKING_CONNECT
4828 if (FD_ISSET (channel, &Writeok)
4829 && FD_ISSET (channel, &connect_wait_mask))
4831 struct Lisp_Process *p;
4833 FD_CLR (channel, &connect_wait_mask);
4834 FD_CLR (channel, &write_mask);
4835 if (--num_pending_connects < 0)
4836 emacs_abort ();
4838 proc = chan_process[channel];
4839 if (NILP (proc))
4840 continue;
4842 p = XPROCESS (proc);
4844 #ifdef GNU_LINUX
4845 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4846 So only use it on systems where it is known to work. */
4848 socklen_t xlen = sizeof (xerrno);
4849 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4850 xerrno = errno;
4852 #else
4854 struct sockaddr pname;
4855 int pnamelen = sizeof (pname);
4857 /* If connection failed, getpeername will fail. */
4858 xerrno = 0;
4859 if (getpeername (channel, &pname, &pnamelen) < 0)
4861 /* Obtain connect failure code through error slippage. */
4862 char dummy;
4863 xerrno = errno;
4864 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4865 xerrno = errno;
4868 #endif
4869 if (xerrno)
4871 p->tick = ++process_tick;
4872 pset_status (p, list2 (Qfailed, make_number (xerrno)));
4873 deactivate_process (proc);
4875 else
4877 pset_status (p, Qrun);
4878 /* Execute the sentinel here. If we had relied on
4879 status_notify to do it later, it will read input
4880 from the process before calling the sentinel. */
4881 exec_sentinel (proc, build_string ("open\n"));
4882 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
4884 FD_SET (p->infd, &input_wait_mask);
4885 FD_SET (p->infd, &non_keyboard_wait_mask);
4889 #endif /* NON_BLOCKING_CONNECT */
4890 } /* End for each file descriptor. */
4891 } /* End while exit conditions not met. */
4893 unbind_to (count, Qnil);
4895 /* If calling from keyboard input, do not quit
4896 since we want to return C-g as an input character.
4897 Otherwise, do pending quit if requested. */
4898 if (read_kbd >= 0)
4900 /* Prevent input_pending from remaining set if we quit. */
4901 clear_input_pending ();
4902 QUIT;
4905 return got_some_input;
4908 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
4910 static Lisp_Object
4911 read_process_output_call (Lisp_Object fun_and_args)
4913 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
4916 static Lisp_Object
4917 read_process_output_error_handler (Lisp_Object error_val)
4919 cmd_error_internal (error_val, "error in process filter: ");
4920 Vinhibit_quit = Qt;
4921 update_echo_area ();
4922 Fsleep_for (make_number (2), Qnil);
4923 return Qt;
4926 static void
4927 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
4928 ssize_t nbytes,
4929 struct coding_system *coding);
4931 /* Read pending output from the process channel,
4932 starting with our buffered-ahead character if we have one.
4933 Yield number of decoded characters read.
4935 This function reads at most 4096 characters.
4936 If you want to read all available subprocess output,
4937 you must call it repeatedly until it returns zero.
4939 The characters read are decoded according to PROC's coding-system
4940 for decoding. */
4942 static int
4943 read_process_output (Lisp_Object proc, register int channel)
4945 register ssize_t nbytes;
4946 char *chars;
4947 register struct Lisp_Process *p = XPROCESS (proc);
4948 struct coding_system *coding = proc_decode_coding_system[channel];
4949 int carryover = p->decoding_carryover;
4950 int readmax = 4096;
4951 ptrdiff_t count = SPECPDL_INDEX ();
4952 Lisp_Object odeactivate;
4954 chars = alloca (carryover + readmax);
4955 if (carryover)
4956 /* See the comment above. */
4957 memcpy (chars, SDATA (p->decoding_buf), carryover);
4959 #ifdef DATAGRAM_SOCKETS
4960 /* We have a working select, so proc_buffered_char is always -1. */
4961 if (DATAGRAM_CHAN_P (channel))
4963 socklen_t len = datagram_address[channel].len;
4964 nbytes = recvfrom (channel, chars + carryover, readmax,
4965 0, datagram_address[channel].sa, &len);
4967 else
4968 #endif
4970 bool buffered = proc_buffered_char[channel] >= 0;
4971 if (buffered)
4973 chars[carryover] = proc_buffered_char[channel];
4974 proc_buffered_char[channel] = -1;
4976 #ifdef HAVE_GNUTLS
4977 if (p->gnutls_p)
4978 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
4979 readmax - buffered);
4980 else
4981 #endif
4982 nbytes = emacs_read (channel, chars + carryover + buffered,
4983 readmax - buffered);
4984 #ifdef ADAPTIVE_READ_BUFFERING
4985 if (nbytes > 0 && p->adaptive_read_buffering)
4987 int delay = p->read_output_delay;
4988 if (nbytes < 256)
4990 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
4992 if (delay == 0)
4993 process_output_delay_count++;
4994 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
4997 else if (delay > 0 && nbytes == readmax - buffered)
4999 delay -= READ_OUTPUT_DELAY_INCREMENT;
5000 if (delay == 0)
5001 process_output_delay_count--;
5003 p->read_output_delay = delay;
5004 if (delay)
5006 p->read_output_skip = 1;
5007 process_output_skip = 1;
5010 #endif
5011 nbytes += buffered;
5012 nbytes += buffered && nbytes <= 0;
5015 p->decoding_carryover = 0;
5017 /* At this point, NBYTES holds number of bytes just received
5018 (including the one in proc_buffered_char[channel]). */
5019 if (nbytes <= 0)
5021 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5022 return nbytes;
5023 coding->mode |= CODING_MODE_LAST_BLOCK;
5026 /* Now set NBYTES how many bytes we must decode. */
5027 nbytes += carryover;
5029 odeactivate = Vdeactivate_mark;
5030 /* There's no good reason to let process filters change the current
5031 buffer, and many callers of accept-process-output, sit-for, and
5032 friends don't expect current-buffer to be changed from under them. */
5033 record_unwind_current_buffer ();
5035 read_and_dispose_of_process_output (p, chars, nbytes, coding);
5037 /* Handling the process output should not deactivate the mark. */
5038 Vdeactivate_mark = odeactivate;
5040 unbind_to (count, Qnil);
5041 return nbytes;
5044 static void
5045 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5046 ssize_t nbytes,
5047 struct coding_system *coding)
5049 Lisp_Object outstream = p->filter;
5050 Lisp_Object text;
5051 bool outer_running_asynch_code = running_asynch_code;
5052 int waiting = waiting_for_user_input_p;
5054 /* No need to gcpro these, because all we do with them later
5055 is test them for EQness, and none of them should be a string. */
5056 #if 0
5057 Lisp_Object obuffer, okeymap;
5058 XSETBUFFER (obuffer, current_buffer);
5059 okeymap = BVAR (current_buffer, keymap);
5060 #endif
5062 /* We inhibit quit here instead of just catching it so that
5063 hitting ^G when a filter happens to be running won't screw
5064 it up. */
5065 specbind (Qinhibit_quit, Qt);
5066 specbind (Qlast_nonmenu_event, Qt);
5068 /* In case we get recursively called,
5069 and we already saved the match data nonrecursively,
5070 save the same match data in safely recursive fashion. */
5071 if (outer_running_asynch_code)
5073 Lisp_Object tem;
5074 /* Don't clobber the CURRENT match data, either! */
5075 tem = Fmatch_data (Qnil, Qnil, Qnil);
5076 restore_search_regs ();
5077 record_unwind_save_match_data ();
5078 Fset_match_data (tem, Qt);
5081 /* For speed, if a search happens within this code,
5082 save the match data in a special nonrecursive fashion. */
5083 running_asynch_code = 1;
5085 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5086 text = coding->dst_object;
5087 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5088 /* A new coding system might be found. */
5089 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5091 pset_decode_coding_system (p, Vlast_coding_system_used);
5093 /* Don't call setup_coding_system for
5094 proc_decode_coding_system[channel] here. It is done in
5095 detect_coding called via decode_coding above. */
5097 /* If a coding system for encoding is not yet decided, we set
5098 it as the same as coding-system for decoding.
5100 But, before doing that we must check if
5101 proc_encode_coding_system[p->outfd] surely points to a
5102 valid memory because p->outfd will be changed once EOF is
5103 sent to the process. */
5104 if (NILP (p->encode_coding_system)
5105 && proc_encode_coding_system[p->outfd])
5107 pset_encode_coding_system
5108 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5109 setup_coding_system (p->encode_coding_system,
5110 proc_encode_coding_system[p->outfd]);
5114 if (coding->carryover_bytes > 0)
5116 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5117 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5118 memcpy (SDATA (p->decoding_buf), coding->carryover,
5119 coding->carryover_bytes);
5120 p->decoding_carryover = coding->carryover_bytes;
5122 if (SBYTES (text) > 0)
5123 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5124 sometimes it's simply wrong to wrap (e.g. when called from
5125 accept-process-output). */
5126 internal_condition_case_1 (read_process_output_call,
5127 Fcons (outstream,
5128 Fcons (make_lisp_proc (p),
5129 Fcons (text, Qnil))),
5130 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5131 read_process_output_error_handler);
5133 /* If we saved the match data nonrecursively, restore it now. */
5134 restore_search_regs ();
5135 running_asynch_code = outer_running_asynch_code;
5137 /* Restore waiting_for_user_input_p as it was
5138 when we were called, in case the filter clobbered it. */
5139 waiting_for_user_input_p = waiting;
5141 #if 0 /* Call record_asynch_buffer_change unconditionally,
5142 because we might have changed minor modes or other things
5143 that affect key bindings. */
5144 if (! EQ (Fcurrent_buffer (), obuffer)
5145 || ! EQ (current_buffer->keymap, okeymap))
5146 #endif
5147 /* But do it only if the caller is actually going to read events.
5148 Otherwise there's no need to make him wake up, and it could
5149 cause trouble (for example it would make sit_for return). */
5150 if (waiting_for_user_input_p == -1)
5151 record_asynch_buffer_change ();
5154 DEFUN ("internal-default-process-filter", Finternal_default_process_filter,
5155 Sinternal_default_process_filter, 2, 2, 0,
5156 doc: /* Function used as default process filter. */)
5157 (Lisp_Object proc, Lisp_Object text)
5159 struct Lisp_Process *p;
5160 ptrdiff_t opoint;
5162 CHECK_PROCESS (proc);
5163 p = XPROCESS (proc);
5164 CHECK_STRING (text);
5166 if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5168 Lisp_Object old_read_only;
5169 ptrdiff_t old_begv, old_zv;
5170 ptrdiff_t old_begv_byte, old_zv_byte;
5171 ptrdiff_t before, before_byte;
5172 ptrdiff_t opoint_byte;
5173 struct buffer *b;
5175 Fset_buffer (p->buffer);
5176 opoint = PT;
5177 opoint_byte = PT_BYTE;
5178 old_read_only = BVAR (current_buffer, read_only);
5179 old_begv = BEGV;
5180 old_zv = ZV;
5181 old_begv_byte = BEGV_BYTE;
5182 old_zv_byte = ZV_BYTE;
5184 bset_read_only (current_buffer, Qnil);
5186 /* Insert new output into buffer
5187 at the current end-of-output marker,
5188 thus preserving logical ordering of input and output. */
5189 if (XMARKER (p->mark)->buffer)
5190 SET_PT_BOTH (clip_to_bounds (BEGV,
5191 marker_position (p->mark), ZV),
5192 clip_to_bounds (BEGV_BYTE,
5193 marker_byte_position (p->mark),
5194 ZV_BYTE));
5195 else
5196 SET_PT_BOTH (ZV, ZV_BYTE);
5197 before = PT;
5198 before_byte = PT_BYTE;
5200 /* If the output marker is outside of the visible region, save
5201 the restriction and widen. */
5202 if (! (BEGV <= PT && PT <= ZV))
5203 Fwiden ();
5205 /* Adjust the multibyteness of TEXT to that of the buffer. */
5206 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5207 != ! STRING_MULTIBYTE (text))
5208 text = (STRING_MULTIBYTE (text)
5209 ? Fstring_as_unibyte (text)
5210 : Fstring_to_multibyte (text));
5211 /* Insert before markers in case we are inserting where
5212 the buffer's mark is, and the user's next command is Meta-y. */
5213 insert_from_string_before_markers (text, 0, 0,
5214 SCHARS (text), SBYTES (text), 0);
5216 /* Make sure the process marker's position is valid when the
5217 process buffer is changed in the signal_after_change above.
5218 W3 is known to do that. */
5219 if (BUFFERP (p->buffer)
5220 && (b = XBUFFER (p->buffer), b != current_buffer))
5221 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5222 else
5223 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5225 update_mode_lines++;
5227 /* Make sure opoint and the old restrictions
5228 float ahead of any new text just as point would. */
5229 if (opoint >= before)
5231 opoint += PT - before;
5232 opoint_byte += PT_BYTE - before_byte;
5234 if (old_begv > before)
5236 old_begv += PT - before;
5237 old_begv_byte += PT_BYTE - before_byte;
5239 if (old_zv >= before)
5241 old_zv += PT - before;
5242 old_zv_byte += PT_BYTE - before_byte;
5245 /* If the restriction isn't what it should be, set it. */
5246 if (old_begv != BEGV || old_zv != ZV)
5247 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5249 bset_read_only (current_buffer, old_read_only);
5250 SET_PT_BOTH (opoint, opoint_byte);
5252 return Qnil;
5255 /* Sending data to subprocess. */
5257 /* In send_process, when a write fails temporarily,
5258 wait_reading_process_output is called. It may execute user code,
5259 e.g. timers, that attempts to write new data to the same process.
5260 We must ensure that data is sent in the right order, and not
5261 interspersed half-completed with other writes (Bug#10815). This is
5262 handled by the write_queue element of struct process. It is a list
5263 with each entry having the form
5265 (string . (offset . length))
5267 where STRING is a lisp string, OFFSET is the offset into the
5268 string's byte sequence from which we should begin to send, and
5269 LENGTH is the number of bytes left to send. */
5271 /* Create a new entry in write_queue.
5272 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5273 BUF is a pointer to the string sequence of the input_obj or a C
5274 string in case of Qt or Qnil. */
5276 static void
5277 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5278 const char *buf, ptrdiff_t len, bool front)
5280 ptrdiff_t offset;
5281 Lisp_Object entry, obj;
5283 if (STRINGP (input_obj))
5285 offset = buf - SSDATA (input_obj);
5286 obj = input_obj;
5288 else
5290 offset = 0;
5291 obj = make_unibyte_string (buf, len);
5294 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5296 if (front)
5297 pset_write_queue (p, Fcons (entry, p->write_queue));
5298 else
5299 pset_write_queue (p, nconc2 (p->write_queue, Fcons (entry, Qnil)));
5302 /* Remove the first element in the write_queue of process P, put its
5303 contents in OBJ, BUF and LEN, and return true. If the
5304 write_queue is empty, return false. */
5306 static bool
5307 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5308 const char **buf, ptrdiff_t *len)
5310 Lisp_Object entry, offset_length;
5311 ptrdiff_t offset;
5313 if (NILP (p->write_queue))
5314 return 0;
5316 entry = XCAR (p->write_queue);
5317 pset_write_queue (p, XCDR (p->write_queue));
5319 *obj = XCAR (entry);
5320 offset_length = XCDR (entry);
5322 *len = XINT (XCDR (offset_length));
5323 offset = XINT (XCAR (offset_length));
5324 *buf = SSDATA (*obj) + offset;
5326 return 1;
5329 /* Send some data to process PROC.
5330 BUF is the beginning of the data; LEN is the number of characters.
5331 OBJECT is the Lisp object that the data comes from. If OBJECT is
5332 nil or t, it means that the data comes from C string.
5334 If OBJECT is not nil, the data is encoded by PROC's coding-system
5335 for encoding before it is sent.
5337 This function can evaluate Lisp code and can garbage collect. */
5339 static void
5340 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
5341 Lisp_Object object)
5343 struct Lisp_Process *p = XPROCESS (proc);
5344 ssize_t rv;
5345 struct coding_system *coding;
5347 if (p->raw_status_new)
5348 update_status (p);
5349 if (! EQ (p->status, Qrun))
5350 error ("Process %s not running", SDATA (p->name));
5351 if (p->outfd < 0)
5352 error ("Output file descriptor of %s is closed", SDATA (p->name));
5354 coding = proc_encode_coding_system[p->outfd];
5355 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5357 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5358 || (BUFFERP (object)
5359 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5360 || EQ (object, Qt))
5362 pset_encode_coding_system
5363 (p, complement_process_encoding_system (p->encode_coding_system));
5364 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5366 /* The coding system for encoding was changed to raw-text
5367 because we sent a unibyte text previously. Now we are
5368 sending a multibyte text, thus we must encode it by the
5369 original coding system specified for the current process.
5371 Another reason we come here is that the coding system
5372 was just complemented and a new one was returned by
5373 complement_process_encoding_system. */
5374 setup_coding_system (p->encode_coding_system, coding);
5375 Vlast_coding_system_used = p->encode_coding_system;
5377 coding->src_multibyte = 1;
5379 else
5381 coding->src_multibyte = 0;
5382 /* For sending a unibyte text, character code conversion should
5383 not take place but EOL conversion should. So, setup raw-text
5384 or one of the subsidiary if we have not yet done it. */
5385 if (CODING_REQUIRE_ENCODING (coding))
5387 if (CODING_REQUIRE_FLUSHING (coding))
5389 /* But, before changing the coding, we must flush out data. */
5390 coding->mode |= CODING_MODE_LAST_BLOCK;
5391 send_process (proc, "", 0, Qt);
5392 coding->mode &= CODING_MODE_LAST_BLOCK;
5394 setup_coding_system (raw_text_coding_system
5395 (Vlast_coding_system_used),
5396 coding);
5397 coding->src_multibyte = 0;
5400 coding->dst_multibyte = 0;
5402 if (CODING_REQUIRE_ENCODING (coding))
5404 coding->dst_object = Qt;
5405 if (BUFFERP (object))
5407 ptrdiff_t from_byte, from, to;
5408 ptrdiff_t save_pt, save_pt_byte;
5409 struct buffer *cur = current_buffer;
5411 set_buffer_internal (XBUFFER (object));
5412 save_pt = PT, save_pt_byte = PT_BYTE;
5414 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5415 from = BYTE_TO_CHAR (from_byte);
5416 to = BYTE_TO_CHAR (from_byte + len);
5417 TEMP_SET_PT_BOTH (from, from_byte);
5418 encode_coding_object (coding, object, from, from_byte,
5419 to, from_byte + len, Qt);
5420 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5421 set_buffer_internal (cur);
5423 else if (STRINGP (object))
5425 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5426 SBYTES (object), Qt);
5428 else
5430 coding->dst_object = make_unibyte_string (buf, len);
5431 coding->produced = len;
5434 len = coding->produced;
5435 object = coding->dst_object;
5436 buf = SSDATA (object);
5439 /* If there is already data in the write_queue, put the new data
5440 in the back of queue. Otherwise, ignore it. */
5441 if (!NILP (p->write_queue))
5442 write_queue_push (p, object, buf, len, 0);
5444 do /* while !NILP (p->write_queue) */
5446 ptrdiff_t cur_len = -1;
5447 const char *cur_buf;
5448 Lisp_Object cur_object;
5450 /* If write_queue is empty, ignore it. */
5451 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5453 cur_len = len;
5454 cur_buf = buf;
5455 cur_object = object;
5458 while (cur_len > 0)
5460 /* Send this batch, using one or more write calls. */
5461 ptrdiff_t written = 0;
5462 int outfd = p->outfd;
5463 #ifdef DATAGRAM_SOCKETS
5464 if (DATAGRAM_CHAN_P (outfd))
5466 rv = sendto (outfd, cur_buf, cur_len,
5467 0, datagram_address[outfd].sa,
5468 datagram_address[outfd].len);
5469 if (rv >= 0)
5470 written = rv;
5471 else if (errno == EMSGSIZE)
5472 report_file_error ("sending datagram", Fcons (proc, Qnil));
5474 else
5475 #endif
5477 #ifdef HAVE_GNUTLS
5478 if (p->gnutls_p)
5479 written = emacs_gnutls_write (p, cur_buf, cur_len);
5480 else
5481 #endif
5482 written = emacs_write_sig (outfd, cur_buf, cur_len);
5483 rv = (written ? 0 : -1);
5484 #ifdef ADAPTIVE_READ_BUFFERING
5485 if (p->read_output_delay > 0
5486 && p->adaptive_read_buffering == 1)
5488 p->read_output_delay = 0;
5489 process_output_delay_count--;
5490 p->read_output_skip = 0;
5492 #endif
5495 if (rv < 0)
5497 if (errno == EAGAIN
5498 #ifdef EWOULDBLOCK
5499 || errno == EWOULDBLOCK
5500 #endif
5502 /* Buffer is full. Wait, accepting input;
5503 that may allow the program
5504 to finish doing output and read more. */
5506 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5507 /* A gross hack to work around a bug in FreeBSD.
5508 In the following sequence, read(2) returns
5509 bogus data:
5511 write(2) 1022 bytes
5512 write(2) 954 bytes, get EAGAIN
5513 read(2) 1024 bytes in process_read_output
5514 read(2) 11 bytes in process_read_output
5516 That is, read(2) returns more bytes than have
5517 ever been written successfully. The 1033 bytes
5518 read are the 1022 bytes written successfully
5519 after processing (for example with CRs added if
5520 the terminal is set up that way which it is
5521 here). The same bytes will be seen again in a
5522 later read(2), without the CRs. */
5524 if (errno == EAGAIN)
5526 int flags = FWRITE;
5527 ioctl (p->outfd, TIOCFLUSH, &flags);
5529 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5531 /* Put what we should have written in wait_queue. */
5532 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5533 wait_reading_process_output (0, 20 * 1000 * 1000,
5534 0, 0, Qnil, NULL, 0);
5535 /* Reread queue, to see what is left. */
5536 break;
5538 else if (errno == EPIPE)
5540 p->raw_status_new = 0;
5541 pset_status (p, list2 (Qexit, make_number (256)));
5542 p->tick = ++process_tick;
5543 deactivate_process (proc);
5544 error ("process %s no longer connected to pipe; closed it",
5545 SDATA (p->name));
5547 else
5548 /* This is a real error. */
5549 report_file_error ("writing to process", Fcons (proc, Qnil));
5551 cur_buf += written;
5552 cur_len -= written;
5555 while (!NILP (p->write_queue));
5558 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5559 3, 3, 0,
5560 doc: /* Send current contents of region as input to PROCESS.
5561 PROCESS may be a process, a buffer, the name of a process or buffer, or
5562 nil, indicating the current buffer's process.
5563 Called from program, takes three arguments, PROCESS, START and END.
5564 If the region is more than 500 characters long,
5565 it is sent in several bunches. This may happen even for shorter regions.
5566 Output from processes can arrive in between bunches. */)
5567 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5569 Lisp_Object proc = get_process (process);
5570 ptrdiff_t start_byte, end_byte;
5572 validate_region (&start, &end);
5574 start_byte = CHAR_TO_BYTE (XINT (start));
5575 end_byte = CHAR_TO_BYTE (XINT (end));
5577 if (XINT (start) < GPT && XINT (end) > GPT)
5578 move_gap_both (XINT (start), start_byte);
5580 send_process (proc, (char *) BYTE_POS_ADDR (start_byte),
5581 end_byte - start_byte, Fcurrent_buffer ());
5583 return Qnil;
5586 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5587 2, 2, 0,
5588 doc: /* Send PROCESS the contents of STRING as input.
5589 PROCESS may be a process, a buffer, the name of a process or buffer, or
5590 nil, indicating the current buffer's process.
5591 If STRING is more than 500 characters long,
5592 it is sent in several bunches. This may happen even for shorter strings.
5593 Output from processes can arrive in between bunches. */)
5594 (Lisp_Object process, Lisp_Object string)
5596 Lisp_Object proc;
5597 CHECK_STRING (string);
5598 proc = get_process (process);
5599 send_process (proc, SSDATA (string),
5600 SBYTES (string), string);
5601 return Qnil;
5604 /* Return the foreground process group for the tty/pty that
5605 the process P uses. */
5606 static pid_t
5607 emacs_get_tty_pgrp (struct Lisp_Process *p)
5609 pid_t gid = -1;
5611 #ifdef TIOCGPGRP
5612 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5614 int fd;
5615 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5616 master side. Try the slave side. */
5617 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5619 if (fd != -1)
5621 ioctl (fd, TIOCGPGRP, &gid);
5622 emacs_close (fd);
5625 #endif /* defined (TIOCGPGRP ) */
5627 return gid;
5630 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5631 Sprocess_running_child_p, 0, 1, 0,
5632 doc: /* Return t if PROCESS has given the terminal to a child.
5633 If the operating system does not make it possible to find out,
5634 return t unconditionally. */)
5635 (Lisp_Object process)
5637 /* Initialize in case ioctl doesn't exist or gives an error,
5638 in a way that will cause returning t. */
5639 pid_t gid;
5640 Lisp_Object proc;
5641 struct Lisp_Process *p;
5643 proc = get_process (process);
5644 p = XPROCESS (proc);
5646 if (!EQ (p->type, Qreal))
5647 error ("Process %s is not a subprocess",
5648 SDATA (p->name));
5649 if (p->infd < 0)
5650 error ("Process %s is not active",
5651 SDATA (p->name));
5653 gid = emacs_get_tty_pgrp (p);
5655 if (gid == p->pid)
5656 return Qnil;
5657 return Qt;
5660 /* send a signal number SIGNO to PROCESS.
5661 If CURRENT_GROUP is t, that means send to the process group
5662 that currently owns the terminal being used to communicate with PROCESS.
5663 This is used for various commands in shell mode.
5664 If CURRENT_GROUP is lambda, that means send to the process group
5665 that currently owns the terminal, but only if it is NOT the shell itself.
5667 If NOMSG is false, insert signal-announcements into process's buffers
5668 right away.
5670 If we can, we try to signal PROCESS by sending control characters
5671 down the pty. This allows us to signal inferiors who have changed
5672 their uid, for which kill would return an EPERM error. */
5674 static void
5675 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5676 bool nomsg)
5678 Lisp_Object proc;
5679 struct Lisp_Process *p;
5680 pid_t gid;
5681 bool no_pgrp = 0;
5683 proc = get_process (process);
5684 p = XPROCESS (proc);
5686 if (!EQ (p->type, Qreal))
5687 error ("Process %s is not a subprocess",
5688 SDATA (p->name));
5689 if (p->infd < 0)
5690 error ("Process %s is not active",
5691 SDATA (p->name));
5693 if (!p->pty_flag)
5694 current_group = Qnil;
5696 /* If we are using pgrps, get a pgrp number and make it negative. */
5697 if (NILP (current_group))
5698 /* Send the signal to the shell's process group. */
5699 gid = p->pid;
5700 else
5702 #ifdef SIGNALS_VIA_CHARACTERS
5703 /* If possible, send signals to the entire pgrp
5704 by sending an input character to it. */
5706 struct termios t;
5707 cc_t *sig_char = NULL;
5709 tcgetattr (p->infd, &t);
5711 switch (signo)
5713 case SIGINT:
5714 sig_char = &t.c_cc[VINTR];
5715 break;
5717 case SIGQUIT:
5718 sig_char = &t.c_cc[VQUIT];
5719 break;
5721 case SIGTSTP:
5722 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5723 sig_char = &t.c_cc[VSWTCH];
5724 #else
5725 sig_char = &t.c_cc[VSUSP];
5726 #endif
5727 break;
5730 if (sig_char && *sig_char != CDISABLE)
5732 send_process (proc, (char *) sig_char, 1, Qnil);
5733 return;
5735 /* If we can't send the signal with a character,
5736 fall through and send it another way. */
5738 /* The code above may fall through if it can't
5739 handle the signal. */
5740 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5742 #ifdef TIOCGPGRP
5743 /* Get the current pgrp using the tty itself, if we have that.
5744 Otherwise, use the pty to get the pgrp.
5745 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5746 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5747 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5748 His patch indicates that if TIOCGPGRP returns an error, then
5749 we should just assume that p->pid is also the process group id. */
5751 gid = emacs_get_tty_pgrp (p);
5753 if (gid == -1)
5754 /* If we can't get the information, assume
5755 the shell owns the tty. */
5756 gid = p->pid;
5758 /* It is not clear whether anything really can set GID to -1.
5759 Perhaps on some system one of those ioctls can or could do so.
5760 Or perhaps this is vestigial. */
5761 if (gid == -1)
5762 no_pgrp = 1;
5763 #else /* ! defined (TIOCGPGRP ) */
5764 /* Can't select pgrps on this system, so we know that
5765 the child itself heads the pgrp. */
5766 gid = p->pid;
5767 #endif /* ! defined (TIOCGPGRP ) */
5769 /* If current_group is lambda, and the shell owns the terminal,
5770 don't send any signal. */
5771 if (EQ (current_group, Qlambda) && gid == p->pid)
5772 return;
5775 switch (signo)
5777 #ifdef SIGCONT
5778 case SIGCONT:
5779 p->raw_status_new = 0;
5780 pset_status (p, Qrun);
5781 p->tick = ++process_tick;
5782 if (!nomsg)
5784 status_notify (NULL);
5785 redisplay_preserve_echo_area (13);
5787 break;
5788 #endif /* ! defined (SIGCONT) */
5789 case SIGINT:
5790 case SIGQUIT:
5791 case SIGKILL:
5792 flush_pending_output (p->infd);
5793 break;
5796 /* If we don't have process groups, send the signal to the immediate
5797 subprocess. That isn't really right, but it's better than any
5798 obvious alternative. */
5799 if (no_pgrp)
5801 kill (p->pid, signo);
5802 return;
5805 /* gid may be a pid, or minus a pgrp's number */
5806 #ifdef TIOCSIGSEND
5807 if (!NILP (current_group))
5809 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5810 kill (-gid, signo);
5812 else
5814 gid = - p->pid;
5815 kill (gid, signo);
5817 #else /* ! defined (TIOCSIGSEND) */
5818 kill (-gid, signo);
5819 #endif /* ! defined (TIOCSIGSEND) */
5822 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5823 doc: /* Interrupt process PROCESS.
5824 PROCESS may be a process, a buffer, or the name of a process or buffer.
5825 No arg or nil means current buffer's process.
5826 Second arg CURRENT-GROUP non-nil means send signal to
5827 the current process-group of the process's controlling terminal
5828 rather than to the process's own process group.
5829 If the process is a shell, this means interrupt current subjob
5830 rather than the shell.
5832 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5833 don't send the signal. */)
5834 (Lisp_Object process, Lisp_Object current_group)
5836 process_send_signal (process, SIGINT, current_group, 0);
5837 return process;
5840 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5841 doc: /* Kill process PROCESS. May be process or name of one.
5842 See function `interrupt-process' for more details on usage. */)
5843 (Lisp_Object process, Lisp_Object current_group)
5845 process_send_signal (process, SIGKILL, current_group, 0);
5846 return process;
5849 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5850 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5851 See function `interrupt-process' for more details on usage. */)
5852 (Lisp_Object process, Lisp_Object current_group)
5854 process_send_signal (process, SIGQUIT, current_group, 0);
5855 return process;
5858 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
5859 doc: /* Stop process PROCESS. May be process or name of one.
5860 See function `interrupt-process' for more details on usage.
5861 If PROCESS is a network or serial process, inhibit handling of incoming
5862 traffic. */)
5863 (Lisp_Object process, Lisp_Object current_group)
5865 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5867 struct Lisp_Process *p;
5869 p = XPROCESS (process);
5870 if (NILP (p->command)
5871 && p->infd >= 0)
5873 FD_CLR (p->infd, &input_wait_mask);
5874 FD_CLR (p->infd, &non_keyboard_wait_mask);
5876 pset_command (p, Qt);
5877 return process;
5879 #ifndef SIGTSTP
5880 error ("No SIGTSTP support");
5881 #else
5882 process_send_signal (process, SIGTSTP, current_group, 0);
5883 #endif
5884 return process;
5887 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
5888 doc: /* Continue process PROCESS. May be process or name of one.
5889 See function `interrupt-process' for more details on usage.
5890 If PROCESS is a network or serial process, resume handling of incoming
5891 traffic. */)
5892 (Lisp_Object process, Lisp_Object current_group)
5894 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5896 struct Lisp_Process *p;
5898 p = XPROCESS (process);
5899 if (EQ (p->command, Qt)
5900 && p->infd >= 0
5901 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
5903 FD_SET (p->infd, &input_wait_mask);
5904 FD_SET (p->infd, &non_keyboard_wait_mask);
5905 #ifdef WINDOWSNT
5906 if (fd_info[ p->infd ].flags & FILE_SERIAL)
5907 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
5908 #else /* not WINDOWSNT */
5909 tcflush (p->infd, TCIFLUSH);
5910 #endif /* not WINDOWSNT */
5912 pset_command (p, Qnil);
5913 return process;
5915 #ifdef SIGCONT
5916 process_send_signal (process, SIGCONT, current_group, 0);
5917 #else
5918 error ("No SIGCONT support");
5919 #endif
5920 return process;
5923 /* Return the integer value of the signal whose abbreviation is ABBR,
5924 or a negative number if there is no such signal. */
5925 static int
5926 abbr_to_signal (char const *name)
5928 int i, signo;
5929 char sigbuf[20]; /* Large enough for all valid signal abbreviations. */
5931 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
5932 name += 3;
5934 for (i = 0; i < sizeof sigbuf; i++)
5936 sigbuf[i] = c_toupper (name[i]);
5937 if (! sigbuf[i])
5938 return str2sig (sigbuf, &signo) == 0 ? signo : -1;
5941 return -1;
5944 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
5945 2, 2, "sProcess (name or number): \nnSignal code: ",
5946 doc: /* Send PROCESS the signal with code SIGCODE.
5947 PROCESS may also be a number specifying the process id of the
5948 process to signal; in this case, the process need not be a child of
5949 this Emacs.
5950 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
5951 (Lisp_Object process, Lisp_Object sigcode)
5953 pid_t pid;
5954 int signo;
5956 if (STRINGP (process))
5958 Lisp_Object tem = Fget_process (process);
5959 if (NILP (tem))
5961 Lisp_Object process_number =
5962 string_to_number (SSDATA (process), 10, 1);
5963 if (INTEGERP (process_number) || FLOATP (process_number))
5964 tem = process_number;
5966 process = tem;
5968 else if (!NUMBERP (process))
5969 process = get_process (process);
5971 if (NILP (process))
5972 return process;
5974 if (NUMBERP (process))
5975 CONS_TO_INTEGER (process, pid_t, pid);
5976 else
5978 CHECK_PROCESS (process);
5979 pid = XPROCESS (process)->pid;
5980 if (pid <= 0)
5981 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
5984 if (INTEGERP (sigcode))
5986 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
5987 signo = XINT (sigcode);
5989 else
5991 char *name;
5993 CHECK_SYMBOL (sigcode);
5994 name = SSDATA (SYMBOL_NAME (sigcode));
5996 signo = abbr_to_signal (name);
5997 if (signo < 0)
5998 error ("Undefined signal name %s", name);
6001 return make_number (kill (pid, signo));
6004 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6005 doc: /* Make PROCESS see end-of-file in its input.
6006 EOF comes after any text already sent to it.
6007 PROCESS may be a process, a buffer, the name of a process or buffer, or
6008 nil, indicating the current buffer's process.
6009 If PROCESS is a network connection, or is a process communicating
6010 through a pipe (as opposed to a pty), then you cannot send any more
6011 text to PROCESS after you call this function.
6012 If PROCESS is a serial process, wait until all output written to the
6013 process has been transmitted to the serial port. */)
6014 (Lisp_Object process)
6016 Lisp_Object proc;
6017 struct coding_system *coding;
6019 if (DATAGRAM_CONN_P (process))
6020 return process;
6022 proc = get_process (process);
6023 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6025 /* Make sure the process is really alive. */
6026 if (XPROCESS (proc)->raw_status_new)
6027 update_status (XPROCESS (proc));
6028 if (! EQ (XPROCESS (proc)->status, Qrun))
6029 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6031 if (CODING_REQUIRE_FLUSHING (coding))
6033 coding->mode |= CODING_MODE_LAST_BLOCK;
6034 send_process (proc, "", 0, Qnil);
6037 if (XPROCESS (proc)->pty_flag)
6038 send_process (proc, "\004", 1, Qnil);
6039 else if (EQ (XPROCESS (proc)->type, Qserial))
6041 #ifndef WINDOWSNT
6042 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6043 error ("tcdrain() failed: %s", emacs_strerror (errno));
6044 #endif /* not WINDOWSNT */
6045 /* Do nothing on Windows because writes are blocking. */
6047 else
6049 int old_outfd, new_outfd;
6051 #ifdef HAVE_SHUTDOWN
6052 /* If this is a network connection, or socketpair is used
6053 for communication with the subprocess, call shutdown to cause EOF.
6054 (In some old system, shutdown to socketpair doesn't work.
6055 Then we just can't win.) */
6056 if (EQ (XPROCESS (proc)->type, Qnetwork)
6057 || XPROCESS (proc)->outfd == XPROCESS (proc)->infd)
6058 shutdown (XPROCESS (proc)->outfd, 1);
6059 /* In case of socketpair, outfd == infd, so don't close it. */
6060 if (XPROCESS (proc)->outfd != XPROCESS (proc)->infd)
6061 emacs_close (XPROCESS (proc)->outfd);
6062 #else /* not HAVE_SHUTDOWN */
6063 emacs_close (XPROCESS (proc)->outfd);
6064 #endif /* not HAVE_SHUTDOWN */
6065 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6066 if (new_outfd < 0)
6067 emacs_abort ();
6068 old_outfd = XPROCESS (proc)->outfd;
6070 if (!proc_encode_coding_system[new_outfd])
6071 proc_encode_coding_system[new_outfd]
6072 = xmalloc (sizeof (struct coding_system));
6073 *proc_encode_coding_system[new_outfd]
6074 = *proc_encode_coding_system[old_outfd];
6075 memset (proc_encode_coding_system[old_outfd], 0,
6076 sizeof (struct coding_system));
6078 XPROCESS (proc)->outfd = new_outfd;
6080 return process;
6083 /* The main Emacs thread records child processes in three places:
6085 - Vprocess_alist, for asynchronous subprocesses, which are child
6086 processes visible to Lisp.
6088 - deleted_pid_list, for child processes invisible to Lisp,
6089 typically because of delete-process. These are recorded so that
6090 the processes can be reaped when they exit, so that the operating
6091 system's process table is not cluttered by zombies.
6093 - the local variable PID in Fcall_process, call_process_cleanup and
6094 call_process_kill, for synchronous subprocesses.
6095 record_unwind_protect is used to make sure this process is not
6096 forgotten: if the user interrupts call-process and the child
6097 process refuses to exit immediately even with two C-g's,
6098 call_process_kill adds PID's contents to deleted_pid_list before
6099 returning.
6101 The main Emacs thread invokes waitpid only on child processes that
6102 it creates and that have not been reaped. This avoid races on
6103 platforms such as GTK, where other threads create their own
6104 subprocesses which the main thread should not reap. For example,
6105 if the main thread attempted to reap an already-reaped child, it
6106 might inadvertently reap a GTK-created process that happened to
6107 have the same process ID. */
6109 /* LIB_CHILD_HANDLER is a SIGCHLD handler that Emacs calls while doing
6110 its own SIGCHLD handling. On POSIXish systems, glib needs this to
6111 keep track of its own children. GNUstep is similar. */
6113 static void dummy_handler (int sig) {}
6114 static signal_handler_t volatile lib_child_handler;
6116 /* Handle a SIGCHLD signal by looking for known child processes of
6117 Emacs whose status have changed. For each one found, record its
6118 new status.
6120 All we do is change the status; we do not run sentinels or print
6121 notifications. That is saved for the next time keyboard input is
6122 done, in order to avoid timing errors.
6124 ** WARNING: this can be called during garbage collection.
6125 Therefore, it must not be fooled by the presence of mark bits in
6126 Lisp objects.
6128 ** USG WARNING: Although it is not obvious from the documentation
6129 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6130 signal() before executing at least one wait(), otherwise the
6131 handler will be called again, resulting in an infinite loop. The
6132 relevant portion of the documentation reads "SIGCLD signals will be
6133 queued and the signal-catching function will be continually
6134 reentered until the queue is empty". Invoking signal() causes the
6135 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6136 Inc.
6138 ** Malloc WARNING: This should never call malloc either directly or
6139 indirectly; if it does, that is a bug */
6141 static void
6142 handle_child_signal (int sig)
6144 Lisp_Object tail;
6146 /* Find the process that signaled us, and record its status. */
6148 /* The process can have been deleted by Fdelete_process, or have
6149 been started asynchronously by Fcall_process. */
6150 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6152 bool all_pids_are_fixnums
6153 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
6154 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
6155 Lisp_Object xpid = XCAR (tail);
6156 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
6158 pid_t deleted_pid;
6159 if (INTEGERP (xpid))
6160 deleted_pid = XINT (xpid);
6161 else
6162 deleted_pid = XFLOAT_DATA (xpid);
6163 if (child_status_changed (deleted_pid, 0, 0))
6164 XSETCAR (tail, Qnil);
6168 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6169 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6171 Lisp_Object proc = XCDR (XCAR (tail));
6172 struct Lisp_Process *p = XPROCESS (proc);
6173 int status;
6175 if (p->alive
6176 && child_status_changed (p->pid, &status, WUNTRACED | WCONTINUED))
6178 /* Change the status of the process that was found. */
6179 p->tick = ++process_tick;
6180 p->raw_status = status;
6181 p->raw_status_new = 1;
6183 /* If process has terminated, stop waiting for its output. */
6184 if (WIFSIGNALED (status) || WIFEXITED (status))
6186 bool clear_desc_flag = 0;
6187 p->alive = 0;
6188 if (p->infd >= 0)
6189 clear_desc_flag = 1;
6191 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
6192 if (clear_desc_flag)
6194 FD_CLR (p->infd, &input_wait_mask);
6195 FD_CLR (p->infd, &non_keyboard_wait_mask);
6201 lib_child_handler (sig);
6202 #ifdef NS_IMPL_GNUSTEP
6203 /* NSTask in GNUStep sets its child handler each time it is called.
6204 So we must re-set ours. */
6205 catch_child_signal();
6206 #endif
6209 static void
6210 deliver_child_signal (int sig)
6212 deliver_process_signal (sig, handle_child_signal);
6216 static Lisp_Object
6217 exec_sentinel_error_handler (Lisp_Object error_val)
6219 cmd_error_internal (error_val, "error in process sentinel: ");
6220 Vinhibit_quit = Qt;
6221 update_echo_area ();
6222 Fsleep_for (make_number (2), Qnil);
6223 return Qt;
6226 static void
6227 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6229 Lisp_Object sentinel, odeactivate;
6230 struct Lisp_Process *p = XPROCESS (proc);
6231 ptrdiff_t count = SPECPDL_INDEX ();
6232 bool outer_running_asynch_code = running_asynch_code;
6233 int waiting = waiting_for_user_input_p;
6235 if (inhibit_sentinels)
6236 return;
6238 /* No need to gcpro these, because all we do with them later
6239 is test them for EQness, and none of them should be a string. */
6240 odeactivate = Vdeactivate_mark;
6241 #if 0
6242 Lisp_Object obuffer, okeymap;
6243 XSETBUFFER (obuffer, current_buffer);
6244 okeymap = BVAR (current_buffer, keymap);
6245 #endif
6247 /* There's no good reason to let sentinels change the current
6248 buffer, and many callers of accept-process-output, sit-for, and
6249 friends don't expect current-buffer to be changed from under them. */
6250 record_unwind_current_buffer ();
6252 sentinel = p->sentinel;
6254 /* Inhibit quit so that random quits don't screw up a running filter. */
6255 specbind (Qinhibit_quit, Qt);
6256 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6258 /* In case we get recursively called,
6259 and we already saved the match data nonrecursively,
6260 save the same match data in safely recursive fashion. */
6261 if (outer_running_asynch_code)
6263 Lisp_Object tem;
6264 tem = Fmatch_data (Qnil, Qnil, Qnil);
6265 restore_search_regs ();
6266 record_unwind_save_match_data ();
6267 Fset_match_data (tem, Qt);
6270 /* For speed, if a search happens within this code,
6271 save the match data in a special nonrecursive fashion. */
6272 running_asynch_code = 1;
6274 internal_condition_case_1 (read_process_output_call,
6275 Fcons (sentinel,
6276 Fcons (proc, Fcons (reason, Qnil))),
6277 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6278 exec_sentinel_error_handler);
6280 /* If we saved the match data nonrecursively, restore it now. */
6281 restore_search_regs ();
6282 running_asynch_code = outer_running_asynch_code;
6284 Vdeactivate_mark = odeactivate;
6286 /* Restore waiting_for_user_input_p as it was
6287 when we were called, in case the filter clobbered it. */
6288 waiting_for_user_input_p = waiting;
6290 #if 0
6291 if (! EQ (Fcurrent_buffer (), obuffer)
6292 || ! EQ (current_buffer->keymap, okeymap))
6293 #endif
6294 /* But do it only if the caller is actually going to read events.
6295 Otherwise there's no need to make him wake up, and it could
6296 cause trouble (for example it would make sit_for return). */
6297 if (waiting_for_user_input_p == -1)
6298 record_asynch_buffer_change ();
6300 unbind_to (count, Qnil);
6303 /* Report all recent events of a change in process status
6304 (either run the sentinel or output a message).
6305 This is usually done while Emacs is waiting for keyboard input
6306 but can be done at other times. */
6308 static void
6309 status_notify (struct Lisp_Process *deleting_process)
6311 register Lisp_Object proc;
6312 Lisp_Object tail, msg;
6313 struct gcpro gcpro1, gcpro2;
6315 tail = Qnil;
6316 msg = Qnil;
6317 /* We need to gcpro tail; if read_process_output calls a filter
6318 which deletes a process and removes the cons to which tail points
6319 from Vprocess_alist, and then causes a GC, tail is an unprotected
6320 reference. */
6321 GCPRO2 (tail, msg);
6323 /* Set this now, so that if new processes are created by sentinels
6324 that we run, we get called again to handle their status changes. */
6325 update_tick = process_tick;
6327 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6329 Lisp_Object symbol;
6330 register struct Lisp_Process *p;
6332 proc = Fcdr (XCAR (tail));
6333 p = XPROCESS (proc);
6335 if (p->tick != p->update_tick)
6337 p->update_tick = p->tick;
6339 /* If process is still active, read any output that remains. */
6340 while (! EQ (p->filter, Qt)
6341 && ! EQ (p->status, Qconnect)
6342 && ! EQ (p->status, Qlisten)
6343 /* Network or serial process not stopped: */
6344 && ! EQ (p->command, Qt)
6345 && p->infd >= 0
6346 && p != deleting_process
6347 && read_process_output (proc, p->infd) > 0);
6349 /* Get the text to use for the message. */
6350 if (p->raw_status_new)
6351 update_status (p);
6352 msg = status_message (p);
6354 /* If process is terminated, deactivate it or delete it. */
6355 symbol = p->status;
6356 if (CONSP (p->status))
6357 symbol = XCAR (p->status);
6359 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6360 || EQ (symbol, Qclosed))
6362 if (delete_exited_processes)
6363 remove_process (proc);
6364 else
6365 deactivate_process (proc);
6368 /* The actions above may have further incremented p->tick.
6369 So set p->update_tick again so that an error in the sentinel will
6370 not cause this code to be run again. */
6371 p->update_tick = p->tick;
6372 /* Now output the message suitably. */
6373 exec_sentinel (proc, msg);
6375 } /* end for */
6377 update_mode_lines++; /* In case buffers use %s in mode-line-format. */
6378 UNGCPRO;
6381 DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel,
6382 Sinternal_default_process_sentinel, 2, 2, 0,
6383 doc: /* Function used as default sentinel for processes. */)
6384 (Lisp_Object proc, Lisp_Object msg)
6386 Lisp_Object buffer, symbol;
6387 struct Lisp_Process *p;
6388 CHECK_PROCESS (proc);
6389 p = XPROCESS (proc);
6390 buffer = p->buffer;
6391 symbol = p->status;
6392 if (CONSP (symbol))
6393 symbol = XCAR (symbol);
6395 if (!EQ (symbol, Qrun) && !NILP (buffer))
6397 Lisp_Object tem;
6398 struct buffer *old = current_buffer;
6399 ptrdiff_t opoint, opoint_byte;
6400 ptrdiff_t before, before_byte;
6402 /* Avoid error if buffer is deleted
6403 (probably that's why the process is dead, too). */
6404 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
6405 return Qnil;
6406 Fset_buffer (buffer);
6408 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
6409 msg = (code_convert_string_norecord
6410 (msg, Vlocale_coding_system, 1));
6412 opoint = PT;
6413 opoint_byte = PT_BYTE;
6414 /* Insert new output into buffer
6415 at the current end-of-output marker,
6416 thus preserving logical ordering of input and output. */
6417 if (XMARKER (p->mark)->buffer)
6418 Fgoto_char (p->mark);
6419 else
6420 SET_PT_BOTH (ZV, ZV_BYTE);
6422 before = PT;
6423 before_byte = PT_BYTE;
6425 tem = BVAR (current_buffer, read_only);
6426 bset_read_only (current_buffer, Qnil);
6427 insert_string ("\nProcess ");
6428 { /* FIXME: temporary kludge. */
6429 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
6430 insert_string (" ");
6431 Finsert (1, &msg);
6432 bset_read_only (current_buffer, tem);
6433 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6435 if (opoint >= before)
6436 SET_PT_BOTH (opoint + (PT - before),
6437 opoint_byte + (PT_BYTE - before_byte));
6438 else
6439 SET_PT_BOTH (opoint, opoint_byte);
6441 set_buffer_internal (old);
6443 return Qnil;
6447 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6448 Sset_process_coding_system, 1, 3, 0,
6449 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6450 DECODING will be used to decode subprocess output and ENCODING to
6451 encode subprocess input. */)
6452 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6454 register struct Lisp_Process *p;
6456 CHECK_PROCESS (process);
6457 p = XPROCESS (process);
6458 if (p->infd < 0)
6459 error ("Input file descriptor of %s closed", SDATA (p->name));
6460 if (p->outfd < 0)
6461 error ("Output file descriptor of %s closed", SDATA (p->name));
6462 Fcheck_coding_system (decoding);
6463 Fcheck_coding_system (encoding);
6464 encoding = coding_inherit_eol_type (encoding, Qnil);
6465 pset_decode_coding_system (p, decoding);
6466 pset_encode_coding_system (p, encoding);
6467 setup_process_coding_systems (process);
6469 return Qnil;
6472 DEFUN ("process-coding-system",
6473 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6474 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6475 (register Lisp_Object process)
6477 CHECK_PROCESS (process);
6478 return Fcons (XPROCESS (process)->decode_coding_system,
6479 XPROCESS (process)->encode_coding_system);
6482 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6483 Sset_process_filter_multibyte, 2, 2, 0,
6484 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6485 If FLAG is non-nil, the filter is given multibyte strings.
6486 If FLAG is nil, the filter is given unibyte strings. In this case,
6487 all character code conversion except for end-of-line conversion is
6488 suppressed. */)
6489 (Lisp_Object process, Lisp_Object flag)
6491 register struct Lisp_Process *p;
6493 CHECK_PROCESS (process);
6494 p = XPROCESS (process);
6495 if (NILP (flag))
6496 pset_decode_coding_system
6497 (p, raw_text_coding_system (p->decode_coding_system));
6498 setup_process_coding_systems (process);
6500 return Qnil;
6503 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6504 Sprocess_filter_multibyte_p, 1, 1, 0,
6505 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6506 (Lisp_Object process)
6508 register struct Lisp_Process *p;
6509 struct coding_system *coding;
6511 CHECK_PROCESS (process);
6512 p = XPROCESS (process);
6513 coding = proc_decode_coding_system[p->infd];
6514 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6520 # ifdef HAVE_GPM
6522 void
6523 add_gpm_wait_descriptor (int desc)
6525 add_keyboard_wait_descriptor (desc);
6528 void
6529 delete_gpm_wait_descriptor (int desc)
6531 delete_keyboard_wait_descriptor (desc);
6534 # endif
6536 # ifdef USABLE_SIGIO
6538 /* Return true if *MASK has a bit set
6539 that corresponds to one of the keyboard input descriptors. */
6541 static bool
6542 keyboard_bit_set (fd_set *mask)
6544 int fd;
6546 for (fd = 0; fd <= max_input_desc; fd++)
6547 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6548 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6549 return 1;
6551 return 0;
6553 # endif
6555 #else /* not subprocesses */
6557 /* Defined on msdos.c. */
6558 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
6559 EMACS_TIME *, void *);
6561 /* Implementation of wait_reading_process_output, assuming that there
6562 are no subprocesses. Used only by the MS-DOS build.
6564 Wait for timeout to elapse and/or keyboard input to be available.
6566 TIME_LIMIT is:
6567 timeout in seconds
6568 If negative, gobble data immediately available but don't wait for any.
6570 NSECS is:
6571 an additional duration to wait, measured in nanoseconds
6572 If TIME_LIMIT is zero, then:
6573 If NSECS == 0, there is no limit.
6574 If NSECS > 0, the timeout consists of NSECS only.
6575 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6577 READ_KBD is:
6578 0 to ignore keyboard input, or
6579 1 to return when input is available, or
6580 -1 means caller will actually read the input, so don't throw to
6581 the quit handler.
6583 see full version for other parameters. We know that wait_proc will
6584 always be NULL, since `subprocesses' isn't defined.
6586 DO_DISPLAY means redisplay should be done to show subprocess
6587 output that arrives.
6589 Return true if we received input from any process. */
6591 bool
6592 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6593 bool do_display,
6594 Lisp_Object wait_for_cell,
6595 struct Lisp_Process *wait_proc, int just_wait_proc)
6597 register int nfds;
6598 EMACS_TIME end_time, timeout;
6600 if (time_limit < 0)
6602 time_limit = 0;
6603 nsecs = -1;
6605 else if (TYPE_MAXIMUM (time_t) < time_limit)
6606 time_limit = TYPE_MAXIMUM (time_t);
6608 /* What does time_limit really mean? */
6609 if (time_limit || nsecs > 0)
6611 timeout = make_emacs_time (time_limit, nsecs);
6612 end_time = add_emacs_time (current_emacs_time (), timeout);
6615 /* Turn off periodic alarms (in case they are in use)
6616 and then turn off any other atimers,
6617 because the select emulator uses alarms. */
6618 stop_polling ();
6619 turn_on_atimers (0);
6621 while (1)
6623 bool timeout_reduced_for_timers = 0;
6624 SELECT_TYPE waitchannels;
6625 int xerrno;
6627 /* If calling from keyboard input, do not quit
6628 since we want to return C-g as an input character.
6629 Otherwise, do pending quit if requested. */
6630 if (read_kbd >= 0)
6631 QUIT;
6633 /* Exit now if the cell we're waiting for became non-nil. */
6634 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6635 break;
6637 /* Compute time from now till when time limit is up. */
6638 /* Exit if already run out. */
6639 if (nsecs < 0)
6641 /* A negative timeout means
6642 gobble output available now
6643 but don't wait at all. */
6645 timeout = make_emacs_time (0, 0);
6647 else if (time_limit || nsecs > 0)
6649 EMACS_TIME now = current_emacs_time ();
6650 if (EMACS_TIME_LE (end_time, now))
6651 break;
6652 timeout = sub_emacs_time (end_time, now);
6654 else
6656 timeout = make_emacs_time (100000, 0);
6659 /* If our caller will not immediately handle keyboard events,
6660 run timer events directly.
6661 (Callers that will immediately read keyboard events
6662 call timer_delay on their own.) */
6663 if (NILP (wait_for_cell))
6665 EMACS_TIME timer_delay;
6669 unsigned old_timers_run = timers_run;
6670 timer_delay = timer_check ();
6671 if (timers_run != old_timers_run && do_display)
6672 /* We must retry, since a timer may have requeued itself
6673 and that could alter the time delay. */
6674 redisplay_preserve_echo_area (14);
6675 else
6676 break;
6678 while (!detect_input_pending ());
6680 /* If there is unread keyboard input, also return. */
6681 if (read_kbd != 0
6682 && requeued_events_pending_p ())
6683 break;
6685 if (EMACS_TIME_VALID_P (timer_delay) && nsecs >= 0)
6687 if (EMACS_TIME_LT (timer_delay, timeout))
6689 timeout = timer_delay;
6690 timeout_reduced_for_timers = 1;
6695 /* Cause C-g and alarm signals to take immediate action,
6696 and cause input available signals to zero out timeout. */
6697 if (read_kbd < 0)
6698 set_waiting_for_input (&timeout);
6700 /* If a frame has been newly mapped and needs updating,
6701 reprocess its display stuff. */
6702 if (frame_garbaged && do_display)
6704 clear_waiting_for_input ();
6705 redisplay_preserve_echo_area (15);
6706 if (read_kbd < 0)
6707 set_waiting_for_input (&timeout);
6710 /* Wait till there is something to do. */
6711 FD_ZERO (&waitchannels);
6712 if (read_kbd && detect_input_pending ())
6713 nfds = 0;
6714 else
6716 if (read_kbd || !NILP (wait_for_cell))
6717 FD_SET (0, &waitchannels);
6718 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6721 xerrno = errno;
6723 /* Make C-g and alarm signals set flags again */
6724 clear_waiting_for_input ();
6726 /* If we woke up due to SIGWINCH, actually change size now. */
6727 do_pending_window_change (0);
6729 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6730 /* We waited the full specified time, so return now. */
6731 break;
6733 if (nfds == -1)
6735 /* If the system call was interrupted, then go around the
6736 loop again. */
6737 if (xerrno == EINTR)
6738 FD_ZERO (&waitchannels);
6739 else
6740 error ("select error: %s", emacs_strerror (xerrno));
6743 /* Check for keyboard input */
6745 if (read_kbd
6746 && detect_input_pending_run_timers (do_display))
6748 swallow_events (do_display);
6749 if (detect_input_pending_run_timers (do_display))
6750 break;
6753 /* If there is unread keyboard input, also return. */
6754 if (read_kbd
6755 && requeued_events_pending_p ())
6756 break;
6758 /* If wait_for_cell. check for keyboard input
6759 but don't run any timers.
6760 ??? (It seems wrong to me to check for keyboard
6761 input at all when wait_for_cell, but the code
6762 has been this way since July 1994.
6763 Try changing this after version 19.31.) */
6764 if (! NILP (wait_for_cell)
6765 && detect_input_pending ())
6767 swallow_events (do_display);
6768 if (detect_input_pending ())
6769 break;
6772 /* Exit now if the cell we're waiting for became non-nil. */
6773 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6774 break;
6777 start_polling ();
6779 return 0;
6782 #endif /* not subprocesses */
6784 /* The following functions are needed even if async subprocesses are
6785 not supported. Some of them are no-op stubs in that case. */
6787 /* Add DESC to the set of keyboard input descriptors. */
6789 void
6790 add_keyboard_wait_descriptor (int desc)
6792 #ifdef subprocesses /* actually means "not MSDOS" */
6793 FD_SET (desc, &input_wait_mask);
6794 FD_SET (desc, &non_process_wait_mask);
6795 if (desc > max_input_desc)
6796 max_input_desc = desc;
6797 #endif
6800 /* From now on, do not expect DESC to give keyboard input. */
6802 void
6803 delete_keyboard_wait_descriptor (int desc)
6805 #ifdef subprocesses
6806 int fd;
6807 int lim = max_input_desc;
6809 FD_CLR (desc, &input_wait_mask);
6810 FD_CLR (desc, &non_process_wait_mask);
6812 if (desc == max_input_desc)
6813 for (fd = 0; fd < lim; fd++)
6814 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
6815 max_input_desc = fd;
6816 #endif
6819 /* Setup coding systems of PROCESS. */
6821 void
6822 setup_process_coding_systems (Lisp_Object process)
6824 #ifdef subprocesses
6825 struct Lisp_Process *p = XPROCESS (process);
6826 int inch = p->infd;
6827 int outch = p->outfd;
6828 Lisp_Object coding_system;
6830 if (inch < 0 || outch < 0)
6831 return;
6833 if (!proc_decode_coding_system[inch])
6834 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
6835 coding_system = p->decode_coding_system;
6836 if (EQ (p->filter, Qinternal_default_process_filter)
6837 && BUFFERP (p->buffer))
6839 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
6840 coding_system = raw_text_coding_system (coding_system);
6842 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
6844 if (!proc_encode_coding_system[outch])
6845 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
6846 setup_coding_system (p->encode_coding_system,
6847 proc_encode_coding_system[outch]);
6848 #endif
6851 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
6852 doc: /* Return the (or a) process associated with BUFFER.
6853 BUFFER may be a buffer or the name of one. */)
6854 (register Lisp_Object buffer)
6856 #ifdef subprocesses
6857 register Lisp_Object buf, tail, proc;
6859 if (NILP (buffer)) return Qnil;
6860 buf = Fget_buffer (buffer);
6861 if (NILP (buf)) return Qnil;
6863 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6865 proc = Fcdr (XCAR (tail));
6866 if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
6867 return proc;
6869 #endif /* subprocesses */
6870 return Qnil;
6873 DEFUN ("process-inherit-coding-system-flag",
6874 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
6875 1, 1, 0,
6876 doc: /* Return the value of inherit-coding-system flag for PROCESS.
6877 If this flag is t, `buffer-file-coding-system' of the buffer
6878 associated with PROCESS will inherit the coding system used to decode
6879 the process output. */)
6880 (register Lisp_Object process)
6882 #ifdef subprocesses
6883 CHECK_PROCESS (process);
6884 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
6885 #else
6886 /* Ignore the argument and return the value of
6887 inherit-process-coding-system. */
6888 return inherit_process_coding_system ? Qt : Qnil;
6889 #endif
6892 /* Kill all processes associated with `buffer'.
6893 If `buffer' is nil, kill all processes */
6895 void
6896 kill_buffer_processes (Lisp_Object buffer)
6898 #ifdef subprocesses
6899 Lisp_Object tail, proc;
6901 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6903 proc = XCDR (XCAR (tail));
6904 if (PROCESSP (proc)
6905 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
6907 if (NETCONN_P (proc) || SERIALCONN_P (proc))
6908 Fdelete_process (proc);
6909 else if (XPROCESS (proc)->infd >= 0)
6910 process_send_signal (proc, SIGHUP, Qnil, 1);
6913 #else /* subprocesses */
6914 /* Since we have no subprocesses, this does nothing. */
6915 #endif /* subprocesses */
6918 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
6919 Swaiting_for_user_input_p, 0, 0, 0,
6920 doc: /* Return non-nil if Emacs is waiting for input from the user.
6921 This is intended for use by asynchronous process output filters and sentinels. */)
6922 (void)
6924 #ifdef subprocesses
6925 return (waiting_for_user_input_p ? Qt : Qnil);
6926 #else
6927 return Qnil;
6928 #endif
6931 /* Stop reading input from keyboard sources. */
6933 void
6934 hold_keyboard_input (void)
6936 kbd_is_on_hold = 1;
6939 /* Resume reading input from keyboard sources. */
6941 void
6942 unhold_keyboard_input (void)
6944 kbd_is_on_hold = 0;
6947 /* Return true if keyboard input is on hold, zero otherwise. */
6949 bool
6950 kbd_on_hold_p (void)
6952 return kbd_is_on_hold;
6956 /* Enumeration of and access to system processes a-la ps(1). */
6958 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
6959 0, 0, 0,
6960 doc: /* Return a list of numerical process IDs of all running processes.
6961 If this functionality is unsupported, return nil.
6963 See `process-attributes' for getting attributes of a process given its ID. */)
6964 (void)
6966 return list_system_processes ();
6969 DEFUN ("process-attributes", Fprocess_attributes,
6970 Sprocess_attributes, 1, 1, 0,
6971 doc: /* Return attributes of the process given by its PID, a number.
6973 Value is an alist where each element is a cons cell of the form
6975 \(KEY . VALUE)
6977 If this functionality is unsupported, the value is nil.
6979 See `list-system-processes' for getting a list of all process IDs.
6981 The KEYs of the attributes that this function may return are listed
6982 below, together with the type of the associated VALUE (in parentheses).
6983 Not all platforms support all of these attributes; unsupported
6984 attributes will not appear in the returned alist.
6985 Unless explicitly indicated otherwise, numbers can have either
6986 integer or floating point values.
6988 euid -- Effective user User ID of the process (number)
6989 user -- User name corresponding to euid (string)
6990 egid -- Effective user Group ID of the process (number)
6991 group -- Group name corresponding to egid (string)
6992 comm -- Command name (executable name only) (string)
6993 state -- Process state code, such as "S", "R", or "T" (string)
6994 ppid -- Parent process ID (number)
6995 pgrp -- Process group ID (number)
6996 sess -- Session ID, i.e. process ID of session leader (number)
6997 ttname -- Controlling tty name (string)
6998 tpgid -- ID of foreground process group on the process's tty (number)
6999 minflt -- number of minor page faults (number)
7000 majflt -- number of major page faults (number)
7001 cminflt -- cumulative number of minor page faults (number)
7002 cmajflt -- cumulative number of major page faults (number)
7003 utime -- user time used by the process, in (current-time) format,
7004 which is a list of integers (HIGH LOW USEC PSEC)
7005 stime -- system time used by the process (current-time)
7006 time -- sum of utime and stime (current-time)
7007 cutime -- user time used by the process and its children (current-time)
7008 cstime -- system time used by the process and its children (current-time)
7009 ctime -- sum of cutime and cstime (current-time)
7010 pri -- priority of the process (number)
7011 nice -- nice value of the process (number)
7012 thcount -- process thread count (number)
7013 start -- time the process started (current-time)
7014 vsize -- virtual memory size of the process in KB's (number)
7015 rss -- resident set size of the process in KB's (number)
7016 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7017 pcpu -- percents of CPU time used by the process (floating-point number)
7018 pmem -- percents of total physical memory used by process's resident set
7019 (floating-point number)
7020 args -- command line which invoked the process (string). */)
7021 ( Lisp_Object pid)
7023 return system_process_attributes (pid);
7026 /* Arrange to catch SIGCHLD if this hasn't already been arranged.
7027 Invoke this after init_process_emacs, and after glib and/or GNUstep
7028 futz with the SIGCHLD handler, but before Emacs forks any children.
7029 This function's caller should block SIGCHLD. */
7031 #ifndef NS_IMPL_GNUSTEP
7032 static
7033 #endif
7034 void
7035 catch_child_signal (void)
7037 struct sigaction action, old_action;
7038 emacs_sigaction_init (&action, deliver_child_signal);
7039 block_child_signal ();
7040 sigaction (SIGCHLD, &action, &old_action);
7041 eassert (! (old_action.sa_flags & SA_SIGINFO));
7043 if (old_action.sa_handler != deliver_child_signal)
7044 lib_child_handler
7045 = (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7046 ? dummy_handler
7047 : old_action.sa_handler);
7048 unblock_child_signal ();
7052 /* This is not called "init_process" because that is the name of a
7053 Mach system call, so it would cause problems on Darwin systems. */
7054 void
7055 init_process_emacs (void)
7057 #ifdef subprocesses
7058 register int i;
7060 inhibit_sentinels = 0;
7062 #ifndef CANNOT_DUMP
7063 if (! noninteractive || initialized)
7064 #endif
7066 #if defined HAVE_GLIB && !defined WINDOWSNT
7067 /* Tickle glib's child-handling code. Ask glib to wait for Emacs itself;
7068 this should always fail, but is enough to initialize glib's
7069 private SIGCHLD handler, allowing catch_child_signal to copy
7070 it into lib_child_handler. */
7071 g_source_unref (g_child_watch_source_new (getpid ()));
7072 #endif
7073 catch_child_signal ();
7076 FD_ZERO (&input_wait_mask);
7077 FD_ZERO (&non_keyboard_wait_mask);
7078 FD_ZERO (&non_process_wait_mask);
7079 FD_ZERO (&write_mask);
7080 max_process_desc = 0;
7081 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7083 #ifdef NON_BLOCKING_CONNECT
7084 FD_ZERO (&connect_wait_mask);
7085 num_pending_connects = 0;
7086 #endif
7088 #ifdef ADAPTIVE_READ_BUFFERING
7089 process_output_delay_count = 0;
7090 process_output_skip = 0;
7091 #endif
7093 /* Don't do this, it caused infinite select loops. The display
7094 method should call add_keyboard_wait_descriptor on stdin if it
7095 needs that. */
7096 #if 0
7097 FD_SET (0, &input_wait_mask);
7098 #endif
7100 Vprocess_alist = Qnil;
7101 deleted_pid_list = Qnil;
7102 for (i = 0; i < MAXDESC; i++)
7104 chan_process[i] = Qnil;
7105 proc_buffered_char[i] = -1;
7107 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7108 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7109 #ifdef DATAGRAM_SOCKETS
7110 memset (datagram_address, 0, sizeof datagram_address);
7111 #endif
7114 Lisp_Object subfeatures = Qnil;
7115 const struct socket_options *sopt;
7117 #define ADD_SUBFEATURE(key, val) \
7118 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7120 #ifdef NON_BLOCKING_CONNECT
7121 ADD_SUBFEATURE (QCnowait, Qt);
7122 #endif
7123 #ifdef DATAGRAM_SOCKETS
7124 ADD_SUBFEATURE (QCtype, Qdatagram);
7125 #endif
7126 #ifdef HAVE_SEQPACKET
7127 ADD_SUBFEATURE (QCtype, Qseqpacket);
7128 #endif
7129 #ifdef HAVE_LOCAL_SOCKETS
7130 ADD_SUBFEATURE (QCfamily, Qlocal);
7131 #endif
7132 ADD_SUBFEATURE (QCfamily, Qipv4);
7133 #ifdef AF_INET6
7134 ADD_SUBFEATURE (QCfamily, Qipv6);
7135 #endif
7136 #ifdef HAVE_GETSOCKNAME
7137 ADD_SUBFEATURE (QCservice, Qt);
7138 #endif
7139 ADD_SUBFEATURE (QCserver, Qt);
7141 for (sopt = socket_options; sopt->name; sopt++)
7142 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7144 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7147 #if defined (DARWIN_OS)
7148 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7149 processes. As such, we only change the default value. */
7150 if (initialized)
7152 char const *release = (STRINGP (Voperating_system_release)
7153 ? SSDATA (Voperating_system_release)
7154 : 0);
7155 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7156 Vprocess_connection_type = Qnil;
7159 #endif
7160 #endif /* subprocesses */
7161 kbd_is_on_hold = 0;
7164 void
7165 syms_of_process (void)
7167 #ifdef subprocesses
7169 DEFSYM (Qprocessp, "processp");
7170 DEFSYM (Qrun, "run");
7171 DEFSYM (Qstop, "stop");
7172 DEFSYM (Qsignal, "signal");
7174 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7175 here again.
7177 Qexit = intern_c_string ("exit");
7178 staticpro (&Qexit); */
7180 DEFSYM (Qopen, "open");
7181 DEFSYM (Qclosed, "closed");
7182 DEFSYM (Qconnect, "connect");
7183 DEFSYM (Qfailed, "failed");
7184 DEFSYM (Qlisten, "listen");
7185 DEFSYM (Qlocal, "local");
7186 DEFSYM (Qipv4, "ipv4");
7187 #ifdef AF_INET6
7188 DEFSYM (Qipv6, "ipv6");
7189 #endif
7190 DEFSYM (Qdatagram, "datagram");
7191 DEFSYM (Qseqpacket, "seqpacket");
7193 DEFSYM (QCport, ":port");
7194 DEFSYM (QCspeed, ":speed");
7195 DEFSYM (QCprocess, ":process");
7197 DEFSYM (QCbytesize, ":bytesize");
7198 DEFSYM (QCstopbits, ":stopbits");
7199 DEFSYM (QCparity, ":parity");
7200 DEFSYM (Qodd, "odd");
7201 DEFSYM (Qeven, "even");
7202 DEFSYM (QCflowcontrol, ":flowcontrol");
7203 DEFSYM (Qhw, "hw");
7204 DEFSYM (Qsw, "sw");
7205 DEFSYM (QCsummary, ":summary");
7207 DEFSYM (Qreal, "real");
7208 DEFSYM (Qnetwork, "network");
7209 DEFSYM (Qserial, "serial");
7210 DEFSYM (QCbuffer, ":buffer");
7211 DEFSYM (QChost, ":host");
7212 DEFSYM (QCservice, ":service");
7213 DEFSYM (QClocal, ":local");
7214 DEFSYM (QCremote, ":remote");
7215 DEFSYM (QCcoding, ":coding");
7216 DEFSYM (QCserver, ":server");
7217 DEFSYM (QCnowait, ":nowait");
7218 DEFSYM (QCsentinel, ":sentinel");
7219 DEFSYM (QClog, ":log");
7220 DEFSYM (QCnoquery, ":noquery");
7221 DEFSYM (QCstop, ":stop");
7222 DEFSYM (QCoptions, ":options");
7223 DEFSYM (QCplist, ":plist");
7225 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7227 staticpro (&Vprocess_alist);
7228 staticpro (&deleted_pid_list);
7230 #endif /* subprocesses */
7232 DEFSYM (QCname, ":name");
7233 DEFSYM (QCtype, ":type");
7235 DEFSYM (Qeuid, "euid");
7236 DEFSYM (Qegid, "egid");
7237 DEFSYM (Quser, "user");
7238 DEFSYM (Qgroup, "group");
7239 DEFSYM (Qcomm, "comm");
7240 DEFSYM (Qstate, "state");
7241 DEFSYM (Qppid, "ppid");
7242 DEFSYM (Qpgrp, "pgrp");
7243 DEFSYM (Qsess, "sess");
7244 DEFSYM (Qttname, "ttname");
7245 DEFSYM (Qtpgid, "tpgid");
7246 DEFSYM (Qminflt, "minflt");
7247 DEFSYM (Qmajflt, "majflt");
7248 DEFSYM (Qcminflt, "cminflt");
7249 DEFSYM (Qcmajflt, "cmajflt");
7250 DEFSYM (Qutime, "utime");
7251 DEFSYM (Qstime, "stime");
7252 DEFSYM (Qtime, "time");
7253 DEFSYM (Qcutime, "cutime");
7254 DEFSYM (Qcstime, "cstime");
7255 DEFSYM (Qctime, "ctime");
7256 DEFSYM (Qinternal_default_process_sentinel,
7257 "internal-default-process-sentinel");
7258 DEFSYM (Qinternal_default_process_filter,
7259 "internal-default-process-filter");
7260 DEFSYM (Qpri, "pri");
7261 DEFSYM (Qnice, "nice");
7262 DEFSYM (Qthcount, "thcount");
7263 DEFSYM (Qstart, "start");
7264 DEFSYM (Qvsize, "vsize");
7265 DEFSYM (Qrss, "rss");
7266 DEFSYM (Qetime, "etime");
7267 DEFSYM (Qpcpu, "pcpu");
7268 DEFSYM (Qpmem, "pmem");
7269 DEFSYM (Qargs, "args");
7271 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7272 doc: /* Non-nil means delete processes immediately when they exit.
7273 A value of nil means don't delete them until `list-processes' is run. */);
7275 delete_exited_processes = 1;
7277 #ifdef subprocesses
7278 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7279 doc: /* Control type of device used to communicate with subprocesses.
7280 Values are nil to use a pipe, or t or `pty' to use a pty.
7281 The value has no effect if the system has no ptys or if all ptys are busy:
7282 then a pipe is used in any case.
7283 The value takes effect when `start-process' is called. */);
7284 Vprocess_connection_type = Qt;
7286 #ifdef ADAPTIVE_READ_BUFFERING
7287 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7288 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7289 On some systems, when Emacs reads the output from a subprocess, the output data
7290 is read in very small blocks, potentially resulting in very poor performance.
7291 This behavior can be remedied to some extent by setting this variable to a
7292 non-nil value, as it will automatically delay reading from such processes, to
7293 allow them to produce more output before Emacs tries to read it.
7294 If the value is t, the delay is reset after each write to the process; any other
7295 non-nil value means that the delay is not reset on write.
7296 The variable takes effect when `start-process' is called. */);
7297 Vprocess_adaptive_read_buffering = Qt;
7298 #endif
7300 defsubr (&Sprocessp);
7301 defsubr (&Sget_process);
7302 defsubr (&Sdelete_process);
7303 defsubr (&Sprocess_status);
7304 defsubr (&Sprocess_exit_status);
7305 defsubr (&Sprocess_id);
7306 defsubr (&Sprocess_name);
7307 defsubr (&Sprocess_tty_name);
7308 defsubr (&Sprocess_command);
7309 defsubr (&Sset_process_buffer);
7310 defsubr (&Sprocess_buffer);
7311 defsubr (&Sprocess_mark);
7312 defsubr (&Sset_process_filter);
7313 defsubr (&Sprocess_filter);
7314 defsubr (&Sset_process_sentinel);
7315 defsubr (&Sprocess_sentinel);
7316 defsubr (&Sset_process_window_size);
7317 defsubr (&Sset_process_inherit_coding_system_flag);
7318 defsubr (&Sset_process_query_on_exit_flag);
7319 defsubr (&Sprocess_query_on_exit_flag);
7320 defsubr (&Sprocess_contact);
7321 defsubr (&Sprocess_plist);
7322 defsubr (&Sset_process_plist);
7323 defsubr (&Sprocess_list);
7324 defsubr (&Sstart_process);
7325 defsubr (&Sserial_process_configure);
7326 defsubr (&Smake_serial_process);
7327 defsubr (&Sset_network_process_option);
7328 defsubr (&Smake_network_process);
7329 defsubr (&Sformat_network_address);
7330 #if defined (HAVE_NET_IF_H)
7331 #ifdef SIOCGIFCONF
7332 defsubr (&Snetwork_interface_list);
7333 #endif
7334 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
7335 defsubr (&Snetwork_interface_info);
7336 #endif
7337 #endif /* defined (HAVE_NET_IF_H) */
7338 #ifdef DATAGRAM_SOCKETS
7339 defsubr (&Sprocess_datagram_address);
7340 defsubr (&Sset_process_datagram_address);
7341 #endif
7342 defsubr (&Saccept_process_output);
7343 defsubr (&Sprocess_send_region);
7344 defsubr (&Sprocess_send_string);
7345 defsubr (&Sinterrupt_process);
7346 defsubr (&Skill_process);
7347 defsubr (&Squit_process);
7348 defsubr (&Sstop_process);
7349 defsubr (&Scontinue_process);
7350 defsubr (&Sprocess_running_child_p);
7351 defsubr (&Sprocess_send_eof);
7352 defsubr (&Ssignal_process);
7353 defsubr (&Swaiting_for_user_input_p);
7354 defsubr (&Sprocess_type);
7355 defsubr (&Sinternal_default_process_sentinel);
7356 defsubr (&Sinternal_default_process_filter);
7357 defsubr (&Sset_process_coding_system);
7358 defsubr (&Sprocess_coding_system);
7359 defsubr (&Sset_process_filter_multibyte);
7360 defsubr (&Sprocess_filter_multibyte_p);
7362 #endif /* subprocesses */
7364 defsubr (&Sget_buffer_process);
7365 defsubr (&Sprocess_inherit_coding_system_flag);
7366 defsubr (&Slist_system_processes);
7367 defsubr (&Sprocess_attributes);