Copy just non-empty strings to kill-ring
[emacs.git] / src / process.c
blobbc2ac451c9df6e742d9beedac2873c254eb67e25
1 /* Asynchronous subprocess control for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2016 Free Software
4 Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 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_UTIL_H
79 #include <util.h>
80 #endif
82 #ifdef HAVE_PTY_H
83 #include <pty.h>
84 #endif
86 #include <c-ctype.h>
87 #include <sig2str.h>
88 #include <verify.h>
90 #endif /* subprocesses */
92 #include "systime.h"
93 #include "systty.h"
95 #include "window.h"
96 #include "character.h"
97 #include "buffer.h"
98 #include "coding.h"
99 #include "process.h"
100 #include "frame.h"
101 #include "termopts.h"
102 #include "keyboard.h"
103 #include "blockinput.h"
104 #include "atimer.h"
105 #include "sysselect.h"
106 #include "syssignal.h"
107 #include "syswait.h"
108 #ifdef HAVE_GNUTLS
109 #include "gnutls.h"
110 #endif
112 #ifdef HAVE_WINDOW_SYSTEM
113 #include TERM_HEADER
114 #endif /* HAVE_WINDOW_SYSTEM */
116 #ifdef HAVE_GLIB
117 #include "xgselect.h"
118 #ifndef WINDOWSNT
119 #include <glib.h>
120 #endif
121 #endif
123 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
124 /* This is 0.1s in nanoseconds. */
125 #define ASYNC_RETRY_NSEC 100000000
126 #endif
128 #ifdef WINDOWSNT
129 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
130 struct timespec *, void *);
131 #endif
133 /* Work around GCC 4.3.0 bug with strict overflow checking; see
134 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
135 This bug appears to be fixed in GCC 5.1, so don't work around it there. */
136 #if GNUC_PREREQ (4, 3, 0) && ! GNUC_PREREQ (5, 1, 0)
137 # pragma GCC diagnostic ignored "-Wstrict-overflow"
138 #endif
140 /* True if keyboard input is on hold, zero otherwise. */
142 static bool kbd_is_on_hold;
144 /* Nonzero means don't run process sentinels. This is used
145 when exiting. */
146 bool inhibit_sentinels;
148 #ifdef subprocesses
150 #ifndef SOCK_CLOEXEC
151 # define SOCK_CLOEXEC 0
152 #endif
153 #ifndef SOCK_NONBLOCK
154 # define SOCK_NONBLOCK 0
155 #endif
157 /* True if ERRNUM represents an error where the system call would
158 block if a blocking variant were used. */
159 static bool
160 would_block (int errnum)
162 #ifdef EWOULDBLOCK
163 if (EWOULDBLOCK != EAGAIN && errnum == EWOULDBLOCK)
164 return true;
165 #endif
166 return errnum == EAGAIN;
169 #ifndef HAVE_ACCEPT4
171 /* Emulate GNU/Linux accept4 and socket well enough for this module. */
173 static int
174 close_on_exec (int fd)
176 if (0 <= fd)
177 fcntl (fd, F_SETFD, FD_CLOEXEC);
178 return fd;
181 # undef accept4
182 # define accept4(sockfd, addr, addrlen, flags) \
183 process_accept4 (sockfd, addr, addrlen, flags)
184 static int
185 accept4 (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags)
187 return close_on_exec (accept (sockfd, addr, addrlen));
190 static int
191 process_socket (int domain, int type, int protocol)
193 return close_on_exec (socket (domain, type, protocol));
195 # undef socket
196 # define socket(domain, type, protocol) process_socket (domain, type, protocol)
197 #endif
199 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
200 #define NETCONN1_P(p) (EQ (p->type, Qnetwork))
201 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
202 #define SERIALCONN1_P(p) (EQ (p->type, Qserial))
203 #define PIPECONN_P(p) (EQ (XPROCESS (p)->type, Qpipe))
204 #define PIPECONN1_P(p) (EQ (p->type, Qpipe))
206 /* Number of events of change of status of a process. */
207 static EMACS_INT process_tick;
208 /* Number of events for which the user or sentinel has been notified. */
209 static EMACS_INT update_tick;
211 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
212 this system. We need to read full packets, so we need a
213 "non-destructive" select. So we require either native select,
214 or emulation of select using FIONREAD. */
216 #ifndef BROKEN_DATAGRAM_SOCKETS
217 # if defined HAVE_SELECT || defined USABLE_FIONREAD
218 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
219 # define DATAGRAM_SOCKETS
220 # endif
221 # endif
222 #endif
224 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
225 # define HAVE_SEQPACKET
226 #endif
228 #define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
229 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
230 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
232 /* Number of processes which have a non-zero read_output_delay,
233 and therefore might be delayed for adaptive read buffering. */
235 static int process_output_delay_count;
237 /* True if any process has non-nil read_output_skip. */
239 static bool process_output_skip;
241 static void create_process (Lisp_Object, char **, Lisp_Object);
242 #ifdef USABLE_SIGIO
243 static bool keyboard_bit_set (fd_set *);
244 #endif
245 static void deactivate_process (Lisp_Object);
246 static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
247 static int read_process_output (Lisp_Object, int);
248 static void handle_child_signal (int);
249 static void create_pty (Lisp_Object);
251 static Lisp_Object get_process (register Lisp_Object name);
252 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
254 /* Mask of bits indicating the descriptors that we wait for input on. */
256 static fd_set input_wait_mask;
258 /* Mask that excludes keyboard input descriptor(s). */
260 static fd_set non_keyboard_wait_mask;
262 /* Mask that excludes process input descriptor(s). */
264 static fd_set non_process_wait_mask;
266 /* Mask for selecting for write. */
268 static fd_set write_mask;
270 /* Mask of bits indicating the descriptors that we wait for connect to
271 complete on. Once they complete, they are removed from this mask
272 and added to the input_wait_mask and non_keyboard_wait_mask. */
274 static fd_set connect_wait_mask;
276 /* Number of bits set in connect_wait_mask. */
277 static int num_pending_connects;
279 /* The largest descriptor currently in use for a process object; -1 if none. */
280 static int max_process_desc;
282 /* The largest descriptor currently in use for input; -1 if none. */
283 static int max_input_desc;
285 /* Set the external socket descriptor for Emacs to use when
286 `make-network-process' is called with a non-nil
287 `:use-external-socket' option. The value should be either -1, or
288 the file descriptor of a socket that is already bound. */
289 static int external_sock_fd;
291 /* Indexed by descriptor, gives the process (if any) for that descriptor. */
292 static Lisp_Object chan_process[FD_SETSIZE];
293 static void wait_for_socket_fds (Lisp_Object, char const *);
295 /* Alist of elements (NAME . PROCESS). */
296 static Lisp_Object Vprocess_alist;
298 /* Buffered-ahead input char from process, indexed by channel.
299 -1 means empty (no char is buffered).
300 Used on sys V where the only way to tell if there is any
301 output from the process is to read at least one char.
302 Always -1 on systems that support FIONREAD. */
304 static int proc_buffered_char[FD_SETSIZE];
306 /* Table of `struct coding-system' for each process. */
307 static struct coding_system *proc_decode_coding_system[FD_SETSIZE];
308 static struct coding_system *proc_encode_coding_system[FD_SETSIZE];
310 #ifdef DATAGRAM_SOCKETS
311 /* Table of `partner address' for datagram sockets. */
312 static struct sockaddr_and_len {
313 struct sockaddr *sa;
314 ptrdiff_t len;
315 } datagram_address[FD_SETSIZE];
316 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
317 #define DATAGRAM_CONN_P(proc) \
318 (PROCESSP (proc) && \
319 XPROCESS (proc)->infd >= 0 && \
320 datagram_address[XPROCESS (proc)->infd].sa != 0)
321 #else
322 #define DATAGRAM_CONN_P(proc) (0)
323 #endif
325 /* FOR_EACH_PROCESS (LIST_VAR, PROC_VAR) followed by a statement is
326 a `for' loop which iterates over processes from Vprocess_alist. */
328 #define FOR_EACH_PROCESS(list_var, proc_var) \
329 FOR_EACH_ALIST_VALUE (Vprocess_alist, list_var, proc_var)
331 /* These setters are used only in this file, so they can be private. */
332 static void
333 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
335 p->buffer = val;
337 static void
338 pset_command (struct Lisp_Process *p, Lisp_Object val)
340 p->command = val;
342 static void
343 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
345 p->decode_coding_system = val;
347 static void
348 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
350 p->decoding_buf = val;
352 static void
353 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
355 p->encode_coding_system = val;
357 static void
358 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
360 p->encoding_buf = val;
362 static void
363 pset_filter (struct Lisp_Process *p, Lisp_Object val)
365 p->filter = NILP (val) ? Qinternal_default_process_filter : val;
367 static void
368 pset_log (struct Lisp_Process *p, Lisp_Object val)
370 p->log = val;
372 static void
373 pset_mark (struct Lisp_Process *p, Lisp_Object val)
375 p->mark = val;
377 static void
378 pset_name (struct Lisp_Process *p, Lisp_Object val)
380 p->name = val;
382 static void
383 pset_plist (struct Lisp_Process *p, Lisp_Object val)
385 p->plist = val;
387 static void
388 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
390 p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
392 static void
393 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
395 p->tty_name = val;
397 static void
398 pset_type (struct Lisp_Process *p, Lisp_Object val)
400 p->type = val;
402 static void
403 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
405 p->write_queue = val;
407 static void
408 pset_stderrproc (struct Lisp_Process *p, Lisp_Object val)
410 p->stderrproc = val;
414 static Lisp_Object
415 make_lisp_proc (struct Lisp_Process *p)
417 return make_lisp_ptr (p, Lisp_Vectorlike);
420 static struct fd_callback_data
422 fd_callback func;
423 void *data;
424 #define FOR_READ 1
425 #define FOR_WRITE 2
426 int condition; /* Mask of the defines above. */
427 } fd_callback_info[FD_SETSIZE];
430 /* Add a file descriptor FD to be monitored for when read is possible.
431 When read is possible, call FUNC with argument DATA. */
433 void
434 add_read_fd (int fd, fd_callback func, void *data)
436 add_keyboard_wait_descriptor (fd);
438 fd_callback_info[fd].func = func;
439 fd_callback_info[fd].data = data;
440 fd_callback_info[fd].condition |= FOR_READ;
443 /* Stop monitoring file descriptor FD for when read is possible. */
445 void
446 delete_read_fd (int fd)
448 delete_keyboard_wait_descriptor (fd);
450 fd_callback_info[fd].condition &= ~FOR_READ;
451 if (fd_callback_info[fd].condition == 0)
453 fd_callback_info[fd].func = 0;
454 fd_callback_info[fd].data = 0;
458 /* Add a file descriptor FD to be monitored for when write is possible.
459 When write is possible, call FUNC with argument DATA. */
461 void
462 add_write_fd (int fd, fd_callback func, void *data)
464 FD_SET (fd, &write_mask);
465 if (fd > max_input_desc)
466 max_input_desc = fd;
468 fd_callback_info[fd].func = func;
469 fd_callback_info[fd].data = data;
470 fd_callback_info[fd].condition |= FOR_WRITE;
473 /* FD is no longer an input descriptor; update max_input_desc accordingly. */
475 static void
476 delete_input_desc (int fd)
478 if (fd == max_input_desc)
481 fd--;
482 while (0 <= fd && ! (FD_ISSET (fd, &input_wait_mask)
483 || FD_ISSET (fd, &write_mask)));
485 max_input_desc = fd;
489 /* Stop monitoring file descriptor FD for when write is possible. */
491 void
492 delete_write_fd (int fd)
494 FD_CLR (fd, &write_mask);
495 fd_callback_info[fd].condition &= ~FOR_WRITE;
496 if (fd_callback_info[fd].condition == 0)
498 fd_callback_info[fd].func = 0;
499 fd_callback_info[fd].data = 0;
500 delete_input_desc (fd);
505 /* Compute the Lisp form of the process status, p->status, from
506 the numeric status that was returned by `wait'. */
508 static Lisp_Object status_convert (int);
510 static void
511 update_status (struct Lisp_Process *p)
513 eassert (p->raw_status_new);
514 pset_status (p, status_convert (p->raw_status));
515 p->raw_status_new = 0;
518 /* Convert a process status word in Unix format to
519 the list that we use internally. */
521 static Lisp_Object
522 status_convert (int w)
524 if (WIFSTOPPED (w))
525 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
526 else if (WIFEXITED (w))
527 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
528 WCOREDUMP (w) ? Qt : Qnil));
529 else if (WIFSIGNALED (w))
530 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
531 WCOREDUMP (w) ? Qt : Qnil));
532 else
533 return Qrun;
536 /* True if STATUS is that of a process attempting connection. */
538 static bool
539 connecting_status (Lisp_Object status)
541 return CONSP (status) && EQ (XCAR (status), Qconnect);
544 /* Given a status-list, extract the three pieces of information
545 and store them individually through the three pointers. */
547 static void
548 decode_status (Lisp_Object l, Lisp_Object *symbol, Lisp_Object *code,
549 bool *coredump)
551 Lisp_Object tem;
553 if (connecting_status (l))
554 l = XCAR (l);
556 if (SYMBOLP (l))
558 *symbol = l;
559 *code = make_number (0);
560 *coredump = 0;
562 else
564 *symbol = XCAR (l);
565 tem = XCDR (l);
566 *code = XCAR (tem);
567 tem = XCDR (tem);
568 *coredump = !NILP (tem);
572 /* Return a string describing a process status list. */
574 static Lisp_Object
575 status_message (struct Lisp_Process *p)
577 Lisp_Object status = p->status;
578 Lisp_Object symbol, code;
579 bool coredump;
580 Lisp_Object string;
582 decode_status (status, &symbol, &code, &coredump);
584 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
586 char const *signame;
587 synchronize_system_messages_locale ();
588 signame = strsignal (XFASTINT (code));
589 if (signame == 0)
590 string = build_string ("unknown");
591 else
593 int c1, c2;
595 string = build_unibyte_string (signame);
596 if (! NILP (Vlocale_coding_system))
597 string = (code_convert_string_norecord
598 (string, Vlocale_coding_system, 0));
599 c1 = STRING_CHAR (SDATA (string));
600 c2 = downcase (c1);
601 if (c1 != c2)
602 Faset (string, make_number (0), make_number (c2));
604 AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
605 return concat2 (string, suffix);
607 else if (EQ (symbol, Qexit))
609 if (NETCONN1_P (p))
610 return build_string (XFASTINT (code) == 0
611 ? "deleted\n"
612 : "connection broken by remote peer\n");
613 if (XFASTINT (code) == 0)
614 return build_string ("finished\n");
615 AUTO_STRING (prefix, "exited abnormally with code ");
616 string = Fnumber_to_string (code);
617 AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
618 return concat3 (prefix, string, suffix);
620 else if (EQ (symbol, Qfailed))
622 AUTO_STRING (format, "failed with code %s\n");
623 return CALLN (Fformat, format, code);
625 else
626 return Fcopy_sequence (Fsymbol_name (symbol));
629 enum { PTY_NAME_SIZE = 24 };
631 /* Open an available pty, returning a file descriptor.
632 Store into PTY_NAME the file name of the terminal corresponding to the pty.
633 Return -1 on failure. */
635 static int
636 allocate_pty (char pty_name[PTY_NAME_SIZE])
638 #ifdef HAVE_PTYS
639 int fd;
641 #ifdef PTY_ITERATION
642 PTY_ITERATION
643 #else
644 register int c, i;
645 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
646 for (i = 0; i < 16; i++)
647 #endif
649 #ifdef PTY_NAME_SPRINTF
650 PTY_NAME_SPRINTF
651 #else
652 sprintf (pty_name, "/dev/pty%c%x", c, i);
653 #endif /* no PTY_NAME_SPRINTF */
655 #ifdef PTY_OPEN
656 PTY_OPEN;
657 #else /* no PTY_OPEN */
658 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
659 #endif /* no PTY_OPEN */
661 if (fd >= 0)
663 #ifdef PTY_TTY_NAME_SPRINTF
664 PTY_TTY_NAME_SPRINTF
665 #else
666 sprintf (pty_name, "/dev/tty%c%x", c, i);
667 #endif /* no PTY_TTY_NAME_SPRINTF */
669 /* Set FD's close-on-exec flag. This is needed even if
670 PT_OPEN calls posix_openpt with O_CLOEXEC, since POSIX
671 doesn't require support for that combination.
672 Do this after PTY_TTY_NAME_SPRINTF, which on some platforms
673 doesn't work if the close-on-exec flag is set (Bug#20555).
674 Multithreaded platforms where posix_openpt ignores
675 O_CLOEXEC (or where PTY_OPEN doesn't call posix_openpt)
676 have a race condition between the PTY_OPEN and here. */
677 fcntl (fd, F_SETFD, FD_CLOEXEC);
679 /* Check to make certain that both sides are available.
680 This avoids a nasty yet stupid bug in rlogins. */
681 if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
683 emacs_close (fd);
684 # ifndef __sgi
685 continue;
686 # else
687 return -1;
688 # endif /* __sgi */
690 setup_pty (fd);
691 return fd;
694 #endif /* HAVE_PTYS */
695 return -1;
698 /* Allocate basically initialized process. */
700 static struct Lisp_Process *
701 allocate_process (void)
703 return ALLOCATE_ZEROED_PSEUDOVECTOR (struct Lisp_Process, pid, PVEC_PROCESS);
706 static Lisp_Object
707 make_process (Lisp_Object name)
709 struct Lisp_Process *p = allocate_process ();
710 /* Initialize Lisp data. Note that allocate_process initializes all
711 Lisp data to nil, so do it only for slots which should not be nil. */
712 pset_status (p, Qrun);
713 pset_mark (p, Fmake_marker ());
715 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
716 non-Lisp data, so do it only for slots which should not be zero. */
717 p->infd = -1;
718 p->outfd = -1;
719 for (int i = 0; i < PROCESS_OPEN_FDS; i++)
720 p->open_fd[i] = -1;
722 #ifdef HAVE_GNUTLS
723 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
724 p->gnutls_boot_parameters = Qnil;
725 #endif
727 /* If name is already in use, modify it until it is unused. */
729 Lisp_Object name1 = name;
730 for (printmax_t i = 1; ; i++)
732 Lisp_Object tem = Fget_process (name1);
733 if (NILP (tem))
734 break;
735 char const suffix_fmt[] = "<%"pMd">";
736 char suffix[sizeof suffix_fmt + INT_STRLEN_BOUND (printmax_t)];
737 AUTO_STRING_WITH_LEN (lsuffix, suffix, sprintf (suffix, suffix_fmt, i));
738 name1 = concat2 (name, lsuffix);
740 name = name1;
741 pset_name (p, name);
742 pset_sentinel (p, Qinternal_default_process_sentinel);
743 pset_filter (p, Qinternal_default_process_filter);
744 Lisp_Object val;
745 XSETPROCESS (val, p);
746 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
747 return val;
750 static void
751 remove_process (register Lisp_Object proc)
753 register Lisp_Object pair;
755 pair = Frassq (proc, Vprocess_alist);
756 Vprocess_alist = Fdelq (pair, Vprocess_alist);
758 deactivate_process (proc);
761 #ifdef HAVE_GETADDRINFO_A
762 static void
763 free_dns_request (Lisp_Object proc)
765 struct Lisp_Process *p = XPROCESS (proc);
767 if (p->dns_request->ar_result)
768 freeaddrinfo (p->dns_request->ar_result);
769 xfree (p->dns_request);
770 p->dns_request = NULL;
772 #endif
775 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
776 doc: /* Return t if OBJECT is a process. */)
777 (Lisp_Object object)
779 return PROCESSP (object) ? Qt : Qnil;
782 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
783 doc: /* Return the process named NAME, or nil if there is none. */)
784 (register Lisp_Object name)
786 if (PROCESSP (name))
787 return name;
788 CHECK_STRING (name);
789 return Fcdr (Fassoc (name, Vprocess_alist));
792 /* This is how commands for the user decode process arguments. It
793 accepts a process, a process name, a buffer, a buffer name, or nil.
794 Buffers denote the first process in the buffer, and nil denotes the
795 current buffer. */
797 static Lisp_Object
798 get_process (register Lisp_Object name)
800 register Lisp_Object proc, obj;
801 if (STRINGP (name))
803 obj = Fget_process (name);
804 if (NILP (obj))
805 obj = Fget_buffer (name);
806 if (NILP (obj))
807 error ("Process %s does not exist", SDATA (name));
809 else if (NILP (name))
810 obj = Fcurrent_buffer ();
811 else
812 obj = name;
814 /* Now obj should be either a buffer object or a process object. */
815 if (BUFFERP (obj))
817 if (NILP (BVAR (XBUFFER (obj), name)))
818 error ("Attempt to get process for a dead buffer");
819 proc = Fget_buffer_process (obj);
820 if (NILP (proc))
821 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
823 else
825 CHECK_PROCESS (obj);
826 proc = obj;
828 return proc;
832 /* Fdelete_process promises to immediately forget about the process, but in
833 reality, Emacs needs to remember those processes until they have been
834 treated by the SIGCHLD handler and waitpid has been invoked on them;
835 otherwise they might fill up the kernel's process table.
837 Some processes created by call-process are also put onto this list.
839 Members of this list are (process-ID . filename) pairs. The
840 process-ID is a number; the filename, if a string, is a file that
841 needs to be removed after the process exits. */
842 static Lisp_Object deleted_pid_list;
844 void
845 record_deleted_pid (pid_t pid, Lisp_Object filename)
847 deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
848 /* GC treated elements set to nil. */
849 Fdelq (Qnil, deleted_pid_list));
853 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
854 doc: /* Delete PROCESS: kill it and forget about it immediately.
855 PROCESS may be a process, a buffer, the name of a process or buffer, or
856 nil, indicating the current buffer's process. */)
857 (register Lisp_Object process)
859 register struct Lisp_Process *p;
861 process = get_process (process);
862 p = XPROCESS (process);
864 #ifdef HAVE_GETADDRINFO_A
865 if (p->dns_request)
867 /* Cancel the request. Unless shutting down, wait until
868 completion. Free the request if completely canceled. */
870 bool canceled = gai_cancel (p->dns_request) != EAI_NOTCANCELED;
871 if (!canceled && !inhibit_sentinels)
873 struct gaicb const *req = p->dns_request;
874 while (gai_suspend (&req, 1, NULL) != 0)
875 continue;
876 canceled = true;
878 if (canceled)
879 free_dns_request (process);
881 #endif
883 p->raw_status_new = 0;
884 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
886 pset_status (p, list2 (Qexit, make_number (0)));
887 p->tick = ++process_tick;
888 status_notify (p, NULL);
889 redisplay_preserve_echo_area (13);
891 else
893 if (p->alive)
894 record_kill_process (p, Qnil);
896 if (p->infd >= 0)
898 /* Update P's status, since record_kill_process will make the
899 SIGCHLD handler update deleted_pid_list, not *P. */
900 Lisp_Object symbol;
901 if (p->raw_status_new)
902 update_status (p);
903 symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
904 if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
905 pset_status (p, list2 (Qsignal, make_number (SIGKILL)));
907 p->tick = ++process_tick;
908 status_notify (p, NULL);
909 redisplay_preserve_echo_area (13);
912 remove_process (process);
913 return Qnil;
916 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
917 doc: /* Return the status of PROCESS.
918 The returned value is one of the following symbols:
919 run -- for a process that is running.
920 stop -- for a process stopped but continuable.
921 exit -- for a process that has exited.
922 signal -- for a process that has got a fatal signal.
923 open -- for a network stream connection that is open.
924 listen -- for a network stream server that is listening.
925 closed -- for a network stream connection that is closed.
926 connect -- when waiting for a non-blocking connection to complete.
927 failed -- when a non-blocking connection has failed.
928 nil -- if arg is a process name and no such process exists.
929 PROCESS may be a process, a buffer, the name of a process, or
930 nil, indicating the current buffer's process. */)
931 (register Lisp_Object process)
933 register struct Lisp_Process *p;
934 register Lisp_Object status;
936 if (STRINGP (process))
937 process = Fget_process (process);
938 else
939 process = get_process (process);
941 if (NILP (process))
942 return process;
944 p = XPROCESS (process);
945 if (p->raw_status_new)
946 update_status (p);
947 status = p->status;
948 if (CONSP (status))
949 status = XCAR (status);
950 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
952 if (EQ (status, Qexit))
953 status = Qclosed;
954 else if (EQ (p->command, Qt))
955 status = Qstop;
956 else if (EQ (status, Qrun))
957 status = Qopen;
959 return status;
962 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
963 1, 1, 0,
964 doc: /* Return the exit status of PROCESS or the signal number that killed it.
965 If PROCESS has not yet exited or died, return 0. */)
966 (register Lisp_Object process)
968 CHECK_PROCESS (process);
969 if (XPROCESS (process)->raw_status_new)
970 update_status (XPROCESS (process));
971 if (CONSP (XPROCESS (process)->status))
972 return XCAR (XCDR (XPROCESS (process)->status));
973 return make_number (0);
976 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
977 doc: /* Return the process id of PROCESS.
978 This is the pid of the external process which PROCESS uses or talks to.
979 For a network connection, this value is nil. */)
980 (register Lisp_Object process)
982 pid_t pid;
984 CHECK_PROCESS (process);
985 pid = XPROCESS (process)->pid;
986 return (pid ? make_fixnum_or_float (pid) : Qnil);
989 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
990 doc: /* Return the name of PROCESS, as a string.
991 This is the name of the program invoked in PROCESS,
992 possibly modified to make it unique among process names. */)
993 (register Lisp_Object process)
995 CHECK_PROCESS (process);
996 return XPROCESS (process)->name;
999 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
1000 doc: /* Return the command that was executed to start PROCESS.
1001 This is a list of strings, the first string being the program executed
1002 and the rest of the strings being the arguments given to it.
1003 For a network or serial process, this is nil (process is running) or t
1004 \(process is stopped). */)
1005 (register Lisp_Object process)
1007 CHECK_PROCESS (process);
1008 return XPROCESS (process)->command;
1011 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
1012 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
1013 This is the terminal that the process itself reads and writes on,
1014 not the name of the pty that Emacs uses to talk with that terminal. */)
1015 (register Lisp_Object process)
1017 CHECK_PROCESS (process);
1018 return XPROCESS (process)->tty_name;
1021 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
1022 2, 2, 0,
1023 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
1024 Return BUFFER. */)
1025 (register Lisp_Object process, Lisp_Object buffer)
1027 struct Lisp_Process *p;
1029 CHECK_PROCESS (process);
1030 if (!NILP (buffer))
1031 CHECK_BUFFER (buffer);
1032 p = XPROCESS (process);
1033 pset_buffer (p, buffer);
1034 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
1035 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
1036 setup_process_coding_systems (process);
1037 return buffer;
1040 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
1041 1, 1, 0,
1042 doc: /* Return the buffer PROCESS is associated with.
1043 The default process filter inserts output from PROCESS into this buffer. */)
1044 (register Lisp_Object process)
1046 CHECK_PROCESS (process);
1047 return XPROCESS (process)->buffer;
1050 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1051 1, 1, 0,
1052 doc: /* Return the marker for the end of the last output from PROCESS. */)
1053 (register Lisp_Object process)
1055 CHECK_PROCESS (process);
1056 return XPROCESS (process)->mark;
1059 static void
1060 set_process_filter_masks (struct Lisp_Process *p)
1062 if (EQ (p->filter, Qt) && !EQ (p->status, Qlisten))
1064 FD_CLR (p->infd, &input_wait_mask);
1065 FD_CLR (p->infd, &non_keyboard_wait_mask);
1067 else if (EQ (p->filter, Qt)
1068 /* Network or serial process not stopped: */
1069 && !EQ (p->command, Qt))
1071 FD_SET (p->infd, &input_wait_mask);
1072 FD_SET (p->infd, &non_keyboard_wait_mask);
1076 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1077 2, 2, 0,
1078 doc: /* Give PROCESS the filter function FILTER; nil means default.
1079 A value of t means stop accepting output from the process.
1081 When a process has a non-default filter, its buffer is not used for output.
1082 Instead, each time it does output, the entire string of output is
1083 passed to the filter.
1085 The filter gets two arguments: the process and the string of output.
1086 The string argument is normally a multibyte string, except:
1087 - if the process's input coding system is no-conversion or raw-text,
1088 it is a unibyte string (the non-converted input), or else
1089 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1090 string (the result of converting the decoded input multibyte
1091 string to unibyte with `string-make-unibyte'). */)
1092 (Lisp_Object process, Lisp_Object filter)
1094 CHECK_PROCESS (process);
1095 struct Lisp_Process *p = XPROCESS (process);
1097 /* Don't signal an error if the process's input file descriptor
1098 is closed. This could make debugging Lisp more difficult,
1099 for example when doing something like
1101 (setq process (start-process ...))
1102 (debug)
1103 (set-process-filter process ...) */
1105 if (NILP (filter))
1106 filter = Qinternal_default_process_filter;
1108 pset_filter (p, filter);
1110 if (p->infd >= 0)
1111 set_process_filter_masks (p);
1113 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
1114 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1115 setup_process_coding_systems (process);
1116 return filter;
1119 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1120 1, 1, 0,
1121 doc: /* Return the filter function of PROCESS.
1122 See `set-process-filter' for more info on filter functions. */)
1123 (register Lisp_Object process)
1125 CHECK_PROCESS (process);
1126 return XPROCESS (process)->filter;
1129 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1130 2, 2, 0,
1131 doc: /* Give PROCESS the sentinel SENTINEL; nil for default.
1132 The sentinel is called as a function when the process changes state.
1133 It gets two arguments: the process, and a string describing the change. */)
1134 (register Lisp_Object process, Lisp_Object sentinel)
1136 struct Lisp_Process *p;
1138 CHECK_PROCESS (process);
1139 p = XPROCESS (process);
1141 if (NILP (sentinel))
1142 sentinel = Qinternal_default_process_sentinel;
1144 pset_sentinel (p, sentinel);
1145 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
1146 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1147 return sentinel;
1150 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1151 1, 1, 0,
1152 doc: /* Return the sentinel of PROCESS.
1153 See `set-process-sentinel' for more info on sentinels. */)
1154 (register Lisp_Object process)
1156 CHECK_PROCESS (process);
1157 return XPROCESS (process)->sentinel;
1160 DEFUN ("set-process-window-size", Fset_process_window_size,
1161 Sset_process_window_size, 3, 3, 0,
1162 doc: /* Tell PROCESS that it has logical window size WIDTH by HEIGHT.
1163 Value is t if PROCESS was successfully told about the window size,
1164 nil otherwise. */)
1165 (Lisp_Object process, Lisp_Object height, Lisp_Object width)
1167 CHECK_PROCESS (process);
1169 /* All known platforms store window sizes as 'unsigned short'. */
1170 CHECK_RANGED_INTEGER (height, 0, USHRT_MAX);
1171 CHECK_RANGED_INTEGER (width, 0, USHRT_MAX);
1173 if (NETCONN_P (process)
1174 || XPROCESS (process)->infd < 0
1175 || (set_window_size (XPROCESS (process)->infd,
1176 XINT (height), XINT (width))
1177 < 0))
1178 return Qnil;
1179 else
1180 return Qt;
1183 DEFUN ("set-process-inherit-coding-system-flag",
1184 Fset_process_inherit_coding_system_flag,
1185 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1186 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1187 If the second argument FLAG is non-nil, then the variable
1188 `buffer-file-coding-system' of the buffer associated with PROCESS
1189 will be bound to the value of the coding system used to decode
1190 the process output.
1192 This is useful when the coding system specified for the process buffer
1193 leaves either the character code conversion or the end-of-line conversion
1194 unspecified, or if the coding system used to decode the process output
1195 is more appropriate for saving the process buffer.
1197 Binding the variable `inherit-process-coding-system' to non-nil before
1198 starting the process is an alternative way of setting the inherit flag
1199 for the process which will run.
1201 This function returns FLAG. */)
1202 (register Lisp_Object process, Lisp_Object flag)
1204 CHECK_PROCESS (process);
1205 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1206 return flag;
1209 DEFUN ("set-process-query-on-exit-flag",
1210 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1211 2, 2, 0,
1212 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1213 If the second argument FLAG is non-nil, Emacs will query the user before
1214 exiting or killing a buffer if PROCESS is running. This function
1215 returns FLAG. */)
1216 (register Lisp_Object process, Lisp_Object flag)
1218 CHECK_PROCESS (process);
1219 XPROCESS (process)->kill_without_query = NILP (flag);
1220 return flag;
1223 DEFUN ("process-query-on-exit-flag",
1224 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1225 1, 1, 0,
1226 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1227 (register Lisp_Object process)
1229 CHECK_PROCESS (process);
1230 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1233 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1234 1, 2, 0,
1235 doc: /* Return the contact info of PROCESS; t for a real child.
1236 For a network or serial connection, the value depends on the optional
1237 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1238 SERVICE) for a network connection or (PORT SPEED) for a serial
1239 connection. If KEY is t, the complete contact information for the
1240 connection is returned, else the specific value for the keyword KEY is
1241 returned. See `make-network-process' or `make-serial-process' for a
1242 list of keywords.
1243 If PROCESS is a non-blocking network process that hasn't been fully
1244 set up yet, this function will block until socket setup has completed. */)
1245 (Lisp_Object process, Lisp_Object key)
1247 Lisp_Object contact;
1249 CHECK_PROCESS (process);
1250 contact = XPROCESS (process)->childp;
1252 #ifdef DATAGRAM_SOCKETS
1254 if (NETCONN_P (process))
1255 wait_for_socket_fds (process, "process-contact");
1257 if (DATAGRAM_CONN_P (process)
1258 && (EQ (key, Qt) || EQ (key, QCremote)))
1259 contact = Fplist_put (contact, QCremote,
1260 Fprocess_datagram_address (process));
1261 #endif
1263 if ((!NETCONN_P (process) && !SERIALCONN_P (process) && !PIPECONN_P (process))
1264 || EQ (key, Qt))
1265 return contact;
1266 if (NILP (key) && NETCONN_P (process))
1267 return list2 (Fplist_get (contact, QChost),
1268 Fplist_get (contact, QCservice));
1269 if (NILP (key) && SERIALCONN_P (process))
1270 return list2 (Fplist_get (contact, QCport),
1271 Fplist_get (contact, QCspeed));
1272 /* FIXME: Return a meaningful value (e.g., the child end of the pipe)
1273 if the pipe process is useful for purposes other than receiving
1274 stderr. */
1275 if (NILP (key) && PIPECONN_P (process))
1276 return Qt;
1277 return Fplist_get (contact, key);
1280 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1281 1, 1, 0,
1282 doc: /* Return the plist of PROCESS. */)
1283 (register Lisp_Object process)
1285 CHECK_PROCESS (process);
1286 return XPROCESS (process)->plist;
1289 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1290 2, 2, 0,
1291 doc: /* Replace the plist of PROCESS with PLIST. Return PLIST. */)
1292 (Lisp_Object process, Lisp_Object plist)
1294 CHECK_PROCESS (process);
1295 CHECK_LIST (plist);
1297 pset_plist (XPROCESS (process), plist);
1298 return plist;
1301 #if 0 /* Turned off because we don't currently record this info
1302 in the process. Perhaps add it. */
1303 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1304 doc: /* Return the connection type of PROCESS.
1305 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1306 a socket connection. */)
1307 (Lisp_Object process)
1309 return XPROCESS (process)->type;
1311 #endif
1313 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1314 doc: /* Return the connection type of PROCESS.
1315 The value is either the symbol `real', `network', or `serial'.
1316 PROCESS may be a process, a buffer, the name of a process or buffer, or
1317 nil, indicating the current buffer's process. */)
1318 (Lisp_Object process)
1320 Lisp_Object proc;
1321 proc = get_process (process);
1322 return XPROCESS (proc)->type;
1325 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1326 1, 2, 0,
1327 doc: /* Convert network ADDRESS from internal format to a string.
1328 A 4 or 5 element vector represents an IPv4 address (with port number).
1329 An 8 or 9 element vector represents an IPv6 address (with port number).
1330 If optional second argument OMIT-PORT is non-nil, don't include a port
1331 number in the string, even when present in ADDRESS.
1332 Return nil if format of ADDRESS is invalid. */)
1333 (Lisp_Object address, Lisp_Object omit_port)
1335 if (NILP (address))
1336 return Qnil;
1338 if (STRINGP (address)) /* AF_LOCAL */
1339 return address;
1341 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1343 register struct Lisp_Vector *p = XVECTOR (address);
1344 ptrdiff_t size = p->header.size;
1345 Lisp_Object args[10];
1346 int nargs, i;
1347 char const *format;
1349 if (size == 4 || (size == 5 && !NILP (omit_port)))
1351 format = "%d.%d.%d.%d";
1352 nargs = 4;
1354 else if (size == 5)
1356 format = "%d.%d.%d.%d:%d";
1357 nargs = 5;
1359 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1361 format = "%x:%x:%x:%x:%x:%x:%x:%x";
1362 nargs = 8;
1364 else if (size == 9)
1366 format = "[%x:%x:%x:%x:%x:%x:%x:%x]:%d";
1367 nargs = 9;
1369 else
1370 return Qnil;
1372 AUTO_STRING (format_obj, format);
1373 args[0] = format_obj;
1375 for (i = 0; i < nargs; i++)
1377 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1378 return Qnil;
1380 if (nargs <= 5 /* IPv4 */
1381 && i < 4 /* host, not port */
1382 && XINT (p->contents[i]) > 255)
1383 return Qnil;
1385 args[i + 1] = p->contents[i];
1388 return Fformat (nargs + 1, args);
1391 if (CONSP (address))
1393 AUTO_STRING (format, "<Family %d>");
1394 return CALLN (Fformat, format, Fcar (address));
1397 return Qnil;
1400 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1401 doc: /* Return a list of all processes that are Emacs sub-processes. */)
1402 (void)
1404 return Fmapcar (Qcdr, Vprocess_alist);
1407 /* Starting asynchronous inferior processes. */
1409 static void start_process_unwind (Lisp_Object proc);
1411 DEFUN ("make-process", Fmake_process, Smake_process, 0, MANY, 0,
1412 doc: /* Start a program in a subprocess. Return the process object for it.
1414 This is similar to `start-process', but arguments are specified as
1415 keyword/argument pairs. The following arguments are defined:
1417 :name NAME -- NAME is name for process. It is modified if necessary
1418 to make it unique.
1420 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
1421 with the process. Process output goes at end of that buffer, unless
1422 you specify an output stream or filter function to handle the output.
1423 BUFFER may be also nil, meaning that this process is not associated
1424 with any buffer.
1426 :command COMMAND -- COMMAND is a list starting with the program file
1427 name, followed by strings to give to the program as arguments.
1429 :coding CODING -- If CODING is a symbol, it specifies the coding
1430 system used for both reading and writing for this process. If CODING
1431 is a cons (DECODING . ENCODING), DECODING is used for reading, and
1432 ENCODING is used for writing.
1434 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
1435 the process is running. If BOOL is not given, query before exiting.
1437 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
1438 In the stopped state, a process does not accept incoming data, but you
1439 can send outgoing data. The stopped state is cleared by
1440 `continue-process' and set by `stop-process'.
1442 :connection-type TYPE -- TYPE is control type of device used to
1443 communicate with subprocesses. Values are `pipe' to use a pipe, `pty'
1444 to use a pty, or nil to use the default specified through
1445 `process-connection-type'.
1447 :filter FILTER -- Install FILTER as the process filter.
1449 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
1451 :stderr STDERR -- STDERR is either a buffer or a pipe process attached
1452 to the standard error of subprocess. Specifying this implies
1453 `:connection-type' is set to `pipe'.
1455 usage: (make-process &rest ARGS) */)
1456 (ptrdiff_t nargs, Lisp_Object *args)
1458 Lisp_Object buffer, name, command, program, proc, contact, current_dir, tem;
1459 Lisp_Object xstderr, stderrproc;
1460 ptrdiff_t count = SPECPDL_INDEX ();
1461 USE_SAFE_ALLOCA;
1463 if (nargs == 0)
1464 return Qnil;
1466 /* Save arguments for process-contact and clone-process. */
1467 contact = Flist (nargs, args);
1469 buffer = Fplist_get (contact, QCbuffer);
1470 if (!NILP (buffer))
1471 buffer = Fget_buffer_create (buffer);
1473 /* Make sure that the child will be able to chdir to the current
1474 buffer's current directory, or its unhandled equivalent. We
1475 can't just have the child check for an error when it does the
1476 chdir, since it's in a vfork. */
1477 current_dir = encode_current_directory ();
1479 name = Fplist_get (contact, QCname);
1480 CHECK_STRING (name);
1482 command = Fplist_get (contact, QCcommand);
1483 if (CONSP (command))
1484 program = XCAR (command);
1485 else
1486 program = Qnil;
1488 if (!NILP (program))
1489 CHECK_STRING (program);
1491 stderrproc = Qnil;
1492 xstderr = Fplist_get (contact, QCstderr);
1493 if (PROCESSP (xstderr))
1495 if (!PIPECONN_P (xstderr))
1496 error ("Process is not a pipe process");
1497 stderrproc = xstderr;
1499 else if (!NILP (xstderr))
1501 CHECK_STRING (program);
1502 stderrproc = CALLN (Fmake_pipe_process,
1503 QCname,
1504 concat2 (name, build_string (" stderr")),
1505 QCbuffer,
1506 Fget_buffer_create (xstderr));
1509 proc = make_process (name);
1510 /* If an error occurs and we can't start the process, we want to
1511 remove it from the process list. This means that each error
1512 check in create_process doesn't need to call remove_process
1513 itself; it's all taken care of here. */
1514 record_unwind_protect (start_process_unwind, proc);
1516 pset_childp (XPROCESS (proc), Qt);
1517 pset_plist (XPROCESS (proc), Qnil);
1518 pset_type (XPROCESS (proc), Qreal);
1519 pset_buffer (XPROCESS (proc), buffer);
1520 pset_sentinel (XPROCESS (proc), Fplist_get (contact, QCsentinel));
1521 pset_filter (XPROCESS (proc), Fplist_get (contact, QCfilter));
1522 pset_command (XPROCESS (proc), Fcopy_sequence (command));
1524 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
1525 XPROCESS (proc)->kill_without_query = 1;
1526 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
1527 pset_command (XPROCESS (proc), Qt);
1529 tem = Fplist_get (contact, QCconnection_type);
1530 if (EQ (tem, Qpty))
1531 XPROCESS (proc)->pty_flag = true;
1532 else if (EQ (tem, Qpipe))
1533 XPROCESS (proc)->pty_flag = false;
1534 else if (NILP (tem))
1535 XPROCESS (proc)->pty_flag = !NILP (Vprocess_connection_type);
1536 else
1537 report_file_error ("Unknown connection type", tem);
1539 if (!NILP (stderrproc))
1541 pset_stderrproc (XPROCESS (proc), stderrproc);
1543 XPROCESS (proc)->pty_flag = false;
1546 #ifdef HAVE_GNUTLS
1547 /* AKA GNUTLS_INITSTAGE(proc). */
1548 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1549 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1550 #endif
1552 XPROCESS (proc)->adaptive_read_buffering
1553 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1554 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1556 /* Make the process marker point into the process buffer (if any). */
1557 if (BUFFERP (buffer))
1558 set_marker_both (XPROCESS (proc)->mark, buffer,
1559 BUF_ZV (XBUFFER (buffer)),
1560 BUF_ZV_BYTE (XBUFFER (buffer)));
1563 /* Decide coding systems for communicating with the process. Here
1564 we don't setup the structure coding_system nor pay attention to
1565 unibyte mode. They are done in create_process. */
1567 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1568 Lisp_Object coding_systems = Qt;
1569 Lisp_Object val, *args2;
1571 tem = Fplist_get (contact, QCcoding);
1572 if (!NILP (tem))
1574 val = tem;
1575 if (CONSP (val))
1576 val = XCAR (val);
1578 else
1579 val = Vcoding_system_for_read;
1580 if (NILP (val))
1582 ptrdiff_t nargs2 = 3 + XINT (Flength (command));
1583 Lisp_Object tem2;
1584 SAFE_ALLOCA_LISP (args2, nargs2);
1585 ptrdiff_t i = 0;
1586 args2[i++] = Qstart_process;
1587 args2[i++] = name;
1588 args2[i++] = buffer;
1589 for (tem2 = command; CONSP (tem2); tem2 = XCDR (tem2))
1590 args2[i++] = XCAR (tem2);
1591 if (!NILP (program))
1592 coding_systems = Ffind_operation_coding_system (nargs2, args2);
1593 if (CONSP (coding_systems))
1594 val = XCAR (coding_systems);
1595 else if (CONSP (Vdefault_process_coding_system))
1596 val = XCAR (Vdefault_process_coding_system);
1598 pset_decode_coding_system (XPROCESS (proc), val);
1600 if (!NILP (tem))
1602 val = tem;
1603 if (CONSP (val))
1604 val = XCDR (val);
1606 else
1607 val = Vcoding_system_for_write;
1608 if (NILP (val))
1610 if (EQ (coding_systems, Qt))
1612 ptrdiff_t nargs2 = 3 + XINT (Flength (command));
1613 Lisp_Object tem2;
1614 SAFE_ALLOCA_LISP (args2, nargs2);
1615 ptrdiff_t i = 0;
1616 args2[i++] = Qstart_process;
1617 args2[i++] = name;
1618 args2[i++] = buffer;
1619 for (tem2 = command; CONSP (tem2); tem2 = XCDR (tem2))
1620 args2[i++] = XCAR (tem2);
1621 if (!NILP (program))
1622 coding_systems = Ffind_operation_coding_system (nargs2, args2);
1624 if (CONSP (coding_systems))
1625 val = XCDR (coding_systems);
1626 else if (CONSP (Vdefault_process_coding_system))
1627 val = XCDR (Vdefault_process_coding_system);
1629 pset_encode_coding_system (XPROCESS (proc), val);
1630 /* Note: At this moment, the above coding system may leave
1631 text-conversion or eol-conversion unspecified. They will be
1632 decided after we read output from the process and decode it by
1633 some coding system, or just before we actually send a text to
1634 the process. */
1638 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1639 XPROCESS (proc)->decoding_carryover = 0;
1640 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1642 XPROCESS (proc)->inherit_coding_system_flag
1643 = !(NILP (buffer) || !inherit_process_coding_system);
1645 if (!NILP (program))
1647 Lisp_Object program_args = XCDR (command);
1649 /* If program file name is not absolute, search our path for it.
1650 Put the name we will really use in TEM. */
1651 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1652 && !(SCHARS (program) > 1
1653 && IS_DEVICE_SEP (SREF (program, 1))))
1655 tem = Qnil;
1656 openp (Vexec_path, program, Vexec_suffixes, &tem,
1657 make_number (X_OK), false);
1658 if (NILP (tem))
1659 report_file_error ("Searching for program", program);
1660 tem = Fexpand_file_name (tem, Qnil);
1662 else
1664 if (!NILP (Ffile_directory_p (program)))
1665 error ("Specified program for new process is a directory");
1666 tem = program;
1669 /* Remove "/:" from TEM. */
1670 tem = remove_slash_colon (tem);
1672 Lisp_Object arg_encoding = Qnil;
1674 /* Encode the file name and put it in NEW_ARGV.
1675 That's where the child will use it to execute the program. */
1676 tem = list1 (ENCODE_FILE (tem));
1677 ptrdiff_t new_argc = 1;
1679 /* Here we encode arguments by the coding system used for sending
1680 data to the process. We don't support using different coding
1681 systems for encoding arguments and for encoding data sent to the
1682 process. */
1684 for (Lisp_Object tem2 = program_args; CONSP (tem2); tem2 = XCDR (tem2))
1686 Lisp_Object arg = XCAR (tem2);
1687 CHECK_STRING (arg);
1688 if (STRING_MULTIBYTE (arg))
1690 if (NILP (arg_encoding))
1691 arg_encoding = (complement_process_encoding_system
1692 (XPROCESS (proc)->encode_coding_system));
1693 arg = code_convert_string_norecord (arg, arg_encoding, 1);
1695 tem = Fcons (arg, tem);
1696 new_argc++;
1699 /* Now that everything is encoded we can collect the strings into
1700 NEW_ARGV. */
1701 char **new_argv;
1702 SAFE_NALLOCA (new_argv, 1, new_argc + 1);
1703 new_argv[new_argc] = 0;
1705 for (ptrdiff_t i = new_argc - 1; i >= 0; i--)
1707 new_argv[i] = SSDATA (XCAR (tem));
1708 tem = XCDR (tem);
1711 create_process (proc, new_argv, current_dir);
1713 else
1714 create_pty (proc);
1716 SAFE_FREE ();
1717 return unbind_to (count, proc);
1720 /* This function is the unwind_protect form for Fstart_process. If
1721 PROC doesn't have its pid set, then we know someone has signaled
1722 an error and the process wasn't started successfully, so we should
1723 remove it from the process list. */
1724 static void
1725 start_process_unwind (Lisp_Object proc)
1727 if (!PROCESSP (proc))
1728 emacs_abort ();
1730 /* Was PROC started successfully?
1731 -2 is used for a pty with no process, eg for gdb. */
1732 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1733 remove_process (proc);
1736 /* If *FD_ADDR is nonnegative, close it, and mark it as closed. */
1738 static void
1739 close_process_fd (int *fd_addr)
1741 int fd = *fd_addr;
1742 if (0 <= fd)
1744 *fd_addr = -1;
1745 emacs_close (fd);
1749 /* Indexes of file descriptors in open_fds. */
1750 enum
1752 /* The pipe from Emacs to its subprocess. */
1753 SUBPROCESS_STDIN,
1754 WRITE_TO_SUBPROCESS,
1756 /* The main pipe from the subprocess to Emacs. */
1757 READ_FROM_SUBPROCESS,
1758 SUBPROCESS_STDOUT,
1760 /* The pipe from the subprocess to Emacs that is closed when the
1761 subprocess execs. */
1762 READ_FROM_EXEC_MONITOR,
1763 EXEC_MONITOR_OUTPUT
1766 verify (PROCESS_OPEN_FDS == EXEC_MONITOR_OUTPUT + 1);
1768 static void
1769 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1771 struct Lisp_Process *p = XPROCESS (process);
1772 int inchannel, outchannel;
1773 pid_t pid;
1774 int vfork_errno;
1775 int forkin, forkout, forkerr = -1;
1776 bool pty_flag = 0;
1777 char pty_name[PTY_NAME_SIZE];
1778 Lisp_Object lisp_pty_name = Qnil;
1779 sigset_t oldset;
1781 inchannel = outchannel = -1;
1783 if (p->pty_flag)
1784 outchannel = inchannel = allocate_pty (pty_name);
1786 if (inchannel >= 0)
1788 p->open_fd[READ_FROM_SUBPROCESS] = inchannel;
1789 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1790 /* On most USG systems it does not work to open the pty's tty here,
1791 then close it and reopen it in the child. */
1792 /* Don't let this terminal become our controlling terminal
1793 (in case we don't have one). */
1794 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1795 if (forkin < 0)
1796 report_file_error ("Opening pty", Qnil);
1797 p->open_fd[SUBPROCESS_STDIN] = forkin;
1798 #else
1799 forkin = forkout = -1;
1800 #endif /* not USG, or USG_SUBTTY_WORKS */
1801 pty_flag = 1;
1802 lisp_pty_name = build_string (pty_name);
1804 else
1806 if (emacs_pipe (p->open_fd + SUBPROCESS_STDIN) != 0
1807 || emacs_pipe (p->open_fd + READ_FROM_SUBPROCESS) != 0)
1808 report_file_error ("Creating pipe", Qnil);
1809 forkin = p->open_fd[SUBPROCESS_STDIN];
1810 outchannel = p->open_fd[WRITE_TO_SUBPROCESS];
1811 inchannel = p->open_fd[READ_FROM_SUBPROCESS];
1812 forkout = p->open_fd[SUBPROCESS_STDOUT];
1814 if (!NILP (p->stderrproc))
1816 struct Lisp_Process *pp = XPROCESS (p->stderrproc);
1818 forkerr = pp->open_fd[SUBPROCESS_STDOUT];
1820 /* Close unnecessary file descriptors. */
1821 close_process_fd (&pp->open_fd[WRITE_TO_SUBPROCESS]);
1822 close_process_fd (&pp->open_fd[SUBPROCESS_STDIN]);
1826 #ifndef WINDOWSNT
1827 if (emacs_pipe (p->open_fd + READ_FROM_EXEC_MONITOR) != 0)
1828 report_file_error ("Creating pipe", Qnil);
1829 #endif
1831 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1832 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1834 /* Record this as an active process, with its channels. */
1835 chan_process[inchannel] = process;
1836 p->infd = inchannel;
1837 p->outfd = outchannel;
1839 /* Previously we recorded the tty descriptor used in the subprocess.
1840 It was only used for getting the foreground tty process, so now
1841 we just reopen the device (see emacs_get_tty_pgrp) as this is
1842 more portable (see USG_SUBTTY_WORKS above). */
1844 p->pty_flag = pty_flag;
1845 pset_status (p, Qrun);
1847 if (!EQ (p->command, Qt))
1849 FD_SET (inchannel, &input_wait_mask);
1850 FD_SET (inchannel, &non_keyboard_wait_mask);
1853 if (inchannel > max_process_desc)
1854 max_process_desc = inchannel;
1856 /* This may signal an error. */
1857 setup_process_coding_systems (process);
1859 block_input ();
1860 block_child_signal (&oldset);
1862 #ifndef WINDOWSNT
1863 /* vfork, and prevent local vars from being clobbered by the vfork. */
1864 Lisp_Object volatile current_dir_volatile = current_dir;
1865 Lisp_Object volatile lisp_pty_name_volatile = lisp_pty_name;
1866 char **volatile new_argv_volatile = new_argv;
1867 int volatile forkin_volatile = forkin;
1868 int volatile forkout_volatile = forkout;
1869 int volatile forkerr_volatile = forkerr;
1870 struct Lisp_Process *p_volatile = p;
1872 pid = vfork ();
1874 current_dir = current_dir_volatile;
1875 lisp_pty_name = lisp_pty_name_volatile;
1876 new_argv = new_argv_volatile;
1877 forkin = forkin_volatile;
1878 forkout = forkout_volatile;
1879 forkerr = forkerr_volatile;
1880 p = p_volatile;
1882 pty_flag = p->pty_flag;
1884 if (pid == 0)
1885 #endif /* not WINDOWSNT */
1887 /* Make the pty be the controlling terminal of the process. */
1888 #ifdef HAVE_PTYS
1889 /* First, disconnect its current controlling terminal. */
1890 /* We tried doing setsid only if pty_flag, but it caused
1891 process_set_signal to fail on SGI when using a pipe. */
1892 setsid ();
1893 /* Make the pty's terminal the controlling terminal. */
1894 if (pty_flag && forkin >= 0)
1896 #ifdef TIOCSCTTY
1897 /* We ignore the return value
1898 because faith@cs.unc.edu says that is necessary on Linux. */
1899 ioctl (forkin, TIOCSCTTY, 0);
1900 #endif
1902 #if defined (LDISC1)
1903 if (pty_flag && forkin >= 0)
1905 struct termios t;
1906 tcgetattr (forkin, &t);
1907 t.c_lflag = LDISC1;
1908 if (tcsetattr (forkin, TCSANOW, &t) < 0)
1909 emacs_perror ("create_process/tcsetattr LDISC1");
1911 #else
1912 #if defined (NTTYDISC) && defined (TIOCSETD)
1913 if (pty_flag && forkin >= 0)
1915 /* Use new line discipline. */
1916 int ldisc = NTTYDISC;
1917 ioctl (forkin, TIOCSETD, &ldisc);
1919 #endif
1920 #endif
1921 #ifdef TIOCNOTTY
1922 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1923 can do TIOCSPGRP only to the process's controlling tty. */
1924 if (pty_flag)
1926 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1927 I can't test it since I don't have 4.3. */
1928 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1929 if (j >= 0)
1931 ioctl (j, TIOCNOTTY, 0);
1932 emacs_close (j);
1935 #endif /* TIOCNOTTY */
1937 #if !defined (DONT_REOPEN_PTY)
1938 /*** There is a suggestion that this ought to be a
1939 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
1940 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1941 that system does seem to need this code, even though
1942 both TIOCSCTTY is defined. */
1943 /* Now close the pty (if we had it open) and reopen it.
1944 This makes the pty the controlling terminal of the subprocess. */
1945 if (pty_flag)
1948 /* I wonder if emacs_close (emacs_open (SSDATA (lisp_pty_name), ...))
1949 would work? */
1950 if (forkin >= 0)
1951 emacs_close (forkin);
1952 forkout = forkin = emacs_open (SSDATA (lisp_pty_name), O_RDWR, 0);
1954 if (forkin < 0)
1956 emacs_perror (SSDATA (lisp_pty_name));
1957 _exit (EXIT_CANCELED);
1961 #endif /* not DONT_REOPEN_PTY */
1963 #ifdef SETUP_SLAVE_PTY
1964 if (pty_flag)
1966 SETUP_SLAVE_PTY;
1968 #endif /* SETUP_SLAVE_PTY */
1969 #endif /* HAVE_PTYS */
1971 signal (SIGINT, SIG_DFL);
1972 signal (SIGQUIT, SIG_DFL);
1973 #ifdef SIGPROF
1974 signal (SIGPROF, SIG_DFL);
1975 #endif
1977 /* Emacs ignores SIGPIPE, but the child should not. */
1978 signal (SIGPIPE, SIG_DFL);
1980 /* Stop blocking SIGCHLD in the child. */
1981 unblock_child_signal (&oldset);
1983 if (pty_flag)
1984 child_setup_tty (forkout);
1986 if (forkerr < 0)
1987 forkerr = forkout;
1988 #ifdef WINDOWSNT
1989 pid = child_setup (forkin, forkout, forkerr, new_argv, 1, current_dir);
1990 #else /* not WINDOWSNT */
1991 child_setup (forkin, forkout, forkerr, new_argv, 1, current_dir);
1992 #endif /* not WINDOWSNT */
1995 /* Back in the parent process. */
1997 vfork_errno = errno;
1998 p->pid = pid;
1999 if (pid >= 0)
2000 p->alive = 1;
2002 /* Stop blocking in the parent. */
2003 unblock_child_signal (&oldset);
2004 unblock_input ();
2006 if (pid < 0)
2007 report_file_errno ("Doing vfork", Qnil, vfork_errno);
2008 else
2010 /* vfork succeeded. */
2012 /* Close the pipe ends that the child uses, or the child's pty. */
2013 close_process_fd (&p->open_fd[SUBPROCESS_STDIN]);
2014 close_process_fd (&p->open_fd[SUBPROCESS_STDOUT]);
2016 #ifdef WINDOWSNT
2017 register_child (pid, inchannel);
2018 #endif /* WINDOWSNT */
2020 pset_tty_name (p, lisp_pty_name);
2022 #ifndef WINDOWSNT
2023 /* Wait for child_setup to complete in case that vfork is
2024 actually defined as fork. The descriptor
2025 XPROCESS (proc)->open_fd[EXEC_MONITOR_OUTPUT]
2026 of a pipe is closed at the child side either by close-on-exec
2027 on successful execve or the _exit call in child_setup. */
2029 char dummy;
2031 close_process_fd (&p->open_fd[EXEC_MONITOR_OUTPUT]);
2032 emacs_read (p->open_fd[READ_FROM_EXEC_MONITOR], &dummy, 1);
2033 close_process_fd (&p->open_fd[READ_FROM_EXEC_MONITOR]);
2035 #endif
2036 if (!NILP (p->stderrproc))
2038 struct Lisp_Process *pp = XPROCESS (p->stderrproc);
2039 close_process_fd (&pp->open_fd[SUBPROCESS_STDOUT]);
2044 static void
2045 create_pty (Lisp_Object process)
2047 struct Lisp_Process *p = XPROCESS (process);
2048 char pty_name[PTY_NAME_SIZE];
2049 int pty_fd = !p->pty_flag ? -1 : allocate_pty (pty_name);
2051 if (pty_fd >= 0)
2053 p->open_fd[SUBPROCESS_STDIN] = pty_fd;
2054 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
2055 /* On most USG systems it does not work to open the pty's tty here,
2056 then close it and reopen it in the child. */
2057 /* Don't let this terminal become our controlling terminal
2058 (in case we don't have one). */
2059 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
2060 if (forkout < 0)
2061 report_file_error ("Opening pty", Qnil);
2062 p->open_fd[WRITE_TO_SUBPROCESS] = forkout;
2063 #if defined (DONT_REOPEN_PTY)
2064 /* In the case that vfork is defined as fork, the parent process
2065 (Emacs) may send some data before the child process completes
2066 tty options setup. So we setup tty before forking. */
2067 child_setup_tty (forkout);
2068 #endif /* DONT_REOPEN_PTY */
2069 #endif /* not USG, or USG_SUBTTY_WORKS */
2071 fcntl (pty_fd, F_SETFL, O_NONBLOCK);
2073 /* Record this as an active process, with its channels.
2074 As a result, child_setup will close Emacs's side of the pipes. */
2075 chan_process[pty_fd] = process;
2076 p->infd = pty_fd;
2077 p->outfd = pty_fd;
2079 /* Previously we recorded the tty descriptor used in the subprocess.
2080 It was only used for getting the foreground tty process, so now
2081 we just reopen the device (see emacs_get_tty_pgrp) as this is
2082 more portable (see USG_SUBTTY_WORKS above). */
2084 p->pty_flag = 1;
2085 pset_status (p, Qrun);
2086 setup_process_coding_systems (process);
2088 FD_SET (pty_fd, &input_wait_mask);
2089 FD_SET (pty_fd, &non_keyboard_wait_mask);
2090 if (pty_fd > max_process_desc)
2091 max_process_desc = pty_fd;
2093 pset_tty_name (p, build_string (pty_name));
2096 p->pid = -2;
2099 DEFUN ("make-pipe-process", Fmake_pipe_process, Smake_pipe_process,
2100 0, MANY, 0,
2101 doc: /* Create and return a bidirectional pipe process.
2103 In Emacs, pipes are represented by process objects, so input and
2104 output work as for subprocesses, and `delete-process' closes a pipe.
2105 However, a pipe process has no process id, it cannot be signaled,
2106 and the status codes are different from normal processes.
2108 Arguments are specified as keyword/argument pairs. The following
2109 arguments are defined:
2111 :name NAME -- NAME is the name of the process. It is modified if necessary to make it unique.
2113 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2114 with the process. Process output goes at the end of that buffer,
2115 unless you specify an output stream or filter function to handle the
2116 output. If BUFFER is not given, the value of NAME is used.
2118 :coding CODING -- If CODING is a symbol, it specifies the coding
2119 system used for both reading and writing for this process. If CODING
2120 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2121 ENCODING is used for writing.
2123 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2124 the process is running. If BOOL is not given, query before exiting.
2126 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2127 In the stopped state, a pipe process does not accept incoming data,
2128 but you can send outgoing data. The stopped state is cleared by
2129 `continue-process' and set by `stop-process'.
2131 :filter FILTER -- Install FILTER as the process filter.
2133 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2135 usage: (make-pipe-process &rest ARGS) */)
2136 (ptrdiff_t nargs, Lisp_Object *args)
2138 Lisp_Object proc, contact;
2139 struct Lisp_Process *p;
2140 Lisp_Object name, buffer;
2141 Lisp_Object tem;
2142 ptrdiff_t specpdl_count;
2143 int inchannel, outchannel;
2145 if (nargs == 0)
2146 return Qnil;
2148 contact = Flist (nargs, args);
2150 name = Fplist_get (contact, QCname);
2151 CHECK_STRING (name);
2152 proc = make_process (name);
2153 specpdl_count = SPECPDL_INDEX ();
2154 record_unwind_protect (remove_process, proc);
2155 p = XPROCESS (proc);
2157 if (emacs_pipe (p->open_fd + SUBPROCESS_STDIN) != 0
2158 || emacs_pipe (p->open_fd + READ_FROM_SUBPROCESS) != 0)
2159 report_file_error ("Creating pipe", Qnil);
2160 outchannel = p->open_fd[WRITE_TO_SUBPROCESS];
2161 inchannel = p->open_fd[READ_FROM_SUBPROCESS];
2163 fcntl (inchannel, F_SETFL, O_NONBLOCK);
2164 fcntl (outchannel, F_SETFL, O_NONBLOCK);
2166 #ifdef WINDOWSNT
2167 register_aux_fd (inchannel);
2168 #endif
2170 /* Record this as an active process, with its channels. */
2171 chan_process[inchannel] = proc;
2172 p->infd = inchannel;
2173 p->outfd = outchannel;
2175 if (inchannel > max_process_desc)
2176 max_process_desc = inchannel;
2178 buffer = Fplist_get (contact, QCbuffer);
2179 if (NILP (buffer))
2180 buffer = name;
2181 buffer = Fget_buffer_create (buffer);
2182 pset_buffer (p, buffer);
2184 pset_childp (p, contact);
2185 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2186 pset_type (p, Qpipe);
2187 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2188 pset_filter (p, Fplist_get (contact, QCfilter));
2189 pset_log (p, Qnil);
2190 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2191 p->kill_without_query = 1;
2192 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2193 pset_command (p, Qt);
2194 eassert (! p->pty_flag);
2196 if (!EQ (p->command, Qt))
2198 FD_SET (inchannel, &input_wait_mask);
2199 FD_SET (inchannel, &non_keyboard_wait_mask);
2201 p->adaptive_read_buffering
2202 = (NILP (Vprocess_adaptive_read_buffering) ? 0
2203 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
2205 /* Make the process marker point into the process buffer (if any). */
2206 if (BUFFERP (buffer))
2207 set_marker_both (p->mark, buffer,
2208 BUF_ZV (XBUFFER (buffer)),
2209 BUF_ZV_BYTE (XBUFFER (buffer)));
2212 /* Setup coding systems for communicating with the network stream. */
2214 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
2215 Lisp_Object coding_systems = Qt;
2216 Lisp_Object val;
2218 tem = Fplist_get (contact, QCcoding);
2219 val = Qnil;
2220 if (!NILP (tem))
2222 val = tem;
2223 if (CONSP (val))
2224 val = XCAR (val);
2226 else if (!NILP (Vcoding_system_for_read))
2227 val = Vcoding_system_for_read;
2228 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2229 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2230 /* We dare not decode end-of-line format by setting VAL to
2231 Qraw_text, because the existing Emacs Lisp libraries
2232 assume that they receive bare code including a sequence of
2233 CR LF. */
2234 val = Qnil;
2235 else
2237 if (CONSP (coding_systems))
2238 val = XCAR (coding_systems);
2239 else if (CONSP (Vdefault_process_coding_system))
2240 val = XCAR (Vdefault_process_coding_system);
2241 else
2242 val = Qnil;
2244 pset_decode_coding_system (p, val);
2246 if (!NILP (tem))
2248 val = tem;
2249 if (CONSP (val))
2250 val = XCDR (val);
2252 else if (!NILP (Vcoding_system_for_write))
2253 val = Vcoding_system_for_write;
2254 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2255 val = Qnil;
2256 else
2258 if (CONSP (coding_systems))
2259 val = XCDR (coding_systems);
2260 else if (CONSP (Vdefault_process_coding_system))
2261 val = XCDR (Vdefault_process_coding_system);
2262 else
2263 val = Qnil;
2265 pset_encode_coding_system (p, val);
2267 /* This may signal an error. */
2268 setup_process_coding_systems (proc);
2270 specpdl_ptr = specpdl + specpdl_count;
2272 return proc;
2276 /* Convert an internal struct sockaddr to a lisp object (vector or string).
2277 The address family of sa is not included in the result. */
2279 Lisp_Object
2280 conv_sockaddr_to_lisp (struct sockaddr *sa, ptrdiff_t len)
2282 Lisp_Object address;
2283 ptrdiff_t i;
2284 unsigned char *cp;
2285 struct Lisp_Vector *p;
2287 /* Workaround for a bug in getsockname on BSD: Names bound to
2288 sockets in the UNIX domain are inaccessible; getsockname returns
2289 a zero length name. */
2290 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
2291 return empty_unibyte_string;
2293 switch (sa->sa_family)
2295 case AF_INET:
2297 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2298 len = sizeof (sin->sin_addr) + 1;
2299 address = Fmake_vector (make_number (len), Qnil);
2300 p = XVECTOR (address);
2301 p->contents[--len] = make_number (ntohs (sin->sin_port));
2302 cp = (unsigned char *) &sin->sin_addr;
2303 break;
2305 #ifdef AF_INET6
2306 case AF_INET6:
2308 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2309 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
2310 len = sizeof (sin6->sin6_addr) / 2 + 1;
2311 address = Fmake_vector (make_number (len), Qnil);
2312 p = XVECTOR (address);
2313 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2314 for (i = 0; i < len; i++)
2315 p->contents[i] = make_number (ntohs (ip6[i]));
2316 return address;
2318 #endif
2319 #ifdef HAVE_LOCAL_SOCKETS
2320 case AF_LOCAL:
2322 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2323 ptrdiff_t name_length = len - offsetof (struct sockaddr_un, sun_path);
2324 /* If the first byte is NUL, the name is a Linux abstract
2325 socket name, and the name can contain embedded NULs. If
2326 it's not, we have a NUL-terminated string. Be careful not
2327 to walk past the end of the object looking for the name
2328 terminator, however. */
2329 if (name_length > 0 && sockun->sun_path[0] != '\0')
2331 const char *terminator
2332 = memchr (sockun->sun_path, '\0', name_length);
2334 if (terminator)
2335 name_length = terminator - (const char *) sockun->sun_path;
2338 return make_unibyte_string (sockun->sun_path, name_length);
2340 #endif
2341 default:
2342 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2343 address = Fcons (make_number (sa->sa_family),
2344 Fmake_vector (make_number (len), Qnil));
2345 p = XVECTOR (XCDR (address));
2346 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2347 break;
2350 i = 0;
2351 while (i < len)
2352 p->contents[i++] = make_number (*cp++);
2354 return address;
2357 /* Convert an internal struct addrinfo to a Lisp object. */
2359 static Lisp_Object
2360 conv_addrinfo_to_lisp (struct addrinfo *res)
2362 Lisp_Object protocol = make_number (res->ai_protocol);
2363 eassert (XINT (protocol) == res->ai_protocol);
2364 return Fcons (protocol, conv_sockaddr_to_lisp (res->ai_addr, res->ai_addrlen));
2368 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2370 static ptrdiff_t
2371 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2373 struct Lisp_Vector *p;
2375 if (VECTORP (address))
2377 p = XVECTOR (address);
2378 if (p->header.size == 5)
2380 *familyp = AF_INET;
2381 return sizeof (struct sockaddr_in);
2383 #ifdef AF_INET6
2384 else if (p->header.size == 9)
2386 *familyp = AF_INET6;
2387 return sizeof (struct sockaddr_in6);
2389 #endif
2391 #ifdef HAVE_LOCAL_SOCKETS
2392 else if (STRINGP (address))
2394 *familyp = AF_LOCAL;
2395 return sizeof (struct sockaddr_un);
2397 #endif
2398 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2399 && VECTORP (XCDR (address)))
2401 struct sockaddr *sa;
2402 p = XVECTOR (XCDR (address));
2403 if (MAX_ALLOCA - sizeof sa->sa_family < p->header.size)
2404 return 0;
2405 *familyp = XINT (XCAR (address));
2406 return p->header.size + sizeof (sa->sa_family);
2408 return 0;
2411 /* Convert an address object (vector or string) to an internal sockaddr.
2413 The address format has been basically validated by
2414 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2415 it could have come from user data. So if FAMILY is not valid,
2416 we return after zeroing *SA. */
2418 static void
2419 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2421 register struct Lisp_Vector *p;
2422 register unsigned char *cp = NULL;
2423 register int i;
2424 EMACS_INT hostport;
2426 memset (sa, 0, len);
2428 if (VECTORP (address))
2430 p = XVECTOR (address);
2431 if (family == AF_INET)
2433 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2434 len = sizeof (sin->sin_addr) + 1;
2435 hostport = XINT (p->contents[--len]);
2436 sin->sin_port = htons (hostport);
2437 cp = (unsigned char *)&sin->sin_addr;
2438 sa->sa_family = family;
2440 #ifdef AF_INET6
2441 else if (family == AF_INET6)
2443 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2444 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2445 len = sizeof (sin6->sin6_addr) / 2 + 1;
2446 hostport = XINT (p->contents[--len]);
2447 sin6->sin6_port = htons (hostport);
2448 for (i = 0; i < len; i++)
2449 if (INTEGERP (p->contents[i]))
2451 int j = XFASTINT (p->contents[i]) & 0xffff;
2452 ip6[i] = ntohs (j);
2454 sa->sa_family = family;
2455 return;
2457 #endif
2458 else
2459 return;
2461 else if (STRINGP (address))
2463 #ifdef HAVE_LOCAL_SOCKETS
2464 if (family == AF_LOCAL)
2466 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2467 cp = SDATA (address);
2468 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2469 sockun->sun_path[i] = *cp++;
2470 sa->sa_family = family;
2472 #endif
2473 return;
2475 else
2477 p = XVECTOR (XCDR (address));
2478 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2481 for (i = 0; i < len; i++)
2482 if (INTEGERP (p->contents[i]))
2483 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2486 #ifdef DATAGRAM_SOCKETS
2487 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2488 1, 1, 0,
2489 doc: /* Get the current datagram address associated with PROCESS.
2490 If PROCESS is a non-blocking network process that hasn't been fully
2491 set up yet, this function will block until socket setup has completed. */)
2492 (Lisp_Object process)
2494 int channel;
2496 CHECK_PROCESS (process);
2498 if (NETCONN_P (process))
2499 wait_for_socket_fds (process, "process-datagram-address");
2501 if (!DATAGRAM_CONN_P (process))
2502 return Qnil;
2504 channel = XPROCESS (process)->infd;
2505 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2506 datagram_address[channel].len);
2509 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2510 2, 2, 0,
2511 doc: /* Set the datagram address for PROCESS to ADDRESS.
2512 Return nil upon error setting address, ADDRESS otherwise.
2514 If PROCESS is a non-blocking network process that hasn't been fully
2515 set up yet, this function will block until socket setup has completed. */)
2516 (Lisp_Object process, Lisp_Object address)
2518 int channel;
2519 int family;
2520 ptrdiff_t len;
2522 CHECK_PROCESS (process);
2524 if (NETCONN_P (process))
2525 wait_for_socket_fds (process, "set-process-datagram-address");
2527 if (!DATAGRAM_CONN_P (process))
2528 return Qnil;
2530 channel = XPROCESS (process)->infd;
2532 len = get_lisp_to_sockaddr_size (address, &family);
2533 if (len == 0 || datagram_address[channel].len != len)
2534 return Qnil;
2535 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2536 return address;
2538 #endif
2541 static const struct socket_options {
2542 /* The name of this option. Should be lowercase version of option
2543 name without SO_ prefix. */
2544 const char *name;
2545 /* Option level SOL_... */
2546 int optlevel;
2547 /* Option number SO_... */
2548 int optnum;
2549 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2550 enum { OPIX_NONE = 0, OPIX_MISC = 1, OPIX_REUSEADDR = 2 } optbit;
2551 } socket_options[] =
2553 #ifdef SO_BINDTODEVICE
2554 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2555 #endif
2556 #ifdef SO_BROADCAST
2557 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2558 #endif
2559 #ifdef SO_DONTROUTE
2560 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2561 #endif
2562 #ifdef SO_KEEPALIVE
2563 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2564 #endif
2565 #ifdef SO_LINGER
2566 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2567 #endif
2568 #ifdef SO_OOBINLINE
2569 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2570 #endif
2571 #ifdef SO_PRIORITY
2572 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2573 #endif
2574 #ifdef SO_REUSEADDR
2575 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2576 #endif
2577 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2580 /* Set option OPT to value VAL on socket S.
2582 Return (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2583 Signals an error if setting a known option fails.
2586 static int
2587 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2589 char *name;
2590 const struct socket_options *sopt;
2591 int ret = 0;
2593 CHECK_SYMBOL (opt);
2595 name = SSDATA (SYMBOL_NAME (opt));
2596 for (sopt = socket_options; sopt->name; sopt++)
2597 if (strcmp (name, sopt->name) == 0)
2598 break;
2600 switch (sopt->opttype)
2602 case SOPT_BOOL:
2604 int optval;
2605 optval = NILP (val) ? 0 : 1;
2606 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2607 &optval, sizeof (optval));
2608 break;
2611 case SOPT_INT:
2613 int optval;
2614 if (TYPE_RANGED_INTEGERP (int, val))
2615 optval = XINT (val);
2616 else
2617 error ("Bad option value for %s", name);
2618 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2619 &optval, sizeof (optval));
2620 break;
2623 #ifdef SO_BINDTODEVICE
2624 case SOPT_IFNAME:
2626 char devname[IFNAMSIZ + 1];
2628 /* This is broken, at least in the Linux 2.4 kernel.
2629 To unbind, the arg must be a zero integer, not the empty string.
2630 This should work on all systems. KFS. 2003-09-23. */
2631 memset (devname, 0, sizeof devname);
2632 if (STRINGP (val))
2634 char *arg = SSDATA (val);
2635 int len = min (strlen (arg), IFNAMSIZ);
2636 memcpy (devname, arg, len);
2638 else if (!NILP (val))
2639 error ("Bad option value for %s", name);
2640 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2641 devname, IFNAMSIZ);
2642 break;
2644 #endif
2646 #ifdef SO_LINGER
2647 case SOPT_LINGER:
2649 struct linger linger;
2651 linger.l_onoff = 1;
2652 linger.l_linger = 0;
2653 if (TYPE_RANGED_INTEGERP (int, val))
2654 linger.l_linger = XINT (val);
2655 else
2656 linger.l_onoff = NILP (val) ? 0 : 1;
2657 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2658 &linger, sizeof (linger));
2659 break;
2661 #endif
2663 default:
2664 return 0;
2667 if (ret < 0)
2669 int setsockopt_errno = errno;
2670 report_file_errno ("Cannot set network option", list2 (opt, val),
2671 setsockopt_errno);
2674 return (1 << sopt->optbit);
2678 DEFUN ("set-network-process-option",
2679 Fset_network_process_option, Sset_network_process_option,
2680 3, 4, 0,
2681 doc: /* For network process PROCESS set option OPTION to value VALUE.
2682 See `make-network-process' for a list of options and values.
2683 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2684 OPTION is not a supported option, return nil instead; otherwise return t.
2686 If PROCESS is a non-blocking network process that hasn't been fully
2687 set up yet, this function will block until socket setup has completed. */)
2688 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2690 int s;
2691 struct Lisp_Process *p;
2693 CHECK_PROCESS (process);
2694 p = XPROCESS (process);
2695 if (!NETCONN1_P (p))
2696 error ("Process is not a network process");
2698 wait_for_socket_fds (process, "set-network-process-option");
2700 s = p->infd;
2701 if (s < 0)
2702 error ("Process is not running");
2704 if (set_socket_option (s, option, value))
2706 pset_childp (p, Fplist_put (p->childp, option, value));
2707 return Qt;
2710 if (NILP (no_error))
2711 error ("Unknown or unsupported option");
2713 return Qnil;
2717 DEFUN ("serial-process-configure",
2718 Fserial_process_configure,
2719 Sserial_process_configure,
2720 0, MANY, 0,
2721 doc: /* Configure speed, bytesize, etc. of a serial process.
2723 Arguments are specified as keyword/argument pairs. Attributes that
2724 are not given are re-initialized from the process's current
2725 configuration (available via the function `process-contact') or set to
2726 reasonable default values. The following arguments are defined:
2728 :process PROCESS
2729 :name NAME
2730 :buffer BUFFER
2731 :port PORT
2732 -- Any of these arguments can be given to identify the process that is
2733 to be configured. If none of these arguments is given, the current
2734 buffer's process is used.
2736 :speed SPEED -- SPEED is the speed of the serial port in bits per
2737 second, also called baud rate. Any value can be given for SPEED, but
2738 most serial ports work only at a few defined values between 1200 and
2739 115200, with 9600 being the most common value. If SPEED is nil, the
2740 serial port is not configured any further, i.e., all other arguments
2741 are ignored. This may be useful for special serial ports such as
2742 Bluetooth-to-serial converters which can only be configured through AT
2743 commands. A value of nil for SPEED can be used only when passed
2744 through `make-serial-process' or `serial-term'.
2746 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2747 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2749 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2750 `odd' (use odd parity), or the symbol `even' (use even parity). If
2751 PARITY is not given, no parity is used.
2753 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2754 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2755 is not given or nil, 1 stopbit is used.
2757 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2758 flowcontrol to be used, which is either nil (don't use flowcontrol),
2759 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2760 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2761 flowcontrol is used.
2763 `serial-process-configure' is called by `make-serial-process' for the
2764 initial configuration of the serial port.
2766 Examples:
2768 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2770 \(serial-process-configure
2771 :buffer "COM1" :stopbits 1 :parity \\='odd :flowcontrol \\='hw)
2773 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2775 usage: (serial-process-configure &rest ARGS) */)
2776 (ptrdiff_t nargs, Lisp_Object *args)
2778 struct Lisp_Process *p;
2779 Lisp_Object contact = Qnil;
2780 Lisp_Object proc = Qnil;
2782 contact = Flist (nargs, args);
2784 proc = Fplist_get (contact, QCprocess);
2785 if (NILP (proc))
2786 proc = Fplist_get (contact, QCname);
2787 if (NILP (proc))
2788 proc = Fplist_get (contact, QCbuffer);
2789 if (NILP (proc))
2790 proc = Fplist_get (contact, QCport);
2791 proc = get_process (proc);
2792 p = XPROCESS (proc);
2793 if (!EQ (p->type, Qserial))
2794 error ("Not a serial process");
2796 if (NILP (Fplist_get (p->childp, QCspeed)))
2797 return Qnil;
2799 serial_configure (p, contact);
2800 return Qnil;
2803 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2804 0, MANY, 0,
2805 doc: /* Create and return a serial port process.
2807 In Emacs, serial port connections are represented by process objects,
2808 so input and output work as for subprocesses, and `delete-process'
2809 closes a serial port connection. However, a serial process has no
2810 process id, it cannot be signaled, and the status codes are different
2811 from normal processes.
2813 `make-serial-process' creates a process and a buffer, on which you
2814 probably want to use `process-send-string'. Try \\[serial-term] for
2815 an interactive terminal. See below for examples.
2817 Arguments are specified as keyword/argument pairs. The following
2818 arguments are defined:
2820 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2821 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2822 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2823 the backslashes in strings).
2825 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2826 which this function calls.
2828 :name NAME -- NAME is the name of the process. If NAME is not given,
2829 the value of PORT is used.
2831 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2832 with the process. Process output goes at the end of that buffer,
2833 unless you specify an output stream or filter function to handle the
2834 output. If BUFFER is not given, the value of NAME is used.
2836 :coding CODING -- If CODING is a symbol, it specifies the coding
2837 system used for both reading and writing for this process. If CODING
2838 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2839 ENCODING is used for writing.
2841 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2842 the process is running. If BOOL is not given, query before exiting.
2844 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2845 In the stopped state, a serial process does not accept incoming data,
2846 but you can send outgoing data. The stopped state is cleared by
2847 `continue-process' and set by `stop-process'.
2849 :filter FILTER -- Install FILTER as the process filter.
2851 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2853 :plist PLIST -- Install PLIST as the initial plist of the process.
2855 :bytesize
2856 :parity
2857 :stopbits
2858 :flowcontrol
2859 -- This function calls `serial-process-configure' to handle these
2860 arguments.
2862 The original argument list, possibly modified by later configuration,
2863 is available via the function `process-contact'.
2865 Examples:
2867 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2869 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2871 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity \\='odd)
2873 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2875 usage: (make-serial-process &rest ARGS) */)
2876 (ptrdiff_t nargs, Lisp_Object *args)
2878 int fd = -1;
2879 Lisp_Object proc, contact, port;
2880 struct Lisp_Process *p;
2881 Lisp_Object name, buffer;
2882 Lisp_Object tem, val;
2883 ptrdiff_t specpdl_count;
2885 if (nargs == 0)
2886 return Qnil;
2888 contact = Flist (nargs, args);
2890 port = Fplist_get (contact, QCport);
2891 if (NILP (port))
2892 error ("No port specified");
2893 CHECK_STRING (port);
2895 if (NILP (Fplist_member (contact, QCspeed)))
2896 error (":speed not specified");
2897 if (!NILP (Fplist_get (contact, QCspeed)))
2898 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2900 name = Fplist_get (contact, QCname);
2901 if (NILP (name))
2902 name = port;
2903 CHECK_STRING (name);
2904 proc = make_process (name);
2905 specpdl_count = SPECPDL_INDEX ();
2906 record_unwind_protect (remove_process, proc);
2907 p = XPROCESS (proc);
2909 fd = serial_open (port);
2910 p->open_fd[SUBPROCESS_STDIN] = fd;
2911 p->infd = fd;
2912 p->outfd = fd;
2913 if (fd > max_process_desc)
2914 max_process_desc = fd;
2915 chan_process[fd] = proc;
2917 buffer = Fplist_get (contact, QCbuffer);
2918 if (NILP (buffer))
2919 buffer = name;
2920 buffer = Fget_buffer_create (buffer);
2921 pset_buffer (p, buffer);
2923 pset_childp (p, contact);
2924 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2925 pset_type (p, Qserial);
2926 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2927 pset_filter (p, Fplist_get (contact, QCfilter));
2928 pset_log (p, Qnil);
2929 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2930 p->kill_without_query = 1;
2931 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2932 pset_command (p, Qt);
2933 eassert (! p->pty_flag);
2935 if (!EQ (p->command, Qt))
2937 FD_SET (fd, &input_wait_mask);
2938 FD_SET (fd, &non_keyboard_wait_mask);
2941 if (BUFFERP (buffer))
2943 set_marker_both (p->mark, buffer,
2944 BUF_ZV (XBUFFER (buffer)),
2945 BUF_ZV_BYTE (XBUFFER (buffer)));
2948 tem = Fplist_member (contact, QCcoding);
2949 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2950 tem = Qnil;
2952 val = Qnil;
2953 if (!NILP (tem))
2955 val = XCAR (XCDR (tem));
2956 if (CONSP (val))
2957 val = XCAR (val);
2959 else if (!NILP (Vcoding_system_for_read))
2960 val = Vcoding_system_for_read;
2961 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2962 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2963 val = Qnil;
2964 pset_decode_coding_system (p, val);
2966 val = Qnil;
2967 if (!NILP (tem))
2969 val = XCAR (XCDR (tem));
2970 if (CONSP (val))
2971 val = XCDR (val);
2973 else if (!NILP (Vcoding_system_for_write))
2974 val = Vcoding_system_for_write;
2975 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2976 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2977 val = Qnil;
2978 pset_encode_coding_system (p, val);
2980 setup_process_coding_systems (proc);
2981 pset_decoding_buf (p, empty_unibyte_string);
2982 p->decoding_carryover = 0;
2983 pset_encoding_buf (p, empty_unibyte_string);
2984 p->inherit_coding_system_flag
2985 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2987 Fserial_process_configure (nargs, args);
2989 specpdl_ptr = specpdl + specpdl_count;
2991 return proc;
2994 static void
2995 set_network_socket_coding_system (Lisp_Object proc, Lisp_Object host,
2996 Lisp_Object service, Lisp_Object name)
2998 Lisp_Object tem;
2999 struct Lisp_Process *p = XPROCESS (proc);
3000 Lisp_Object contact = p->childp;
3001 Lisp_Object coding_systems = Qt;
3002 Lisp_Object val;
3004 tem = Fplist_member (contact, QCcoding);
3005 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3006 tem = Qnil; /* No error message (too late!). */
3008 /* Setup coding systems for communicating with the network stream. */
3009 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3011 if (!NILP (tem))
3013 val = XCAR (XCDR (tem));
3014 if (CONSP (val))
3015 val = XCAR (val);
3017 else if (!NILP (Vcoding_system_for_read))
3018 val = Vcoding_system_for_read;
3019 else if ((!NILP (p->buffer)
3020 && NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
3021 || (NILP (p->buffer)
3022 && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3023 /* We dare not decode end-of-line format by setting VAL to
3024 Qraw_text, because the existing Emacs Lisp libraries
3025 assume that they receive bare code including a sequence of
3026 CR LF. */
3027 val = Qnil;
3028 else
3030 if (NILP (host) || NILP (service))
3031 coding_systems = Qnil;
3032 else
3033 coding_systems = CALLN (Ffind_operation_coding_system,
3034 Qopen_network_stream, name, p->buffer,
3035 host, service);
3036 if (CONSP (coding_systems))
3037 val = XCAR (coding_systems);
3038 else if (CONSP (Vdefault_process_coding_system))
3039 val = XCAR (Vdefault_process_coding_system);
3040 else
3041 val = Qnil;
3043 pset_decode_coding_system (p, val);
3045 if (!NILP (tem))
3047 val = XCAR (XCDR (tem));
3048 if (CONSP (val))
3049 val = XCDR (val);
3051 else if (!NILP (Vcoding_system_for_write))
3052 val = Vcoding_system_for_write;
3053 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3054 val = Qnil;
3055 else
3057 if (EQ (coding_systems, Qt))
3059 if (NILP (host) || NILP (service))
3060 coding_systems = Qnil;
3061 else
3062 coding_systems = CALLN (Ffind_operation_coding_system,
3063 Qopen_network_stream, name, p->buffer,
3064 host, service);
3066 if (CONSP (coding_systems))
3067 val = XCDR (coding_systems);
3068 else if (CONSP (Vdefault_process_coding_system))
3069 val = XCDR (Vdefault_process_coding_system);
3070 else
3071 val = Qnil;
3073 pset_encode_coding_system (p, val);
3075 pset_decoding_buf (p, empty_unibyte_string);
3076 p->decoding_carryover = 0;
3077 pset_encoding_buf (p, empty_unibyte_string);
3079 p->inherit_coding_system_flag
3080 = !(!NILP (tem) || NILP (p->buffer) || !inherit_process_coding_system);
3083 #ifdef HAVE_GNUTLS
3084 static void
3085 finish_after_tls_connection (Lisp_Object proc)
3087 struct Lisp_Process *p = XPROCESS (proc);
3088 Lisp_Object contact = p->childp;
3089 Lisp_Object result = Qt;
3091 if (!NILP (Ffboundp (Qnsm_verify_connection)))
3092 result = call3 (Qnsm_verify_connection,
3093 proc,
3094 Fplist_get (contact, QChost),
3095 Fplist_get (contact, QCservice));
3097 if (NILP (result))
3099 pset_status (p, list2 (Qfailed,
3100 build_string ("The Network Security Manager stopped the connections")));
3101 deactivate_process (proc);
3103 else
3105 /* If we cleared the connection wait mask before we did
3106 the TLS setup, then we have to say that the process
3107 is finally "open" here. */
3108 if (! FD_ISSET (p->outfd, &connect_wait_mask))
3110 pset_status (p, Qrun);
3111 /* Execute the sentinel here. If we had relied on
3112 status_notify to do it later, it will read input
3113 from the process before calling the sentinel. */
3114 exec_sentinel (proc, build_string ("open\n"));
3118 #endif
3120 static void
3121 connect_network_socket (Lisp_Object proc, Lisp_Object addrinfos,
3122 Lisp_Object use_external_socket_p)
3124 ptrdiff_t count = SPECPDL_INDEX ();
3125 ptrdiff_t count1;
3126 int s = -1, outch, inch;
3127 int xerrno = 0;
3128 int family;
3129 struct sockaddr *sa = NULL;
3130 int ret;
3131 ptrdiff_t addrlen;
3132 struct Lisp_Process *p = XPROCESS (proc);
3133 Lisp_Object contact = p->childp;
3134 int optbits = 0;
3135 int socket_to_use = -1;
3137 if (!NILP (use_external_socket_p))
3139 socket_to_use = external_sock_fd;
3141 /* Ensure we don't consume the external socket twice. */
3142 external_sock_fd = -1;
3145 /* Do this in case we never enter the while-loop below. */
3146 count1 = SPECPDL_INDEX ();
3147 s = -1;
3149 while (!NILP (addrinfos))
3151 Lisp_Object addrinfo = XCAR (addrinfos);
3152 addrinfos = XCDR (addrinfos);
3153 int protocol = XINT (XCAR (addrinfo));
3154 Lisp_Object ip_address = XCDR (addrinfo);
3156 #ifdef WINDOWSNT
3157 retry_connect:
3158 #endif
3160 addrlen = get_lisp_to_sockaddr_size (ip_address, &family);
3161 if (sa)
3162 free (sa);
3163 sa = xmalloc (addrlen);
3164 conv_lisp_to_sockaddr (family, ip_address, sa, addrlen);
3166 s = socket_to_use;
3167 if (s < 0)
3169 int socktype = p->socktype | SOCK_CLOEXEC;
3170 if (p->is_non_blocking_client)
3171 socktype |= SOCK_NONBLOCK;
3172 s = socket (family, socktype, protocol);
3173 if (s < 0)
3175 xerrno = errno;
3176 continue;
3180 if (p->is_non_blocking_client && ! (SOCK_NONBLOCK && socket_to_use < 0))
3182 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3183 if (ret < 0)
3185 xerrno = errno;
3186 emacs_close (s);
3187 s = -1;
3188 if (socket_to_use < 0)
3189 break;
3190 continue;
3194 #ifdef DATAGRAM_SOCKETS
3195 if (!p->is_server && p->socktype == SOCK_DGRAM)
3196 break;
3197 #endif /* DATAGRAM_SOCKETS */
3199 /* Make us close S if quit. */
3200 record_unwind_protect_int (close_file_unwind, s);
3202 /* Parse network options in the arg list. We simply ignore anything
3203 which isn't a known option (including other keywords). An error
3204 is signaled if setting a known option fails. */
3206 Lisp_Object params = contact, key, val;
3208 while (!NILP (params))
3210 key = XCAR (params);
3211 params = XCDR (params);
3212 val = XCAR (params);
3213 params = XCDR (params);
3214 optbits |= set_socket_option (s, key, val);
3218 if (p->is_server)
3220 /* Configure as a server socket. */
3222 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3223 explicit :reuseaddr key to override this. */
3224 #ifdef HAVE_LOCAL_SOCKETS
3225 if (family != AF_LOCAL)
3226 #endif
3227 if (!(optbits & (1 << OPIX_REUSEADDR)))
3229 int optval = 1;
3230 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3231 report_file_error ("Cannot set reuse option on server socket", Qnil);
3234 /* If passed a socket descriptor, it should be already bound. */
3235 if (socket_to_use < 0 && bind (s, sa, addrlen) != 0)
3236 report_file_error ("Cannot bind server socket", Qnil);
3238 #ifdef HAVE_GETSOCKNAME
3239 if (p->port == 0)
3241 struct sockaddr_in sa1;
3242 socklen_t len1 = sizeof (sa1);
3243 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3245 Lisp_Object service;
3246 service = make_number (ntohs (sa1.sin_port));
3247 contact = Fplist_put (contact, QCservice, service);
3248 /* Save the port number so that we can stash it in
3249 the process object later. */
3250 ((struct sockaddr_in *)sa)->sin_port = sa1.sin_port;
3253 #endif
3255 if (p->socktype != SOCK_DGRAM && listen (s, p->backlog))
3256 report_file_error ("Cannot listen on server socket", Qnil);
3258 break;
3261 immediate_quit = 1;
3262 QUIT;
3264 ret = connect (s, sa, addrlen);
3265 xerrno = errno;
3267 if (ret == 0 || xerrno == EISCONN)
3269 /* The unwind-protect will be discarded afterwards.
3270 Likewise for immediate_quit. */
3271 break;
3274 if (p->is_non_blocking_client && xerrno == EINPROGRESS)
3275 break;
3277 #ifndef WINDOWSNT
3278 if (xerrno == EINTR)
3280 /* Unlike most other syscalls connect() cannot be called
3281 again. (That would return EALREADY.) The proper way to
3282 wait for completion is pselect(). */
3283 int sc;
3284 socklen_t len;
3285 fd_set fdset;
3286 retry_select:
3287 FD_ZERO (&fdset);
3288 FD_SET (s, &fdset);
3289 QUIT;
3290 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3291 if (sc == -1)
3293 if (errno == EINTR)
3294 goto retry_select;
3295 else
3296 report_file_error ("Failed select", Qnil);
3298 eassert (sc > 0);
3300 len = sizeof xerrno;
3301 eassert (FD_ISSET (s, &fdset));
3302 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) < 0)
3303 report_file_error ("Failed getsockopt", Qnil);
3304 if (xerrno == 0)
3305 break;
3306 if (NILP (addrinfos))
3307 report_file_errno ("Failed connect", Qnil, xerrno);
3309 #endif /* !WINDOWSNT */
3311 immediate_quit = 0;
3313 /* Discard the unwind protect closing S. */
3314 specpdl_ptr = specpdl + count1;
3315 emacs_close (s);
3316 s = -1;
3317 if (socket_to_use < 0)
3318 break;
3320 #ifdef WINDOWSNT
3321 if (xerrno == EINTR)
3322 goto retry_connect;
3323 #endif
3326 if (s >= 0)
3328 #ifdef DATAGRAM_SOCKETS
3329 if (p->socktype == SOCK_DGRAM)
3331 if (datagram_address[s].sa)
3332 emacs_abort ();
3334 datagram_address[s].sa = xmalloc (addrlen);
3335 datagram_address[s].len = addrlen;
3336 if (p->is_server)
3338 Lisp_Object remote;
3339 memset (datagram_address[s].sa, 0, addrlen);
3340 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3342 int rfamily;
3343 ptrdiff_t rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3344 if (rlen != 0 && rfamily == family
3345 && rlen == addrlen)
3346 conv_lisp_to_sockaddr (rfamily, remote,
3347 datagram_address[s].sa, rlen);
3350 else
3351 memcpy (datagram_address[s].sa, sa, addrlen);
3353 #endif
3355 contact = Fplist_put (contact, p->is_server? QClocal: QCremote,
3356 conv_sockaddr_to_lisp (sa, addrlen));
3357 #ifdef HAVE_GETSOCKNAME
3358 if (!p->is_server)
3360 struct sockaddr_in sa1;
3361 socklen_t len1 = sizeof (sa1);
3362 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3363 contact = Fplist_put (contact, QClocal,
3364 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3366 #endif
3369 immediate_quit = 0;
3371 if (s < 0)
3373 /* If non-blocking got this far - and failed - assume non-blocking is
3374 not supported after all. This is probably a wrong assumption, but
3375 the normal blocking calls to open-network-stream handles this error
3376 better. */
3377 if (p->is_non_blocking_client)
3378 return;
3380 report_file_errno ((p->is_server
3381 ? "make server process failed"
3382 : "make client process failed"),
3383 contact, xerrno);
3386 inch = s;
3387 outch = s;
3389 chan_process[inch] = proc;
3391 fcntl (inch, F_SETFL, O_NONBLOCK);
3393 p = XPROCESS (proc);
3394 p->open_fd[SUBPROCESS_STDIN] = inch;
3395 p->infd = inch;
3396 p->outfd = outch;
3398 /* Discard the unwind protect for closing S, if any. */
3399 specpdl_ptr = specpdl + count1;
3401 /* Unwind bind_polling_period and request_sigio. */
3402 unbind_to (count, Qnil);
3404 if (p->is_server && p->socktype != SOCK_DGRAM)
3405 pset_status (p, Qlisten);
3407 /* Make the process marker point into the process buffer (if any). */
3408 if (BUFFERP (p->buffer))
3409 set_marker_both (p->mark, p->buffer,
3410 BUF_ZV (XBUFFER (p->buffer)),
3411 BUF_ZV_BYTE (XBUFFER (p->buffer)));
3413 if (p->is_non_blocking_client)
3415 /* We may get here if connect did succeed immediately. However,
3416 in that case, we still need to signal this like a non-blocking
3417 connection. */
3418 if (! (connecting_status (p->status)
3419 && EQ (XCDR (p->status), addrinfos)))
3420 pset_status (p, Fcons (Qconnect, addrinfos));
3421 if (!FD_ISSET (inch, &connect_wait_mask))
3423 FD_SET (inch, &connect_wait_mask);
3424 FD_SET (inch, &write_mask);
3425 num_pending_connects++;
3428 else
3429 /* A server may have a client filter setting of Qt, but it must
3430 still listen for incoming connects unless it is stopped. */
3431 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3432 || (EQ (p->status, Qlisten) && NILP (p->command)))
3434 FD_SET (inch, &input_wait_mask);
3435 FD_SET (inch, &non_keyboard_wait_mask);
3438 if (inch > max_process_desc)
3439 max_process_desc = inch;
3441 /* Set up the masks based on the process filter. */
3442 set_process_filter_masks (p);
3444 setup_process_coding_systems (proc);
3446 #ifdef HAVE_GNUTLS
3447 /* Continue the asynchronous connection. */
3448 if (!NILP (p->gnutls_boot_parameters))
3450 Lisp_Object boot, params = p->gnutls_boot_parameters;
3452 boot = Fgnutls_boot (proc, XCAR (params), XCDR (params));
3453 p->gnutls_boot_parameters = Qnil;
3455 if (p->gnutls_initstage == GNUTLS_STAGE_READY)
3456 /* Run sentinels, etc. */
3457 finish_after_tls_connection (proc);
3458 else if (p->gnutls_initstage != GNUTLS_STAGE_HANDSHAKE_TRIED)
3460 deactivate_process (proc);
3461 if (NILP (boot))
3462 pset_status (p, list2 (Qfailed,
3463 build_string ("TLS negotiation failed")));
3464 else
3465 pset_status (p, list2 (Qfailed, boot));
3468 #endif
3472 /* Create a network stream/datagram client/server process. Treated
3473 exactly like a normal process when reading and writing. Primary
3474 differences are in status display and process deletion. A network
3475 connection has no PID; you cannot signal it. All you can do is
3476 stop/continue it and deactivate/close it via delete-process. */
3478 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
3479 0, MANY, 0,
3480 doc: /* Create and return a network server or client process.
3482 In Emacs, network connections are represented by process objects, so
3483 input and output work as for subprocesses and `delete-process' closes
3484 a network connection. However, a network process has no process id,
3485 it cannot be signaled, and the status codes are different from normal
3486 processes.
3488 Arguments are specified as keyword/argument pairs. The following
3489 arguments are defined:
3491 :name NAME -- NAME is name for process. It is modified if necessary
3492 to make it unique.
3494 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
3495 with the process. Process output goes at end of that buffer, unless
3496 you specify an output stream or filter function to handle the output.
3497 BUFFER may be also nil, meaning that this process is not associated
3498 with any buffer.
3500 :host HOST -- HOST is name of the host to connect to, or its IP
3501 address. The symbol `local' specifies the local host. If specified
3502 for a server process, it must be a valid name or address for the local
3503 host, and only clients connecting to that address will be accepted.
3505 :service SERVICE -- SERVICE is name of the service desired, or an
3506 integer specifying a port number to connect to. If SERVICE is t,
3507 a random port number is selected for the server. A port number can
3508 be specified as an integer string, e.g., "80", as well as an integer.
3510 :type TYPE -- TYPE is the type of connection. The default (nil) is a
3511 stream type connection, `datagram' creates a datagram type connection,
3512 `seqpacket' creates a reliable datagram connection.
3514 :family FAMILY -- FAMILY is the address (and protocol) family for the
3515 service specified by HOST and SERVICE. The default (nil) is to use
3516 whatever address family (IPv4 or IPv6) that is defined for the host
3517 and port number specified by HOST and SERVICE. Other address families
3518 supported are:
3519 local -- for a local (i.e. UNIX) address specified by SERVICE.
3520 ipv4 -- use IPv4 address family only.
3521 ipv6 -- use IPv6 address family only.
3523 :local ADDRESS -- ADDRESS is the local address used for the connection.
3524 This parameter is ignored when opening a client process. When specified
3525 for a server process, the FAMILY, HOST and SERVICE args are ignored.
3527 :remote ADDRESS -- ADDRESS is the remote partner's address for the
3528 connection. This parameter is ignored when opening a stream server
3529 process. For a datagram server process, it specifies the initial
3530 setting of the remote datagram address. When specified for a client
3531 process, the FAMILY, HOST, and SERVICE args are ignored.
3533 The format of ADDRESS depends on the address family:
3534 - An IPv4 address is represented as an vector of integers [A B C D P]
3535 corresponding to numeric IP address A.B.C.D and port number P.
3536 - A local address is represented as a string with the address in the
3537 local address space.
3538 - An "unsupported family" address is represented by a cons (F . AV)
3539 where F is the family number and AV is a vector containing the socket
3540 address data with one element per address data byte. Do not rely on
3541 this format in portable code, as it may depend on implementation
3542 defined constants, data sizes, and data structure alignment.
3544 :coding CODING -- If CODING is a symbol, it specifies the coding
3545 system used for both reading and writing for this process. If CODING
3546 is a cons (DECODING . ENCODING), DECODING is used for reading, and
3547 ENCODING is used for writing.
3549 :nowait BOOL -- If NOWAIT is non-nil for a stream type client
3550 process, return without waiting for the connection to complete;
3551 instead, the sentinel function will be called with second arg matching
3552 "open" (if successful) or "failed" when the connect completes.
3553 Default is to use a blocking connect (i.e. wait) for stream type
3554 connections.
3556 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
3557 running when Emacs is exited.
3559 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
3560 In the stopped state, a server process does not accept new
3561 connections, and a client process does not handle incoming traffic.
3562 The stopped state is cleared by `continue-process' and set by
3563 `stop-process'.
3565 :filter FILTER -- Install FILTER as the process filter.
3567 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
3568 process filter are multibyte, otherwise they are unibyte.
3569 If this keyword is not specified, the strings are multibyte if
3570 the default value of `enable-multibyte-characters' is non-nil.
3572 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
3574 :log LOG -- Install LOG as the server process log function. This
3575 function is called when the server accepts a network connection from a
3576 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
3577 is the server process, CLIENT is the new process for the connection,
3578 and MESSAGE is a string.
3580 :plist PLIST -- Install PLIST as the new process's initial plist.
3582 :tls-parameters LIST -- is a list that should be supplied if you're
3583 opening a TLS connection. The first element is the TLS type (either
3584 `gnutls-x509pki' or `gnutls-anon'), and the remaining elements should
3585 be a keyword list accepted by gnutls-boot (as returned by
3586 `gnutls-boot-parameters').
3588 :server QLEN -- if QLEN is non-nil, create a server process for the
3589 specified FAMILY, SERVICE, and connection type (stream or datagram).
3590 If QLEN is an integer, it is used as the max. length of the server's
3591 pending connection queue (also known as the backlog); the default
3592 queue length is 5. Default is to create a client process.
3594 The following network options can be specified for this connection:
3596 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
3597 :dontroute BOOL -- Only send to directly connected hosts.
3598 :keepalive BOOL -- Send keep-alive messages on network stream.
3599 :linger BOOL or TIMEOUT -- Send queued messages before closing.
3600 :oobinline BOOL -- Place out-of-band data in receive data stream.
3601 :priority INT -- Set protocol defined priority for sent packets.
3602 :reuseaddr BOOL -- Allow reusing a recently used local address
3603 (this is allowed by default for a server process).
3604 :bindtodevice NAME -- bind to interface NAME. Using this may require
3605 special privileges on some systems.
3606 :use-external-socket BOOL -- Use any pre-allocated sockets that have
3607 been passed to Emacs. If Emacs wasn't
3608 passed a socket, this option is silently
3609 ignored.
3612 Consult the relevant system programmer's manual pages for more
3613 information on using these options.
3616 A server process will listen for and accept connections from clients.
3617 When a client connection is accepted, a new network process is created
3618 for the connection with the following parameters:
3620 - The client's process name is constructed by concatenating the server
3621 process's NAME and a client identification string.
3622 - If the FILTER argument is non-nil, the client process will not get a
3623 separate process buffer; otherwise, the client's process buffer is a newly
3624 created buffer named after the server process's BUFFER name or process
3625 NAME concatenated with the client identification string.
3626 - The connection type and the process filter and sentinel parameters are
3627 inherited from the server process's TYPE, FILTER and SENTINEL.
3628 - The client process's contact info is set according to the client's
3629 addressing information (typically an IP address and a port number).
3630 - The client process's plist is initialized from the server's plist.
3632 Notice that the FILTER and SENTINEL args are never used directly by
3633 the server process. Also, the BUFFER argument is not used directly by
3634 the server process, but via the optional :log function, accepted (and
3635 failed) connections may be logged in the server process's buffer.
3637 The original argument list, modified with the actual connection
3638 information, is available via the `process-contact' function.
3640 usage: (make-network-process &rest ARGS) */)
3641 (ptrdiff_t nargs, Lisp_Object *args)
3643 Lisp_Object proc;
3644 Lisp_Object contact;
3645 struct Lisp_Process *p;
3646 const char *portstring;
3647 ptrdiff_t portstringlen ATTRIBUTE_UNUSED;
3648 char portbuf[INT_BUFSIZE_BOUND (EMACS_INT)];
3649 #ifdef HAVE_LOCAL_SOCKETS
3650 struct sockaddr_un address_un;
3651 #endif
3652 EMACS_INT port = 0;
3653 Lisp_Object tem;
3654 Lisp_Object name, buffer, host, service, address;
3655 Lisp_Object filter, sentinel, use_external_socket_p;
3656 Lisp_Object addrinfos = Qnil;
3657 int socktype;
3658 int family = -1;
3659 enum { any_protocol = 0 };
3660 #ifdef HAVE_GETADDRINFO_A
3661 struct gaicb *dns_request = NULL;
3662 #endif
3663 ptrdiff_t count = SPECPDL_INDEX ();
3665 if (nargs == 0)
3666 return Qnil;
3668 /* Save arguments for process-contact and clone-process. */
3669 contact = Flist (nargs, args);
3671 #ifdef WINDOWSNT
3672 /* Ensure socket support is loaded if available. */
3673 init_winsock (TRUE);
3674 #endif
3676 /* :type TYPE (nil: stream, datagram */
3677 tem = Fplist_get (contact, QCtype);
3678 if (NILP (tem))
3679 socktype = SOCK_STREAM;
3680 #ifdef DATAGRAM_SOCKETS
3681 else if (EQ (tem, Qdatagram))
3682 socktype = SOCK_DGRAM;
3683 #endif
3684 #ifdef HAVE_SEQPACKET
3685 else if (EQ (tem, Qseqpacket))
3686 socktype = SOCK_SEQPACKET;
3687 #endif
3688 else
3689 error ("Unsupported connection type");
3691 name = Fplist_get (contact, QCname);
3692 buffer = Fplist_get (contact, QCbuffer);
3693 filter = Fplist_get (contact, QCfilter);
3694 sentinel = Fplist_get (contact, QCsentinel);
3695 use_external_socket_p = Fplist_get (contact, QCuse_external_socket);
3697 CHECK_STRING (name);
3699 /* :local ADDRESS or :remote ADDRESS */
3700 tem = Fplist_get (contact, QCserver);
3701 if (NILP (tem))
3702 address = Fplist_get (contact, QCremote);
3703 else
3704 address = Fplist_get (contact, QClocal);
3705 if (!NILP (address))
3707 host = service = Qnil;
3709 if (!get_lisp_to_sockaddr_size (address, &family))
3710 error ("Malformed :address");
3712 addrinfos = list1 (Fcons (make_number (any_protocol), address));
3713 goto open_socket;
3716 /* :family FAMILY -- nil (for Inet), local, or integer. */
3717 tem = Fplist_get (contact, QCfamily);
3718 if (NILP (tem))
3720 #ifdef AF_INET6
3721 family = AF_UNSPEC;
3722 #else
3723 family = AF_INET;
3724 #endif
3726 #ifdef HAVE_LOCAL_SOCKETS
3727 else if (EQ (tem, Qlocal))
3728 family = AF_LOCAL;
3729 #endif
3730 #ifdef AF_INET6
3731 else if (EQ (tem, Qipv6))
3732 family = AF_INET6;
3733 #endif
3734 else if (EQ (tem, Qipv4))
3735 family = AF_INET;
3736 else if (TYPE_RANGED_INTEGERP (int, tem))
3737 family = XINT (tem);
3738 else
3739 error ("Unknown address family");
3741 /* :service SERVICE -- string, integer (port number), or t (random port). */
3742 service = Fplist_get (contact, QCservice);
3744 /* :host HOST -- hostname, ip address, or 'local for localhost. */
3745 host = Fplist_get (contact, QChost);
3746 if (NILP (host))
3748 /* The "connection" function gets it bind info from the address we're
3749 given, so use this dummy address if nothing is specified. */
3750 #ifdef HAVE_LOCAL_SOCKETS
3751 if (family != AF_LOCAL)
3752 #endif
3753 host = build_string ("127.0.0.1");
3755 else
3757 if (EQ (host, Qlocal))
3758 /* Depending on setup, "localhost" may map to different IPv4 and/or
3759 IPv6 addresses, so it's better to be explicit (Bug#6781). */
3760 host = build_string ("127.0.0.1");
3761 CHECK_STRING (host);
3764 #ifdef HAVE_LOCAL_SOCKETS
3765 if (family == AF_LOCAL)
3767 if (!NILP (host))
3769 message (":family local ignores the :host property");
3770 contact = Fplist_put (contact, QChost, Qnil);
3771 host = Qnil;
3773 CHECK_STRING (service);
3774 if (sizeof address_un.sun_path <= SBYTES (service))
3775 error ("Service name too long");
3776 addrinfos = list1 (Fcons (make_number (any_protocol), service));
3777 goto open_socket;
3779 #endif
3781 /* Slow down polling to every ten seconds.
3782 Some kernels have a bug which causes retrying connect to fail
3783 after a connect. Polling can interfere with gethostbyname too. */
3784 #ifdef POLL_FOR_INPUT
3785 if (socktype != SOCK_DGRAM)
3787 record_unwind_protect_void (run_all_atimers);
3788 bind_polling_period (10);
3790 #endif
3792 if (!NILP (host))
3794 /* SERVICE can either be a string or int.
3795 Convert to a C string for later use by getaddrinfo. */
3796 if (EQ (service, Qt))
3798 portstring = "0";
3799 portstringlen = 1;
3801 else if (INTEGERP (service))
3803 portstring = portbuf;
3804 portstringlen = sprintf (portbuf, "%"pI"d", XINT (service));
3806 else
3808 CHECK_STRING (service);
3809 portstring = SSDATA (service);
3810 portstringlen = SBYTES (service);
3814 #ifdef HAVE_GETADDRINFO_A
3815 if (!NILP (host) && !NILP (Fplist_get (contact, QCnowait)))
3817 ptrdiff_t hostlen = SBYTES (host);
3818 struct req
3820 struct gaicb gaicb;
3821 struct addrinfo hints;
3822 char str[FLEXIBLE_ARRAY_MEMBER];
3823 } *req = xmalloc (offsetof (struct req, str)
3824 + hostlen + 1 + portstringlen + 1);
3825 dns_request = &req->gaicb;
3826 dns_request->ar_name = req->str;
3827 dns_request->ar_service = req->str + hostlen + 1;
3828 dns_request->ar_request = &req->hints;
3829 dns_request->ar_result = NULL;
3830 memset (&req->hints, 0, sizeof req->hints);
3831 req->hints.ai_family = family;
3832 req->hints.ai_socktype = socktype;
3833 strcpy (req->str, SSDATA (host));
3834 strcpy (req->str + hostlen + 1, portstring);
3836 int ret = getaddrinfo_a (GAI_NOWAIT, &dns_request, 1, NULL);
3837 if (ret)
3838 error ("%s/%s getaddrinfo_a error %d", SSDATA (host), portstring, ret);
3840 goto open_socket;
3842 #endif /* HAVE_GETADDRINFO_A */
3844 /* If we have a host, use getaddrinfo to resolve both host and service.
3845 Otherwise, use getservbyname to lookup the service. */
3847 if (!NILP (host))
3849 struct addrinfo *res, *lres;
3850 int ret;
3852 immediate_quit = 1;
3853 QUIT;
3855 struct addrinfo hints;
3856 memset (&hints, 0, sizeof hints);
3857 hints.ai_family = family;
3858 hints.ai_socktype = socktype;
3860 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3861 if (ret)
3862 #ifdef HAVE_GAI_STRERROR
3864 synchronize_system_messages_locale ();
3865 char const *str = gai_strerror (ret);
3866 if (! NILP (Vlocale_coding_system))
3867 str = SSDATA (code_convert_string_norecord
3868 (build_string (str), Vlocale_coding_system, 0));
3869 error ("%s/%s %s", SSDATA (host), portstring, str);
3871 #else
3872 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3873 #endif
3874 immediate_quit = 0;
3876 for (lres = res; lres; lres = lres->ai_next)
3877 addrinfos = Fcons (conv_addrinfo_to_lisp (lres), addrinfos);
3879 addrinfos = Fnreverse (addrinfos);
3881 freeaddrinfo (res);
3883 goto open_socket;
3886 /* No hostname has been specified (e.g., a local server process). */
3888 if (EQ (service, Qt))
3889 port = 0;
3890 else if (INTEGERP (service))
3891 port = XINT (service);
3892 else
3894 CHECK_STRING (service);
3896 port = -1;
3897 if (SBYTES (service) != 0)
3899 /* Allow the service to be a string containing the port number,
3900 because that's allowed if you have getaddrbyname. */
3901 char *service_end;
3902 long int lport = strtol (SSDATA (service), &service_end, 10);
3903 if (service_end == SSDATA (service) + SBYTES (service))
3904 port = lport;
3905 else
3907 struct servent *svc_info
3908 = getservbyname (SSDATA (service),
3909 socktype == SOCK_DGRAM ? "udp" : "tcp");
3910 if (svc_info)
3911 port = ntohs (svc_info->s_port);
3916 if (! (0 <= port && port < 1 << 16))
3918 AUTO_STRING (unknown_service, "Unknown service: %s");
3919 xsignal1 (Qerror, CALLN (Fformat, unknown_service, service));
3922 open_socket:
3924 if (!NILP (buffer))
3925 buffer = Fget_buffer_create (buffer);
3926 proc = make_process (name);
3927 p = XPROCESS (proc);
3928 pset_childp (p, contact);
3929 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3930 pset_type (p, Qnetwork);
3932 pset_buffer (p, buffer);
3933 pset_sentinel (p, sentinel);
3934 pset_filter (p, filter);
3935 pset_log (p, Fplist_get (contact, QClog));
3936 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3937 p->kill_without_query = 1;
3938 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3939 pset_command (p, Qt);
3940 p->pid = 0;
3941 p->backlog = 5;
3942 p->is_non_blocking_client = false;
3943 p->is_server = false;
3944 p->port = port;
3945 p->socktype = socktype;
3946 #ifdef HAVE_GETADDRINFO_A
3947 p->dns_request = NULL;
3948 #endif
3949 #ifdef HAVE_GNUTLS
3950 tem = Fplist_get (contact, QCtls_parameters);
3951 CHECK_LIST (tem);
3952 p->gnutls_boot_parameters = tem;
3953 #endif
3955 set_network_socket_coding_system (proc, host, service, name);
3957 unbind_to (count, Qnil);
3959 /* :server BOOL */
3960 tem = Fplist_get (contact, QCserver);
3961 if (!NILP (tem))
3963 /* Don't support network sockets when non-blocking mode is
3964 not available, since a blocked Emacs is not useful. */
3965 p->is_server = true;
3966 if (TYPE_RANGED_INTEGERP (int, tem))
3967 p->backlog = XINT (tem);
3970 /* :nowait BOOL */
3971 if (!p->is_server && socktype != SOCK_DGRAM
3972 && !NILP (Fplist_get (contact, QCnowait)))
3973 p->is_non_blocking_client = true;
3975 #ifdef HAVE_GETADDRINFO_A
3976 /* With async address resolution, the list of addresses is empty, so
3977 postpone connecting to the server. */
3978 if (!p->is_server && NILP (addrinfos))
3980 p->dns_request = dns_request;
3981 p->status = list1 (Qconnect);
3982 return proc;
3984 #endif
3986 connect_network_socket (proc, addrinfos, use_external_socket_p);
3987 return proc;
3991 #ifdef HAVE_NET_IF_H
3993 #ifdef SIOCGIFCONF
3994 static Lisp_Object
3995 network_interface_list (void)
3997 struct ifconf ifconf;
3998 struct ifreq *ifreq;
3999 void *buf = NULL;
4000 ptrdiff_t buf_size = 512;
4001 int s;
4002 Lisp_Object res;
4003 ptrdiff_t count;
4005 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
4006 if (s < 0)
4007 return Qnil;
4008 count = SPECPDL_INDEX ();
4009 record_unwind_protect_int (close_file_unwind, s);
4013 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
4014 ifconf.ifc_buf = buf;
4015 ifconf.ifc_len = buf_size;
4016 if (ioctl (s, SIOCGIFCONF, &ifconf))
4018 emacs_close (s);
4019 xfree (buf);
4020 return Qnil;
4023 while (ifconf.ifc_len == buf_size);
4025 res = unbind_to (count, Qnil);
4026 ifreq = ifconf.ifc_req;
4027 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
4029 struct ifreq *ifq = ifreq;
4030 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
4031 #define SIZEOF_IFREQ(sif) \
4032 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
4033 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
4035 int len = SIZEOF_IFREQ (ifq);
4036 #else
4037 int len = sizeof (*ifreq);
4038 #endif
4039 char namebuf[sizeof (ifq->ifr_name) + 1];
4040 ifreq = (struct ifreq *) ((char *) ifreq + len);
4042 if (ifq->ifr_addr.sa_family != AF_INET)
4043 continue;
4045 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
4046 namebuf[sizeof (ifq->ifr_name)] = 0;
4047 res = Fcons (Fcons (build_string (namebuf),
4048 conv_sockaddr_to_lisp (&ifq->ifr_addr,
4049 sizeof (struct sockaddr))),
4050 res);
4053 xfree (buf);
4054 return res;
4056 #endif /* SIOCGIFCONF */
4058 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
4060 struct ifflag_def {
4061 int flag_bit;
4062 const char *flag_sym;
4065 static const struct ifflag_def ifflag_table[] = {
4066 #ifdef IFF_UP
4067 { IFF_UP, "up" },
4068 #endif
4069 #ifdef IFF_BROADCAST
4070 { IFF_BROADCAST, "broadcast" },
4071 #endif
4072 #ifdef IFF_DEBUG
4073 { IFF_DEBUG, "debug" },
4074 #endif
4075 #ifdef IFF_LOOPBACK
4076 { IFF_LOOPBACK, "loopback" },
4077 #endif
4078 #ifdef IFF_POINTOPOINT
4079 { IFF_POINTOPOINT, "pointopoint" },
4080 #endif
4081 #ifdef IFF_RUNNING
4082 { IFF_RUNNING, "running" },
4083 #endif
4084 #ifdef IFF_NOARP
4085 { IFF_NOARP, "noarp" },
4086 #endif
4087 #ifdef IFF_PROMISC
4088 { IFF_PROMISC, "promisc" },
4089 #endif
4090 #ifdef IFF_NOTRAILERS
4091 #ifdef NS_IMPL_COCOA
4092 /* Really means smart, notrailers is obsolete. */
4093 { IFF_NOTRAILERS, "smart" },
4094 #else
4095 { IFF_NOTRAILERS, "notrailers" },
4096 #endif
4097 #endif
4098 #ifdef IFF_ALLMULTI
4099 { IFF_ALLMULTI, "allmulti" },
4100 #endif
4101 #ifdef IFF_MASTER
4102 { IFF_MASTER, "master" },
4103 #endif
4104 #ifdef IFF_SLAVE
4105 { IFF_SLAVE, "slave" },
4106 #endif
4107 #ifdef IFF_MULTICAST
4108 { IFF_MULTICAST, "multicast" },
4109 #endif
4110 #ifdef IFF_PORTSEL
4111 { IFF_PORTSEL, "portsel" },
4112 #endif
4113 #ifdef IFF_AUTOMEDIA
4114 { IFF_AUTOMEDIA, "automedia" },
4115 #endif
4116 #ifdef IFF_DYNAMIC
4117 { IFF_DYNAMIC, "dynamic" },
4118 #endif
4119 #ifdef IFF_OACTIVE
4120 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress. */
4121 #endif
4122 #ifdef IFF_SIMPLEX
4123 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions. */
4124 #endif
4125 #ifdef IFF_LINK0
4126 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit. */
4127 #endif
4128 #ifdef IFF_LINK1
4129 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit. */
4130 #endif
4131 #ifdef IFF_LINK2
4132 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit. */
4133 #endif
4134 { 0, 0 }
4137 static Lisp_Object
4138 network_interface_info (Lisp_Object ifname)
4140 struct ifreq rq;
4141 Lisp_Object res = Qnil;
4142 Lisp_Object elt;
4143 int s;
4144 bool any = 0;
4145 ptrdiff_t count;
4146 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
4147 && defined HAVE_GETIFADDRS && defined LLADDR)
4148 struct ifaddrs *ifap;
4149 #endif
4151 CHECK_STRING (ifname);
4153 if (sizeof rq.ifr_name <= SBYTES (ifname))
4154 error ("interface name too long");
4155 lispstpcpy (rq.ifr_name, ifname);
4157 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
4158 if (s < 0)
4159 return Qnil;
4160 count = SPECPDL_INDEX ();
4161 record_unwind_protect_int (close_file_unwind, s);
4163 elt = Qnil;
4164 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
4165 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
4167 int flags = rq.ifr_flags;
4168 const struct ifflag_def *fp;
4169 int fnum;
4171 /* If flags is smaller than int (i.e. short) it may have the high bit set
4172 due to IFF_MULTICAST. In that case, sign extending it into
4173 an int is wrong. */
4174 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
4175 flags = (unsigned short) rq.ifr_flags;
4177 any = 1;
4178 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
4180 if (flags & fp->flag_bit)
4182 elt = Fcons (intern (fp->flag_sym), elt);
4183 flags -= fp->flag_bit;
4186 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
4188 if (flags & 1)
4190 elt = Fcons (make_number (fnum), elt);
4194 #endif
4195 res = Fcons (elt, res);
4197 elt = Qnil;
4198 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
4199 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
4201 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
4202 register struct Lisp_Vector *p = XVECTOR (hwaddr);
4203 int n;
4205 any = 1;
4206 for (n = 0; n < 6; n++)
4207 p->contents[n] = make_number (((unsigned char *)
4208 &rq.ifr_hwaddr.sa_data[0])
4209 [n]);
4210 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
4212 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
4213 if (getifaddrs (&ifap) != -1)
4215 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
4216 register struct Lisp_Vector *p = XVECTOR (hwaddr);
4217 struct ifaddrs *it;
4219 for (it = ifap; it != NULL; it = it->ifa_next)
4221 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
4222 unsigned char linkaddr[6];
4223 int n;
4225 if (it->ifa_addr->sa_family != AF_LINK
4226 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
4227 || sdl->sdl_alen != 6)
4228 continue;
4230 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
4231 for (n = 0; n < 6; n++)
4232 p->contents[n] = make_number (linkaddr[n]);
4234 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
4235 break;
4238 #ifdef HAVE_FREEIFADDRS
4239 freeifaddrs (ifap);
4240 #endif
4242 #endif /* HAVE_GETIFADDRS && LLADDR */
4244 res = Fcons (elt, res);
4246 elt = Qnil;
4247 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
4248 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
4250 any = 1;
4251 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
4252 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
4253 #else
4254 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
4255 #endif
4257 #endif
4258 res = Fcons (elt, res);
4260 elt = Qnil;
4261 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
4262 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
4264 any = 1;
4265 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
4267 #endif
4268 res = Fcons (elt, res);
4270 elt = Qnil;
4271 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
4272 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
4274 any = 1;
4275 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
4277 #endif
4278 res = Fcons (elt, res);
4280 return unbind_to (count, any ? res : Qnil);
4282 #endif /* !SIOCGIFADDR && !SIOCGIFHWADDR && !SIOCGIFFLAGS */
4283 #endif /* defined (HAVE_NET_IF_H) */
4285 DEFUN ("network-interface-list", Fnetwork_interface_list,
4286 Snetwork_interface_list, 0, 0, 0,
4287 doc: /* Return an alist of all network interfaces and their network address.
4288 Each element is a cons, the car of which is a string containing the
4289 interface name, and the cdr is the network address in internal
4290 format; see the description of ADDRESS in `make-network-process'.
4292 If the information is not available, return nil. */)
4293 (void)
4295 #if (defined HAVE_NET_IF_H && defined SIOCGIFCONF) || defined WINDOWSNT
4296 return network_interface_list ();
4297 #else
4298 return Qnil;
4299 #endif
4302 DEFUN ("network-interface-info", Fnetwork_interface_info,
4303 Snetwork_interface_info, 1, 1, 0,
4304 doc: /* Return information about network interface named IFNAME.
4305 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
4306 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
4307 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
4308 FLAGS is the current flags of the interface.
4310 Data that is unavailable is returned as nil. */)
4311 (Lisp_Object ifname)
4313 #if ((defined HAVE_NET_IF_H \
4314 && (defined SIOCGIFADDR || defined SIOCGIFHWADDR \
4315 || defined SIOCGIFFLAGS)) \
4316 || defined WINDOWSNT)
4317 return network_interface_info (ifname);
4318 #else
4319 return Qnil;
4320 #endif
4323 /* Turn off input and output for process PROC. */
4325 static void
4326 deactivate_process (Lisp_Object proc)
4328 int inchannel;
4329 struct Lisp_Process *p = XPROCESS (proc);
4330 int i;
4332 #ifdef HAVE_GNUTLS
4333 /* Delete GnuTLS structures in PROC, if any. */
4334 emacs_gnutls_deinit (proc);
4335 #endif /* HAVE_GNUTLS */
4337 if (p->read_output_delay > 0)
4339 if (--process_output_delay_count < 0)
4340 process_output_delay_count = 0;
4341 p->read_output_delay = 0;
4342 p->read_output_skip = 0;
4345 /* Beware SIGCHLD hereabouts. */
4347 for (i = 0; i < PROCESS_OPEN_FDS; i++)
4348 close_process_fd (&p->open_fd[i]);
4350 inchannel = p->infd;
4351 if (inchannel >= 0)
4353 p->infd = -1;
4354 p->outfd = -1;
4355 #ifdef DATAGRAM_SOCKETS
4356 if (DATAGRAM_CHAN_P (inchannel))
4358 xfree (datagram_address[inchannel].sa);
4359 datagram_address[inchannel].sa = 0;
4360 datagram_address[inchannel].len = 0;
4362 #endif
4363 chan_process[inchannel] = Qnil;
4364 FD_CLR (inchannel, &input_wait_mask);
4365 FD_CLR (inchannel, &non_keyboard_wait_mask);
4366 if (FD_ISSET (inchannel, &connect_wait_mask))
4368 FD_CLR (inchannel, &connect_wait_mask);
4369 FD_CLR (inchannel, &write_mask);
4370 if (--num_pending_connects < 0)
4371 emacs_abort ();
4373 if (inchannel == max_process_desc)
4375 /* We just closed the highest-numbered process input descriptor,
4376 so recompute the highest-numbered one now. */
4377 int i = inchannel;
4379 i--;
4380 while (0 <= i && NILP (chan_process[i]));
4382 max_process_desc = i;
4388 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
4389 0, 4, 0,
4390 doc: /* Allow any pending output from subprocesses to be read by Emacs.
4391 It is given to their filter functions.
4392 Optional argument PROCESS means do not return until output has been
4393 received from PROCESS.
4395 Optional second argument SECONDS and third argument MILLISEC
4396 specify a timeout; return after that much time even if there is
4397 no subprocess output. If SECONDS is a floating point number,
4398 it specifies a fractional number of seconds to wait.
4399 The MILLISEC argument is obsolete and should be avoided.
4401 If optional fourth argument JUST-THIS-ONE is non-nil, accept output
4402 from PROCESS only, suspending reading output from other processes.
4403 If JUST-THIS-ONE is an integer, don't run any timers either.
4404 Return non-nil if we received any output from PROCESS (or, if PROCESS
4405 is nil, from any process) before the timeout expired. */)
4406 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
4408 intmax_t secs;
4409 int nsecs;
4411 if (! NILP (process))
4412 CHECK_PROCESS (process);
4413 else
4414 just_this_one = Qnil;
4416 if (!NILP (millisec))
4417 { /* Obsolete calling convention using integers rather than floats. */
4418 CHECK_NUMBER (millisec);
4419 if (NILP (seconds))
4420 seconds = make_float (XINT (millisec) / 1000.0);
4421 else
4423 CHECK_NUMBER (seconds);
4424 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
4428 secs = 0;
4429 nsecs = -1;
4431 if (!NILP (seconds))
4433 if (INTEGERP (seconds))
4435 if (XINT (seconds) > 0)
4437 secs = XINT (seconds);
4438 nsecs = 0;
4441 else if (FLOATP (seconds))
4443 if (XFLOAT_DATA (seconds) > 0)
4445 struct timespec t = dtotimespec (XFLOAT_DATA (seconds));
4446 secs = min (t.tv_sec, WAIT_READING_MAX);
4447 nsecs = t.tv_nsec;
4450 else
4451 wrong_type_argument (Qnumberp, seconds);
4453 else if (! NILP (process))
4454 nsecs = 0;
4456 return
4457 ((wait_reading_process_output (secs, nsecs, 0, 0,
4458 Qnil,
4459 !NILP (process) ? XPROCESS (process) : NULL,
4460 (NILP (just_this_one) ? 0
4461 : !INTEGERP (just_this_one) ? 1 : -1))
4462 <= 0)
4463 ? Qnil : Qt);
4466 /* Accept a connection for server process SERVER on CHANNEL. */
4468 static EMACS_INT connect_counter = 0;
4470 static void
4471 server_accept_connection (Lisp_Object server, int channel)
4473 Lisp_Object proc, caller, name, buffer;
4474 Lisp_Object contact, host, service;
4475 struct Lisp_Process *ps = XPROCESS (server);
4476 struct Lisp_Process *p;
4477 int s;
4478 union u_sockaddr {
4479 struct sockaddr sa;
4480 struct sockaddr_in in;
4481 #ifdef AF_INET6
4482 struct sockaddr_in6 in6;
4483 #endif
4484 #ifdef HAVE_LOCAL_SOCKETS
4485 struct sockaddr_un un;
4486 #endif
4487 } saddr;
4488 socklen_t len = sizeof saddr;
4489 ptrdiff_t count;
4491 s = accept4 (channel, &saddr.sa, &len, SOCK_CLOEXEC);
4493 if (s < 0)
4495 int code = errno;
4496 if (!would_block (code) && !NILP (ps->log))
4497 call3 (ps->log, server, Qnil,
4498 concat3 (build_string ("accept failed with code"),
4499 Fnumber_to_string (make_number (code)),
4500 build_string ("\n")));
4501 return;
4504 count = SPECPDL_INDEX ();
4505 record_unwind_protect_int (close_file_unwind, s);
4507 connect_counter++;
4509 /* Setup a new process to handle the connection. */
4511 /* Generate a unique identification of the caller, and build contact
4512 information for this process. */
4513 host = Qt;
4514 service = Qnil;
4515 switch (saddr.sa.sa_family)
4517 case AF_INET:
4519 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4521 AUTO_STRING (ipv4_format, "%d.%d.%d.%d");
4522 host = CALLN (Fformat, ipv4_format,
4523 make_number (ip[0]), make_number (ip[1]),
4524 make_number (ip[2]), make_number (ip[3]));
4525 service = make_number (ntohs (saddr.in.sin_port));
4526 AUTO_STRING (caller_format, " <%s:%d>");
4527 caller = CALLN (Fformat, caller_format, host, service);
4529 break;
4531 #ifdef AF_INET6
4532 case AF_INET6:
4534 Lisp_Object args[9];
4535 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4536 int i;
4538 AUTO_STRING (ipv6_format, "%x:%x:%x:%x:%x:%x:%x:%x");
4539 args[0] = ipv6_format;
4540 for (i = 0; i < 8; i++)
4541 args[i + 1] = make_number (ntohs (ip6[i]));
4542 host = CALLMANY (Fformat, args);
4543 service = make_number (ntohs (saddr.in.sin_port));
4544 AUTO_STRING (caller_format, " <[%s]:%d>");
4545 caller = CALLN (Fformat, caller_format, host, service);
4547 break;
4548 #endif
4550 #ifdef HAVE_LOCAL_SOCKETS
4551 case AF_LOCAL:
4552 #endif
4553 default:
4554 caller = Fnumber_to_string (make_number (connect_counter));
4555 AUTO_STRING (space_less_than, " <");
4556 AUTO_STRING (greater_than, ">");
4557 caller = concat3 (space_less_than, caller, greater_than);
4558 break;
4561 /* Create a new buffer name for this process if it doesn't have a
4562 filter. The new buffer name is based on the buffer name or
4563 process name of the server process concatenated with the caller
4564 identification. */
4566 if (!(EQ (ps->filter, Qinternal_default_process_filter)
4567 || EQ (ps->filter, Qt)))
4568 buffer = Qnil;
4569 else
4571 buffer = ps->buffer;
4572 if (!NILP (buffer))
4573 buffer = Fbuffer_name (buffer);
4574 else
4575 buffer = ps->name;
4576 if (!NILP (buffer))
4578 buffer = concat2 (buffer, caller);
4579 buffer = Fget_buffer_create (buffer);
4583 /* Generate a unique name for the new server process. Combine the
4584 server process name with the caller identification. */
4586 name = concat2 (ps->name, caller);
4587 proc = make_process (name);
4589 chan_process[s] = proc;
4591 fcntl (s, F_SETFL, O_NONBLOCK);
4593 p = XPROCESS (proc);
4595 /* Build new contact information for this setup. */
4596 contact = Fcopy_sequence (ps->childp);
4597 contact = Fplist_put (contact, QCserver, Qnil);
4598 contact = Fplist_put (contact, QChost, host);
4599 if (!NILP (service))
4600 contact = Fplist_put (contact, QCservice, service);
4601 contact = Fplist_put (contact, QCremote,
4602 conv_sockaddr_to_lisp (&saddr.sa, len));
4603 #ifdef HAVE_GETSOCKNAME
4604 len = sizeof saddr;
4605 if (getsockname (s, &saddr.sa, &len) == 0)
4606 contact = Fplist_put (contact, QClocal,
4607 conv_sockaddr_to_lisp (&saddr.sa, len));
4608 #endif
4610 pset_childp (p, contact);
4611 pset_plist (p, Fcopy_sequence (ps->plist));
4612 pset_type (p, Qnetwork);
4614 pset_buffer (p, buffer);
4615 pset_sentinel (p, ps->sentinel);
4616 pset_filter (p, ps->filter);
4617 pset_command (p, Qnil);
4618 p->pid = 0;
4620 /* Discard the unwind protect for closing S. */
4621 specpdl_ptr = specpdl + count;
4623 p->open_fd[SUBPROCESS_STDIN] = s;
4624 p->infd = s;
4625 p->outfd = s;
4626 pset_status (p, Qrun);
4628 /* Client processes for accepted connections are not stopped initially. */
4629 if (!EQ (p->filter, Qt))
4631 FD_SET (s, &input_wait_mask);
4632 FD_SET (s, &non_keyboard_wait_mask);
4635 if (s > max_process_desc)
4636 max_process_desc = s;
4638 /* Setup coding system for new process based on server process.
4639 This seems to be the proper thing to do, as the coding system
4640 of the new process should reflect the settings at the time the
4641 server socket was opened; not the current settings. */
4643 pset_decode_coding_system (p, ps->decode_coding_system);
4644 pset_encode_coding_system (p, ps->encode_coding_system);
4645 setup_process_coding_systems (proc);
4647 pset_decoding_buf (p, empty_unibyte_string);
4648 p->decoding_carryover = 0;
4649 pset_encoding_buf (p, empty_unibyte_string);
4651 p->inherit_coding_system_flag
4652 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4654 AUTO_STRING (dash, "-");
4655 AUTO_STRING (nl, "\n");
4656 Lisp_Object host_string = STRINGP (host) ? host : dash;
4658 if (!NILP (ps->log))
4660 AUTO_STRING (accept_from, "accept from ");
4661 call3 (ps->log, server, proc, concat3 (accept_from, host_string, nl));
4664 AUTO_STRING (open_from, "open from ");
4665 exec_sentinel (proc, concat3 (open_from, host_string, nl));
4668 #ifdef HAVE_GETADDRINFO_A
4669 static Lisp_Object
4670 check_for_dns (Lisp_Object proc)
4672 struct Lisp_Process *p = XPROCESS (proc);
4673 Lisp_Object addrinfos = Qnil;
4675 /* Sanity check. */
4676 if (! p->dns_request)
4677 return Qnil;
4679 int ret = gai_error (p->dns_request);
4680 if (ret == EAI_INPROGRESS)
4681 return Qt;
4683 /* We got a response. */
4684 if (ret == 0)
4686 struct addrinfo *res;
4688 for (res = p->dns_request->ar_result; res; res = res->ai_next)
4689 addrinfos = Fcons (conv_addrinfo_to_lisp (res), addrinfos);
4691 addrinfos = Fnreverse (addrinfos);
4693 /* The DNS lookup failed. */
4694 else if (connecting_status (p->status))
4696 deactivate_process (proc);
4697 pset_status (p, (list2
4698 (Qfailed,
4699 concat3 (build_string ("Name lookup of "),
4700 build_string (p->dns_request->ar_name),
4701 build_string (" failed")))));
4704 free_dns_request (proc);
4706 /* This process should not already be connected (or killed). */
4707 if (! connecting_status (p->status))
4708 return Qnil;
4710 return addrinfos;
4713 #endif /* HAVE_GETADDRINFO_A */
4715 static void
4716 wait_for_socket_fds (Lisp_Object process, char const *name)
4718 while (XPROCESS (process)->infd < 0
4719 && connecting_status (XPROCESS (process)->status))
4721 add_to_log ("Waiting for socket from %s...", build_string (name));
4722 wait_reading_process_output (0, 20 * 1000 * 1000, 0, 0, Qnil, NULL, 0);
4726 static void
4727 wait_while_connecting (Lisp_Object process)
4729 while (connecting_status (XPROCESS (process)->status))
4731 add_to_log ("Waiting for connection...");
4732 wait_reading_process_output (0, 20 * 1000 * 1000, 0, 0, Qnil, NULL, 0);
4736 static void
4737 wait_for_tls_negotiation (Lisp_Object process)
4739 #ifdef HAVE_GNUTLS
4740 while (XPROCESS (process)->gnutls_p
4741 && XPROCESS (process)->gnutls_initstage != GNUTLS_STAGE_READY)
4743 add_to_log ("Waiting for TLS...");
4744 wait_reading_process_output (0, 20 * 1000 * 1000, 0, 0, Qnil, NULL, 0);
4746 #endif
4749 /* This variable is different from waiting_for_input in keyboard.c.
4750 It is used to communicate to a lisp process-filter/sentinel (via the
4751 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4752 for user-input when that process-filter was called.
4753 waiting_for_input cannot be used as that is by definition 0 when
4754 lisp code is being evalled.
4755 This is also used in record_asynch_buffer_change.
4756 For that purpose, this must be 0
4757 when not inside wait_reading_process_output. */
4758 static int waiting_for_user_input_p;
4760 static void
4761 wait_reading_process_output_unwind (int data)
4763 waiting_for_user_input_p = data;
4766 /* This is here so breakpoints can be put on it. */
4767 static void
4768 wait_reading_process_output_1 (void)
4772 /* Read and dispose of subprocess output while waiting for timeout to
4773 elapse and/or keyboard input to be available.
4775 TIME_LIMIT is:
4776 timeout in seconds
4777 If negative, gobble data immediately available but don't wait for any.
4779 NSECS is:
4780 an additional duration to wait, measured in nanoseconds
4781 If TIME_LIMIT is zero, then:
4782 If NSECS == 0, there is no limit.
4783 If NSECS > 0, the timeout consists of NSECS only.
4784 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4786 READ_KBD is:
4787 0 to ignore keyboard input, or
4788 1 to return when input is available, or
4789 -1 meaning caller will actually read the input, so don't throw to
4790 the quit handler, or
4792 DO_DISPLAY means redisplay should be done to show subprocess
4793 output that arrives.
4795 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4796 (and gobble terminal input into the buffer if any arrives).
4798 If WAIT_PROC is specified, wait until something arrives from that
4799 process.
4801 If JUST_WAIT_PROC is nonzero, handle only output from WAIT_PROC
4802 (suspending output from other processes). A negative value
4803 means don't run any timers either.
4805 Return positive if we received input from WAIT_PROC (or from any
4806 process if WAIT_PROC is null), zero if we attempted to receive
4807 input but got none, and negative if we didn't even try. */
4810 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4811 bool do_display,
4812 Lisp_Object wait_for_cell,
4813 struct Lisp_Process *wait_proc, int just_wait_proc)
4815 int channel, nfds;
4816 fd_set Available;
4817 fd_set Writeok;
4818 bool check_write;
4819 int check_delay;
4820 bool no_avail;
4821 int xerrno;
4822 Lisp_Object proc;
4823 struct timespec timeout, end_time, timer_delay;
4824 struct timespec got_output_end_time = invalid_timespec ();
4825 enum { MINIMUM = -1, TIMEOUT, INFINITY } wait;
4826 int got_some_output = -1;
4827 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
4828 bool retry_for_async;
4829 #endif
4830 ptrdiff_t count = SPECPDL_INDEX ();
4832 /* Close to the current time if known, an invalid timespec otherwise. */
4833 struct timespec now = invalid_timespec ();
4835 FD_ZERO (&Available);
4836 FD_ZERO (&Writeok);
4838 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4839 && !(CONSP (wait_proc->status)
4840 && EQ (XCAR (wait_proc->status), Qexit)))
4841 message1 ("Blocking call to accept-process-output with quit inhibited!!");
4843 record_unwind_protect_int (wait_reading_process_output_unwind,
4844 waiting_for_user_input_p);
4845 waiting_for_user_input_p = read_kbd;
4847 if (TYPE_MAXIMUM (time_t) < time_limit)
4848 time_limit = TYPE_MAXIMUM (time_t);
4850 if (time_limit < 0 || nsecs < 0)
4851 wait = MINIMUM;
4852 else if (time_limit > 0 || nsecs > 0)
4854 wait = TIMEOUT;
4855 now = current_timespec ();
4856 end_time = timespec_add (now, make_timespec (time_limit, nsecs));
4858 else
4859 wait = INFINITY;
4861 while (1)
4863 bool process_skipped = false;
4865 /* If calling from keyboard input, do not quit
4866 since we want to return C-g as an input character.
4867 Otherwise, do pending quit if requested. */
4868 if (read_kbd >= 0)
4869 QUIT;
4870 else if (pending_signals)
4871 process_pending_signals ();
4873 /* Exit now if the cell we're waiting for became non-nil. */
4874 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4875 break;
4877 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
4879 Lisp_Object process_list_head, aproc;
4880 struct Lisp_Process *p;
4882 retry_for_async = false;
4883 FOR_EACH_PROCESS(process_list_head, aproc)
4885 p = XPROCESS (aproc);
4887 if (! wait_proc || p == wait_proc)
4889 #ifdef HAVE_GETADDRINFO_A
4890 /* Check for pending DNS requests. */
4891 if (p->dns_request)
4893 Lisp_Object addrinfos = check_for_dns (aproc);
4894 if (!NILP (addrinfos) && !EQ (addrinfos, Qt))
4895 connect_network_socket (aproc, addrinfos, Qnil);
4896 else
4897 retry_for_async = true;
4899 #endif
4900 #ifdef HAVE_GNUTLS
4901 /* Continue TLS negotiation. */
4902 if (p->gnutls_initstage == GNUTLS_STAGE_HANDSHAKE_TRIED
4903 && p->is_non_blocking_client)
4905 gnutls_try_handshake (p);
4906 p->gnutls_handshakes_tried++;
4908 if (p->gnutls_initstage == GNUTLS_STAGE_READY)
4910 gnutls_verify_boot (aproc, Qnil);
4911 finish_after_tls_connection (aproc);
4913 else
4915 retry_for_async = true;
4916 if (p->gnutls_handshakes_tried
4917 > GNUTLS_EMACS_HANDSHAKES_LIMIT)
4919 deactivate_process (aproc);
4920 pset_status (p, list2 (Qfailed,
4921 build_string ("TLS negotiation failed")));
4925 #endif
4929 #endif /* GETADDRINFO_A or GNUTLS */
4931 /* Compute time from now till when time limit is up. */
4932 /* Exit if already run out. */
4933 if (wait == TIMEOUT)
4935 if (!timespec_valid_p (now))
4936 now = current_timespec ();
4937 if (timespec_cmp (end_time, now) <= 0)
4938 break;
4939 timeout = timespec_sub (end_time, now);
4941 else
4942 timeout = make_timespec (wait < TIMEOUT ? 0 : 100000, 0);
4944 /* Normally we run timers here.
4945 But not if wait_for_cell; in those cases,
4946 the wait is supposed to be short,
4947 and those callers cannot handle running arbitrary Lisp code here. */
4948 if (NILP (wait_for_cell)
4949 && just_wait_proc >= 0)
4953 unsigned old_timers_run = timers_run;
4954 struct buffer *old_buffer = current_buffer;
4955 Lisp_Object old_window = selected_window;
4957 timer_delay = timer_check ();
4959 /* If a timer has run, this might have changed buffers
4960 an alike. Make read_key_sequence aware of that. */
4961 if (timers_run != old_timers_run
4962 && (old_buffer != current_buffer
4963 || !EQ (old_window, selected_window))
4964 && waiting_for_user_input_p == -1)
4965 record_asynch_buffer_change ();
4967 if (timers_run != old_timers_run && do_display)
4968 /* We must retry, since a timer may have requeued itself
4969 and that could alter the time_delay. */
4970 redisplay_preserve_echo_area (9);
4971 else
4972 break;
4974 while (!detect_input_pending ());
4976 /* If there is unread keyboard input, also return. */
4977 if (read_kbd != 0
4978 && requeued_events_pending_p ())
4979 break;
4981 /* This is so a breakpoint can be put here. */
4982 if (!timespec_valid_p (timer_delay))
4983 wait_reading_process_output_1 ();
4986 /* Cause C-g and alarm signals to take immediate action,
4987 and cause input available signals to zero out timeout.
4989 It is important that we do this before checking for process
4990 activity. If we get a SIGCHLD after the explicit checks for
4991 process activity, timeout is the only way we will know. */
4992 if (read_kbd < 0)
4993 set_waiting_for_input (&timeout);
4995 /* If status of something has changed, and no input is
4996 available, notify the user of the change right away. After
4997 this explicit check, we'll let the SIGCHLD handler zap
4998 timeout to get our attention. */
4999 if (update_tick != process_tick)
5001 fd_set Atemp;
5002 fd_set Ctemp;
5004 if (kbd_on_hold_p ())
5005 FD_ZERO (&Atemp);
5006 else
5007 Atemp = input_wait_mask;
5008 Ctemp = write_mask;
5010 timeout = make_timespec (0, 0);
5011 if ((pselect (max (max_process_desc, max_input_desc) + 1,
5012 &Atemp,
5013 (num_pending_connects > 0 ? &Ctemp : NULL),
5014 NULL, &timeout, NULL)
5015 <= 0))
5017 /* It's okay for us to do this and then continue with
5018 the loop, since timeout has already been zeroed out. */
5019 clear_waiting_for_input ();
5020 got_some_output = status_notify (NULL, wait_proc);
5021 if (do_display) redisplay_preserve_echo_area (13);
5025 /* Don't wait for output from a non-running process. Just
5026 read whatever data has already been received. */
5027 if (wait_proc && wait_proc->raw_status_new)
5028 update_status (wait_proc);
5029 if (wait_proc
5030 && ! EQ (wait_proc->status, Qrun)
5031 && ! connecting_status (wait_proc->status))
5033 bool read_some_bytes = false;
5035 clear_waiting_for_input ();
5037 /* If data can be read from the process, do so until exhausted. */
5038 if (wait_proc->infd >= 0)
5040 XSETPROCESS (proc, wait_proc);
5042 while (true)
5044 int nread = read_process_output (proc, wait_proc->infd);
5045 if (nread < 0)
5047 if (errno == EIO || would_block (errno))
5048 break;
5050 else
5052 if (got_some_output < nread)
5053 got_some_output = nread;
5054 if (nread == 0)
5055 break;
5056 read_some_bytes = true;
5061 if (read_some_bytes && do_display)
5062 redisplay_preserve_echo_area (10);
5064 break;
5067 /* Wait till there is something to do. */
5069 if (wait_proc && just_wait_proc)
5071 if (wait_proc->infd < 0) /* Terminated. */
5072 break;
5073 FD_SET (wait_proc->infd, &Available);
5074 check_delay = 0;
5075 check_write = 0;
5077 else if (!NILP (wait_for_cell))
5079 Available = non_process_wait_mask;
5080 check_delay = 0;
5081 check_write = 0;
5083 else
5085 if (! read_kbd)
5086 Available = non_keyboard_wait_mask;
5087 else
5088 Available = input_wait_mask;
5089 Writeok = write_mask;
5090 check_delay = wait_proc ? 0 : process_output_delay_count;
5091 check_write = true;
5094 /* If frame size has changed or the window is newly mapped,
5095 redisplay now, before we start to wait. There is a race
5096 condition here; if a SIGIO arrives between now and the select
5097 and indicates that a frame is trashed, the select may block
5098 displaying a trashed screen. */
5099 if (frame_garbaged && do_display)
5101 clear_waiting_for_input ();
5102 redisplay_preserve_echo_area (11);
5103 if (read_kbd < 0)
5104 set_waiting_for_input (&timeout);
5107 /* Skip the `select' call if input is available and we're
5108 waiting for keyboard input or a cell change (which can be
5109 triggered by processing X events). In the latter case, set
5110 nfds to 1 to avoid breaking the loop. */
5111 no_avail = 0;
5112 if ((read_kbd || !NILP (wait_for_cell))
5113 && detect_input_pending ())
5115 nfds = read_kbd ? 0 : 1;
5116 no_avail = 1;
5117 FD_ZERO (&Available);
5119 else
5121 /* Set the timeout for adaptive read buffering if any
5122 process has non-zero read_output_skip and non-zero
5123 read_output_delay, and we are not reading output for a
5124 specific process. It is not executed if
5125 Vprocess_adaptive_read_buffering is nil. */
5126 if (process_output_skip && check_delay > 0)
5128 int adaptive_nsecs = timeout.tv_nsec;
5129 if (timeout.tv_sec > 0 || adaptive_nsecs > READ_OUTPUT_DELAY_MAX)
5130 adaptive_nsecs = READ_OUTPUT_DELAY_MAX;
5131 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
5133 proc = chan_process[channel];
5134 if (NILP (proc))
5135 continue;
5136 /* Find minimum non-zero read_output_delay among the
5137 processes with non-zero read_output_skip. */
5138 if (XPROCESS (proc)->read_output_delay > 0)
5140 check_delay--;
5141 if (!XPROCESS (proc)->read_output_skip)
5142 continue;
5143 FD_CLR (channel, &Available);
5144 process_skipped = true;
5145 XPROCESS (proc)->read_output_skip = 0;
5146 if (XPROCESS (proc)->read_output_delay < adaptive_nsecs)
5147 adaptive_nsecs = XPROCESS (proc)->read_output_delay;
5150 timeout = make_timespec (0, adaptive_nsecs);
5151 process_output_skip = 0;
5154 /* If we've got some output and haven't limited our timeout
5155 with adaptive read buffering, limit it. */
5156 if (got_some_output > 0 && !process_skipped
5157 && (timeout.tv_sec
5158 || timeout.tv_nsec > READ_OUTPUT_DELAY_INCREMENT))
5159 timeout = make_timespec (0, READ_OUTPUT_DELAY_INCREMENT);
5162 if (NILP (wait_for_cell) && just_wait_proc >= 0
5163 && timespec_valid_p (timer_delay)
5164 && timespec_cmp (timer_delay, timeout) < 0)
5166 if (!timespec_valid_p (now))
5167 now = current_timespec ();
5168 struct timespec timeout_abs = timespec_add (now, timeout);
5169 if (!timespec_valid_p (got_output_end_time)
5170 || timespec_cmp (timeout_abs, got_output_end_time) < 0)
5171 got_output_end_time = timeout_abs;
5172 timeout = timer_delay;
5174 else
5175 got_output_end_time = invalid_timespec ();
5177 /* NOW can become inaccurate if time can pass during pselect. */
5178 if (timeout.tv_sec > 0 || timeout.tv_nsec > 0)
5179 now = invalid_timespec ();
5181 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
5182 if (retry_for_async
5183 && (timeout.tv_sec > 0 || timeout.tv_nsec > ASYNC_RETRY_NSEC))
5185 timeout.tv_sec = 0;
5186 timeout.tv_nsec = ASYNC_RETRY_NSEC;
5188 #endif
5190 #if defined (HAVE_NS)
5191 nfds = ns_select
5192 #elif defined (HAVE_GLIB)
5193 nfds = xg_select
5194 #else
5195 nfds = pselect
5196 #endif
5197 (max (max_process_desc, max_input_desc) + 1,
5198 &Available,
5199 (check_write ? &Writeok : 0),
5200 NULL, &timeout, NULL);
5202 #ifdef HAVE_GNUTLS
5203 /* GnuTLS buffers data internally. In lowat mode it leaves
5204 some data in the TCP buffers so that select works, but
5205 with custom pull/push functions we need to check if some
5206 data is available in the buffers manually. */
5207 if (nfds == 0)
5209 fd_set tls_available;
5210 int set = 0;
5212 FD_ZERO (&tls_available);
5213 if (! wait_proc)
5215 /* We're not waiting on a specific process, so loop
5216 through all the channels and check for data.
5217 This is a workaround needed for some versions of
5218 the gnutls library -- 2.12.14 has been confirmed
5219 to need it. See
5220 http://comments.gmane.org/gmane.emacs.devel/145074 */
5221 for (channel = 0; channel < FD_SETSIZE; ++channel)
5222 if (! NILP (chan_process[channel]))
5224 struct Lisp_Process *p =
5225 XPROCESS (chan_process[channel]);
5226 if (p && p->gnutls_p && p->gnutls_state
5227 && ((emacs_gnutls_record_check_pending
5228 (p->gnutls_state))
5229 > 0))
5231 nfds++;
5232 eassert (p->infd == channel);
5233 FD_SET (p->infd, &tls_available);
5234 set++;
5238 else
5240 /* Check this specific channel. */
5241 if (wait_proc->gnutls_p /* Check for valid process. */
5242 && wait_proc->gnutls_state
5243 /* Do we have pending data? */
5244 && ((emacs_gnutls_record_check_pending
5245 (wait_proc->gnutls_state))
5246 > 0))
5248 nfds = 1;
5249 eassert (0 <= wait_proc->infd);
5250 /* Set to Available. */
5251 FD_SET (wait_proc->infd, &tls_available);
5252 set++;
5255 if (set)
5256 Available = tls_available;
5258 #endif
5261 xerrno = errno;
5263 /* Make C-g and alarm signals set flags again. */
5264 clear_waiting_for_input ();
5266 /* If we woke up due to SIGWINCH, actually change size now. */
5267 do_pending_window_change (0);
5269 if (nfds == 0)
5271 /* Exit the main loop if we've passed the requested timeout,
5272 or aren't skipping processes and got some output and
5273 haven't lowered our timeout due to timers or SIGIO and
5274 have waited a long amount of time due to repeated
5275 timers. */
5276 struct timespec huge_timespec
5277 = make_timespec (TYPE_MAXIMUM (time_t), 2 * TIMESPEC_RESOLUTION);
5278 struct timespec cmp_time = huge_timespec;
5279 if (wait < TIMEOUT)
5280 break;
5281 if (wait == TIMEOUT)
5282 cmp_time = end_time;
5283 if (!process_skipped && got_some_output > 0
5284 && (timeout.tv_sec > 0 || timeout.tv_nsec > 0))
5286 if (!timespec_valid_p (got_output_end_time))
5287 break;
5288 if (timespec_cmp (got_output_end_time, cmp_time) < 0)
5289 cmp_time = got_output_end_time;
5291 if (timespec_cmp (cmp_time, huge_timespec) < 0)
5293 now = current_timespec ();
5294 if (timespec_cmp (cmp_time, now) <= 0)
5295 break;
5299 if (nfds < 0)
5301 if (xerrno == EINTR)
5302 no_avail = 1;
5303 else if (xerrno == EBADF)
5304 emacs_abort ();
5305 else
5306 report_file_errno ("Failed select", Qnil, xerrno);
5309 /* Check for keyboard input. */
5310 /* If there is any, return immediately
5311 to give it higher priority than subprocesses. */
5313 if (read_kbd != 0)
5315 unsigned old_timers_run = timers_run;
5316 struct buffer *old_buffer = current_buffer;
5317 Lisp_Object old_window = selected_window;
5318 bool leave = false;
5320 if (detect_input_pending_run_timers (do_display))
5322 swallow_events (do_display);
5323 if (detect_input_pending_run_timers (do_display))
5324 leave = true;
5327 /* If a timer has run, this might have changed buffers
5328 an alike. Make read_key_sequence aware of that. */
5329 if (timers_run != old_timers_run
5330 && waiting_for_user_input_p == -1
5331 && (old_buffer != current_buffer
5332 || !EQ (old_window, selected_window)))
5333 record_asynch_buffer_change ();
5335 if (leave)
5336 break;
5339 /* If there is unread keyboard input, also return. */
5340 if (read_kbd != 0
5341 && requeued_events_pending_p ())
5342 break;
5344 /* If we are not checking for keyboard input now,
5345 do process events (but don't run any timers).
5346 This is so that X events will be processed.
5347 Otherwise they may have to wait until polling takes place.
5348 That would causes delays in pasting selections, for example.
5350 (We used to do this only if wait_for_cell.) */
5351 if (read_kbd == 0 && detect_input_pending ())
5353 swallow_events (do_display);
5354 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
5355 if (detect_input_pending ())
5356 break;
5357 #endif
5360 /* Exit now if the cell we're waiting for became non-nil. */
5361 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
5362 break;
5364 #ifdef USABLE_SIGIO
5365 /* If we think we have keyboard input waiting, but didn't get SIGIO,
5366 go read it. This can happen with X on BSD after logging out.
5367 In that case, there really is no input and no SIGIO,
5368 but select says there is input. */
5370 if (read_kbd && interrupt_input
5371 && keyboard_bit_set (&Available) && ! noninteractive)
5372 handle_input_available_signal (SIGIO);
5373 #endif
5375 /* If checking input just got us a size-change event from X,
5376 obey it now if we should. */
5377 if (read_kbd || ! NILP (wait_for_cell))
5378 do_pending_window_change (0);
5380 /* Check for data from a process. */
5381 if (no_avail || nfds == 0)
5382 continue;
5384 for (channel = 0; channel <= max_input_desc; ++channel)
5386 struct fd_callback_data *d = &fd_callback_info[channel];
5387 if (d->func
5388 && ((d->condition & FOR_READ
5389 && FD_ISSET (channel, &Available))
5390 || (d->condition & FOR_WRITE
5391 && FD_ISSET (channel, &write_mask))))
5392 d->func (channel, d->data);
5395 for (channel = 0; channel <= max_process_desc; channel++)
5397 if (FD_ISSET (channel, &Available)
5398 && FD_ISSET (channel, &non_keyboard_wait_mask)
5399 && !FD_ISSET (channel, &non_process_wait_mask))
5401 int nread;
5403 /* If waiting for this channel, arrange to return as
5404 soon as no more input to be processed. No more
5405 waiting. */
5406 proc = chan_process[channel];
5407 if (NILP (proc))
5408 continue;
5410 /* If this is a server stream socket, accept connection. */
5411 if (EQ (XPROCESS (proc)->status, Qlisten))
5413 server_accept_connection (proc, channel);
5414 continue;
5417 /* Read data from the process, starting with our
5418 buffered-ahead character if we have one. */
5420 nread = read_process_output (proc, channel);
5421 if ((!wait_proc || wait_proc == XPROCESS (proc))
5422 && got_some_output < nread)
5423 got_some_output = nread;
5424 if (nread > 0)
5426 /* Vacuum up any leftovers without waiting. */
5427 if (wait_proc == XPROCESS (proc))
5428 wait = MINIMUM;
5429 /* Since read_process_output can run a filter,
5430 which can call accept-process-output,
5431 don't try to read from any other processes
5432 before doing the select again. */
5433 FD_ZERO (&Available);
5435 if (do_display)
5436 redisplay_preserve_echo_area (12);
5438 else if (nread == -1 && would_block (errno))
5440 #ifdef WINDOWSNT
5441 /* FIXME: Is this special case still needed? */
5442 /* Note that we cannot distinguish between no input
5443 available now and a closed pipe.
5444 With luck, a closed pipe will be accompanied by
5445 subprocess termination and SIGCHLD. */
5446 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc)
5447 && !PIPECONN_P (proc))
5449 #endif
5450 #ifdef HAVE_PTYS
5451 /* On some OSs with ptys, when the process on one end of
5452 a pty exits, the other end gets an error reading with
5453 errno = EIO instead of getting an EOF (0 bytes read).
5454 Therefore, if we get an error reading and errno =
5455 EIO, just continue, because the child process has
5456 exited and should clean itself up soon (e.g. when we
5457 get a SIGCHLD). */
5458 else if (nread == -1 && errno == EIO)
5460 struct Lisp_Process *p = XPROCESS (proc);
5462 /* Clear the descriptor now, so we only raise the
5463 signal once. */
5464 FD_CLR (channel, &input_wait_mask);
5465 FD_CLR (channel, &non_keyboard_wait_mask);
5467 if (p->pid == -2)
5469 /* If the EIO occurs on a pty, the SIGCHLD handler's
5470 waitpid call will not find the process object to
5471 delete. Do it here. */
5472 p->tick = ++process_tick;
5473 pset_status (p, Qfailed);
5476 #endif /* HAVE_PTYS */
5477 /* If we can detect process termination, don't consider the
5478 process gone just because its pipe is closed. */
5479 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc)
5480 && !PIPECONN_P (proc))
5482 else if (nread == 0 && PIPECONN_P (proc))
5484 /* Preserve status of processes already terminated. */
5485 XPROCESS (proc)->tick = ++process_tick;
5486 deactivate_process (proc);
5487 if (EQ (XPROCESS (proc)->status, Qrun))
5488 pset_status (XPROCESS (proc),
5489 list2 (Qexit, make_number (0)));
5491 else
5493 /* Preserve status of processes already terminated. */
5494 XPROCESS (proc)->tick = ++process_tick;
5495 deactivate_process (proc);
5496 if (XPROCESS (proc)->raw_status_new)
5497 update_status (XPROCESS (proc));
5498 if (EQ (XPROCESS (proc)->status, Qrun))
5499 pset_status (XPROCESS (proc),
5500 list2 (Qexit, make_number (256)));
5503 if (FD_ISSET (channel, &Writeok)
5504 && FD_ISSET (channel, &connect_wait_mask))
5506 struct Lisp_Process *p;
5508 FD_CLR (channel, &connect_wait_mask);
5509 FD_CLR (channel, &write_mask);
5510 if (--num_pending_connects < 0)
5511 emacs_abort ();
5513 proc = chan_process[channel];
5514 if (NILP (proc))
5515 continue;
5517 p = XPROCESS (proc);
5519 #ifndef WINDOWSNT
5521 socklen_t xlen = sizeof (xerrno);
5522 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
5523 xerrno = errno;
5525 #else
5526 /* On MS-Windows, getsockopt clears the error for the
5527 entire process, which may not be the right thing; see
5528 w32.c. Use getpeername instead. */
5530 struct sockaddr pname;
5531 socklen_t pnamelen = sizeof (pname);
5533 /* If connection failed, getpeername will fail. */
5534 xerrno = 0;
5535 if (getpeername (channel, &pname, &pnamelen) < 0)
5537 /* Obtain connect failure code through error slippage. */
5538 char dummy;
5539 xerrno = errno;
5540 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
5541 xerrno = errno;
5544 #endif
5545 if (xerrno)
5547 Lisp_Object addrinfos
5548 = connecting_status (p->status) ? XCDR (p->status) : Qnil;
5549 if (!NILP (addrinfos))
5550 XSETCDR (p->status, XCDR (addrinfos));
5551 else
5553 p->tick = ++process_tick;
5554 pset_status (p, list2 (Qfailed, make_number (xerrno)));
5556 deactivate_process (proc);
5557 if (!NILP (addrinfos))
5558 connect_network_socket (proc, addrinfos, Qnil);
5560 else
5562 #ifdef HAVE_GNUTLS
5563 /* If we have an incompletely set up TLS connection,
5564 then defer the sentinel signaling until
5565 later. */
5566 if (NILP (p->gnutls_boot_parameters)
5567 && !p->gnutls_p)
5568 #endif
5570 pset_status (p, Qrun);
5571 /* Execute the sentinel here. If we had relied on
5572 status_notify to do it later, it will read input
5573 from the process before calling the sentinel. */
5574 exec_sentinel (proc, build_string ("open\n"));
5577 if (0 <= p->infd && !EQ (p->filter, Qt)
5578 && !EQ (p->command, Qt))
5580 FD_SET (p->infd, &input_wait_mask);
5581 FD_SET (p->infd, &non_keyboard_wait_mask);
5585 } /* End for each file descriptor. */
5586 } /* End while exit conditions not met. */
5588 unbind_to (count, Qnil);
5590 /* If calling from keyboard input, do not quit
5591 since we want to return C-g as an input character.
5592 Otherwise, do pending quit if requested. */
5593 if (read_kbd >= 0)
5595 /* Prevent input_pending from remaining set if we quit. */
5596 clear_input_pending ();
5597 QUIT;
5600 return got_some_output;
5603 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
5605 static Lisp_Object
5606 read_process_output_call (Lisp_Object fun_and_args)
5608 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
5611 static Lisp_Object
5612 read_process_output_error_handler (Lisp_Object error_val)
5614 cmd_error_internal (error_val, "error in process filter: ");
5615 Vinhibit_quit = Qt;
5616 update_echo_area ();
5617 Fsleep_for (make_number (2), Qnil);
5618 return Qt;
5621 static void
5622 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5623 ssize_t nbytes,
5624 struct coding_system *coding);
5626 /* Read pending output from the process channel,
5627 starting with our buffered-ahead character if we have one.
5628 Yield number of decoded characters read.
5630 This function reads at most 4096 characters.
5631 If you want to read all available subprocess output,
5632 you must call it repeatedly until it returns zero.
5634 The characters read are decoded according to PROC's coding-system
5635 for decoding. */
5637 static int
5638 read_process_output (Lisp_Object proc, int channel)
5640 ssize_t nbytes;
5641 struct Lisp_Process *p = XPROCESS (proc);
5642 struct coding_system *coding = proc_decode_coding_system[channel];
5643 int carryover = p->decoding_carryover;
5644 enum { readmax = 4096 };
5645 ptrdiff_t count = SPECPDL_INDEX ();
5646 Lisp_Object odeactivate;
5647 char chars[sizeof coding->carryover + readmax];
5649 if (carryover)
5650 /* See the comment above. */
5651 memcpy (chars, SDATA (p->decoding_buf), carryover);
5653 #ifdef DATAGRAM_SOCKETS
5654 /* We have a working select, so proc_buffered_char is always -1. */
5655 if (DATAGRAM_CHAN_P (channel))
5657 socklen_t len = datagram_address[channel].len;
5658 nbytes = recvfrom (channel, chars + carryover, readmax,
5659 0, datagram_address[channel].sa, &len);
5661 else
5662 #endif
5664 bool buffered = proc_buffered_char[channel] >= 0;
5665 if (buffered)
5667 chars[carryover] = proc_buffered_char[channel];
5668 proc_buffered_char[channel] = -1;
5670 #ifdef HAVE_GNUTLS
5671 if (p->gnutls_p && p->gnutls_state)
5672 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
5673 readmax - buffered);
5674 else
5675 #endif
5676 nbytes = emacs_read (channel, chars + carryover + buffered,
5677 readmax - buffered);
5678 if (nbytes > 0 && p->adaptive_read_buffering)
5680 int delay = p->read_output_delay;
5681 if (nbytes < 256)
5683 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5685 if (delay == 0)
5686 process_output_delay_count++;
5687 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5690 else if (delay > 0 && nbytes == readmax - buffered)
5692 delay -= READ_OUTPUT_DELAY_INCREMENT;
5693 if (delay == 0)
5694 process_output_delay_count--;
5696 p->read_output_delay = delay;
5697 if (delay)
5699 p->read_output_skip = 1;
5700 process_output_skip = 1;
5703 nbytes += buffered;
5704 nbytes += buffered && nbytes <= 0;
5707 p->decoding_carryover = 0;
5709 /* At this point, NBYTES holds number of bytes just received
5710 (including the one in proc_buffered_char[channel]). */
5711 if (nbytes <= 0)
5713 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5714 return nbytes;
5715 coding->mode |= CODING_MODE_LAST_BLOCK;
5718 /* Now set NBYTES how many bytes we must decode. */
5719 nbytes += carryover;
5721 odeactivate = Vdeactivate_mark;
5722 /* There's no good reason to let process filters change the current
5723 buffer, and many callers of accept-process-output, sit-for, and
5724 friends don't expect current-buffer to be changed from under them. */
5725 record_unwind_current_buffer ();
5727 read_and_dispose_of_process_output (p, chars, nbytes, coding);
5729 /* Handling the process output should not deactivate the mark. */
5730 Vdeactivate_mark = odeactivate;
5732 unbind_to (count, Qnil);
5733 return nbytes;
5736 static void
5737 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5738 ssize_t nbytes,
5739 struct coding_system *coding)
5741 Lisp_Object outstream = p->filter;
5742 Lisp_Object text;
5743 bool outer_running_asynch_code = running_asynch_code;
5744 int waiting = waiting_for_user_input_p;
5746 #if 0
5747 Lisp_Object obuffer, okeymap;
5748 XSETBUFFER (obuffer, current_buffer);
5749 okeymap = BVAR (current_buffer, keymap);
5750 #endif
5752 /* We inhibit quit here instead of just catching it so that
5753 hitting ^G when a filter happens to be running won't screw
5754 it up. */
5755 specbind (Qinhibit_quit, Qt);
5756 specbind (Qlast_nonmenu_event, Qt);
5758 /* In case we get recursively called,
5759 and we already saved the match data nonrecursively,
5760 save the same match data in safely recursive fashion. */
5761 if (outer_running_asynch_code)
5763 Lisp_Object tem;
5764 /* Don't clobber the CURRENT match data, either! */
5765 tem = Fmatch_data (Qnil, Qnil, Qnil);
5766 restore_search_regs ();
5767 record_unwind_save_match_data ();
5768 Fset_match_data (tem, Qt);
5771 /* For speed, if a search happens within this code,
5772 save the match data in a special nonrecursive fashion. */
5773 running_asynch_code = 1;
5775 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5776 text = coding->dst_object;
5777 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5778 /* A new coding system might be found. */
5779 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5781 pset_decode_coding_system (p, Vlast_coding_system_used);
5783 /* Don't call setup_coding_system for
5784 proc_decode_coding_system[channel] here. It is done in
5785 detect_coding called via decode_coding above. */
5787 /* If a coding system for encoding is not yet decided, we set
5788 it as the same as coding-system for decoding.
5790 But, before doing that we must check if
5791 proc_encode_coding_system[p->outfd] surely points to a
5792 valid memory because p->outfd will be changed once EOF is
5793 sent to the process. */
5794 if (NILP (p->encode_coding_system) && p->outfd >= 0
5795 && proc_encode_coding_system[p->outfd])
5797 pset_encode_coding_system
5798 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5799 setup_coding_system (p->encode_coding_system,
5800 proc_encode_coding_system[p->outfd]);
5804 if (coding->carryover_bytes > 0)
5806 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5807 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5808 memcpy (SDATA (p->decoding_buf), coding->carryover,
5809 coding->carryover_bytes);
5810 p->decoding_carryover = coding->carryover_bytes;
5812 if (SBYTES (text) > 0)
5813 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5814 sometimes it's simply wrong to wrap (e.g. when called from
5815 accept-process-output). */
5816 internal_condition_case_1 (read_process_output_call,
5817 list3 (outstream, make_lisp_proc (p), text),
5818 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5819 read_process_output_error_handler);
5821 /* If we saved the match data nonrecursively, restore it now. */
5822 restore_search_regs ();
5823 running_asynch_code = outer_running_asynch_code;
5825 /* Restore waiting_for_user_input_p as it was
5826 when we were called, in case the filter clobbered it. */
5827 waiting_for_user_input_p = waiting;
5829 #if 0 /* Call record_asynch_buffer_change unconditionally,
5830 because we might have changed minor modes or other things
5831 that affect key bindings. */
5832 if (! EQ (Fcurrent_buffer (), obuffer)
5833 || ! EQ (current_buffer->keymap, okeymap))
5834 #endif
5835 /* But do it only if the caller is actually going to read events.
5836 Otherwise there's no need to make him wake up, and it could
5837 cause trouble (for example it would make sit_for return). */
5838 if (waiting_for_user_input_p == -1)
5839 record_asynch_buffer_change ();
5842 DEFUN ("internal-default-process-filter", Finternal_default_process_filter,
5843 Sinternal_default_process_filter, 2, 2, 0,
5844 doc: /* Function used as default process filter.
5845 This inserts the process's output into its buffer, if there is one.
5846 Otherwise it discards the output. */)
5847 (Lisp_Object proc, Lisp_Object text)
5849 struct Lisp_Process *p;
5850 ptrdiff_t opoint;
5852 CHECK_PROCESS (proc);
5853 p = XPROCESS (proc);
5854 CHECK_STRING (text);
5856 if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5858 Lisp_Object old_read_only;
5859 ptrdiff_t old_begv, old_zv;
5860 ptrdiff_t old_begv_byte, old_zv_byte;
5861 ptrdiff_t before, before_byte;
5862 ptrdiff_t opoint_byte;
5863 struct buffer *b;
5865 Fset_buffer (p->buffer);
5866 opoint = PT;
5867 opoint_byte = PT_BYTE;
5868 old_read_only = BVAR (current_buffer, read_only);
5869 old_begv = BEGV;
5870 old_zv = ZV;
5871 old_begv_byte = BEGV_BYTE;
5872 old_zv_byte = ZV_BYTE;
5874 bset_read_only (current_buffer, Qnil);
5876 /* Insert new output into buffer at the current end-of-output
5877 marker, thus preserving logical ordering of input and output. */
5878 if (XMARKER (p->mark)->buffer)
5879 set_point_from_marker (p->mark);
5880 else
5881 SET_PT_BOTH (ZV, ZV_BYTE);
5882 before = PT;
5883 before_byte = PT_BYTE;
5885 /* If the output marker is outside of the visible region, save
5886 the restriction and widen. */
5887 if (! (BEGV <= PT && PT <= ZV))
5888 Fwiden ();
5890 /* Adjust the multibyteness of TEXT to that of the buffer. */
5891 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5892 != ! STRING_MULTIBYTE (text))
5893 text = (STRING_MULTIBYTE (text)
5894 ? Fstring_as_unibyte (text)
5895 : Fstring_to_multibyte (text));
5896 /* Insert before markers in case we are inserting where
5897 the buffer's mark is, and the user's next command is Meta-y. */
5898 insert_from_string_before_markers (text, 0, 0,
5899 SCHARS (text), SBYTES (text), 0);
5901 /* Make sure the process marker's position is valid when the
5902 process buffer is changed in the signal_after_change above.
5903 W3 is known to do that. */
5904 if (BUFFERP (p->buffer)
5905 && (b = XBUFFER (p->buffer), b != current_buffer))
5906 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5907 else
5908 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5910 update_mode_lines = 23;
5912 /* Make sure opoint and the old restrictions
5913 float ahead of any new text just as point would. */
5914 if (opoint >= before)
5916 opoint += PT - before;
5917 opoint_byte += PT_BYTE - before_byte;
5919 if (old_begv > before)
5921 old_begv += PT - before;
5922 old_begv_byte += PT_BYTE - before_byte;
5924 if (old_zv >= before)
5926 old_zv += PT - before;
5927 old_zv_byte += PT_BYTE - before_byte;
5930 /* If the restriction isn't what it should be, set it. */
5931 if (old_begv != BEGV || old_zv != ZV)
5932 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5934 bset_read_only (current_buffer, old_read_only);
5935 SET_PT_BOTH (opoint, opoint_byte);
5937 return Qnil;
5940 /* Sending data to subprocess. */
5942 /* In send_process, when a write fails temporarily,
5943 wait_reading_process_output is called. It may execute user code,
5944 e.g. timers, that attempts to write new data to the same process.
5945 We must ensure that data is sent in the right order, and not
5946 interspersed half-completed with other writes (Bug#10815). This is
5947 handled by the write_queue element of struct process. It is a list
5948 with each entry having the form
5950 (string . (offset . length))
5952 where STRING is a lisp string, OFFSET is the offset into the
5953 string's byte sequence from which we should begin to send, and
5954 LENGTH is the number of bytes left to send. */
5956 /* Create a new entry in write_queue.
5957 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5958 BUF is a pointer to the string sequence of the input_obj or a C
5959 string in case of Qt or Qnil. */
5961 static void
5962 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5963 const char *buf, ptrdiff_t len, bool front)
5965 ptrdiff_t offset;
5966 Lisp_Object entry, obj;
5968 if (STRINGP (input_obj))
5970 offset = buf - SSDATA (input_obj);
5971 obj = input_obj;
5973 else
5975 offset = 0;
5976 obj = make_unibyte_string (buf, len);
5979 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5981 if (front)
5982 pset_write_queue (p, Fcons (entry, p->write_queue));
5983 else
5984 pset_write_queue (p, nconc2 (p->write_queue, list1 (entry)));
5987 /* Remove the first element in the write_queue of process P, put its
5988 contents in OBJ, BUF and LEN, and return true. If the
5989 write_queue is empty, return false. */
5991 static bool
5992 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5993 const char **buf, ptrdiff_t *len)
5995 Lisp_Object entry, offset_length;
5996 ptrdiff_t offset;
5998 if (NILP (p->write_queue))
5999 return 0;
6001 entry = XCAR (p->write_queue);
6002 pset_write_queue (p, XCDR (p->write_queue));
6004 *obj = XCAR (entry);
6005 offset_length = XCDR (entry);
6007 *len = XINT (XCDR (offset_length));
6008 offset = XINT (XCAR (offset_length));
6009 *buf = SSDATA (*obj) + offset;
6011 return 1;
6014 /* Send some data to process PROC.
6015 BUF is the beginning of the data; LEN is the number of characters.
6016 OBJECT is the Lisp object that the data comes from. If OBJECT is
6017 nil or t, it means that the data comes from C string.
6019 If OBJECT is not nil, the data is encoded by PROC's coding-system
6020 for encoding before it is sent.
6022 This function can evaluate Lisp code and can garbage collect. */
6024 static void
6025 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
6026 Lisp_Object object)
6028 struct Lisp_Process *p = XPROCESS (proc);
6029 ssize_t rv;
6030 struct coding_system *coding;
6032 if (NETCONN_P (proc))
6034 wait_while_connecting (proc);
6035 wait_for_tls_negotiation (proc);
6038 if (p->raw_status_new)
6039 update_status (p);
6040 if (! EQ (p->status, Qrun))
6041 error ("Process %s not running", SDATA (p->name));
6042 if (p->outfd < 0)
6043 error ("Output file descriptor of %s is closed", SDATA (p->name));
6045 coding = proc_encode_coding_system[p->outfd];
6046 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
6048 if ((STRINGP (object) && STRING_MULTIBYTE (object))
6049 || (BUFFERP (object)
6050 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
6051 || EQ (object, Qt))
6053 pset_encode_coding_system
6054 (p, complement_process_encoding_system (p->encode_coding_system));
6055 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
6057 /* The coding system for encoding was changed to raw-text
6058 because we sent a unibyte text previously. Now we are
6059 sending a multibyte text, thus we must encode it by the
6060 original coding system specified for the current process.
6062 Another reason we come here is that the coding system
6063 was just complemented and a new one was returned by
6064 complement_process_encoding_system. */
6065 setup_coding_system (p->encode_coding_system, coding);
6066 Vlast_coding_system_used = p->encode_coding_system;
6068 coding->src_multibyte = 1;
6070 else
6072 coding->src_multibyte = 0;
6073 /* For sending a unibyte text, character code conversion should
6074 not take place but EOL conversion should. So, setup raw-text
6075 or one of the subsidiary if we have not yet done it. */
6076 if (CODING_REQUIRE_ENCODING (coding))
6078 if (CODING_REQUIRE_FLUSHING (coding))
6080 /* But, before changing the coding, we must flush out data. */
6081 coding->mode |= CODING_MODE_LAST_BLOCK;
6082 send_process (proc, "", 0, Qt);
6083 coding->mode &= CODING_MODE_LAST_BLOCK;
6085 setup_coding_system (raw_text_coding_system
6086 (Vlast_coding_system_used),
6087 coding);
6088 coding->src_multibyte = 0;
6091 coding->dst_multibyte = 0;
6093 if (CODING_REQUIRE_ENCODING (coding))
6095 coding->dst_object = Qt;
6096 if (BUFFERP (object))
6098 ptrdiff_t from_byte, from, to;
6099 ptrdiff_t save_pt, save_pt_byte;
6100 struct buffer *cur = current_buffer;
6102 set_buffer_internal (XBUFFER (object));
6103 save_pt = PT, save_pt_byte = PT_BYTE;
6105 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
6106 from = BYTE_TO_CHAR (from_byte);
6107 to = BYTE_TO_CHAR (from_byte + len);
6108 TEMP_SET_PT_BOTH (from, from_byte);
6109 encode_coding_object (coding, object, from, from_byte,
6110 to, from_byte + len, Qt);
6111 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
6112 set_buffer_internal (cur);
6114 else if (STRINGP (object))
6116 encode_coding_object (coding, object, 0, 0, SCHARS (object),
6117 SBYTES (object), Qt);
6119 else
6121 coding->dst_object = make_unibyte_string (buf, len);
6122 coding->produced = len;
6125 len = coding->produced;
6126 object = coding->dst_object;
6127 buf = SSDATA (object);
6130 /* If there is already data in the write_queue, put the new data
6131 in the back of queue. Otherwise, ignore it. */
6132 if (!NILP (p->write_queue))
6133 write_queue_push (p, object, buf, len, 0);
6135 do /* while !NILP (p->write_queue) */
6137 ptrdiff_t cur_len = -1;
6138 const char *cur_buf;
6139 Lisp_Object cur_object;
6141 /* If write_queue is empty, ignore it. */
6142 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
6144 cur_len = len;
6145 cur_buf = buf;
6146 cur_object = object;
6149 while (cur_len > 0)
6151 /* Send this batch, using one or more write calls. */
6152 ptrdiff_t written = 0;
6153 int outfd = p->outfd;
6154 #ifdef DATAGRAM_SOCKETS
6155 if (DATAGRAM_CHAN_P (outfd))
6157 rv = sendto (outfd, cur_buf, cur_len,
6158 0, datagram_address[outfd].sa,
6159 datagram_address[outfd].len);
6160 if (rv >= 0)
6161 written = rv;
6162 else if (errno == EMSGSIZE)
6163 report_file_error ("Sending datagram", proc);
6165 else
6166 #endif
6168 #ifdef HAVE_GNUTLS
6169 if (p->gnutls_p && p->gnutls_state)
6170 written = emacs_gnutls_write (p, cur_buf, cur_len);
6171 else
6172 #endif
6173 written = emacs_write_sig (outfd, cur_buf, cur_len);
6174 rv = (written ? 0 : -1);
6175 if (p->read_output_delay > 0
6176 && p->adaptive_read_buffering == 1)
6178 p->read_output_delay = 0;
6179 process_output_delay_count--;
6180 p->read_output_skip = 0;
6184 if (rv < 0)
6186 if (would_block (errno))
6187 /* Buffer is full. Wait, accepting input;
6188 that may allow the program
6189 to finish doing output and read more. */
6191 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
6192 /* A gross hack to work around a bug in FreeBSD.
6193 In the following sequence, read(2) returns
6194 bogus data:
6196 write(2) 1022 bytes
6197 write(2) 954 bytes, get EAGAIN
6198 read(2) 1024 bytes in process_read_output
6199 read(2) 11 bytes in process_read_output
6201 That is, read(2) returns more bytes than have
6202 ever been written successfully. The 1033 bytes
6203 read are the 1022 bytes written successfully
6204 after processing (for example with CRs added if
6205 the terminal is set up that way which it is
6206 here). The same bytes will be seen again in a
6207 later read(2), without the CRs. */
6209 if (errno == EAGAIN)
6211 int flags = FWRITE;
6212 ioctl (p->outfd, TIOCFLUSH, &flags);
6214 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
6216 /* Put what we should have written in wait_queue. */
6217 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
6218 wait_reading_process_output (0, 20 * 1000 * 1000,
6219 0, 0, Qnil, NULL, 0);
6220 /* Reread queue, to see what is left. */
6221 break;
6223 else if (errno == EPIPE)
6225 p->raw_status_new = 0;
6226 pset_status (p, list2 (Qexit, make_number (256)));
6227 p->tick = ++process_tick;
6228 deactivate_process (proc);
6229 error ("process %s no longer connected to pipe; closed it",
6230 SDATA (p->name));
6232 else
6233 /* This is a real error. */
6234 report_file_error ("Writing to process", proc);
6236 cur_buf += written;
6237 cur_len -= written;
6240 while (!NILP (p->write_queue));
6243 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
6244 3, 3, 0,
6245 doc: /* Send current contents of region as input to PROCESS.
6246 PROCESS may be a process, a buffer, the name of a process or buffer, or
6247 nil, indicating the current buffer's process.
6248 Called from program, takes three arguments, PROCESS, START and END.
6249 If the region is more than 500 characters long,
6250 it is sent in several bunches. This may happen even for shorter regions.
6251 Output from processes can arrive in between bunches.
6253 If PROCESS is a non-blocking network process that hasn't been fully
6254 set up yet, this function will block until socket setup has completed. */)
6255 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
6257 Lisp_Object proc = get_process (process);
6258 ptrdiff_t start_byte, end_byte;
6260 validate_region (&start, &end);
6262 start_byte = CHAR_TO_BYTE (XINT (start));
6263 end_byte = CHAR_TO_BYTE (XINT (end));
6265 if (XINT (start) < GPT && XINT (end) > GPT)
6266 move_gap_both (XINT (start), start_byte);
6268 if (NETCONN_P (proc))
6269 wait_while_connecting (proc);
6271 send_process (proc, (char *) BYTE_POS_ADDR (start_byte),
6272 end_byte - start_byte, Fcurrent_buffer ());
6274 return Qnil;
6277 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
6278 2, 2, 0,
6279 doc: /* Send PROCESS the contents of STRING as input.
6280 PROCESS may be a process, a buffer, the name of a process or buffer, or
6281 nil, indicating the current buffer's process.
6282 If STRING is more than 500 characters long,
6283 it is sent in several bunches. This may happen even for shorter strings.
6284 Output from processes can arrive in between bunches.
6286 If PROCESS is a non-blocking network process that hasn't been fully
6287 set up yet, this function will block until socket setup has completed. */)
6288 (Lisp_Object process, Lisp_Object string)
6290 CHECK_STRING (string);
6291 Lisp_Object proc = get_process (process);
6292 send_process (proc, SSDATA (string),
6293 SBYTES (string), string);
6294 return Qnil;
6297 /* Return the foreground process group for the tty/pty that
6298 the process P uses. */
6299 static pid_t
6300 emacs_get_tty_pgrp (struct Lisp_Process *p)
6302 pid_t gid = -1;
6304 #ifdef TIOCGPGRP
6305 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
6307 int fd;
6308 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
6309 master side. Try the slave side. */
6310 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
6312 if (fd != -1)
6314 ioctl (fd, TIOCGPGRP, &gid);
6315 emacs_close (fd);
6318 #endif /* defined (TIOCGPGRP ) */
6320 return gid;
6323 DEFUN ("process-running-child-p", Fprocess_running_child_p,
6324 Sprocess_running_child_p, 0, 1, 0,
6325 doc: /* Return non-nil if PROCESS has given the terminal to a
6326 child. If the operating system does not make it possible to find out,
6327 return t. If we can find out, return the numeric ID of the foreground
6328 process group. */)
6329 (Lisp_Object process)
6331 /* Initialize in case ioctl doesn't exist or gives an error,
6332 in a way that will cause returning t. */
6333 Lisp_Object proc = get_process (process);
6334 struct Lisp_Process *p = XPROCESS (proc);
6336 if (!EQ (p->type, Qreal))
6337 error ("Process %s is not a subprocess",
6338 SDATA (p->name));
6339 if (p->infd < 0)
6340 error ("Process %s is not active",
6341 SDATA (p->name));
6343 pid_t gid = emacs_get_tty_pgrp (p);
6345 if (gid == p->pid)
6346 return Qnil;
6347 if (gid != -1)
6348 return make_number (gid);
6349 return Qt;
6352 /* Send a signal number SIGNO to PROCESS.
6353 If CURRENT_GROUP is t, that means send to the process group
6354 that currently owns the terminal being used to communicate with PROCESS.
6355 This is used for various commands in shell mode.
6356 If CURRENT_GROUP is lambda, that means send to the process group
6357 that currently owns the terminal, but only if it is NOT the shell itself.
6359 If NOMSG is false, insert signal-announcements into process's buffers
6360 right away.
6362 If we can, we try to signal PROCESS by sending control characters
6363 down the pty. This allows us to signal inferiors who have changed
6364 their uid, for which kill would return an EPERM error. */
6366 static void
6367 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
6368 bool nomsg)
6370 Lisp_Object proc;
6371 struct Lisp_Process *p;
6372 pid_t gid;
6373 bool no_pgrp = 0;
6375 proc = get_process (process);
6376 p = XPROCESS (proc);
6378 if (!EQ (p->type, Qreal))
6379 error ("Process %s is not a subprocess",
6380 SDATA (p->name));
6381 if (p->infd < 0)
6382 error ("Process %s is not active",
6383 SDATA (p->name));
6385 if (!p->pty_flag)
6386 current_group = Qnil;
6388 /* If we are using pgrps, get a pgrp number and make it negative. */
6389 if (NILP (current_group))
6390 /* Send the signal to the shell's process group. */
6391 gid = p->pid;
6392 else
6394 #ifdef SIGNALS_VIA_CHARACTERS
6395 /* If possible, send signals to the entire pgrp
6396 by sending an input character to it. */
6398 struct termios t;
6399 cc_t *sig_char = NULL;
6401 tcgetattr (p->infd, &t);
6403 switch (signo)
6405 case SIGINT:
6406 sig_char = &t.c_cc[VINTR];
6407 break;
6409 case SIGQUIT:
6410 sig_char = &t.c_cc[VQUIT];
6411 break;
6413 case SIGTSTP:
6414 #ifdef VSWTCH
6415 sig_char = &t.c_cc[VSWTCH];
6416 #else
6417 sig_char = &t.c_cc[VSUSP];
6418 #endif
6419 break;
6422 if (sig_char && *sig_char != CDISABLE)
6424 send_process (proc, (char *) sig_char, 1, Qnil);
6425 return;
6427 /* If we can't send the signal with a character,
6428 fall through and send it another way. */
6430 /* The code above may fall through if it can't
6431 handle the signal. */
6432 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
6434 #ifdef TIOCGPGRP
6435 /* Get the current pgrp using the tty itself, if we have that.
6436 Otherwise, use the pty to get the pgrp.
6437 On pfa systems, saka@pfu.fujitsu.co.JP writes:
6438 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
6439 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
6440 His patch indicates that if TIOCGPGRP returns an error, then
6441 we should just assume that p->pid is also the process group id. */
6443 gid = emacs_get_tty_pgrp (p);
6445 if (gid == -1)
6446 /* If we can't get the information, assume
6447 the shell owns the tty. */
6448 gid = p->pid;
6450 /* It is not clear whether anything really can set GID to -1.
6451 Perhaps on some system one of those ioctls can or could do so.
6452 Or perhaps this is vestigial. */
6453 if (gid == -1)
6454 no_pgrp = 1;
6455 #else /* ! defined (TIOCGPGRP) */
6456 /* Can't select pgrps on this system, so we know that
6457 the child itself heads the pgrp. */
6458 gid = p->pid;
6459 #endif /* ! defined (TIOCGPGRP) */
6461 /* If current_group is lambda, and the shell owns the terminal,
6462 don't send any signal. */
6463 if (EQ (current_group, Qlambda) && gid == p->pid)
6464 return;
6467 #ifdef SIGCONT
6468 if (signo == SIGCONT)
6470 p->raw_status_new = 0;
6471 pset_status (p, Qrun);
6472 p->tick = ++process_tick;
6473 if (!nomsg)
6475 status_notify (NULL, NULL);
6476 redisplay_preserve_echo_area (13);
6479 #endif
6481 #ifdef TIOCSIGSEND
6482 /* Work around a HP-UX 7.0 bug that mishandles signals to subjobs.
6483 We don't know whether the bug is fixed in later HP-UX versions. */
6484 if (! NILP (current_group) && ioctl (p->infd, TIOCSIGSEND, signo) != -1)
6485 return;
6486 #endif
6488 /* If we don't have process groups, send the signal to the immediate
6489 subprocess. That isn't really right, but it's better than any
6490 obvious alternative. */
6491 pid_t pid = no_pgrp ? gid : - gid;
6493 /* Do not kill an already-reaped process, as that could kill an
6494 innocent bystander that happens to have the same process ID. */
6495 sigset_t oldset;
6496 block_child_signal (&oldset);
6497 if (p->alive)
6498 kill (pid, signo);
6499 unblock_child_signal (&oldset);
6502 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
6503 doc: /* Interrupt process PROCESS.
6504 PROCESS may be a process, a buffer, or the name of a process or buffer.
6505 No arg or nil means current buffer's process.
6506 Second arg CURRENT-GROUP non-nil means send signal to
6507 the current process-group of the process's controlling terminal
6508 rather than to the process's own process group.
6509 If the process is a shell, this means interrupt current subjob
6510 rather than the shell.
6512 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
6513 don't send the signal. */)
6514 (Lisp_Object process, Lisp_Object current_group)
6516 process_send_signal (process, SIGINT, current_group, 0);
6517 return process;
6520 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
6521 doc: /* Kill process PROCESS. May be process or name of one.
6522 See function `interrupt-process' for more details on usage. */)
6523 (Lisp_Object process, Lisp_Object current_group)
6525 process_send_signal (process, SIGKILL, current_group, 0);
6526 return process;
6529 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
6530 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
6531 See function `interrupt-process' for more details on usage. */)
6532 (Lisp_Object process, Lisp_Object current_group)
6534 process_send_signal (process, SIGQUIT, current_group, 0);
6535 return process;
6538 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
6539 doc: /* Stop process PROCESS. May be process or name of one.
6540 See function `interrupt-process' for more details on usage.
6541 If PROCESS is a network or serial process, inhibit handling of incoming
6542 traffic. */)
6543 (Lisp_Object process, Lisp_Object current_group)
6545 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)
6546 || PIPECONN_P (process)))
6548 struct Lisp_Process *p;
6550 p = XPROCESS (process);
6551 if (NILP (p->command)
6552 && p->infd >= 0)
6554 FD_CLR (p->infd, &input_wait_mask);
6555 FD_CLR (p->infd, &non_keyboard_wait_mask);
6557 pset_command (p, Qt);
6558 return process;
6560 #ifndef SIGTSTP
6561 error ("No SIGTSTP support");
6562 #else
6563 process_send_signal (process, SIGTSTP, current_group, 0);
6564 #endif
6565 return process;
6568 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
6569 doc: /* Continue process PROCESS. May be process or name of one.
6570 See function `interrupt-process' for more details on usage.
6571 If PROCESS is a network or serial process, resume handling of incoming
6572 traffic. */)
6573 (Lisp_Object process, Lisp_Object current_group)
6575 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)
6576 || PIPECONN_P (process)))
6578 struct Lisp_Process *p;
6580 p = XPROCESS (process);
6581 if (EQ (p->command, Qt)
6582 && p->infd >= 0
6583 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
6585 FD_SET (p->infd, &input_wait_mask);
6586 FD_SET (p->infd, &non_keyboard_wait_mask);
6587 #ifdef WINDOWSNT
6588 if (fd_info[ p->infd ].flags & FILE_SERIAL)
6589 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
6590 #else /* not WINDOWSNT */
6591 tcflush (p->infd, TCIFLUSH);
6592 #endif /* not WINDOWSNT */
6594 pset_command (p, Qnil);
6595 return process;
6597 #ifdef SIGCONT
6598 process_send_signal (process, SIGCONT, current_group, 0);
6599 #else
6600 error ("No SIGCONT support");
6601 #endif
6602 return process;
6605 /* Return the integer value of the signal whose abbreviation is ABBR,
6606 or a negative number if there is no such signal. */
6607 static int
6608 abbr_to_signal (char const *name)
6610 int i, signo;
6611 char sigbuf[20]; /* Large enough for all valid signal abbreviations. */
6613 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
6614 name += 3;
6616 for (i = 0; i < sizeof sigbuf; i++)
6618 sigbuf[i] = c_toupper (name[i]);
6619 if (! sigbuf[i])
6620 return str2sig (sigbuf, &signo) == 0 ? signo : -1;
6623 return -1;
6626 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
6627 2, 2, "sProcess (name or number): \nnSignal code: ",
6628 doc: /* Send PROCESS the signal with code SIGCODE.
6629 PROCESS may also be a number specifying the process id of the
6630 process to signal; in this case, the process need not be a child of
6631 this Emacs.
6632 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
6633 (Lisp_Object process, Lisp_Object sigcode)
6635 pid_t pid;
6636 int signo;
6638 if (STRINGP (process))
6640 Lisp_Object tem = Fget_process (process);
6641 if (NILP (tem))
6643 Lisp_Object process_number
6644 = string_to_number (SSDATA (process), 10, 1);
6645 if (NUMBERP (process_number))
6646 tem = process_number;
6648 process = tem;
6650 else if (!NUMBERP (process))
6651 process = get_process (process);
6653 if (NILP (process))
6654 return process;
6656 if (NUMBERP (process))
6657 CONS_TO_INTEGER (process, pid_t, pid);
6658 else
6660 CHECK_PROCESS (process);
6661 pid = XPROCESS (process)->pid;
6662 if (pid <= 0)
6663 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
6666 if (INTEGERP (sigcode))
6668 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
6669 signo = XINT (sigcode);
6671 else
6673 char *name;
6675 CHECK_SYMBOL (sigcode);
6676 name = SSDATA (SYMBOL_NAME (sigcode));
6678 signo = abbr_to_signal (name);
6679 if (signo < 0)
6680 error ("Undefined signal name %s", name);
6683 return make_number (kill (pid, signo));
6686 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6687 doc: /* Make PROCESS see end-of-file in its input.
6688 EOF comes after any text already sent to it.
6689 PROCESS may be a process, a buffer, the name of a process or buffer, or
6690 nil, indicating the current buffer's process.
6691 If PROCESS is a network connection, or is a process communicating
6692 through a pipe (as opposed to a pty), then you cannot send any more
6693 text to PROCESS after you call this function.
6694 If PROCESS is a serial process, wait until all output written to the
6695 process has been transmitted to the serial port. */)
6696 (Lisp_Object process)
6698 Lisp_Object proc;
6699 struct coding_system *coding = NULL;
6700 int outfd;
6702 proc = get_process (process);
6704 if (NETCONN_P (proc))
6705 wait_while_connecting (proc);
6707 if (DATAGRAM_CONN_P (proc))
6708 return process;
6711 outfd = XPROCESS (proc)->outfd;
6712 if (outfd >= 0)
6713 coding = proc_encode_coding_system[outfd];
6715 /* Make sure the process is really alive. */
6716 if (XPROCESS (proc)->raw_status_new)
6717 update_status (XPROCESS (proc));
6718 if (! EQ (XPROCESS (proc)->status, Qrun))
6719 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6721 if (coding && CODING_REQUIRE_FLUSHING (coding))
6723 coding->mode |= CODING_MODE_LAST_BLOCK;
6724 send_process (proc, "", 0, Qnil);
6727 if (XPROCESS (proc)->pty_flag)
6728 send_process (proc, "\004", 1, Qnil);
6729 else if (EQ (XPROCESS (proc)->type, Qserial))
6731 #ifndef WINDOWSNT
6732 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6733 report_file_error ("Failed tcdrain", Qnil);
6734 #endif /* not WINDOWSNT */
6735 /* Do nothing on Windows because writes are blocking. */
6737 else
6739 struct Lisp_Process *p = XPROCESS (proc);
6740 int old_outfd = p->outfd;
6741 int new_outfd;
6743 #ifdef HAVE_SHUTDOWN
6744 /* If this is a network connection, or socketpair is used
6745 for communication with the subprocess, call shutdown to cause EOF.
6746 (In some old system, shutdown to socketpair doesn't work.
6747 Then we just can't win.) */
6748 if (0 <= old_outfd
6749 && (EQ (p->type, Qnetwork) || p->infd == old_outfd))
6750 shutdown (old_outfd, 1);
6751 #endif
6752 close_process_fd (&p->open_fd[WRITE_TO_SUBPROCESS]);
6753 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6754 if (new_outfd < 0)
6755 report_file_error ("Opening null device", Qnil);
6756 p->open_fd[WRITE_TO_SUBPROCESS] = new_outfd;
6757 p->outfd = new_outfd;
6759 if (!proc_encode_coding_system[new_outfd])
6760 proc_encode_coding_system[new_outfd]
6761 = xmalloc (sizeof (struct coding_system));
6762 if (old_outfd >= 0)
6764 *proc_encode_coding_system[new_outfd]
6765 = *proc_encode_coding_system[old_outfd];
6766 memset (proc_encode_coding_system[old_outfd], 0,
6767 sizeof (struct coding_system));
6769 else
6770 setup_coding_system (p->encode_coding_system,
6771 proc_encode_coding_system[new_outfd]);
6773 return process;
6776 /* The main Emacs thread records child processes in three places:
6778 - Vprocess_alist, for asynchronous subprocesses, which are child
6779 processes visible to Lisp.
6781 - deleted_pid_list, for child processes invisible to Lisp,
6782 typically because of delete-process. These are recorded so that
6783 the processes can be reaped when they exit, so that the operating
6784 system's process table is not cluttered by zombies.
6786 - the local variable PID in Fcall_process, call_process_cleanup and
6787 call_process_kill, for synchronous subprocesses.
6788 record_unwind_protect is used to make sure this process is not
6789 forgotten: if the user interrupts call-process and the child
6790 process refuses to exit immediately even with two C-g's,
6791 call_process_kill adds PID's contents to deleted_pid_list before
6792 returning.
6794 The main Emacs thread invokes waitpid only on child processes that
6795 it creates and that have not been reaped. This avoid races on
6796 platforms such as GTK, where other threads create their own
6797 subprocesses which the main thread should not reap. For example,
6798 if the main thread attempted to reap an already-reaped child, it
6799 might inadvertently reap a GTK-created process that happened to
6800 have the same process ID. */
6802 /* LIB_CHILD_HANDLER is a SIGCHLD handler that Emacs calls while doing
6803 its own SIGCHLD handling. On POSIXish systems, glib needs this to
6804 keep track of its own children. GNUstep is similar. */
6806 static void dummy_handler (int sig) {}
6807 static signal_handler_t volatile lib_child_handler;
6809 /* Handle a SIGCHLD signal by looking for known child processes of
6810 Emacs whose status have changed. For each one found, record its
6811 new status.
6813 All we do is change the status; we do not run sentinels or print
6814 notifications. That is saved for the next time keyboard input is
6815 done, in order to avoid timing errors.
6817 ** WARNING: this can be called during garbage collection.
6818 Therefore, it must not be fooled by the presence of mark bits in
6819 Lisp objects.
6821 ** USG WARNING: Although it is not obvious from the documentation
6822 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6823 signal() before executing at least one wait(), otherwise the
6824 handler will be called again, resulting in an infinite loop. The
6825 relevant portion of the documentation reads "SIGCLD signals will be
6826 queued and the signal-catching function will be continually
6827 reentered until the queue is empty". Invoking signal() causes the
6828 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6829 Inc.
6831 ** Malloc WARNING: This should never call malloc either directly or
6832 indirectly; if it does, that is a bug. */
6834 static void
6835 handle_child_signal (int sig)
6837 Lisp_Object tail, proc;
6839 /* Find the process that signaled us, and record its status. */
6841 /* The process can have been deleted by Fdelete_process, or have
6842 been started asynchronously by Fcall_process. */
6843 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6845 bool all_pids_are_fixnums
6846 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
6847 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
6848 Lisp_Object head = XCAR (tail);
6849 Lisp_Object xpid;
6850 if (! CONSP (head))
6851 continue;
6852 xpid = XCAR (head);
6853 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
6855 pid_t deleted_pid;
6856 if (INTEGERP (xpid))
6857 deleted_pid = XINT (xpid);
6858 else
6859 deleted_pid = XFLOAT_DATA (xpid);
6860 if (child_status_changed (deleted_pid, 0, 0))
6862 if (STRINGP (XCDR (head)))
6863 unlink (SSDATA (XCDR (head)));
6864 XSETCAR (tail, Qnil);
6869 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6870 FOR_EACH_PROCESS (tail, proc)
6872 struct Lisp_Process *p = XPROCESS (proc);
6873 int status;
6875 if (p->alive
6876 && child_status_changed (p->pid, &status, WUNTRACED | WCONTINUED))
6878 /* Change the status of the process that was found. */
6879 p->tick = ++process_tick;
6880 p->raw_status = status;
6881 p->raw_status_new = 1;
6883 /* If process has terminated, stop waiting for its output. */
6884 if (WIFSIGNALED (status) || WIFEXITED (status))
6886 bool clear_desc_flag = 0;
6887 p->alive = 0;
6888 if (p->infd >= 0)
6889 clear_desc_flag = 1;
6891 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
6892 if (clear_desc_flag)
6894 FD_CLR (p->infd, &input_wait_mask);
6895 FD_CLR (p->infd, &non_keyboard_wait_mask);
6901 lib_child_handler (sig);
6902 #ifdef NS_IMPL_GNUSTEP
6903 /* NSTask in GNUstep sets its child handler each time it is called.
6904 So we must re-set ours. */
6905 catch_child_signal ();
6906 #endif
6909 static void
6910 deliver_child_signal (int sig)
6912 deliver_process_signal (sig, handle_child_signal);
6916 static Lisp_Object
6917 exec_sentinel_error_handler (Lisp_Object error_val)
6919 cmd_error_internal (error_val, "error in process sentinel: ");
6920 Vinhibit_quit = Qt;
6921 update_echo_area ();
6922 Fsleep_for (make_number (2), Qnil);
6923 return Qt;
6926 static void
6927 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6929 Lisp_Object sentinel, odeactivate;
6930 struct Lisp_Process *p = XPROCESS (proc);
6931 ptrdiff_t count = SPECPDL_INDEX ();
6932 bool outer_running_asynch_code = running_asynch_code;
6933 int waiting = waiting_for_user_input_p;
6935 if (inhibit_sentinels)
6936 return;
6938 odeactivate = Vdeactivate_mark;
6939 #if 0
6940 Lisp_Object obuffer, okeymap;
6941 XSETBUFFER (obuffer, current_buffer);
6942 okeymap = BVAR (current_buffer, keymap);
6943 #endif
6945 /* There's no good reason to let sentinels change the current
6946 buffer, and many callers of accept-process-output, sit-for, and
6947 friends don't expect current-buffer to be changed from under them. */
6948 record_unwind_current_buffer ();
6950 sentinel = p->sentinel;
6952 /* Inhibit quit so that random quits don't screw up a running filter. */
6953 specbind (Qinhibit_quit, Qt);
6954 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6956 /* In case we get recursively called,
6957 and we already saved the match data nonrecursively,
6958 save the same match data in safely recursive fashion. */
6959 if (outer_running_asynch_code)
6961 Lisp_Object tem;
6962 tem = Fmatch_data (Qnil, Qnil, Qnil);
6963 restore_search_regs ();
6964 record_unwind_save_match_data ();
6965 Fset_match_data (tem, Qt);
6968 /* For speed, if a search happens within this code,
6969 save the match data in a special nonrecursive fashion. */
6970 running_asynch_code = 1;
6972 internal_condition_case_1 (read_process_output_call,
6973 list3 (sentinel, proc, reason),
6974 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6975 exec_sentinel_error_handler);
6977 /* If we saved the match data nonrecursively, restore it now. */
6978 restore_search_regs ();
6979 running_asynch_code = outer_running_asynch_code;
6981 Vdeactivate_mark = odeactivate;
6983 /* Restore waiting_for_user_input_p as it was
6984 when we were called, in case the filter clobbered it. */
6985 waiting_for_user_input_p = waiting;
6987 #if 0
6988 if (! EQ (Fcurrent_buffer (), obuffer)
6989 || ! EQ (current_buffer->keymap, okeymap))
6990 #endif
6991 /* But do it only if the caller is actually going to read events.
6992 Otherwise there's no need to make him wake up, and it could
6993 cause trouble (for example it would make sit_for return). */
6994 if (waiting_for_user_input_p == -1)
6995 record_asynch_buffer_change ();
6997 unbind_to (count, Qnil);
7000 /* Report all recent events of a change in process status
7001 (either run the sentinel or output a message).
7002 This is usually done while Emacs is waiting for keyboard input
7003 but can be done at other times.
7005 Return positive if any input was received from WAIT_PROC (or from
7006 any process if WAIT_PROC is null), zero if input was attempted but
7007 none received, and negative if we didn't even try. */
7009 static int
7010 status_notify (struct Lisp_Process *deleting_process,
7011 struct Lisp_Process *wait_proc)
7013 Lisp_Object proc;
7014 Lisp_Object tail, msg;
7015 int got_some_output = -1;
7017 tail = Qnil;
7018 msg = Qnil;
7020 /* Set this now, so that if new processes are created by sentinels
7021 that we run, we get called again to handle their status changes. */
7022 update_tick = process_tick;
7024 FOR_EACH_PROCESS (tail, proc)
7026 Lisp_Object symbol;
7027 register struct Lisp_Process *p = XPROCESS (proc);
7029 if (p->tick != p->update_tick)
7031 p->update_tick = p->tick;
7033 /* If process is still active, read any output that remains. */
7034 while (! EQ (p->filter, Qt)
7035 && ! connecting_status (p->status)
7036 && ! EQ (p->status, Qlisten)
7037 /* Network or serial process not stopped: */
7038 && ! EQ (p->command, Qt)
7039 && p->infd >= 0
7040 && p != deleting_process)
7042 int nread = read_process_output (proc, p->infd);
7043 if ((!wait_proc || wait_proc == XPROCESS (proc))
7044 && got_some_output < nread)
7045 got_some_output = nread;
7046 if (nread <= 0)
7047 break;
7050 /* Get the text to use for the message. */
7051 if (p->raw_status_new)
7052 update_status (p);
7053 msg = status_message (p);
7055 /* If process is terminated, deactivate it or delete it. */
7056 symbol = p->status;
7057 if (CONSP (p->status))
7058 symbol = XCAR (p->status);
7060 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
7061 || EQ (symbol, Qclosed))
7063 if (delete_exited_processes)
7064 remove_process (proc);
7065 else
7066 deactivate_process (proc);
7069 /* The actions above may have further incremented p->tick.
7070 So set p->update_tick again so that an error in the sentinel will
7071 not cause this code to be run again. */
7072 p->update_tick = p->tick;
7073 /* Now output the message suitably. */
7074 exec_sentinel (proc, msg);
7075 if (BUFFERP (p->buffer))
7076 /* In case it uses %s in mode-line-format. */
7077 bset_update_mode_line (XBUFFER (p->buffer));
7079 } /* end for */
7081 return got_some_output;
7084 DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel,
7085 Sinternal_default_process_sentinel, 2, 2, 0,
7086 doc: /* Function used as default sentinel for processes.
7087 This inserts a status message into the process's buffer, if there is one. */)
7088 (Lisp_Object proc, Lisp_Object msg)
7090 Lisp_Object buffer, symbol;
7091 struct Lisp_Process *p;
7092 CHECK_PROCESS (proc);
7093 p = XPROCESS (proc);
7094 buffer = p->buffer;
7095 symbol = p->status;
7096 if (CONSP (symbol))
7097 symbol = XCAR (symbol);
7099 if (!EQ (symbol, Qrun) && !NILP (buffer))
7101 Lisp_Object tem;
7102 struct buffer *old = current_buffer;
7103 ptrdiff_t opoint, opoint_byte;
7104 ptrdiff_t before, before_byte;
7106 /* Avoid error if buffer is deleted
7107 (probably that's why the process is dead, too). */
7108 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
7109 return Qnil;
7110 Fset_buffer (buffer);
7112 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
7113 msg = (code_convert_string_norecord
7114 (msg, Vlocale_coding_system, 1));
7116 opoint = PT;
7117 opoint_byte = PT_BYTE;
7118 /* Insert new output into buffer
7119 at the current end-of-output marker,
7120 thus preserving logical ordering of input and output. */
7121 if (XMARKER (p->mark)->buffer)
7122 Fgoto_char (p->mark);
7123 else
7124 SET_PT_BOTH (ZV, ZV_BYTE);
7126 before = PT;
7127 before_byte = PT_BYTE;
7129 tem = BVAR (current_buffer, read_only);
7130 bset_read_only (current_buffer, Qnil);
7131 insert_string ("\nProcess ");
7132 { /* FIXME: temporary kludge. */
7133 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
7134 insert_string (" ");
7135 Finsert (1, &msg);
7136 bset_read_only (current_buffer, tem);
7137 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
7139 if (opoint >= before)
7140 SET_PT_BOTH (opoint + (PT - before),
7141 opoint_byte + (PT_BYTE - before_byte));
7142 else
7143 SET_PT_BOTH (opoint, opoint_byte);
7145 set_buffer_internal (old);
7147 return Qnil;
7151 DEFUN ("set-process-coding-system", Fset_process_coding_system,
7152 Sset_process_coding_system, 1, 3, 0,
7153 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
7154 DECODING will be used to decode subprocess output and ENCODING to
7155 encode subprocess input. */)
7156 (Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
7158 CHECK_PROCESS (process);
7160 struct Lisp_Process *p = XPROCESS (process);
7162 Fcheck_coding_system (decoding);
7163 Fcheck_coding_system (encoding);
7164 encoding = coding_inherit_eol_type (encoding, Qnil);
7165 pset_decode_coding_system (p, decoding);
7166 pset_encode_coding_system (p, encoding);
7168 /* If the sockets haven't been set up yet, the final setup part of
7169 this will be called asynchronously. */
7170 if (p->infd < 0 || p->outfd < 0)
7171 return Qnil;
7173 setup_process_coding_systems (process);
7175 return Qnil;
7178 DEFUN ("process-coding-system",
7179 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
7180 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
7181 (register Lisp_Object process)
7183 CHECK_PROCESS (process);
7184 return Fcons (XPROCESS (process)->decode_coding_system,
7185 XPROCESS (process)->encode_coding_system);
7188 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
7189 Sset_process_filter_multibyte, 2, 2, 0,
7190 doc: /* Set multibyteness of the strings given to PROCESS's filter.
7191 If FLAG is non-nil, the filter is given multibyte strings.
7192 If FLAG is nil, the filter is given unibyte strings. In this case,
7193 all character code conversion except for end-of-line conversion is
7194 suppressed. */)
7195 (Lisp_Object process, Lisp_Object flag)
7197 CHECK_PROCESS (process);
7199 struct Lisp_Process *p = XPROCESS (process);
7200 if (NILP (flag))
7201 pset_decode_coding_system
7202 (p, raw_text_coding_system (p->decode_coding_system));
7204 /* If the sockets haven't been set up yet, the final setup part of
7205 this will be called asynchronously. */
7206 if (p->infd < 0 || p->outfd < 0)
7207 return Qnil;
7209 setup_process_coding_systems (process);
7211 return Qnil;
7214 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
7215 Sprocess_filter_multibyte_p, 1, 1, 0,
7216 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
7217 (Lisp_Object process)
7219 CHECK_PROCESS (process);
7220 struct Lisp_Process *p = XPROCESS (process);
7221 if (p->infd < 0)
7222 return Qnil;
7223 struct coding_system *coding = proc_decode_coding_system[p->infd];
7224 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
7230 # ifdef HAVE_GPM
7232 void
7233 add_gpm_wait_descriptor (int desc)
7235 add_keyboard_wait_descriptor (desc);
7238 void
7239 delete_gpm_wait_descriptor (int desc)
7241 delete_keyboard_wait_descriptor (desc);
7244 # endif
7246 # ifdef USABLE_SIGIO
7248 /* Return true if *MASK has a bit set
7249 that corresponds to one of the keyboard input descriptors. */
7251 static bool
7252 keyboard_bit_set (fd_set *mask)
7254 int fd;
7256 for (fd = 0; fd <= max_input_desc; fd++)
7257 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
7258 && !FD_ISSET (fd, &non_keyboard_wait_mask))
7259 return 1;
7261 return 0;
7263 # endif
7265 #else /* not subprocesses */
7267 /* Defined in msdos.c. */
7268 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
7269 struct timespec *, void *);
7271 /* Implementation of wait_reading_process_output, assuming that there
7272 are no subprocesses. Used only by the MS-DOS build.
7274 Wait for timeout to elapse and/or keyboard input to be available.
7276 TIME_LIMIT is:
7277 timeout in seconds
7278 If negative, gobble data immediately available but don't wait for any.
7280 NSECS is:
7281 an additional duration to wait, measured in nanoseconds
7282 If TIME_LIMIT is zero, then:
7283 If NSECS == 0, there is no limit.
7284 If NSECS > 0, the timeout consists of NSECS only.
7285 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
7287 READ_KBD is:
7288 0 to ignore keyboard input, or
7289 1 to return when input is available, or
7290 -1 means caller will actually read the input, so don't throw to
7291 the quit handler.
7293 see full version for other parameters. We know that wait_proc will
7294 always be NULL, since `subprocesses' isn't defined.
7296 DO_DISPLAY means redisplay should be done to show subprocess
7297 output that arrives.
7299 Return -1 signifying we got no output and did not try. */
7302 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
7303 bool do_display,
7304 Lisp_Object wait_for_cell,
7305 struct Lisp_Process *wait_proc, int just_wait_proc)
7307 register int nfds;
7308 struct timespec end_time, timeout;
7309 enum { MINIMUM = -1, TIMEOUT, INFINITY } wait;
7311 if (TYPE_MAXIMUM (time_t) < time_limit)
7312 time_limit = TYPE_MAXIMUM (time_t);
7314 if (time_limit < 0 || nsecs < 0)
7315 wait = MINIMUM;
7316 else if (time_limit > 0 || nsecs > 0)
7318 wait = TIMEOUT;
7319 end_time = timespec_add (current_timespec (),
7320 make_timespec (time_limit, nsecs));
7322 else
7323 wait = INFINITY;
7325 /* Turn off periodic alarms (in case they are in use)
7326 and then turn off any other atimers,
7327 because the select emulator uses alarms. */
7328 stop_polling ();
7329 turn_on_atimers (0);
7331 while (1)
7333 bool timeout_reduced_for_timers = false;
7334 fd_set waitchannels;
7335 int xerrno;
7337 /* If calling from keyboard input, do not quit
7338 since we want to return C-g as an input character.
7339 Otherwise, do pending quit if requested. */
7340 if (read_kbd >= 0)
7341 QUIT;
7343 /* Exit now if the cell we're waiting for became non-nil. */
7344 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7345 break;
7347 /* Compute time from now till when time limit is up. */
7348 /* Exit if already run out. */
7349 if (wait == TIMEOUT)
7351 struct timespec now = current_timespec ();
7352 if (timespec_cmp (end_time, now) <= 0)
7353 break;
7354 timeout = timespec_sub (end_time, now);
7356 else
7357 timeout = make_timespec (wait < TIMEOUT ? 0 : 100000, 0);
7359 /* If our caller will not immediately handle keyboard events,
7360 run timer events directly.
7361 (Callers that will immediately read keyboard events
7362 call timer_delay on their own.) */
7363 if (NILP (wait_for_cell))
7365 struct timespec timer_delay;
7369 unsigned old_timers_run = timers_run;
7370 timer_delay = timer_check ();
7371 if (timers_run != old_timers_run && do_display)
7372 /* We must retry, since a timer may have requeued itself
7373 and that could alter the time delay. */
7374 redisplay_preserve_echo_area (14);
7375 else
7376 break;
7378 while (!detect_input_pending ());
7380 /* If there is unread keyboard input, also return. */
7381 if (read_kbd != 0
7382 && requeued_events_pending_p ())
7383 break;
7385 if (timespec_valid_p (timer_delay))
7387 if (timespec_cmp (timer_delay, timeout) < 0)
7389 timeout = timer_delay;
7390 timeout_reduced_for_timers = true;
7395 /* Cause C-g and alarm signals to take immediate action,
7396 and cause input available signals to zero out timeout. */
7397 if (read_kbd < 0)
7398 set_waiting_for_input (&timeout);
7400 /* If a frame has been newly mapped and needs updating,
7401 reprocess its display stuff. */
7402 if (frame_garbaged && do_display)
7404 clear_waiting_for_input ();
7405 redisplay_preserve_echo_area (15);
7406 if (read_kbd < 0)
7407 set_waiting_for_input (&timeout);
7410 /* Wait till there is something to do. */
7411 FD_ZERO (&waitchannels);
7412 if (read_kbd && detect_input_pending ())
7413 nfds = 0;
7414 else
7416 if (read_kbd || !NILP (wait_for_cell))
7417 FD_SET (0, &waitchannels);
7418 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
7421 xerrno = errno;
7423 /* Make C-g and alarm signals set flags again. */
7424 clear_waiting_for_input ();
7426 /* If we woke up due to SIGWINCH, actually change size now. */
7427 do_pending_window_change (0);
7429 if (wait < INFINITY && nfds == 0 && ! timeout_reduced_for_timers)
7430 /* We waited the full specified time, so return now. */
7431 break;
7433 if (nfds == -1)
7435 /* If the system call was interrupted, then go around the
7436 loop again. */
7437 if (xerrno == EINTR)
7438 FD_ZERO (&waitchannels);
7439 else
7440 report_file_errno ("Failed select", Qnil, xerrno);
7443 /* Check for keyboard input. */
7445 if (read_kbd
7446 && detect_input_pending_run_timers (do_display))
7448 swallow_events (do_display);
7449 if (detect_input_pending_run_timers (do_display))
7450 break;
7453 /* If there is unread keyboard input, also return. */
7454 if (read_kbd
7455 && requeued_events_pending_p ())
7456 break;
7458 /* If wait_for_cell. check for keyboard input
7459 but don't run any timers.
7460 ??? (It seems wrong to me to check for keyboard
7461 input at all when wait_for_cell, but the code
7462 has been this way since July 1994.
7463 Try changing this after version 19.31.) */
7464 if (! NILP (wait_for_cell)
7465 && detect_input_pending ())
7467 swallow_events (do_display);
7468 if (detect_input_pending ())
7469 break;
7472 /* Exit now if the cell we're waiting for became non-nil. */
7473 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7474 break;
7477 start_polling ();
7479 return -1;
7482 #endif /* not subprocesses */
7484 /* The following functions are needed even if async subprocesses are
7485 not supported. Some of them are no-op stubs in that case. */
7487 #ifdef HAVE_TIMERFD
7489 /* Add FD, which is a descriptor returned by timerfd_create,
7490 to the set of non-keyboard input descriptors. */
7492 void
7493 add_timer_wait_descriptor (int fd)
7495 FD_SET (fd, &input_wait_mask);
7496 FD_SET (fd, &non_keyboard_wait_mask);
7497 FD_SET (fd, &non_process_wait_mask);
7498 fd_callback_info[fd].func = timerfd_callback;
7499 fd_callback_info[fd].data = NULL;
7500 fd_callback_info[fd].condition |= FOR_READ;
7501 if (fd > max_input_desc)
7502 max_input_desc = fd;
7505 #endif /* HAVE_TIMERFD */
7507 /* If program file NAME starts with /: for quoting a magic
7508 name, remove that, preserving the multibyteness of NAME. */
7510 Lisp_Object
7511 remove_slash_colon (Lisp_Object name)
7513 return
7514 ((SBYTES (name) > 2 && SREF (name, 0) == '/' && SREF (name, 1) == ':')
7515 ? make_specified_string (SSDATA (name) + 2, SCHARS (name) - 2,
7516 SBYTES (name) - 2, STRING_MULTIBYTE (name))
7517 : name);
7520 /* Add DESC to the set of keyboard input descriptors. */
7522 void
7523 add_keyboard_wait_descriptor (int desc)
7525 #ifdef subprocesses /* Actually means "not MSDOS". */
7526 FD_SET (desc, &input_wait_mask);
7527 FD_SET (desc, &non_process_wait_mask);
7528 if (desc > max_input_desc)
7529 max_input_desc = desc;
7530 #endif
7533 /* From now on, do not expect DESC to give keyboard input. */
7535 void
7536 delete_keyboard_wait_descriptor (int desc)
7538 #ifdef subprocesses
7539 FD_CLR (desc, &input_wait_mask);
7540 FD_CLR (desc, &non_process_wait_mask);
7541 delete_input_desc (desc);
7542 #endif
7545 /* Setup coding systems of PROCESS. */
7547 void
7548 setup_process_coding_systems (Lisp_Object process)
7550 #ifdef subprocesses
7551 struct Lisp_Process *p = XPROCESS (process);
7552 int inch = p->infd;
7553 int outch = p->outfd;
7554 Lisp_Object coding_system;
7556 if (inch < 0 || outch < 0)
7557 return;
7559 if (!proc_decode_coding_system[inch])
7560 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
7561 coding_system = p->decode_coding_system;
7562 if (EQ (p->filter, Qinternal_default_process_filter)
7563 && BUFFERP (p->buffer))
7565 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
7566 coding_system = raw_text_coding_system (coding_system);
7568 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
7570 if (!proc_encode_coding_system[outch])
7571 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
7572 setup_coding_system (p->encode_coding_system,
7573 proc_encode_coding_system[outch]);
7574 #endif
7577 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
7578 doc: /* Return the (or a) live process associated with BUFFER.
7579 BUFFER may be a buffer or the name of one.
7580 Return nil if all processes associated with BUFFER have been
7581 deleted or killed. */)
7582 (register Lisp_Object buffer)
7584 #ifdef subprocesses
7585 register Lisp_Object buf, tail, proc;
7587 if (NILP (buffer)) return Qnil;
7588 buf = Fget_buffer (buffer);
7589 if (NILP (buf)) return Qnil;
7591 FOR_EACH_PROCESS (tail, proc)
7592 if (EQ (XPROCESS (proc)->buffer, buf))
7593 return proc;
7594 #endif /* subprocesses */
7595 return Qnil;
7598 DEFUN ("process-inherit-coding-system-flag",
7599 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
7600 1, 1, 0,
7601 doc: /* Return the value of inherit-coding-system flag for PROCESS.
7602 If this flag is t, `buffer-file-coding-system' of the buffer
7603 associated with PROCESS will inherit the coding system used to decode
7604 the process output. */)
7605 (register Lisp_Object process)
7607 #ifdef subprocesses
7608 CHECK_PROCESS (process);
7609 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
7610 #else
7611 /* Ignore the argument and return the value of
7612 inherit-process-coding-system. */
7613 return inherit_process_coding_system ? Qt : Qnil;
7614 #endif
7617 /* Kill all processes associated with `buffer'.
7618 If `buffer' is nil, kill all processes. */
7620 void
7621 kill_buffer_processes (Lisp_Object buffer)
7623 #ifdef subprocesses
7624 Lisp_Object tail, proc;
7626 FOR_EACH_PROCESS (tail, proc)
7627 if (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer))
7629 if (NETCONN_P (proc) || SERIALCONN_P (proc) || PIPECONN_P (proc))
7630 Fdelete_process (proc);
7631 else if (XPROCESS (proc)->infd >= 0)
7632 process_send_signal (proc, SIGHUP, Qnil, 1);
7634 #else /* subprocesses */
7635 /* Since we have no subprocesses, this does nothing. */
7636 #endif /* subprocesses */
7639 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
7640 Swaiting_for_user_input_p, 0, 0, 0,
7641 doc: /* Return non-nil if Emacs is waiting for input from the user.
7642 This is intended for use by asynchronous process output filters and sentinels. */)
7643 (void)
7645 #ifdef subprocesses
7646 return (waiting_for_user_input_p ? Qt : Qnil);
7647 #else
7648 return Qnil;
7649 #endif
7652 /* Stop reading input from keyboard sources. */
7654 void
7655 hold_keyboard_input (void)
7657 kbd_is_on_hold = 1;
7660 /* Resume reading input from keyboard sources. */
7662 void
7663 unhold_keyboard_input (void)
7665 kbd_is_on_hold = 0;
7668 /* Return true if keyboard input is on hold, zero otherwise. */
7670 bool
7671 kbd_on_hold_p (void)
7673 return kbd_is_on_hold;
7677 /* Enumeration of and access to system processes a-la ps(1). */
7679 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
7680 0, 0, 0,
7681 doc: /* Return a list of numerical process IDs of all running processes.
7682 If this functionality is unsupported, return nil.
7684 See `process-attributes' for getting attributes of a process given its ID. */)
7685 (void)
7687 return list_system_processes ();
7690 DEFUN ("process-attributes", Fprocess_attributes,
7691 Sprocess_attributes, 1, 1, 0,
7692 doc: /* Return attributes of the process given by its PID, a number.
7694 Value is an alist where each element is a cons cell of the form
7696 (KEY . VALUE)
7698 If this functionality is unsupported, the value is nil.
7700 See `list-system-processes' for getting a list of all process IDs.
7702 The KEYs of the attributes that this function may return are listed
7703 below, together with the type of the associated VALUE (in parentheses).
7704 Not all platforms support all of these attributes; unsupported
7705 attributes will not appear in the returned alist.
7706 Unless explicitly indicated otherwise, numbers can have either
7707 integer or floating point values.
7709 euid -- Effective user User ID of the process (number)
7710 user -- User name corresponding to euid (string)
7711 egid -- Effective user Group ID of the process (number)
7712 group -- Group name corresponding to egid (string)
7713 comm -- Command name (executable name only) (string)
7714 state -- Process state code, such as "S", "R", or "T" (string)
7715 ppid -- Parent process ID (number)
7716 pgrp -- Process group ID (number)
7717 sess -- Session ID, i.e. process ID of session leader (number)
7718 ttname -- Controlling tty name (string)
7719 tpgid -- ID of foreground process group on the process's tty (number)
7720 minflt -- number of minor page faults (number)
7721 majflt -- number of major page faults (number)
7722 cminflt -- cumulative number of minor page faults (number)
7723 cmajflt -- cumulative number of major page faults (number)
7724 utime -- user time used by the process, in (current-time) format,
7725 which is a list of integers (HIGH LOW USEC PSEC)
7726 stime -- system time used by the process (current-time)
7727 time -- sum of utime and stime (current-time)
7728 cutime -- user time used by the process and its children (current-time)
7729 cstime -- system time used by the process and its children (current-time)
7730 ctime -- sum of cutime and cstime (current-time)
7731 pri -- priority of the process (number)
7732 nice -- nice value of the process (number)
7733 thcount -- process thread count (number)
7734 start -- time the process started (current-time)
7735 vsize -- virtual memory size of the process in KB's (number)
7736 rss -- resident set size of the process in KB's (number)
7737 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7738 pcpu -- percents of CPU time used by the process (floating-point number)
7739 pmem -- percents of total physical memory used by process's resident set
7740 (floating-point number)
7741 args -- command line which invoked the process (string). */)
7742 ( Lisp_Object pid)
7744 return system_process_attributes (pid);
7747 #ifdef subprocesses
7748 /* Arrange to catch SIGCHLD if this hasn't already been arranged.
7749 Invoke this after init_process_emacs, and after glib and/or GNUstep
7750 futz with the SIGCHLD handler, but before Emacs forks any children.
7751 This function's caller should block SIGCHLD. */
7753 void
7754 catch_child_signal (void)
7756 struct sigaction action, old_action;
7757 sigset_t oldset;
7758 emacs_sigaction_init (&action, deliver_child_signal);
7759 block_child_signal (&oldset);
7760 sigaction (SIGCHLD, &action, &old_action);
7761 eassert (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7762 || ! (old_action.sa_flags & SA_SIGINFO));
7764 if (old_action.sa_handler != deliver_child_signal)
7765 lib_child_handler
7766 = (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7767 ? dummy_handler
7768 : old_action.sa_handler);
7769 unblock_child_signal (&oldset);
7771 #endif /* subprocesses */
7774 /* This is not called "init_process" because that is the name of a
7775 Mach system call, so it would cause problems on Darwin systems. */
7776 void
7777 init_process_emacs (int sockfd)
7779 #ifdef subprocesses
7780 int i;
7782 inhibit_sentinels = 0;
7784 #ifndef CANNOT_DUMP
7785 if (! noninteractive || initialized)
7786 #endif
7788 #if defined HAVE_GLIB && !defined WINDOWSNT
7789 /* Tickle glib's child-handling code. Ask glib to wait for Emacs itself;
7790 this should always fail, but is enough to initialize glib's
7791 private SIGCHLD handler, allowing catch_child_signal to copy
7792 it into lib_child_handler. */
7793 g_source_unref (g_child_watch_source_new (getpid ()));
7794 #endif
7795 catch_child_signal ();
7798 FD_ZERO (&input_wait_mask);
7799 FD_ZERO (&non_keyboard_wait_mask);
7800 FD_ZERO (&non_process_wait_mask);
7801 FD_ZERO (&write_mask);
7802 max_process_desc = max_input_desc = -1;
7803 external_sock_fd = sockfd;
7804 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7806 FD_ZERO (&connect_wait_mask);
7807 num_pending_connects = 0;
7809 process_output_delay_count = 0;
7810 process_output_skip = 0;
7812 /* Don't do this, it caused infinite select loops. The display
7813 method should call add_keyboard_wait_descriptor on stdin if it
7814 needs that. */
7815 #if 0
7816 FD_SET (0, &input_wait_mask);
7817 #endif
7819 Vprocess_alist = Qnil;
7820 deleted_pid_list = Qnil;
7821 for (i = 0; i < FD_SETSIZE; i++)
7823 chan_process[i] = Qnil;
7824 proc_buffered_char[i] = -1;
7826 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7827 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7828 #ifdef DATAGRAM_SOCKETS
7829 memset (datagram_address, 0, sizeof datagram_address);
7830 #endif
7832 #if defined (DARWIN_OS)
7833 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7834 processes. As such, we only change the default value. */
7835 if (initialized)
7837 char const *release = (STRINGP (Voperating_system_release)
7838 ? SSDATA (Voperating_system_release)
7839 : 0);
7840 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7841 Vprocess_connection_type = Qnil;
7844 #endif
7845 #endif /* subprocesses */
7846 kbd_is_on_hold = 0;
7849 void
7850 syms_of_process (void)
7852 #ifdef subprocesses
7854 DEFSYM (Qprocessp, "processp");
7855 DEFSYM (Qrun, "run");
7856 DEFSYM (Qstop, "stop");
7857 DEFSYM (Qsignal, "signal");
7859 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7860 here again. */
7862 DEFSYM (Qopen, "open");
7863 DEFSYM (Qclosed, "closed");
7864 DEFSYM (Qconnect, "connect");
7865 DEFSYM (Qfailed, "failed");
7866 DEFSYM (Qlisten, "listen");
7867 DEFSYM (Qlocal, "local");
7868 DEFSYM (Qipv4, "ipv4");
7869 #ifdef AF_INET6
7870 DEFSYM (Qipv6, "ipv6");
7871 #endif
7872 DEFSYM (Qdatagram, "datagram");
7873 DEFSYM (Qseqpacket, "seqpacket");
7875 DEFSYM (QCport, ":port");
7876 DEFSYM (QCspeed, ":speed");
7877 DEFSYM (QCprocess, ":process");
7879 DEFSYM (QCbytesize, ":bytesize");
7880 DEFSYM (QCstopbits, ":stopbits");
7881 DEFSYM (QCparity, ":parity");
7882 DEFSYM (Qodd, "odd");
7883 DEFSYM (Qeven, "even");
7884 DEFSYM (QCflowcontrol, ":flowcontrol");
7885 DEFSYM (Qhw, "hw");
7886 DEFSYM (Qsw, "sw");
7887 DEFSYM (QCsummary, ":summary");
7889 DEFSYM (Qreal, "real");
7890 DEFSYM (Qnetwork, "network");
7891 DEFSYM (Qserial, "serial");
7892 DEFSYM (Qpipe, "pipe");
7893 DEFSYM (QCbuffer, ":buffer");
7894 DEFSYM (QChost, ":host");
7895 DEFSYM (QCservice, ":service");
7896 DEFSYM (QClocal, ":local");
7897 DEFSYM (QCremote, ":remote");
7898 DEFSYM (QCcoding, ":coding");
7899 DEFSYM (QCserver, ":server");
7900 DEFSYM (QCnowait, ":nowait");
7901 DEFSYM (QCsentinel, ":sentinel");
7902 DEFSYM (QCuse_external_socket, ":use-external-socket");
7903 DEFSYM (QCtls_parameters, ":tls-parameters");
7904 DEFSYM (Qnsm_verify_connection, "nsm-verify-connection");
7905 DEFSYM (QClog, ":log");
7906 DEFSYM (QCnoquery, ":noquery");
7907 DEFSYM (QCstop, ":stop");
7908 DEFSYM (QCplist, ":plist");
7909 DEFSYM (QCcommand, ":command");
7910 DEFSYM (QCconnection_type, ":connection-type");
7911 DEFSYM (QCstderr, ":stderr");
7912 DEFSYM (Qpty, "pty");
7913 DEFSYM (Qpipe, "pipe");
7915 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7917 staticpro (&Vprocess_alist);
7918 staticpro (&deleted_pid_list);
7920 #endif /* subprocesses */
7922 DEFSYM (QCname, ":name");
7923 DEFSYM (QCtype, ":type");
7925 DEFSYM (Qeuid, "euid");
7926 DEFSYM (Qegid, "egid");
7927 DEFSYM (Quser, "user");
7928 DEFSYM (Qgroup, "group");
7929 DEFSYM (Qcomm, "comm");
7930 DEFSYM (Qstate, "state");
7931 DEFSYM (Qppid, "ppid");
7932 DEFSYM (Qpgrp, "pgrp");
7933 DEFSYM (Qsess, "sess");
7934 DEFSYM (Qttname, "ttname");
7935 DEFSYM (Qtpgid, "tpgid");
7936 DEFSYM (Qminflt, "minflt");
7937 DEFSYM (Qmajflt, "majflt");
7938 DEFSYM (Qcminflt, "cminflt");
7939 DEFSYM (Qcmajflt, "cmajflt");
7940 DEFSYM (Qutime, "utime");
7941 DEFSYM (Qstime, "stime");
7942 DEFSYM (Qtime, "time");
7943 DEFSYM (Qcutime, "cutime");
7944 DEFSYM (Qcstime, "cstime");
7945 DEFSYM (Qctime, "ctime");
7946 #ifdef subprocesses
7947 DEFSYM (Qinternal_default_process_sentinel,
7948 "internal-default-process-sentinel");
7949 DEFSYM (Qinternal_default_process_filter,
7950 "internal-default-process-filter");
7951 #endif
7952 DEFSYM (Qpri, "pri");
7953 DEFSYM (Qnice, "nice");
7954 DEFSYM (Qthcount, "thcount");
7955 DEFSYM (Qstart, "start");
7956 DEFSYM (Qvsize, "vsize");
7957 DEFSYM (Qrss, "rss");
7958 DEFSYM (Qetime, "etime");
7959 DEFSYM (Qpcpu, "pcpu");
7960 DEFSYM (Qpmem, "pmem");
7961 DEFSYM (Qargs, "args");
7963 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7964 doc: /* Non-nil means delete processes immediately when they exit.
7965 A value of nil means don't delete them until `list-processes' is run. */);
7967 delete_exited_processes = 1;
7969 #ifdef subprocesses
7970 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7971 doc: /* Control type of device used to communicate with subprocesses.
7972 Values are nil to use a pipe, or t or `pty' to use a pty.
7973 The value has no effect if the system has no ptys or if all ptys are busy:
7974 then a pipe is used in any case.
7975 The value takes effect when `start-process' is called. */);
7976 Vprocess_connection_type = Qt;
7978 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7979 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7980 On some systems, when Emacs reads the output from a subprocess, the output data
7981 is read in very small blocks, potentially resulting in very poor performance.
7982 This behavior can be remedied to some extent by setting this variable to a
7983 non-nil value, as it will automatically delay reading from such processes, to
7984 allow them to produce more output before Emacs tries to read it.
7985 If the value is t, the delay is reset after each write to the process; any other
7986 non-nil value means that the delay is not reset on write.
7987 The variable takes effect when `start-process' is called. */);
7988 Vprocess_adaptive_read_buffering = Qt;
7990 defsubr (&Sprocessp);
7991 defsubr (&Sget_process);
7992 defsubr (&Sdelete_process);
7993 defsubr (&Sprocess_status);
7994 defsubr (&Sprocess_exit_status);
7995 defsubr (&Sprocess_id);
7996 defsubr (&Sprocess_name);
7997 defsubr (&Sprocess_tty_name);
7998 defsubr (&Sprocess_command);
7999 defsubr (&Sset_process_buffer);
8000 defsubr (&Sprocess_buffer);
8001 defsubr (&Sprocess_mark);
8002 defsubr (&Sset_process_filter);
8003 defsubr (&Sprocess_filter);
8004 defsubr (&Sset_process_sentinel);
8005 defsubr (&Sprocess_sentinel);
8006 defsubr (&Sset_process_window_size);
8007 defsubr (&Sset_process_inherit_coding_system_flag);
8008 defsubr (&Sset_process_query_on_exit_flag);
8009 defsubr (&Sprocess_query_on_exit_flag);
8010 defsubr (&Sprocess_contact);
8011 defsubr (&Sprocess_plist);
8012 defsubr (&Sset_process_plist);
8013 defsubr (&Sprocess_list);
8014 defsubr (&Smake_process);
8015 defsubr (&Smake_pipe_process);
8016 defsubr (&Sserial_process_configure);
8017 defsubr (&Smake_serial_process);
8018 defsubr (&Sset_network_process_option);
8019 defsubr (&Smake_network_process);
8020 defsubr (&Sformat_network_address);
8021 defsubr (&Snetwork_interface_list);
8022 defsubr (&Snetwork_interface_info);
8023 #ifdef DATAGRAM_SOCKETS
8024 defsubr (&Sprocess_datagram_address);
8025 defsubr (&Sset_process_datagram_address);
8026 #endif
8027 defsubr (&Saccept_process_output);
8028 defsubr (&Sprocess_send_region);
8029 defsubr (&Sprocess_send_string);
8030 defsubr (&Sinterrupt_process);
8031 defsubr (&Skill_process);
8032 defsubr (&Squit_process);
8033 defsubr (&Sstop_process);
8034 defsubr (&Scontinue_process);
8035 defsubr (&Sprocess_running_child_p);
8036 defsubr (&Sprocess_send_eof);
8037 defsubr (&Ssignal_process);
8038 defsubr (&Swaiting_for_user_input_p);
8039 defsubr (&Sprocess_type);
8040 defsubr (&Sinternal_default_process_sentinel);
8041 defsubr (&Sinternal_default_process_filter);
8042 defsubr (&Sset_process_coding_system);
8043 defsubr (&Sprocess_coding_system);
8044 defsubr (&Sset_process_filter_multibyte);
8045 defsubr (&Sprocess_filter_multibyte_p);
8048 Lisp_Object subfeatures = Qnil;
8049 const struct socket_options *sopt;
8051 #define ADD_SUBFEATURE(key, val) \
8052 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
8054 ADD_SUBFEATURE (QCnowait, Qt);
8055 #ifdef DATAGRAM_SOCKETS
8056 ADD_SUBFEATURE (QCtype, Qdatagram);
8057 #endif
8058 #ifdef HAVE_SEQPACKET
8059 ADD_SUBFEATURE (QCtype, Qseqpacket);
8060 #endif
8061 #ifdef HAVE_LOCAL_SOCKETS
8062 ADD_SUBFEATURE (QCfamily, Qlocal);
8063 #endif
8064 ADD_SUBFEATURE (QCfamily, Qipv4);
8065 #ifdef AF_INET6
8066 ADD_SUBFEATURE (QCfamily, Qipv6);
8067 #endif
8068 #ifdef HAVE_GETSOCKNAME
8069 ADD_SUBFEATURE (QCservice, Qt);
8070 #endif
8071 ADD_SUBFEATURE (QCserver, Qt);
8073 for (sopt = socket_options; sopt->name; sopt++)
8074 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
8076 Fprovide (intern_c_string ("make-network-process"), subfeatures);
8079 #endif /* subprocesses */
8081 defsubr (&Sget_buffer_process);
8082 defsubr (&Sprocess_inherit_coding_system_flag);
8083 defsubr (&Slist_system_processes);
8084 defsubr (&Sprocess_attributes);