lisp/strokes.el: Fix typos.
[emacs.git] / src / process.c
blob187627dd85ab725c9a85905f3009efefdc7d4b71
1 /* Asynchronous subprocess control for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2014
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
24 #include <stdio.h>
25 #include <errno.h>
26 #include <sys/types.h> /* Some typedefs are used in sys/file.h. */
27 #include <sys/file.h>
28 #include <sys/stat.h>
29 #include <unistd.h>
30 #include <fcntl.h>
32 #include "lisp.h"
34 /* Only MS-DOS does not define `subprocesses'. */
35 #ifdef subprocesses
37 #include <sys/socket.h>
38 #include <netdb.h>
39 #include <netinet/in.h>
40 #include <arpa/inet.h>
42 /* Are local (unix) sockets supported? */
43 #if defined (HAVE_SYS_UN_H)
44 #if !defined (AF_LOCAL) && defined (AF_UNIX)
45 #define AF_LOCAL AF_UNIX
46 #endif
47 #ifdef AF_LOCAL
48 #define HAVE_LOCAL_SOCKETS
49 #include <sys/un.h>
50 #endif
51 #endif
53 #include <sys/ioctl.h>
54 #if defined (HAVE_NET_IF_H)
55 #include <net/if.h>
56 #endif /* HAVE_NET_IF_H */
58 #if defined (HAVE_IFADDRS_H)
59 /* Must be after net/if.h */
60 #include <ifaddrs.h>
62 /* We only use structs from this header when we use getifaddrs. */
63 #if defined (HAVE_NET_IF_DL_H)
64 #include <net/if_dl.h>
65 #endif
67 #endif
69 #ifdef NEED_BSDTTY
70 #include <bsdtty.h>
71 #endif
73 #ifdef USG5_4
74 # include <sys/stream.h>
75 # include <sys/stropts.h>
76 #endif
78 #ifdef HAVE_RES_INIT
79 #include <arpa/nameser.h>
80 #include <resolv.h>
81 #endif
83 #ifdef HAVE_UTIL_H
84 #include <util.h>
85 #endif
87 #ifdef HAVE_PTY_H
88 #include <pty.h>
89 #endif
91 #include <c-ctype.h>
92 #include <sig2str.h>
93 #include <verify.h>
95 #endif /* subprocesses */
97 #include "systime.h"
98 #include "systty.h"
100 #include "window.h"
101 #include "character.h"
102 #include "buffer.h"
103 #include "coding.h"
104 #include "process.h"
105 #include "frame.h"
106 #include "termhooks.h"
107 #include "termopts.h"
108 #include "commands.h"
109 #include "keyboard.h"
110 #include "blockinput.h"
111 #include "dispextern.h"
112 #include "composite.h"
113 #include "atimer.h"
114 #include "sysselect.h"
115 #include "syssignal.h"
116 #include "syswait.h"
117 #ifdef HAVE_GNUTLS
118 #include "gnutls.h"
119 #endif
121 #ifdef HAVE_WINDOW_SYSTEM
122 #include TERM_HEADER
123 #endif /* HAVE_WINDOW_SYSTEM */
125 #ifdef HAVE_GLIB
126 #include "xgselect.h"
127 #ifndef WINDOWSNT
128 #include <glib.h>
129 #endif
130 #endif
132 #ifdef WINDOWSNT
133 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
134 struct timespec *, void *);
135 #endif
137 #ifndef SOCK_CLOEXEC
138 # define SOCK_CLOEXEC 0
139 #endif
141 #ifndef HAVE_ACCEPT4
143 /* Emulate GNU/Linux accept4 and socket well enough for this module. */
145 static int
146 close_on_exec (int fd)
148 if (0 <= fd)
149 fcntl (fd, F_SETFD, FD_CLOEXEC);
150 return fd;
153 static int
154 accept4 (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags)
156 return close_on_exec (accept (sockfd, addr, addrlen));
159 static int
160 process_socket (int domain, int type, int protocol)
162 return close_on_exec (socket (domain, type, protocol));
164 # undef socket
165 # define socket(domain, type, protocol) process_socket (domain, type, protocol)
166 #endif
168 /* Work around GCC 4.7.0 bug with strict overflow checking; see
169 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
170 These lines can be removed once the GCC bug is fixed. */
171 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
172 # pragma GCC diagnostic ignored "-Wstrict-overflow"
173 #endif
175 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
176 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
177 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
178 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
179 Lisp_Object QCname, QCtype;
181 /* True if keyboard input is on hold, zero otherwise. */
183 static bool kbd_is_on_hold;
185 /* Nonzero means don't run process sentinels. This is used
186 when exiting. */
187 bool inhibit_sentinels;
189 #ifdef subprocesses
191 Lisp_Object Qprocessp;
192 static Lisp_Object Qrun, Qstop, Qsignal;
193 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
194 Lisp_Object Qlocal;
195 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
196 static Lisp_Object Qreal, Qnetwork, Qserial;
197 #ifdef AF_INET6
198 static Lisp_Object Qipv6;
199 #endif
200 static Lisp_Object QCport, QCprocess;
201 Lisp_Object QCspeed;
202 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
203 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
204 static Lisp_Object QCbuffer, QChost, QCservice;
205 static Lisp_Object QClocal, QCremote, QCcoding;
206 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
207 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
208 static Lisp_Object Qlast_nonmenu_event;
209 static Lisp_Object Qinternal_default_process_sentinel;
210 static Lisp_Object Qinternal_default_process_filter;
212 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
213 #define NETCONN1_P(p) (EQ (p->type, Qnetwork))
214 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
215 #define SERIALCONN1_P(p) (EQ (p->type, Qserial))
217 /* Number of events of change of status of a process. */
218 static EMACS_INT process_tick;
219 /* Number of events for which the user or sentinel has been notified. */
220 static EMACS_INT update_tick;
222 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
224 /* Only W32 has this, it really means that select can't take write mask. */
225 #ifdef BROKEN_NON_BLOCKING_CONNECT
226 #undef NON_BLOCKING_CONNECT
227 #define SELECT_CANT_DO_WRITE_MASK
228 #else
229 #ifndef NON_BLOCKING_CONNECT
230 #ifdef HAVE_SELECT
231 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
232 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
233 #define NON_BLOCKING_CONNECT
234 #endif /* EWOULDBLOCK || EINPROGRESS */
235 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
236 #endif /* HAVE_SELECT */
237 #endif /* NON_BLOCKING_CONNECT */
238 #endif /* BROKEN_NON_BLOCKING_CONNECT */
240 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
241 this system. We need to read full packets, so we need a
242 "non-destructive" select. So we require either native select,
243 or emulation of select using FIONREAD. */
245 #ifndef BROKEN_DATAGRAM_SOCKETS
246 # if defined HAVE_SELECT || defined USABLE_FIONREAD
247 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
248 # define DATAGRAM_SOCKETS
249 # endif
250 # endif
251 #endif
253 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
254 # define HAVE_SEQPACKET
255 #endif
257 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
258 #define ADAPTIVE_READ_BUFFERING
259 #endif
261 #ifdef ADAPTIVE_READ_BUFFERING
262 #define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
263 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
264 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
266 /* Number of processes which have a non-zero read_output_delay,
267 and therefore might be delayed for adaptive read buffering. */
269 static int process_output_delay_count;
271 /* True if any process has non-nil read_output_skip. */
273 static bool process_output_skip;
275 #else
276 #define process_output_delay_count 0
277 #endif
279 static void create_process (Lisp_Object, char **, Lisp_Object);
280 #ifdef USABLE_SIGIO
281 static bool keyboard_bit_set (fd_set *);
282 #endif
283 static void deactivate_process (Lisp_Object);
284 static void status_notify (struct Lisp_Process *);
285 static int read_process_output (Lisp_Object, int);
286 static void handle_child_signal (int);
287 static void create_pty (Lisp_Object);
289 /* If we support a window system, turn on the code to poll periodically
290 to detect C-g. It isn't actually used when doing interrupt input. */
291 #ifdef HAVE_WINDOW_SYSTEM
292 #define POLL_FOR_INPUT
293 #endif
295 static Lisp_Object get_process (register Lisp_Object name);
296 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
298 /* Mask of bits indicating the descriptors that we wait for input on. */
300 static fd_set input_wait_mask;
302 /* Mask that excludes keyboard input descriptor(s). */
304 static fd_set non_keyboard_wait_mask;
306 /* Mask that excludes process input descriptor(s). */
308 static fd_set non_process_wait_mask;
310 /* Mask for selecting for write. */
312 static fd_set write_mask;
314 #ifdef NON_BLOCKING_CONNECT
315 /* Mask of bits indicating the descriptors that we wait for connect to
316 complete on. Once they complete, they are removed from this mask
317 and added to the input_wait_mask and non_keyboard_wait_mask. */
319 static fd_set connect_wait_mask;
321 /* Number of bits set in connect_wait_mask. */
322 static int num_pending_connects;
323 #endif /* NON_BLOCKING_CONNECT */
325 /* The largest descriptor currently in use for a process object; -1 if none. */
326 static int max_process_desc;
328 /* The largest descriptor currently in use for input; -1 if none. */
329 static int max_input_desc;
331 /* Indexed by descriptor, gives the process (if any) for that descriptor */
332 static Lisp_Object chan_process[FD_SETSIZE];
334 /* Alist of elements (NAME . PROCESS) */
335 static Lisp_Object Vprocess_alist;
337 /* Buffered-ahead input char from process, indexed by channel.
338 -1 means empty (no char is buffered).
339 Used on sys V where the only way to tell if there is any
340 output from the process is to read at least one char.
341 Always -1 on systems that support FIONREAD. */
343 static int proc_buffered_char[FD_SETSIZE];
345 /* Table of `struct coding-system' for each process. */
346 static struct coding_system *proc_decode_coding_system[FD_SETSIZE];
347 static struct coding_system *proc_encode_coding_system[FD_SETSIZE];
349 #ifdef DATAGRAM_SOCKETS
350 /* Table of `partner address' for datagram sockets. */
351 static struct sockaddr_and_len {
352 struct sockaddr *sa;
353 int len;
354 } datagram_address[FD_SETSIZE];
355 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
356 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
357 #else
358 #define DATAGRAM_CHAN_P(chan) (0)
359 #define DATAGRAM_CONN_P(proc) (0)
360 #endif
362 /* FOR_EACH_PROCESS (LIST_VAR, PROC_VAR) followed by a statement is
363 a `for' loop which iterates over processes from Vprocess_alist. */
365 #define FOR_EACH_PROCESS(list_var, proc_var) \
366 FOR_EACH_ALIST_VALUE (Vprocess_alist, list_var, proc_var)
368 /* These setters are used only in this file, so they can be private. */
369 static void
370 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
372 p->buffer = val;
374 static void
375 pset_command (struct Lisp_Process *p, Lisp_Object val)
377 p->command = val;
379 static void
380 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
382 p->decode_coding_system = val;
384 static void
385 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
387 p->decoding_buf = val;
389 static void
390 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
392 p->encode_coding_system = val;
394 static void
395 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
397 p->encoding_buf = val;
399 static void
400 pset_filter (struct Lisp_Process *p, Lisp_Object val)
402 p->filter = NILP (val) ? Qinternal_default_process_filter : val;
404 static void
405 pset_log (struct Lisp_Process *p, Lisp_Object val)
407 p->log = val;
409 static void
410 pset_mark (struct Lisp_Process *p, Lisp_Object val)
412 p->mark = val;
414 static void
415 pset_name (struct Lisp_Process *p, Lisp_Object val)
417 p->name = val;
419 static void
420 pset_plist (struct Lisp_Process *p, Lisp_Object val)
422 p->plist = val;
424 static void
425 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
427 p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
429 static void
430 pset_status (struct Lisp_Process *p, Lisp_Object val)
432 p->status = val;
434 static void
435 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
437 p->tty_name = val;
439 static void
440 pset_type (struct Lisp_Process *p, Lisp_Object val)
442 p->type = val;
444 static void
445 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
447 p->write_queue = val;
452 static struct fd_callback_data
454 fd_callback func;
455 void *data;
456 #define FOR_READ 1
457 #define FOR_WRITE 2
458 int condition; /* mask of the defines above. */
459 } fd_callback_info[FD_SETSIZE];
462 /* Add a file descriptor FD to be monitored for when read is possible.
463 When read is possible, call FUNC with argument DATA. */
465 void
466 add_read_fd (int fd, fd_callback func, void *data)
468 eassert (fd < FD_SETSIZE);
469 add_keyboard_wait_descriptor (fd);
471 fd_callback_info[fd].func = func;
472 fd_callback_info[fd].data = data;
473 fd_callback_info[fd].condition |= FOR_READ;
476 /* Stop monitoring file descriptor FD for when read is possible. */
478 void
479 delete_read_fd (int fd)
481 eassert (fd < FD_SETSIZE);
482 delete_keyboard_wait_descriptor (fd);
484 fd_callback_info[fd].condition &= ~FOR_READ;
485 if (fd_callback_info[fd].condition == 0)
487 fd_callback_info[fd].func = 0;
488 fd_callback_info[fd].data = 0;
492 /* Add a file descriptor FD to be monitored for when write is possible.
493 When write is possible, call FUNC with argument DATA. */
495 void
496 add_write_fd (int fd, fd_callback func, void *data)
498 eassert (fd < FD_SETSIZE);
499 FD_SET (fd, &write_mask);
500 if (fd > max_input_desc)
501 max_input_desc = fd;
503 fd_callback_info[fd].func = func;
504 fd_callback_info[fd].data = data;
505 fd_callback_info[fd].condition |= FOR_WRITE;
508 /* FD is no longer an input descriptor; update max_input_desc accordingly. */
510 static void
511 delete_input_desc (int fd)
513 if (fd == max_input_desc)
516 fd--;
517 while (0 <= fd && ! (FD_ISSET (fd, &input_wait_mask)
518 || FD_ISSET (fd, &write_mask)));
520 max_input_desc = fd;
524 /* Stop monitoring file descriptor FD for when write is possible. */
526 void
527 delete_write_fd (int fd)
529 eassert (fd < FD_SETSIZE);
530 FD_CLR (fd, &write_mask);
531 fd_callback_info[fd].condition &= ~FOR_WRITE;
532 if (fd_callback_info[fd].condition == 0)
534 fd_callback_info[fd].func = 0;
535 fd_callback_info[fd].data = 0;
536 delete_input_desc (fd);
541 /* Compute the Lisp form of the process status, p->status, from
542 the numeric status that was returned by `wait'. */
544 static Lisp_Object status_convert (int);
546 static void
547 update_status (struct Lisp_Process *p)
549 eassert (p->raw_status_new);
550 pset_status (p, status_convert (p->raw_status));
551 p->raw_status_new = 0;
554 /* Convert a process status word in Unix format to
555 the list that we use internally. */
557 static Lisp_Object
558 status_convert (int w)
560 if (WIFSTOPPED (w))
561 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
562 else if (WIFEXITED (w))
563 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
564 WCOREDUMP (w) ? Qt : Qnil));
565 else if (WIFSIGNALED (w))
566 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
567 WCOREDUMP (w) ? Qt : Qnil));
568 else
569 return Qrun;
572 /* Given a status-list, extract the three pieces of information
573 and store them individually through the three pointers. */
575 static void
576 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
578 Lisp_Object tem;
580 if (SYMBOLP (l))
582 *symbol = l;
583 *code = 0;
584 *coredump = 0;
586 else
588 *symbol = XCAR (l);
589 tem = XCDR (l);
590 *code = XFASTINT (XCAR (tem));
591 tem = XCDR (tem);
592 *coredump = !NILP (tem);
596 /* Return a string describing a process status list. */
598 static Lisp_Object
599 status_message (struct Lisp_Process *p)
601 Lisp_Object status = p->status;
602 Lisp_Object symbol;
603 int code;
604 bool coredump;
605 Lisp_Object string, string2;
607 decode_status (status, &symbol, &code, &coredump);
609 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
611 char const *signame;
612 synchronize_system_messages_locale ();
613 signame = strsignal (code);
614 if (signame == 0)
615 string = build_string ("unknown");
616 else
618 int c1, c2;
620 string = build_unibyte_string (signame);
621 if (! NILP (Vlocale_coding_system))
622 string = (code_convert_string_norecord
623 (string, Vlocale_coding_system, 0));
624 c1 = STRING_CHAR (SDATA (string));
625 c2 = downcase (c1);
626 if (c1 != c2)
627 Faset (string, make_number (0), make_number (c2));
629 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
630 return concat2 (string, string2);
632 else if (EQ (symbol, Qexit))
634 if (NETCONN1_P (p))
635 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
636 if (code == 0)
637 return build_string ("finished\n");
638 string = Fnumber_to_string (make_number (code));
639 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
640 return concat3 (build_string ("exited abnormally with code "),
641 string, string2);
643 else if (EQ (symbol, Qfailed))
645 string = Fnumber_to_string (make_number (code));
646 string2 = build_string ("\n");
647 return concat3 (build_string ("failed with code "),
648 string, string2);
650 else
651 return Fcopy_sequence (Fsymbol_name (symbol));
654 enum { PTY_NAME_SIZE = 24 };
656 /* Open an available pty, returning a file descriptor.
657 Store into PTY_NAME the file name of the terminal corresponding to the pty.
658 Return -1 on failure. */
660 static int
661 allocate_pty (char pty_name[PTY_NAME_SIZE])
663 #ifdef HAVE_PTYS
664 int fd;
666 #ifdef PTY_ITERATION
667 PTY_ITERATION
668 #else
669 register int c, i;
670 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
671 for (i = 0; i < 16; i++)
672 #endif
674 #ifdef PTY_NAME_SPRINTF
675 PTY_NAME_SPRINTF
676 #else
677 sprintf (pty_name, "/dev/pty%c%x", c, i);
678 #endif /* no PTY_NAME_SPRINTF */
680 #ifdef PTY_OPEN
681 PTY_OPEN;
682 #else /* no PTY_OPEN */
683 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
684 #endif /* no PTY_OPEN */
686 if (fd >= 0)
688 #ifdef PTY_OPEN
689 /* Set FD's close-on-exec flag. This is needed even if
690 PT_OPEN calls posix_openpt with O_CLOEXEC, since POSIX
691 doesn't require support for that combination.
692 Multithreaded platforms where posix_openpt ignores
693 O_CLOEXEC (or where PTY_OPEN doesn't call posix_openpt)
694 have a race condition between the PTY_OPEN and here. */
695 fcntl (fd, F_SETFD, FD_CLOEXEC);
696 #endif
697 /* check to make certain that both sides are available
698 this avoids a nasty yet stupid bug in rlogins */
699 #ifdef PTY_TTY_NAME_SPRINTF
700 PTY_TTY_NAME_SPRINTF
701 #else
702 sprintf (pty_name, "/dev/tty%c%x", c, i);
703 #endif /* no PTY_TTY_NAME_SPRINTF */
704 if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
706 emacs_close (fd);
707 # ifndef __sgi
708 continue;
709 # else
710 return -1;
711 # endif /* __sgi */
713 setup_pty (fd);
714 return fd;
717 #endif /* HAVE_PTYS */
718 return -1;
721 static Lisp_Object
722 make_process (Lisp_Object name)
724 register Lisp_Object val, tem, name1;
725 register struct Lisp_Process *p;
726 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
727 printmax_t i;
729 p = allocate_process ();
730 /* Initialize Lisp data. Note that allocate_process initializes all
731 Lisp data to nil, so do it only for slots which should not be nil. */
732 pset_status (p, Qrun);
733 pset_mark (p, Fmake_marker ());
735 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
736 non-Lisp data, so do it only for slots which should not be zero. */
737 p->infd = -1;
738 p->outfd = -1;
739 for (i = 0; i < PROCESS_OPEN_FDS; i++)
740 p->open_fd[i] = -1;
742 #ifdef HAVE_GNUTLS
743 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
744 #endif
746 /* If name is already in use, modify it until it is unused. */
748 name1 = name;
749 for (i = 1; ; i++)
751 tem = Fget_process (name1);
752 if (NILP (tem)) break;
753 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
755 name = name1;
756 pset_name (p, name);
757 pset_sentinel (p, Qinternal_default_process_sentinel);
758 pset_filter (p, Qinternal_default_process_filter);
759 XSETPROCESS (val, p);
760 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
761 return val;
764 static void
765 remove_process (register Lisp_Object proc)
767 register Lisp_Object pair;
769 pair = Frassq (proc, Vprocess_alist);
770 Vprocess_alist = Fdelq (pair, Vprocess_alist);
772 deactivate_process (proc);
776 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
777 doc: /* Return t if OBJECT is a process. */)
778 (Lisp_Object object)
780 return PROCESSP (object) ? Qt : Qnil;
783 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
784 doc: /* Return the process named NAME, or nil if there is none. */)
785 (register Lisp_Object name)
787 if (PROCESSP (name))
788 return name;
789 CHECK_STRING (name);
790 return Fcdr (Fassoc (name, Vprocess_alist));
793 /* This is how commands for the user decode process arguments. It
794 accepts a process, a process name, a buffer, a buffer name, or nil.
795 Buffers denote the first process in the buffer, and nil denotes the
796 current buffer. */
798 static Lisp_Object
799 get_process (register Lisp_Object name)
801 register Lisp_Object proc, obj;
802 if (STRINGP (name))
804 obj = Fget_process (name);
805 if (NILP (obj))
806 obj = Fget_buffer (name);
807 if (NILP (obj))
808 error ("Process %s does not exist", SDATA (name));
810 else if (NILP (name))
811 obj = Fcurrent_buffer ();
812 else
813 obj = name;
815 /* Now obj should be either a buffer object or a process object. */
816 if (BUFFERP (obj))
818 if (NILP (BVAR (XBUFFER (obj), name)))
819 error ("Attempt to get process for a dead buffer");
820 proc = Fget_buffer_process (obj);
821 if (NILP (proc))
822 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
824 else
826 CHECK_PROCESS (obj);
827 proc = obj;
829 return proc;
833 /* Fdelete_process promises to immediately forget about the process, but in
834 reality, Emacs needs to remember those processes until they have been
835 treated by the SIGCHLD handler and waitpid has been invoked on them;
836 otherwise they might fill up the kernel's process table.
838 Some processes created by call-process are also put onto this list.
840 Members of this list are (process-ID . filename) pairs. The
841 process-ID is a number; the filename, if a string, is a file that
842 needs to be removed after the process exits. */
843 static Lisp_Object deleted_pid_list;
845 void
846 record_deleted_pid (pid_t pid, Lisp_Object filename)
848 deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
849 /* GC treated elements set to nil. */
850 Fdelq (Qnil, deleted_pid_list));
854 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
855 doc: /* Delete PROCESS: kill it and forget about it immediately.
856 PROCESS may be a process, a buffer, the name of a process or buffer, or
857 nil, indicating the current buffer's process. */)
858 (register Lisp_Object process)
860 register struct Lisp_Process *p;
862 process = get_process (process);
863 p = XPROCESS (process);
865 p->raw_status_new = 0;
866 if (NETCONN1_P (p) || SERIALCONN1_P (p))
868 pset_status (p, list2 (Qexit, make_number (0)));
869 p->tick = ++process_tick;
870 status_notify (p);
871 redisplay_preserve_echo_area (13);
873 else
875 if (p->alive)
876 record_kill_process (p, Qnil);
878 if (p->infd >= 0)
880 /* Update P's status, since record_kill_process will make the
881 SIGCHLD handler update deleted_pid_list, not *P. */
882 Lisp_Object symbol;
883 if (p->raw_status_new)
884 update_status (p);
885 symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
886 if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
887 pset_status (p, list2 (Qsignal, make_number (SIGKILL)));
889 p->tick = ++process_tick;
890 status_notify (p);
891 redisplay_preserve_echo_area (13);
894 remove_process (process);
895 return Qnil;
898 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
899 doc: /* Return the status of PROCESS.
900 The returned value is one of the following symbols:
901 run -- for a process that is running.
902 stop -- for a process stopped but continuable.
903 exit -- for a process that has exited.
904 signal -- for a process that has got a fatal signal.
905 open -- for a network stream connection that is open.
906 listen -- for a network stream server that is listening.
907 closed -- for a network stream connection that is closed.
908 connect -- when waiting for a non-blocking connection to complete.
909 failed -- when a non-blocking connection has failed.
910 nil -- if arg is a process name and no such process exists.
911 PROCESS may be a process, a buffer, the name of a process, or
912 nil, indicating the current buffer's process. */)
913 (register Lisp_Object process)
915 register struct Lisp_Process *p;
916 register Lisp_Object status;
918 if (STRINGP (process))
919 process = Fget_process (process);
920 else
921 process = get_process (process);
923 if (NILP (process))
924 return process;
926 p = XPROCESS (process);
927 if (p->raw_status_new)
928 update_status (p);
929 status = p->status;
930 if (CONSP (status))
931 status = XCAR (status);
932 if (NETCONN1_P (p) || SERIALCONN1_P (p))
934 if (EQ (status, Qexit))
935 status = Qclosed;
936 else if (EQ (p->command, Qt))
937 status = Qstop;
938 else if (EQ (status, Qrun))
939 status = Qopen;
941 return status;
944 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
945 1, 1, 0,
946 doc: /* Return the exit status of PROCESS or the signal number that killed it.
947 If PROCESS has not yet exited or died, return 0. */)
948 (register Lisp_Object process)
950 CHECK_PROCESS (process);
951 if (XPROCESS (process)->raw_status_new)
952 update_status (XPROCESS (process));
953 if (CONSP (XPROCESS (process)->status))
954 return XCAR (XCDR (XPROCESS (process)->status));
955 return make_number (0);
958 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
959 doc: /* Return the process id of PROCESS.
960 This is the pid of the external process which PROCESS uses or talks to.
961 For a network connection, this value is nil. */)
962 (register Lisp_Object process)
964 pid_t pid;
966 CHECK_PROCESS (process);
967 pid = XPROCESS (process)->pid;
968 return (pid ? make_fixnum_or_float (pid) : Qnil);
971 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
972 doc: /* Return the name of PROCESS, as a string.
973 This is the name of the program invoked in PROCESS,
974 possibly modified to make it unique among process names. */)
975 (register Lisp_Object process)
977 CHECK_PROCESS (process);
978 return XPROCESS (process)->name;
981 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
982 doc: /* Return the command that was executed to start PROCESS.
983 This is a list of strings, the first string being the program executed
984 and the rest of the strings being the arguments given to it.
985 For a network or serial process, this is nil (process is running) or t
986 \(process is stopped). */)
987 (register Lisp_Object process)
989 CHECK_PROCESS (process);
990 return XPROCESS (process)->command;
993 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
994 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
995 This is the terminal that the process itself reads and writes on,
996 not the name of the pty that Emacs uses to talk with that terminal. */)
997 (register Lisp_Object process)
999 CHECK_PROCESS (process);
1000 return XPROCESS (process)->tty_name;
1003 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
1004 2, 2, 0,
1005 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
1006 Return BUFFER. */)
1007 (register Lisp_Object process, Lisp_Object buffer)
1009 struct Lisp_Process *p;
1011 CHECK_PROCESS (process);
1012 if (!NILP (buffer))
1013 CHECK_BUFFER (buffer);
1014 p = XPROCESS (process);
1015 pset_buffer (p, buffer);
1016 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1017 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
1018 setup_process_coding_systems (process);
1019 return buffer;
1022 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
1023 1, 1, 0,
1024 doc: /* Return the buffer PROCESS is associated with.
1025 The default process filter inserts output from PROCESS into this buffer. */)
1026 (register Lisp_Object process)
1028 CHECK_PROCESS (process);
1029 return XPROCESS (process)->buffer;
1032 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1033 1, 1, 0,
1034 doc: /* Return the marker for the end of the last output from PROCESS. */)
1035 (register Lisp_Object process)
1037 CHECK_PROCESS (process);
1038 return XPROCESS (process)->mark;
1041 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1042 2, 2, 0,
1043 doc: /* Give PROCESS the filter function FILTER; nil means default.
1044 A value of t means stop accepting output from the process.
1046 When a process has a non-default filter, its buffer is not used for output.
1047 Instead, each time it does output, the entire string of output is
1048 passed to the filter.
1050 The filter gets two arguments: the process and the string of output.
1051 The string argument is normally a multibyte string, except:
1052 - if the process's input coding system is no-conversion or raw-text,
1053 it is a unibyte string (the non-converted input), or else
1054 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1055 string (the result of converting the decoded input multibyte
1056 string to unibyte with `string-make-unibyte'). */)
1057 (register Lisp_Object process, Lisp_Object filter)
1059 struct Lisp_Process *p;
1061 CHECK_PROCESS (process);
1062 p = XPROCESS (process);
1064 /* Don't signal an error if the process's input file descriptor
1065 is closed. This could make debugging Lisp more difficult,
1066 for example when doing something like
1068 (setq process (start-process ...))
1069 (debug)
1070 (set-process-filter process ...) */
1072 if (NILP (filter))
1073 filter = Qinternal_default_process_filter;
1075 if (p->infd >= 0)
1077 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1079 FD_CLR (p->infd, &input_wait_mask);
1080 FD_CLR (p->infd, &non_keyboard_wait_mask);
1082 else if (EQ (p->filter, Qt)
1083 /* Network or serial process not stopped: */
1084 && !EQ (p->command, Qt))
1086 FD_SET (p->infd, &input_wait_mask);
1087 FD_SET (p->infd, &non_keyboard_wait_mask);
1091 pset_filter (p, filter);
1092 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1093 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1094 setup_process_coding_systems (process);
1095 return filter;
1098 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1099 1, 1, 0,
1100 doc: /* Return the filter function of PROCESS.
1101 See `set-process-filter' for more info on filter functions. */)
1102 (register Lisp_Object process)
1104 CHECK_PROCESS (process);
1105 return XPROCESS (process)->filter;
1108 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1109 2, 2, 0,
1110 doc: /* Give PROCESS the sentinel SENTINEL; nil for default.
1111 The sentinel is called as a function when the process changes state.
1112 It gets two arguments: the process, and a string describing the change. */)
1113 (register Lisp_Object process, Lisp_Object sentinel)
1115 struct Lisp_Process *p;
1117 CHECK_PROCESS (process);
1118 p = XPROCESS (process);
1120 if (NILP (sentinel))
1121 sentinel = Qinternal_default_process_sentinel;
1123 pset_sentinel (p, sentinel);
1124 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1125 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1126 return sentinel;
1129 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1130 1, 1, 0,
1131 doc: /* Return the sentinel of PROCESS.
1132 See `set-process-sentinel' for more info on sentinels. */)
1133 (register Lisp_Object process)
1135 CHECK_PROCESS (process);
1136 return XPROCESS (process)->sentinel;
1139 DEFUN ("set-process-window-size", Fset_process_window_size,
1140 Sset_process_window_size, 3, 3, 0,
1141 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1142 (Lisp_Object process, Lisp_Object height, Lisp_Object width)
1144 CHECK_PROCESS (process);
1146 /* All known platforms store window sizes as 'unsigned short'. */
1147 CHECK_RANGED_INTEGER (height, 0, USHRT_MAX);
1148 CHECK_RANGED_INTEGER (width, 0, USHRT_MAX);
1150 if (XPROCESS (process)->infd < 0
1151 || (set_window_size (XPROCESS (process)->infd,
1152 XINT (height), XINT (width))
1153 < 0))
1154 return Qnil;
1155 else
1156 return Qt;
1159 DEFUN ("set-process-inherit-coding-system-flag",
1160 Fset_process_inherit_coding_system_flag,
1161 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1162 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1163 If the second argument FLAG is non-nil, then the variable
1164 `buffer-file-coding-system' of the buffer associated with PROCESS
1165 will be bound to the value of the coding system used to decode
1166 the process output.
1168 This is useful when the coding system specified for the process buffer
1169 leaves either the character code conversion or the end-of-line conversion
1170 unspecified, or if the coding system used to decode the process output
1171 is more appropriate for saving the process buffer.
1173 Binding the variable `inherit-process-coding-system' to non-nil before
1174 starting the process is an alternative way of setting the inherit flag
1175 for the process which will run.
1177 This function returns FLAG. */)
1178 (register Lisp_Object process, Lisp_Object flag)
1180 CHECK_PROCESS (process);
1181 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1182 return flag;
1185 DEFUN ("set-process-query-on-exit-flag",
1186 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1187 2, 2, 0,
1188 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1189 If the second argument FLAG is non-nil, Emacs will query the user before
1190 exiting or killing a buffer if PROCESS is running. This function
1191 returns FLAG. */)
1192 (register Lisp_Object process, Lisp_Object flag)
1194 CHECK_PROCESS (process);
1195 XPROCESS (process)->kill_without_query = NILP (flag);
1196 return flag;
1199 DEFUN ("process-query-on-exit-flag",
1200 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1201 1, 1, 0,
1202 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1203 (register Lisp_Object process)
1205 CHECK_PROCESS (process);
1206 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1209 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1210 1, 2, 0,
1211 doc: /* Return the contact info of PROCESS; t for a real child.
1212 For a network or serial connection, the value depends on the optional
1213 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1214 SERVICE) for a network connection or (PORT SPEED) for a serial
1215 connection. If KEY is t, the complete contact information for the
1216 connection is returned, else the specific value for the keyword KEY is
1217 returned. See `make-network-process' or `make-serial-process' for a
1218 list of keywords. */)
1219 (register Lisp_Object process, Lisp_Object key)
1221 Lisp_Object contact;
1223 CHECK_PROCESS (process);
1224 contact = XPROCESS (process)->childp;
1226 #ifdef DATAGRAM_SOCKETS
1227 if (DATAGRAM_CONN_P (process)
1228 && (EQ (key, Qt) || EQ (key, QCremote)))
1229 contact = Fplist_put (contact, QCremote,
1230 Fprocess_datagram_address (process));
1231 #endif
1233 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1234 return contact;
1235 if (NILP (key) && NETCONN_P (process))
1236 return list2 (Fplist_get (contact, QChost),
1237 Fplist_get (contact, QCservice));
1238 if (NILP (key) && SERIALCONN_P (process))
1239 return list2 (Fplist_get (contact, QCport),
1240 Fplist_get (contact, QCspeed));
1241 return Fplist_get (contact, key);
1244 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1245 1, 1, 0,
1246 doc: /* Return the plist of PROCESS. */)
1247 (register Lisp_Object process)
1249 CHECK_PROCESS (process);
1250 return XPROCESS (process)->plist;
1253 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1254 2, 2, 0,
1255 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1256 (register Lisp_Object process, Lisp_Object plist)
1258 CHECK_PROCESS (process);
1259 CHECK_LIST (plist);
1261 pset_plist (XPROCESS (process), plist);
1262 return plist;
1265 #if 0 /* Turned off because we don't currently record this info
1266 in the process. Perhaps add it. */
1267 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1268 doc: /* Return the connection type of PROCESS.
1269 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1270 a socket connection. */)
1271 (Lisp_Object process)
1273 return XPROCESS (process)->type;
1275 #endif
1277 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1278 doc: /* Return the connection type of PROCESS.
1279 The value is either the symbol `real', `network', or `serial'.
1280 PROCESS may be a process, a buffer, the name of a process or buffer, or
1281 nil, indicating the current buffer's process. */)
1282 (Lisp_Object process)
1284 Lisp_Object proc;
1285 proc = get_process (process);
1286 return XPROCESS (proc)->type;
1289 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1290 1, 2, 0,
1291 doc: /* Convert network ADDRESS from internal format to a string.
1292 A 4 or 5 element vector represents an IPv4 address (with port number).
1293 An 8 or 9 element vector represents an IPv6 address (with port number).
1294 If optional second argument OMIT-PORT is non-nil, don't include a port
1295 number in the string, even when present in ADDRESS.
1296 Returns nil if format of ADDRESS is invalid. */)
1297 (Lisp_Object address, Lisp_Object omit_port)
1299 if (NILP (address))
1300 return Qnil;
1302 if (STRINGP (address)) /* AF_LOCAL */
1303 return address;
1305 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1307 register struct Lisp_Vector *p = XVECTOR (address);
1308 ptrdiff_t size = p->header.size;
1309 Lisp_Object args[10];
1310 int nargs, i;
1312 if (size == 4 || (size == 5 && !NILP (omit_port)))
1314 args[0] = build_string ("%d.%d.%d.%d");
1315 nargs = 4;
1317 else if (size == 5)
1319 args[0] = build_string ("%d.%d.%d.%d:%d");
1320 nargs = 5;
1322 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1324 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1325 nargs = 8;
1327 else if (size == 9)
1329 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1330 nargs = 9;
1332 else
1333 return Qnil;
1335 for (i = 0; i < nargs; i++)
1337 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1338 return Qnil;
1340 if (nargs <= 5 /* IPv4 */
1341 && i < 4 /* host, not port */
1342 && XINT (p->contents[i]) > 255)
1343 return Qnil;
1345 args[i+1] = p->contents[i];
1348 return Fformat (nargs+1, args);
1351 if (CONSP (address))
1353 Lisp_Object args[2];
1354 args[0] = build_string ("<Family %d>");
1355 args[1] = Fcar (address);
1356 return Fformat (2, args);
1359 return Qnil;
1362 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1363 doc: /* Return a list of all processes that are Emacs sub-processes. */)
1364 (void)
1366 return Fmapcar (Qcdr, Vprocess_alist);
1369 /* Starting asynchronous inferior processes. */
1371 static void start_process_unwind (Lisp_Object proc);
1373 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1374 doc: /* Start a program in a subprocess. Return the process object for it.
1375 NAME is name for process. It is modified if necessary to make it unique.
1376 BUFFER is the buffer (or buffer name) to associate with the process.
1378 Process output (both standard output and standard error streams) goes
1379 at end of BUFFER, unless you specify an output stream or filter
1380 function to handle the output. BUFFER may also be nil, meaning that
1381 this process is not associated with any buffer.
1383 PROGRAM is the program file name. It is searched for in `exec-path'
1384 (which see). If nil, just associate a pty with the buffer. Remaining
1385 arguments are strings to give program as arguments.
1387 If you want to separate standard output from standard error, invoke
1388 the command through a shell and redirect one of them using the shell
1389 syntax.
1391 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1392 (ptrdiff_t nargs, Lisp_Object *args)
1394 Lisp_Object buffer, name, program, proc, current_dir, tem;
1395 register unsigned char **new_argv;
1396 ptrdiff_t i;
1397 ptrdiff_t count = SPECPDL_INDEX ();
1399 buffer = args[1];
1400 if (!NILP (buffer))
1401 buffer = Fget_buffer_create (buffer);
1403 /* Make sure that the child will be able to chdir to the current
1404 buffer's current directory, or its unhandled equivalent. We
1405 can't just have the child check for an error when it does the
1406 chdir, since it's in a vfork.
1408 We have to GCPRO around this because Fexpand_file_name and
1409 Funhandled_file_name_directory might call a file name handling
1410 function. The argument list is protected by the caller, so all
1411 we really have to worry about is buffer. */
1413 struct gcpro gcpro1;
1414 GCPRO1 (buffer);
1415 current_dir = encode_current_directory ();
1416 UNGCPRO;
1419 name = args[0];
1420 CHECK_STRING (name);
1422 program = args[2];
1424 if (!NILP (program))
1425 CHECK_STRING (program);
1427 proc = make_process (name);
1428 /* If an error occurs and we can't start the process, we want to
1429 remove it from the process list. This means that each error
1430 check in create_process doesn't need to call remove_process
1431 itself; it's all taken care of here. */
1432 record_unwind_protect (start_process_unwind, proc);
1434 pset_childp (XPROCESS (proc), Qt);
1435 pset_plist (XPROCESS (proc), Qnil);
1436 pset_type (XPROCESS (proc), Qreal);
1437 pset_buffer (XPROCESS (proc), buffer);
1438 pset_sentinel (XPROCESS (proc), Qinternal_default_process_sentinel);
1439 pset_filter (XPROCESS (proc), Qinternal_default_process_filter);
1440 pset_command (XPROCESS (proc), Flist (nargs - 2, args + 2));
1442 #ifdef HAVE_GNUTLS
1443 /* AKA GNUTLS_INITSTAGE(proc). */
1444 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1445 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1446 #endif
1448 #ifdef ADAPTIVE_READ_BUFFERING
1449 XPROCESS (proc)->adaptive_read_buffering
1450 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1451 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1452 #endif
1454 /* Make the process marker point into the process buffer (if any). */
1455 if (BUFFERP (buffer))
1456 set_marker_both (XPROCESS (proc)->mark, buffer,
1457 BUF_ZV (XBUFFER (buffer)),
1458 BUF_ZV_BYTE (XBUFFER (buffer)));
1461 /* Decide coding systems for communicating with the process. Here
1462 we don't setup the structure coding_system nor pay attention to
1463 unibyte mode. They are done in create_process. */
1465 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1466 Lisp_Object coding_systems = Qt;
1467 Lisp_Object val, *args2;
1468 struct gcpro gcpro1, gcpro2;
1470 val = Vcoding_system_for_read;
1471 if (NILP (val))
1473 args2 = alloca ((nargs + 1) * sizeof *args2);
1474 args2[0] = Qstart_process;
1475 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1476 GCPRO2 (proc, current_dir);
1477 if (!NILP (program))
1478 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1479 UNGCPRO;
1480 if (CONSP (coding_systems))
1481 val = XCAR (coding_systems);
1482 else if (CONSP (Vdefault_process_coding_system))
1483 val = XCAR (Vdefault_process_coding_system);
1485 pset_decode_coding_system (XPROCESS (proc), val);
1487 val = Vcoding_system_for_write;
1488 if (NILP (val))
1490 if (EQ (coding_systems, Qt))
1492 args2 = alloca ((nargs + 1) * sizeof *args2);
1493 args2[0] = Qstart_process;
1494 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1495 GCPRO2 (proc, current_dir);
1496 if (!NILP (program))
1497 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1498 UNGCPRO;
1500 if (CONSP (coding_systems))
1501 val = XCDR (coding_systems);
1502 else if (CONSP (Vdefault_process_coding_system))
1503 val = XCDR (Vdefault_process_coding_system);
1505 pset_encode_coding_system (XPROCESS (proc), val);
1506 /* Note: At this moment, the above coding system may leave
1507 text-conversion or eol-conversion unspecified. They will be
1508 decided after we read output from the process and decode it by
1509 some coding system, or just before we actually send a text to
1510 the process. */
1514 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1515 XPROCESS (proc)->decoding_carryover = 0;
1516 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1518 XPROCESS (proc)->inherit_coding_system_flag
1519 = !(NILP (buffer) || !inherit_process_coding_system);
1521 if (!NILP (program))
1523 /* If program file name is not absolute, search our path for it.
1524 Put the name we will really use in TEM. */
1525 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1526 && !(SCHARS (program) > 1
1527 && IS_DEVICE_SEP (SREF (program, 1))))
1529 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1531 tem = Qnil;
1532 GCPRO4 (name, program, buffer, current_dir);
1533 openp (Vexec_path, program, Vexec_suffixes, &tem,
1534 make_number (X_OK), false);
1535 UNGCPRO;
1536 if (NILP (tem))
1537 report_file_error ("Searching for program", program);
1538 tem = Fexpand_file_name (tem, Qnil);
1540 else
1542 if (!NILP (Ffile_directory_p (program)))
1543 error ("Specified program for new process is a directory");
1544 tem = program;
1547 /* If program file name starts with /: for quoting a magic name,
1548 discard that. */
1549 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1550 && SREF (tem, 1) == ':')
1551 tem = Fsubstring (tem, make_number (2), Qnil);
1554 Lisp_Object arg_encoding = Qnil;
1555 struct gcpro gcpro1;
1556 GCPRO1 (tem);
1558 /* Encode the file name and put it in NEW_ARGV.
1559 That's where the child will use it to execute the program. */
1560 tem = list1 (ENCODE_FILE (tem));
1562 /* Here we encode arguments by the coding system used for sending
1563 data to the process. We don't support using different coding
1564 systems for encoding arguments and for encoding data sent to the
1565 process. */
1567 for (i = 3; i < nargs; i++)
1569 tem = Fcons (args[i], tem);
1570 CHECK_STRING (XCAR (tem));
1571 if (STRING_MULTIBYTE (XCAR (tem)))
1573 if (NILP (arg_encoding))
1574 arg_encoding = (complement_process_encoding_system
1575 (XPROCESS (proc)->encode_coding_system));
1576 XSETCAR (tem,
1577 code_convert_string_norecord
1578 (XCAR (tem), arg_encoding, 1));
1582 UNGCPRO;
1585 /* Now that everything is encoded we can collect the strings into
1586 NEW_ARGV. */
1587 new_argv = alloca ((nargs - 1) * sizeof *new_argv);
1588 new_argv[nargs - 2] = 0;
1590 for (i = nargs - 2; i-- != 0; )
1592 new_argv[i] = SDATA (XCAR (tem));
1593 tem = XCDR (tem);
1596 create_process (proc, (char **) new_argv, current_dir);
1598 else
1599 create_pty (proc);
1601 return unbind_to (count, proc);
1604 /* This function is the unwind_protect form for Fstart_process. If
1605 PROC doesn't have its pid set, then we know someone has signaled
1606 an error and the process wasn't started successfully, so we should
1607 remove it from the process list. */
1608 static void
1609 start_process_unwind (Lisp_Object proc)
1611 if (!PROCESSP (proc))
1612 emacs_abort ();
1614 /* Was PROC started successfully?
1615 -2 is used for a pty with no process, eg for gdb. */
1616 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1617 remove_process (proc);
1620 /* If *FD_ADDR is nonnegative, close it, and mark it as closed. */
1622 static void
1623 close_process_fd (int *fd_addr)
1625 int fd = *fd_addr;
1626 if (0 <= fd)
1628 *fd_addr = -1;
1629 emacs_close (fd);
1633 /* Indexes of file descriptors in open_fds. */
1634 enum
1636 /* The pipe from Emacs to its subprocess. */
1637 SUBPROCESS_STDIN,
1638 WRITE_TO_SUBPROCESS,
1640 /* The main pipe from the subprocess to Emacs. */
1641 READ_FROM_SUBPROCESS,
1642 SUBPROCESS_STDOUT,
1644 /* The pipe from the subprocess to Emacs that is closed when the
1645 subprocess execs. */
1646 READ_FROM_EXEC_MONITOR,
1647 EXEC_MONITOR_OUTPUT
1650 verify (PROCESS_OPEN_FDS == EXEC_MONITOR_OUTPUT + 1);
1652 static void
1653 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1655 struct Lisp_Process *p = XPROCESS (process);
1656 int inchannel, outchannel;
1657 pid_t pid;
1658 int vfork_errno;
1659 int forkin, forkout;
1660 bool pty_flag = 0;
1661 char pty_name[PTY_NAME_SIZE];
1662 Lisp_Object lisp_pty_name = Qnil;
1664 inchannel = outchannel = -1;
1666 if (!NILP (Vprocess_connection_type))
1667 outchannel = inchannel = allocate_pty (pty_name);
1669 if (inchannel >= 0)
1671 p->open_fd[READ_FROM_SUBPROCESS] = inchannel;
1672 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1673 /* On most USG systems it does not work to open the pty's tty here,
1674 then close it and reopen it in the child. */
1675 /* Don't let this terminal become our controlling terminal
1676 (in case we don't have one). */
1677 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1678 if (forkin < 0)
1679 report_file_error ("Opening pty", Qnil);
1680 p->open_fd[SUBPROCESS_STDIN] = forkin;
1681 #else
1682 forkin = forkout = -1;
1683 #endif /* not USG, or USG_SUBTTY_WORKS */
1684 pty_flag = 1;
1685 lisp_pty_name = build_string (pty_name);
1687 else
1689 if (emacs_pipe (p->open_fd + SUBPROCESS_STDIN) != 0
1690 || emacs_pipe (p->open_fd + READ_FROM_SUBPROCESS) != 0)
1691 report_file_error ("Creating pipe", Qnil);
1692 forkin = p->open_fd[SUBPROCESS_STDIN];
1693 outchannel = p->open_fd[WRITE_TO_SUBPROCESS];
1694 inchannel = p->open_fd[READ_FROM_SUBPROCESS];
1695 forkout = p->open_fd[SUBPROCESS_STDOUT];
1698 #ifndef WINDOWSNT
1699 if (emacs_pipe (p->open_fd + READ_FROM_EXEC_MONITOR) != 0)
1700 report_file_error ("Creating pipe", Qnil);
1701 #endif
1703 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1704 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1706 /* Record this as an active process, with its channels. */
1707 chan_process[inchannel] = process;
1708 p->infd = inchannel;
1709 p->outfd = outchannel;
1711 /* Previously we recorded the tty descriptor used in the subprocess.
1712 It was only used for getting the foreground tty process, so now
1713 we just reopen the device (see emacs_get_tty_pgrp) as this is
1714 more portable (see USG_SUBTTY_WORKS above). */
1716 p->pty_flag = pty_flag;
1717 pset_status (p, Qrun);
1719 FD_SET (inchannel, &input_wait_mask);
1720 FD_SET (inchannel, &non_keyboard_wait_mask);
1721 if (inchannel > max_process_desc)
1722 max_process_desc = inchannel;
1724 /* This may signal an error. */
1725 setup_process_coding_systems (process);
1727 block_input ();
1728 block_child_signal ();
1730 #ifndef WINDOWSNT
1731 /* vfork, and prevent local vars from being clobbered by the vfork. */
1733 Lisp_Object volatile current_dir_volatile = current_dir;
1734 Lisp_Object volatile lisp_pty_name_volatile = lisp_pty_name;
1735 char **volatile new_argv_volatile = new_argv;
1736 int volatile forkin_volatile = forkin;
1737 int volatile forkout_volatile = forkout;
1738 struct Lisp_Process *p_volatile = p;
1740 pid = vfork ();
1742 current_dir = current_dir_volatile;
1743 lisp_pty_name = lisp_pty_name_volatile;
1744 new_argv = new_argv_volatile;
1745 forkin = forkin_volatile;
1746 forkout = forkout_volatile;
1747 p = p_volatile;
1749 pty_flag = p->pty_flag;
1752 if (pid == 0)
1753 #endif /* not WINDOWSNT */
1755 int xforkin = forkin;
1756 int xforkout = forkout;
1758 /* Make the pty be the controlling terminal of the process. */
1759 #ifdef HAVE_PTYS
1760 /* First, disconnect its current controlling terminal. */
1761 /* We tried doing setsid only if pty_flag, but it caused
1762 process_set_signal to fail on SGI when using a pipe. */
1763 setsid ();
1764 /* Make the pty's terminal the controlling terminal. */
1765 if (pty_flag && xforkin >= 0)
1767 #ifdef TIOCSCTTY
1768 /* We ignore the return value
1769 because faith@cs.unc.edu says that is necessary on Linux. */
1770 ioctl (xforkin, TIOCSCTTY, 0);
1771 #endif
1773 #if defined (LDISC1)
1774 if (pty_flag && xforkin >= 0)
1776 struct termios t;
1777 tcgetattr (xforkin, &t);
1778 t.c_lflag = LDISC1;
1779 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1780 emacs_perror ("create_process/tcsetattr LDISC1");
1782 #else
1783 #if defined (NTTYDISC) && defined (TIOCSETD)
1784 if (pty_flag && xforkin >= 0)
1786 /* Use new line discipline. */
1787 int ldisc = NTTYDISC;
1788 ioctl (xforkin, TIOCSETD, &ldisc);
1790 #endif
1791 #endif
1792 #ifdef TIOCNOTTY
1793 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1794 can do TIOCSPGRP only to the process's controlling tty. */
1795 if (pty_flag)
1797 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1798 I can't test it since I don't have 4.3. */
1799 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1800 if (j >= 0)
1802 ioctl (j, TIOCNOTTY, 0);
1803 emacs_close (j);
1806 #endif /* TIOCNOTTY */
1808 #if !defined (DONT_REOPEN_PTY)
1809 /*** There is a suggestion that this ought to be a
1810 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
1811 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1812 that system does seem to need this code, even though
1813 both TIOCSCTTY is defined. */
1814 /* Now close the pty (if we had it open) and reopen it.
1815 This makes the pty the controlling terminal of the subprocess. */
1816 if (pty_flag)
1819 /* I wonder if emacs_close (emacs_open (SSDATA (lisp_pty_name), ...))
1820 would work? */
1821 if (xforkin >= 0)
1822 emacs_close (xforkin);
1823 xforkout = xforkin = emacs_open (SSDATA (lisp_pty_name), O_RDWR, 0);
1825 if (xforkin < 0)
1827 emacs_perror (SSDATA (lisp_pty_name));
1828 _exit (EXIT_CANCELED);
1832 #endif /* not DONT_REOPEN_PTY */
1834 #ifdef SETUP_SLAVE_PTY
1835 if (pty_flag)
1837 SETUP_SLAVE_PTY;
1839 #endif /* SETUP_SLAVE_PTY */
1840 #endif /* HAVE_PTYS */
1842 signal (SIGINT, SIG_DFL);
1843 signal (SIGQUIT, SIG_DFL);
1844 #ifdef SIGPROF
1845 signal (SIGPROF, SIG_DFL);
1846 #endif
1848 /* Emacs ignores SIGPIPE, but the child should not. */
1849 signal (SIGPIPE, SIG_DFL);
1851 /* Stop blocking SIGCHLD in the child. */
1852 unblock_child_signal ();
1854 if (pty_flag)
1855 child_setup_tty (xforkout);
1856 #ifdef WINDOWSNT
1857 pid = child_setup (xforkin, xforkout, xforkout, new_argv, 1, current_dir);
1858 #else /* not WINDOWSNT */
1859 child_setup (xforkin, xforkout, xforkout, new_argv, 1, current_dir);
1860 #endif /* not WINDOWSNT */
1863 /* Back in the parent process. */
1865 vfork_errno = errno;
1866 p->pid = pid;
1867 if (pid >= 0)
1868 p->alive = 1;
1870 /* Stop blocking in the parent. */
1871 unblock_child_signal ();
1872 unblock_input ();
1874 if (pid < 0)
1875 report_file_errno ("Doing vfork", Qnil, vfork_errno);
1876 else
1878 /* vfork succeeded. */
1880 /* Close the pipe ends that the child uses, or the child's pty. */
1881 close_process_fd (&p->open_fd[SUBPROCESS_STDIN]);
1882 close_process_fd (&p->open_fd[SUBPROCESS_STDOUT]);
1884 #ifdef WINDOWSNT
1885 register_child (pid, inchannel);
1886 #endif /* WINDOWSNT */
1888 pset_tty_name (p, lisp_pty_name);
1890 #ifndef WINDOWSNT
1891 /* Wait for child_setup to complete in case that vfork is
1892 actually defined as fork. The descriptor
1893 XPROCESS (proc)->open_fd[EXEC_MONITOR_OUTPUT]
1894 of a pipe is closed at the child side either by close-on-exec
1895 on successful execve or the _exit call in child_setup. */
1897 char dummy;
1899 close_process_fd (&p->open_fd[EXEC_MONITOR_OUTPUT]);
1900 emacs_read (p->open_fd[READ_FROM_EXEC_MONITOR], &dummy, 1);
1901 close_process_fd (&p->open_fd[READ_FROM_EXEC_MONITOR]);
1903 #endif
1907 static void
1908 create_pty (Lisp_Object process)
1910 struct Lisp_Process *p = XPROCESS (process);
1911 char pty_name[PTY_NAME_SIZE];
1912 int pty_fd = NILP (Vprocess_connection_type) ? -1 : allocate_pty (pty_name);
1914 if (pty_fd >= 0)
1916 p->open_fd[SUBPROCESS_STDIN] = pty_fd;
1917 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1918 /* On most USG systems it does not work to open the pty's tty here,
1919 then close it and reopen it in the child. */
1920 /* Don't let this terminal become our controlling terminal
1921 (in case we don't have one). */
1922 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1923 if (forkout < 0)
1924 report_file_error ("Opening pty", Qnil);
1925 p->open_fd[WRITE_TO_SUBPROCESS] = forkout;
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 */
1934 fcntl (pty_fd, F_SETFL, O_NONBLOCK);
1936 /* Record this as an active process, with its channels.
1937 As a result, child_setup will close Emacs's side of the pipes. */
1938 chan_process[pty_fd] = process;
1939 p->infd = pty_fd;
1940 p->outfd = pty_fd;
1942 /* Previously we recorded the tty descriptor used in the subprocess.
1943 It was only used for getting the foreground tty process, so now
1944 we just reopen the device (see emacs_get_tty_pgrp) as this is
1945 more portable (see USG_SUBTTY_WORKS above). */
1947 p->pty_flag = 1;
1948 pset_status (p, Qrun);
1949 setup_process_coding_systems (process);
1951 FD_SET (pty_fd, &input_wait_mask);
1952 FD_SET (pty_fd, &non_keyboard_wait_mask);
1953 if (pty_fd > max_process_desc)
1954 max_process_desc = pty_fd;
1956 pset_tty_name (p, build_string (pty_name));
1959 p->pid = -2;
1963 /* Convert an internal struct sockaddr to a lisp object (vector or string).
1964 The address family of sa is not included in the result. */
1966 #ifndef WINDOWSNT
1967 static
1968 #endif
1969 Lisp_Object
1970 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
1972 Lisp_Object address;
1973 int i;
1974 unsigned char *cp;
1975 register struct Lisp_Vector *p;
1977 /* Workaround for a bug in getsockname on BSD: Names bound to
1978 sockets in the UNIX domain are inaccessible; getsockname returns
1979 a zero length name. */
1980 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
1981 return empty_unibyte_string;
1983 switch (sa->sa_family)
1985 case AF_INET:
1987 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
1988 len = sizeof (sin->sin_addr) + 1;
1989 address = Fmake_vector (make_number (len), Qnil);
1990 p = XVECTOR (address);
1991 p->contents[--len] = make_number (ntohs (sin->sin_port));
1992 cp = (unsigned char *) &sin->sin_addr;
1993 break;
1995 #ifdef AF_INET6
1996 case AF_INET6:
1998 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
1999 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
2000 len = sizeof (sin6->sin6_addr)/2 + 1;
2001 address = Fmake_vector (make_number (len), Qnil);
2002 p = XVECTOR (address);
2003 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2004 for (i = 0; i < len; i++)
2005 p->contents[i] = make_number (ntohs (ip6[i]));
2006 return address;
2008 #endif
2009 #ifdef HAVE_LOCAL_SOCKETS
2010 case AF_LOCAL:
2012 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2013 for (i = 0; i < sizeof (sockun->sun_path); i++)
2014 if (sockun->sun_path[i] == 0)
2015 break;
2016 return make_unibyte_string (sockun->sun_path, i);
2018 #endif
2019 default:
2020 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2021 address = Fcons (make_number (sa->sa_family),
2022 Fmake_vector (make_number (len), Qnil));
2023 p = XVECTOR (XCDR (address));
2024 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2025 break;
2028 i = 0;
2029 while (i < len)
2030 p->contents[i++] = make_number (*cp++);
2032 return address;
2036 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2038 static int
2039 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2041 register struct Lisp_Vector *p;
2043 if (VECTORP (address))
2045 p = XVECTOR (address);
2046 if (p->header.size == 5)
2048 *familyp = AF_INET;
2049 return sizeof (struct sockaddr_in);
2051 #ifdef AF_INET6
2052 else if (p->header.size == 9)
2054 *familyp = AF_INET6;
2055 return sizeof (struct sockaddr_in6);
2057 #endif
2059 #ifdef HAVE_LOCAL_SOCKETS
2060 else if (STRINGP (address))
2062 *familyp = AF_LOCAL;
2063 return sizeof (struct sockaddr_un);
2065 #endif
2066 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2067 && VECTORP (XCDR (address)))
2069 struct sockaddr *sa;
2070 *familyp = XINT (XCAR (address));
2071 p = XVECTOR (XCDR (address));
2072 return p->header.size + sizeof (sa->sa_family);
2074 return 0;
2077 /* Convert an address object (vector or string) to an internal sockaddr.
2079 The address format has been basically validated by
2080 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2081 it could have come from user data. So if FAMILY is not valid,
2082 we return after zeroing *SA. */
2084 static void
2085 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2087 register struct Lisp_Vector *p;
2088 register unsigned char *cp = NULL;
2089 register int i;
2090 EMACS_INT hostport;
2092 memset (sa, 0, len);
2094 if (VECTORP (address))
2096 p = XVECTOR (address);
2097 if (family == AF_INET)
2099 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2100 len = sizeof (sin->sin_addr) + 1;
2101 hostport = XINT (p->contents[--len]);
2102 sin->sin_port = htons (hostport);
2103 cp = (unsigned char *)&sin->sin_addr;
2104 sa->sa_family = family;
2106 #ifdef AF_INET6
2107 else if (family == AF_INET6)
2109 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2110 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2111 len = sizeof (sin6->sin6_addr) + 1;
2112 hostport = XINT (p->contents[--len]);
2113 sin6->sin6_port = htons (hostport);
2114 for (i = 0; i < len; i++)
2115 if (INTEGERP (p->contents[i]))
2117 int j = XFASTINT (p->contents[i]) & 0xffff;
2118 ip6[i] = ntohs (j);
2120 sa->sa_family = family;
2121 return;
2123 #endif
2124 else
2125 return;
2127 else if (STRINGP (address))
2129 #ifdef HAVE_LOCAL_SOCKETS
2130 if (family == AF_LOCAL)
2132 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2133 cp = SDATA (address);
2134 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2135 sockun->sun_path[i] = *cp++;
2136 sa->sa_family = family;
2138 #endif
2139 return;
2141 else
2143 p = XVECTOR (XCDR (address));
2144 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2147 for (i = 0; i < len; i++)
2148 if (INTEGERP (p->contents[i]))
2149 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2152 #ifdef DATAGRAM_SOCKETS
2153 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2154 1, 1, 0,
2155 doc: /* Get the current datagram address associated with PROCESS. */)
2156 (Lisp_Object process)
2158 int channel;
2160 CHECK_PROCESS (process);
2162 if (!DATAGRAM_CONN_P (process))
2163 return Qnil;
2165 channel = XPROCESS (process)->infd;
2166 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2167 datagram_address[channel].len);
2170 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2171 2, 2, 0,
2172 doc: /* Set the datagram address for PROCESS to ADDRESS.
2173 Returns nil upon error setting address, ADDRESS otherwise. */)
2174 (Lisp_Object process, Lisp_Object address)
2176 int channel;
2177 int family, len;
2179 CHECK_PROCESS (process);
2181 if (!DATAGRAM_CONN_P (process))
2182 return Qnil;
2184 channel = XPROCESS (process)->infd;
2186 len = get_lisp_to_sockaddr_size (address, &family);
2187 if (len == 0 || datagram_address[channel].len != len)
2188 return Qnil;
2189 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2190 return address;
2192 #endif
2195 static const struct socket_options {
2196 /* The name of this option. Should be lowercase version of option
2197 name without SO_ prefix. */
2198 const char *name;
2199 /* Option level SOL_... */
2200 int optlevel;
2201 /* Option number SO_... */
2202 int optnum;
2203 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2204 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2205 } socket_options[] =
2207 #ifdef SO_BINDTODEVICE
2208 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2209 #endif
2210 #ifdef SO_BROADCAST
2211 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2212 #endif
2213 #ifdef SO_DONTROUTE
2214 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2215 #endif
2216 #ifdef SO_KEEPALIVE
2217 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2218 #endif
2219 #ifdef SO_LINGER
2220 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2221 #endif
2222 #ifdef SO_OOBINLINE
2223 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2224 #endif
2225 #ifdef SO_PRIORITY
2226 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2227 #endif
2228 #ifdef SO_REUSEADDR
2229 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2230 #endif
2231 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2234 /* Set option OPT to value VAL on socket S.
2236 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2237 Signals an error if setting a known option fails.
2240 static int
2241 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2243 char *name;
2244 const struct socket_options *sopt;
2245 int ret = 0;
2247 CHECK_SYMBOL (opt);
2249 name = SSDATA (SYMBOL_NAME (opt));
2250 for (sopt = socket_options; sopt->name; sopt++)
2251 if (strcmp (name, sopt->name) == 0)
2252 break;
2254 switch (sopt->opttype)
2256 case SOPT_BOOL:
2258 int optval;
2259 optval = NILP (val) ? 0 : 1;
2260 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2261 &optval, sizeof (optval));
2262 break;
2265 case SOPT_INT:
2267 int optval;
2268 if (TYPE_RANGED_INTEGERP (int, val))
2269 optval = XINT (val);
2270 else
2271 error ("Bad option value for %s", name);
2272 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2273 &optval, sizeof (optval));
2274 break;
2277 #ifdef SO_BINDTODEVICE
2278 case SOPT_IFNAME:
2280 char devname[IFNAMSIZ+1];
2282 /* This is broken, at least in the Linux 2.4 kernel.
2283 To unbind, the arg must be a zero integer, not the empty string.
2284 This should work on all systems. KFS. 2003-09-23. */
2285 memset (devname, 0, sizeof devname);
2286 if (STRINGP (val))
2288 char *arg = SSDATA (val);
2289 int len = min (strlen (arg), IFNAMSIZ);
2290 memcpy (devname, arg, len);
2292 else if (!NILP (val))
2293 error ("Bad option value for %s", name);
2294 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2295 devname, IFNAMSIZ);
2296 break;
2298 #endif
2300 #ifdef SO_LINGER
2301 case SOPT_LINGER:
2303 struct linger linger;
2305 linger.l_onoff = 1;
2306 linger.l_linger = 0;
2307 if (TYPE_RANGED_INTEGERP (int, val))
2308 linger.l_linger = XINT (val);
2309 else
2310 linger.l_onoff = NILP (val) ? 0 : 1;
2311 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2312 &linger, sizeof (linger));
2313 break;
2315 #endif
2317 default:
2318 return 0;
2321 if (ret < 0)
2323 int setsockopt_errno = errno;
2324 report_file_errno ("Cannot set network option", list2 (opt, val),
2325 setsockopt_errno);
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 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2460 0, MANY, 0,
2461 doc: /* Create and return a serial port process.
2463 In Emacs, serial port connections are represented by process objects,
2464 so input and output work as for subprocesses, and `delete-process'
2465 closes a serial port connection. However, a serial process has no
2466 process id, it cannot be signaled, and the status codes are different
2467 from normal processes.
2469 `make-serial-process' creates a process and a buffer, on which you
2470 probably want to use `process-send-string'. Try \\[serial-term] for
2471 an interactive terminal. See below for examples.
2473 Arguments are specified as keyword/argument pairs. The following
2474 arguments are defined:
2476 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2477 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2478 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2479 the backslashes in strings).
2481 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2482 which this function calls.
2484 :name NAME -- NAME is the name of the process. If NAME is not given,
2485 the value of PORT is used.
2487 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2488 with the process. Process output goes at the end of that buffer,
2489 unless you specify an output stream or filter function to handle the
2490 output. If BUFFER is not given, the value of NAME is used.
2492 :coding CODING -- If CODING is a symbol, it specifies the coding
2493 system used for both reading and writing for this process. If CODING
2494 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2495 ENCODING is used for writing.
2497 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2498 the process is running. If BOOL is not given, query before exiting.
2500 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2501 In the stopped state, a serial process does not accept incoming data,
2502 but you can send outgoing data. The stopped state is cleared by
2503 `continue-process' and set by `stop-process'.
2505 :filter FILTER -- Install FILTER as the process filter.
2507 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2509 :plist PLIST -- Install PLIST as the initial plist of the process.
2511 :bytesize
2512 :parity
2513 :stopbits
2514 :flowcontrol
2515 -- This function calls `serial-process-configure' to handle these
2516 arguments.
2518 The original argument list, possibly modified by later configuration,
2519 is available via the function `process-contact'.
2521 Examples:
2523 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2525 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2527 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2529 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2531 usage: (make-serial-process &rest ARGS) */)
2532 (ptrdiff_t nargs, Lisp_Object *args)
2534 int fd = -1;
2535 Lisp_Object proc, contact, port;
2536 struct Lisp_Process *p;
2537 struct gcpro gcpro1;
2538 Lisp_Object name, buffer;
2539 Lisp_Object tem, val;
2540 ptrdiff_t specpdl_count;
2542 if (nargs == 0)
2543 return Qnil;
2545 contact = Flist (nargs, args);
2546 GCPRO1 (contact);
2548 port = Fplist_get (contact, QCport);
2549 if (NILP (port))
2550 error ("No port specified");
2551 CHECK_STRING (port);
2553 if (NILP (Fplist_member (contact, QCspeed)))
2554 error (":speed not specified");
2555 if (!NILP (Fplist_get (contact, QCspeed)))
2556 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2558 name = Fplist_get (contact, QCname);
2559 if (NILP (name))
2560 name = port;
2561 CHECK_STRING (name);
2562 proc = make_process (name);
2563 specpdl_count = SPECPDL_INDEX ();
2564 record_unwind_protect (remove_process, proc);
2565 p = XPROCESS (proc);
2567 fd = serial_open (port);
2568 p->open_fd[SUBPROCESS_STDIN] = fd;
2569 p->infd = fd;
2570 p->outfd = fd;
2571 if (fd > max_process_desc)
2572 max_process_desc = fd;
2573 chan_process[fd] = proc;
2575 buffer = Fplist_get (contact, QCbuffer);
2576 if (NILP (buffer))
2577 buffer = name;
2578 buffer = Fget_buffer_create (buffer);
2579 pset_buffer (p, buffer);
2581 pset_childp (p, contact);
2582 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2583 pset_type (p, Qserial);
2584 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2585 pset_filter (p, Fplist_get (contact, QCfilter));
2586 pset_log (p, Qnil);
2587 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2588 p->kill_without_query = 1;
2589 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2590 pset_command (p, Qt);
2591 eassert (! p->pty_flag);
2593 if (!EQ (p->command, Qt))
2595 FD_SET (fd, &input_wait_mask);
2596 FD_SET (fd, &non_keyboard_wait_mask);
2599 if (BUFFERP (buffer))
2601 set_marker_both (p->mark, buffer,
2602 BUF_ZV (XBUFFER (buffer)),
2603 BUF_ZV_BYTE (XBUFFER (buffer)));
2606 tem = Fplist_member (contact, QCcoding);
2607 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2608 tem = Qnil;
2610 val = Qnil;
2611 if (!NILP (tem))
2613 val = XCAR (XCDR (tem));
2614 if (CONSP (val))
2615 val = XCAR (val);
2617 else if (!NILP (Vcoding_system_for_read))
2618 val = Vcoding_system_for_read;
2619 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2620 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2621 val = Qnil;
2622 pset_decode_coding_system (p, val);
2624 val = Qnil;
2625 if (!NILP (tem))
2627 val = XCAR (XCDR (tem));
2628 if (CONSP (val))
2629 val = XCDR (val);
2631 else if (!NILP (Vcoding_system_for_write))
2632 val = Vcoding_system_for_write;
2633 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2634 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2635 val = Qnil;
2636 pset_encode_coding_system (p, val);
2638 setup_process_coding_systems (proc);
2639 pset_decoding_buf (p, empty_unibyte_string);
2640 p->decoding_carryover = 0;
2641 pset_encoding_buf (p, empty_unibyte_string);
2642 p->inherit_coding_system_flag
2643 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2645 Fserial_process_configure (nargs, args);
2647 specpdl_ptr = specpdl + specpdl_count;
2649 UNGCPRO;
2650 return proc;
2653 /* Create a network stream/datagram client/server process. Treated
2654 exactly like a normal process when reading and writing. Primary
2655 differences are in status display and process deletion. A network
2656 connection has no PID; you cannot signal it. All you can do is
2657 stop/continue it and deactivate/close it via delete-process */
2659 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2660 0, MANY, 0,
2661 doc: /* Create and return a network server or client process.
2663 In Emacs, network connections are represented by process objects, so
2664 input and output work as for subprocesses and `delete-process' closes
2665 a network connection. However, a network process has no process id,
2666 it cannot be signaled, and the status codes are different from normal
2667 processes.
2669 Arguments are specified as keyword/argument pairs. The following
2670 arguments are defined:
2672 :name NAME -- NAME is name for process. It is modified if necessary
2673 to make it unique.
2675 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2676 with the process. Process output goes at end of that buffer, unless
2677 you specify an output stream or filter function to handle the output.
2678 BUFFER may be also nil, meaning that this process is not associated
2679 with any buffer.
2681 :host HOST -- HOST is name of the host to connect to, or its IP
2682 address. The symbol `local' specifies the local host. If specified
2683 for a server process, it must be a valid name or address for the local
2684 host, and only clients connecting to that address will be accepted.
2686 :service SERVICE -- SERVICE is name of the service desired, or an
2687 integer specifying a port number to connect to. If SERVICE is t,
2688 a random port number is selected for the server. (If Emacs was
2689 compiled with getaddrinfo, a port number can also be specified as a
2690 string, e.g. "80", as well as an integer. This is not portable.)
2692 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2693 stream type connection, `datagram' creates a datagram type connection,
2694 `seqpacket' creates a reliable datagram connection.
2696 :family FAMILY -- FAMILY is the address (and protocol) family for the
2697 service specified by HOST and SERVICE. The default (nil) is to use
2698 whatever address family (IPv4 or IPv6) that is defined for the host
2699 and port number specified by HOST and SERVICE. Other address families
2700 supported are:
2701 local -- for a local (i.e. UNIX) address specified by SERVICE.
2702 ipv4 -- use IPv4 address family only.
2703 ipv6 -- use IPv6 address family only.
2705 :local ADDRESS -- ADDRESS is the local address used for the connection.
2706 This parameter is ignored when opening a client process. When specified
2707 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2709 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2710 connection. This parameter is ignored when opening a stream server
2711 process. For a datagram server process, it specifies the initial
2712 setting of the remote datagram address. When specified for a client
2713 process, the FAMILY, HOST, and SERVICE args are ignored.
2715 The format of ADDRESS depends on the address family:
2716 - An IPv4 address is represented as an vector of integers [A B C D P]
2717 corresponding to numeric IP address A.B.C.D and port number P.
2718 - A local address is represented as a string with the address in the
2719 local address space.
2720 - An "unsupported family" address is represented by a cons (F . AV)
2721 where F is the family number and AV is a vector containing the socket
2722 address data with one element per address data byte. Do not rely on
2723 this format in portable code, as it may depend on implementation
2724 defined constants, data sizes, and data structure alignment.
2726 :coding CODING -- If CODING is a symbol, it specifies the coding
2727 system used for both reading and writing for this process. If CODING
2728 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2729 ENCODING is used for writing.
2731 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2732 return without waiting for the connection to complete; instead, the
2733 sentinel function will be called with second arg matching "open" (if
2734 successful) or "failed" when the connect completes. Default is to use
2735 a blocking connect (i.e. wait) for stream type connections.
2737 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2738 running when Emacs is exited.
2740 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2741 In the stopped state, a server process does not accept new
2742 connections, and a client process does not handle incoming traffic.
2743 The stopped state is cleared by `continue-process' and set by
2744 `stop-process'.
2746 :filter FILTER -- Install FILTER as the process filter.
2748 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2749 process filter are multibyte, otherwise they are unibyte.
2750 If this keyword is not specified, the strings are multibyte if
2751 the default value of `enable-multibyte-characters' is non-nil.
2753 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2755 :log LOG -- Install LOG as the server process log function. This
2756 function is called when the server accepts a network connection from a
2757 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2758 is the server process, CLIENT is the new process for the connection,
2759 and MESSAGE is a string.
2761 :plist PLIST -- Install PLIST as the new process's initial plist.
2763 :server QLEN -- if QLEN is non-nil, create a server process for the
2764 specified FAMILY, SERVICE, and connection type (stream or datagram).
2765 If QLEN is an integer, it is used as the max. length of the server's
2766 pending connection queue (also known as the backlog); the default
2767 queue length is 5. Default is to create a client process.
2769 The following network options can be specified for this connection:
2771 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2772 :dontroute BOOL -- Only send to directly connected hosts.
2773 :keepalive BOOL -- Send keep-alive messages on network stream.
2774 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2775 :oobinline BOOL -- Place out-of-band data in receive data stream.
2776 :priority INT -- Set protocol defined priority for sent packets.
2777 :reuseaddr BOOL -- Allow reusing a recently used local address
2778 (this is allowed by default for a server process).
2779 :bindtodevice NAME -- bind to interface NAME. Using this may require
2780 special privileges on some systems.
2782 Consult the relevant system programmer's manual pages for more
2783 information on using these options.
2786 A server process will listen for and accept connections from clients.
2787 When a client connection is accepted, a new network process is created
2788 for the connection with the following parameters:
2790 - The client's process name is constructed by concatenating the server
2791 process's NAME and a client identification string.
2792 - If the FILTER argument is non-nil, the client process will not get a
2793 separate process buffer; otherwise, the client's process buffer is a newly
2794 created buffer named after the server process's BUFFER name or process
2795 NAME concatenated with the client identification string.
2796 - The connection type and the process filter and sentinel parameters are
2797 inherited from the server process's TYPE, FILTER and SENTINEL.
2798 - The client process's contact info is set according to the client's
2799 addressing information (typically an IP address and a port number).
2800 - The client process's plist is initialized from the server's plist.
2802 Notice that the FILTER and SENTINEL args are never used directly by
2803 the server process. Also, the BUFFER argument is not used directly by
2804 the server process, but via the optional :log function, accepted (and
2805 failed) connections may be logged in the server process's buffer.
2807 The original argument list, modified with the actual connection
2808 information, is available via the `process-contact' function.
2810 usage: (make-network-process &rest ARGS) */)
2811 (ptrdiff_t nargs, Lisp_Object *args)
2813 Lisp_Object proc;
2814 Lisp_Object contact;
2815 struct Lisp_Process *p;
2816 #ifdef HAVE_GETADDRINFO
2817 struct addrinfo ai, *res, *lres;
2818 struct addrinfo hints;
2819 const char *portstring;
2820 char portbuf[128];
2821 #else /* HAVE_GETADDRINFO */
2822 struct _emacs_addrinfo
2824 int ai_family;
2825 int ai_socktype;
2826 int ai_protocol;
2827 int ai_addrlen;
2828 struct sockaddr *ai_addr;
2829 struct _emacs_addrinfo *ai_next;
2830 } ai, *res, *lres;
2831 #endif /* HAVE_GETADDRINFO */
2832 struct sockaddr_in address_in;
2833 #ifdef HAVE_LOCAL_SOCKETS
2834 struct sockaddr_un address_un;
2835 #endif
2836 int port;
2837 int ret = 0;
2838 int xerrno = 0;
2839 int s = -1, outch, inch;
2840 struct gcpro gcpro1;
2841 ptrdiff_t count = SPECPDL_INDEX ();
2842 ptrdiff_t count1;
2843 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2844 Lisp_Object tem;
2845 Lisp_Object name, buffer, host, service, address;
2846 Lisp_Object filter, sentinel;
2847 bool is_non_blocking_client = 0;
2848 bool is_server = 0;
2849 int backlog = 5;
2850 int socktype;
2851 int family = -1;
2853 if (nargs == 0)
2854 return Qnil;
2856 /* Save arguments for process-contact and clone-process. */
2857 contact = Flist (nargs, args);
2858 GCPRO1 (contact);
2860 #ifdef WINDOWSNT
2861 /* Ensure socket support is loaded if available. */
2862 init_winsock (TRUE);
2863 #endif
2865 /* :type TYPE (nil: stream, datagram */
2866 tem = Fplist_get (contact, QCtype);
2867 if (NILP (tem))
2868 socktype = SOCK_STREAM;
2869 #ifdef DATAGRAM_SOCKETS
2870 else if (EQ (tem, Qdatagram))
2871 socktype = SOCK_DGRAM;
2872 #endif
2873 #ifdef HAVE_SEQPACKET
2874 else if (EQ (tem, Qseqpacket))
2875 socktype = SOCK_SEQPACKET;
2876 #endif
2877 else
2878 error ("Unsupported connection type");
2880 /* :server BOOL */
2881 tem = Fplist_get (contact, QCserver);
2882 if (!NILP (tem))
2884 /* Don't support network sockets when non-blocking mode is
2885 not available, since a blocked Emacs is not useful. */
2886 is_server = 1;
2887 if (TYPE_RANGED_INTEGERP (int, tem))
2888 backlog = XINT (tem);
2891 /* Make QCaddress an alias for :local (server) or :remote (client). */
2892 QCaddress = is_server ? QClocal : QCremote;
2894 /* :nowait BOOL */
2895 if (!is_server && socktype != SOCK_DGRAM
2896 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2898 #ifndef NON_BLOCKING_CONNECT
2899 error ("Non-blocking connect not supported");
2900 #else
2901 is_non_blocking_client = 1;
2902 #endif
2905 name = Fplist_get (contact, QCname);
2906 buffer = Fplist_get (contact, QCbuffer);
2907 filter = Fplist_get (contact, QCfilter);
2908 sentinel = Fplist_get (contact, QCsentinel);
2910 CHECK_STRING (name);
2912 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2913 ai.ai_socktype = socktype;
2914 ai.ai_protocol = 0;
2915 ai.ai_next = NULL;
2916 res = &ai;
2918 /* :local ADDRESS or :remote ADDRESS */
2919 address = Fplist_get (contact, QCaddress);
2920 if (!NILP (address))
2922 host = service = Qnil;
2924 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2925 error ("Malformed :address");
2926 ai.ai_family = family;
2927 ai.ai_addr = alloca (ai.ai_addrlen);
2928 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2929 goto open_socket;
2932 /* :family FAMILY -- nil (for Inet), local, or integer. */
2933 tem = Fplist_get (contact, QCfamily);
2934 if (NILP (tem))
2936 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
2937 family = AF_UNSPEC;
2938 #else
2939 family = AF_INET;
2940 #endif
2942 #ifdef HAVE_LOCAL_SOCKETS
2943 else if (EQ (tem, Qlocal))
2944 family = AF_LOCAL;
2945 #endif
2946 #ifdef AF_INET6
2947 else if (EQ (tem, Qipv6))
2948 family = AF_INET6;
2949 #endif
2950 else if (EQ (tem, Qipv4))
2951 family = AF_INET;
2952 else if (TYPE_RANGED_INTEGERP (int, tem))
2953 family = XINT (tem);
2954 else
2955 error ("Unknown address family");
2957 ai.ai_family = family;
2959 /* :service SERVICE -- string, integer (port number), or t (random port). */
2960 service = Fplist_get (contact, QCservice);
2962 /* :host HOST -- hostname, ip address, or 'local for localhost. */
2963 host = Fplist_get (contact, QChost);
2964 if (!NILP (host))
2966 if (EQ (host, Qlocal))
2967 /* Depending on setup, "localhost" may map to different IPv4 and/or
2968 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
2969 host = build_string ("127.0.0.1");
2970 CHECK_STRING (host);
2973 #ifdef HAVE_LOCAL_SOCKETS
2974 if (family == AF_LOCAL)
2976 if (!NILP (host))
2978 message (":family local ignores the :host \"%s\" property",
2979 SDATA (host));
2980 contact = Fplist_put (contact, QChost, Qnil);
2981 host = Qnil;
2983 CHECK_STRING (service);
2984 memset (&address_un, 0, sizeof address_un);
2985 address_un.sun_family = AF_LOCAL;
2986 if (sizeof address_un.sun_path <= SBYTES (service))
2987 error ("Service name too long");
2988 strcpy (address_un.sun_path, SSDATA (service));
2989 ai.ai_addr = (struct sockaddr *) &address_un;
2990 ai.ai_addrlen = sizeof address_un;
2991 goto open_socket;
2993 #endif
2995 /* Slow down polling to every ten seconds.
2996 Some kernels have a bug which causes retrying connect to fail
2997 after a connect. Polling can interfere with gethostbyname too. */
2998 #ifdef POLL_FOR_INPUT
2999 if (socktype != SOCK_DGRAM)
3001 record_unwind_protect_void (run_all_atimers);
3002 bind_polling_period (10);
3004 #endif
3006 #ifdef HAVE_GETADDRINFO
3007 /* If we have a host, use getaddrinfo to resolve both host and service.
3008 Otherwise, use getservbyname to lookup the service. */
3009 if (!NILP (host))
3012 /* SERVICE can either be a string or int.
3013 Convert to a C string for later use by getaddrinfo. */
3014 if (EQ (service, Qt))
3015 portstring = "0";
3016 else if (INTEGERP (service))
3018 sprintf (portbuf, "%"pI"d", XINT (service));
3019 portstring = portbuf;
3021 else
3023 CHECK_STRING (service);
3024 portstring = SSDATA (service);
3027 immediate_quit = 1;
3028 QUIT;
3029 memset (&hints, 0, sizeof (hints));
3030 hints.ai_flags = 0;
3031 hints.ai_family = family;
3032 hints.ai_socktype = socktype;
3033 hints.ai_protocol = 0;
3035 #ifdef HAVE_RES_INIT
3036 res_init ();
3037 #endif
3039 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3040 if (ret)
3041 #ifdef HAVE_GAI_STRERROR
3042 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3043 #else
3044 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3045 #endif
3046 immediate_quit = 0;
3048 goto open_socket;
3050 #endif /* HAVE_GETADDRINFO */
3052 /* We end up here if getaddrinfo is not defined, or in case no hostname
3053 has been specified (e.g. for a local server process). */
3055 if (EQ (service, Qt))
3056 port = 0;
3057 else if (INTEGERP (service))
3058 port = htons ((unsigned short) XINT (service));
3059 else
3061 struct servent *svc_info;
3062 CHECK_STRING (service);
3063 svc_info = getservbyname (SSDATA (service),
3064 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3065 if (svc_info == 0)
3066 error ("Unknown service: %s", SDATA (service));
3067 port = svc_info->s_port;
3070 memset (&address_in, 0, sizeof address_in);
3071 address_in.sin_family = family;
3072 address_in.sin_addr.s_addr = INADDR_ANY;
3073 address_in.sin_port = port;
3075 #ifndef HAVE_GETADDRINFO
3076 if (!NILP (host))
3078 struct hostent *host_info_ptr;
3080 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3081 as it may `hang' Emacs for a very long time. */
3082 immediate_quit = 1;
3083 QUIT;
3085 #ifdef HAVE_RES_INIT
3086 res_init ();
3087 #endif
3089 host_info_ptr = gethostbyname (SDATA (host));
3090 immediate_quit = 0;
3092 if (host_info_ptr)
3094 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3095 host_info_ptr->h_length);
3096 family = host_info_ptr->h_addrtype;
3097 address_in.sin_family = family;
3099 else
3100 /* Attempt to interpret host as numeric inet address */
3102 unsigned long numeric_addr;
3103 numeric_addr = inet_addr (SSDATA (host));
3104 if (numeric_addr == -1)
3105 error ("Unknown host \"%s\"", SDATA (host));
3107 memcpy (&address_in.sin_addr, &numeric_addr,
3108 sizeof (address_in.sin_addr));
3112 #endif /* not HAVE_GETADDRINFO */
3114 ai.ai_family = family;
3115 ai.ai_addr = (struct sockaddr *) &address_in;
3116 ai.ai_addrlen = sizeof address_in;
3118 open_socket:
3120 /* Do this in case we never enter the for-loop below. */
3121 count1 = SPECPDL_INDEX ();
3122 s = -1;
3124 for (lres = res; lres; lres = lres->ai_next)
3126 ptrdiff_t optn;
3127 int optbits;
3129 #ifdef WINDOWSNT
3130 retry_connect:
3131 #endif
3133 s = socket (lres->ai_family, lres->ai_socktype | SOCK_CLOEXEC,
3134 lres->ai_protocol);
3135 if (s < 0)
3137 xerrno = errno;
3138 continue;
3141 #ifdef DATAGRAM_SOCKETS
3142 if (!is_server && socktype == SOCK_DGRAM)
3143 break;
3144 #endif /* DATAGRAM_SOCKETS */
3146 #ifdef NON_BLOCKING_CONNECT
3147 if (is_non_blocking_client)
3149 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3150 if (ret < 0)
3152 xerrno = errno;
3153 emacs_close (s);
3154 s = -1;
3155 continue;
3158 #endif
3160 /* Make us close S if quit. */
3161 record_unwind_protect_int (close_file_unwind, s);
3163 /* Parse network options in the arg list.
3164 We simply ignore anything which isn't a known option (including other keywords).
3165 An error is signaled if setting a known option fails. */
3166 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3167 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3169 if (is_server)
3171 /* Configure as a server socket. */
3173 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3174 explicit :reuseaddr key to override this. */
3175 #ifdef HAVE_LOCAL_SOCKETS
3176 if (family != AF_LOCAL)
3177 #endif
3178 if (!(optbits & (1 << OPIX_REUSEADDR)))
3180 int optval = 1;
3181 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3182 report_file_error ("Cannot set reuse option on server socket", Qnil);
3185 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3186 report_file_error ("Cannot bind server socket", Qnil);
3188 #ifdef HAVE_GETSOCKNAME
3189 if (EQ (service, Qt))
3191 struct sockaddr_in sa1;
3192 socklen_t len1 = sizeof (sa1);
3193 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3195 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3196 service = make_number (ntohs (sa1.sin_port));
3197 contact = Fplist_put (contact, QCservice, service);
3200 #endif
3202 if (socktype != SOCK_DGRAM && listen (s, backlog))
3203 report_file_error ("Cannot listen on server socket", Qnil);
3205 break;
3208 immediate_quit = 1;
3209 QUIT;
3211 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3212 xerrno = errno;
3214 if (ret == 0 || xerrno == EISCONN)
3216 /* The unwind-protect will be discarded afterwards.
3217 Likewise for immediate_quit. */
3218 break;
3221 #ifdef NON_BLOCKING_CONNECT
3222 #ifdef EINPROGRESS
3223 if (is_non_blocking_client && xerrno == EINPROGRESS)
3224 break;
3225 #else
3226 #ifdef EWOULDBLOCK
3227 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3228 break;
3229 #endif
3230 #endif
3231 #endif
3233 #ifndef WINDOWSNT
3234 if (xerrno == EINTR)
3236 /* Unlike most other syscalls connect() cannot be called
3237 again. (That would return EALREADY.) The proper way to
3238 wait for completion is pselect(). */
3239 int sc;
3240 socklen_t len;
3241 fd_set fdset;
3242 retry_select:
3243 FD_ZERO (&fdset);
3244 FD_SET (s, &fdset);
3245 QUIT;
3246 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3247 if (sc == -1)
3249 if (errno == EINTR)
3250 goto retry_select;
3251 else
3252 report_file_error ("Failed select", Qnil);
3254 eassert (sc > 0);
3256 len = sizeof xerrno;
3257 eassert (FD_ISSET (s, &fdset));
3258 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) < 0)
3259 report_file_error ("Failed getsockopt", Qnil);
3260 if (xerrno)
3261 report_file_errno ("Failed connect", Qnil, xerrno);
3262 break;
3264 #endif /* !WINDOWSNT */
3266 immediate_quit = 0;
3268 /* Discard the unwind protect closing S. */
3269 specpdl_ptr = specpdl + count1;
3270 emacs_close (s);
3271 s = -1;
3273 #ifdef WINDOWSNT
3274 if (xerrno == EINTR)
3275 goto retry_connect;
3276 #endif
3279 if (s >= 0)
3281 #ifdef DATAGRAM_SOCKETS
3282 if (socktype == SOCK_DGRAM)
3284 if (datagram_address[s].sa)
3285 emacs_abort ();
3286 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3287 datagram_address[s].len = lres->ai_addrlen;
3288 if (is_server)
3290 Lisp_Object remote;
3291 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3292 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3294 int rfamily, rlen;
3295 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3296 if (rlen != 0 && rfamily == lres->ai_family
3297 && rlen == lres->ai_addrlen)
3298 conv_lisp_to_sockaddr (rfamily, remote,
3299 datagram_address[s].sa, rlen);
3302 else
3303 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3305 #endif
3306 contact = Fplist_put (contact, QCaddress,
3307 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3308 #ifdef HAVE_GETSOCKNAME
3309 if (!is_server)
3311 struct sockaddr_in sa1;
3312 socklen_t len1 = sizeof (sa1);
3313 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3314 contact = Fplist_put (contact, QClocal,
3315 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3317 #endif
3320 immediate_quit = 0;
3322 #ifdef HAVE_GETADDRINFO
3323 if (res != &ai)
3325 block_input ();
3326 freeaddrinfo (res);
3327 unblock_input ();
3329 #endif
3331 if (s < 0)
3333 /* If non-blocking got this far - and failed - assume non-blocking is
3334 not supported after all. This is probably a wrong assumption, but
3335 the normal blocking calls to open-network-stream handles this error
3336 better. */
3337 if (is_non_blocking_client)
3338 return Qnil;
3340 report_file_errno ((is_server
3341 ? "make server process failed"
3342 : "make client process failed"),
3343 contact, xerrno);
3346 inch = s;
3347 outch = s;
3349 if (!NILP (buffer))
3350 buffer = Fget_buffer_create (buffer);
3351 proc = make_process (name);
3353 chan_process[inch] = proc;
3355 fcntl (inch, F_SETFL, O_NONBLOCK);
3357 p = XPROCESS (proc);
3359 pset_childp (p, contact);
3360 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3361 pset_type (p, Qnetwork);
3363 pset_buffer (p, buffer);
3364 pset_sentinel (p, sentinel);
3365 pset_filter (p, filter);
3366 pset_log (p, Fplist_get (contact, QClog));
3367 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3368 p->kill_without_query = 1;
3369 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3370 pset_command (p, Qt);
3371 p->pid = 0;
3373 p->open_fd[SUBPROCESS_STDIN] = inch;
3374 p->infd = inch;
3375 p->outfd = outch;
3377 /* Discard the unwind protect for closing S, if any. */
3378 specpdl_ptr = specpdl + count1;
3380 /* Unwind bind_polling_period and request_sigio. */
3381 unbind_to (count, Qnil);
3383 if (is_server && socktype != SOCK_DGRAM)
3384 pset_status (p, Qlisten);
3386 /* Make the process marker point into the process buffer (if any). */
3387 if (BUFFERP (buffer))
3388 set_marker_both (p->mark, buffer,
3389 BUF_ZV (XBUFFER (buffer)),
3390 BUF_ZV_BYTE (XBUFFER (buffer)));
3392 #ifdef NON_BLOCKING_CONNECT
3393 if (is_non_blocking_client)
3395 /* We may get here if connect did succeed immediately. However,
3396 in that case, we still need to signal this like a non-blocking
3397 connection. */
3398 pset_status (p, Qconnect);
3399 if (!FD_ISSET (inch, &connect_wait_mask))
3401 FD_SET (inch, &connect_wait_mask);
3402 FD_SET (inch, &write_mask);
3403 num_pending_connects++;
3406 else
3407 #endif
3408 /* A server may have a client filter setting of Qt, but it must
3409 still listen for incoming connects unless it is stopped. */
3410 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3411 || (EQ (p->status, Qlisten) && NILP (p->command)))
3413 FD_SET (inch, &input_wait_mask);
3414 FD_SET (inch, &non_keyboard_wait_mask);
3417 if (inch > max_process_desc)
3418 max_process_desc = inch;
3420 tem = Fplist_member (contact, QCcoding);
3421 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3422 tem = Qnil; /* No error message (too late!). */
3425 /* Setup coding systems for communicating with the network stream. */
3426 struct gcpro gcpro1;
3427 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3428 Lisp_Object coding_systems = Qt;
3429 Lisp_Object fargs[5], val;
3431 if (!NILP (tem))
3433 val = XCAR (XCDR (tem));
3434 if (CONSP (val))
3435 val = XCAR (val);
3437 else if (!NILP (Vcoding_system_for_read))
3438 val = Vcoding_system_for_read;
3439 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3440 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3441 /* We dare not decode end-of-line format by setting VAL to
3442 Qraw_text, because the existing Emacs Lisp libraries
3443 assume that they receive bare code including a sequence of
3444 CR LF. */
3445 val = Qnil;
3446 else
3448 if (NILP (host) || NILP (service))
3449 coding_systems = Qnil;
3450 else
3452 fargs[0] = Qopen_network_stream, fargs[1] = name,
3453 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3454 GCPRO1 (proc);
3455 coding_systems = Ffind_operation_coding_system (5, fargs);
3456 UNGCPRO;
3458 if (CONSP (coding_systems))
3459 val = XCAR (coding_systems);
3460 else if (CONSP (Vdefault_process_coding_system))
3461 val = XCAR (Vdefault_process_coding_system);
3462 else
3463 val = Qnil;
3465 pset_decode_coding_system (p, val);
3467 if (!NILP (tem))
3469 val = XCAR (XCDR (tem));
3470 if (CONSP (val))
3471 val = XCDR (val);
3473 else if (!NILP (Vcoding_system_for_write))
3474 val = Vcoding_system_for_write;
3475 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3476 val = Qnil;
3477 else
3479 if (EQ (coding_systems, Qt))
3481 if (NILP (host) || NILP (service))
3482 coding_systems = Qnil;
3483 else
3485 fargs[0] = Qopen_network_stream, fargs[1] = name,
3486 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3487 GCPRO1 (proc);
3488 coding_systems = Ffind_operation_coding_system (5, fargs);
3489 UNGCPRO;
3492 if (CONSP (coding_systems))
3493 val = XCDR (coding_systems);
3494 else if (CONSP (Vdefault_process_coding_system))
3495 val = XCDR (Vdefault_process_coding_system);
3496 else
3497 val = Qnil;
3499 pset_encode_coding_system (p, val);
3501 setup_process_coding_systems (proc);
3503 pset_decoding_buf (p, empty_unibyte_string);
3504 p->decoding_carryover = 0;
3505 pset_encoding_buf (p, empty_unibyte_string);
3507 p->inherit_coding_system_flag
3508 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3510 UNGCPRO;
3511 return proc;
3515 #ifdef HAVE_NET_IF_H
3517 #ifdef SIOCGIFCONF
3518 static Lisp_Object
3519 network_interface_list (void)
3521 struct ifconf ifconf;
3522 struct ifreq *ifreq;
3523 void *buf = NULL;
3524 ptrdiff_t buf_size = 512;
3525 int s;
3526 Lisp_Object res;
3527 ptrdiff_t count;
3529 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
3530 if (s < 0)
3531 return Qnil;
3532 count = SPECPDL_INDEX ();
3533 record_unwind_protect_int (close_file_unwind, s);
3537 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3538 ifconf.ifc_buf = buf;
3539 ifconf.ifc_len = buf_size;
3540 if (ioctl (s, SIOCGIFCONF, &ifconf))
3542 emacs_close (s);
3543 xfree (buf);
3544 return Qnil;
3547 while (ifconf.ifc_len == buf_size);
3549 res = unbind_to (count, Qnil);
3550 ifreq = ifconf.ifc_req;
3551 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3553 struct ifreq *ifq = ifreq;
3554 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3555 #define SIZEOF_IFREQ(sif) \
3556 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3557 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3559 int len = SIZEOF_IFREQ (ifq);
3560 #else
3561 int len = sizeof (*ifreq);
3562 #endif
3563 char namebuf[sizeof (ifq->ifr_name) + 1];
3564 ifreq = (struct ifreq *) ((char *) ifreq + len);
3566 if (ifq->ifr_addr.sa_family != AF_INET)
3567 continue;
3569 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3570 namebuf[sizeof (ifq->ifr_name)] = 0;
3571 res = Fcons (Fcons (build_string (namebuf),
3572 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3573 sizeof (struct sockaddr))),
3574 res);
3577 xfree (buf);
3578 return res;
3580 #endif /* SIOCGIFCONF */
3582 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3584 struct ifflag_def {
3585 int flag_bit;
3586 const char *flag_sym;
3589 static const struct ifflag_def ifflag_table[] = {
3590 #ifdef IFF_UP
3591 { IFF_UP, "up" },
3592 #endif
3593 #ifdef IFF_BROADCAST
3594 { IFF_BROADCAST, "broadcast" },
3595 #endif
3596 #ifdef IFF_DEBUG
3597 { IFF_DEBUG, "debug" },
3598 #endif
3599 #ifdef IFF_LOOPBACK
3600 { IFF_LOOPBACK, "loopback" },
3601 #endif
3602 #ifdef IFF_POINTOPOINT
3603 { IFF_POINTOPOINT, "pointopoint" },
3604 #endif
3605 #ifdef IFF_RUNNING
3606 { IFF_RUNNING, "running" },
3607 #endif
3608 #ifdef IFF_NOARP
3609 { IFF_NOARP, "noarp" },
3610 #endif
3611 #ifdef IFF_PROMISC
3612 { IFF_PROMISC, "promisc" },
3613 #endif
3614 #ifdef IFF_NOTRAILERS
3615 #ifdef NS_IMPL_COCOA
3616 /* Really means smart, notrailers is obsolete */
3617 { IFF_NOTRAILERS, "smart" },
3618 #else
3619 { IFF_NOTRAILERS, "notrailers" },
3620 #endif
3621 #endif
3622 #ifdef IFF_ALLMULTI
3623 { IFF_ALLMULTI, "allmulti" },
3624 #endif
3625 #ifdef IFF_MASTER
3626 { IFF_MASTER, "master" },
3627 #endif
3628 #ifdef IFF_SLAVE
3629 { IFF_SLAVE, "slave" },
3630 #endif
3631 #ifdef IFF_MULTICAST
3632 { IFF_MULTICAST, "multicast" },
3633 #endif
3634 #ifdef IFF_PORTSEL
3635 { IFF_PORTSEL, "portsel" },
3636 #endif
3637 #ifdef IFF_AUTOMEDIA
3638 { IFF_AUTOMEDIA, "automedia" },
3639 #endif
3640 #ifdef IFF_DYNAMIC
3641 { IFF_DYNAMIC, "dynamic" },
3642 #endif
3643 #ifdef IFF_OACTIVE
3644 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3645 #endif
3646 #ifdef IFF_SIMPLEX
3647 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3648 #endif
3649 #ifdef IFF_LINK0
3650 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3651 #endif
3652 #ifdef IFF_LINK1
3653 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3654 #endif
3655 #ifdef IFF_LINK2
3656 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3657 #endif
3658 { 0, 0 }
3661 static Lisp_Object
3662 network_interface_info (Lisp_Object ifname)
3664 struct ifreq rq;
3665 Lisp_Object res = Qnil;
3666 Lisp_Object elt;
3667 int s;
3668 bool any = 0;
3669 ptrdiff_t count;
3670 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3671 && defined HAVE_GETIFADDRS && defined LLADDR)
3672 struct ifaddrs *ifap;
3673 #endif
3675 CHECK_STRING (ifname);
3677 if (sizeof rq.ifr_name <= SBYTES (ifname))
3678 error ("interface name too long");
3679 strcpy (rq.ifr_name, SSDATA (ifname));
3681 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
3682 if (s < 0)
3683 return Qnil;
3684 count = SPECPDL_INDEX ();
3685 record_unwind_protect_int (close_file_unwind, s);
3687 elt = Qnil;
3688 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3689 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3691 int flags = rq.ifr_flags;
3692 const struct ifflag_def *fp;
3693 int fnum;
3695 /* If flags is smaller than int (i.e. short) it may have the high bit set
3696 due to IFF_MULTICAST. In that case, sign extending it into
3697 an int is wrong. */
3698 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3699 flags = (unsigned short) rq.ifr_flags;
3701 any = 1;
3702 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3704 if (flags & fp->flag_bit)
3706 elt = Fcons (intern (fp->flag_sym), elt);
3707 flags -= fp->flag_bit;
3710 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3712 if (flags & 1)
3714 elt = Fcons (make_number (fnum), elt);
3718 #endif
3719 res = Fcons (elt, res);
3721 elt = Qnil;
3722 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3723 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3725 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3726 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3727 int n;
3729 any = 1;
3730 for (n = 0; n < 6; n++)
3731 p->contents[n] = make_number (((unsigned char *)
3732 &rq.ifr_hwaddr.sa_data[0])
3733 [n]);
3734 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3736 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3737 if (getifaddrs (&ifap) != -1)
3739 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3740 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3741 struct ifaddrs *it;
3743 for (it = ifap; it != NULL; it = it->ifa_next)
3745 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3746 unsigned char linkaddr[6];
3747 int n;
3749 if (it->ifa_addr->sa_family != AF_LINK
3750 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3751 || sdl->sdl_alen != 6)
3752 continue;
3754 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3755 for (n = 0; n < 6; n++)
3756 p->contents[n] = make_number (linkaddr[n]);
3758 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3759 break;
3762 #ifdef HAVE_FREEIFADDRS
3763 freeifaddrs (ifap);
3764 #endif
3766 #endif /* HAVE_GETIFADDRS && LLADDR */
3768 res = Fcons (elt, res);
3770 elt = Qnil;
3771 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3772 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3774 any = 1;
3775 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3776 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3777 #else
3778 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3779 #endif
3781 #endif
3782 res = Fcons (elt, res);
3784 elt = Qnil;
3785 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3786 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3788 any = 1;
3789 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3791 #endif
3792 res = Fcons (elt, res);
3794 elt = Qnil;
3795 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3796 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3798 any = 1;
3799 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3801 #endif
3802 res = Fcons (elt, res);
3804 return unbind_to (count, any ? res : Qnil);
3806 #endif /* !SIOCGIFADDR && !SIOCGIFHWADDR && !SIOCGIFFLAGS */
3807 #endif /* defined (HAVE_NET_IF_H) */
3809 DEFUN ("network-interface-list", Fnetwork_interface_list,
3810 Snetwork_interface_list, 0, 0, 0,
3811 doc: /* Return an alist of all network interfaces and their network address.
3812 Each element is a cons, the car of which is a string containing the
3813 interface name, and the cdr is the network address in internal
3814 format; see the description of ADDRESS in `make-network-process'.
3816 If the information is not available, return nil. */)
3817 (void)
3819 #if (defined HAVE_NET_IF_H && defined SIOCGIFCONF) || defined WINDOWSNT
3820 return network_interface_list ();
3821 #else
3822 return Qnil;
3823 #endif
3826 DEFUN ("network-interface-info", Fnetwork_interface_info,
3827 Snetwork_interface_info, 1, 1, 0,
3828 doc: /* Return information about network interface named IFNAME.
3829 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3830 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3831 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
3832 FLAGS is the current flags of the interface.
3834 Data that is unavailable is returned as nil. */)
3835 (Lisp_Object ifname)
3837 #if ((defined HAVE_NET_IF_H \
3838 && (defined SIOCGIFADDR || defined SIOCGIFHWADDR \
3839 || defined SIOCGIFFLAGS)) \
3840 || defined WINDOWSNT)
3841 return network_interface_info (ifname);
3842 #else
3843 return Qnil;
3844 #endif
3848 /* Turn off input and output for process PROC. */
3850 static void
3851 deactivate_process (Lisp_Object proc)
3853 int inchannel;
3854 struct Lisp_Process *p = XPROCESS (proc);
3855 int i;
3857 #ifdef HAVE_GNUTLS
3858 /* Delete GnuTLS structures in PROC, if any. */
3859 emacs_gnutls_deinit (proc);
3860 #endif /* HAVE_GNUTLS */
3862 #ifdef ADAPTIVE_READ_BUFFERING
3863 if (p->read_output_delay > 0)
3865 if (--process_output_delay_count < 0)
3866 process_output_delay_count = 0;
3867 p->read_output_delay = 0;
3868 p->read_output_skip = 0;
3870 #endif
3872 /* Beware SIGCHLD hereabouts. */
3874 for (i = 0; i < PROCESS_OPEN_FDS; i++)
3875 close_process_fd (&p->open_fd[i]);
3877 inchannel = p->infd;
3878 if (inchannel >= 0)
3880 p->infd = -1;
3881 p->outfd = -1;
3882 #ifdef DATAGRAM_SOCKETS
3883 if (DATAGRAM_CHAN_P (inchannel))
3885 xfree (datagram_address[inchannel].sa);
3886 datagram_address[inchannel].sa = 0;
3887 datagram_address[inchannel].len = 0;
3889 #endif
3890 chan_process[inchannel] = Qnil;
3891 FD_CLR (inchannel, &input_wait_mask);
3892 FD_CLR (inchannel, &non_keyboard_wait_mask);
3893 #ifdef NON_BLOCKING_CONNECT
3894 if (FD_ISSET (inchannel, &connect_wait_mask))
3896 FD_CLR (inchannel, &connect_wait_mask);
3897 FD_CLR (inchannel, &write_mask);
3898 if (--num_pending_connects < 0)
3899 emacs_abort ();
3901 #endif
3902 if (inchannel == max_process_desc)
3904 /* We just closed the highest-numbered process input descriptor,
3905 so recompute the highest-numbered one now. */
3906 int i = inchannel;
3908 i--;
3909 while (0 <= i && NILP (chan_process[i]));
3911 max_process_desc = i;
3917 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3918 0, 4, 0,
3919 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3920 It is given to their filter functions.
3921 Non-nil arg PROCESS means do not return until some output has been received
3922 from PROCESS.
3924 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3925 and milliseconds to wait; return after that much time whether or not
3926 there is any subprocess output. If SECONDS is a floating point number,
3927 it specifies a fractional number of seconds to wait.
3928 The MILLISEC argument is obsolete and should be avoided.
3930 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3931 from PROCESS, suspending reading output from other processes.
3932 If JUST-THIS-ONE is an integer, don't run any timers either.
3933 Return non-nil if we received any output before the timeout expired. */)
3934 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3936 intmax_t secs;
3937 int nsecs;
3939 if (! NILP (process))
3940 CHECK_PROCESS (process);
3941 else
3942 just_this_one = Qnil;
3944 if (!NILP (millisec))
3945 { /* Obsolete calling convention using integers rather than floats. */
3946 CHECK_NUMBER (millisec);
3947 if (NILP (seconds))
3948 seconds = make_float (XINT (millisec) / 1000.0);
3949 else
3951 CHECK_NUMBER (seconds);
3952 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3956 secs = 0;
3957 nsecs = -1;
3959 if (!NILP (seconds))
3961 if (INTEGERP (seconds))
3963 if (XINT (seconds) > 0)
3965 secs = XINT (seconds);
3966 nsecs = 0;
3969 else if (FLOATP (seconds))
3971 if (XFLOAT_DATA (seconds) > 0)
3973 struct timespec t = dtotimespec (XFLOAT_DATA (seconds));
3974 secs = min (t.tv_sec, WAIT_READING_MAX);
3975 nsecs = t.tv_nsec;
3978 else
3979 wrong_type_argument (Qnumberp, seconds);
3981 else if (! NILP (process))
3982 nsecs = 0;
3984 return
3985 (wait_reading_process_output (secs, nsecs, 0, 0,
3986 Qnil,
3987 !NILP (process) ? XPROCESS (process) : NULL,
3988 NILP (just_this_one) ? 0 :
3989 !INTEGERP (just_this_one) ? 1 : -1)
3990 ? Qt : Qnil);
3993 /* Accept a connection for server process SERVER on CHANNEL. */
3995 static EMACS_INT connect_counter = 0;
3997 static void
3998 server_accept_connection (Lisp_Object server, int channel)
4000 Lisp_Object proc, caller, name, buffer;
4001 Lisp_Object contact, host, service;
4002 struct Lisp_Process *ps= XPROCESS (server);
4003 struct Lisp_Process *p;
4004 int s;
4005 union u_sockaddr {
4006 struct sockaddr sa;
4007 struct sockaddr_in in;
4008 #ifdef AF_INET6
4009 struct sockaddr_in6 in6;
4010 #endif
4011 #ifdef HAVE_LOCAL_SOCKETS
4012 struct sockaddr_un un;
4013 #endif
4014 } saddr;
4015 socklen_t len = sizeof saddr;
4016 ptrdiff_t count;
4018 s = accept4 (channel, &saddr.sa, &len, SOCK_CLOEXEC);
4020 if (s < 0)
4022 int code = errno;
4024 if (code == EAGAIN)
4025 return;
4026 #ifdef EWOULDBLOCK
4027 if (code == EWOULDBLOCK)
4028 return;
4029 #endif
4031 if (!NILP (ps->log))
4032 call3 (ps->log, server, Qnil,
4033 concat3 (build_string ("accept failed with code"),
4034 Fnumber_to_string (make_number (code)),
4035 build_string ("\n")));
4036 return;
4039 count = SPECPDL_INDEX ();
4040 record_unwind_protect_int (close_file_unwind, s);
4042 connect_counter++;
4044 /* Setup a new process to handle the connection. */
4046 /* Generate a unique identification of the caller, and build contact
4047 information for this process. */
4048 host = Qt;
4049 service = Qnil;
4050 switch (saddr.sa.sa_family)
4052 case AF_INET:
4054 Lisp_Object args[5];
4055 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4056 args[0] = build_string ("%d.%d.%d.%d");
4057 args[1] = make_number (*ip++);
4058 args[2] = make_number (*ip++);
4059 args[3] = make_number (*ip++);
4060 args[4] = make_number (*ip++);
4061 host = Fformat (5, args);
4062 service = make_number (ntohs (saddr.in.sin_port));
4064 args[0] = build_string (" <%s:%d>");
4065 args[1] = host;
4066 args[2] = service;
4067 caller = Fformat (3, args);
4069 break;
4071 #ifdef AF_INET6
4072 case AF_INET6:
4074 Lisp_Object args[9];
4075 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4076 int i;
4077 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4078 for (i = 0; i < 8; i++)
4079 args[i+1] = make_number (ntohs (ip6[i]));
4080 host = Fformat (9, args);
4081 service = make_number (ntohs (saddr.in.sin_port));
4083 args[0] = build_string (" <[%s]:%d>");
4084 args[1] = host;
4085 args[2] = service;
4086 caller = Fformat (3, args);
4088 break;
4089 #endif
4091 #ifdef HAVE_LOCAL_SOCKETS
4092 case AF_LOCAL:
4093 #endif
4094 default:
4095 caller = Fnumber_to_string (make_number (connect_counter));
4096 caller = concat3 (build_string (" <"), caller, build_string (">"));
4097 break;
4100 /* Create a new buffer name for this process if it doesn't have a
4101 filter. The new buffer name is based on the buffer name or
4102 process name of the server process concatenated with the caller
4103 identification. */
4105 if (!(EQ (ps->filter, Qinternal_default_process_filter)
4106 || EQ (ps->filter, Qt)))
4107 buffer = Qnil;
4108 else
4110 buffer = ps->buffer;
4111 if (!NILP (buffer))
4112 buffer = Fbuffer_name (buffer);
4113 else
4114 buffer = ps->name;
4115 if (!NILP (buffer))
4117 buffer = concat2 (buffer, caller);
4118 buffer = Fget_buffer_create (buffer);
4122 /* Generate a unique name for the new server process. Combine the
4123 server process name with the caller identification. */
4125 name = concat2 (ps->name, caller);
4126 proc = make_process (name);
4128 chan_process[s] = proc;
4130 fcntl (s, F_SETFL, O_NONBLOCK);
4132 p = XPROCESS (proc);
4134 /* Build new contact information for this setup. */
4135 contact = Fcopy_sequence (ps->childp);
4136 contact = Fplist_put (contact, QCserver, Qnil);
4137 contact = Fplist_put (contact, QChost, host);
4138 if (!NILP (service))
4139 contact = Fplist_put (contact, QCservice, service);
4140 contact = Fplist_put (contact, QCremote,
4141 conv_sockaddr_to_lisp (&saddr.sa, len));
4142 #ifdef HAVE_GETSOCKNAME
4143 len = sizeof saddr;
4144 if (getsockname (s, &saddr.sa, &len) == 0)
4145 contact = Fplist_put (contact, QClocal,
4146 conv_sockaddr_to_lisp (&saddr.sa, len));
4147 #endif
4149 pset_childp (p, contact);
4150 pset_plist (p, Fcopy_sequence (ps->plist));
4151 pset_type (p, Qnetwork);
4153 pset_buffer (p, buffer);
4154 pset_sentinel (p, ps->sentinel);
4155 pset_filter (p, ps->filter);
4156 pset_command (p, Qnil);
4157 p->pid = 0;
4159 /* Discard the unwind protect for closing S. */
4160 specpdl_ptr = specpdl + count;
4162 p->open_fd[SUBPROCESS_STDIN] = s;
4163 p->infd = s;
4164 p->outfd = s;
4165 pset_status (p, Qrun);
4167 /* Client processes for accepted connections are not stopped initially. */
4168 if (!EQ (p->filter, Qt))
4170 FD_SET (s, &input_wait_mask);
4171 FD_SET (s, &non_keyboard_wait_mask);
4174 if (s > max_process_desc)
4175 max_process_desc = s;
4177 /* Setup coding system for new process based on server process.
4178 This seems to be the proper thing to do, as the coding system
4179 of the new process should reflect the settings at the time the
4180 server socket was opened; not the current settings. */
4182 pset_decode_coding_system (p, ps->decode_coding_system);
4183 pset_encode_coding_system (p, ps->encode_coding_system);
4184 setup_process_coding_systems (proc);
4186 pset_decoding_buf (p, empty_unibyte_string);
4187 p->decoding_carryover = 0;
4188 pset_encoding_buf (p, empty_unibyte_string);
4190 p->inherit_coding_system_flag
4191 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4193 if (!NILP (ps->log))
4194 call3 (ps->log, server, proc,
4195 concat3 (build_string ("accept from "),
4196 (STRINGP (host) ? host : build_string ("-")),
4197 build_string ("\n")));
4199 exec_sentinel (proc,
4200 concat3 (build_string ("open from "),
4201 (STRINGP (host) ? host : build_string ("-")),
4202 build_string ("\n")));
4205 /* This variable is different from waiting_for_input in keyboard.c.
4206 It is used to communicate to a lisp process-filter/sentinel (via the
4207 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4208 for user-input when that process-filter was called.
4209 waiting_for_input cannot be used as that is by definition 0 when
4210 lisp code is being evalled.
4211 This is also used in record_asynch_buffer_change.
4212 For that purpose, this must be 0
4213 when not inside wait_reading_process_output. */
4214 static int waiting_for_user_input_p;
4216 static void
4217 wait_reading_process_output_unwind (int data)
4219 waiting_for_user_input_p = data;
4222 /* This is here so breakpoints can be put on it. */
4223 static void
4224 wait_reading_process_output_1 (void)
4228 /* Read and dispose of subprocess output while waiting for timeout to
4229 elapse and/or keyboard input to be available.
4231 TIME_LIMIT is:
4232 timeout in seconds
4233 If negative, gobble data immediately available but don't wait for any.
4235 NSECS is:
4236 an additional duration to wait, measured in nanoseconds
4237 If TIME_LIMIT is zero, then:
4238 If NSECS == 0, there is no limit.
4239 If NSECS > 0, the timeout consists of NSECS only.
4240 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4242 READ_KBD is:
4243 0 to ignore keyboard input, or
4244 1 to return when input is available, or
4245 -1 meaning caller will actually read the input, so don't throw to
4246 the quit handler, or
4248 DO_DISPLAY means redisplay should be done to show subprocess
4249 output that arrives.
4251 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4252 (and gobble terminal input into the buffer if any arrives).
4254 If WAIT_PROC is specified, wait until something arrives from that
4255 process. The return value is true if we read some input from
4256 that process.
4258 If JUST_WAIT_PROC is nonzero, handle only output from WAIT_PROC
4259 (suspending output from other processes). A negative value
4260 means don't run any timers either.
4262 If WAIT_PROC is specified, then the function returns true if we
4263 received input from that process before the timeout elapsed.
4264 Otherwise, return true if we received input from any process. */
4266 bool
4267 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4268 bool do_display,
4269 Lisp_Object wait_for_cell,
4270 struct Lisp_Process *wait_proc, int just_wait_proc)
4272 int channel, nfds;
4273 fd_set Available;
4274 fd_set Writeok;
4275 bool check_write;
4276 int check_delay;
4277 bool no_avail;
4278 int xerrno;
4279 Lisp_Object proc;
4280 struct timespec timeout, end_time;
4281 int wait_channel = -1;
4282 bool got_some_input = 0;
4283 ptrdiff_t count = SPECPDL_INDEX ();
4285 FD_ZERO (&Available);
4286 FD_ZERO (&Writeok);
4288 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4289 && !(CONSP (wait_proc->status)
4290 && EQ (XCAR (wait_proc->status), Qexit)))
4291 message1 ("Blocking call to accept-process-output with quit inhibited!!");
4293 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4294 if (wait_proc != NULL)
4295 wait_channel = wait_proc->infd;
4297 record_unwind_protect_int (wait_reading_process_output_unwind,
4298 waiting_for_user_input_p);
4299 waiting_for_user_input_p = read_kbd;
4301 if (time_limit < 0)
4303 time_limit = 0;
4304 nsecs = -1;
4306 else if (TYPE_MAXIMUM (time_t) < time_limit)
4307 time_limit = TYPE_MAXIMUM (time_t);
4309 /* Since we may need to wait several times,
4310 compute the absolute time to return at. */
4311 if (time_limit || nsecs > 0)
4313 timeout = make_timespec (time_limit, nsecs);
4314 end_time = timespec_add (current_timespec (), timeout);
4317 while (1)
4319 bool timeout_reduced_for_timers = 0;
4321 /* If calling from keyboard input, do not quit
4322 since we want to return C-g as an input character.
4323 Otherwise, do pending quit if requested. */
4324 if (read_kbd >= 0)
4325 QUIT;
4326 else if (pending_signals)
4327 process_pending_signals ();
4329 /* Exit now if the cell we're waiting for became non-nil. */
4330 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4331 break;
4333 /* Compute time from now till when time limit is up. */
4334 /* Exit if already run out. */
4335 if (nsecs < 0)
4337 /* A negative timeout means
4338 gobble output available now
4339 but don't wait at all. */
4341 timeout = make_timespec (0, 0);
4343 else if (time_limit || nsecs > 0)
4345 struct timespec now = current_timespec ();
4346 if (timespec_cmp (end_time, now) <= 0)
4347 break;
4348 timeout = timespec_sub (end_time, now);
4350 else
4352 timeout = make_timespec (100000, 0);
4355 /* Normally we run timers here.
4356 But not if wait_for_cell; in those cases,
4357 the wait is supposed to be short,
4358 and those callers cannot handle running arbitrary Lisp code here. */
4359 if (NILP (wait_for_cell)
4360 && just_wait_proc >= 0)
4362 struct timespec timer_delay;
4366 unsigned old_timers_run = timers_run;
4367 struct buffer *old_buffer = current_buffer;
4368 Lisp_Object old_window = selected_window;
4370 timer_delay = timer_check ();
4372 /* If a timer has run, this might have changed buffers
4373 an alike. Make read_key_sequence aware of that. */
4374 if (timers_run != old_timers_run
4375 && (old_buffer != current_buffer
4376 || !EQ (old_window, selected_window))
4377 && waiting_for_user_input_p == -1)
4378 record_asynch_buffer_change ();
4380 if (timers_run != old_timers_run && do_display)
4381 /* We must retry, since a timer may have requeued itself
4382 and that could alter the time_delay. */
4383 redisplay_preserve_echo_area (9);
4384 else
4385 break;
4387 while (!detect_input_pending ());
4389 /* If there is unread keyboard input, also return. */
4390 if (read_kbd != 0
4391 && requeued_events_pending_p ())
4392 break;
4394 /* A negative timeout means do not wait at all. */
4395 if (nsecs >= 0)
4397 if (timespec_valid_p (timer_delay))
4399 if (timespec_cmp (timer_delay, timeout) < 0)
4401 timeout = timer_delay;
4402 timeout_reduced_for_timers = 1;
4405 else
4407 /* This is so a breakpoint can be put here. */
4408 wait_reading_process_output_1 ();
4413 /* Cause C-g and alarm signals to take immediate action,
4414 and cause input available signals to zero out timeout.
4416 It is important that we do this before checking for process
4417 activity. If we get a SIGCHLD after the explicit checks for
4418 process activity, timeout is the only way we will know. */
4419 if (read_kbd < 0)
4420 set_waiting_for_input (&timeout);
4422 /* If status of something has changed, and no input is
4423 available, notify the user of the change right away. After
4424 this explicit check, we'll let the SIGCHLD handler zap
4425 timeout to get our attention. */
4426 if (update_tick != process_tick)
4428 fd_set Atemp;
4429 fd_set Ctemp;
4431 if (kbd_on_hold_p ())
4432 FD_ZERO (&Atemp);
4433 else
4434 Atemp = input_wait_mask;
4435 Ctemp = write_mask;
4437 timeout = make_timespec (0, 0);
4438 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4439 &Atemp,
4440 #ifdef NON_BLOCKING_CONNECT
4441 (num_pending_connects > 0 ? &Ctemp : NULL),
4442 #else
4443 NULL,
4444 #endif
4445 NULL, &timeout, NULL)
4446 <= 0))
4448 /* It's okay for us to do this and then continue with
4449 the loop, since timeout has already been zeroed out. */
4450 clear_waiting_for_input ();
4451 status_notify (NULL);
4452 if (do_display) redisplay_preserve_echo_area (13);
4456 /* Don't wait for output from a non-running process. Just
4457 read whatever data has already been received. */
4458 if (wait_proc && wait_proc->raw_status_new)
4459 update_status (wait_proc);
4460 if (wait_proc
4461 && ! EQ (wait_proc->status, Qrun)
4462 && ! EQ (wait_proc->status, Qconnect))
4464 bool read_some_bytes = 0;
4466 clear_waiting_for_input ();
4467 XSETPROCESS (proc, wait_proc);
4469 /* Read data from the process, until we exhaust it. */
4470 while (wait_proc->infd >= 0)
4472 int nread = read_process_output (proc, wait_proc->infd);
4474 if (nread == 0)
4475 break;
4477 if (nread > 0)
4478 got_some_input = read_some_bytes = 1;
4479 else if (nread == -1 && (errno == EIO || errno == EAGAIN))
4480 break;
4481 #ifdef EWOULDBLOCK
4482 else if (nread == -1 && EWOULDBLOCK == errno)
4483 break;
4484 #endif
4486 if (read_some_bytes && do_display)
4487 redisplay_preserve_echo_area (10);
4489 break;
4492 /* Wait till there is something to do */
4494 if (wait_proc && just_wait_proc)
4496 if (wait_proc->infd < 0) /* Terminated */
4497 break;
4498 FD_SET (wait_proc->infd, &Available);
4499 check_delay = 0;
4500 check_write = 0;
4502 else if (!NILP (wait_for_cell))
4504 Available = non_process_wait_mask;
4505 check_delay = 0;
4506 check_write = 0;
4508 else
4510 if (! read_kbd)
4511 Available = non_keyboard_wait_mask;
4512 else
4513 Available = input_wait_mask;
4514 Writeok = write_mask;
4515 #ifdef SELECT_CANT_DO_WRITE_MASK
4516 check_write = 0;
4517 #else
4518 check_write = 1;
4519 #endif
4520 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4523 /* If frame size has changed or the window is newly mapped,
4524 redisplay now, before we start to wait. There is a race
4525 condition here; if a SIGIO arrives between now and the select
4526 and indicates that a frame is trashed, the select may block
4527 displaying a trashed screen. */
4528 if (frame_garbaged && do_display)
4530 clear_waiting_for_input ();
4531 redisplay_preserve_echo_area (11);
4532 if (read_kbd < 0)
4533 set_waiting_for_input (&timeout);
4536 /* Skip the `select' call if input is available and we're
4537 waiting for keyboard input or a cell change (which can be
4538 triggered by processing X events). In the latter case, set
4539 nfds to 1 to avoid breaking the loop. */
4540 no_avail = 0;
4541 if ((read_kbd || !NILP (wait_for_cell))
4542 && detect_input_pending ())
4544 nfds = read_kbd ? 0 : 1;
4545 no_avail = 1;
4548 if (!no_avail)
4551 #ifdef ADAPTIVE_READ_BUFFERING
4552 /* Set the timeout for adaptive read buffering if any
4553 process has non-zero read_output_skip and non-zero
4554 read_output_delay, and we are not reading output for a
4555 specific wait_channel. It is not executed if
4556 Vprocess_adaptive_read_buffering is nil. */
4557 if (process_output_skip && check_delay > 0)
4559 int nsecs = timeout.tv_nsec;
4560 if (timeout.tv_sec > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4561 nsecs = READ_OUTPUT_DELAY_MAX;
4562 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4564 proc = chan_process[channel];
4565 if (NILP (proc))
4566 continue;
4567 /* Find minimum non-zero read_output_delay among the
4568 processes with non-zero read_output_skip. */
4569 if (XPROCESS (proc)->read_output_delay > 0)
4571 check_delay--;
4572 if (!XPROCESS (proc)->read_output_skip)
4573 continue;
4574 FD_CLR (channel, &Available);
4575 XPROCESS (proc)->read_output_skip = 0;
4576 if (XPROCESS (proc)->read_output_delay < nsecs)
4577 nsecs = XPROCESS (proc)->read_output_delay;
4580 timeout = make_timespec (0, nsecs);
4581 process_output_skip = 0;
4583 #endif
4585 #if defined (HAVE_NS)
4586 nfds = ns_select
4587 #elif defined (HAVE_GLIB)
4588 nfds = xg_select
4589 #else
4590 nfds = pselect
4591 #endif
4592 (max (max_process_desc, max_input_desc) + 1,
4593 &Available,
4594 (check_write ? &Writeok : 0),
4595 NULL, &timeout, NULL);
4597 #ifdef HAVE_GNUTLS
4598 /* GnuTLS buffers data internally. In lowat mode it leaves
4599 some data in the TCP buffers so that select works, but
4600 with custom pull/push functions we need to check if some
4601 data is available in the buffers manually. */
4602 if (nfds == 0)
4604 if (! wait_proc)
4606 /* We're not waiting on a specific process, so loop
4607 through all the channels and check for data.
4608 This is a workaround needed for some versions of
4609 the gnutls library -- 2.12.14 has been confirmed
4610 to need it. See
4611 http://comments.gmane.org/gmane.emacs.devel/145074 */
4612 for (channel = 0; channel < FD_SETSIZE; ++channel)
4613 if (! NILP (chan_process[channel]))
4615 struct Lisp_Process *p =
4616 XPROCESS (chan_process[channel]);
4617 if (p && p->gnutls_p && p->gnutls_state && p->infd
4618 && ((emacs_gnutls_record_check_pending
4619 (p->gnutls_state))
4620 > 0))
4622 nfds++;
4623 FD_SET (p->infd, &Available);
4627 else
4629 /* Check this specific channel. */
4630 if (wait_proc->gnutls_p /* Check for valid process. */
4631 && wait_proc->gnutls_state
4632 /* Do we have pending data? */
4633 && ((emacs_gnutls_record_check_pending
4634 (wait_proc->gnutls_state))
4635 > 0))
4637 nfds = 1;
4638 /* Set to Available. */
4639 FD_SET (wait_proc->infd, &Available);
4643 #endif
4646 xerrno = errno;
4648 /* Make C-g and alarm signals set flags again */
4649 clear_waiting_for_input ();
4651 /* If we woke up due to SIGWINCH, actually change size now. */
4652 do_pending_window_change (0);
4654 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4655 /* We waited the full specified time, so return now. */
4656 break;
4657 if (nfds < 0)
4659 if (xerrno == EINTR)
4660 no_avail = 1;
4661 else if (xerrno == EBADF)
4662 emacs_abort ();
4663 else
4664 report_file_errno ("Failed select", Qnil, xerrno);
4667 if (no_avail)
4669 FD_ZERO (&Available);
4670 check_write = 0;
4673 /* Check for keyboard input */
4674 /* If there is any, return immediately
4675 to give it higher priority than subprocesses */
4677 if (read_kbd != 0)
4679 unsigned old_timers_run = timers_run;
4680 struct buffer *old_buffer = current_buffer;
4681 Lisp_Object old_window = selected_window;
4682 bool leave = 0;
4684 if (detect_input_pending_run_timers (do_display))
4686 swallow_events (do_display);
4687 if (detect_input_pending_run_timers (do_display))
4688 leave = 1;
4691 /* If a timer has run, this might have changed buffers
4692 an alike. Make read_key_sequence aware of that. */
4693 if (timers_run != old_timers_run
4694 && waiting_for_user_input_p == -1
4695 && (old_buffer != current_buffer
4696 || !EQ (old_window, selected_window)))
4697 record_asynch_buffer_change ();
4699 if (leave)
4700 break;
4703 /* If there is unread keyboard input, also return. */
4704 if (read_kbd != 0
4705 && requeued_events_pending_p ())
4706 break;
4708 /* If we are not checking for keyboard input now,
4709 do process events (but don't run any timers).
4710 This is so that X events will be processed.
4711 Otherwise they may have to wait until polling takes place.
4712 That would causes delays in pasting selections, for example.
4714 (We used to do this only if wait_for_cell.) */
4715 if (read_kbd == 0 && detect_input_pending ())
4717 swallow_events (do_display);
4718 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4719 if (detect_input_pending ())
4720 break;
4721 #endif
4724 /* Exit now if the cell we're waiting for became non-nil. */
4725 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4726 break;
4728 #ifdef USABLE_SIGIO
4729 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4730 go read it. This can happen with X on BSD after logging out.
4731 In that case, there really is no input and no SIGIO,
4732 but select says there is input. */
4734 if (read_kbd && interrupt_input
4735 && keyboard_bit_set (&Available) && ! noninteractive)
4736 handle_input_available_signal (SIGIO);
4737 #endif
4739 if (! wait_proc)
4740 got_some_input |= nfds > 0;
4742 /* If checking input just got us a size-change event from X,
4743 obey it now if we should. */
4744 if (read_kbd || ! NILP (wait_for_cell))
4745 do_pending_window_change (0);
4747 /* Check for data from a process. */
4748 if (no_avail || nfds == 0)
4749 continue;
4751 for (channel = 0; channel <= max_input_desc; ++channel)
4753 struct fd_callback_data *d = &fd_callback_info[channel];
4754 if (d->func
4755 && ((d->condition & FOR_READ
4756 && FD_ISSET (channel, &Available))
4757 || (d->condition & FOR_WRITE
4758 && FD_ISSET (channel, &write_mask))))
4759 d->func (channel, d->data);
4762 for (channel = 0; channel <= max_process_desc; channel++)
4764 if (FD_ISSET (channel, &Available)
4765 && FD_ISSET (channel, &non_keyboard_wait_mask)
4766 && !FD_ISSET (channel, &non_process_wait_mask))
4768 int nread;
4770 /* If waiting for this channel, arrange to return as
4771 soon as no more input to be processed. No more
4772 waiting. */
4773 if (wait_channel == channel)
4775 wait_channel = -1;
4776 nsecs = -1;
4777 got_some_input = 1;
4779 proc = chan_process[channel];
4780 if (NILP (proc))
4781 continue;
4783 /* If this is a server stream socket, accept connection. */
4784 if (EQ (XPROCESS (proc)->status, Qlisten))
4786 server_accept_connection (proc, channel);
4787 continue;
4790 /* Read data from the process, starting with our
4791 buffered-ahead character if we have one. */
4793 nread = read_process_output (proc, channel);
4794 if (nread > 0)
4796 /* Since read_process_output can run a filter,
4797 which can call accept-process-output,
4798 don't try to read from any other processes
4799 before doing the select again. */
4800 FD_ZERO (&Available);
4802 if (do_display)
4803 redisplay_preserve_echo_area (12);
4805 #ifdef EWOULDBLOCK
4806 else if (nread == -1 && errno == EWOULDBLOCK)
4808 #endif
4809 else if (nread == -1 && errno == EAGAIN)
4811 #ifdef WINDOWSNT
4812 /* FIXME: Is this special case still needed? */
4813 /* Note that we cannot distinguish between no input
4814 available now and a closed pipe.
4815 With luck, a closed pipe will be accompanied by
4816 subprocess termination and SIGCHLD. */
4817 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4819 #endif
4820 #ifdef HAVE_PTYS
4821 /* On some OSs with ptys, when the process on one end of
4822 a pty exits, the other end gets an error reading with
4823 errno = EIO instead of getting an EOF (0 bytes read).
4824 Therefore, if we get an error reading and errno =
4825 EIO, just continue, because the child process has
4826 exited and should clean itself up soon (e.g. when we
4827 get a SIGCHLD). */
4828 else if (nread == -1 && errno == EIO)
4830 struct Lisp_Process *p = XPROCESS (proc);
4832 /* Clear the descriptor now, so we only raise the
4833 signal once. */
4834 FD_CLR (channel, &input_wait_mask);
4835 FD_CLR (channel, &non_keyboard_wait_mask);
4837 if (p->pid == -2)
4839 /* If the EIO occurs on a pty, the SIGCHLD handler's
4840 waitpid call will not find the process object to
4841 delete. Do it here. */
4842 p->tick = ++process_tick;
4843 pset_status (p, Qfailed);
4846 #endif /* HAVE_PTYS */
4847 /* If we can detect process termination, don't consider the
4848 process gone just because its pipe is closed. */
4849 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4851 else
4853 /* Preserve status of processes already terminated. */
4854 XPROCESS (proc)->tick = ++process_tick;
4855 deactivate_process (proc);
4856 if (XPROCESS (proc)->raw_status_new)
4857 update_status (XPROCESS (proc));
4858 if (EQ (XPROCESS (proc)->status, Qrun))
4859 pset_status (XPROCESS (proc),
4860 list2 (Qexit, make_number (256)));
4863 #ifdef NON_BLOCKING_CONNECT
4864 if (FD_ISSET (channel, &Writeok)
4865 && FD_ISSET (channel, &connect_wait_mask))
4867 struct Lisp_Process *p;
4869 FD_CLR (channel, &connect_wait_mask);
4870 FD_CLR (channel, &write_mask);
4871 if (--num_pending_connects < 0)
4872 emacs_abort ();
4874 proc = chan_process[channel];
4875 if (NILP (proc))
4876 continue;
4878 p = XPROCESS (proc);
4880 #ifdef GNU_LINUX
4881 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4882 So only use it on systems where it is known to work. */
4884 socklen_t xlen = sizeof (xerrno);
4885 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4886 xerrno = errno;
4888 #else
4890 struct sockaddr pname;
4891 socklen_t pnamelen = sizeof (pname);
4893 /* If connection failed, getpeername will fail. */
4894 xerrno = 0;
4895 if (getpeername (channel, &pname, &pnamelen) < 0)
4897 /* Obtain connect failure code through error slippage. */
4898 char dummy;
4899 xerrno = errno;
4900 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4901 xerrno = errno;
4904 #endif
4905 if (xerrno)
4907 p->tick = ++process_tick;
4908 pset_status (p, list2 (Qfailed, make_number (xerrno)));
4909 deactivate_process (proc);
4911 else
4913 pset_status (p, Qrun);
4914 /* Execute the sentinel here. If we had relied on
4915 status_notify to do it later, it will read input
4916 from the process before calling the sentinel. */
4917 exec_sentinel (proc, build_string ("open\n"));
4918 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
4920 FD_SET (p->infd, &input_wait_mask);
4921 FD_SET (p->infd, &non_keyboard_wait_mask);
4925 #endif /* NON_BLOCKING_CONNECT */
4926 } /* End for each file descriptor. */
4927 } /* End while exit conditions not met. */
4929 unbind_to (count, Qnil);
4931 /* If calling from keyboard input, do not quit
4932 since we want to return C-g as an input character.
4933 Otherwise, do pending quit if requested. */
4934 if (read_kbd >= 0)
4936 /* Prevent input_pending from remaining set if we quit. */
4937 clear_input_pending ();
4938 QUIT;
4941 return got_some_input;
4944 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
4946 static Lisp_Object
4947 read_process_output_call (Lisp_Object fun_and_args)
4949 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
4952 static Lisp_Object
4953 read_process_output_error_handler (Lisp_Object error_val)
4955 cmd_error_internal (error_val, "error in process filter: ");
4956 Vinhibit_quit = Qt;
4957 update_echo_area ();
4958 Fsleep_for (make_number (2), Qnil);
4959 return Qt;
4962 static void
4963 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
4964 ssize_t nbytes,
4965 struct coding_system *coding);
4967 /* Read pending output from the process channel,
4968 starting with our buffered-ahead character if we have one.
4969 Yield number of decoded characters read.
4971 This function reads at most 4096 characters.
4972 If you want to read all available subprocess output,
4973 you must call it repeatedly until it returns zero.
4975 The characters read are decoded according to PROC's coding-system
4976 for decoding. */
4978 static int
4979 read_process_output (Lisp_Object proc, register int channel)
4981 register ssize_t nbytes;
4982 char *chars;
4983 register struct Lisp_Process *p = XPROCESS (proc);
4984 struct coding_system *coding = proc_decode_coding_system[channel];
4985 int carryover = p->decoding_carryover;
4986 int readmax = 4096;
4987 ptrdiff_t count = SPECPDL_INDEX ();
4988 Lisp_Object odeactivate;
4990 chars = alloca (carryover + readmax);
4991 if (carryover)
4992 /* See the comment above. */
4993 memcpy (chars, SDATA (p->decoding_buf), carryover);
4995 #ifdef DATAGRAM_SOCKETS
4996 /* We have a working select, so proc_buffered_char is always -1. */
4997 if (DATAGRAM_CHAN_P (channel))
4999 socklen_t len = datagram_address[channel].len;
5000 nbytes = recvfrom (channel, chars + carryover, readmax,
5001 0, datagram_address[channel].sa, &len);
5003 else
5004 #endif
5006 bool buffered = proc_buffered_char[channel] >= 0;
5007 if (buffered)
5009 chars[carryover] = proc_buffered_char[channel];
5010 proc_buffered_char[channel] = -1;
5012 #ifdef HAVE_GNUTLS
5013 if (p->gnutls_p && p->gnutls_state)
5014 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
5015 readmax - buffered);
5016 else
5017 #endif
5018 nbytes = emacs_read (channel, chars + carryover + buffered,
5019 readmax - buffered);
5020 #ifdef ADAPTIVE_READ_BUFFERING
5021 if (nbytes > 0 && p->adaptive_read_buffering)
5023 int delay = p->read_output_delay;
5024 if (nbytes < 256)
5026 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5028 if (delay == 0)
5029 process_output_delay_count++;
5030 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5033 else if (delay > 0 && nbytes == readmax - buffered)
5035 delay -= READ_OUTPUT_DELAY_INCREMENT;
5036 if (delay == 0)
5037 process_output_delay_count--;
5039 p->read_output_delay = delay;
5040 if (delay)
5042 p->read_output_skip = 1;
5043 process_output_skip = 1;
5046 #endif
5047 nbytes += buffered;
5048 nbytes += buffered && nbytes <= 0;
5051 p->decoding_carryover = 0;
5053 /* At this point, NBYTES holds number of bytes just received
5054 (including the one in proc_buffered_char[channel]). */
5055 if (nbytes <= 0)
5057 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5058 return nbytes;
5059 coding->mode |= CODING_MODE_LAST_BLOCK;
5062 /* Now set NBYTES how many bytes we must decode. */
5063 nbytes += carryover;
5065 odeactivate = Vdeactivate_mark;
5066 /* There's no good reason to let process filters change the current
5067 buffer, and many callers of accept-process-output, sit-for, and
5068 friends don't expect current-buffer to be changed from under them. */
5069 record_unwind_current_buffer ();
5071 read_and_dispose_of_process_output (p, chars, nbytes, coding);
5073 /* Handling the process output should not deactivate the mark. */
5074 Vdeactivate_mark = odeactivate;
5076 unbind_to (count, Qnil);
5077 return nbytes;
5080 static void
5081 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5082 ssize_t nbytes,
5083 struct coding_system *coding)
5085 Lisp_Object outstream = p->filter;
5086 Lisp_Object text;
5087 bool outer_running_asynch_code = running_asynch_code;
5088 int waiting = waiting_for_user_input_p;
5090 /* No need to gcpro these, because all we do with them later
5091 is test them for EQness, and none of them should be a string. */
5092 #if 0
5093 Lisp_Object obuffer, okeymap;
5094 XSETBUFFER (obuffer, current_buffer);
5095 okeymap = BVAR (current_buffer, keymap);
5096 #endif
5098 /* We inhibit quit here instead of just catching it so that
5099 hitting ^G when a filter happens to be running won't screw
5100 it up. */
5101 specbind (Qinhibit_quit, Qt);
5102 specbind (Qlast_nonmenu_event, Qt);
5104 /* In case we get recursively called,
5105 and we already saved the match data nonrecursively,
5106 save the same match data in safely recursive fashion. */
5107 if (outer_running_asynch_code)
5109 Lisp_Object tem;
5110 /* Don't clobber the CURRENT match data, either! */
5111 tem = Fmatch_data (Qnil, Qnil, Qnil);
5112 restore_search_regs ();
5113 record_unwind_save_match_data ();
5114 Fset_match_data (tem, Qt);
5117 /* For speed, if a search happens within this code,
5118 save the match data in a special nonrecursive fashion. */
5119 running_asynch_code = 1;
5121 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5122 text = coding->dst_object;
5123 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5124 /* A new coding system might be found. */
5125 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5127 pset_decode_coding_system (p, Vlast_coding_system_used);
5129 /* Don't call setup_coding_system for
5130 proc_decode_coding_system[channel] here. It is done in
5131 detect_coding called via decode_coding above. */
5133 /* If a coding system for encoding is not yet decided, we set
5134 it as the same as coding-system for decoding.
5136 But, before doing that we must check if
5137 proc_encode_coding_system[p->outfd] surely points to a
5138 valid memory because p->outfd will be changed once EOF is
5139 sent to the process. */
5140 if (NILP (p->encode_coding_system)
5141 && proc_encode_coding_system[p->outfd])
5143 pset_encode_coding_system
5144 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5145 setup_coding_system (p->encode_coding_system,
5146 proc_encode_coding_system[p->outfd]);
5150 if (coding->carryover_bytes > 0)
5152 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5153 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5154 memcpy (SDATA (p->decoding_buf), coding->carryover,
5155 coding->carryover_bytes);
5156 p->decoding_carryover = coding->carryover_bytes;
5158 if (SBYTES (text) > 0)
5159 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5160 sometimes it's simply wrong to wrap (e.g. when called from
5161 accept-process-output). */
5162 internal_condition_case_1 (read_process_output_call,
5163 list3 (outstream, make_lisp_proc (p), text),
5164 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5165 read_process_output_error_handler);
5167 /* If we saved the match data nonrecursively, restore it now. */
5168 restore_search_regs ();
5169 running_asynch_code = outer_running_asynch_code;
5171 /* Restore waiting_for_user_input_p as it was
5172 when we were called, in case the filter clobbered it. */
5173 waiting_for_user_input_p = waiting;
5175 #if 0 /* Call record_asynch_buffer_change unconditionally,
5176 because we might have changed minor modes or other things
5177 that affect key bindings. */
5178 if (! EQ (Fcurrent_buffer (), obuffer)
5179 || ! EQ (current_buffer->keymap, okeymap))
5180 #endif
5181 /* But do it only if the caller is actually going to read events.
5182 Otherwise there's no need to make him wake up, and it could
5183 cause trouble (for example it would make sit_for return). */
5184 if (waiting_for_user_input_p == -1)
5185 record_asynch_buffer_change ();
5188 DEFUN ("internal-default-process-filter", Finternal_default_process_filter,
5189 Sinternal_default_process_filter, 2, 2, 0,
5190 doc: /* Function used as default process filter.
5191 This inserts the process's output into its buffer, if there is one.
5192 Otherwise it discards the output. */)
5193 (Lisp_Object proc, Lisp_Object text)
5195 struct Lisp_Process *p;
5196 ptrdiff_t opoint;
5198 CHECK_PROCESS (proc);
5199 p = XPROCESS (proc);
5200 CHECK_STRING (text);
5202 if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5204 Lisp_Object old_read_only;
5205 ptrdiff_t old_begv, old_zv;
5206 ptrdiff_t old_begv_byte, old_zv_byte;
5207 ptrdiff_t before, before_byte;
5208 ptrdiff_t opoint_byte;
5209 struct buffer *b;
5211 Fset_buffer (p->buffer);
5212 opoint = PT;
5213 opoint_byte = PT_BYTE;
5214 old_read_only = BVAR (current_buffer, read_only);
5215 old_begv = BEGV;
5216 old_zv = ZV;
5217 old_begv_byte = BEGV_BYTE;
5218 old_zv_byte = ZV_BYTE;
5220 bset_read_only (current_buffer, Qnil);
5222 /* Insert new output into buffer at the current end-of-output
5223 marker, thus preserving logical ordering of input and output. */
5224 if (XMARKER (p->mark)->buffer)
5225 set_point_from_marker (p->mark);
5226 else
5227 SET_PT_BOTH (ZV, ZV_BYTE);
5228 before = PT;
5229 before_byte = PT_BYTE;
5231 /* If the output marker is outside of the visible region, save
5232 the restriction and widen. */
5233 if (! (BEGV <= PT && PT <= ZV))
5234 Fwiden ();
5236 /* Adjust the multibyteness of TEXT to that of the buffer. */
5237 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5238 != ! STRING_MULTIBYTE (text))
5239 text = (STRING_MULTIBYTE (text)
5240 ? Fstring_as_unibyte (text)
5241 : Fstring_to_multibyte (text));
5242 /* Insert before markers in case we are inserting where
5243 the buffer's mark is, and the user's next command is Meta-y. */
5244 insert_from_string_before_markers (text, 0, 0,
5245 SCHARS (text), SBYTES (text), 0);
5247 /* Make sure the process marker's position is valid when the
5248 process buffer is changed in the signal_after_change above.
5249 W3 is known to do that. */
5250 if (BUFFERP (p->buffer)
5251 && (b = XBUFFER (p->buffer), b != current_buffer))
5252 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5253 else
5254 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5256 update_mode_lines = 23;
5258 /* Make sure opoint and the old restrictions
5259 float ahead of any new text just as point would. */
5260 if (opoint >= before)
5262 opoint += PT - before;
5263 opoint_byte += PT_BYTE - before_byte;
5265 if (old_begv > before)
5267 old_begv += PT - before;
5268 old_begv_byte += PT_BYTE - before_byte;
5270 if (old_zv >= before)
5272 old_zv += PT - before;
5273 old_zv_byte += PT_BYTE - before_byte;
5276 /* If the restriction isn't what it should be, set it. */
5277 if (old_begv != BEGV || old_zv != ZV)
5278 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5280 bset_read_only (current_buffer, old_read_only);
5281 SET_PT_BOTH (opoint, opoint_byte);
5283 return Qnil;
5286 /* Sending data to subprocess. */
5288 /* In send_process, when a write fails temporarily,
5289 wait_reading_process_output is called. It may execute user code,
5290 e.g. timers, that attempts to write new data to the same process.
5291 We must ensure that data is sent in the right order, and not
5292 interspersed half-completed with other writes (Bug#10815). This is
5293 handled by the write_queue element of struct process. It is a list
5294 with each entry having the form
5296 (string . (offset . length))
5298 where STRING is a lisp string, OFFSET is the offset into the
5299 string's byte sequence from which we should begin to send, and
5300 LENGTH is the number of bytes left to send. */
5302 /* Create a new entry in write_queue.
5303 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5304 BUF is a pointer to the string sequence of the input_obj or a C
5305 string in case of Qt or Qnil. */
5307 static void
5308 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5309 const char *buf, ptrdiff_t len, bool front)
5311 ptrdiff_t offset;
5312 Lisp_Object entry, obj;
5314 if (STRINGP (input_obj))
5316 offset = buf - SSDATA (input_obj);
5317 obj = input_obj;
5319 else
5321 offset = 0;
5322 obj = make_unibyte_string (buf, len);
5325 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5327 if (front)
5328 pset_write_queue (p, Fcons (entry, p->write_queue));
5329 else
5330 pset_write_queue (p, nconc2 (p->write_queue, list1 (entry)));
5333 /* Remove the first element in the write_queue of process P, put its
5334 contents in OBJ, BUF and LEN, and return true. If the
5335 write_queue is empty, return false. */
5337 static bool
5338 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5339 const char **buf, ptrdiff_t *len)
5341 Lisp_Object entry, offset_length;
5342 ptrdiff_t offset;
5344 if (NILP (p->write_queue))
5345 return 0;
5347 entry = XCAR (p->write_queue);
5348 pset_write_queue (p, XCDR (p->write_queue));
5350 *obj = XCAR (entry);
5351 offset_length = XCDR (entry);
5353 *len = XINT (XCDR (offset_length));
5354 offset = XINT (XCAR (offset_length));
5355 *buf = SSDATA (*obj) + offset;
5357 return 1;
5360 /* Send some data to process PROC.
5361 BUF is the beginning of the data; LEN is the number of characters.
5362 OBJECT is the Lisp object that the data comes from. If OBJECT is
5363 nil or t, it means that the data comes from C string.
5365 If OBJECT is not nil, the data is encoded by PROC's coding-system
5366 for encoding before it is sent.
5368 This function can evaluate Lisp code and can garbage collect. */
5370 static void
5371 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
5372 Lisp_Object object)
5374 struct Lisp_Process *p = XPROCESS (proc);
5375 ssize_t rv;
5376 struct coding_system *coding;
5378 if (p->raw_status_new)
5379 update_status (p);
5380 if (! EQ (p->status, Qrun))
5381 error ("Process %s not running", SDATA (p->name));
5382 if (p->outfd < 0)
5383 error ("Output file descriptor of %s is closed", SDATA (p->name));
5385 coding = proc_encode_coding_system[p->outfd];
5386 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5388 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5389 || (BUFFERP (object)
5390 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5391 || EQ (object, Qt))
5393 pset_encode_coding_system
5394 (p, complement_process_encoding_system (p->encode_coding_system));
5395 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5397 /* The coding system for encoding was changed to raw-text
5398 because we sent a unibyte text previously. Now we are
5399 sending a multibyte text, thus we must encode it by the
5400 original coding system specified for the current process.
5402 Another reason we come here is that the coding system
5403 was just complemented and a new one was returned by
5404 complement_process_encoding_system. */
5405 setup_coding_system (p->encode_coding_system, coding);
5406 Vlast_coding_system_used = p->encode_coding_system;
5408 coding->src_multibyte = 1;
5410 else
5412 coding->src_multibyte = 0;
5413 /* For sending a unibyte text, character code conversion should
5414 not take place but EOL conversion should. So, setup raw-text
5415 or one of the subsidiary if we have not yet done it. */
5416 if (CODING_REQUIRE_ENCODING (coding))
5418 if (CODING_REQUIRE_FLUSHING (coding))
5420 /* But, before changing the coding, we must flush out data. */
5421 coding->mode |= CODING_MODE_LAST_BLOCK;
5422 send_process (proc, "", 0, Qt);
5423 coding->mode &= CODING_MODE_LAST_BLOCK;
5425 setup_coding_system (raw_text_coding_system
5426 (Vlast_coding_system_used),
5427 coding);
5428 coding->src_multibyte = 0;
5431 coding->dst_multibyte = 0;
5433 if (CODING_REQUIRE_ENCODING (coding))
5435 coding->dst_object = Qt;
5436 if (BUFFERP (object))
5438 ptrdiff_t from_byte, from, to;
5439 ptrdiff_t save_pt, save_pt_byte;
5440 struct buffer *cur = current_buffer;
5442 set_buffer_internal (XBUFFER (object));
5443 save_pt = PT, save_pt_byte = PT_BYTE;
5445 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5446 from = BYTE_TO_CHAR (from_byte);
5447 to = BYTE_TO_CHAR (from_byte + len);
5448 TEMP_SET_PT_BOTH (from, from_byte);
5449 encode_coding_object (coding, object, from, from_byte,
5450 to, from_byte + len, Qt);
5451 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5452 set_buffer_internal (cur);
5454 else if (STRINGP (object))
5456 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5457 SBYTES (object), Qt);
5459 else
5461 coding->dst_object = make_unibyte_string (buf, len);
5462 coding->produced = len;
5465 len = coding->produced;
5466 object = coding->dst_object;
5467 buf = SSDATA (object);
5470 /* If there is already data in the write_queue, put the new data
5471 in the back of queue. Otherwise, ignore it. */
5472 if (!NILP (p->write_queue))
5473 write_queue_push (p, object, buf, len, 0);
5475 do /* while !NILP (p->write_queue) */
5477 ptrdiff_t cur_len = -1;
5478 const char *cur_buf;
5479 Lisp_Object cur_object;
5481 /* If write_queue is empty, ignore it. */
5482 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5484 cur_len = len;
5485 cur_buf = buf;
5486 cur_object = object;
5489 while (cur_len > 0)
5491 /* Send this batch, using one or more write calls. */
5492 ptrdiff_t written = 0;
5493 int outfd = p->outfd;
5494 #ifdef DATAGRAM_SOCKETS
5495 if (DATAGRAM_CHAN_P (outfd))
5497 rv = sendto (outfd, cur_buf, cur_len,
5498 0, datagram_address[outfd].sa,
5499 datagram_address[outfd].len);
5500 if (rv >= 0)
5501 written = rv;
5502 else if (errno == EMSGSIZE)
5503 report_file_error ("Sending datagram", proc);
5505 else
5506 #endif
5508 #ifdef HAVE_GNUTLS
5509 if (p->gnutls_p && p->gnutls_state)
5510 written = emacs_gnutls_write (p, cur_buf, cur_len);
5511 else
5512 #endif
5513 written = emacs_write_sig (outfd, cur_buf, cur_len);
5514 rv = (written ? 0 : -1);
5515 #ifdef ADAPTIVE_READ_BUFFERING
5516 if (p->read_output_delay > 0
5517 && p->adaptive_read_buffering == 1)
5519 p->read_output_delay = 0;
5520 process_output_delay_count--;
5521 p->read_output_skip = 0;
5523 #endif
5526 if (rv < 0)
5528 if (errno == EAGAIN
5529 #ifdef EWOULDBLOCK
5530 || errno == EWOULDBLOCK
5531 #endif
5533 /* Buffer is full. Wait, accepting input;
5534 that may allow the program
5535 to finish doing output and read more. */
5537 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5538 /* A gross hack to work around a bug in FreeBSD.
5539 In the following sequence, read(2) returns
5540 bogus data:
5542 write(2) 1022 bytes
5543 write(2) 954 bytes, get EAGAIN
5544 read(2) 1024 bytes in process_read_output
5545 read(2) 11 bytes in process_read_output
5547 That is, read(2) returns more bytes than have
5548 ever been written successfully. The 1033 bytes
5549 read are the 1022 bytes written successfully
5550 after processing (for example with CRs added if
5551 the terminal is set up that way which it is
5552 here). The same bytes will be seen again in a
5553 later read(2), without the CRs. */
5555 if (errno == EAGAIN)
5557 int flags = FWRITE;
5558 ioctl (p->outfd, TIOCFLUSH, &flags);
5560 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5562 /* Put what we should have written in wait_queue. */
5563 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5564 wait_reading_process_output (0, 20 * 1000 * 1000,
5565 0, 0, Qnil, NULL, 0);
5566 /* Reread queue, to see what is left. */
5567 break;
5569 else if (errno == EPIPE)
5571 p->raw_status_new = 0;
5572 pset_status (p, list2 (Qexit, make_number (256)));
5573 p->tick = ++process_tick;
5574 deactivate_process (proc);
5575 error ("process %s no longer connected to pipe; closed it",
5576 SDATA (p->name));
5578 else
5579 /* This is a real error. */
5580 report_file_error ("Writing to process", proc);
5582 cur_buf += written;
5583 cur_len -= written;
5586 while (!NILP (p->write_queue));
5589 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5590 3, 3, 0,
5591 doc: /* Send current contents of region as input to PROCESS.
5592 PROCESS may be a process, a buffer, the name of a process or buffer, or
5593 nil, indicating the current buffer's process.
5594 Called from program, takes three arguments, PROCESS, START and END.
5595 If the region is more than 500 characters long,
5596 it is sent in several bunches. This may happen even for shorter regions.
5597 Output from processes can arrive in between bunches. */)
5598 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5600 Lisp_Object proc = get_process (process);
5601 ptrdiff_t start_byte, end_byte;
5603 validate_region (&start, &end);
5605 start_byte = CHAR_TO_BYTE (XINT (start));
5606 end_byte = CHAR_TO_BYTE (XINT (end));
5608 if (XINT (start) < GPT && XINT (end) > GPT)
5609 move_gap_both (XINT (start), start_byte);
5611 send_process (proc, (char *) BYTE_POS_ADDR (start_byte),
5612 end_byte - start_byte, Fcurrent_buffer ());
5614 return Qnil;
5617 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5618 2, 2, 0,
5619 doc: /* Send PROCESS the contents of STRING as input.
5620 PROCESS may be a process, a buffer, the name of a process or buffer, or
5621 nil, indicating the current buffer's process.
5622 If STRING is more than 500 characters long,
5623 it is sent in several bunches. This may happen even for shorter strings.
5624 Output from processes can arrive in between bunches. */)
5625 (Lisp_Object process, Lisp_Object string)
5627 Lisp_Object proc;
5628 CHECK_STRING (string);
5629 proc = get_process (process);
5630 send_process (proc, SSDATA (string),
5631 SBYTES (string), string);
5632 return Qnil;
5635 /* Return the foreground process group for the tty/pty that
5636 the process P uses. */
5637 static pid_t
5638 emacs_get_tty_pgrp (struct Lisp_Process *p)
5640 pid_t gid = -1;
5642 #ifdef TIOCGPGRP
5643 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5645 int fd;
5646 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5647 master side. Try the slave side. */
5648 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5650 if (fd != -1)
5652 ioctl (fd, TIOCGPGRP, &gid);
5653 emacs_close (fd);
5656 #endif /* defined (TIOCGPGRP ) */
5658 return gid;
5661 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5662 Sprocess_running_child_p, 0, 1, 0,
5663 doc: /* Return t if PROCESS has given the terminal to a child.
5664 If the operating system does not make it possible to find out,
5665 return t unconditionally. */)
5666 (Lisp_Object process)
5668 /* Initialize in case ioctl doesn't exist or gives an error,
5669 in a way that will cause returning t. */
5670 pid_t gid;
5671 Lisp_Object proc;
5672 struct Lisp_Process *p;
5674 proc = get_process (process);
5675 p = XPROCESS (proc);
5677 if (!EQ (p->type, Qreal))
5678 error ("Process %s is not a subprocess",
5679 SDATA (p->name));
5680 if (p->infd < 0)
5681 error ("Process %s is not active",
5682 SDATA (p->name));
5684 gid = emacs_get_tty_pgrp (p);
5686 if (gid == p->pid)
5687 return Qnil;
5688 return Qt;
5691 /* send a signal number SIGNO to PROCESS.
5692 If CURRENT_GROUP is t, that means send to the process group
5693 that currently owns the terminal being used to communicate with PROCESS.
5694 This is used for various commands in shell mode.
5695 If CURRENT_GROUP is lambda, that means send to the process group
5696 that currently owns the terminal, but only if it is NOT the shell itself.
5698 If NOMSG is false, insert signal-announcements into process's buffers
5699 right away.
5701 If we can, we try to signal PROCESS by sending control characters
5702 down the pty. This allows us to signal inferiors who have changed
5703 their uid, for which kill would return an EPERM error. */
5705 static void
5706 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5707 bool nomsg)
5709 Lisp_Object proc;
5710 struct Lisp_Process *p;
5711 pid_t gid;
5712 bool no_pgrp = 0;
5714 proc = get_process (process);
5715 p = XPROCESS (proc);
5717 if (!EQ (p->type, Qreal))
5718 error ("Process %s is not a subprocess",
5719 SDATA (p->name));
5720 if (p->infd < 0)
5721 error ("Process %s is not active",
5722 SDATA (p->name));
5724 if (!p->pty_flag)
5725 current_group = Qnil;
5727 /* If we are using pgrps, get a pgrp number and make it negative. */
5728 if (NILP (current_group))
5729 /* Send the signal to the shell's process group. */
5730 gid = p->pid;
5731 else
5733 #ifdef SIGNALS_VIA_CHARACTERS
5734 /* If possible, send signals to the entire pgrp
5735 by sending an input character to it. */
5737 struct termios t;
5738 cc_t *sig_char = NULL;
5740 tcgetattr (p->infd, &t);
5742 switch (signo)
5744 case SIGINT:
5745 sig_char = &t.c_cc[VINTR];
5746 break;
5748 case SIGQUIT:
5749 sig_char = &t.c_cc[VQUIT];
5750 break;
5752 case SIGTSTP:
5753 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5754 sig_char = &t.c_cc[VSWTCH];
5755 #else
5756 sig_char = &t.c_cc[VSUSP];
5757 #endif
5758 break;
5761 if (sig_char && *sig_char != CDISABLE)
5763 send_process (proc, (char *) sig_char, 1, Qnil);
5764 return;
5766 /* If we can't send the signal with a character,
5767 fall through and send it another way. */
5769 /* The code above may fall through if it can't
5770 handle the signal. */
5771 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5773 #ifdef TIOCGPGRP
5774 /* Get the current pgrp using the tty itself, if we have that.
5775 Otherwise, use the pty to get the pgrp.
5776 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5777 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5778 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5779 His patch indicates that if TIOCGPGRP returns an error, then
5780 we should just assume that p->pid is also the process group id. */
5782 gid = emacs_get_tty_pgrp (p);
5784 if (gid == -1)
5785 /* If we can't get the information, assume
5786 the shell owns the tty. */
5787 gid = p->pid;
5789 /* It is not clear whether anything really can set GID to -1.
5790 Perhaps on some system one of those ioctls can or could do so.
5791 Or perhaps this is vestigial. */
5792 if (gid == -1)
5793 no_pgrp = 1;
5794 #else /* ! defined (TIOCGPGRP ) */
5795 /* Can't select pgrps on this system, so we know that
5796 the child itself heads the pgrp. */
5797 gid = p->pid;
5798 #endif /* ! defined (TIOCGPGRP ) */
5800 /* If current_group is lambda, and the shell owns the terminal,
5801 don't send any signal. */
5802 if (EQ (current_group, Qlambda) && gid == p->pid)
5803 return;
5806 #ifdef SIGCONT
5807 if (signo == SIGCONT)
5809 p->raw_status_new = 0;
5810 pset_status (p, Qrun);
5811 p->tick = ++process_tick;
5812 if (!nomsg)
5814 status_notify (NULL);
5815 redisplay_preserve_echo_area (13);
5818 #endif
5820 /* If we don't have process groups, send the signal to the immediate
5821 subprocess. That isn't really right, but it's better than any
5822 obvious alternative. */
5823 if (no_pgrp)
5825 kill (p->pid, signo);
5826 return;
5829 /* gid may be a pid, or minus a pgrp's number */
5830 #ifdef TIOCSIGSEND
5831 if (!NILP (current_group))
5833 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5834 kill (-gid, signo);
5836 else
5838 gid = - p->pid;
5839 kill (gid, signo);
5841 #else /* ! defined (TIOCSIGSEND) */
5842 kill (-gid, signo);
5843 #endif /* ! defined (TIOCSIGSEND) */
5846 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5847 doc: /* Interrupt process PROCESS.
5848 PROCESS may be a process, a buffer, or the name of a process or buffer.
5849 No arg or nil means current buffer's process.
5850 Second arg CURRENT-GROUP non-nil means send signal to
5851 the current process-group of the process's controlling terminal
5852 rather than to the process's own process group.
5853 If the process is a shell, this means interrupt current subjob
5854 rather than the shell.
5856 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5857 don't send the signal. */)
5858 (Lisp_Object process, Lisp_Object current_group)
5860 process_send_signal (process, SIGINT, current_group, 0);
5861 return process;
5864 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5865 doc: /* Kill process PROCESS. May be process or name of one.
5866 See function `interrupt-process' for more details on usage. */)
5867 (Lisp_Object process, Lisp_Object current_group)
5869 process_send_signal (process, SIGKILL, current_group, 0);
5870 return process;
5873 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5874 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5875 See function `interrupt-process' for more details on usage. */)
5876 (Lisp_Object process, Lisp_Object current_group)
5878 process_send_signal (process, SIGQUIT, current_group, 0);
5879 return process;
5882 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
5883 doc: /* Stop process PROCESS. May be process or name of one.
5884 See function `interrupt-process' for more details on usage.
5885 If PROCESS is a network or serial process, inhibit handling of incoming
5886 traffic. */)
5887 (Lisp_Object process, Lisp_Object current_group)
5889 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5891 struct Lisp_Process *p;
5893 p = XPROCESS (process);
5894 if (NILP (p->command)
5895 && p->infd >= 0)
5897 FD_CLR (p->infd, &input_wait_mask);
5898 FD_CLR (p->infd, &non_keyboard_wait_mask);
5900 pset_command (p, Qt);
5901 return process;
5903 #ifndef SIGTSTP
5904 error ("No SIGTSTP support");
5905 #else
5906 process_send_signal (process, SIGTSTP, current_group, 0);
5907 #endif
5908 return process;
5911 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
5912 doc: /* Continue process PROCESS. May be process or name of one.
5913 See function `interrupt-process' for more details on usage.
5914 If PROCESS is a network or serial process, resume handling of incoming
5915 traffic. */)
5916 (Lisp_Object process, Lisp_Object current_group)
5918 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5920 struct Lisp_Process *p;
5922 p = XPROCESS (process);
5923 if (EQ (p->command, Qt)
5924 && p->infd >= 0
5925 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
5927 FD_SET (p->infd, &input_wait_mask);
5928 FD_SET (p->infd, &non_keyboard_wait_mask);
5929 #ifdef WINDOWSNT
5930 if (fd_info[ p->infd ].flags & FILE_SERIAL)
5931 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
5932 #else /* not WINDOWSNT */
5933 tcflush (p->infd, TCIFLUSH);
5934 #endif /* not WINDOWSNT */
5936 pset_command (p, Qnil);
5937 return process;
5939 #ifdef SIGCONT
5940 process_send_signal (process, SIGCONT, current_group, 0);
5941 #else
5942 error ("No SIGCONT support");
5943 #endif
5944 return process;
5947 /* Return the integer value of the signal whose abbreviation is ABBR,
5948 or a negative number if there is no such signal. */
5949 static int
5950 abbr_to_signal (char const *name)
5952 int i, signo;
5953 char sigbuf[20]; /* Large enough for all valid signal abbreviations. */
5955 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
5956 name += 3;
5958 for (i = 0; i < sizeof sigbuf; i++)
5960 sigbuf[i] = c_toupper (name[i]);
5961 if (! sigbuf[i])
5962 return str2sig (sigbuf, &signo) == 0 ? signo : -1;
5965 return -1;
5968 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
5969 2, 2, "sProcess (name or number): \nnSignal code: ",
5970 doc: /* Send PROCESS the signal with code SIGCODE.
5971 PROCESS may also be a number specifying the process id of the
5972 process to signal; in this case, the process need not be a child of
5973 this Emacs.
5974 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
5975 (Lisp_Object process, Lisp_Object sigcode)
5977 pid_t pid;
5978 int signo;
5980 if (STRINGP (process))
5982 Lisp_Object tem = Fget_process (process);
5983 if (NILP (tem))
5985 Lisp_Object process_number =
5986 string_to_number (SSDATA (process), 10, 1);
5987 if (INTEGERP (process_number) || FLOATP (process_number))
5988 tem = process_number;
5990 process = tem;
5992 else if (!NUMBERP (process))
5993 process = get_process (process);
5995 if (NILP (process))
5996 return process;
5998 if (NUMBERP (process))
5999 CONS_TO_INTEGER (process, pid_t, pid);
6000 else
6002 CHECK_PROCESS (process);
6003 pid = XPROCESS (process)->pid;
6004 if (pid <= 0)
6005 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
6008 if (INTEGERP (sigcode))
6010 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
6011 signo = XINT (sigcode);
6013 else
6015 char *name;
6017 CHECK_SYMBOL (sigcode);
6018 name = SSDATA (SYMBOL_NAME (sigcode));
6020 signo = abbr_to_signal (name);
6021 if (signo < 0)
6022 error ("Undefined signal name %s", name);
6025 return make_number (kill (pid, signo));
6028 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6029 doc: /* Make PROCESS see end-of-file in its input.
6030 EOF comes after any text already sent to it.
6031 PROCESS may be a process, a buffer, the name of a process or buffer, or
6032 nil, indicating the current buffer's process.
6033 If PROCESS is a network connection, or is a process communicating
6034 through a pipe (as opposed to a pty), then you cannot send any more
6035 text to PROCESS after you call this function.
6036 If PROCESS is a serial process, wait until all output written to the
6037 process has been transmitted to the serial port. */)
6038 (Lisp_Object process)
6040 Lisp_Object proc;
6041 struct coding_system *coding = NULL;
6042 int outfd;
6044 if (DATAGRAM_CONN_P (process))
6045 return process;
6047 proc = get_process (process);
6048 outfd = XPROCESS (proc)->outfd;
6049 if (outfd >= 0)
6050 coding = proc_encode_coding_system[outfd];
6052 /* Make sure the process is really alive. */
6053 if (XPROCESS (proc)->raw_status_new)
6054 update_status (XPROCESS (proc));
6055 if (! EQ (XPROCESS (proc)->status, Qrun))
6056 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6058 if (coding && CODING_REQUIRE_FLUSHING (coding))
6060 coding->mode |= CODING_MODE_LAST_BLOCK;
6061 send_process (proc, "", 0, Qnil);
6064 if (XPROCESS (proc)->pty_flag)
6065 send_process (proc, "\004", 1, Qnil);
6066 else if (EQ (XPROCESS (proc)->type, Qserial))
6068 #ifndef WINDOWSNT
6069 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6070 report_file_error ("Failed tcdrain", Qnil);
6071 #endif /* not WINDOWSNT */
6072 /* Do nothing on Windows because writes are blocking. */
6074 else
6076 struct Lisp_Process *p = XPROCESS (proc);
6077 int old_outfd = p->outfd;
6078 int new_outfd;
6080 #ifdef HAVE_SHUTDOWN
6081 /* If this is a network connection, or socketpair is used
6082 for communication with the subprocess, call shutdown to cause EOF.
6083 (In some old system, shutdown to socketpair doesn't work.
6084 Then we just can't win.) */
6085 if (EQ (p->type, Qnetwork)
6086 || p->infd == old_outfd)
6087 shutdown (old_outfd, 1);
6088 #endif
6089 close_process_fd (&p->open_fd[WRITE_TO_SUBPROCESS]);
6090 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6091 if (new_outfd < 0)
6092 report_file_error ("Opening null device", Qnil);
6093 p->open_fd[WRITE_TO_SUBPROCESS] = new_outfd;
6094 p->outfd = new_outfd;
6096 if (!proc_encode_coding_system[new_outfd])
6097 proc_encode_coding_system[new_outfd]
6098 = xmalloc (sizeof (struct coding_system));
6099 if (old_outfd >= 0)
6101 *proc_encode_coding_system[new_outfd]
6102 = *proc_encode_coding_system[old_outfd];
6103 memset (proc_encode_coding_system[old_outfd], 0,
6104 sizeof (struct coding_system));
6106 else
6107 setup_coding_system (p->encode_coding_system,
6108 proc_encode_coding_system[new_outfd]);
6110 return process;
6113 /* The main Emacs thread records child processes in three places:
6115 - Vprocess_alist, for asynchronous subprocesses, which are child
6116 processes visible to Lisp.
6118 - deleted_pid_list, for child processes invisible to Lisp,
6119 typically because of delete-process. These are recorded so that
6120 the processes can be reaped when they exit, so that the operating
6121 system's process table is not cluttered by zombies.
6123 - the local variable PID in Fcall_process, call_process_cleanup and
6124 call_process_kill, for synchronous subprocesses.
6125 record_unwind_protect is used to make sure this process is not
6126 forgotten: if the user interrupts call-process and the child
6127 process refuses to exit immediately even with two C-g's,
6128 call_process_kill adds PID's contents to deleted_pid_list before
6129 returning.
6131 The main Emacs thread invokes waitpid only on child processes that
6132 it creates and that have not been reaped. This avoid races on
6133 platforms such as GTK, where other threads create their own
6134 subprocesses which the main thread should not reap. For example,
6135 if the main thread attempted to reap an already-reaped child, it
6136 might inadvertently reap a GTK-created process that happened to
6137 have the same process ID. */
6139 /* LIB_CHILD_HANDLER is a SIGCHLD handler that Emacs calls while doing
6140 its own SIGCHLD handling. On POSIXish systems, glib needs this to
6141 keep track of its own children. GNUstep is similar. */
6143 static void dummy_handler (int sig) {}
6144 static signal_handler_t volatile lib_child_handler;
6146 /* Handle a SIGCHLD signal by looking for known child processes of
6147 Emacs whose status have changed. For each one found, record its
6148 new status.
6150 All we do is change the status; we do not run sentinels or print
6151 notifications. That is saved for the next time keyboard input is
6152 done, in order to avoid timing errors.
6154 ** WARNING: this can be called during garbage collection.
6155 Therefore, it must not be fooled by the presence of mark bits in
6156 Lisp objects.
6158 ** USG WARNING: Although it is not obvious from the documentation
6159 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6160 signal() before executing at least one wait(), otherwise the
6161 handler will be called again, resulting in an infinite loop. The
6162 relevant portion of the documentation reads "SIGCLD signals will be
6163 queued and the signal-catching function will be continually
6164 reentered until the queue is empty". Invoking signal() causes the
6165 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6166 Inc.
6168 ** Malloc WARNING: This should never call malloc either directly or
6169 indirectly; if it does, that is a bug */
6171 static void
6172 handle_child_signal (int sig)
6174 Lisp_Object tail, proc;
6176 /* Find the process that signaled us, and record its status. */
6178 /* The process can have been deleted by Fdelete_process, or have
6179 been started asynchronously by Fcall_process. */
6180 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6182 bool all_pids_are_fixnums
6183 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
6184 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
6185 Lisp_Object head = XCAR (tail);
6186 Lisp_Object xpid;
6187 if (! CONSP (head))
6188 continue;
6189 xpid = XCAR (head);
6190 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
6192 pid_t deleted_pid;
6193 if (INTEGERP (xpid))
6194 deleted_pid = XINT (xpid);
6195 else
6196 deleted_pid = XFLOAT_DATA (xpid);
6197 if (child_status_changed (deleted_pid, 0, 0))
6199 if (STRINGP (XCDR (head)))
6200 unlink (SSDATA (XCDR (head)));
6201 XSETCAR (tail, Qnil);
6206 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6207 FOR_EACH_PROCESS (tail, proc)
6209 struct Lisp_Process *p = XPROCESS (proc);
6210 int status;
6212 if (p->alive
6213 && child_status_changed (p->pid, &status, WUNTRACED | WCONTINUED))
6215 /* Change the status of the process that was found. */
6216 p->tick = ++process_tick;
6217 p->raw_status = status;
6218 p->raw_status_new = 1;
6220 /* If process has terminated, stop waiting for its output. */
6221 if (WIFSIGNALED (status) || WIFEXITED (status))
6223 bool clear_desc_flag = 0;
6224 p->alive = 0;
6225 if (p->infd >= 0)
6226 clear_desc_flag = 1;
6228 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
6229 if (clear_desc_flag)
6231 FD_CLR (p->infd, &input_wait_mask);
6232 FD_CLR (p->infd, &non_keyboard_wait_mask);
6238 lib_child_handler (sig);
6239 #ifdef NS_IMPL_GNUSTEP
6240 /* NSTask in GNUstep sets its child handler each time it is called.
6241 So we must re-set ours. */
6242 catch_child_signal();
6243 #endif
6246 static void
6247 deliver_child_signal (int sig)
6249 deliver_process_signal (sig, handle_child_signal);
6253 static Lisp_Object
6254 exec_sentinel_error_handler (Lisp_Object error_val)
6256 cmd_error_internal (error_val, "error in process sentinel: ");
6257 Vinhibit_quit = Qt;
6258 update_echo_area ();
6259 Fsleep_for (make_number (2), Qnil);
6260 return Qt;
6263 static void
6264 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6266 Lisp_Object sentinel, odeactivate;
6267 struct Lisp_Process *p = XPROCESS (proc);
6268 ptrdiff_t count = SPECPDL_INDEX ();
6269 bool outer_running_asynch_code = running_asynch_code;
6270 int waiting = waiting_for_user_input_p;
6272 if (inhibit_sentinels)
6273 return;
6275 /* No need to gcpro these, because all we do with them later
6276 is test them for EQness, and none of them should be a string. */
6277 odeactivate = Vdeactivate_mark;
6278 #if 0
6279 Lisp_Object obuffer, okeymap;
6280 XSETBUFFER (obuffer, current_buffer);
6281 okeymap = BVAR (current_buffer, keymap);
6282 #endif
6284 /* There's no good reason to let sentinels change the current
6285 buffer, and many callers of accept-process-output, sit-for, and
6286 friends don't expect current-buffer to be changed from under them. */
6287 record_unwind_current_buffer ();
6289 sentinel = p->sentinel;
6291 /* Inhibit quit so that random quits don't screw up a running filter. */
6292 specbind (Qinhibit_quit, Qt);
6293 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6295 /* In case we get recursively called,
6296 and we already saved the match data nonrecursively,
6297 save the same match data in safely recursive fashion. */
6298 if (outer_running_asynch_code)
6300 Lisp_Object tem;
6301 tem = Fmatch_data (Qnil, Qnil, Qnil);
6302 restore_search_regs ();
6303 record_unwind_save_match_data ();
6304 Fset_match_data (tem, Qt);
6307 /* For speed, if a search happens within this code,
6308 save the match data in a special nonrecursive fashion. */
6309 running_asynch_code = 1;
6311 internal_condition_case_1 (read_process_output_call,
6312 list3 (sentinel, proc, reason),
6313 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6314 exec_sentinel_error_handler);
6316 /* If we saved the match data nonrecursively, restore it now. */
6317 restore_search_regs ();
6318 running_asynch_code = outer_running_asynch_code;
6320 Vdeactivate_mark = odeactivate;
6322 /* Restore waiting_for_user_input_p as it was
6323 when we were called, in case the filter clobbered it. */
6324 waiting_for_user_input_p = waiting;
6326 #if 0
6327 if (! EQ (Fcurrent_buffer (), obuffer)
6328 || ! EQ (current_buffer->keymap, okeymap))
6329 #endif
6330 /* But do it only if the caller is actually going to read events.
6331 Otherwise there's no need to make him wake up, and it could
6332 cause trouble (for example it would make sit_for return). */
6333 if (waiting_for_user_input_p == -1)
6334 record_asynch_buffer_change ();
6336 unbind_to (count, Qnil);
6339 /* Report all recent events of a change in process status
6340 (either run the sentinel or output a message).
6341 This is usually done while Emacs is waiting for keyboard input
6342 but can be done at other times. */
6344 static void
6345 status_notify (struct Lisp_Process *deleting_process)
6347 register Lisp_Object proc;
6348 Lisp_Object tail, msg;
6349 struct gcpro gcpro1, gcpro2;
6351 tail = Qnil;
6352 msg = Qnil;
6353 /* We need to gcpro tail; if read_process_output calls a filter
6354 which deletes a process and removes the cons to which tail points
6355 from Vprocess_alist, and then causes a GC, tail is an unprotected
6356 reference. */
6357 GCPRO2 (tail, msg);
6359 /* Set this now, so that if new processes are created by sentinels
6360 that we run, we get called again to handle their status changes. */
6361 update_tick = process_tick;
6363 FOR_EACH_PROCESS (tail, proc)
6365 Lisp_Object symbol;
6366 register struct Lisp_Process *p = XPROCESS (proc);
6368 if (p->tick != p->update_tick)
6370 p->update_tick = p->tick;
6372 /* If process is still active, read any output that remains. */
6373 while (! EQ (p->filter, Qt)
6374 && ! EQ (p->status, Qconnect)
6375 && ! EQ (p->status, Qlisten)
6376 /* Network or serial process not stopped: */
6377 && ! EQ (p->command, Qt)
6378 && p->infd >= 0
6379 && p != deleting_process
6380 && read_process_output (proc, p->infd) > 0);
6382 /* Get the text to use for the message. */
6383 if (p->raw_status_new)
6384 update_status (p);
6385 msg = status_message (p);
6387 /* If process is terminated, deactivate it or delete it. */
6388 symbol = p->status;
6389 if (CONSP (p->status))
6390 symbol = XCAR (p->status);
6392 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6393 || EQ (symbol, Qclosed))
6395 if (delete_exited_processes)
6396 remove_process (proc);
6397 else
6398 deactivate_process (proc);
6401 /* The actions above may have further incremented p->tick.
6402 So set p->update_tick again so that an error in the sentinel will
6403 not cause this code to be run again. */
6404 p->update_tick = p->tick;
6405 /* Now output the message suitably. */
6406 exec_sentinel (proc, msg);
6408 } /* end for */
6410 update_mode_lines = 24; /* In case buffers use %s in mode-line-format. */
6411 UNGCPRO;
6414 DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel,
6415 Sinternal_default_process_sentinel, 2, 2, 0,
6416 doc: /* Function used as default sentinel for processes.
6417 This inserts a status message into the process's buffer, if there is one. */)
6418 (Lisp_Object proc, Lisp_Object msg)
6420 Lisp_Object buffer, symbol;
6421 struct Lisp_Process *p;
6422 CHECK_PROCESS (proc);
6423 p = XPROCESS (proc);
6424 buffer = p->buffer;
6425 symbol = p->status;
6426 if (CONSP (symbol))
6427 symbol = XCAR (symbol);
6429 if (!EQ (symbol, Qrun) && !NILP (buffer))
6431 Lisp_Object tem;
6432 struct buffer *old = current_buffer;
6433 ptrdiff_t opoint, opoint_byte;
6434 ptrdiff_t before, before_byte;
6436 /* Avoid error if buffer is deleted
6437 (probably that's why the process is dead, too). */
6438 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
6439 return Qnil;
6440 Fset_buffer (buffer);
6442 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
6443 msg = (code_convert_string_norecord
6444 (msg, Vlocale_coding_system, 1));
6446 opoint = PT;
6447 opoint_byte = PT_BYTE;
6448 /* Insert new output into buffer
6449 at the current end-of-output marker,
6450 thus preserving logical ordering of input and output. */
6451 if (XMARKER (p->mark)->buffer)
6452 Fgoto_char (p->mark);
6453 else
6454 SET_PT_BOTH (ZV, ZV_BYTE);
6456 before = PT;
6457 before_byte = PT_BYTE;
6459 tem = BVAR (current_buffer, read_only);
6460 bset_read_only (current_buffer, Qnil);
6461 insert_string ("\nProcess ");
6462 { /* FIXME: temporary kludge. */
6463 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
6464 insert_string (" ");
6465 Finsert (1, &msg);
6466 bset_read_only (current_buffer, tem);
6467 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6469 if (opoint >= before)
6470 SET_PT_BOTH (opoint + (PT - before),
6471 opoint_byte + (PT_BYTE - before_byte));
6472 else
6473 SET_PT_BOTH (opoint, opoint_byte);
6475 set_buffer_internal (old);
6477 return Qnil;
6481 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6482 Sset_process_coding_system, 1, 3, 0,
6483 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6484 DECODING will be used to decode subprocess output and ENCODING to
6485 encode subprocess input. */)
6486 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6488 register struct Lisp_Process *p;
6490 CHECK_PROCESS (process);
6491 p = XPROCESS (process);
6492 if (p->infd < 0)
6493 error ("Input file descriptor of %s closed", SDATA (p->name));
6494 if (p->outfd < 0)
6495 error ("Output file descriptor of %s closed", SDATA (p->name));
6496 Fcheck_coding_system (decoding);
6497 Fcheck_coding_system (encoding);
6498 encoding = coding_inherit_eol_type (encoding, Qnil);
6499 pset_decode_coding_system (p, decoding);
6500 pset_encode_coding_system (p, encoding);
6501 setup_process_coding_systems (process);
6503 return Qnil;
6506 DEFUN ("process-coding-system",
6507 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6508 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6509 (register Lisp_Object process)
6511 CHECK_PROCESS (process);
6512 return Fcons (XPROCESS (process)->decode_coding_system,
6513 XPROCESS (process)->encode_coding_system);
6516 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6517 Sset_process_filter_multibyte, 2, 2, 0,
6518 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6519 If FLAG is non-nil, the filter is given multibyte strings.
6520 If FLAG is nil, the filter is given unibyte strings. In this case,
6521 all character code conversion except for end-of-line conversion is
6522 suppressed. */)
6523 (Lisp_Object process, Lisp_Object flag)
6525 register struct Lisp_Process *p;
6527 CHECK_PROCESS (process);
6528 p = XPROCESS (process);
6529 if (NILP (flag))
6530 pset_decode_coding_system
6531 (p, raw_text_coding_system (p->decode_coding_system));
6532 setup_process_coding_systems (process);
6534 return Qnil;
6537 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6538 Sprocess_filter_multibyte_p, 1, 1, 0,
6539 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6540 (Lisp_Object process)
6542 register struct Lisp_Process *p;
6543 struct coding_system *coding;
6545 CHECK_PROCESS (process);
6546 p = XPROCESS (process);
6547 coding = proc_decode_coding_system[p->infd];
6548 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6554 # ifdef HAVE_GPM
6556 void
6557 add_gpm_wait_descriptor (int desc)
6559 add_keyboard_wait_descriptor (desc);
6562 void
6563 delete_gpm_wait_descriptor (int desc)
6565 delete_keyboard_wait_descriptor (desc);
6568 # endif
6570 # ifdef USABLE_SIGIO
6572 /* Return true if *MASK has a bit set
6573 that corresponds to one of the keyboard input descriptors. */
6575 static bool
6576 keyboard_bit_set (fd_set *mask)
6578 int fd;
6580 for (fd = 0; fd <= max_input_desc; fd++)
6581 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6582 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6583 return 1;
6585 return 0;
6587 # endif
6589 #else /* not subprocesses */
6591 /* Defined on msdos.c. */
6592 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
6593 struct timespec *, void *);
6595 /* Implementation of wait_reading_process_output, assuming that there
6596 are no subprocesses. Used only by the MS-DOS build.
6598 Wait for timeout to elapse and/or keyboard input to be available.
6600 TIME_LIMIT is:
6601 timeout in seconds
6602 If negative, gobble data immediately available but don't wait for any.
6604 NSECS is:
6605 an additional duration to wait, measured in nanoseconds
6606 If TIME_LIMIT is zero, then:
6607 If NSECS == 0, there is no limit.
6608 If NSECS > 0, the timeout consists of NSECS only.
6609 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6611 READ_KBD is:
6612 0 to ignore keyboard input, or
6613 1 to return when input is available, or
6614 -1 means caller will actually read the input, so don't throw to
6615 the quit handler.
6617 see full version for other parameters. We know that wait_proc will
6618 always be NULL, since `subprocesses' isn't defined.
6620 DO_DISPLAY means redisplay should be done to show subprocess
6621 output that arrives.
6623 Return true if we received input from any process. */
6625 bool
6626 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6627 bool do_display,
6628 Lisp_Object wait_for_cell,
6629 struct Lisp_Process *wait_proc, int just_wait_proc)
6631 register int nfds;
6632 struct timespec end_time, timeout;
6634 if (time_limit < 0)
6636 time_limit = 0;
6637 nsecs = -1;
6639 else if (TYPE_MAXIMUM (time_t) < time_limit)
6640 time_limit = TYPE_MAXIMUM (time_t);
6642 /* What does time_limit really mean? */
6643 if (time_limit || nsecs > 0)
6645 timeout = make_timespec (time_limit, nsecs);
6646 end_time = timespec_add (current_timespec (), timeout);
6649 /* Turn off periodic alarms (in case they are in use)
6650 and then turn off any other atimers,
6651 because the select emulator uses alarms. */
6652 stop_polling ();
6653 turn_on_atimers (0);
6655 while (1)
6657 bool timeout_reduced_for_timers = 0;
6658 fd_set waitchannels;
6659 int xerrno;
6661 /* If calling from keyboard input, do not quit
6662 since we want to return C-g as an input character.
6663 Otherwise, do pending quit if requested. */
6664 if (read_kbd >= 0)
6665 QUIT;
6667 /* Exit now if the cell we're waiting for became non-nil. */
6668 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6669 break;
6671 /* Compute time from now till when time limit is up. */
6672 /* Exit if already run out. */
6673 if (nsecs < 0)
6675 /* A negative timeout means
6676 gobble output available now
6677 but don't wait at all. */
6679 timeout = make_timespec (0, 0);
6681 else if (time_limit || nsecs > 0)
6683 struct timespec now = current_timespec ();
6684 if (timespec_cmp (end_time, now) <= 0)
6685 break;
6686 timeout = timespec_sub (end_time, now);
6688 else
6690 timeout = make_timespec (100000, 0);
6693 /* If our caller will not immediately handle keyboard events,
6694 run timer events directly.
6695 (Callers that will immediately read keyboard events
6696 call timer_delay on their own.) */
6697 if (NILP (wait_for_cell))
6699 struct timespec timer_delay;
6703 unsigned old_timers_run = timers_run;
6704 timer_delay = timer_check ();
6705 if (timers_run != old_timers_run && do_display)
6706 /* We must retry, since a timer may have requeued itself
6707 and that could alter the time delay. */
6708 redisplay_preserve_echo_area (14);
6709 else
6710 break;
6712 while (!detect_input_pending ());
6714 /* If there is unread keyboard input, also return. */
6715 if (read_kbd != 0
6716 && requeued_events_pending_p ())
6717 break;
6719 if (timespec_valid_p (timer_delay) && nsecs >= 0)
6721 if (timespec_cmp (timer_delay, timeout) < 0)
6723 timeout = timer_delay;
6724 timeout_reduced_for_timers = 1;
6729 /* Cause C-g and alarm signals to take immediate action,
6730 and cause input available signals to zero out timeout. */
6731 if (read_kbd < 0)
6732 set_waiting_for_input (&timeout);
6734 /* If a frame has been newly mapped and needs updating,
6735 reprocess its display stuff. */
6736 if (frame_garbaged && do_display)
6738 clear_waiting_for_input ();
6739 redisplay_preserve_echo_area (15);
6740 if (read_kbd < 0)
6741 set_waiting_for_input (&timeout);
6744 /* Wait till there is something to do. */
6745 FD_ZERO (&waitchannels);
6746 if (read_kbd && detect_input_pending ())
6747 nfds = 0;
6748 else
6750 if (read_kbd || !NILP (wait_for_cell))
6751 FD_SET (0, &waitchannels);
6752 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6755 xerrno = errno;
6757 /* Make C-g and alarm signals set flags again */
6758 clear_waiting_for_input ();
6760 /* If we woke up due to SIGWINCH, actually change size now. */
6761 do_pending_window_change (0);
6763 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6764 /* We waited the full specified time, so return now. */
6765 break;
6767 if (nfds == -1)
6769 /* If the system call was interrupted, then go around the
6770 loop again. */
6771 if (xerrno == EINTR)
6772 FD_ZERO (&waitchannels);
6773 else
6774 report_file_errno ("Failed select", Qnil, xerrno);
6777 /* Check for keyboard input */
6779 if (read_kbd
6780 && detect_input_pending_run_timers (do_display))
6782 swallow_events (do_display);
6783 if (detect_input_pending_run_timers (do_display))
6784 break;
6787 /* If there is unread keyboard input, also return. */
6788 if (read_kbd
6789 && requeued_events_pending_p ())
6790 break;
6792 /* If wait_for_cell. check for keyboard input
6793 but don't run any timers.
6794 ??? (It seems wrong to me to check for keyboard
6795 input at all when wait_for_cell, but the code
6796 has been this way since July 1994.
6797 Try changing this after version 19.31.) */
6798 if (! NILP (wait_for_cell)
6799 && detect_input_pending ())
6801 swallow_events (do_display);
6802 if (detect_input_pending ())
6803 break;
6806 /* Exit now if the cell we're waiting for became non-nil. */
6807 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6808 break;
6811 start_polling ();
6813 return 0;
6816 #endif /* not subprocesses */
6818 /* The following functions are needed even if async subprocesses are
6819 not supported. Some of them are no-op stubs in that case. */
6821 /* Add DESC to the set of keyboard input descriptors. */
6823 void
6824 add_keyboard_wait_descriptor (int desc)
6826 #ifdef subprocesses /* actually means "not MSDOS" */
6827 FD_SET (desc, &input_wait_mask);
6828 FD_SET (desc, &non_process_wait_mask);
6829 if (desc > max_input_desc)
6830 max_input_desc = desc;
6831 #endif
6834 /* From now on, do not expect DESC to give keyboard input. */
6836 void
6837 delete_keyboard_wait_descriptor (int desc)
6839 #ifdef subprocesses
6840 FD_CLR (desc, &input_wait_mask);
6841 FD_CLR (desc, &non_process_wait_mask);
6842 delete_input_desc (desc);
6843 #endif
6846 /* Setup coding systems of PROCESS. */
6848 void
6849 setup_process_coding_systems (Lisp_Object process)
6851 #ifdef subprocesses
6852 struct Lisp_Process *p = XPROCESS (process);
6853 int inch = p->infd;
6854 int outch = p->outfd;
6855 Lisp_Object coding_system;
6857 if (inch < 0 || outch < 0)
6858 return;
6860 if (!proc_decode_coding_system[inch])
6861 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
6862 coding_system = p->decode_coding_system;
6863 if (EQ (p->filter, Qinternal_default_process_filter)
6864 && BUFFERP (p->buffer))
6866 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
6867 coding_system = raw_text_coding_system (coding_system);
6869 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
6871 if (!proc_encode_coding_system[outch])
6872 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
6873 setup_coding_system (p->encode_coding_system,
6874 proc_encode_coding_system[outch]);
6875 #endif
6878 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
6879 doc: /* Return the (or a) process associated with BUFFER.
6880 BUFFER may be a buffer or the name of one. */)
6881 (register Lisp_Object buffer)
6883 #ifdef subprocesses
6884 register Lisp_Object buf, tail, proc;
6886 if (NILP (buffer)) return Qnil;
6887 buf = Fget_buffer (buffer);
6888 if (NILP (buf)) return Qnil;
6890 FOR_EACH_PROCESS (tail, proc)
6891 if (EQ (XPROCESS (proc)->buffer, buf))
6892 return proc;
6893 #endif /* subprocesses */
6894 return Qnil;
6897 DEFUN ("process-inherit-coding-system-flag",
6898 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
6899 1, 1, 0,
6900 doc: /* Return the value of inherit-coding-system flag for PROCESS.
6901 If this flag is t, `buffer-file-coding-system' of the buffer
6902 associated with PROCESS will inherit the coding system used to decode
6903 the process output. */)
6904 (register Lisp_Object process)
6906 #ifdef subprocesses
6907 CHECK_PROCESS (process);
6908 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
6909 #else
6910 /* Ignore the argument and return the value of
6911 inherit-process-coding-system. */
6912 return inherit_process_coding_system ? Qt : Qnil;
6913 #endif
6916 /* Kill all processes associated with `buffer'.
6917 If `buffer' is nil, kill all processes */
6919 void
6920 kill_buffer_processes (Lisp_Object buffer)
6922 #ifdef subprocesses
6923 Lisp_Object tail, proc;
6925 FOR_EACH_PROCESS (tail, proc)
6926 if (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer))
6928 if (NETCONN_P (proc) || SERIALCONN_P (proc))
6929 Fdelete_process (proc);
6930 else if (XPROCESS (proc)->infd >= 0)
6931 process_send_signal (proc, SIGHUP, Qnil, 1);
6933 #else /* subprocesses */
6934 /* Since we have no subprocesses, this does nothing. */
6935 #endif /* subprocesses */
6938 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
6939 Swaiting_for_user_input_p, 0, 0, 0,
6940 doc: /* Return non-nil if Emacs is waiting for input from the user.
6941 This is intended for use by asynchronous process output filters and sentinels. */)
6942 (void)
6944 #ifdef subprocesses
6945 return (waiting_for_user_input_p ? Qt : Qnil);
6946 #else
6947 return Qnil;
6948 #endif
6951 /* Stop reading input from keyboard sources. */
6953 void
6954 hold_keyboard_input (void)
6956 kbd_is_on_hold = 1;
6959 /* Resume reading input from keyboard sources. */
6961 void
6962 unhold_keyboard_input (void)
6964 kbd_is_on_hold = 0;
6967 /* Return true if keyboard input is on hold, zero otherwise. */
6969 bool
6970 kbd_on_hold_p (void)
6972 return kbd_is_on_hold;
6976 /* Enumeration of and access to system processes a-la ps(1). */
6978 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
6979 0, 0, 0,
6980 doc: /* Return a list of numerical process IDs of all running processes.
6981 If this functionality is unsupported, return nil.
6983 See `process-attributes' for getting attributes of a process given its ID. */)
6984 (void)
6986 return list_system_processes ();
6989 DEFUN ("process-attributes", Fprocess_attributes,
6990 Sprocess_attributes, 1, 1, 0,
6991 doc: /* Return attributes of the process given by its PID, a number.
6993 Value is an alist where each element is a cons cell of the form
6995 \(KEY . VALUE)
6997 If this functionality is unsupported, the value is nil.
6999 See `list-system-processes' for getting a list of all process IDs.
7001 The KEYs of the attributes that this function may return are listed
7002 below, together with the type of the associated VALUE (in parentheses).
7003 Not all platforms support all of these attributes; unsupported
7004 attributes will not appear in the returned alist.
7005 Unless explicitly indicated otherwise, numbers can have either
7006 integer or floating point values.
7008 euid -- Effective user User ID of the process (number)
7009 user -- User name corresponding to euid (string)
7010 egid -- Effective user Group ID of the process (number)
7011 group -- Group name corresponding to egid (string)
7012 comm -- Command name (executable name only) (string)
7013 state -- Process state code, such as "S", "R", or "T" (string)
7014 ppid -- Parent process ID (number)
7015 pgrp -- Process group ID (number)
7016 sess -- Session ID, i.e. process ID of session leader (number)
7017 ttname -- Controlling tty name (string)
7018 tpgid -- ID of foreground process group on the process's tty (number)
7019 minflt -- number of minor page faults (number)
7020 majflt -- number of major page faults (number)
7021 cminflt -- cumulative number of minor page faults (number)
7022 cmajflt -- cumulative number of major page faults (number)
7023 utime -- user time used by the process, in (current-time) format,
7024 which is a list of integers (HIGH LOW USEC PSEC)
7025 stime -- system time used by the process (current-time)
7026 time -- sum of utime and stime (current-time)
7027 cutime -- user time used by the process and its children (current-time)
7028 cstime -- system time used by the process and its children (current-time)
7029 ctime -- sum of cutime and cstime (current-time)
7030 pri -- priority of the process (number)
7031 nice -- nice value of the process (number)
7032 thcount -- process thread count (number)
7033 start -- time the process started (current-time)
7034 vsize -- virtual memory size of the process in KB's (number)
7035 rss -- resident set size of the process in KB's (number)
7036 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7037 pcpu -- percents of CPU time used by the process (floating-point number)
7038 pmem -- percents of total physical memory used by process's resident set
7039 (floating-point number)
7040 args -- command line which invoked the process (string). */)
7041 ( Lisp_Object pid)
7043 return system_process_attributes (pid);
7046 /* Arrange to catch SIGCHLD if this hasn't already been arranged.
7047 Invoke this after init_process_emacs, and after glib and/or GNUstep
7048 futz with the SIGCHLD handler, but before Emacs forks any children.
7049 This function's caller should block SIGCHLD. */
7051 #ifndef NS_IMPL_GNUSTEP
7052 static
7053 #endif
7054 void
7055 catch_child_signal (void)
7057 struct sigaction action, old_action;
7058 emacs_sigaction_init (&action, deliver_child_signal);
7059 block_child_signal ();
7060 sigaction (SIGCHLD, &action, &old_action);
7061 eassert (! (old_action.sa_flags & SA_SIGINFO));
7063 if (old_action.sa_handler != deliver_child_signal)
7064 lib_child_handler
7065 = (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7066 ? dummy_handler
7067 : old_action.sa_handler);
7068 unblock_child_signal ();
7072 /* This is not called "init_process" because that is the name of a
7073 Mach system call, so it would cause problems on Darwin systems. */
7074 void
7075 init_process_emacs (void)
7077 #ifdef subprocesses
7078 register int i;
7080 inhibit_sentinels = 0;
7082 #ifndef CANNOT_DUMP
7083 if (! noninteractive || initialized)
7084 #endif
7086 #if defined HAVE_GLIB && !defined WINDOWSNT
7087 /* Tickle glib's child-handling code. Ask glib to wait for Emacs itself;
7088 this should always fail, but is enough to initialize glib's
7089 private SIGCHLD handler, allowing catch_child_signal to copy
7090 it into lib_child_handler. */
7091 g_source_unref (g_child_watch_source_new (getpid ()));
7092 #endif
7093 catch_child_signal ();
7096 FD_ZERO (&input_wait_mask);
7097 FD_ZERO (&non_keyboard_wait_mask);
7098 FD_ZERO (&non_process_wait_mask);
7099 FD_ZERO (&write_mask);
7100 max_process_desc = max_input_desc = -1;
7101 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7103 #ifdef NON_BLOCKING_CONNECT
7104 FD_ZERO (&connect_wait_mask);
7105 num_pending_connects = 0;
7106 #endif
7108 #ifdef ADAPTIVE_READ_BUFFERING
7109 process_output_delay_count = 0;
7110 process_output_skip = 0;
7111 #endif
7113 /* Don't do this, it caused infinite select loops. The display
7114 method should call add_keyboard_wait_descriptor on stdin if it
7115 needs that. */
7116 #if 0
7117 FD_SET (0, &input_wait_mask);
7118 #endif
7120 Vprocess_alist = Qnil;
7121 deleted_pid_list = Qnil;
7122 for (i = 0; i < FD_SETSIZE; i++)
7124 chan_process[i] = Qnil;
7125 proc_buffered_char[i] = -1;
7127 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7128 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7129 #ifdef DATAGRAM_SOCKETS
7130 memset (datagram_address, 0, sizeof datagram_address);
7131 #endif
7134 Lisp_Object subfeatures = Qnil;
7135 const struct socket_options *sopt;
7137 #define ADD_SUBFEATURE(key, val) \
7138 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7140 #ifdef NON_BLOCKING_CONNECT
7141 ADD_SUBFEATURE (QCnowait, Qt);
7142 #endif
7143 #ifdef DATAGRAM_SOCKETS
7144 ADD_SUBFEATURE (QCtype, Qdatagram);
7145 #endif
7146 #ifdef HAVE_SEQPACKET
7147 ADD_SUBFEATURE (QCtype, Qseqpacket);
7148 #endif
7149 #ifdef HAVE_LOCAL_SOCKETS
7150 ADD_SUBFEATURE (QCfamily, Qlocal);
7151 #endif
7152 ADD_SUBFEATURE (QCfamily, Qipv4);
7153 #ifdef AF_INET6
7154 ADD_SUBFEATURE (QCfamily, Qipv6);
7155 #endif
7156 #ifdef HAVE_GETSOCKNAME
7157 ADD_SUBFEATURE (QCservice, Qt);
7158 #endif
7159 ADD_SUBFEATURE (QCserver, Qt);
7161 for (sopt = socket_options; sopt->name; sopt++)
7162 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7164 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7167 #if defined (DARWIN_OS)
7168 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7169 processes. As such, we only change the default value. */
7170 if (initialized)
7172 char const *release = (STRINGP (Voperating_system_release)
7173 ? SSDATA (Voperating_system_release)
7174 : 0);
7175 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7176 Vprocess_connection_type = Qnil;
7179 #endif
7180 #endif /* subprocesses */
7181 kbd_is_on_hold = 0;
7184 void
7185 syms_of_process (void)
7187 #ifdef subprocesses
7189 DEFSYM (Qprocessp, "processp");
7190 DEFSYM (Qrun, "run");
7191 DEFSYM (Qstop, "stop");
7192 DEFSYM (Qsignal, "signal");
7194 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7195 here again.
7197 Qexit = intern_c_string ("exit");
7198 staticpro (&Qexit); */
7200 DEFSYM (Qopen, "open");
7201 DEFSYM (Qclosed, "closed");
7202 DEFSYM (Qconnect, "connect");
7203 DEFSYM (Qfailed, "failed");
7204 DEFSYM (Qlisten, "listen");
7205 DEFSYM (Qlocal, "local");
7206 DEFSYM (Qipv4, "ipv4");
7207 #ifdef AF_INET6
7208 DEFSYM (Qipv6, "ipv6");
7209 #endif
7210 DEFSYM (Qdatagram, "datagram");
7211 DEFSYM (Qseqpacket, "seqpacket");
7213 DEFSYM (QCport, ":port");
7214 DEFSYM (QCspeed, ":speed");
7215 DEFSYM (QCprocess, ":process");
7217 DEFSYM (QCbytesize, ":bytesize");
7218 DEFSYM (QCstopbits, ":stopbits");
7219 DEFSYM (QCparity, ":parity");
7220 DEFSYM (Qodd, "odd");
7221 DEFSYM (Qeven, "even");
7222 DEFSYM (QCflowcontrol, ":flowcontrol");
7223 DEFSYM (Qhw, "hw");
7224 DEFSYM (Qsw, "sw");
7225 DEFSYM (QCsummary, ":summary");
7227 DEFSYM (Qreal, "real");
7228 DEFSYM (Qnetwork, "network");
7229 DEFSYM (Qserial, "serial");
7230 DEFSYM (QCbuffer, ":buffer");
7231 DEFSYM (QChost, ":host");
7232 DEFSYM (QCservice, ":service");
7233 DEFSYM (QClocal, ":local");
7234 DEFSYM (QCremote, ":remote");
7235 DEFSYM (QCcoding, ":coding");
7236 DEFSYM (QCserver, ":server");
7237 DEFSYM (QCnowait, ":nowait");
7238 DEFSYM (QCsentinel, ":sentinel");
7239 DEFSYM (QClog, ":log");
7240 DEFSYM (QCnoquery, ":noquery");
7241 DEFSYM (QCstop, ":stop");
7242 DEFSYM (QCoptions, ":options");
7243 DEFSYM (QCplist, ":plist");
7245 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7247 staticpro (&Vprocess_alist);
7248 staticpro (&deleted_pid_list);
7250 #endif /* subprocesses */
7252 DEFSYM (QCname, ":name");
7253 DEFSYM (QCtype, ":type");
7255 DEFSYM (Qeuid, "euid");
7256 DEFSYM (Qegid, "egid");
7257 DEFSYM (Quser, "user");
7258 DEFSYM (Qgroup, "group");
7259 DEFSYM (Qcomm, "comm");
7260 DEFSYM (Qstate, "state");
7261 DEFSYM (Qppid, "ppid");
7262 DEFSYM (Qpgrp, "pgrp");
7263 DEFSYM (Qsess, "sess");
7264 DEFSYM (Qttname, "ttname");
7265 DEFSYM (Qtpgid, "tpgid");
7266 DEFSYM (Qminflt, "minflt");
7267 DEFSYM (Qmajflt, "majflt");
7268 DEFSYM (Qcminflt, "cminflt");
7269 DEFSYM (Qcmajflt, "cmajflt");
7270 DEFSYM (Qutime, "utime");
7271 DEFSYM (Qstime, "stime");
7272 DEFSYM (Qtime, "time");
7273 DEFSYM (Qcutime, "cutime");
7274 DEFSYM (Qcstime, "cstime");
7275 DEFSYM (Qctime, "ctime");
7276 DEFSYM (Qinternal_default_process_sentinel,
7277 "internal-default-process-sentinel");
7278 DEFSYM (Qinternal_default_process_filter,
7279 "internal-default-process-filter");
7280 DEFSYM (Qpri, "pri");
7281 DEFSYM (Qnice, "nice");
7282 DEFSYM (Qthcount, "thcount");
7283 DEFSYM (Qstart, "start");
7284 DEFSYM (Qvsize, "vsize");
7285 DEFSYM (Qrss, "rss");
7286 DEFSYM (Qetime, "etime");
7287 DEFSYM (Qpcpu, "pcpu");
7288 DEFSYM (Qpmem, "pmem");
7289 DEFSYM (Qargs, "args");
7291 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7292 doc: /* Non-nil means delete processes immediately when they exit.
7293 A value of nil means don't delete them until `list-processes' is run. */);
7295 delete_exited_processes = 1;
7297 #ifdef subprocesses
7298 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7299 doc: /* Control type of device used to communicate with subprocesses.
7300 Values are nil to use a pipe, or t or `pty' to use a pty.
7301 The value has no effect if the system has no ptys or if all ptys are busy:
7302 then a pipe is used in any case.
7303 The value takes effect when `start-process' is called. */);
7304 Vprocess_connection_type = Qt;
7306 #ifdef ADAPTIVE_READ_BUFFERING
7307 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7308 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7309 On some systems, when Emacs reads the output from a subprocess, the output data
7310 is read in very small blocks, potentially resulting in very poor performance.
7311 This behavior can be remedied to some extent by setting this variable to a
7312 non-nil value, as it will automatically delay reading from such processes, to
7313 allow them to produce more output before Emacs tries to read it.
7314 If the value is t, the delay is reset after each write to the process; any other
7315 non-nil value means that the delay is not reset on write.
7316 The variable takes effect when `start-process' is called. */);
7317 Vprocess_adaptive_read_buffering = Qt;
7318 #endif
7320 defsubr (&Sprocessp);
7321 defsubr (&Sget_process);
7322 defsubr (&Sdelete_process);
7323 defsubr (&Sprocess_status);
7324 defsubr (&Sprocess_exit_status);
7325 defsubr (&Sprocess_id);
7326 defsubr (&Sprocess_name);
7327 defsubr (&Sprocess_tty_name);
7328 defsubr (&Sprocess_command);
7329 defsubr (&Sset_process_buffer);
7330 defsubr (&Sprocess_buffer);
7331 defsubr (&Sprocess_mark);
7332 defsubr (&Sset_process_filter);
7333 defsubr (&Sprocess_filter);
7334 defsubr (&Sset_process_sentinel);
7335 defsubr (&Sprocess_sentinel);
7336 defsubr (&Sset_process_window_size);
7337 defsubr (&Sset_process_inherit_coding_system_flag);
7338 defsubr (&Sset_process_query_on_exit_flag);
7339 defsubr (&Sprocess_query_on_exit_flag);
7340 defsubr (&Sprocess_contact);
7341 defsubr (&Sprocess_plist);
7342 defsubr (&Sset_process_plist);
7343 defsubr (&Sprocess_list);
7344 defsubr (&Sstart_process);
7345 defsubr (&Sserial_process_configure);
7346 defsubr (&Smake_serial_process);
7347 defsubr (&Sset_network_process_option);
7348 defsubr (&Smake_network_process);
7349 defsubr (&Sformat_network_address);
7350 defsubr (&Snetwork_interface_list);
7351 defsubr (&Snetwork_interface_info);
7352 #ifdef DATAGRAM_SOCKETS
7353 defsubr (&Sprocess_datagram_address);
7354 defsubr (&Sset_process_datagram_address);
7355 #endif
7356 defsubr (&Saccept_process_output);
7357 defsubr (&Sprocess_send_region);
7358 defsubr (&Sprocess_send_string);
7359 defsubr (&Sinterrupt_process);
7360 defsubr (&Skill_process);
7361 defsubr (&Squit_process);
7362 defsubr (&Sstop_process);
7363 defsubr (&Scontinue_process);
7364 defsubr (&Sprocess_running_child_p);
7365 defsubr (&Sprocess_send_eof);
7366 defsubr (&Ssignal_process);
7367 defsubr (&Swaiting_for_user_input_p);
7368 defsubr (&Sprocess_type);
7369 defsubr (&Sinternal_default_process_sentinel);
7370 defsubr (&Sinternal_default_process_filter);
7371 defsubr (&Sset_process_coding_system);
7372 defsubr (&Sprocess_coding_system);
7373 defsubr (&Sset_process_filter_multibyte);
7374 defsubr (&Sprocess_filter_multibyte_p);
7376 #endif /* subprocesses */
7378 defsubr (&Sget_buffer_process);
7379 defsubr (&Sprocess_inherit_coding_system_flag);
7380 defsubr (&Slist_system_processes);
7381 defsubr (&Sprocess_attributes);