Avoid kill-emacs-hook errors hanging batch mode
[emacs.git] / src / process.c
blobe6465e2347e26e80d0668f2a6876ac21e7deeaf1
1 /* Asynchronous subprocess control for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2018 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 <https://www.gnu.org/licenses/>. */
22 #include <config.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <errno.h>
27 #include <sys/types.h> /* Some typedefs are used in sys/file.h. */
28 #include <sys/file.h>
29 #include <sys/stat.h>
30 #include <unistd.h>
31 #include <fcntl.h>
33 #include "lisp.h"
35 /* Only MS-DOS does not define `subprocesses'. */
36 #ifdef subprocesses
38 #include <sys/socket.h>
39 #include <netdb.h>
40 #include <netinet/in.h>
41 #include <arpa/inet.h>
43 #endif /* subprocesses */
45 #ifdef HAVE_SETRLIMIT
46 # include <sys/resource.h>
48 /* If NOFILE_LIMIT.rlim_cur is greater than FD_SETSIZE, then
49 NOFILE_LIMIT is the initial limit on the number of open files,
50 which should be restored in child processes. */
51 static struct rlimit nofile_limit;
52 #endif
54 #ifdef subprocesses
56 /* Are local (unix) sockets supported? */
57 #if defined (HAVE_SYS_UN_H)
58 #if !defined (AF_LOCAL) && defined (AF_UNIX)
59 #define AF_LOCAL AF_UNIX
60 #endif
61 #ifdef AF_LOCAL
62 #define HAVE_LOCAL_SOCKETS
63 #include <sys/un.h>
64 #endif
65 #endif
67 #include <sys/ioctl.h>
68 #if defined (HAVE_NET_IF_H)
69 #include <net/if.h>
70 #endif /* HAVE_NET_IF_H */
72 #if defined (HAVE_IFADDRS_H)
73 /* Must be after net/if.h */
74 #include <ifaddrs.h>
76 /* We only use structs from this header when we use getifaddrs. */
77 #if defined (HAVE_NET_IF_DL_H)
78 #include <net/if_dl.h>
79 #endif
81 #endif
83 #ifdef NEED_BSDTTY
84 #include <bsdtty.h>
85 #endif
87 #ifdef USG5_4
88 # include <sys/stream.h>
89 # include <sys/stropts.h>
90 #endif
92 #ifdef HAVE_UTIL_H
93 #include <util.h>
94 #endif
96 #ifdef HAVE_PTY_H
97 #include <pty.h>
98 #endif
100 #include <c-ctype.h>
101 #include <flexmember.h>
102 #include <sig2str.h>
103 #include <verify.h>
105 #endif /* subprocesses */
107 #include "systime.h"
108 #include "systty.h"
110 #include "window.h"
111 #include "character.h"
112 #include "buffer.h"
113 #include "coding.h"
114 #include "process.h"
115 #include "frame.h"
116 #include "termopts.h"
117 #include "keyboard.h"
118 #include "blockinput.h"
119 #include "atimer.h"
120 #include "sysselect.h"
121 #include "syssignal.h"
122 #include "syswait.h"
123 #ifdef HAVE_GNUTLS
124 #include "gnutls.h"
125 #endif
127 #ifdef HAVE_WINDOW_SYSTEM
128 #include TERM_HEADER
129 #endif /* HAVE_WINDOW_SYSTEM */
131 #ifdef HAVE_GLIB
132 #include "xgselect.h"
133 #ifndef WINDOWSNT
134 #include <glib.h>
135 #endif
136 #endif
138 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
139 /* This is 0.1s in nanoseconds. */
140 #define ASYNC_RETRY_NSEC 100000000
141 #endif
143 #ifdef WINDOWSNT
144 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
145 const struct timespec *, const sigset_t *);
146 #endif
148 /* Work around GCC 4.3.0 bug with strict overflow checking; see
149 <https://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
150 This bug appears to be fixed in GCC 5.1, so don't work around it there. */
151 #if GNUC_PREREQ (4, 3, 0) && ! GNUC_PREREQ (5, 1, 0)
152 # pragma GCC diagnostic ignored "-Wstrict-overflow"
153 #endif
155 /* True if keyboard input is on hold, zero otherwise. */
157 static bool kbd_is_on_hold;
159 /* Nonzero means don't run process sentinels. This is used
160 when exiting. */
161 bool inhibit_sentinels;
163 #ifdef subprocesses
165 #ifndef SOCK_CLOEXEC
166 # define SOCK_CLOEXEC 0
167 #endif
168 #ifndef SOCK_NONBLOCK
169 # define SOCK_NONBLOCK 0
170 #endif
172 /* True if ERRNUM represents an error where the system call would
173 block if a blocking variant were used. */
174 static bool
175 would_block (int errnum)
177 #ifdef EWOULDBLOCK
178 if (EWOULDBLOCK != EAGAIN && errnum == EWOULDBLOCK)
179 return true;
180 #endif
181 return errnum == EAGAIN;
184 #ifndef HAVE_ACCEPT4
186 /* Emulate GNU/Linux accept4 and socket well enough for this module. */
188 static int
189 close_on_exec (int fd)
191 if (0 <= fd)
192 fcntl (fd, F_SETFD, FD_CLOEXEC);
193 return fd;
196 # undef accept4
197 # define accept4(sockfd, addr, addrlen, flags) \
198 process_accept4 (sockfd, addr, addrlen, flags)
199 static int
200 accept4 (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags)
202 return close_on_exec (accept (sockfd, addr, addrlen));
205 static int
206 process_socket (int domain, int type, int protocol)
208 return close_on_exec (socket (domain, type, protocol));
210 # undef socket
211 # define socket(domain, type, protocol) process_socket (domain, type, protocol)
212 #endif
214 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
215 #define NETCONN1_P(p) (EQ (p->type, Qnetwork))
216 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
217 #define SERIALCONN1_P(p) (EQ (p->type, Qserial))
218 #define PIPECONN_P(p) (EQ (XPROCESS (p)->type, Qpipe))
219 #define PIPECONN1_P(p) (EQ (p->type, Qpipe))
221 /* Number of events of change of status of a process. */
222 static EMACS_INT process_tick;
223 /* Number of events for which the user or sentinel has been notified. */
224 static EMACS_INT update_tick;
226 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
227 this system. We need to read full packets, so we need a
228 "non-destructive" select. So we require either native select,
229 or emulation of select using FIONREAD. */
231 #ifndef BROKEN_DATAGRAM_SOCKETS
232 # if defined HAVE_SELECT || defined USABLE_FIONREAD
233 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
234 # define DATAGRAM_SOCKETS
235 # endif
236 # endif
237 #endif
239 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
240 # define HAVE_SEQPACKET
241 #endif
243 #define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
244 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
245 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
247 /* Number of processes which have a non-zero read_output_delay,
248 and therefore might be delayed for adaptive read buffering. */
250 static int process_output_delay_count;
252 /* True if any process has non-nil read_output_skip. */
254 static bool process_output_skip;
256 static void start_process_unwind (Lisp_Object);
257 static void create_process (Lisp_Object, char **, Lisp_Object);
258 #ifdef USABLE_SIGIO
259 static bool keyboard_bit_set (fd_set *);
260 #endif
261 static void deactivate_process (Lisp_Object);
262 static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
263 static int read_process_output (Lisp_Object, int);
264 static void create_pty (Lisp_Object);
265 static void exec_sentinel (Lisp_Object, Lisp_Object);
267 /* Number of bits set in connect_wait_mask. */
268 static int num_pending_connects;
270 /* The largest descriptor currently in use; -1 if none. */
271 static int max_desc;
273 /* Set the external socket descriptor for Emacs to use when
274 `make-network-process' is called with a non-nil
275 `:use-external-socket' option. The value should be either -1, or
276 the file descriptor of a socket that is already bound. */
277 static int external_sock_fd;
279 /* Indexed by descriptor, gives the process (if any) for that descriptor. */
280 static Lisp_Object chan_process[FD_SETSIZE];
281 static void wait_for_socket_fds (Lisp_Object, char const *);
283 /* Alist of elements (NAME . PROCESS). */
284 static Lisp_Object Vprocess_alist;
286 /* Buffered-ahead input char from process, indexed by channel.
287 -1 means empty (no char is buffered).
288 Used on sys V where the only way to tell if there is any
289 output from the process is to read at least one char.
290 Always -1 on systems that support FIONREAD. */
292 static int proc_buffered_char[FD_SETSIZE];
294 /* Table of `struct coding-system' for each process. */
295 static struct coding_system *proc_decode_coding_system[FD_SETSIZE];
296 static struct coding_system *proc_encode_coding_system[FD_SETSIZE];
298 #ifdef DATAGRAM_SOCKETS
299 /* Table of `partner address' for datagram sockets. */
300 static struct sockaddr_and_len {
301 struct sockaddr *sa;
302 ptrdiff_t len;
303 } datagram_address[FD_SETSIZE];
304 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
305 #define DATAGRAM_CONN_P(proc) \
306 (PROCESSP (proc) && \
307 XPROCESS (proc)->infd >= 0 && \
308 datagram_address[XPROCESS (proc)->infd].sa != 0)
309 #else
310 #define DATAGRAM_CONN_P(proc) (0)
311 #endif
313 /* FOR_EACH_PROCESS (LIST_VAR, PROC_VAR) followed by a statement is
314 a `for' loop which iterates over processes from Vprocess_alist. */
316 #define FOR_EACH_PROCESS(list_var, proc_var) \
317 FOR_EACH_ALIST_VALUE (Vprocess_alist, list_var, proc_var)
319 /* These setters are used only in this file, so they can be private. */
320 static void
321 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
323 p->buffer = val;
325 static void
326 pset_command (struct Lisp_Process *p, Lisp_Object val)
328 p->command = val;
330 static void
331 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
333 p->decode_coding_system = val;
335 static void
336 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
338 p->decoding_buf = val;
340 static void
341 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
343 p->encode_coding_system = val;
345 static void
346 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
348 p->encoding_buf = val;
350 static void
351 pset_filter (struct Lisp_Process *p, Lisp_Object val)
353 p->filter = NILP (val) ? Qinternal_default_process_filter : val;
355 static void
356 pset_log (struct Lisp_Process *p, Lisp_Object val)
358 p->log = val;
360 static void
361 pset_mark (struct Lisp_Process *p, Lisp_Object val)
363 p->mark = val;
365 static void
366 pset_thread (struct Lisp_Process *p, Lisp_Object val)
368 p->thread = val;
370 static void
371 pset_name (struct Lisp_Process *p, Lisp_Object val)
373 p->name = val;
375 static void
376 pset_plist (struct Lisp_Process *p, Lisp_Object val)
378 p->plist = val;
380 static void
381 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
383 p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
385 static void
386 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
388 p->tty_name = val;
390 static void
391 pset_type (struct Lisp_Process *p, Lisp_Object val)
393 p->type = val;
395 static void
396 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
398 p->write_queue = val;
400 static void
401 pset_stderrproc (struct Lisp_Process *p, Lisp_Object val)
403 p->stderrproc = val;
407 static Lisp_Object
408 make_lisp_proc (struct Lisp_Process *p)
410 return make_lisp_ptr (p, Lisp_Vectorlike);
413 enum fd_bits
415 /* Read from file descriptor. */
416 FOR_READ = 1,
417 /* Write to file descriptor. */
418 FOR_WRITE = 2,
419 /* This descriptor refers to a keyboard. Only valid if FOR_READ is
420 set. */
421 KEYBOARD_FD = 4,
422 /* This descriptor refers to a process. */
423 PROCESS_FD = 8,
424 /* A non-blocking connect. Only valid if FOR_WRITE is set. */
425 NON_BLOCKING_CONNECT_FD = 16
428 static struct fd_callback_data
430 fd_callback func;
431 void *data;
432 /* Flags from enum fd_bits. */
433 int flags;
434 /* If this fd is locked to a certain thread, this points to it.
435 Otherwise, this is NULL. If an fd is locked to a thread, then
436 only that thread is permitted to wait on it. */
437 struct thread_state *thread;
438 /* If this fd is currently being selected on by a thread, this
439 points to the thread. Otherwise it is NULL. */
440 struct thread_state *waiting_thread;
441 } fd_callback_info[FD_SETSIZE];
444 /* Add a file descriptor FD to be monitored for when read is possible.
445 When read is possible, call FUNC with argument DATA. */
447 void
448 add_read_fd (int fd, fd_callback func, void *data)
450 add_keyboard_wait_descriptor (fd);
452 fd_callback_info[fd].func = func;
453 fd_callback_info[fd].data = data;
456 static void
457 add_non_keyboard_read_fd (int fd)
459 eassert (fd >= 0 && fd < FD_SETSIZE);
460 eassert (fd_callback_info[fd].func == NULL);
462 fd_callback_info[fd].flags &= ~KEYBOARD_FD;
463 fd_callback_info[fd].flags |= FOR_READ;
464 if (fd > max_desc)
465 max_desc = fd;
468 static void
469 add_process_read_fd (int fd)
471 add_non_keyboard_read_fd (fd);
472 fd_callback_info[fd].flags |= PROCESS_FD;
475 /* Stop monitoring file descriptor FD for when read is possible. */
477 void
478 delete_read_fd (int fd)
480 delete_keyboard_wait_descriptor (fd);
482 if (fd_callback_info[fd].flags == 0)
484 fd_callback_info[fd].func = 0;
485 fd_callback_info[fd].data = 0;
489 /* Add a file descriptor FD to be monitored for when write is possible.
490 When write is possible, call FUNC with argument DATA. */
492 void
493 add_write_fd (int fd, fd_callback func, void *data)
495 eassert (fd >= 0 && fd < FD_SETSIZE);
497 fd_callback_info[fd].func = func;
498 fd_callback_info[fd].data = data;
499 fd_callback_info[fd].flags |= FOR_WRITE;
500 if (fd > max_desc)
501 max_desc = fd;
504 static void
505 add_non_blocking_write_fd (int fd)
507 eassert (fd >= 0 && fd < FD_SETSIZE);
508 eassert (fd_callback_info[fd].func == NULL);
510 fd_callback_info[fd].flags |= FOR_WRITE | NON_BLOCKING_CONNECT_FD;
511 if (fd > max_desc)
512 max_desc = fd;
513 ++num_pending_connects;
516 static void
517 recompute_max_desc (void)
519 int fd;
521 for (fd = max_desc; fd >= 0; --fd)
523 if (fd_callback_info[fd].flags != 0)
525 max_desc = fd;
526 break;
531 /* Stop monitoring file descriptor FD for when write is possible. */
533 void
534 delete_write_fd (int fd)
536 if ((fd_callback_info[fd].flags & NON_BLOCKING_CONNECT_FD) != 0)
538 if (--num_pending_connects < 0)
539 emacs_abort ();
541 fd_callback_info[fd].flags &= ~(FOR_WRITE | NON_BLOCKING_CONNECT_FD);
542 if (fd_callback_info[fd].flags == 0)
544 fd_callback_info[fd].func = 0;
545 fd_callback_info[fd].data = 0;
547 if (fd == max_desc)
548 recompute_max_desc ();
552 static void
553 compute_input_wait_mask (fd_set *mask)
555 int fd;
557 FD_ZERO (mask);
558 for (fd = 0; fd <= max_desc; ++fd)
560 if (fd_callback_info[fd].thread != NULL
561 && fd_callback_info[fd].thread != current_thread)
562 continue;
563 if (fd_callback_info[fd].waiting_thread != NULL
564 && fd_callback_info[fd].waiting_thread != current_thread)
565 continue;
566 if ((fd_callback_info[fd].flags & FOR_READ) != 0)
568 FD_SET (fd, mask);
569 fd_callback_info[fd].waiting_thread = current_thread;
574 static void
575 compute_non_process_wait_mask (fd_set *mask)
577 int fd;
579 FD_ZERO (mask);
580 for (fd = 0; fd <= max_desc; ++fd)
582 if (fd_callback_info[fd].thread != NULL
583 && fd_callback_info[fd].thread != current_thread)
584 continue;
585 if (fd_callback_info[fd].waiting_thread != NULL
586 && fd_callback_info[fd].waiting_thread != current_thread)
587 continue;
588 if ((fd_callback_info[fd].flags & FOR_READ) != 0
589 && (fd_callback_info[fd].flags & PROCESS_FD) == 0)
591 FD_SET (fd, mask);
592 fd_callback_info[fd].waiting_thread = current_thread;
597 static void
598 compute_non_keyboard_wait_mask (fd_set *mask)
600 int fd;
602 FD_ZERO (mask);
603 for (fd = 0; fd <= max_desc; ++fd)
605 if (fd_callback_info[fd].thread != NULL
606 && fd_callback_info[fd].thread != current_thread)
607 continue;
608 if (fd_callback_info[fd].waiting_thread != NULL
609 && fd_callback_info[fd].waiting_thread != current_thread)
610 continue;
611 if ((fd_callback_info[fd].flags & FOR_READ) != 0
612 && (fd_callback_info[fd].flags & KEYBOARD_FD) == 0)
614 FD_SET (fd, mask);
615 fd_callback_info[fd].waiting_thread = current_thread;
620 static void
621 compute_write_mask (fd_set *mask)
623 int fd;
625 FD_ZERO (mask);
626 for (fd = 0; fd <= max_desc; ++fd)
628 if (fd_callback_info[fd].thread != NULL
629 && fd_callback_info[fd].thread != current_thread)
630 continue;
631 if (fd_callback_info[fd].waiting_thread != NULL
632 && fd_callback_info[fd].waiting_thread != current_thread)
633 continue;
634 if ((fd_callback_info[fd].flags & FOR_WRITE) != 0)
636 FD_SET (fd, mask);
637 fd_callback_info[fd].waiting_thread = current_thread;
642 static void
643 clear_waiting_thread_info (void)
645 int fd;
647 for (fd = 0; fd <= max_desc; ++fd)
649 if (fd_callback_info[fd].waiting_thread == current_thread)
650 fd_callback_info[fd].waiting_thread = NULL;
655 /* Compute the Lisp form of the process status, p->status, from
656 the numeric status that was returned by `wait'. */
658 static Lisp_Object status_convert (int);
660 static void
661 update_status (struct Lisp_Process *p)
663 eassert (p->raw_status_new);
664 pset_status (p, status_convert (p->raw_status));
665 p->raw_status_new = 0;
668 /* Convert a process status word in Unix format to
669 the list that we use internally. */
671 static Lisp_Object
672 status_convert (int w)
674 if (WIFSTOPPED (w))
675 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
676 else if (WIFEXITED (w))
677 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
678 WCOREDUMP (w) ? Qt : Qnil));
679 else if (WIFSIGNALED (w))
680 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
681 WCOREDUMP (w) ? Qt : Qnil));
682 else
683 return Qrun;
686 /* True if STATUS is that of a process attempting connection. */
688 static bool
689 connecting_status (Lisp_Object status)
691 return CONSP (status) && EQ (XCAR (status), Qconnect);
694 /* Given a status-list, extract the three pieces of information
695 and store them individually through the three pointers. */
697 static void
698 decode_status (Lisp_Object l, Lisp_Object *symbol, Lisp_Object *code,
699 bool *coredump)
701 Lisp_Object tem;
703 if (connecting_status (l))
704 l = XCAR (l);
706 if (SYMBOLP (l))
708 *symbol = l;
709 *code = make_number (0);
710 *coredump = 0;
712 else
714 *symbol = XCAR (l);
715 tem = XCDR (l);
716 *code = XCAR (tem);
717 tem = XCDR (tem);
718 *coredump = !NILP (tem);
722 /* Return a string describing a process status list. */
724 static Lisp_Object
725 status_message (struct Lisp_Process *p)
727 Lisp_Object status = p->status;
728 Lisp_Object symbol, code;
729 bool coredump;
730 Lisp_Object string;
732 decode_status (status, &symbol, &code, &coredump);
734 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
736 char const *signame;
737 synchronize_system_messages_locale ();
738 signame = strsignal (XFASTINT (code));
739 if (signame == 0)
740 string = build_string ("unknown");
741 else
743 int c1, c2;
745 string = build_unibyte_string (signame);
746 if (! NILP (Vlocale_coding_system))
747 string = (code_convert_string_norecord
748 (string, Vlocale_coding_system, 0));
749 c1 = STRING_CHAR (SDATA (string));
750 c2 = downcase (c1);
751 if (c1 != c2)
752 Faset (string, make_number (0), make_number (c2));
754 AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
755 return concat2 (string, suffix);
757 else if (EQ (symbol, Qexit))
759 if (NETCONN1_P (p))
760 return build_string (XFASTINT (code) == 0
761 ? "deleted\n"
762 : "connection broken by remote peer\n");
763 if (XFASTINT (code) == 0)
764 return build_string ("finished\n");
765 AUTO_STRING (prefix, "exited abnormally with code ");
766 string = Fnumber_to_string (code);
767 AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
768 return concat3 (prefix, string, suffix);
770 else if (EQ (symbol, Qfailed))
772 AUTO_STRING (format, "failed with code %s\n");
773 return CALLN (Fformat, format, code);
775 else
776 return Fcopy_sequence (Fsymbol_name (symbol));
779 enum { PTY_NAME_SIZE = 24 };
781 /* Open an available pty, returning a file descriptor.
782 Store into PTY_NAME the file name of the terminal corresponding to the pty.
783 Return -1 on failure. */
785 static int
786 allocate_pty (char pty_name[PTY_NAME_SIZE])
788 #ifdef HAVE_PTYS
789 int fd;
791 #ifdef PTY_ITERATION
792 PTY_ITERATION
793 #else
794 register int c, i;
795 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
796 for (i = 0; i < 16; i++)
797 #endif
799 #ifdef PTY_NAME_SPRINTF
800 PTY_NAME_SPRINTF
801 #else
802 sprintf (pty_name, "/dev/pty%c%x", c, i);
803 #endif /* no PTY_NAME_SPRINTF */
805 #ifdef PTY_OPEN
806 PTY_OPEN;
807 #else /* no PTY_OPEN */
808 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
809 #endif /* no PTY_OPEN */
811 if (fd >= 0)
813 #ifdef PTY_TTY_NAME_SPRINTF
814 PTY_TTY_NAME_SPRINTF
815 #else
816 sprintf (pty_name, "/dev/tty%c%x", c, i);
817 #endif /* no PTY_TTY_NAME_SPRINTF */
819 /* Set FD's close-on-exec flag. This is needed even if
820 PT_OPEN calls posix_openpt with O_CLOEXEC, since POSIX
821 doesn't require support for that combination.
822 Do this after PTY_TTY_NAME_SPRINTF, which on some platforms
823 doesn't work if the close-on-exec flag is set (Bug#20555).
824 Multithreaded platforms where posix_openpt ignores
825 O_CLOEXEC (or where PTY_OPEN doesn't call posix_openpt)
826 have a race condition between the PTY_OPEN and here. */
827 fcntl (fd, F_SETFD, FD_CLOEXEC);
829 /* Check to make certain that both sides are available.
830 This avoids a nasty yet stupid bug in rlogins. */
831 if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
833 emacs_close (fd);
834 continue;
836 setup_pty (fd);
837 return fd;
840 #endif /* HAVE_PTYS */
841 return -1;
844 /* Allocate basically initialized process. */
846 static struct Lisp_Process *
847 allocate_process (void)
849 return ALLOCATE_ZEROED_PSEUDOVECTOR (struct Lisp_Process, pid, PVEC_PROCESS);
852 static Lisp_Object
853 make_process (Lisp_Object name)
855 struct Lisp_Process *p = allocate_process ();
856 /* Initialize Lisp data. Note that allocate_process initializes all
857 Lisp data to nil, so do it only for slots which should not be nil. */
858 pset_status (p, Qrun);
859 pset_mark (p, Fmake_marker ());
860 pset_thread (p, Fcurrent_thread ());
862 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
863 non-Lisp data, so do it only for slots which should not be zero. */
864 p->infd = -1;
865 p->outfd = -1;
866 for (int i = 0; i < PROCESS_OPEN_FDS; i++)
867 p->open_fd[i] = -1;
869 #ifdef HAVE_GNUTLS
870 verify (GNUTLS_STAGE_EMPTY == 0);
871 eassert (p->gnutls_initstage == GNUTLS_STAGE_EMPTY);
872 eassert (NILP (p->gnutls_boot_parameters));
873 #endif
875 /* If name is already in use, modify it until it is unused. */
877 Lisp_Object name1 = name;
878 for (printmax_t i = 1; ; i++)
880 Lisp_Object tem = Fget_process (name1);
881 if (NILP (tem))
882 break;
883 char const suffix_fmt[] = "<%"pMd">";
884 char suffix[sizeof suffix_fmt + INT_STRLEN_BOUND (printmax_t)];
885 AUTO_STRING_WITH_LEN (lsuffix, suffix, sprintf (suffix, suffix_fmt, i));
886 name1 = concat2 (name, lsuffix);
888 name = name1;
889 pset_name (p, name);
890 pset_sentinel (p, Qinternal_default_process_sentinel);
891 pset_filter (p, Qinternal_default_process_filter);
892 Lisp_Object val;
893 XSETPROCESS (val, p);
894 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
895 return val;
898 static void
899 remove_process (register Lisp_Object proc)
901 register Lisp_Object pair;
903 pair = Frassq (proc, Vprocess_alist);
904 Vprocess_alist = Fdelq (pair, Vprocess_alist);
906 deactivate_process (proc);
909 void
910 update_processes_for_thread_death (Lisp_Object dying_thread)
912 Lisp_Object pair;
914 for (pair = Vprocess_alist; !NILP (pair); pair = XCDR (pair))
916 Lisp_Object process = XCDR (XCAR (pair));
917 if (EQ (XPROCESS (process)->thread, dying_thread))
919 struct Lisp_Process *proc = XPROCESS (process);
921 pset_thread (proc, Qnil);
922 if (proc->infd >= 0)
923 fd_callback_info[proc->infd].thread = NULL;
924 if (proc->outfd >= 0)
925 fd_callback_info[proc->outfd].thread = NULL;
930 #ifdef HAVE_GETADDRINFO_A
931 static void
932 free_dns_request (Lisp_Object proc)
934 struct Lisp_Process *p = XPROCESS (proc);
936 if (p->dns_request->ar_result)
937 freeaddrinfo (p->dns_request->ar_result);
938 xfree (p->dns_request);
939 p->dns_request = NULL;
941 #endif
944 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
945 doc: /* Return t if OBJECT is a process. */)
946 (Lisp_Object object)
948 return PROCESSP (object) ? Qt : Qnil;
951 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
952 doc: /* Return the process named NAME, or nil if there is none. */)
953 (register Lisp_Object name)
955 if (PROCESSP (name))
956 return name;
957 CHECK_STRING (name);
958 return Fcdr (Fassoc (name, Vprocess_alist, Qnil));
961 /* This is how commands for the user decode process arguments. It
962 accepts a process, a process name, a buffer, a buffer name, or nil.
963 Buffers denote the first process in the buffer, and nil denotes the
964 current buffer. */
966 static Lisp_Object
967 get_process (register Lisp_Object name)
969 register Lisp_Object proc, obj;
970 if (STRINGP (name))
972 obj = Fget_process (name);
973 if (NILP (obj))
974 obj = Fget_buffer (name);
975 if (NILP (obj))
976 error ("Process %s does not exist", SDATA (name));
978 else if (NILP (name))
979 obj = Fcurrent_buffer ();
980 else
981 obj = name;
983 /* Now obj should be either a buffer object or a process object. */
984 if (BUFFERP (obj))
986 if (NILP (BVAR (XBUFFER (obj), name)))
987 error ("Attempt to get process for a dead buffer");
988 proc = Fget_buffer_process (obj);
989 if (NILP (proc))
990 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
992 else
994 CHECK_PROCESS (obj);
995 proc = obj;
997 return proc;
1001 /* Fdelete_process promises to immediately forget about the process, but in
1002 reality, Emacs needs to remember those processes until they have been
1003 treated by the SIGCHLD handler and waitpid has been invoked on them;
1004 otherwise they might fill up the kernel's process table.
1006 Some processes created by call-process are also put onto this list.
1008 Members of this list are (process-ID . filename) pairs. The
1009 process-ID is a number; the filename, if a string, is a file that
1010 needs to be removed after the process exits. */
1011 static Lisp_Object deleted_pid_list;
1013 void
1014 record_deleted_pid (pid_t pid, Lisp_Object filename)
1016 deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
1017 /* GC treated elements set to nil. */
1018 Fdelq (Qnil, deleted_pid_list));
1022 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
1023 doc: /* Delete PROCESS: kill it and forget about it immediately.
1024 PROCESS may be a process, a buffer, the name of a process or buffer, or
1025 nil, indicating the current buffer's process. */)
1026 (register Lisp_Object process)
1028 register struct Lisp_Process *p;
1030 process = get_process (process);
1031 p = XPROCESS (process);
1033 #ifdef HAVE_GETADDRINFO_A
1034 if (p->dns_request)
1036 /* Cancel the request. Unless shutting down, wait until
1037 completion. Free the request if completely canceled. */
1039 bool canceled = gai_cancel (p->dns_request) != EAI_NOTCANCELED;
1040 if (!canceled && !inhibit_sentinels)
1042 struct gaicb const *req = p->dns_request;
1043 while (gai_suspend (&req, 1, NULL) != 0)
1044 continue;
1045 canceled = true;
1047 if (canceled)
1048 free_dns_request (process);
1050 #endif
1052 p->raw_status_new = 0;
1053 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
1055 pset_status (p, list2 (Qexit, make_number (0)));
1056 p->tick = ++process_tick;
1057 status_notify (p, NULL);
1058 redisplay_preserve_echo_area (13);
1060 else
1062 if (p->alive)
1063 record_kill_process (p, Qnil);
1065 if (p->infd >= 0)
1067 /* Update P's status, since record_kill_process will make the
1068 SIGCHLD handler update deleted_pid_list, not *P. */
1069 Lisp_Object symbol;
1070 if (p->raw_status_new)
1071 update_status (p);
1072 symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
1073 if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
1074 pset_status (p, list2 (Qsignal, make_number (SIGKILL)));
1076 p->tick = ++process_tick;
1077 status_notify (p, NULL);
1078 redisplay_preserve_echo_area (13);
1081 remove_process (process);
1082 return Qnil;
1085 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
1086 doc: /* Return the status of PROCESS.
1087 The returned value is one of the following symbols:
1088 run -- for a process that is running.
1089 stop -- for a process stopped but continuable.
1090 exit -- for a process that has exited.
1091 signal -- for a process that has got a fatal signal.
1092 open -- for a network stream connection that is open.
1093 listen -- for a network stream server that is listening.
1094 closed -- for a network stream connection that is closed.
1095 connect -- when waiting for a non-blocking connection to complete.
1096 failed -- when a non-blocking connection has failed.
1097 nil -- if arg is a process name and no such process exists.
1098 PROCESS may be a process, a buffer, the name of a process, or
1099 nil, indicating the current buffer's process. */)
1100 (register Lisp_Object process)
1102 register struct Lisp_Process *p;
1103 register Lisp_Object status;
1105 if (STRINGP (process))
1106 process = Fget_process (process);
1107 else
1108 process = get_process (process);
1110 if (NILP (process))
1111 return process;
1113 p = XPROCESS (process);
1114 if (p->raw_status_new)
1115 update_status (p);
1116 status = p->status;
1117 if (CONSP (status))
1118 status = XCAR (status);
1119 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
1121 if (EQ (status, Qexit))
1122 status = Qclosed;
1123 else if (EQ (p->command, Qt))
1124 status = Qstop;
1125 else if (EQ (status, Qrun))
1126 status = Qopen;
1128 return status;
1131 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
1132 1, 1, 0,
1133 doc: /* Return the exit status of PROCESS or the signal number that killed it.
1134 If PROCESS has not yet exited or died, return 0. */)
1135 (register Lisp_Object process)
1137 CHECK_PROCESS (process);
1138 if (XPROCESS (process)->raw_status_new)
1139 update_status (XPROCESS (process));
1140 if (CONSP (XPROCESS (process)->status))
1141 return XCAR (XCDR (XPROCESS (process)->status));
1142 return make_number (0);
1145 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
1146 doc: /* Return the process id of PROCESS.
1147 This is the pid of the external process which PROCESS uses or talks to.
1148 For a network, serial, and pipe connections, this value is nil. */)
1149 (register Lisp_Object process)
1151 pid_t pid;
1153 CHECK_PROCESS (process);
1154 pid = XPROCESS (process)->pid;
1155 return (pid ? make_fixnum_or_float (pid) : Qnil);
1158 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
1159 doc: /* Return the name of PROCESS, as a string.
1160 This is the name of the program invoked in PROCESS,
1161 possibly modified to make it unique among process names. */)
1162 (register Lisp_Object process)
1164 CHECK_PROCESS (process);
1165 return XPROCESS (process)->name;
1168 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
1169 doc: /* Return the command that was executed to start PROCESS.
1170 This is a list of strings, the first string being the program executed
1171 and the rest of the strings being the arguments given to it.
1172 For a network or serial or pipe connection, this is nil (process is running)
1173 or t (process is stopped). */)
1174 (register Lisp_Object process)
1176 CHECK_PROCESS (process);
1177 return XPROCESS (process)->command;
1180 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
1181 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
1182 This is the terminal that the process itself reads and writes on,
1183 not the name of the pty that Emacs uses to talk with that terminal. */)
1184 (register Lisp_Object process)
1186 CHECK_PROCESS (process);
1187 return XPROCESS (process)->tty_name;
1190 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
1191 2, 2, 0,
1192 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
1193 Return BUFFER. */)
1194 (register Lisp_Object process, Lisp_Object buffer)
1196 struct Lisp_Process *p;
1198 CHECK_PROCESS (process);
1199 if (!NILP (buffer))
1200 CHECK_BUFFER (buffer);
1201 p = XPROCESS (process);
1202 pset_buffer (p, buffer);
1203 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
1204 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
1205 setup_process_coding_systems (process);
1206 return buffer;
1209 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
1210 1, 1, 0,
1211 doc: /* Return the buffer PROCESS is associated with.
1212 The default process filter inserts output from PROCESS into this buffer. */)
1213 (register Lisp_Object process)
1215 CHECK_PROCESS (process);
1216 return XPROCESS (process)->buffer;
1219 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1220 1, 1, 0,
1221 doc: /* Return the marker for the end of the last output from PROCESS. */)
1222 (register Lisp_Object process)
1224 CHECK_PROCESS (process);
1225 return XPROCESS (process)->mark;
1228 static void
1229 set_process_filter_masks (struct Lisp_Process *p)
1231 if (EQ (p->filter, Qt) && !EQ (p->status, Qlisten))
1232 delete_read_fd (p->infd);
1233 else if (EQ (p->filter, Qt)
1234 /* Network or serial process not stopped: */
1235 && !EQ (p->command, Qt))
1236 add_process_read_fd (p->infd);
1239 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1240 2, 2, 0,
1241 doc: /* Give PROCESS the filter function FILTER; nil means default.
1242 A value of t means stop accepting output from the process.
1244 When a process has a non-default filter, its buffer is not used for output.
1245 Instead, each time it does output, the entire string of output is
1246 passed to the filter.
1248 The filter gets two arguments: the process and the string of output.
1249 The string argument is normally a multibyte string, except:
1250 - if the process's input coding system is no-conversion or raw-text,
1251 it is a unibyte string (the non-converted input), or else
1252 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1253 string (the result of converting the decoded input multibyte
1254 string to unibyte with `string-make-unibyte'). */)
1255 (Lisp_Object process, Lisp_Object filter)
1257 CHECK_PROCESS (process);
1258 struct Lisp_Process *p = XPROCESS (process);
1260 /* Don't signal an error if the process's input file descriptor
1261 is closed. This could make debugging Lisp more difficult,
1262 for example when doing something like
1264 (setq process (start-process ...))
1265 (debug)
1266 (set-process-filter process ...) */
1268 if (NILP (filter))
1269 filter = Qinternal_default_process_filter;
1271 pset_filter (p, filter);
1273 if (p->infd >= 0)
1274 set_process_filter_masks (p);
1276 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
1277 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1278 setup_process_coding_systems (process);
1279 return filter;
1282 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1283 1, 1, 0,
1284 doc: /* Return the filter function of PROCESS.
1285 See `set-process-filter' for more info on filter functions. */)
1286 (register Lisp_Object process)
1288 CHECK_PROCESS (process);
1289 return XPROCESS (process)->filter;
1292 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1293 2, 2, 0,
1294 doc: /* Give PROCESS the sentinel SENTINEL; nil for default.
1295 The sentinel is called as a function when the process changes state.
1296 It gets two arguments: the process, and a string describing the change. */)
1297 (register Lisp_Object process, Lisp_Object sentinel)
1299 struct Lisp_Process *p;
1301 CHECK_PROCESS (process);
1302 p = XPROCESS (process);
1304 if (NILP (sentinel))
1305 sentinel = Qinternal_default_process_sentinel;
1307 pset_sentinel (p, sentinel);
1308 if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
1309 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1310 return sentinel;
1313 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1314 1, 1, 0,
1315 doc: /* Return the sentinel of PROCESS.
1316 See `set-process-sentinel' for more info on sentinels. */)
1317 (register Lisp_Object process)
1319 CHECK_PROCESS (process);
1320 return XPROCESS (process)->sentinel;
1323 DEFUN ("set-process-thread", Fset_process_thread, Sset_process_thread,
1324 2, 2, 0,
1325 doc: /* Set the locking thread of PROCESS to be THREAD.
1326 If THREAD is nil, the process is unlocked. */)
1327 (Lisp_Object process, Lisp_Object thread)
1329 struct Lisp_Process *proc;
1330 struct thread_state *tstate;
1332 CHECK_PROCESS (process);
1333 if (NILP (thread))
1334 tstate = NULL;
1335 else
1337 CHECK_THREAD (thread);
1338 tstate = XTHREAD (thread);
1341 proc = XPROCESS (process);
1342 pset_thread (proc, thread);
1343 if (proc->infd >= 0)
1344 fd_callback_info[proc->infd].thread = tstate;
1345 if (proc->outfd >= 0)
1346 fd_callback_info[proc->outfd].thread = tstate;
1348 return thread;
1351 DEFUN ("process-thread", Fprocess_thread, Sprocess_thread,
1352 1, 1, 0,
1353 doc: /* Ret the locking thread of PROCESS.
1354 If PROCESS is unlocked, this function returns nil. */)
1355 (Lisp_Object process)
1357 CHECK_PROCESS (process);
1358 return XPROCESS (process)->thread;
1361 DEFUN ("set-process-window-size", Fset_process_window_size,
1362 Sset_process_window_size, 3, 3, 0,
1363 doc: /* Tell PROCESS that it has logical window size WIDTH by HEIGHT.
1364 Value is t if PROCESS was successfully told about the window size,
1365 nil otherwise. */)
1366 (Lisp_Object process, Lisp_Object height, Lisp_Object width)
1368 CHECK_PROCESS (process);
1370 /* All known platforms store window sizes as 'unsigned short'. */
1371 CHECK_RANGED_INTEGER (height, 0, USHRT_MAX);
1372 CHECK_RANGED_INTEGER (width, 0, USHRT_MAX);
1374 if (NETCONN_P (process)
1375 || XPROCESS (process)->infd < 0
1376 || (set_window_size (XPROCESS (process)->infd,
1377 XINT (height), XINT (width))
1378 < 0))
1379 return Qnil;
1380 else
1381 return Qt;
1384 DEFUN ("set-process-inherit-coding-system-flag",
1385 Fset_process_inherit_coding_system_flag,
1386 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1387 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1388 If the second argument FLAG is non-nil, then the variable
1389 `buffer-file-coding-system' of the buffer associated with PROCESS
1390 will be bound to the value of the coding system used to decode
1391 the process output.
1393 This is useful when the coding system specified for the process buffer
1394 leaves either the character code conversion or the end-of-line conversion
1395 unspecified, or if the coding system used to decode the process output
1396 is more appropriate for saving the process buffer.
1398 Binding the variable `inherit-process-coding-system' to non-nil before
1399 starting the process is an alternative way of setting the inherit flag
1400 for the process which will run.
1402 This function returns FLAG. */)
1403 (register Lisp_Object process, Lisp_Object flag)
1405 CHECK_PROCESS (process);
1406 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1407 return flag;
1410 DEFUN ("set-process-query-on-exit-flag",
1411 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1412 2, 2, 0,
1413 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1414 If the second argument FLAG is non-nil, Emacs will query the user before
1415 exiting or killing a buffer if PROCESS is running. This function
1416 returns FLAG. */)
1417 (register Lisp_Object process, Lisp_Object flag)
1419 CHECK_PROCESS (process);
1420 XPROCESS (process)->kill_without_query = NILP (flag);
1421 return flag;
1424 DEFUN ("process-query-on-exit-flag",
1425 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1426 1, 1, 0,
1427 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1428 (register Lisp_Object process)
1430 CHECK_PROCESS (process);
1431 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1434 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1435 1, 2, 0,
1436 doc: /* Return the contact info of PROCESS; t for a real child.
1437 For a network or serial or pipe connection, the value depends on the
1438 optional KEY arg. If KEY is nil, value is a cons cell of the form
1439 \(HOST SERVICE) for a network connection or (PORT SPEED) for a serial
1440 connection; it is t for a pipe connection. If KEY is t, the complete
1441 contact information for the connection is returned, else the specific
1442 value for the keyword KEY is returned. See `make-network-process',
1443 `make-serial-process', or `make pipe-process' for the list of keywords.
1444 If PROCESS is a non-blocking network process that hasn't been fully
1445 set up yet, this function will block until socket setup has completed. */)
1446 (Lisp_Object process, Lisp_Object key)
1448 Lisp_Object contact;
1450 CHECK_PROCESS (process);
1451 contact = XPROCESS (process)->childp;
1453 #ifdef DATAGRAM_SOCKETS
1455 if (NETCONN_P (process))
1456 wait_for_socket_fds (process, "process-contact");
1458 if (DATAGRAM_CONN_P (process)
1459 && (EQ (key, Qt) || EQ (key, QCremote)))
1460 contact = Fplist_put (contact, QCremote,
1461 Fprocess_datagram_address (process));
1462 #endif
1464 if ((!NETCONN_P (process) && !SERIALCONN_P (process) && !PIPECONN_P (process))
1465 || EQ (key, Qt))
1466 return contact;
1467 if (NILP (key) && NETCONN_P (process))
1468 return list2 (Fplist_get (contact, QChost),
1469 Fplist_get (contact, QCservice));
1470 if (NILP (key) && SERIALCONN_P (process))
1471 return list2 (Fplist_get (contact, QCport),
1472 Fplist_get (contact, QCspeed));
1473 /* FIXME: Return a meaningful value (e.g., the child end of the pipe)
1474 if the pipe process is useful for purposes other than receiving
1475 stderr. */
1476 if (NILP (key) && PIPECONN_P (process))
1477 return Qt;
1478 return Fplist_get (contact, key);
1481 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1482 1, 1, 0,
1483 doc: /* Return the plist of PROCESS. */)
1484 (register Lisp_Object process)
1486 CHECK_PROCESS (process);
1487 return XPROCESS (process)->plist;
1490 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1491 2, 2, 0,
1492 doc: /* Replace the plist of PROCESS with PLIST. Return PLIST. */)
1493 (Lisp_Object process, Lisp_Object plist)
1495 CHECK_PROCESS (process);
1496 CHECK_LIST (plist);
1498 pset_plist (XPROCESS (process), plist);
1499 return plist;
1502 #if 0 /* Turned off because we don't currently record this info
1503 in the process. Perhaps add it. */
1504 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1505 doc: /* Return the connection type of PROCESS.
1506 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1507 a socket connection. */)
1508 (Lisp_Object process)
1510 return XPROCESS (process)->type;
1512 #endif
1514 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1515 doc: /* Return the connection type of PROCESS.
1516 The value is either the symbol `real', `network', `serial', or `pipe'.
1517 PROCESS may be a process, a buffer, the name of a process or buffer, or
1518 nil, indicating the current buffer's process. */)
1519 (Lisp_Object process)
1521 Lisp_Object proc;
1522 proc = get_process (process);
1523 return XPROCESS (proc)->type;
1526 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1527 1, 2, 0,
1528 doc: /* Convert network ADDRESS from internal format to a string.
1529 A 4 or 5 element vector represents an IPv4 address (with port number).
1530 An 8 or 9 element vector represents an IPv6 address (with port number).
1531 If optional second argument OMIT-PORT is non-nil, don't include a port
1532 number in the string, even when present in ADDRESS.
1533 Return nil if format of ADDRESS is invalid. */)
1534 (Lisp_Object address, Lisp_Object omit_port)
1536 if (NILP (address))
1537 return Qnil;
1539 if (STRINGP (address)) /* AF_LOCAL */
1540 return address;
1542 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1544 register struct Lisp_Vector *p = XVECTOR (address);
1545 ptrdiff_t size = p->header.size;
1546 Lisp_Object args[10];
1547 int nargs, i;
1548 char const *format;
1550 if (size == 4 || (size == 5 && !NILP (omit_port)))
1552 format = "%d.%d.%d.%d";
1553 nargs = 4;
1555 else if (size == 5)
1557 format = "%d.%d.%d.%d:%d";
1558 nargs = 5;
1560 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1562 format = "%x:%x:%x:%x:%x:%x:%x:%x";
1563 nargs = 8;
1565 else if (size == 9)
1567 format = "[%x:%x:%x:%x:%x:%x:%x:%x]:%d";
1568 nargs = 9;
1570 else
1571 return Qnil;
1573 AUTO_STRING (format_obj, format);
1574 args[0] = format_obj;
1576 for (i = 0; i < nargs; i++)
1578 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1579 return Qnil;
1581 if (nargs <= 5 /* IPv4 */
1582 && i < 4 /* host, not port */
1583 && XINT (p->contents[i]) > 255)
1584 return Qnil;
1586 args[i + 1] = p->contents[i];
1589 return Fformat (nargs + 1, args);
1592 if (CONSP (address))
1594 AUTO_STRING (format, "<Family %d>");
1595 return CALLN (Fformat, format, Fcar (address));
1598 return Qnil;
1601 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1602 doc: /* Return a list of all processes that are Emacs sub-processes. */)
1603 (void)
1605 return Fmapcar (Qcdr, Vprocess_alist);
1608 /* Starting asynchronous inferior processes. */
1610 DEFUN ("make-process", Fmake_process, Smake_process, 0, MANY, 0,
1611 doc: /* Start a program in a subprocess. Return the process object for it.
1613 This is similar to `start-process', but arguments are specified as
1614 keyword/argument pairs. The following arguments are defined:
1616 :name NAME -- NAME is name for process. It is modified if necessary
1617 to make it unique.
1619 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
1620 with the process. Process output goes at end of that buffer, unless
1621 you specify an output stream or filter function to handle the output.
1622 BUFFER may be also nil, meaning that this process is not associated
1623 with any buffer.
1625 :command COMMAND -- COMMAND is a list starting with the program file
1626 name, followed by strings to give to the program as arguments.
1628 :coding CODING -- If CODING is a symbol, it specifies the coding
1629 system used for both reading and writing for this process. If CODING
1630 is a cons (DECODING . ENCODING), DECODING is used for reading, and
1631 ENCODING is used for writing.
1633 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
1634 the process is running. If BOOL is not given, query before exiting.
1636 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
1637 In the stopped state, a process does not accept incoming data, but you
1638 can send outgoing data. The stopped state is cleared by
1639 `continue-process' and set by `stop-process'.
1641 :connection-type TYPE -- TYPE is control type of device used to
1642 communicate with subprocesses. Values are `pipe' to use a pipe, `pty'
1643 to use a pty, or nil to use the default specified through
1644 `process-connection-type'.
1646 :filter FILTER -- Install FILTER as the process filter.
1648 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
1650 :stderr STDERR -- STDERR is either a buffer or a pipe process attached
1651 to the standard error of subprocess. Specifying this implies
1652 `:connection-type' is set to `pipe'.
1654 usage: (make-process &rest ARGS) */)
1655 (ptrdiff_t nargs, Lisp_Object *args)
1657 Lisp_Object buffer, name, command, program, proc, contact, current_dir, tem;
1658 Lisp_Object xstderr, stderrproc;
1659 ptrdiff_t count = SPECPDL_INDEX ();
1661 if (nargs == 0)
1662 return Qnil;
1664 /* Save arguments for process-contact and clone-process. */
1665 contact = Flist (nargs, args);
1667 buffer = Fplist_get (contact, QCbuffer);
1668 if (!NILP (buffer))
1669 buffer = Fget_buffer_create (buffer);
1671 /* Make sure that the child will be able to chdir to the current
1672 buffer's current directory, or its unhandled equivalent. We
1673 can't just have the child check for an error when it does the
1674 chdir, since it's in a vfork. */
1675 current_dir = encode_current_directory ();
1677 name = Fplist_get (contact, QCname);
1678 CHECK_STRING (name);
1680 command = Fplist_get (contact, QCcommand);
1681 if (CONSP (command))
1682 program = XCAR (command);
1683 else
1684 program = Qnil;
1686 if (!NILP (program))
1687 CHECK_STRING (program);
1689 bool query_on_exit = NILP (Fplist_get (contact, QCnoquery));
1691 stderrproc = Qnil;
1692 xstderr = Fplist_get (contact, QCstderr);
1693 if (PROCESSP (xstderr))
1695 if (!PIPECONN_P (xstderr))
1696 error ("Process is not a pipe process");
1697 stderrproc = xstderr;
1699 else if (!NILP (xstderr))
1701 CHECK_STRING (program);
1702 stderrproc = CALLN (Fmake_pipe_process,
1703 QCname,
1704 concat2 (name, build_string (" stderr")),
1705 QCbuffer,
1706 Fget_buffer_create (xstderr),
1707 QCnoquery,
1708 query_on_exit ? Qnil : Qt);
1711 proc = make_process (name);
1712 record_unwind_protect (start_process_unwind, proc);
1714 pset_childp (XPROCESS (proc), Qt);
1715 eassert (NILP (XPROCESS (proc)->plist));
1716 pset_type (XPROCESS (proc), Qreal);
1717 pset_buffer (XPROCESS (proc), buffer);
1718 pset_sentinel (XPROCESS (proc), Fplist_get (contact, QCsentinel));
1719 pset_filter (XPROCESS (proc), Fplist_get (contact, QCfilter));
1720 pset_command (XPROCESS (proc), Fcopy_sequence (command));
1722 if (!query_on_exit)
1723 XPROCESS (proc)->kill_without_query = 1;
1724 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
1725 pset_command (XPROCESS (proc), Qt);
1727 tem = Fplist_get (contact, QCconnection_type);
1728 if (EQ (tem, Qpty))
1729 XPROCESS (proc)->pty_flag = true;
1730 else if (EQ (tem, Qpipe))
1731 XPROCESS (proc)->pty_flag = false;
1732 else if (NILP (tem))
1733 XPROCESS (proc)->pty_flag = !NILP (Vprocess_connection_type);
1734 else
1735 report_file_error ("Unknown connection type", tem);
1737 if (!NILP (stderrproc))
1739 pset_stderrproc (XPROCESS (proc), stderrproc);
1741 XPROCESS (proc)->pty_flag = false;
1744 #ifdef HAVE_GNUTLS
1745 /* AKA GNUTLS_INITSTAGE(proc). */
1746 verify (GNUTLS_STAGE_EMPTY == 0);
1747 eassert (XPROCESS (proc)->gnutls_initstage == GNUTLS_STAGE_EMPTY);
1748 eassert (NILP (XPROCESS (proc)->gnutls_cred_type));
1749 #endif
1751 XPROCESS (proc)->adaptive_read_buffering
1752 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1753 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1755 /* Make the process marker point into the process buffer (if any). */
1756 if (BUFFERP (buffer))
1757 set_marker_both (XPROCESS (proc)->mark, buffer,
1758 BUF_ZV (XBUFFER (buffer)),
1759 BUF_ZV_BYTE (XBUFFER (buffer)));
1761 USE_SAFE_ALLOCA;
1764 /* Decide coding systems for communicating with the process. Here
1765 we don't setup the structure coding_system nor pay attention to
1766 unibyte mode. They are done in create_process. */
1768 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1769 Lisp_Object coding_systems = Qt;
1770 Lisp_Object val, *args2;
1772 tem = Fplist_get (contact, QCcoding);
1773 if (!NILP (tem))
1775 val = tem;
1776 if (CONSP (val))
1777 val = XCAR (val);
1779 else
1780 val = Vcoding_system_for_read;
1781 if (NILP (val))
1783 ptrdiff_t nargs2 = 3 + XINT (Flength (command));
1784 Lisp_Object tem2;
1785 SAFE_ALLOCA_LISP (args2, nargs2);
1786 ptrdiff_t i = 0;
1787 args2[i++] = Qstart_process;
1788 args2[i++] = name;
1789 args2[i++] = buffer;
1790 for (tem2 = command; CONSP (tem2); tem2 = XCDR (tem2))
1791 args2[i++] = XCAR (tem2);
1792 if (!NILP (program))
1793 coding_systems = Ffind_operation_coding_system (nargs2, args2);
1794 if (CONSP (coding_systems))
1795 val = XCAR (coding_systems);
1796 else if (CONSP (Vdefault_process_coding_system))
1797 val = XCAR (Vdefault_process_coding_system);
1799 pset_decode_coding_system (XPROCESS (proc), val);
1801 if (!NILP (tem))
1803 val = tem;
1804 if (CONSP (val))
1805 val = XCDR (val);
1807 else
1808 val = Vcoding_system_for_write;
1809 if (NILP (val))
1811 if (EQ (coding_systems, Qt))
1813 ptrdiff_t nargs2 = 3 + XINT (Flength (command));
1814 Lisp_Object tem2;
1815 SAFE_ALLOCA_LISP (args2, nargs2);
1816 ptrdiff_t i = 0;
1817 args2[i++] = Qstart_process;
1818 args2[i++] = name;
1819 args2[i++] = buffer;
1820 for (tem2 = command; CONSP (tem2); tem2 = XCDR (tem2))
1821 args2[i++] = XCAR (tem2);
1822 if (!NILP (program))
1823 coding_systems = Ffind_operation_coding_system (nargs2, args2);
1825 if (CONSP (coding_systems))
1826 val = XCDR (coding_systems);
1827 else if (CONSP (Vdefault_process_coding_system))
1828 val = XCDR (Vdefault_process_coding_system);
1830 pset_encode_coding_system (XPROCESS (proc), val);
1831 /* Note: At this moment, the above coding system may leave
1832 text-conversion or eol-conversion unspecified. They will be
1833 decided after we read output from the process and decode it by
1834 some coding system, or just before we actually send a text to
1835 the process. */
1839 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1840 eassert (XPROCESS (proc)->decoding_carryover == 0);
1841 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1843 XPROCESS (proc)->inherit_coding_system_flag
1844 = !(NILP (buffer) || !inherit_process_coding_system);
1846 if (!NILP (program))
1848 Lisp_Object program_args = XCDR (command);
1850 /* If program file name is not absolute, search our path for it.
1851 Put the name we will really use in TEM. */
1852 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1853 && !(SCHARS (program) > 1
1854 && IS_DEVICE_SEP (SREF (program, 1))))
1856 tem = Qnil;
1857 openp (Vexec_path, program, Vexec_suffixes, &tem,
1858 make_number (X_OK), false);
1859 if (NILP (tem))
1860 report_file_error ("Searching for program", program);
1861 tem = Fexpand_file_name (tem, Qnil);
1863 else
1865 if (!NILP (Ffile_directory_p (program)))
1866 error ("Specified program for new process is a directory");
1867 tem = program;
1870 /* Remove "/:" from TEM. */
1871 tem = remove_slash_colon (tem);
1873 Lisp_Object arg_encoding = Qnil;
1875 /* Encode the file name and put it in NEW_ARGV.
1876 That's where the child will use it to execute the program. */
1877 tem = list1 (ENCODE_FILE (tem));
1878 ptrdiff_t new_argc = 1;
1880 /* Here we encode arguments by the coding system used for sending
1881 data to the process. We don't support using different coding
1882 systems for encoding arguments and for encoding data sent to the
1883 process. */
1885 for (Lisp_Object tem2 = program_args; CONSP (tem2); tem2 = XCDR (tem2))
1887 Lisp_Object arg = XCAR (tem2);
1888 CHECK_STRING (arg);
1889 if (STRING_MULTIBYTE (arg))
1891 if (NILP (arg_encoding))
1892 arg_encoding = (complement_process_encoding_system
1893 (XPROCESS (proc)->encode_coding_system));
1894 arg = code_convert_string_norecord (arg, arg_encoding, 1);
1896 tem = Fcons (arg, tem);
1897 new_argc++;
1900 /* Now that everything is encoded we can collect the strings into
1901 NEW_ARGV. */
1902 char **new_argv;
1903 SAFE_NALLOCA (new_argv, 1, new_argc + 1);
1904 new_argv[new_argc] = 0;
1906 for (ptrdiff_t i = new_argc - 1; i >= 0; i--)
1908 new_argv[i] = SSDATA (XCAR (tem));
1909 tem = XCDR (tem);
1912 create_process (proc, new_argv, current_dir);
1914 else
1915 create_pty (proc);
1917 SAFE_FREE ();
1918 return unbind_to (count, proc);
1921 /* If PROC doesn't have its pid set, then an error was signaled and
1922 the process wasn't started successfully, so remove it. */
1923 static void
1924 start_process_unwind (Lisp_Object proc)
1926 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1927 remove_process (proc);
1930 /* If *FD_ADDR is nonnegative, close it, and mark it as closed. */
1932 static void
1933 close_process_fd (int *fd_addr)
1935 int fd = *fd_addr;
1936 if (0 <= fd)
1938 *fd_addr = -1;
1939 emacs_close (fd);
1943 /* Indexes of file descriptors in open_fds. */
1944 enum
1946 /* The pipe from Emacs to its subprocess. */
1947 SUBPROCESS_STDIN,
1948 WRITE_TO_SUBPROCESS,
1950 /* The main pipe from the subprocess to Emacs. */
1951 READ_FROM_SUBPROCESS,
1952 SUBPROCESS_STDOUT,
1954 /* The pipe from the subprocess to Emacs that is closed when the
1955 subprocess execs. */
1956 READ_FROM_EXEC_MONITOR,
1957 EXEC_MONITOR_OUTPUT
1960 verify (PROCESS_OPEN_FDS == EXEC_MONITOR_OUTPUT + 1);
1962 static void
1963 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1965 struct Lisp_Process *p = XPROCESS (process);
1966 int inchannel, outchannel;
1967 pid_t pid;
1968 int vfork_errno;
1969 int forkin, forkout, forkerr = -1;
1970 bool pty_flag = 0;
1971 char pty_name[PTY_NAME_SIZE];
1972 Lisp_Object lisp_pty_name = Qnil;
1973 sigset_t oldset;
1975 inchannel = outchannel = -1;
1977 if (p->pty_flag)
1978 outchannel = inchannel = allocate_pty (pty_name);
1980 if (inchannel >= 0)
1982 p->open_fd[READ_FROM_SUBPROCESS] = inchannel;
1983 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1984 /* On most USG systems it does not work to open the pty's tty here,
1985 then close it and reopen it in the child. */
1986 /* Don't let this terminal become our controlling terminal
1987 (in case we don't have one). */
1988 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1989 if (forkin < 0)
1990 report_file_error ("Opening pty", Qnil);
1991 p->open_fd[SUBPROCESS_STDIN] = forkin;
1992 #else
1993 forkin = forkout = -1;
1994 #endif /* not USG, or USG_SUBTTY_WORKS */
1995 pty_flag = 1;
1996 lisp_pty_name = build_string (pty_name);
1998 else
2000 if (emacs_pipe (p->open_fd + SUBPROCESS_STDIN) != 0
2001 || emacs_pipe (p->open_fd + READ_FROM_SUBPROCESS) != 0)
2002 report_file_error ("Creating pipe", Qnil);
2003 forkin = p->open_fd[SUBPROCESS_STDIN];
2004 outchannel = p->open_fd[WRITE_TO_SUBPROCESS];
2005 inchannel = p->open_fd[READ_FROM_SUBPROCESS];
2006 forkout = p->open_fd[SUBPROCESS_STDOUT];
2008 if (!NILP (p->stderrproc))
2010 struct Lisp_Process *pp = XPROCESS (p->stderrproc);
2012 forkerr = pp->open_fd[SUBPROCESS_STDOUT];
2014 /* Close unnecessary file descriptors. */
2015 close_process_fd (&pp->open_fd[WRITE_TO_SUBPROCESS]);
2016 close_process_fd (&pp->open_fd[SUBPROCESS_STDIN]);
2020 #ifndef WINDOWSNT
2021 if (emacs_pipe (p->open_fd + READ_FROM_EXEC_MONITOR) != 0)
2022 report_file_error ("Creating pipe", Qnil);
2023 #endif
2025 fcntl (inchannel, F_SETFL, O_NONBLOCK);
2026 fcntl (outchannel, F_SETFL, O_NONBLOCK);
2028 /* Record this as an active process, with its channels. */
2029 chan_process[inchannel] = process;
2030 p->infd = inchannel;
2031 p->outfd = outchannel;
2033 /* Previously we recorded the tty descriptor used in the subprocess.
2034 It was only used for getting the foreground tty process, so now
2035 we just reopen the device (see emacs_get_tty_pgrp) as this is
2036 more portable (see USG_SUBTTY_WORKS above). */
2038 p->pty_flag = pty_flag;
2039 pset_status (p, Qrun);
2041 if (!EQ (p->command, Qt))
2042 add_process_read_fd (inchannel);
2044 /* This may signal an error. */
2045 setup_process_coding_systems (process);
2047 block_input ();
2048 block_child_signal (&oldset);
2050 #ifndef WINDOWSNT
2051 /* vfork, and prevent local vars from being clobbered by the vfork. */
2052 Lisp_Object volatile current_dir_volatile = current_dir;
2053 Lisp_Object volatile lisp_pty_name_volatile = lisp_pty_name;
2054 char **volatile new_argv_volatile = new_argv;
2055 int volatile forkin_volatile = forkin;
2056 int volatile forkout_volatile = forkout;
2057 int volatile forkerr_volatile = forkerr;
2058 struct Lisp_Process *p_volatile = p;
2060 #ifdef DARWIN_OS
2061 /* Darwin doesn't let us run setsid after a vfork, so use fork when
2062 necessary. Also, reset SIGCHLD handling after a vfork, as
2063 apparently macOS can mistakenly deliver SIGCHLD to the child. */
2064 if (pty_flag)
2065 pid = fork ();
2066 else
2068 pid = vfork ();
2069 if (pid == 0)
2070 signal (SIGCHLD, SIG_DFL);
2072 #else
2073 pid = vfork ();
2074 #endif
2076 current_dir = current_dir_volatile;
2077 lisp_pty_name = lisp_pty_name_volatile;
2078 new_argv = new_argv_volatile;
2079 forkin = forkin_volatile;
2080 forkout = forkout_volatile;
2081 forkerr = forkerr_volatile;
2082 p = p_volatile;
2084 pty_flag = p->pty_flag;
2086 if (pid == 0)
2087 #endif /* not WINDOWSNT */
2089 /* Make the pty be the controlling terminal of the process. */
2090 #ifdef HAVE_PTYS
2091 /* First, disconnect its current controlling terminal. */
2092 if (pty_flag)
2093 setsid ();
2094 /* Make the pty's terminal the controlling terminal. */
2095 if (pty_flag && forkin >= 0)
2097 #ifdef TIOCSCTTY
2098 /* We ignore the return value
2099 because faith@cs.unc.edu says that is necessary on Linux. */
2100 ioctl (forkin, TIOCSCTTY, 0);
2101 #endif
2103 #if defined (LDISC1)
2104 if (pty_flag && forkin >= 0)
2106 struct termios t;
2107 tcgetattr (forkin, &t);
2108 t.c_lflag = LDISC1;
2109 if (tcsetattr (forkin, TCSANOW, &t) < 0)
2110 emacs_perror ("create_process/tcsetattr LDISC1");
2112 #else
2113 #if defined (NTTYDISC) && defined (TIOCSETD)
2114 if (pty_flag && forkin >= 0)
2116 /* Use new line discipline. */
2117 int ldisc = NTTYDISC;
2118 ioctl (forkin, TIOCSETD, &ldisc);
2120 #endif
2121 #endif
2122 #ifdef TIOCNOTTY
2123 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
2124 can do TIOCSPGRP only to the process's controlling tty. */
2125 if (pty_flag)
2127 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
2128 I can't test it since I don't have 4.3. */
2129 int j = emacs_open (DEV_TTY, O_RDWR, 0);
2130 if (j >= 0)
2132 ioctl (j, TIOCNOTTY, 0);
2133 emacs_close (j);
2136 #endif /* TIOCNOTTY */
2138 #if !defined (DONT_REOPEN_PTY)
2139 /*** There is a suggestion that this ought to be a
2140 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
2141 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
2142 that system does seem to need this code, even though
2143 both TIOCSCTTY is defined. */
2144 /* Now close the pty (if we had it open) and reopen it.
2145 This makes the pty the controlling terminal of the subprocess. */
2146 if (pty_flag)
2149 /* I wonder if emacs_close (emacs_open (SSDATA (lisp_pty_name), ...))
2150 would work? */
2151 if (forkin >= 0)
2152 emacs_close (forkin);
2153 forkout = forkin = emacs_open (SSDATA (lisp_pty_name), O_RDWR, 0);
2155 if (forkin < 0)
2157 emacs_perror (SSDATA (lisp_pty_name));
2158 _exit (EXIT_CANCELED);
2162 #endif /* not DONT_REOPEN_PTY */
2164 #ifdef SETUP_SLAVE_PTY
2165 if (pty_flag)
2167 SETUP_SLAVE_PTY;
2169 #endif /* SETUP_SLAVE_PTY */
2170 #endif /* HAVE_PTYS */
2172 signal (SIGINT, SIG_DFL);
2173 signal (SIGQUIT, SIG_DFL);
2174 #ifdef SIGPROF
2175 signal (SIGPROF, SIG_DFL);
2176 #endif
2178 /* Emacs ignores SIGPIPE, but the child should not. */
2179 signal (SIGPIPE, SIG_DFL);
2181 /* Stop blocking SIGCHLD in the child. */
2182 unblock_child_signal (&oldset);
2184 if (pty_flag)
2185 child_setup_tty (forkout);
2187 if (forkerr < 0)
2188 forkerr = forkout;
2189 #ifdef WINDOWSNT
2190 pid = child_setup (forkin, forkout, forkerr, new_argv, 1, current_dir);
2191 #else /* not WINDOWSNT */
2192 child_setup (forkin, forkout, forkerr, new_argv, 1, current_dir);
2193 #endif /* not WINDOWSNT */
2196 /* Back in the parent process. */
2198 vfork_errno = errno;
2199 p->pid = pid;
2200 if (pid >= 0)
2201 p->alive = 1;
2203 /* Stop blocking in the parent. */
2204 unblock_child_signal (&oldset);
2205 unblock_input ();
2207 if (pid < 0)
2208 report_file_errno ("Doing vfork", Qnil, vfork_errno);
2209 else
2211 /* vfork succeeded. */
2213 /* Close the pipe ends that the child uses, or the child's pty. */
2214 close_process_fd (&p->open_fd[SUBPROCESS_STDIN]);
2215 close_process_fd (&p->open_fd[SUBPROCESS_STDOUT]);
2217 #ifdef WINDOWSNT
2218 register_child (pid, inchannel);
2219 #endif /* WINDOWSNT */
2221 pset_tty_name (p, lisp_pty_name);
2223 #ifndef WINDOWSNT
2224 /* Wait for child_setup to complete in case that vfork is
2225 actually defined as fork. The descriptor
2226 XPROCESS (proc)->open_fd[EXEC_MONITOR_OUTPUT]
2227 of a pipe is closed at the child side either by close-on-exec
2228 on successful execve or the _exit call in child_setup. */
2230 char dummy;
2232 close_process_fd (&p->open_fd[EXEC_MONITOR_OUTPUT]);
2233 emacs_read (p->open_fd[READ_FROM_EXEC_MONITOR], &dummy, 1);
2234 close_process_fd (&p->open_fd[READ_FROM_EXEC_MONITOR]);
2236 #endif
2237 if (!NILP (p->stderrproc))
2239 struct Lisp_Process *pp = XPROCESS (p->stderrproc);
2240 close_process_fd (&pp->open_fd[SUBPROCESS_STDOUT]);
2245 static void
2246 create_pty (Lisp_Object process)
2248 struct Lisp_Process *p = XPROCESS (process);
2249 char pty_name[PTY_NAME_SIZE];
2250 int pty_fd = !p->pty_flag ? -1 : allocate_pty (pty_name);
2252 if (pty_fd >= 0)
2254 p->open_fd[SUBPROCESS_STDIN] = pty_fd;
2255 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
2256 /* On most USG systems it does not work to open the pty's tty here,
2257 then close it and reopen it in the child. */
2258 /* Don't let this terminal become our controlling terminal
2259 (in case we don't have one). */
2260 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
2261 if (forkout < 0)
2262 report_file_error ("Opening pty", Qnil);
2263 p->open_fd[WRITE_TO_SUBPROCESS] = forkout;
2264 #if defined (DONT_REOPEN_PTY)
2265 /* In the case that vfork is defined as fork, the parent process
2266 (Emacs) may send some data before the child process completes
2267 tty options setup. So we setup tty before forking. */
2268 child_setup_tty (forkout);
2269 #endif /* DONT_REOPEN_PTY */
2270 #endif /* not USG, or USG_SUBTTY_WORKS */
2272 fcntl (pty_fd, F_SETFL, O_NONBLOCK);
2274 /* Record this as an active process, with its channels.
2275 As a result, child_setup will close Emacs's side of the pipes. */
2276 chan_process[pty_fd] = process;
2277 p->infd = pty_fd;
2278 p->outfd = pty_fd;
2280 /* Previously we recorded the tty descriptor used in the subprocess.
2281 It was only used for getting the foreground tty process, so now
2282 we just reopen the device (see emacs_get_tty_pgrp) as this is
2283 more portable (see USG_SUBTTY_WORKS above). */
2285 p->pty_flag = 1;
2286 pset_status (p, Qrun);
2287 setup_process_coding_systems (process);
2289 add_process_read_fd (pty_fd);
2291 pset_tty_name (p, build_string (pty_name));
2294 p->pid = -2;
2297 DEFUN ("make-pipe-process", Fmake_pipe_process, Smake_pipe_process,
2298 0, MANY, 0,
2299 doc: /* Create and return a bidirectional pipe process.
2301 In Emacs, pipes are represented by process objects, so input and
2302 output work as for subprocesses, and `delete-process' closes a pipe.
2303 However, a pipe process has no process id, it cannot be signaled,
2304 and the status codes are different from normal processes.
2306 Arguments are specified as keyword/argument pairs. The following
2307 arguments are defined:
2309 :name NAME -- NAME is the name of the process. It is modified if necessary to make it unique.
2311 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2312 with the process. Process output goes at the end of that buffer,
2313 unless you specify an output stream or filter function to handle the
2314 output. If BUFFER is not given, the value of NAME is used.
2316 :coding CODING -- If CODING is a symbol, it specifies the coding
2317 system used for both reading and writing for this process. If CODING
2318 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2319 ENCODING is used for writing.
2321 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2322 the process is running. If BOOL is not given, query before exiting.
2324 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2325 In the stopped state, a pipe process does not accept incoming data,
2326 but you can send outgoing data. The stopped state is cleared by
2327 `continue-process' and set by `stop-process'.
2329 :filter FILTER -- Install FILTER as the process filter.
2331 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2333 usage: (make-pipe-process &rest ARGS) */)
2334 (ptrdiff_t nargs, Lisp_Object *args)
2336 Lisp_Object proc, contact;
2337 struct Lisp_Process *p;
2338 Lisp_Object name, buffer;
2339 Lisp_Object tem;
2340 ptrdiff_t specpdl_count;
2341 int inchannel, outchannel;
2343 if (nargs == 0)
2344 return Qnil;
2346 contact = Flist (nargs, args);
2348 name = Fplist_get (contact, QCname);
2349 CHECK_STRING (name);
2350 proc = make_process (name);
2351 specpdl_count = SPECPDL_INDEX ();
2352 record_unwind_protect (remove_process, proc);
2353 p = XPROCESS (proc);
2355 if (emacs_pipe (p->open_fd + SUBPROCESS_STDIN) != 0
2356 || emacs_pipe (p->open_fd + READ_FROM_SUBPROCESS) != 0)
2357 report_file_error ("Creating pipe", Qnil);
2358 outchannel = p->open_fd[WRITE_TO_SUBPROCESS];
2359 inchannel = p->open_fd[READ_FROM_SUBPROCESS];
2361 fcntl (inchannel, F_SETFL, O_NONBLOCK);
2362 fcntl (outchannel, F_SETFL, O_NONBLOCK);
2364 #ifdef WINDOWSNT
2365 register_aux_fd (inchannel);
2366 #endif
2368 /* Record this as an active process, with its channels. */
2369 chan_process[inchannel] = proc;
2370 p->infd = inchannel;
2371 p->outfd = outchannel;
2373 if (inchannel > max_desc)
2374 max_desc = inchannel;
2376 buffer = Fplist_get (contact, QCbuffer);
2377 if (NILP (buffer))
2378 buffer = name;
2379 buffer = Fget_buffer_create (buffer);
2380 pset_buffer (p, buffer);
2382 pset_childp (p, contact);
2383 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2384 pset_type (p, Qpipe);
2385 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2386 pset_filter (p, Fplist_get (contact, QCfilter));
2387 eassert (NILP (p->log));
2388 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2389 p->kill_without_query = 1;
2390 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2391 pset_command (p, Qt);
2392 eassert (! p->pty_flag);
2394 if (!EQ (p->command, Qt))
2395 add_process_read_fd (inchannel);
2396 p->adaptive_read_buffering
2397 = (NILP (Vprocess_adaptive_read_buffering) ? 0
2398 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
2400 /* Make the process marker point into the process buffer (if any). */
2401 if (BUFFERP (buffer))
2402 set_marker_both (p->mark, buffer,
2403 BUF_ZV (XBUFFER (buffer)),
2404 BUF_ZV_BYTE (XBUFFER (buffer)));
2407 /* Setup coding systems for communicating with the network stream. */
2409 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
2410 Lisp_Object coding_systems = Qt;
2411 Lisp_Object val;
2413 tem = Fplist_get (contact, QCcoding);
2414 val = Qnil;
2415 if (!NILP (tem))
2417 val = tem;
2418 if (CONSP (val))
2419 val = XCAR (val);
2421 else if (!NILP (Vcoding_system_for_read))
2422 val = Vcoding_system_for_read;
2423 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2424 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2425 /* We dare not decode end-of-line format by setting VAL to
2426 Qraw_text, because the existing Emacs Lisp libraries
2427 assume that they receive bare code including a sequence of
2428 CR LF. */
2429 val = Qnil;
2430 else
2432 if (CONSP (coding_systems))
2433 val = XCAR (coding_systems);
2434 else if (CONSP (Vdefault_process_coding_system))
2435 val = XCAR (Vdefault_process_coding_system);
2436 else
2437 val = Qnil;
2439 pset_decode_coding_system (p, val);
2441 if (!NILP (tem))
2443 val = tem;
2444 if (CONSP (val))
2445 val = XCDR (val);
2447 else if (!NILP (Vcoding_system_for_write))
2448 val = Vcoding_system_for_write;
2449 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2450 val = Qnil;
2451 else
2453 if (CONSP (coding_systems))
2454 val = XCDR (coding_systems);
2455 else if (CONSP (Vdefault_process_coding_system))
2456 val = XCDR (Vdefault_process_coding_system);
2457 else
2458 val = Qnil;
2460 pset_encode_coding_system (p, val);
2462 /* This may signal an error. */
2463 setup_process_coding_systems (proc);
2465 specpdl_ptr = specpdl + specpdl_count;
2467 return proc;
2471 /* Convert an internal struct sockaddr to a lisp object (vector or string).
2472 The address family of sa is not included in the result. */
2474 Lisp_Object
2475 conv_sockaddr_to_lisp (struct sockaddr *sa, ptrdiff_t len)
2477 Lisp_Object address;
2478 ptrdiff_t i;
2479 unsigned char *cp;
2480 struct Lisp_Vector *p;
2482 /* Workaround for a bug in getsockname on BSD: Names bound to
2483 sockets in the UNIX domain are inaccessible; getsockname returns
2484 a zero length name. */
2485 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
2486 return empty_unibyte_string;
2488 switch (sa->sa_family)
2490 case AF_INET:
2492 DECLARE_POINTER_ALIAS (sin, struct sockaddr_in, sa);
2493 len = sizeof (sin->sin_addr) + 1;
2494 address = Fmake_vector (make_number (len), Qnil);
2495 p = XVECTOR (address);
2496 p->contents[--len] = make_number (ntohs (sin->sin_port));
2497 cp = (unsigned char *) &sin->sin_addr;
2498 break;
2500 #ifdef AF_INET6
2501 case AF_INET6:
2503 DECLARE_POINTER_ALIAS (sin6, struct sockaddr_in6, sa);
2504 DECLARE_POINTER_ALIAS (ip6, uint16_t, &sin6->sin6_addr);
2505 len = sizeof (sin6->sin6_addr) / 2 + 1;
2506 address = Fmake_vector (make_number (len), Qnil);
2507 p = XVECTOR (address);
2508 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2509 for (i = 0; i < len; i++)
2510 p->contents[i] = make_number (ntohs (ip6[i]));
2511 return address;
2513 #endif
2514 #ifdef HAVE_LOCAL_SOCKETS
2515 case AF_LOCAL:
2517 DECLARE_POINTER_ALIAS (sockun, struct sockaddr_un, sa);
2518 ptrdiff_t name_length = len - offsetof (struct sockaddr_un, sun_path);
2519 /* If the first byte is NUL, the name is a Linux abstract
2520 socket name, and the name can contain embedded NULs. If
2521 it's not, we have a NUL-terminated string. Be careful not
2522 to walk past the end of the object looking for the name
2523 terminator, however. */
2524 if (name_length > 0 && sockun->sun_path[0] != '\0')
2526 const char *terminator
2527 = memchr (sockun->sun_path, '\0', name_length);
2529 if (terminator)
2530 name_length = terminator - (const char *) sockun->sun_path;
2533 return make_unibyte_string (sockun->sun_path, name_length);
2535 #endif
2536 default:
2537 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2538 address = Fcons (make_number (sa->sa_family),
2539 Fmake_vector (make_number (len), Qnil));
2540 p = XVECTOR (XCDR (address));
2541 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2542 break;
2545 i = 0;
2546 while (i < len)
2547 p->contents[i++] = make_number (*cp++);
2549 return address;
2552 /* Convert an internal struct addrinfo to a Lisp object. */
2554 static Lisp_Object
2555 conv_addrinfo_to_lisp (struct addrinfo *res)
2557 Lisp_Object protocol = make_number (res->ai_protocol);
2558 eassert (XINT (protocol) == res->ai_protocol);
2559 return Fcons (protocol, conv_sockaddr_to_lisp (res->ai_addr, res->ai_addrlen));
2563 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2565 static ptrdiff_t
2566 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2568 struct Lisp_Vector *p;
2570 if (VECTORP (address))
2572 p = XVECTOR (address);
2573 if (p->header.size == 5)
2575 *familyp = AF_INET;
2576 return sizeof (struct sockaddr_in);
2578 #ifdef AF_INET6
2579 else if (p->header.size == 9)
2581 *familyp = AF_INET6;
2582 return sizeof (struct sockaddr_in6);
2584 #endif
2586 #ifdef HAVE_LOCAL_SOCKETS
2587 else if (STRINGP (address))
2589 *familyp = AF_LOCAL;
2590 return sizeof (struct sockaddr_un);
2592 #endif
2593 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2594 && VECTORP (XCDR (address)))
2596 struct sockaddr *sa;
2597 p = XVECTOR (XCDR (address));
2598 if (MAX_ALLOCA - sizeof sa->sa_family < p->header.size)
2599 return 0;
2600 *familyp = XINT (XCAR (address));
2601 return p->header.size + sizeof (sa->sa_family);
2603 return 0;
2606 /* Convert an address object (vector or string) to an internal sockaddr.
2608 The address format has been basically validated by
2609 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2610 it could have come from user data. So if FAMILY is not valid,
2611 we return after zeroing *SA. */
2613 static void
2614 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2616 register struct Lisp_Vector *p;
2617 register unsigned char *cp = NULL;
2618 register int i;
2619 EMACS_INT hostport;
2621 memset (sa, 0, len);
2623 if (VECTORP (address))
2625 p = XVECTOR (address);
2626 if (family == AF_INET)
2628 DECLARE_POINTER_ALIAS (sin, struct sockaddr_in, sa);
2629 len = sizeof (sin->sin_addr) + 1;
2630 hostport = XINT (p->contents[--len]);
2631 sin->sin_port = htons (hostport);
2632 cp = (unsigned char *)&sin->sin_addr;
2633 sa->sa_family = family;
2635 #ifdef AF_INET6
2636 else if (family == AF_INET6)
2638 DECLARE_POINTER_ALIAS (sin6, struct sockaddr_in6, sa);
2639 DECLARE_POINTER_ALIAS (ip6, uint16_t, &sin6->sin6_addr);
2640 len = sizeof (sin6->sin6_addr) / 2 + 1;
2641 hostport = XINT (p->contents[--len]);
2642 sin6->sin6_port = htons (hostport);
2643 for (i = 0; i < len; i++)
2644 if (INTEGERP (p->contents[i]))
2646 int j = XFASTINT (p->contents[i]) & 0xffff;
2647 ip6[i] = ntohs (j);
2649 sa->sa_family = family;
2650 return;
2652 #endif
2653 else
2654 return;
2656 else if (STRINGP (address))
2658 #ifdef HAVE_LOCAL_SOCKETS
2659 if (family == AF_LOCAL)
2661 DECLARE_POINTER_ALIAS (sockun, struct sockaddr_un, sa);
2662 cp = SDATA (address);
2663 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2664 sockun->sun_path[i] = *cp++;
2665 sa->sa_family = family;
2667 #endif
2668 return;
2670 else
2672 p = XVECTOR (XCDR (address));
2673 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2676 for (i = 0; i < len; i++)
2677 if (INTEGERP (p->contents[i]))
2678 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2681 #ifdef DATAGRAM_SOCKETS
2682 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2683 1, 1, 0,
2684 doc: /* Get the current datagram address associated with PROCESS.
2685 If PROCESS is a non-blocking network process that hasn't been fully
2686 set up yet, this function will block until socket setup has completed. */)
2687 (Lisp_Object process)
2689 int channel;
2691 CHECK_PROCESS (process);
2693 if (NETCONN_P (process))
2694 wait_for_socket_fds (process, "process-datagram-address");
2696 if (!DATAGRAM_CONN_P (process))
2697 return Qnil;
2699 channel = XPROCESS (process)->infd;
2700 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2701 datagram_address[channel].len);
2704 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2705 2, 2, 0,
2706 doc: /* Set the datagram address for PROCESS to ADDRESS.
2707 Return nil upon error setting address, ADDRESS otherwise.
2709 If PROCESS is a non-blocking network process that hasn't been fully
2710 set up yet, this function will block until socket setup has completed. */)
2711 (Lisp_Object process, Lisp_Object address)
2713 int channel;
2714 int family;
2715 ptrdiff_t len;
2717 CHECK_PROCESS (process);
2719 if (NETCONN_P (process))
2720 wait_for_socket_fds (process, "set-process-datagram-address");
2722 if (!DATAGRAM_CONN_P (process))
2723 return Qnil;
2725 channel = XPROCESS (process)->infd;
2727 len = get_lisp_to_sockaddr_size (address, &family);
2728 if (len == 0 || datagram_address[channel].len != len)
2729 return Qnil;
2730 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2731 return address;
2733 #endif
2736 static const struct socket_options {
2737 /* The name of this option. Should be lowercase version of option
2738 name without SO_ prefix. */
2739 const char *name;
2740 /* Option level SOL_... */
2741 int optlevel;
2742 /* Option number SO_... */
2743 int optnum;
2744 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2745 enum { OPIX_NONE = 0, OPIX_MISC = 1, OPIX_REUSEADDR = 2 } optbit;
2746 } socket_options[] =
2748 #ifdef SO_BINDTODEVICE
2749 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2750 #endif
2751 #ifdef SO_BROADCAST
2752 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2753 #endif
2754 #ifdef SO_DONTROUTE
2755 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2756 #endif
2757 #ifdef SO_KEEPALIVE
2758 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2759 #endif
2760 #ifdef SO_LINGER
2761 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2762 #endif
2763 #ifdef SO_OOBINLINE
2764 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2765 #endif
2766 #ifdef SO_PRIORITY
2767 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2768 #endif
2769 #ifdef SO_REUSEADDR
2770 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2771 #endif
2772 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2775 /* Set option OPT to value VAL on socket S.
2777 Return (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2778 Signals an error if setting a known option fails.
2781 static int
2782 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2784 char *name;
2785 const struct socket_options *sopt;
2786 int ret = 0;
2788 CHECK_SYMBOL (opt);
2790 name = SSDATA (SYMBOL_NAME (opt));
2791 for (sopt = socket_options; sopt->name; sopt++)
2792 if (strcmp (name, sopt->name) == 0)
2793 break;
2795 switch (sopt->opttype)
2797 case SOPT_BOOL:
2799 int optval;
2800 optval = NILP (val) ? 0 : 1;
2801 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2802 &optval, sizeof (optval));
2803 break;
2806 case SOPT_INT:
2808 int optval;
2809 if (TYPE_RANGED_INTEGERP (int, val))
2810 optval = XINT (val);
2811 else
2812 error ("Bad option value for %s", name);
2813 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2814 &optval, sizeof (optval));
2815 break;
2818 #ifdef SO_BINDTODEVICE
2819 case SOPT_IFNAME:
2821 char devname[IFNAMSIZ + 1];
2823 /* This is broken, at least in the Linux 2.4 kernel.
2824 To unbind, the arg must be a zero integer, not the empty string.
2825 This should work on all systems. KFS. 2003-09-23. */
2826 memset (devname, 0, sizeof devname);
2827 if (STRINGP (val))
2829 char *arg = SSDATA (val);
2830 int len = min (strlen (arg), IFNAMSIZ);
2831 memcpy (devname, arg, len);
2833 else if (!NILP (val))
2834 error ("Bad option value for %s", name);
2835 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2836 devname, IFNAMSIZ);
2837 break;
2839 #endif
2841 #ifdef SO_LINGER
2842 case SOPT_LINGER:
2844 struct linger linger;
2846 linger.l_onoff = 1;
2847 linger.l_linger = 0;
2848 if (TYPE_RANGED_INTEGERP (int, val))
2849 linger.l_linger = XINT (val);
2850 else
2851 linger.l_onoff = NILP (val) ? 0 : 1;
2852 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2853 &linger, sizeof (linger));
2854 break;
2856 #endif
2858 default:
2859 return 0;
2862 if (ret < 0)
2864 int setsockopt_errno = errno;
2865 report_file_errno ("Cannot set network option", list2 (opt, val),
2866 setsockopt_errno);
2869 return (1 << sopt->optbit);
2873 DEFUN ("set-network-process-option",
2874 Fset_network_process_option, Sset_network_process_option,
2875 3, 4, 0,
2876 doc: /* For network process PROCESS set option OPTION to value VALUE.
2877 See `make-network-process' for a list of options and values.
2878 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2879 OPTION is not a supported option, return nil instead; otherwise return t.
2881 If PROCESS is a non-blocking network process that hasn't been fully
2882 set up yet, this function will block until socket setup has completed. */)
2883 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2885 int s;
2886 struct Lisp_Process *p;
2888 CHECK_PROCESS (process);
2889 p = XPROCESS (process);
2890 if (!NETCONN1_P (p))
2891 error ("Process is not a network process");
2893 wait_for_socket_fds (process, "set-network-process-option");
2895 s = p->infd;
2896 if (s < 0)
2897 error ("Process is not running");
2899 if (set_socket_option (s, option, value))
2901 pset_childp (p, Fplist_put (p->childp, option, value));
2902 return Qt;
2905 if (NILP (no_error))
2906 error ("Unknown or unsupported option");
2908 return Qnil;
2912 DEFUN ("serial-process-configure",
2913 Fserial_process_configure,
2914 Sserial_process_configure,
2915 0, MANY, 0,
2916 doc: /* Configure speed, bytesize, etc. of a serial process.
2918 Arguments are specified as keyword/argument pairs. Attributes that
2919 are not given are re-initialized from the process's current
2920 configuration (available via the function `process-contact') or set to
2921 reasonable default values. The following arguments are defined:
2923 :process PROCESS
2924 :name NAME
2925 :buffer BUFFER
2926 :port PORT
2927 -- Any of these arguments can be given to identify the process that is
2928 to be configured. If none of these arguments is given, the current
2929 buffer's process is used.
2931 :speed SPEED -- SPEED is the speed of the serial port in bits per
2932 second, also called baud rate. Any value can be given for SPEED, but
2933 most serial ports work only at a few defined values between 1200 and
2934 115200, with 9600 being the most common value. If SPEED is nil, the
2935 serial port is not configured any further, i.e., all other arguments
2936 are ignored. This may be useful for special serial ports such as
2937 Bluetooth-to-serial converters which can only be configured through AT
2938 commands. A value of nil for SPEED can be used only when passed
2939 through `make-serial-process' or `serial-term'.
2941 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2942 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2944 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2945 `odd' (use odd parity), or the symbol `even' (use even parity). If
2946 PARITY is not given, no parity is used.
2948 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2949 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2950 is not given or nil, 1 stopbit is used.
2952 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2953 flowcontrol to be used, which is either nil (don't use flowcontrol),
2954 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2955 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2956 flowcontrol is used.
2958 `serial-process-configure' is called by `make-serial-process' for the
2959 initial configuration of the serial port.
2961 Examples:
2963 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2965 \(serial-process-configure
2966 :buffer "COM1" :stopbits 1 :parity \\='odd :flowcontrol \\='hw)
2968 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2970 usage: (serial-process-configure &rest ARGS) */)
2971 (ptrdiff_t nargs, Lisp_Object *args)
2973 struct Lisp_Process *p;
2974 Lisp_Object contact = Qnil;
2975 Lisp_Object proc = Qnil;
2977 contact = Flist (nargs, args);
2979 proc = Fplist_get (contact, QCprocess);
2980 if (NILP (proc))
2981 proc = Fplist_get (contact, QCname);
2982 if (NILP (proc))
2983 proc = Fplist_get (contact, QCbuffer);
2984 if (NILP (proc))
2985 proc = Fplist_get (contact, QCport);
2986 proc = get_process (proc);
2987 p = XPROCESS (proc);
2988 if (!EQ (p->type, Qserial))
2989 error ("Not a serial process");
2991 if (NILP (Fplist_get (p->childp, QCspeed)))
2992 return Qnil;
2994 serial_configure (p, contact);
2995 return Qnil;
2998 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2999 0, MANY, 0,
3000 doc: /* Create and return a serial port process.
3002 In Emacs, serial port connections are represented by process objects,
3003 so input and output work as for subprocesses, and `delete-process'
3004 closes a serial port connection. However, a serial process has no
3005 process id, it cannot be signaled, and the status codes are different
3006 from normal processes.
3008 `make-serial-process' creates a process and a buffer, on which you
3009 probably want to use `process-send-string'. Try \\[serial-term] for
3010 an interactive terminal. See below for examples.
3012 Arguments are specified as keyword/argument pairs. The following
3013 arguments are defined:
3015 :port PORT -- (mandatory) PORT is the path or name of the serial port.
3016 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
3017 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
3018 the backslashes in strings).
3020 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
3021 which this function calls.
3023 :name NAME -- NAME is the name of the process. If NAME is not given,
3024 the value of PORT is used.
3026 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
3027 with the process. Process output goes at the end of that buffer,
3028 unless you specify an output stream or filter function to handle the
3029 output. If BUFFER is not given, the value of NAME is used.
3031 :coding CODING -- If CODING is a symbol, it specifies the coding
3032 system used for both reading and writing for this process. If CODING
3033 is a cons (DECODING . ENCODING), DECODING is used for reading, and
3034 ENCODING is used for writing.
3036 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
3037 the process is running. If BOOL is not given, query before exiting.
3039 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
3040 In the stopped state, a serial process does not accept incoming data,
3041 but you can send outgoing data. The stopped state is cleared by
3042 `continue-process' and set by `stop-process'.
3044 :filter FILTER -- Install FILTER as the process filter.
3046 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
3048 :plist PLIST -- Install PLIST as the initial plist of the process.
3050 :bytesize
3051 :parity
3052 :stopbits
3053 :flowcontrol
3054 -- This function calls `serial-process-configure' to handle these
3055 arguments.
3057 The original argument list, possibly modified by later configuration,
3058 is available via the function `process-contact'.
3060 Examples:
3062 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
3064 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
3066 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity \\='odd)
3068 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
3070 usage: (make-serial-process &rest ARGS) */)
3071 (ptrdiff_t nargs, Lisp_Object *args)
3073 int fd = -1;
3074 Lisp_Object proc, contact, port;
3075 struct Lisp_Process *p;
3076 Lisp_Object name, buffer;
3077 Lisp_Object tem, val;
3078 ptrdiff_t specpdl_count;
3080 if (nargs == 0)
3081 return Qnil;
3083 contact = Flist (nargs, args);
3085 port = Fplist_get (contact, QCport);
3086 if (NILP (port))
3087 error ("No port specified");
3088 CHECK_STRING (port);
3090 if (NILP (Fplist_member (contact, QCspeed)))
3091 error (":speed not specified");
3092 if (!NILP (Fplist_get (contact, QCspeed)))
3093 CHECK_NUMBER (Fplist_get (contact, QCspeed));
3095 name = Fplist_get (contact, QCname);
3096 if (NILP (name))
3097 name = port;
3098 CHECK_STRING (name);
3099 proc = make_process (name);
3100 specpdl_count = SPECPDL_INDEX ();
3101 record_unwind_protect (remove_process, proc);
3102 p = XPROCESS (proc);
3104 fd = serial_open (port);
3105 p->open_fd[SUBPROCESS_STDIN] = fd;
3106 p->infd = fd;
3107 p->outfd = fd;
3108 if (fd > max_desc)
3109 max_desc = fd;
3110 chan_process[fd] = proc;
3112 buffer = Fplist_get (contact, QCbuffer);
3113 if (NILP (buffer))
3114 buffer = name;
3115 buffer = Fget_buffer_create (buffer);
3116 pset_buffer (p, buffer);
3118 pset_childp (p, contact);
3119 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3120 pset_type (p, Qserial);
3121 pset_sentinel (p, Fplist_get (contact, QCsentinel));
3122 pset_filter (p, Fplist_get (contact, QCfilter));
3123 eassert (NILP (p->log));
3124 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3125 p->kill_without_query = 1;
3126 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
3127 pset_command (p, Qt);
3128 eassert (! p->pty_flag);
3130 if (!EQ (p->command, Qt))
3131 add_process_read_fd (fd);
3133 if (BUFFERP (buffer))
3135 set_marker_both (p->mark, buffer,
3136 BUF_ZV (XBUFFER (buffer)),
3137 BUF_ZV_BYTE (XBUFFER (buffer)));
3140 tem = Fplist_member (contact, QCcoding);
3141 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3142 tem = Qnil;
3144 val = Qnil;
3145 if (!NILP (tem))
3147 val = XCAR (XCDR (tem));
3148 if (CONSP (val))
3149 val = XCAR (val);
3151 else if (!NILP (Vcoding_system_for_read))
3152 val = Vcoding_system_for_read;
3153 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3154 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3155 val = Qnil;
3156 pset_decode_coding_system (p, val);
3158 val = Qnil;
3159 if (!NILP (tem))
3161 val = XCAR (XCDR (tem));
3162 if (CONSP (val))
3163 val = XCDR (val);
3165 else if (!NILP (Vcoding_system_for_write))
3166 val = Vcoding_system_for_write;
3167 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3168 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3169 val = Qnil;
3170 pset_encode_coding_system (p, val);
3172 setup_process_coding_systems (proc);
3173 pset_decoding_buf (p, empty_unibyte_string);
3174 eassert (p->decoding_carryover == 0);
3175 pset_encoding_buf (p, empty_unibyte_string);
3176 p->inherit_coding_system_flag
3177 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3179 Fserial_process_configure (nargs, args);
3181 specpdl_ptr = specpdl + specpdl_count;
3183 return proc;
3186 static void
3187 set_network_socket_coding_system (Lisp_Object proc, Lisp_Object host,
3188 Lisp_Object service, Lisp_Object name)
3190 Lisp_Object tem;
3191 struct Lisp_Process *p = XPROCESS (proc);
3192 Lisp_Object contact = p->childp;
3193 Lisp_Object coding_systems = Qt;
3194 Lisp_Object val;
3196 tem = Fplist_member (contact, QCcoding);
3197 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3198 tem = Qnil; /* No error message (too late!). */
3200 /* Setup coding systems for communicating with the network stream. */
3201 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3203 if (!NILP (tem))
3205 val = XCAR (XCDR (tem));
3206 if (CONSP (val))
3207 val = XCAR (val);
3209 else if (!NILP (Vcoding_system_for_read))
3210 val = Vcoding_system_for_read;
3211 else if ((!NILP (p->buffer)
3212 && NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
3213 || (NILP (p->buffer)
3214 && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3215 /* We dare not decode end-of-line format by setting VAL to
3216 Qraw_text, because the existing Emacs Lisp libraries
3217 assume that they receive bare code including a sequence of
3218 CR LF. */
3219 val = Qnil;
3220 else
3222 if (NILP (host) || NILP (service))
3223 coding_systems = Qnil;
3224 else
3225 coding_systems = CALLN (Ffind_operation_coding_system,
3226 Qopen_network_stream, name, p->buffer,
3227 host, service);
3228 if (CONSP (coding_systems))
3229 val = XCAR (coding_systems);
3230 else if (CONSP (Vdefault_process_coding_system))
3231 val = XCAR (Vdefault_process_coding_system);
3232 else
3233 val = Qnil;
3235 pset_decode_coding_system (p, val);
3237 if (!NILP (tem))
3239 val = XCAR (XCDR (tem));
3240 if (CONSP (val))
3241 val = XCDR (val);
3243 else if (!NILP (Vcoding_system_for_write))
3244 val = Vcoding_system_for_write;
3245 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3246 val = Qnil;
3247 else
3249 if (EQ (coding_systems, Qt))
3251 if (NILP (host) || NILP (service))
3252 coding_systems = Qnil;
3253 else
3254 coding_systems = CALLN (Ffind_operation_coding_system,
3255 Qopen_network_stream, name, p->buffer,
3256 host, service);
3258 if (CONSP (coding_systems))
3259 val = XCDR (coding_systems);
3260 else if (CONSP (Vdefault_process_coding_system))
3261 val = XCDR (Vdefault_process_coding_system);
3262 else
3263 val = Qnil;
3265 pset_encode_coding_system (p, val);
3267 pset_decoding_buf (p, empty_unibyte_string);
3268 p->decoding_carryover = 0;
3269 pset_encoding_buf (p, empty_unibyte_string);
3271 p->inherit_coding_system_flag
3272 = !(!NILP (tem) || NILP (p->buffer) || !inherit_process_coding_system);
3275 #ifdef HAVE_GNUTLS
3276 static void
3277 finish_after_tls_connection (Lisp_Object proc)
3279 struct Lisp_Process *p = XPROCESS (proc);
3280 Lisp_Object contact = p->childp;
3281 Lisp_Object result = Qt;
3283 if (!NILP (Ffboundp (Qnsm_verify_connection)))
3284 result = call3 (Qnsm_verify_connection,
3285 proc,
3286 Fplist_get (contact, QChost),
3287 Fplist_get (contact, QCservice));
3289 if (NILP (result))
3291 pset_status (p, list2 (Qfailed,
3292 build_string ("The Network Security Manager stopped the connections")));
3293 deactivate_process (proc);
3295 else if (p->outfd < 0)
3297 /* The counterparty may have closed the connection (especially
3298 if the NSM prompt above take a long time), so recheck the file
3299 descriptor here. */
3300 pset_status (p, Qfailed);
3301 deactivate_process (proc);
3303 else if ((fd_callback_info[p->outfd].flags & NON_BLOCKING_CONNECT_FD) == 0)
3305 /* If we cleared the connection wait mask before we did the TLS
3306 setup, then we have to say that the process is finally "open"
3307 here. */
3308 pset_status (p, Qrun);
3309 /* Execute the sentinel here. If we had relied on status_notify
3310 to do it later, it will read input from the process before
3311 calling the sentinel. */
3312 exec_sentinel (proc, build_string ("open\n"));
3315 #endif
3317 static void
3318 connect_network_socket (Lisp_Object proc, Lisp_Object addrinfos,
3319 Lisp_Object use_external_socket_p)
3321 ptrdiff_t count = SPECPDL_INDEX ();
3322 int s = -1, outch, inch;
3323 int xerrno = 0;
3324 int family;
3325 struct sockaddr *sa = NULL;
3326 int ret;
3327 ptrdiff_t addrlen;
3328 struct Lisp_Process *p = XPROCESS (proc);
3329 Lisp_Object contact = p->childp;
3330 int optbits = 0;
3331 int socket_to_use = -1;
3333 if (!NILP (use_external_socket_p))
3335 socket_to_use = external_sock_fd;
3337 /* Ensure we don't consume the external socket twice. */
3338 external_sock_fd = -1;
3341 /* Do this in case we never enter the while-loop below. */
3342 s = -1;
3344 while (!NILP (addrinfos))
3346 Lisp_Object addrinfo = XCAR (addrinfos);
3347 addrinfos = XCDR (addrinfos);
3348 int protocol = XINT (XCAR (addrinfo));
3349 Lisp_Object ip_address = XCDR (addrinfo);
3351 #ifdef WINDOWSNT
3352 retry_connect:
3353 #endif
3355 addrlen = get_lisp_to_sockaddr_size (ip_address, &family);
3356 if (sa)
3357 free (sa);
3358 sa = xmalloc (addrlen);
3359 conv_lisp_to_sockaddr (family, ip_address, sa, addrlen);
3361 s = socket_to_use;
3362 if (s < 0)
3364 int socktype = p->socktype | SOCK_CLOEXEC;
3365 if (p->is_non_blocking_client)
3366 socktype |= SOCK_NONBLOCK;
3367 s = socket (family, socktype, protocol);
3368 if (s < 0)
3370 xerrno = errno;
3371 continue;
3375 if (p->is_non_blocking_client && ! (SOCK_NONBLOCK && socket_to_use < 0))
3377 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3378 if (ret < 0)
3380 xerrno = errno;
3381 emacs_close (s);
3382 s = -1;
3383 if (0 <= socket_to_use)
3384 break;
3385 continue;
3389 #ifdef DATAGRAM_SOCKETS
3390 if (!p->is_server && p->socktype == SOCK_DGRAM)
3391 break;
3392 #endif /* DATAGRAM_SOCKETS */
3394 /* Make us close S if quit. */
3395 record_unwind_protect_int (close_file_unwind, s);
3397 /* Parse network options in the arg list. We simply ignore anything
3398 which isn't a known option (including other keywords). An error
3399 is signaled if setting a known option fails. */
3401 Lisp_Object params = contact, key, val;
3403 while (!NILP (params))
3405 key = XCAR (params);
3406 params = XCDR (params);
3407 val = XCAR (params);
3408 params = XCDR (params);
3409 optbits |= set_socket_option (s, key, val);
3413 if (p->is_server)
3415 /* Configure as a server socket. */
3417 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3418 explicit :reuseaddr key to override this. */
3419 #ifdef HAVE_LOCAL_SOCKETS
3420 if (family != AF_LOCAL)
3421 #endif
3422 if (!(optbits & (1 << OPIX_REUSEADDR)))
3424 int optval = 1;
3425 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3426 report_file_error ("Cannot set reuse option on server socket", Qnil);
3429 /* If passed a socket descriptor, it should be already bound. */
3430 if (socket_to_use < 0 && bind (s, sa, addrlen) != 0)
3431 report_file_error ("Cannot bind server socket", Qnil);
3433 #ifdef HAVE_GETSOCKNAME
3434 if (p->port == 0
3435 #ifdef HAVE_LOCAL_SOCKETS
3436 && family != AF_LOCAL
3437 #endif
3440 struct sockaddr_in sa1;
3441 socklen_t len1 = sizeof (sa1);
3442 #ifdef AF_INET6
3443 /* The code below assumes the port is at the same offset
3444 and of the same width in both IPv4 and IPv6
3445 structures, but the standards don't guarantee that,
3446 so verify it here. */
3447 struct sockaddr_in6 sa6;
3448 verify ((offsetof (struct sockaddr_in, sin_port)
3449 == offsetof (struct sockaddr_in6, sin6_port))
3450 && sizeof (sa1.sin_port) == sizeof (sa6.sin6_port));
3451 #endif
3452 DECLARE_POINTER_ALIAS (psa1, struct sockaddr, &sa1);
3453 if (getsockname (s, psa1, &len1) == 0)
3455 Lisp_Object service = make_number (ntohs (sa1.sin_port));
3456 contact = Fplist_put (contact, QCservice, service);
3457 /* Save the port number so that we can stash it in
3458 the process object later. */
3459 DECLARE_POINTER_ALIAS (psa, struct sockaddr_in, sa);
3460 psa->sin_port = sa1.sin_port;
3463 #endif
3465 if (p->socktype != SOCK_DGRAM && listen (s, p->backlog))
3466 report_file_error ("Cannot listen on server socket", Qnil);
3468 break;
3471 maybe_quit ();
3473 ret = connect (s, sa, addrlen);
3474 xerrno = errno;
3476 if (ret == 0 || xerrno == EISCONN)
3478 /* The unwind-protect will be discarded afterwards. */
3479 break;
3482 if (p->is_non_blocking_client && xerrno == EINPROGRESS)
3483 break;
3485 #ifndef WINDOWSNT
3486 if (xerrno == EINTR)
3488 /* Unlike most other syscalls connect() cannot be called
3489 again. (That would return EALREADY.) The proper way to
3490 wait for completion is pselect(). */
3491 int sc;
3492 socklen_t len;
3493 fd_set fdset;
3494 retry_select:
3495 FD_ZERO (&fdset);
3496 FD_SET (s, &fdset);
3497 maybe_quit ();
3498 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3499 if (sc == -1)
3501 if (errno == EINTR)
3502 goto retry_select;
3503 else
3504 report_file_error ("Failed select", Qnil);
3506 eassert (sc > 0);
3508 len = sizeof xerrno;
3509 eassert (FD_ISSET (s, &fdset));
3510 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) < 0)
3511 report_file_error ("Failed getsockopt", Qnil);
3512 if (xerrno == 0)
3513 break;
3514 if (NILP (addrinfos))
3515 report_file_errno ("Failed connect", Qnil, xerrno);
3517 #endif /* !WINDOWSNT */
3519 /* Discard the unwind protect closing S. */
3520 specpdl_ptr = specpdl + count;
3521 emacs_close (s);
3522 s = -1;
3523 if (0 <= socket_to_use)
3524 break;
3526 #ifdef WINDOWSNT
3527 if (xerrno == EINTR)
3528 goto retry_connect;
3529 #endif
3532 if (s >= 0)
3534 #ifdef DATAGRAM_SOCKETS
3535 if (p->socktype == SOCK_DGRAM)
3537 if (datagram_address[s].sa)
3538 emacs_abort ();
3540 datagram_address[s].sa = xmalloc (addrlen);
3541 datagram_address[s].len = addrlen;
3542 if (p->is_server)
3544 Lisp_Object remote;
3545 memset (datagram_address[s].sa, 0, addrlen);
3546 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3548 int rfamily;
3549 ptrdiff_t rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3550 if (rlen != 0 && rfamily == family
3551 && rlen == addrlen)
3552 conv_lisp_to_sockaddr (rfamily, remote,
3553 datagram_address[s].sa, rlen);
3556 else
3557 memcpy (datagram_address[s].sa, sa, addrlen);
3559 #endif
3561 contact = Fplist_put (contact, p->is_server? QClocal: QCremote,
3562 conv_sockaddr_to_lisp (sa, addrlen));
3563 #ifdef HAVE_GETSOCKNAME
3564 if (!p->is_server)
3566 struct sockaddr_storage sa1;
3567 socklen_t len1 = sizeof (sa1);
3568 DECLARE_POINTER_ALIAS (psa1, struct sockaddr, &sa1);
3569 if (getsockname (s, psa1, &len1) == 0)
3570 contact = Fplist_put (contact, QClocal,
3571 conv_sockaddr_to_lisp (psa1, len1));
3573 #endif
3576 if (s < 0)
3578 /* If non-blocking got this far - and failed - assume non-blocking is
3579 not supported after all. This is probably a wrong assumption, but
3580 the normal blocking calls to open-network-stream handles this error
3581 better. */
3582 if (p->is_non_blocking_client)
3583 return;
3585 report_file_errno ((p->is_server
3586 ? "make server process failed"
3587 : "make client process failed"),
3588 contact, xerrno);
3591 inch = s;
3592 outch = s;
3594 chan_process[inch] = proc;
3596 fcntl (inch, F_SETFL, O_NONBLOCK);
3598 p = XPROCESS (proc);
3599 p->open_fd[SUBPROCESS_STDIN] = inch;
3600 p->infd = inch;
3601 p->outfd = outch;
3603 /* Discard the unwind protect for closing S, if any. */
3604 specpdl_ptr = specpdl + count;
3606 if (p->is_server && p->socktype != SOCK_DGRAM)
3607 pset_status (p, Qlisten);
3609 /* Make the process marker point into the process buffer (if any). */
3610 if (BUFFERP (p->buffer))
3611 set_marker_both (p->mark, p->buffer,
3612 BUF_ZV (XBUFFER (p->buffer)),
3613 BUF_ZV_BYTE (XBUFFER (p->buffer)));
3615 if (p->is_non_blocking_client)
3617 /* We may get here if connect did succeed immediately. However,
3618 in that case, we still need to signal this like a non-blocking
3619 connection. */
3620 if (! (connecting_status (p->status)
3621 && EQ (XCDR (p->status), addrinfos)))
3622 pset_status (p, Fcons (Qconnect, addrinfos));
3623 if ((fd_callback_info[inch].flags & NON_BLOCKING_CONNECT_FD) == 0)
3624 add_non_blocking_write_fd (inch);
3626 else
3627 /* A server may have a client filter setting of Qt, but it must
3628 still listen for incoming connects unless it is stopped. */
3629 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3630 || (EQ (p->status, Qlisten) && NILP (p->command)))
3631 add_process_read_fd (inch);
3633 if (inch > max_desc)
3634 max_desc = inch;
3636 /* Set up the masks based on the process filter. */
3637 set_process_filter_masks (p);
3639 setup_process_coding_systems (proc);
3641 #ifdef HAVE_GNUTLS
3642 /* Continue the asynchronous connection. */
3643 if (!NILP (p->gnutls_boot_parameters))
3645 Lisp_Object boot, params = p->gnutls_boot_parameters;
3647 boot = Fgnutls_boot (proc, XCAR (params), XCDR (params));
3648 p->gnutls_boot_parameters = Qnil;
3650 if (p->gnutls_initstage == GNUTLS_STAGE_READY)
3651 /* Run sentinels, etc. */
3652 finish_after_tls_connection (proc);
3653 else if (p->gnutls_initstage != GNUTLS_STAGE_HANDSHAKE_TRIED)
3655 deactivate_process (proc);
3656 if (NILP (boot))
3657 pset_status (p, list2 (Qfailed,
3658 build_string ("TLS negotiation failed")));
3659 else
3660 pset_status (p, list2 (Qfailed, boot));
3663 #endif
3667 /* Create a network stream/datagram client/server process. Treated
3668 exactly like a normal process when reading and writing. Primary
3669 differences are in status display and process deletion. A network
3670 connection has no PID; you cannot signal it. All you can do is
3671 stop/continue it and deactivate/close it via delete-process. */
3673 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
3674 0, MANY, 0,
3675 doc: /* Create and return a network server or client process.
3677 In Emacs, network connections are represented by process objects, so
3678 input and output work as for subprocesses and `delete-process' closes
3679 a network connection. However, a network process has no process id,
3680 it cannot be signaled, and the status codes are different from normal
3681 processes.
3683 Arguments are specified as keyword/argument pairs. The following
3684 arguments are defined:
3686 :name NAME -- NAME is name for process. It is modified if necessary
3687 to make it unique.
3689 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
3690 with the process. Process output goes at end of that buffer, unless
3691 you specify an output stream or filter function to handle the output.
3692 BUFFER may be also nil, meaning that this process is not associated
3693 with any buffer.
3695 :host HOST -- HOST is name of the host to connect to, or its IP
3696 address. The symbol `local' specifies the local host. If specified
3697 for a server process, it must be a valid name or address for the local
3698 host, and only clients connecting to that address will be accepted.
3700 :service SERVICE -- SERVICE is name of the service desired, or an
3701 integer specifying a port number to connect to. If SERVICE is t,
3702 a random port number is selected for the server. A port number can
3703 be specified as an integer string, e.g., "80", as well as an integer.
3705 :type TYPE -- TYPE is the type of connection. The default (nil) is a
3706 stream type connection, `datagram' creates a datagram type connection,
3707 `seqpacket' creates a reliable datagram connection.
3709 :family FAMILY -- FAMILY is the address (and protocol) family for the
3710 service specified by HOST and SERVICE. The default (nil) is to use
3711 whatever address family (IPv4 or IPv6) that is defined for the host
3712 and port number specified by HOST and SERVICE. Other address families
3713 supported are:
3714 local -- for a local (i.e. UNIX) address specified by SERVICE.
3715 ipv4 -- use IPv4 address family only.
3716 ipv6 -- use IPv6 address family only.
3718 :local ADDRESS -- ADDRESS is the local address used for the connection.
3719 This parameter is ignored when opening a client process. When specified
3720 for a server process, the FAMILY, HOST and SERVICE args are ignored.
3722 :remote ADDRESS -- ADDRESS is the remote partner's address for the
3723 connection. This parameter is ignored when opening a stream server
3724 process. For a datagram server process, it specifies the initial
3725 setting of the remote datagram address. When specified for a client
3726 process, the FAMILY, HOST, and SERVICE args are ignored.
3728 The format of ADDRESS depends on the address family:
3729 - An IPv4 address is represented as an vector of integers [A B C D P]
3730 corresponding to numeric IP address A.B.C.D and port number P.
3731 - A local address is represented as a string with the address in the
3732 local address space.
3733 - An "unsupported family" address is represented by a cons (F . AV)
3734 where F is the family number and AV is a vector containing the socket
3735 address data with one element per address data byte. Do not rely on
3736 this format in portable code, as it may depend on implementation
3737 defined constants, data sizes, and data structure alignment.
3739 :coding CODING -- If CODING is a symbol, it specifies the coding
3740 system used for both reading and writing for this process. If CODING
3741 is a cons (DECODING . ENCODING), DECODING is used for reading, and
3742 ENCODING is used for writing.
3744 :nowait BOOL -- If NOWAIT is non-nil for a stream type client
3745 process, return without waiting for the connection to complete;
3746 instead, the sentinel function will be called with second arg matching
3747 "open" (if successful) or "failed" when the connect completes.
3748 Default is to use a blocking connect (i.e. wait) for stream type
3749 connections.
3751 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
3752 running when Emacs is exited.
3754 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
3755 In the stopped state, a server process does not accept new
3756 connections, and a client process does not handle incoming traffic.
3757 The stopped state is cleared by `continue-process' and set by
3758 `stop-process'.
3760 :filter FILTER -- Install FILTER as the process filter.
3762 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
3763 process filter are multibyte, otherwise they are unibyte.
3764 If this keyword is not specified, the strings are multibyte if
3765 the default value of `enable-multibyte-characters' is non-nil.
3767 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
3769 :log LOG -- Install LOG as the server process log function. This
3770 function is called when the server accepts a network connection from a
3771 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
3772 is the server process, CLIENT is the new process for the connection,
3773 and MESSAGE is a string.
3775 :plist PLIST -- Install PLIST as the new process's initial plist.
3777 :tls-parameters LIST -- is a list that should be supplied if you're
3778 opening a TLS connection. The first element is the TLS type (either
3779 `gnutls-x509pki' or `gnutls-anon'), and the remaining elements should
3780 be a keyword list accepted by gnutls-boot (as returned by
3781 `gnutls-boot-parameters').
3783 :server QLEN -- if QLEN is non-nil, create a server process for the
3784 specified FAMILY, SERVICE, and connection type (stream or datagram).
3785 If QLEN is an integer, it is used as the max. length of the server's
3786 pending connection queue (also known as the backlog); the default
3787 queue length is 5. Default is to create a client process.
3789 The following network options can be specified for this connection:
3791 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
3792 :dontroute BOOL -- Only send to directly connected hosts.
3793 :keepalive BOOL -- Send keep-alive messages on network stream.
3794 :linger BOOL or TIMEOUT -- Send queued messages before closing.
3795 :oobinline BOOL -- Place out-of-band data in receive data stream.
3796 :priority INT -- Set protocol defined priority for sent packets.
3797 :reuseaddr BOOL -- Allow reusing a recently used local address
3798 (this is allowed by default for a server process).
3799 :bindtodevice NAME -- bind to interface NAME. Using this may require
3800 special privileges on some systems.
3801 :use-external-socket BOOL -- Use any pre-allocated sockets that have
3802 been passed to Emacs. If Emacs wasn't
3803 passed a socket, this option is silently
3804 ignored.
3807 Consult the relevant system programmer's manual pages for more
3808 information on using these options.
3811 A server process will listen for and accept connections from clients.
3812 When a client connection is accepted, a new network process is created
3813 for the connection with the following parameters:
3815 - The client's process name is constructed by concatenating the server
3816 process's NAME and a client identification string.
3817 - If the FILTER argument is non-nil, the client process will not get a
3818 separate process buffer; otherwise, the client's process buffer is a newly
3819 created buffer named after the server process's BUFFER name or process
3820 NAME concatenated with the client identification string.
3821 - The connection type and the process filter and sentinel parameters are
3822 inherited from the server process's TYPE, FILTER and SENTINEL.
3823 - The client process's contact info is set according to the client's
3824 addressing information (typically an IP address and a port number).
3825 - The client process's plist is initialized from the server's plist.
3827 Notice that the FILTER and SENTINEL args are never used directly by
3828 the server process. Also, the BUFFER argument is not used directly by
3829 the server process, but via the optional :log function, accepted (and
3830 failed) connections may be logged in the server process's buffer.
3832 The original argument list, modified with the actual connection
3833 information, is available via the `process-contact' function.
3835 usage: (make-network-process &rest ARGS) */)
3836 (ptrdiff_t nargs, Lisp_Object *args)
3838 Lisp_Object proc;
3839 Lisp_Object contact;
3840 struct Lisp_Process *p;
3841 const char *portstring UNINIT;
3842 char portbuf[INT_BUFSIZE_BOUND (EMACS_INT)];
3843 #ifdef HAVE_LOCAL_SOCKETS
3844 struct sockaddr_un address_un;
3845 #endif
3846 EMACS_INT port = 0;
3847 Lisp_Object tem;
3848 Lisp_Object name, buffer, host, service, address;
3849 Lisp_Object filter, sentinel, use_external_socket_p;
3850 Lisp_Object addrinfos = Qnil;
3851 int socktype;
3852 int family = -1;
3853 enum { any_protocol = 0 };
3854 #ifdef HAVE_GETADDRINFO_A
3855 struct gaicb *dns_request = NULL;
3856 #endif
3857 ptrdiff_t count = SPECPDL_INDEX ();
3859 if (nargs == 0)
3860 return Qnil;
3862 /* Save arguments for process-contact and clone-process. */
3863 contact = Flist (nargs, args);
3865 #ifdef WINDOWSNT
3866 /* Ensure socket support is loaded if available. */
3867 init_winsock (TRUE);
3868 #endif
3870 /* :type TYPE (nil: stream, datagram */
3871 tem = Fplist_get (contact, QCtype);
3872 if (NILP (tem))
3873 socktype = SOCK_STREAM;
3874 #ifdef DATAGRAM_SOCKETS
3875 else if (EQ (tem, Qdatagram))
3876 socktype = SOCK_DGRAM;
3877 #endif
3878 #ifdef HAVE_SEQPACKET
3879 else if (EQ (tem, Qseqpacket))
3880 socktype = SOCK_SEQPACKET;
3881 #endif
3882 else
3883 error ("Unsupported connection type");
3885 name = Fplist_get (contact, QCname);
3886 buffer = Fplist_get (contact, QCbuffer);
3887 filter = Fplist_get (contact, QCfilter);
3888 sentinel = Fplist_get (contact, QCsentinel);
3889 use_external_socket_p = Fplist_get (contact, QCuse_external_socket);
3891 CHECK_STRING (name);
3893 /* :local ADDRESS or :remote ADDRESS */
3894 tem = Fplist_get (contact, QCserver);
3895 if (NILP (tem))
3896 address = Fplist_get (contact, QCremote);
3897 else
3898 address = Fplist_get (contact, QClocal);
3899 if (!NILP (address))
3901 host = service = Qnil;
3903 if (!get_lisp_to_sockaddr_size (address, &family))
3904 error ("Malformed :address");
3906 addrinfos = list1 (Fcons (make_number (any_protocol), address));
3907 goto open_socket;
3910 /* :family FAMILY -- nil (for Inet), local, or integer. */
3911 tem = Fplist_get (contact, QCfamily);
3912 if (NILP (tem))
3914 #ifdef AF_INET6
3915 family = AF_UNSPEC;
3916 #else
3917 family = AF_INET;
3918 #endif
3920 #ifdef HAVE_LOCAL_SOCKETS
3921 else if (EQ (tem, Qlocal))
3922 family = AF_LOCAL;
3923 #endif
3924 #ifdef AF_INET6
3925 else if (EQ (tem, Qipv6))
3926 family = AF_INET6;
3927 #endif
3928 else if (EQ (tem, Qipv4))
3929 family = AF_INET;
3930 else if (TYPE_RANGED_INTEGERP (int, tem))
3931 family = XINT (tem);
3932 else
3933 error ("Unknown address family");
3935 /* :service SERVICE -- string, integer (port number), or t (random port). */
3936 service = Fplist_get (contact, QCservice);
3938 /* :host HOST -- hostname, ip address, or 'local for localhost. */
3939 host = Fplist_get (contact, QChost);
3940 if (NILP (host))
3942 /* The "connection" function gets it bind info from the address we're
3943 given, so use this dummy address if nothing is specified. */
3944 #ifdef HAVE_LOCAL_SOCKETS
3945 if (family != AF_LOCAL)
3946 #endif
3947 host = build_string ("127.0.0.1");
3949 else
3951 if (EQ (host, Qlocal))
3952 /* Depending on setup, "localhost" may map to different IPv4 and/or
3953 IPv6 addresses, so it's better to be explicit (Bug#6781). */
3954 host = build_string ("127.0.0.1");
3955 CHECK_STRING (host);
3958 #ifdef HAVE_LOCAL_SOCKETS
3959 if (family == AF_LOCAL)
3961 if (!NILP (host))
3963 message (":family local ignores the :host property");
3964 contact = Fplist_put (contact, QChost, Qnil);
3965 host = Qnil;
3967 CHECK_STRING (service);
3968 if (sizeof address_un.sun_path <= SBYTES (service))
3969 error ("Service name too long");
3970 addrinfos = list1 (Fcons (make_number (any_protocol), service));
3971 goto open_socket;
3973 #endif
3975 /* Slow down polling to every ten seconds.
3976 Some kernels have a bug which causes retrying connect to fail
3977 after a connect. Polling can interfere with gethostbyname too. */
3978 #ifdef POLL_FOR_INPUT
3979 if (socktype != SOCK_DGRAM)
3981 record_unwind_protect_void (run_all_atimers);
3982 bind_polling_period (10);
3984 #endif
3986 if (!NILP (host))
3988 ptrdiff_t portstringlen ATTRIBUTE_UNUSED;
3990 /* SERVICE can either be a string or int.
3991 Convert to a C string for later use by getaddrinfo. */
3992 if (EQ (service, Qt))
3994 portstring = "0";
3995 portstringlen = 1;
3997 else if (INTEGERP (service))
3999 portstring = portbuf;
4000 portstringlen = sprintf (portbuf, "%"pI"d", XINT (service));
4002 else
4004 CHECK_STRING (service);
4005 portstring = SSDATA (service);
4006 portstringlen = SBYTES (service);
4009 #ifdef HAVE_GETADDRINFO_A
4010 if (!NILP (Fplist_get (contact, QCnowait)))
4012 ptrdiff_t hostlen = SBYTES (host);
4013 struct req
4015 struct gaicb gaicb;
4016 struct addrinfo hints;
4017 char str[FLEXIBLE_ARRAY_MEMBER];
4018 } *req = xmalloc (FLEXSIZEOF (struct req, str,
4019 hostlen + 1 + portstringlen + 1));
4020 dns_request = &req->gaicb;
4021 dns_request->ar_name = req->str;
4022 dns_request->ar_service = req->str + hostlen + 1;
4023 dns_request->ar_request = &req->hints;
4024 dns_request->ar_result = NULL;
4025 memset (&req->hints, 0, sizeof req->hints);
4026 req->hints.ai_family = family;
4027 req->hints.ai_socktype = socktype;
4028 strcpy (req->str, SSDATA (host));
4029 strcpy (req->str + hostlen + 1, portstring);
4031 int ret = getaddrinfo_a (GAI_NOWAIT, &dns_request, 1, NULL);
4032 if (ret)
4033 error ("%s/%s getaddrinfo_a error %d",
4034 SSDATA (host), portstring, ret);
4036 goto open_socket;
4038 #endif /* HAVE_GETADDRINFO_A */
4041 /* If we have a host, use getaddrinfo to resolve both host and service.
4042 Otherwise, use getservbyname to lookup the service. */
4044 if (!NILP (host))
4046 struct addrinfo *res, *lres;
4047 int ret;
4049 maybe_quit ();
4051 struct addrinfo hints;
4052 memset (&hints, 0, sizeof hints);
4053 hints.ai_family = family;
4054 hints.ai_socktype = socktype;
4056 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
4057 if (ret)
4058 #ifdef HAVE_GAI_STRERROR
4060 synchronize_system_messages_locale ();
4061 char const *str = gai_strerror (ret);
4062 if (! NILP (Vlocale_coding_system))
4063 str = SSDATA (code_convert_string_norecord
4064 (build_string (str), Vlocale_coding_system, 0));
4065 error ("%s/%s %s", SSDATA (host), portstring, str);
4067 #else
4068 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
4069 #endif
4071 for (lres = res; lres; lres = lres->ai_next)
4072 addrinfos = Fcons (conv_addrinfo_to_lisp (lres), addrinfos);
4074 addrinfos = Fnreverse (addrinfos);
4076 freeaddrinfo (res);
4078 goto open_socket;
4081 /* No hostname has been specified (e.g., a local server process). */
4083 if (EQ (service, Qt))
4084 port = 0;
4085 else if (INTEGERP (service))
4086 port = XINT (service);
4087 else
4089 CHECK_STRING (service);
4091 port = -1;
4092 if (SBYTES (service) != 0)
4094 /* Allow the service to be a string containing the port number,
4095 because that's allowed if you have getaddrbyname. */
4096 char *service_end;
4097 long int lport = strtol (SSDATA (service), &service_end, 10);
4098 if (service_end == SSDATA (service) + SBYTES (service))
4099 port = lport;
4100 else
4102 struct servent *svc_info
4103 = getservbyname (SSDATA (service),
4104 socktype == SOCK_DGRAM ? "udp" : "tcp");
4105 if (svc_info)
4106 port = ntohs (svc_info->s_port);
4111 if (! (0 <= port && port < 1 << 16))
4113 AUTO_STRING (unknown_service, "Unknown service: %s");
4114 xsignal1 (Qerror, CALLN (Fformat, unknown_service, service));
4117 open_socket:
4119 if (!NILP (buffer))
4120 buffer = Fget_buffer_create (buffer);
4122 /* Unwind bind_polling_period. */
4123 unbind_to (count, Qnil);
4125 proc = make_process (name);
4126 record_unwind_protect (remove_process, proc);
4127 p = XPROCESS (proc);
4128 pset_childp (p, contact);
4129 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
4130 pset_type (p, Qnetwork);
4132 pset_buffer (p, buffer);
4133 pset_sentinel (p, sentinel);
4134 pset_filter (p, filter);
4135 pset_log (p, Fplist_get (contact, QClog));
4136 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
4137 p->kill_without_query = 1;
4138 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
4139 pset_command (p, Qt);
4140 eassert (p->pid == 0);
4141 p->backlog = 5;
4142 eassert (! p->is_non_blocking_client);
4143 eassert (! p->is_server);
4144 p->port = port;
4145 p->socktype = socktype;
4146 #ifdef HAVE_GETADDRINFO_A
4147 eassert (! p->dns_request);
4148 #endif
4149 #ifdef HAVE_GNUTLS
4150 tem = Fplist_get (contact, QCtls_parameters);
4151 CHECK_LIST (tem);
4152 p->gnutls_boot_parameters = tem;
4153 #endif
4155 set_network_socket_coding_system (proc, host, service, name);
4157 /* :server BOOL */
4158 tem = Fplist_get (contact, QCserver);
4159 if (!NILP (tem))
4161 /* Don't support network sockets when non-blocking mode is
4162 not available, since a blocked Emacs is not useful. */
4163 p->is_server = true;
4164 if (TYPE_RANGED_INTEGERP (int, tem))
4165 p->backlog = XINT (tem);
4168 /* :nowait BOOL */
4169 if (!p->is_server && socktype != SOCK_DGRAM
4170 && !NILP (Fplist_get (contact, QCnowait)))
4171 p->is_non_blocking_client = true;
4173 bool postpone_connection = false;
4174 #ifdef HAVE_GETADDRINFO_A
4175 /* With async address resolution, the list of addresses is empty, so
4176 postpone connecting to the server. */
4177 if (!p->is_server && NILP (addrinfos))
4179 p->dns_request = dns_request;
4180 p->status = list1 (Qconnect);
4181 postpone_connection = true;
4183 #endif
4184 if (! postpone_connection)
4185 connect_network_socket (proc, addrinfos, use_external_socket_p);
4187 specpdl_ptr = specpdl + count;
4188 return proc;
4192 #ifdef HAVE_NET_IF_H
4194 #ifdef SIOCGIFCONF
4195 static Lisp_Object
4196 network_interface_list (void)
4198 struct ifconf ifconf;
4199 struct ifreq *ifreq;
4200 void *buf = NULL;
4201 ptrdiff_t buf_size = 512;
4202 int s;
4203 Lisp_Object res;
4204 ptrdiff_t count;
4206 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
4207 if (s < 0)
4208 return Qnil;
4209 count = SPECPDL_INDEX ();
4210 record_unwind_protect_int (close_file_unwind, s);
4214 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
4215 ifconf.ifc_buf = buf;
4216 ifconf.ifc_len = buf_size;
4217 if (ioctl (s, SIOCGIFCONF, &ifconf))
4219 emacs_close (s);
4220 xfree (buf);
4221 return Qnil;
4224 while (ifconf.ifc_len == buf_size);
4226 res = unbind_to (count, Qnil);
4227 ifreq = ifconf.ifc_req;
4228 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
4230 struct ifreq *ifq = ifreq;
4231 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
4232 #define SIZEOF_IFREQ(sif) \
4233 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
4234 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
4236 int len = SIZEOF_IFREQ (ifq);
4237 #else
4238 int len = sizeof (*ifreq);
4239 #endif
4240 char namebuf[sizeof (ifq->ifr_name) + 1];
4241 ifreq = (struct ifreq *) ((char *) ifreq + len);
4243 if (ifq->ifr_addr.sa_family != AF_INET)
4244 continue;
4246 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
4247 namebuf[sizeof (ifq->ifr_name)] = 0;
4248 res = Fcons (Fcons (build_string (namebuf),
4249 conv_sockaddr_to_lisp (&ifq->ifr_addr,
4250 sizeof (struct sockaddr))),
4251 res);
4254 xfree (buf);
4255 return res;
4257 #endif /* SIOCGIFCONF */
4259 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
4261 struct ifflag_def {
4262 int flag_bit;
4263 const char *flag_sym;
4266 static const struct ifflag_def ifflag_table[] = {
4267 #ifdef IFF_UP
4268 { IFF_UP, "up" },
4269 #endif
4270 #ifdef IFF_BROADCAST
4271 { IFF_BROADCAST, "broadcast" },
4272 #endif
4273 #ifdef IFF_DEBUG
4274 { IFF_DEBUG, "debug" },
4275 #endif
4276 #ifdef IFF_LOOPBACK
4277 { IFF_LOOPBACK, "loopback" },
4278 #endif
4279 #ifdef IFF_POINTOPOINT
4280 { IFF_POINTOPOINT, "pointopoint" },
4281 #endif
4282 #ifdef IFF_RUNNING
4283 { IFF_RUNNING, "running" },
4284 #endif
4285 #ifdef IFF_NOARP
4286 { IFF_NOARP, "noarp" },
4287 #endif
4288 #ifdef IFF_PROMISC
4289 { IFF_PROMISC, "promisc" },
4290 #endif
4291 #ifdef IFF_NOTRAILERS
4292 #ifdef NS_IMPL_COCOA
4293 /* Really means smart, notrailers is obsolete. */
4294 { IFF_NOTRAILERS, "smart" },
4295 #else
4296 { IFF_NOTRAILERS, "notrailers" },
4297 #endif
4298 #endif
4299 #ifdef IFF_ALLMULTI
4300 { IFF_ALLMULTI, "allmulti" },
4301 #endif
4302 #ifdef IFF_MASTER
4303 { IFF_MASTER, "master" },
4304 #endif
4305 #ifdef IFF_SLAVE
4306 { IFF_SLAVE, "slave" },
4307 #endif
4308 #ifdef IFF_MULTICAST
4309 { IFF_MULTICAST, "multicast" },
4310 #endif
4311 #ifdef IFF_PORTSEL
4312 { IFF_PORTSEL, "portsel" },
4313 #endif
4314 #ifdef IFF_AUTOMEDIA
4315 { IFF_AUTOMEDIA, "automedia" },
4316 #endif
4317 #ifdef IFF_DYNAMIC
4318 { IFF_DYNAMIC, "dynamic" },
4319 #endif
4320 #ifdef IFF_OACTIVE
4321 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress. */
4322 #endif
4323 #ifdef IFF_SIMPLEX
4324 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions. */
4325 #endif
4326 #ifdef IFF_LINK0
4327 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit. */
4328 #endif
4329 #ifdef IFF_LINK1
4330 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit. */
4331 #endif
4332 #ifdef IFF_LINK2
4333 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit. */
4334 #endif
4335 { 0, 0 }
4338 static Lisp_Object
4339 network_interface_info (Lisp_Object ifname)
4341 struct ifreq rq;
4342 Lisp_Object res = Qnil;
4343 Lisp_Object elt;
4344 int s;
4345 bool any = 0;
4346 ptrdiff_t count;
4347 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
4348 && defined HAVE_GETIFADDRS && defined LLADDR)
4349 struct ifaddrs *ifap;
4350 #endif
4352 CHECK_STRING (ifname);
4354 if (sizeof rq.ifr_name <= SBYTES (ifname))
4355 error ("interface name too long");
4356 lispstpcpy (rq.ifr_name, ifname);
4358 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
4359 if (s < 0)
4360 return Qnil;
4361 count = SPECPDL_INDEX ();
4362 record_unwind_protect_int (close_file_unwind, s);
4364 elt = Qnil;
4365 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
4366 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
4368 int flags = rq.ifr_flags;
4369 const struct ifflag_def *fp;
4370 int fnum;
4372 /* If flags is smaller than int (i.e. short) it may have the high bit set
4373 due to IFF_MULTICAST. In that case, sign extending it into
4374 an int is wrong. */
4375 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
4376 flags = (unsigned short) rq.ifr_flags;
4378 any = 1;
4379 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
4381 if (flags & fp->flag_bit)
4383 elt = Fcons (intern (fp->flag_sym), elt);
4384 flags -= fp->flag_bit;
4387 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
4389 if (flags & 1)
4391 elt = Fcons (make_number (fnum), elt);
4395 #endif
4396 res = Fcons (elt, res);
4398 elt = Qnil;
4399 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
4400 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
4402 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
4403 register struct Lisp_Vector *p = XVECTOR (hwaddr);
4404 int n;
4406 any = 1;
4407 for (n = 0; n < 6; n++)
4408 p->contents[n] = make_number (((unsigned char *)
4409 &rq.ifr_hwaddr.sa_data[0])
4410 [n]);
4411 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
4413 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
4414 if (getifaddrs (&ifap) != -1)
4416 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
4417 register struct Lisp_Vector *p = XVECTOR (hwaddr);
4418 struct ifaddrs *it;
4420 for (it = ifap; it != NULL; it = it->ifa_next)
4422 DECLARE_POINTER_ALIAS (sdl, struct sockaddr_dl, it->ifa_addr);
4423 unsigned char linkaddr[6];
4424 int n;
4426 if (it->ifa_addr->sa_family != AF_LINK
4427 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
4428 || sdl->sdl_alen != 6)
4429 continue;
4431 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
4432 for (n = 0; n < 6; n++)
4433 p->contents[n] = make_number (linkaddr[n]);
4435 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
4436 break;
4439 #ifdef HAVE_FREEIFADDRS
4440 freeifaddrs (ifap);
4441 #endif
4443 #endif /* HAVE_GETIFADDRS && LLADDR */
4445 res = Fcons (elt, res);
4447 elt = Qnil;
4448 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
4449 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
4451 any = 1;
4452 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
4453 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
4454 #else
4455 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
4456 #endif
4458 #endif
4459 res = Fcons (elt, res);
4461 elt = Qnil;
4462 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
4463 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
4465 any = 1;
4466 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
4468 #endif
4469 res = Fcons (elt, res);
4471 elt = Qnil;
4472 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
4473 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
4475 any = 1;
4476 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
4478 #endif
4479 res = Fcons (elt, res);
4481 return unbind_to (count, any ? res : Qnil);
4483 #endif /* !SIOCGIFADDR && !SIOCGIFHWADDR && !SIOCGIFFLAGS */
4484 #endif /* defined (HAVE_NET_IF_H) */
4486 DEFUN ("network-interface-list", Fnetwork_interface_list,
4487 Snetwork_interface_list, 0, 0, 0,
4488 doc: /* Return an alist of all network interfaces and their network address.
4489 Each element is a cons, the car of which is a string containing the
4490 interface name, and the cdr is the network address in internal
4491 format; see the description of ADDRESS in `make-network-process'.
4493 If the information is not available, return nil. */)
4494 (void)
4496 #if (defined HAVE_NET_IF_H && defined SIOCGIFCONF) || defined WINDOWSNT
4497 return network_interface_list ();
4498 #else
4499 return Qnil;
4500 #endif
4503 DEFUN ("network-interface-info", Fnetwork_interface_info,
4504 Snetwork_interface_info, 1, 1, 0,
4505 doc: /* Return information about network interface named IFNAME.
4506 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
4507 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
4508 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
4509 FLAGS is the current flags of the interface.
4511 Data that is unavailable is returned as nil. */)
4512 (Lisp_Object ifname)
4514 #if ((defined HAVE_NET_IF_H \
4515 && (defined SIOCGIFADDR || defined SIOCGIFHWADDR \
4516 || defined SIOCGIFFLAGS)) \
4517 || defined WINDOWSNT)
4518 return network_interface_info (ifname);
4519 #else
4520 return Qnil;
4521 #endif
4524 /* Turn off input and output for process PROC. */
4526 static void
4527 deactivate_process (Lisp_Object proc)
4529 int inchannel;
4530 struct Lisp_Process *p = XPROCESS (proc);
4531 int i;
4533 #ifdef HAVE_GNUTLS
4534 /* Delete GnuTLS structures in PROC, if any. */
4535 emacs_gnutls_deinit (proc);
4536 #endif /* HAVE_GNUTLS */
4538 if (p->read_output_delay > 0)
4540 if (--process_output_delay_count < 0)
4541 process_output_delay_count = 0;
4542 p->read_output_delay = 0;
4543 p->read_output_skip = 0;
4546 /* Beware SIGCHLD hereabouts. */
4548 for (i = 0; i < PROCESS_OPEN_FDS; i++)
4549 close_process_fd (&p->open_fd[i]);
4551 inchannel = p->infd;
4552 if (inchannel >= 0)
4554 p->infd = -1;
4555 p->outfd = -1;
4556 #ifdef DATAGRAM_SOCKETS
4557 if (DATAGRAM_CHAN_P (inchannel))
4559 xfree (datagram_address[inchannel].sa);
4560 datagram_address[inchannel].sa = 0;
4561 datagram_address[inchannel].len = 0;
4563 #endif
4564 chan_process[inchannel] = Qnil;
4565 delete_read_fd (inchannel);
4566 if ((fd_callback_info[inchannel].flags & NON_BLOCKING_CONNECT_FD) != 0)
4567 delete_write_fd (inchannel);
4568 if (inchannel == max_desc)
4569 recompute_max_desc ();
4574 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
4575 0, 4, 0,
4576 doc: /* Allow any pending output from subprocesses to be read by Emacs.
4577 It is given to their filter functions.
4578 Optional argument PROCESS means do not return until output has been
4579 received from PROCESS.
4581 Optional second argument SECONDS and third argument MILLISEC
4582 specify a timeout; return after that much time even if there is
4583 no subprocess output. If SECONDS is a floating point number,
4584 it specifies a fractional number of seconds to wait.
4585 The MILLISEC argument is obsolete and should be avoided.
4587 If optional fourth argument JUST-THIS-ONE is non-nil, accept output
4588 from PROCESS only, suspending reading output from other processes.
4589 If JUST-THIS-ONE is an integer, don't run any timers either.
4590 Return non-nil if we received any output from PROCESS (or, if PROCESS
4591 is nil, from any process) before the timeout expired. */)
4592 (Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec,
4593 Lisp_Object just_this_one)
4595 intmax_t secs;
4596 int nsecs;
4598 if (! NILP (process))
4600 CHECK_PROCESS (process);
4601 struct Lisp_Process *proc = XPROCESS (process);
4603 /* Can't wait for a process that is dedicated to a different
4604 thread. */
4605 if (!EQ (proc->thread, Qnil) && !EQ (proc->thread, Fcurrent_thread ()))
4607 Lisp_Object proc_thread_name = XTHREAD (proc->thread)->name;
4609 if (STRINGP (proc_thread_name))
4610 error ("Attempt to accept output from process %s locked to thread %s",
4611 SDATA (proc->name), SDATA (proc_thread_name));
4612 else
4613 error ("Attempt to accept output from process %s locked to thread %p",
4614 SDATA (proc->name), XTHREAD (proc->thread));
4617 else
4618 just_this_one = Qnil;
4620 if (!NILP (millisec))
4621 { /* Obsolete calling convention using integers rather than floats. */
4622 CHECK_NUMBER (millisec);
4623 if (NILP (seconds))
4624 seconds = make_float (XINT (millisec) / 1000.0);
4625 else
4627 CHECK_NUMBER (seconds);
4628 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
4632 secs = 0;
4633 nsecs = -1;
4635 if (!NILP (seconds))
4637 if (INTEGERP (seconds))
4639 if (XINT (seconds) > 0)
4641 secs = XINT (seconds);
4642 nsecs = 0;
4645 else if (FLOATP (seconds))
4647 if (XFLOAT_DATA (seconds) > 0)
4649 struct timespec t = dtotimespec (XFLOAT_DATA (seconds));
4650 secs = min (t.tv_sec, WAIT_READING_MAX);
4651 nsecs = t.tv_nsec;
4654 else
4655 wrong_type_argument (Qnumberp, seconds);
4657 else if (! NILP (process))
4658 nsecs = 0;
4660 return
4661 ((wait_reading_process_output (secs, nsecs, 0, 0,
4662 Qnil,
4663 !NILP (process) ? XPROCESS (process) : NULL,
4664 (NILP (just_this_one) ? 0
4665 : !INTEGERP (just_this_one) ? 1 : -1))
4666 <= 0)
4667 ? Qnil : Qt);
4670 /* Accept a connection for server process SERVER on CHANNEL. */
4672 static EMACS_INT connect_counter = 0;
4674 static void
4675 server_accept_connection (Lisp_Object server, int channel)
4677 Lisp_Object buffer;
4678 Lisp_Object contact, host, service;
4679 struct Lisp_Process *ps = XPROCESS (server);
4680 struct Lisp_Process *p;
4681 int s;
4682 union u_sockaddr {
4683 struct sockaddr sa;
4684 struct sockaddr_in in;
4685 #ifdef AF_INET6
4686 struct sockaddr_in6 in6;
4687 #endif
4688 #ifdef HAVE_LOCAL_SOCKETS
4689 struct sockaddr_un un;
4690 #endif
4691 } saddr;
4692 socklen_t len = sizeof saddr;
4693 ptrdiff_t count;
4695 s = accept4 (channel, &saddr.sa, &len, SOCK_CLOEXEC);
4697 if (s < 0)
4699 int code = errno;
4700 if (!would_block (code) && !NILP (ps->log))
4701 call3 (ps->log, server, Qnil,
4702 concat3 (build_string ("accept failed with code"),
4703 Fnumber_to_string (make_number (code)),
4704 build_string ("\n")));
4705 return;
4708 count = SPECPDL_INDEX ();
4709 record_unwind_protect_int (close_file_unwind, s);
4711 connect_counter++;
4713 /* Setup a new process to handle the connection. */
4715 /* Generate a unique identification of the caller, and build contact
4716 information for this process. */
4717 host = Qt;
4718 service = Qnil;
4719 Lisp_Object args[11];
4720 int nargs = 0;
4721 AUTO_STRING (procname_format_in, "%s <%d.%d.%d.%d:%d>");
4722 AUTO_STRING (procname_format_in6, "%s <[%x:%x:%x:%x:%x:%x:%x:%x]:%d>");
4723 AUTO_STRING (procname_format_default, "%s <%d>");
4724 switch (saddr.sa.sa_family)
4726 case AF_INET:
4728 args[nargs++] = procname_format_in;
4729 nargs++;
4730 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4731 service = make_number (ntohs (saddr.in.sin_port));
4732 for (int i = 0; i < 4; i++)
4733 args[nargs++] = make_number (ip[i]);
4734 args[nargs++] = service;
4736 break;
4738 #ifdef AF_INET6
4739 case AF_INET6:
4741 args[nargs++] = procname_format_in6;
4742 nargs++;
4743 DECLARE_POINTER_ALIAS (ip6, uint16_t, &saddr.in6.sin6_addr);
4744 service = make_number (ntohs (saddr.in.sin_port));
4745 for (int i = 0; i < 8; i++)
4746 args[nargs++] = make_number (ip6[i]);
4747 args[nargs++] = service;
4749 break;
4750 #endif
4752 default:
4753 args[nargs++] = procname_format_default;
4754 nargs++;
4755 args[nargs++] = make_number (connect_counter);
4756 break;
4759 /* Create a new buffer name for this process if it doesn't have a
4760 filter. The new buffer name is based on the buffer name or
4761 process name of the server process concatenated with the caller
4762 identification. */
4764 if (!(EQ (ps->filter, Qinternal_default_process_filter)
4765 || EQ (ps->filter, Qt)))
4766 buffer = Qnil;
4767 else
4769 buffer = ps->buffer;
4770 if (!NILP (buffer))
4771 buffer = Fbuffer_name (buffer);
4772 else
4773 buffer = ps->name;
4774 if (!NILP (buffer))
4776 args[1] = buffer;
4777 buffer = Fget_buffer_create (Fformat (nargs, args));
4781 /* Generate a unique name for the new server process. Combine the
4782 server process name with the caller identification. */
4784 args[1] = ps->name;
4785 Lisp_Object name = Fformat (nargs, args);
4786 Lisp_Object proc = make_process (name);
4788 chan_process[s] = proc;
4790 fcntl (s, F_SETFL, O_NONBLOCK);
4792 p = XPROCESS (proc);
4794 /* Build new contact information for this setup. */
4795 contact = Fcopy_sequence (ps->childp);
4796 contact = Fplist_put (contact, QCserver, Qnil);
4797 contact = Fplist_put (contact, QChost, host);
4798 if (!NILP (service))
4799 contact = Fplist_put (contact, QCservice, service);
4800 contact = Fplist_put (contact, QCremote,
4801 conv_sockaddr_to_lisp (&saddr.sa, len));
4802 #ifdef HAVE_GETSOCKNAME
4803 len = sizeof saddr;
4804 if (getsockname (s, &saddr.sa, &len) == 0)
4805 contact = Fplist_put (contact, QClocal,
4806 conv_sockaddr_to_lisp (&saddr.sa, len));
4807 #endif
4809 pset_childp (p, contact);
4810 pset_plist (p, Fcopy_sequence (ps->plist));
4811 pset_type (p, Qnetwork);
4813 pset_buffer (p, buffer);
4814 pset_sentinel (p, ps->sentinel);
4815 pset_filter (p, ps->filter);
4816 eassert (NILP (p->command));
4817 eassert (p->pid == 0);
4819 /* Discard the unwind protect for closing S. */
4820 specpdl_ptr = specpdl + count;
4822 p->open_fd[SUBPROCESS_STDIN] = s;
4823 p->infd = s;
4824 p->outfd = s;
4825 pset_status (p, Qrun);
4827 /* Client processes for accepted connections are not stopped initially. */
4828 if (!EQ (p->filter, Qt))
4829 add_process_read_fd (s);
4830 if (s > max_desc)
4831 max_desc = s;
4833 /* Setup coding system for new process based on server process.
4834 This seems to be the proper thing to do, as the coding system
4835 of the new process should reflect the settings at the time the
4836 server socket was opened; not the current settings. */
4838 pset_decode_coding_system (p, ps->decode_coding_system);
4839 pset_encode_coding_system (p, ps->encode_coding_system);
4840 setup_process_coding_systems (proc);
4842 pset_decoding_buf (p, empty_unibyte_string);
4843 eassert (p->decoding_carryover == 0);
4844 pset_encoding_buf (p, empty_unibyte_string);
4846 p->inherit_coding_system_flag
4847 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4849 AUTO_STRING (dash, "-");
4850 AUTO_STRING (nl, "\n");
4851 Lisp_Object host_string = STRINGP (host) ? host : dash;
4853 if (!NILP (ps->log))
4855 AUTO_STRING (accept_from, "accept from ");
4856 call3 (ps->log, server, proc, concat3 (accept_from, host_string, nl));
4859 AUTO_STRING (open_from, "open from ");
4860 exec_sentinel (proc, concat3 (open_from, host_string, nl));
4863 #ifdef HAVE_GETADDRINFO_A
4864 static Lisp_Object
4865 check_for_dns (Lisp_Object proc)
4867 struct Lisp_Process *p = XPROCESS (proc);
4868 Lisp_Object addrinfos = Qnil;
4870 /* Sanity check. */
4871 if (! p->dns_request)
4872 return Qnil;
4874 int ret = gai_error (p->dns_request);
4875 if (ret == EAI_INPROGRESS)
4876 return Qt;
4878 /* We got a response. */
4879 if (ret == 0)
4881 struct addrinfo *res;
4883 for (res = p->dns_request->ar_result; res; res = res->ai_next)
4884 addrinfos = Fcons (conv_addrinfo_to_lisp (res), addrinfos);
4886 addrinfos = Fnreverse (addrinfos);
4888 /* The DNS lookup failed. */
4889 else if (connecting_status (p->status))
4891 deactivate_process (proc);
4892 pset_status (p, (list2
4893 (Qfailed,
4894 concat3 (build_string ("Name lookup of "),
4895 build_string (p->dns_request->ar_name),
4896 build_string (" failed")))));
4899 free_dns_request (proc);
4901 /* This process should not already be connected (or killed). */
4902 if (! connecting_status (p->status))
4903 return Qnil;
4905 return addrinfos;
4908 #endif /* HAVE_GETADDRINFO_A */
4910 static void
4911 wait_for_socket_fds (Lisp_Object process, char const *name)
4913 while (XPROCESS (process)->infd < 0
4914 && connecting_status (XPROCESS (process)->status))
4916 add_to_log ("Waiting for socket from %s...", build_string (name));
4917 wait_reading_process_output (0, 20 * 1000 * 1000, 0, 0, Qnil, NULL, 0);
4921 static void
4922 wait_while_connecting (Lisp_Object process)
4924 while (connecting_status (XPROCESS (process)->status))
4926 add_to_log ("Waiting for connection...");
4927 wait_reading_process_output (0, 20 * 1000 * 1000, 0, 0, Qnil, NULL, 0);
4931 static void
4932 wait_for_tls_negotiation (Lisp_Object process)
4934 #ifdef HAVE_GNUTLS
4935 while (XPROCESS (process)->gnutls_p
4936 && XPROCESS (process)->gnutls_initstage != GNUTLS_STAGE_READY)
4938 add_to_log ("Waiting for TLS...");
4939 wait_reading_process_output (0, 20 * 1000 * 1000, 0, 0, Qnil, NULL, 0);
4941 #endif
4944 static void
4945 wait_reading_process_output_unwind (int data)
4947 clear_waiting_thread_info ();
4948 waiting_for_user_input_p = data;
4951 /* This is here so breakpoints can be put on it. */
4952 static void
4953 wait_reading_process_output_1 (void)
4957 /* Read and dispose of subprocess output while waiting for timeout to
4958 elapse and/or keyboard input to be available.
4960 TIME_LIMIT is:
4961 timeout in seconds
4962 If negative, gobble data immediately available but don't wait for any.
4964 NSECS is:
4965 an additional duration to wait, measured in nanoseconds
4966 If TIME_LIMIT is zero, then:
4967 If NSECS == 0, there is no limit.
4968 If NSECS > 0, the timeout consists of NSECS only.
4969 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4971 READ_KBD is:
4972 0 to ignore keyboard input, or
4973 1 to return when input is available, or
4974 -1 meaning caller will actually read the input, so don't throw to
4975 the quit handler
4977 DO_DISPLAY means redisplay should be done to show subprocess
4978 output that arrives.
4980 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4981 (and gobble terminal input into the buffer if any arrives).
4983 If WAIT_PROC is specified, wait until something arrives from that
4984 process.
4986 If JUST_WAIT_PROC is nonzero, handle only output from WAIT_PROC
4987 (suspending output from other processes). A negative value
4988 means don't run any timers either.
4990 Return positive if we received input from WAIT_PROC (or from any
4991 process if WAIT_PROC is null), zero if we attempted to receive
4992 input but got none, and negative if we didn't even try. */
4995 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4996 bool do_display,
4997 Lisp_Object wait_for_cell,
4998 struct Lisp_Process *wait_proc, int just_wait_proc)
5000 int channel, nfds;
5001 fd_set Available;
5002 fd_set Writeok;
5003 bool check_write;
5004 int check_delay;
5005 bool no_avail;
5006 int xerrno;
5007 Lisp_Object proc;
5008 struct timespec timeout, end_time, timer_delay;
5009 struct timespec got_output_end_time = invalid_timespec ();
5010 enum { MINIMUM = -1, TIMEOUT, INFINITY } wait;
5011 int got_some_output = -1;
5012 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
5013 bool retry_for_async;
5014 #endif
5015 ptrdiff_t count = SPECPDL_INDEX ();
5017 /* Close to the current time if known, an invalid timespec otherwise. */
5018 struct timespec now = invalid_timespec ();
5020 eassert (wait_proc == NULL
5021 || EQ (wait_proc->thread, Qnil)
5022 || XTHREAD (wait_proc->thread) == current_thread);
5024 FD_ZERO (&Available);
5025 FD_ZERO (&Writeok);
5027 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
5028 && !(CONSP (wait_proc->status)
5029 && EQ (XCAR (wait_proc->status), Qexit)))
5030 message1 ("Blocking call to accept-process-output with quit inhibited!!");
5032 record_unwind_protect_int (wait_reading_process_output_unwind,
5033 waiting_for_user_input_p);
5034 waiting_for_user_input_p = read_kbd;
5036 if (TYPE_MAXIMUM (time_t) < time_limit)
5037 time_limit = TYPE_MAXIMUM (time_t);
5039 if (time_limit < 0 || nsecs < 0)
5040 wait = MINIMUM;
5041 else if (time_limit > 0 || nsecs > 0)
5043 wait = TIMEOUT;
5044 now = current_timespec ();
5045 end_time = timespec_add (now, make_timespec (time_limit, nsecs));
5047 else
5048 wait = INFINITY;
5050 while (1)
5052 bool process_skipped = false;
5054 /* If calling from keyboard input, do not quit
5055 since we want to return C-g as an input character.
5056 Otherwise, do pending quit if requested. */
5057 if (read_kbd >= 0)
5058 maybe_quit ();
5059 else if (pending_signals)
5060 process_pending_signals ();
5062 /* Exit now if the cell we're waiting for became non-nil. */
5063 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
5064 break;
5066 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
5068 Lisp_Object process_list_head, aproc;
5069 struct Lisp_Process *p;
5071 retry_for_async = false;
5072 FOR_EACH_PROCESS(process_list_head, aproc)
5074 p = XPROCESS (aproc);
5076 if (! wait_proc || p == wait_proc)
5078 #ifdef HAVE_GETADDRINFO_A
5079 /* Check for pending DNS requests. */
5080 if (p->dns_request)
5082 Lisp_Object addrinfos = check_for_dns (aproc);
5083 if (!NILP (addrinfos) && !EQ (addrinfos, Qt))
5084 connect_network_socket (aproc, addrinfos, Qnil);
5085 else
5086 retry_for_async = true;
5088 #endif
5089 #ifdef HAVE_GNUTLS
5090 /* Continue TLS negotiation. */
5091 if (p->gnutls_initstage == GNUTLS_STAGE_HANDSHAKE_TRIED
5092 && p->is_non_blocking_client)
5094 gnutls_try_handshake (p);
5095 p->gnutls_handshakes_tried++;
5097 if (p->gnutls_initstage == GNUTLS_STAGE_READY)
5099 gnutls_verify_boot (aproc, Qnil);
5100 finish_after_tls_connection (aproc);
5102 else
5104 retry_for_async = true;
5105 if (p->gnutls_handshakes_tried
5106 > GNUTLS_EMACS_HANDSHAKES_LIMIT)
5108 deactivate_process (aproc);
5109 pset_status (p, list2 (Qfailed,
5110 build_string ("TLS negotiation failed")));
5114 #endif
5118 #endif /* GETADDRINFO_A or GNUTLS */
5120 /* Compute time from now till when time limit is up. */
5121 /* Exit if already run out. */
5122 if (wait == TIMEOUT)
5124 if (!timespec_valid_p (now))
5125 now = current_timespec ();
5126 if (timespec_cmp (end_time, now) <= 0)
5127 break;
5128 timeout = timespec_sub (end_time, now);
5130 else
5131 timeout = make_timespec (wait < TIMEOUT ? 0 : 100000, 0);
5133 /* Normally we run timers here.
5134 But not if wait_for_cell; in those cases,
5135 the wait is supposed to be short,
5136 and those callers cannot handle running arbitrary Lisp code here. */
5137 if (NILP (wait_for_cell)
5138 && just_wait_proc >= 0)
5142 unsigned old_timers_run = timers_run;
5143 struct buffer *old_buffer = current_buffer;
5144 Lisp_Object old_window = selected_window;
5146 timer_delay = timer_check ();
5148 /* If a timer has run, this might have changed buffers
5149 an alike. Make read_key_sequence aware of that. */
5150 if (timers_run != old_timers_run
5151 && (old_buffer != current_buffer
5152 || !EQ (old_window, selected_window))
5153 && waiting_for_user_input_p == -1)
5154 record_asynch_buffer_change ();
5156 if (timers_run != old_timers_run && do_display)
5157 /* We must retry, since a timer may have requeued itself
5158 and that could alter the time_delay. */
5159 redisplay_preserve_echo_area (9);
5160 else
5161 break;
5163 while (!detect_input_pending ());
5165 /* If there is unread keyboard input, also return. */
5166 if (read_kbd != 0
5167 && requeued_events_pending_p ())
5168 break;
5170 /* This is so a breakpoint can be put here. */
5171 if (!timespec_valid_p (timer_delay))
5172 wait_reading_process_output_1 ();
5175 /* Cause C-g and alarm signals to take immediate action,
5176 and cause input available signals to zero out timeout.
5178 It is important that we do this before checking for process
5179 activity. If we get a SIGCHLD after the explicit checks for
5180 process activity, timeout is the only way we will know. */
5181 if (read_kbd < 0)
5182 set_waiting_for_input (&timeout);
5184 /* If status of something has changed, and no input is
5185 available, notify the user of the change right away. After
5186 this explicit check, we'll let the SIGCHLD handler zap
5187 timeout to get our attention. */
5188 if (update_tick != process_tick)
5190 fd_set Atemp;
5191 fd_set Ctemp;
5193 if (kbd_on_hold_p ())
5194 FD_ZERO (&Atemp);
5195 else
5196 compute_input_wait_mask (&Atemp);
5197 compute_write_mask (&Ctemp);
5199 timeout = make_timespec (0, 0);
5200 if ((thread_select (pselect, max_desc + 1,
5201 &Atemp,
5202 (num_pending_connects > 0 ? &Ctemp : NULL),
5203 NULL, &timeout, NULL)
5204 <= 0))
5206 /* It's okay for us to do this and then continue with
5207 the loop, since timeout has already been zeroed out. */
5208 clear_waiting_for_input ();
5209 got_some_output = status_notify (NULL, wait_proc);
5210 if (do_display) redisplay_preserve_echo_area (13);
5214 /* Don't wait for output from a non-running process. Just
5215 read whatever data has already been received. */
5216 if (wait_proc && wait_proc->raw_status_new)
5217 update_status (wait_proc);
5218 if (wait_proc
5219 && ! EQ (wait_proc->status, Qrun)
5220 && ! connecting_status (wait_proc->status))
5222 bool read_some_bytes = false;
5224 clear_waiting_for_input ();
5226 /* If data can be read from the process, do so until exhausted. */
5227 if (wait_proc->infd >= 0)
5229 XSETPROCESS (proc, wait_proc);
5231 while (true)
5233 int nread = read_process_output (proc, wait_proc->infd);
5234 if (nread < 0)
5236 if (errno == EIO || would_block (errno))
5237 break;
5239 else
5241 if (got_some_output < nread)
5242 got_some_output = nread;
5243 if (nread == 0)
5244 break;
5245 read_some_bytes = true;
5250 if (read_some_bytes && do_display)
5251 redisplay_preserve_echo_area (10);
5253 break;
5256 /* Wait till there is something to do. */
5258 if (wait_proc && just_wait_proc)
5260 if (wait_proc->infd < 0) /* Terminated. */
5261 break;
5262 FD_SET (wait_proc->infd, &Available);
5263 check_delay = 0;
5264 check_write = 0;
5266 else if (!NILP (wait_for_cell))
5268 compute_non_process_wait_mask (&Available);
5269 check_delay = 0;
5270 check_write = 0;
5272 else
5274 if (! read_kbd)
5275 compute_non_keyboard_wait_mask (&Available);
5276 else
5277 compute_input_wait_mask (&Available);
5278 compute_write_mask (&Writeok);
5279 check_delay = wait_proc ? 0 : process_output_delay_count;
5280 check_write = true;
5283 /* If frame size has changed or the window is newly mapped,
5284 redisplay now, before we start to wait. There is a race
5285 condition here; if a SIGIO arrives between now and the select
5286 and indicates that a frame is trashed, the select may block
5287 displaying a trashed screen. */
5288 if (frame_garbaged && do_display)
5290 clear_waiting_for_input ();
5291 redisplay_preserve_echo_area (11);
5292 if (read_kbd < 0)
5293 set_waiting_for_input (&timeout);
5296 /* Skip the `select' call if input is available and we're
5297 waiting for keyboard input or a cell change (which can be
5298 triggered by processing X events). In the latter case, set
5299 nfds to 1 to avoid breaking the loop. */
5300 no_avail = 0;
5301 if ((read_kbd || !NILP (wait_for_cell))
5302 && detect_input_pending ())
5304 nfds = read_kbd ? 0 : 1;
5305 no_avail = 1;
5306 FD_ZERO (&Available);
5308 else
5310 /* Set the timeout for adaptive read buffering if any
5311 process has non-zero read_output_skip and non-zero
5312 read_output_delay, and we are not reading output for a
5313 specific process. It is not executed if
5314 Vprocess_adaptive_read_buffering is nil. */
5315 if (process_output_skip && check_delay > 0)
5317 int adaptive_nsecs = timeout.tv_nsec;
5318 if (timeout.tv_sec > 0 || adaptive_nsecs > READ_OUTPUT_DELAY_MAX)
5319 adaptive_nsecs = READ_OUTPUT_DELAY_MAX;
5320 for (channel = 0; check_delay > 0 && channel <= max_desc; channel++)
5322 proc = chan_process[channel];
5323 if (NILP (proc))
5324 continue;
5325 /* Find minimum non-zero read_output_delay among the
5326 processes with non-zero read_output_skip. */
5327 if (XPROCESS (proc)->read_output_delay > 0)
5329 check_delay--;
5330 if (!XPROCESS (proc)->read_output_skip)
5331 continue;
5332 FD_CLR (channel, &Available);
5333 process_skipped = true;
5334 XPROCESS (proc)->read_output_skip = 0;
5335 if (XPROCESS (proc)->read_output_delay < adaptive_nsecs)
5336 adaptive_nsecs = XPROCESS (proc)->read_output_delay;
5339 timeout = make_timespec (0, adaptive_nsecs);
5340 process_output_skip = 0;
5343 /* If we've got some output and haven't limited our timeout
5344 with adaptive read buffering, limit it. */
5345 if (got_some_output > 0 && !process_skipped
5346 && (timeout.tv_sec
5347 || timeout.tv_nsec > READ_OUTPUT_DELAY_INCREMENT))
5348 timeout = make_timespec (0, READ_OUTPUT_DELAY_INCREMENT);
5351 if (NILP (wait_for_cell) && just_wait_proc >= 0
5352 && timespec_valid_p (timer_delay)
5353 && timespec_cmp (timer_delay, timeout) < 0)
5355 if (!timespec_valid_p (now))
5356 now = current_timespec ();
5357 struct timespec timeout_abs = timespec_add (now, timeout);
5358 if (!timespec_valid_p (got_output_end_time)
5359 || timespec_cmp (timeout_abs, got_output_end_time) < 0)
5360 got_output_end_time = timeout_abs;
5361 timeout = timer_delay;
5363 else
5364 got_output_end_time = invalid_timespec ();
5366 /* NOW can become inaccurate if time can pass during pselect. */
5367 if (timeout.tv_sec > 0 || timeout.tv_nsec > 0)
5368 now = invalid_timespec ();
5370 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
5371 if (retry_for_async
5372 && (timeout.tv_sec > 0 || timeout.tv_nsec > ASYNC_RETRY_NSEC))
5374 timeout.tv_sec = 0;
5375 timeout.tv_nsec = ASYNC_RETRY_NSEC;
5377 #endif
5379 /* Non-macOS HAVE_GLIB builds call thread_select in xgselect.c. */
5380 #if defined HAVE_GLIB && !defined HAVE_NS
5381 nfds = xg_select (max_desc + 1,
5382 &Available, (check_write ? &Writeok : 0),
5383 NULL, &timeout, NULL);
5384 #elif defined HAVE_NS
5385 /* And NS builds call thread_select in ns_select. */
5386 nfds = ns_select (max_desc + 1,
5387 &Available, (check_write ? &Writeok : 0),
5388 NULL, &timeout, NULL);
5389 #else /* !HAVE_GLIB */
5390 nfds = thread_select (pselect, max_desc + 1,
5391 &Available,
5392 (check_write ? &Writeok : 0),
5393 NULL, &timeout, NULL);
5394 #endif /* !HAVE_GLIB */
5396 #ifdef HAVE_GNUTLS
5397 /* GnuTLS buffers data internally. In lowat mode it leaves
5398 some data in the TCP buffers so that select works, but
5399 with custom pull/push functions we need to check if some
5400 data is available in the buffers manually. */
5401 if (nfds == 0)
5403 fd_set tls_available;
5404 int set = 0;
5406 FD_ZERO (&tls_available);
5407 if (! wait_proc)
5409 /* We're not waiting on a specific process, so loop
5410 through all the channels and check for data.
5411 This is a workaround needed for some versions of
5412 the gnutls library -- 2.12.14 has been confirmed
5413 to need it. See
5414 http://comments.gmane.org/gmane.emacs.devel/145074 */
5415 for (channel = 0; channel < FD_SETSIZE; ++channel)
5416 if (! NILP (chan_process[channel]))
5418 struct Lisp_Process *p =
5419 XPROCESS (chan_process[channel]);
5420 if (p && p->gnutls_p && p->gnutls_state
5421 && ((emacs_gnutls_record_check_pending
5422 (p->gnutls_state))
5423 > 0))
5425 nfds++;
5426 eassert (p->infd == channel);
5427 FD_SET (p->infd, &tls_available);
5428 set++;
5432 else
5434 /* Check this specific channel. */
5435 if (wait_proc->gnutls_p /* Check for valid process. */
5436 && wait_proc->gnutls_state
5437 /* Do we have pending data? */
5438 && ((emacs_gnutls_record_check_pending
5439 (wait_proc->gnutls_state))
5440 > 0))
5442 nfds = 1;
5443 eassert (0 <= wait_proc->infd);
5444 /* Set to Available. */
5445 FD_SET (wait_proc->infd, &tls_available);
5446 set++;
5449 if (set)
5450 Available = tls_available;
5452 #endif
5455 xerrno = errno;
5457 /* Make C-g and alarm signals set flags again. */
5458 clear_waiting_for_input ();
5460 /* If we woke up due to SIGWINCH, actually change size now. */
5461 do_pending_window_change (0);
5463 if (nfds == 0)
5465 /* Exit the main loop if we've passed the requested timeout,
5466 or aren't skipping processes and got some output and
5467 haven't lowered our timeout due to timers or SIGIO and
5468 have waited a long amount of time due to repeated
5469 timers. */
5470 struct timespec huge_timespec
5471 = make_timespec (TYPE_MAXIMUM (time_t), 2 * TIMESPEC_RESOLUTION);
5472 struct timespec cmp_time = huge_timespec;
5473 if (wait < TIMEOUT)
5474 break;
5475 if (wait == TIMEOUT)
5476 cmp_time = end_time;
5477 if (!process_skipped && got_some_output > 0
5478 && (timeout.tv_sec > 0 || timeout.tv_nsec > 0))
5480 if (!timespec_valid_p (got_output_end_time))
5481 break;
5482 if (timespec_cmp (got_output_end_time, cmp_time) < 0)
5483 cmp_time = got_output_end_time;
5485 if (timespec_cmp (cmp_time, huge_timespec) < 0)
5487 now = current_timespec ();
5488 if (timespec_cmp (cmp_time, now) <= 0)
5489 break;
5493 if (nfds < 0)
5495 if (xerrno == EINTR)
5496 no_avail = 1;
5497 else if (xerrno == EBADF)
5498 emacs_abort ();
5499 else
5500 report_file_errno ("Failed select", Qnil, xerrno);
5503 /* Check for keyboard input. */
5504 /* If there is any, return immediately
5505 to give it higher priority than subprocesses. */
5507 if (read_kbd != 0)
5509 unsigned old_timers_run = timers_run;
5510 struct buffer *old_buffer = current_buffer;
5511 Lisp_Object old_window = selected_window;
5512 bool leave = false;
5514 if (detect_input_pending_run_timers (do_display))
5516 swallow_events (do_display);
5517 if (detect_input_pending_run_timers (do_display))
5518 leave = true;
5521 /* If a timer has run, this might have changed buffers
5522 an alike. Make read_key_sequence aware of that. */
5523 if (timers_run != old_timers_run
5524 && waiting_for_user_input_p == -1
5525 && (old_buffer != current_buffer
5526 || !EQ (old_window, selected_window)))
5527 record_asynch_buffer_change ();
5529 if (leave)
5530 break;
5533 /* If there is unread keyboard input, also return. */
5534 if (read_kbd != 0
5535 && requeued_events_pending_p ())
5536 break;
5538 /* If we are not checking for keyboard input now,
5539 do process events (but don't run any timers).
5540 This is so that X events will be processed.
5541 Otherwise they may have to wait until polling takes place.
5542 That would causes delays in pasting selections, for example.
5544 (We used to do this only if wait_for_cell.) */
5545 if (read_kbd == 0 && detect_input_pending ())
5547 swallow_events (do_display);
5548 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
5549 if (detect_input_pending ())
5550 break;
5551 #endif
5554 /* Exit now if the cell we're waiting for became non-nil. */
5555 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
5556 break;
5558 #ifdef USABLE_SIGIO
5559 /* If we think we have keyboard input waiting, but didn't get SIGIO,
5560 go read it. This can happen with X on BSD after logging out.
5561 In that case, there really is no input and no SIGIO,
5562 but select says there is input. */
5564 if (read_kbd && interrupt_input
5565 && keyboard_bit_set (&Available) && ! noninteractive)
5566 handle_input_available_signal (SIGIO);
5567 #endif
5569 /* If checking input just got us a size-change event from X,
5570 obey it now if we should. */
5571 if (read_kbd || ! NILP (wait_for_cell))
5572 do_pending_window_change (0);
5574 /* Check for data from a process. */
5575 if (no_avail || nfds == 0)
5576 continue;
5578 for (channel = 0; channel <= max_desc; ++channel)
5580 struct fd_callback_data *d = &fd_callback_info[channel];
5581 if (d->func
5582 && ((d->flags & FOR_READ
5583 && FD_ISSET (channel, &Available))
5584 || ((d->flags & FOR_WRITE)
5585 && FD_ISSET (channel, &Writeok))))
5586 d->func (channel, d->data);
5589 for (channel = 0; channel <= max_desc; channel++)
5591 if (FD_ISSET (channel, &Available)
5592 && ((fd_callback_info[channel].flags & (KEYBOARD_FD | PROCESS_FD))
5593 == PROCESS_FD))
5595 int nread;
5597 /* If waiting for this channel, arrange to return as
5598 soon as no more input to be processed. No more
5599 waiting. */
5600 proc = chan_process[channel];
5601 if (NILP (proc))
5602 continue;
5604 /* If this is a server stream socket, accept connection. */
5605 if (EQ (XPROCESS (proc)->status, Qlisten))
5607 server_accept_connection (proc, channel);
5608 continue;
5611 /* Read data from the process, starting with our
5612 buffered-ahead character if we have one. */
5614 nread = read_process_output (proc, channel);
5615 if ((!wait_proc || wait_proc == XPROCESS (proc))
5616 && got_some_output < nread)
5617 got_some_output = nread;
5618 if (nread > 0)
5620 /* Vacuum up any leftovers without waiting. */
5621 if (wait_proc == XPROCESS (proc))
5622 wait = MINIMUM;
5623 /* Since read_process_output can run a filter,
5624 which can call accept-process-output,
5625 don't try to read from any other processes
5626 before doing the select again. */
5627 FD_ZERO (&Available);
5629 if (do_display)
5630 redisplay_preserve_echo_area (12);
5632 else if (nread == -1 && would_block (errno))
5634 #ifdef HAVE_PTYS
5635 /* On some OSs with ptys, when the process on one end of
5636 a pty exits, the other end gets an error reading with
5637 errno = EIO instead of getting an EOF (0 bytes read).
5638 Therefore, if we get an error reading and errno =
5639 EIO, just continue, because the child process has
5640 exited and should clean itself up soon (e.g. when we
5641 get a SIGCHLD). */
5642 else if (nread == -1 && errno == EIO)
5644 struct Lisp_Process *p = XPROCESS (proc);
5646 /* Clear the descriptor now, so we only raise the
5647 signal once. */
5648 delete_read_fd (channel);
5650 if (p->pid == -2)
5652 /* If the EIO occurs on a pty, the SIGCHLD handler's
5653 waitpid call will not find the process object to
5654 delete. Do it here. */
5655 p->tick = ++process_tick;
5656 pset_status (p, Qfailed);
5659 #endif /* HAVE_PTYS */
5660 /* If we can detect process termination, don't consider the
5661 process gone just because its pipe is closed. */
5662 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc)
5663 && !PIPECONN_P (proc))
5665 else if (nread == 0 && PIPECONN_P (proc))
5667 /* Preserve status of processes already terminated. */
5668 XPROCESS (proc)->tick = ++process_tick;
5669 deactivate_process (proc);
5670 if (EQ (XPROCESS (proc)->status, Qrun))
5671 pset_status (XPROCESS (proc),
5672 list2 (Qexit, make_number (0)));
5674 else
5676 /* Preserve status of processes already terminated. */
5677 XPROCESS (proc)->tick = ++process_tick;
5678 deactivate_process (proc);
5679 if (XPROCESS (proc)->raw_status_new)
5680 update_status (XPROCESS (proc));
5681 if (EQ (XPROCESS (proc)->status, Qrun))
5682 pset_status (XPROCESS (proc),
5683 list2 (Qexit, make_number (256)));
5686 if (FD_ISSET (channel, &Writeok)
5687 && (fd_callback_info[channel].flags
5688 & NON_BLOCKING_CONNECT_FD) != 0)
5690 struct Lisp_Process *p;
5692 delete_write_fd (channel);
5694 proc = chan_process[channel];
5695 if (NILP (proc))
5696 continue;
5698 p = XPROCESS (proc);
5700 #ifndef WINDOWSNT
5702 socklen_t xlen = sizeof (xerrno);
5703 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
5704 xerrno = errno;
5706 #else
5707 /* On MS-Windows, getsockopt clears the error for the
5708 entire process, which may not be the right thing; see
5709 w32.c. Use getpeername instead. */
5711 struct sockaddr pname;
5712 socklen_t pnamelen = sizeof (pname);
5714 /* If connection failed, getpeername will fail. */
5715 xerrno = 0;
5716 if (getpeername (channel, &pname, &pnamelen) < 0)
5718 /* Obtain connect failure code through error slippage. */
5719 char dummy;
5720 xerrno = errno;
5721 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
5722 xerrno = errno;
5725 #endif
5726 if (xerrno)
5728 Lisp_Object addrinfos
5729 = connecting_status (p->status) ? XCDR (p->status) : Qnil;
5730 if (!NILP (addrinfos))
5731 XSETCDR (p->status, XCDR (addrinfos));
5732 else
5734 p->tick = ++process_tick;
5735 pset_status (p, list2 (Qfailed, make_number (xerrno)));
5737 deactivate_process (proc);
5738 if (!NILP (addrinfos))
5739 connect_network_socket (proc, addrinfos, Qnil);
5741 else
5743 #ifdef HAVE_GNUTLS
5744 /* If we have an incompletely set up TLS connection,
5745 then defer the sentinel signaling until
5746 later. */
5747 if (NILP (p->gnutls_boot_parameters)
5748 && !p->gnutls_p)
5749 #endif
5751 pset_status (p, Qrun);
5752 /* Execute the sentinel here. If we had relied on
5753 status_notify to do it later, it will read input
5754 from the process before calling the sentinel. */
5755 exec_sentinel (proc, build_string ("open\n"));
5758 if (0 <= p->infd && !EQ (p->filter, Qt)
5759 && !EQ (p->command, Qt))
5760 add_process_read_fd (p->infd);
5763 } /* End for each file descriptor. */
5764 } /* End while exit conditions not met. */
5766 unbind_to (count, Qnil);
5768 /* If calling from keyboard input, do not quit
5769 since we want to return C-g as an input character.
5770 Otherwise, do pending quit if requested. */
5771 if (read_kbd >= 0)
5773 /* Prevent input_pending from remaining set if we quit. */
5774 clear_input_pending ();
5775 maybe_quit ();
5778 return got_some_output;
5781 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
5783 static Lisp_Object
5784 read_process_output_call (Lisp_Object fun_and_args)
5786 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
5789 static Lisp_Object
5790 read_process_output_error_handler (Lisp_Object error_val)
5792 cmd_error_internal (error_val, "error in process filter: ");
5793 Vinhibit_quit = Qt;
5794 update_echo_area ();
5795 Fsleep_for (make_number (2), Qnil);
5796 return Qt;
5799 static void
5800 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5801 ssize_t nbytes,
5802 struct coding_system *coding);
5804 /* Read pending output from the process channel,
5805 starting with our buffered-ahead character if we have one.
5806 Yield number of decoded characters read.
5808 This function reads at most 4096 characters.
5809 If you want to read all available subprocess output,
5810 you must call it repeatedly until it returns zero.
5812 The characters read are decoded according to PROC's coding-system
5813 for decoding. */
5815 static int
5816 read_process_output (Lisp_Object proc, int channel)
5818 ssize_t nbytes;
5819 struct Lisp_Process *p = XPROCESS (proc);
5820 struct coding_system *coding = proc_decode_coding_system[channel];
5821 int carryover = p->decoding_carryover;
5822 enum { readmax = 4096 };
5823 ptrdiff_t count = SPECPDL_INDEX ();
5824 Lisp_Object odeactivate;
5825 char chars[sizeof coding->carryover + readmax];
5827 if (carryover)
5828 /* See the comment above. */
5829 memcpy (chars, SDATA (p->decoding_buf), carryover);
5831 #ifdef DATAGRAM_SOCKETS
5832 /* We have a working select, so proc_buffered_char is always -1. */
5833 if (DATAGRAM_CHAN_P (channel))
5835 socklen_t len = datagram_address[channel].len;
5836 nbytes = recvfrom (channel, chars + carryover, readmax,
5837 0, datagram_address[channel].sa, &len);
5839 else
5840 #endif
5842 bool buffered = proc_buffered_char[channel] >= 0;
5843 if (buffered)
5845 chars[carryover] = proc_buffered_char[channel];
5846 proc_buffered_char[channel] = -1;
5848 #ifdef HAVE_GNUTLS
5849 if (p->gnutls_p && p->gnutls_state)
5850 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
5851 readmax - buffered);
5852 else
5853 #endif
5854 nbytes = emacs_read (channel, chars + carryover + buffered,
5855 readmax - buffered);
5856 if (nbytes > 0 && p->adaptive_read_buffering)
5858 int delay = p->read_output_delay;
5859 if (nbytes < 256)
5861 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5863 if (delay == 0)
5864 process_output_delay_count++;
5865 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5868 else if (delay > 0 && nbytes == readmax - buffered)
5870 delay -= READ_OUTPUT_DELAY_INCREMENT;
5871 if (delay == 0)
5872 process_output_delay_count--;
5874 p->read_output_delay = delay;
5875 if (delay)
5877 p->read_output_skip = 1;
5878 process_output_skip = 1;
5881 nbytes += buffered;
5882 nbytes += buffered && nbytes <= 0;
5885 p->decoding_carryover = 0;
5887 /* At this point, NBYTES holds number of bytes just received
5888 (including the one in proc_buffered_char[channel]). */
5889 if (nbytes <= 0)
5891 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5892 return nbytes;
5893 coding->mode |= CODING_MODE_LAST_BLOCK;
5896 /* Now set NBYTES how many bytes we must decode. */
5897 nbytes += carryover;
5899 odeactivate = Vdeactivate_mark;
5900 /* There's no good reason to let process filters change the current
5901 buffer, and many callers of accept-process-output, sit-for, and
5902 friends don't expect current-buffer to be changed from under them. */
5903 record_unwind_current_buffer ();
5905 read_and_dispose_of_process_output (p, chars, nbytes, coding);
5907 /* Handling the process output should not deactivate the mark. */
5908 Vdeactivate_mark = odeactivate;
5910 unbind_to (count, Qnil);
5911 return nbytes;
5914 static void
5915 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5916 ssize_t nbytes,
5917 struct coding_system *coding)
5919 Lisp_Object outstream = p->filter;
5920 Lisp_Object text;
5921 bool outer_running_asynch_code = running_asynch_code;
5922 int waiting = waiting_for_user_input_p;
5924 #if 0
5925 Lisp_Object obuffer, okeymap;
5926 XSETBUFFER (obuffer, current_buffer);
5927 okeymap = BVAR (current_buffer, keymap);
5928 #endif
5930 /* We inhibit quit here instead of just catching it so that
5931 hitting ^G when a filter happens to be running won't screw
5932 it up. */
5933 specbind (Qinhibit_quit, Qt);
5934 specbind (Qlast_nonmenu_event, Qt);
5936 /* In case we get recursively called,
5937 and we already saved the match data nonrecursively,
5938 save the same match data in safely recursive fashion. */
5939 if (outer_running_asynch_code)
5941 Lisp_Object tem;
5942 /* Don't clobber the CURRENT match data, either! */
5943 tem = Fmatch_data (Qnil, Qnil, Qnil);
5944 restore_search_regs ();
5945 record_unwind_save_match_data ();
5946 Fset_match_data (tem, Qt);
5949 /* For speed, if a search happens within this code,
5950 save the match data in a special nonrecursive fashion. */
5951 running_asynch_code = 1;
5953 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5954 text = coding->dst_object;
5955 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5956 /* A new coding system might be found. */
5957 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5959 pset_decode_coding_system (p, Vlast_coding_system_used);
5961 /* Don't call setup_coding_system for
5962 proc_decode_coding_system[channel] here. It is done in
5963 detect_coding called via decode_coding above. */
5965 /* If a coding system for encoding is not yet decided, we set
5966 it as the same as coding-system for decoding.
5968 But, before doing that we must check if
5969 proc_encode_coding_system[p->outfd] surely points to a
5970 valid memory because p->outfd will be changed once EOF is
5971 sent to the process. */
5972 if (NILP (p->encode_coding_system) && p->outfd >= 0
5973 && proc_encode_coding_system[p->outfd])
5975 pset_encode_coding_system
5976 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5977 setup_coding_system (p->encode_coding_system,
5978 proc_encode_coding_system[p->outfd]);
5982 if (coding->carryover_bytes > 0)
5984 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5985 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5986 memcpy (SDATA (p->decoding_buf), coding->carryover,
5987 coding->carryover_bytes);
5988 p->decoding_carryover = coding->carryover_bytes;
5990 if (SBYTES (text) > 0)
5991 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5992 sometimes it's simply wrong to wrap (e.g. when called from
5993 accept-process-output). */
5994 internal_condition_case_1 (read_process_output_call,
5995 list3 (outstream, make_lisp_proc (p), text),
5996 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5997 read_process_output_error_handler);
5999 /* If we saved the match data nonrecursively, restore it now. */
6000 restore_search_regs ();
6001 running_asynch_code = outer_running_asynch_code;
6003 /* Restore waiting_for_user_input_p as it was
6004 when we were called, in case the filter clobbered it. */
6005 waiting_for_user_input_p = waiting;
6007 #if 0 /* Call record_asynch_buffer_change unconditionally,
6008 because we might have changed minor modes or other things
6009 that affect key bindings. */
6010 if (! EQ (Fcurrent_buffer (), obuffer)
6011 || ! EQ (current_buffer->keymap, okeymap))
6012 #endif
6013 /* But do it only if the caller is actually going to read events.
6014 Otherwise there's no need to make him wake up, and it could
6015 cause trouble (for example it would make sit_for return). */
6016 if (waiting_for_user_input_p == -1)
6017 record_asynch_buffer_change ();
6020 DEFUN ("internal-default-process-filter", Finternal_default_process_filter,
6021 Sinternal_default_process_filter, 2, 2, 0,
6022 doc: /* Function used as default process filter.
6023 This inserts the process's output into its buffer, if there is one.
6024 Otherwise it discards the output. */)
6025 (Lisp_Object proc, Lisp_Object text)
6027 struct Lisp_Process *p;
6028 ptrdiff_t opoint;
6030 CHECK_PROCESS (proc);
6031 p = XPROCESS (proc);
6032 CHECK_STRING (text);
6034 if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
6036 Lisp_Object old_read_only;
6037 ptrdiff_t old_begv, old_zv;
6038 ptrdiff_t old_begv_byte, old_zv_byte;
6039 ptrdiff_t before, before_byte;
6040 ptrdiff_t opoint_byte;
6041 struct buffer *b;
6043 Fset_buffer (p->buffer);
6044 opoint = PT;
6045 opoint_byte = PT_BYTE;
6046 old_read_only = BVAR (current_buffer, read_only);
6047 old_begv = BEGV;
6048 old_zv = ZV;
6049 old_begv_byte = BEGV_BYTE;
6050 old_zv_byte = ZV_BYTE;
6052 bset_read_only (current_buffer, Qnil);
6054 /* Insert new output into buffer at the current end-of-output
6055 marker, thus preserving logical ordering of input and output. */
6056 if (XMARKER (p->mark)->buffer)
6057 set_point_from_marker (p->mark);
6058 else
6059 SET_PT_BOTH (ZV, ZV_BYTE);
6060 before = PT;
6061 before_byte = PT_BYTE;
6063 /* If the output marker is outside of the visible region, save
6064 the restriction and widen. */
6065 if (! (BEGV <= PT && PT <= ZV))
6066 Fwiden ();
6068 /* Adjust the multibyteness of TEXT to that of the buffer. */
6069 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
6070 != ! STRING_MULTIBYTE (text))
6071 text = (STRING_MULTIBYTE (text)
6072 ? Fstring_as_unibyte (text)
6073 : Fstring_to_multibyte (text));
6074 /* Insert before markers in case we are inserting where
6075 the buffer's mark is, and the user's next command is Meta-y. */
6076 insert_from_string_before_markers (text, 0, 0,
6077 SCHARS (text), SBYTES (text), 0);
6079 /* Make sure the process marker's position is valid when the
6080 process buffer is changed in the signal_after_change above.
6081 W3 is known to do that. */
6082 if (BUFFERP (p->buffer)
6083 && (b = XBUFFER (p->buffer), b != current_buffer))
6084 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
6085 else
6086 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6088 update_mode_lines = 23;
6090 /* Make sure opoint and the old restrictions
6091 float ahead of any new text just as point would. */
6092 if (opoint >= before)
6094 opoint += PT - before;
6095 opoint_byte += PT_BYTE - before_byte;
6097 if (old_begv > before)
6099 old_begv += PT - before;
6100 old_begv_byte += PT_BYTE - before_byte;
6102 if (old_zv >= before)
6104 old_zv += PT - before;
6105 old_zv_byte += PT_BYTE - before_byte;
6108 /* If the restriction isn't what it should be, set it. */
6109 if (old_begv != BEGV || old_zv != ZV)
6110 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
6112 bset_read_only (current_buffer, old_read_only);
6113 SET_PT_BOTH (opoint, opoint_byte);
6115 return Qnil;
6118 /* Sending data to subprocess. */
6120 /* In send_process, when a write fails temporarily,
6121 wait_reading_process_output is called. It may execute user code,
6122 e.g. timers, that attempts to write new data to the same process.
6123 We must ensure that data is sent in the right order, and not
6124 interspersed half-completed with other writes (Bug#10815). This is
6125 handled by the write_queue element of struct process. It is a list
6126 with each entry having the form
6128 (string . (offset . length))
6130 where STRING is a lisp string, OFFSET is the offset into the
6131 string's byte sequence from which we should begin to send, and
6132 LENGTH is the number of bytes left to send. */
6134 /* Create a new entry in write_queue.
6135 INPUT_OBJ should be a buffer, string Qt, or Qnil.
6136 BUF is a pointer to the string sequence of the input_obj or a C
6137 string in case of Qt or Qnil. */
6139 static void
6140 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
6141 const char *buf, ptrdiff_t len, bool front)
6143 ptrdiff_t offset;
6144 Lisp_Object entry, obj;
6146 if (STRINGP (input_obj))
6148 offset = buf - SSDATA (input_obj);
6149 obj = input_obj;
6151 else
6153 offset = 0;
6154 obj = make_unibyte_string (buf, len);
6157 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
6159 if (front)
6160 pset_write_queue (p, Fcons (entry, p->write_queue));
6161 else
6162 pset_write_queue (p, nconc2 (p->write_queue, list1 (entry)));
6165 /* Remove the first element in the write_queue of process P, put its
6166 contents in OBJ, BUF and LEN, and return true. If the
6167 write_queue is empty, return false. */
6169 static bool
6170 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
6171 const char **buf, ptrdiff_t *len)
6173 Lisp_Object entry, offset_length;
6174 ptrdiff_t offset;
6176 if (NILP (p->write_queue))
6177 return 0;
6179 entry = XCAR (p->write_queue);
6180 pset_write_queue (p, XCDR (p->write_queue));
6182 *obj = XCAR (entry);
6183 offset_length = XCDR (entry);
6185 *len = XINT (XCDR (offset_length));
6186 offset = XINT (XCAR (offset_length));
6187 *buf = SSDATA (*obj) + offset;
6189 return 1;
6192 /* Send some data to process PROC.
6193 BUF is the beginning of the data; LEN is the number of characters.
6194 OBJECT is the Lisp object that the data comes from. If OBJECT is
6195 nil or t, it means that the data comes from C string.
6197 If OBJECT is not nil, the data is encoded by PROC's coding-system
6198 for encoding before it is sent.
6200 This function can evaluate Lisp code and can garbage collect. */
6202 static void
6203 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
6204 Lisp_Object object)
6206 struct Lisp_Process *p = XPROCESS (proc);
6207 ssize_t rv;
6208 struct coding_system *coding;
6210 if (NETCONN_P (proc))
6212 wait_while_connecting (proc);
6213 wait_for_tls_negotiation (proc);
6216 if (p->raw_status_new)
6217 update_status (p);
6218 if (! EQ (p->status, Qrun))
6219 error ("Process %s not running", SDATA (p->name));
6220 if (p->outfd < 0)
6221 error ("Output file descriptor of %s is closed", SDATA (p->name));
6223 coding = proc_encode_coding_system[p->outfd];
6224 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
6226 if ((STRINGP (object) && STRING_MULTIBYTE (object))
6227 || (BUFFERP (object)
6228 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
6229 || EQ (object, Qt))
6231 pset_encode_coding_system
6232 (p, complement_process_encoding_system (p->encode_coding_system));
6233 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
6235 /* The coding system for encoding was changed to raw-text
6236 because we sent a unibyte text previously. Now we are
6237 sending a multibyte text, thus we must encode it by the
6238 original coding system specified for the current process.
6240 Another reason we come here is that the coding system
6241 was just complemented and a new one was returned by
6242 complement_process_encoding_system. */
6243 setup_coding_system (p->encode_coding_system, coding);
6244 Vlast_coding_system_used = p->encode_coding_system;
6246 coding->src_multibyte = 1;
6248 else
6250 coding->src_multibyte = 0;
6251 /* For sending a unibyte text, character code conversion should
6252 not take place but EOL conversion should. So, setup raw-text
6253 or one of the subsidiary if we have not yet done it. */
6254 if (CODING_REQUIRE_ENCODING (coding))
6256 if (CODING_REQUIRE_FLUSHING (coding))
6258 /* But, before changing the coding, we must flush out data. */
6259 coding->mode |= CODING_MODE_LAST_BLOCK;
6260 send_process (proc, "", 0, Qt);
6261 coding->mode &= CODING_MODE_LAST_BLOCK;
6263 setup_coding_system (raw_text_coding_system
6264 (Vlast_coding_system_used),
6265 coding);
6266 coding->src_multibyte = 0;
6269 coding->dst_multibyte = 0;
6271 if (CODING_REQUIRE_ENCODING (coding))
6273 coding->dst_object = Qt;
6274 if (BUFFERP (object))
6276 ptrdiff_t from_byte, from, to;
6277 ptrdiff_t save_pt, save_pt_byte;
6278 struct buffer *cur = current_buffer;
6280 set_buffer_internal (XBUFFER (object));
6281 save_pt = PT, save_pt_byte = PT_BYTE;
6283 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
6284 from = BYTE_TO_CHAR (from_byte);
6285 to = BYTE_TO_CHAR (from_byte + len);
6286 TEMP_SET_PT_BOTH (from, from_byte);
6287 encode_coding_object (coding, object, from, from_byte,
6288 to, from_byte + len, Qt);
6289 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
6290 set_buffer_internal (cur);
6292 else if (STRINGP (object))
6294 encode_coding_object (coding, object, 0, 0, SCHARS (object),
6295 SBYTES (object), Qt);
6297 else
6299 coding->dst_object = make_unibyte_string (buf, len);
6300 coding->produced = len;
6303 len = coding->produced;
6304 object = coding->dst_object;
6305 buf = SSDATA (object);
6308 /* If there is already data in the write_queue, put the new data
6309 in the back of queue. Otherwise, ignore it. */
6310 if (!NILP (p->write_queue))
6311 write_queue_push (p, object, buf, len, 0);
6313 do /* while !NILP (p->write_queue) */
6315 ptrdiff_t cur_len = -1;
6316 const char *cur_buf;
6317 Lisp_Object cur_object;
6319 /* If write_queue is empty, ignore it. */
6320 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
6322 cur_len = len;
6323 cur_buf = buf;
6324 cur_object = object;
6327 while (cur_len > 0)
6329 /* Send this batch, using one or more write calls. */
6330 ptrdiff_t written = 0;
6331 int outfd = p->outfd;
6332 #ifdef DATAGRAM_SOCKETS
6333 if (DATAGRAM_CHAN_P (outfd))
6335 rv = sendto (outfd, cur_buf, cur_len,
6336 0, datagram_address[outfd].sa,
6337 datagram_address[outfd].len);
6338 if (rv >= 0)
6339 written = rv;
6340 else if (errno == EMSGSIZE)
6341 report_file_error ("Sending datagram", proc);
6343 else
6344 #endif
6346 #ifdef HAVE_GNUTLS
6347 if (p->gnutls_p && p->gnutls_state)
6348 written = emacs_gnutls_write (p, cur_buf, cur_len);
6349 else
6350 #endif
6351 written = emacs_write_sig (outfd, cur_buf, cur_len);
6352 rv = (written ? 0 : -1);
6353 if (p->read_output_delay > 0
6354 && p->adaptive_read_buffering == 1)
6356 p->read_output_delay = 0;
6357 process_output_delay_count--;
6358 p->read_output_skip = 0;
6362 if (rv < 0)
6364 if (would_block (errno))
6365 /* Buffer is full. Wait, accepting input;
6366 that may allow the program
6367 to finish doing output and read more. */
6369 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
6370 /* A gross hack to work around a bug in FreeBSD.
6371 In the following sequence, read(2) returns
6372 bogus data:
6374 write(2) 1022 bytes
6375 write(2) 954 bytes, get EAGAIN
6376 read(2) 1024 bytes in process_read_output
6377 read(2) 11 bytes in process_read_output
6379 That is, read(2) returns more bytes than have
6380 ever been written successfully. The 1033 bytes
6381 read are the 1022 bytes written successfully
6382 after processing (for example with CRs added if
6383 the terminal is set up that way which it is
6384 here). The same bytes will be seen again in a
6385 later read(2), without the CRs. */
6387 if (errno == EAGAIN)
6389 int flags = FWRITE;
6390 ioctl (p->outfd, TIOCFLUSH, &flags);
6392 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
6394 /* Put what we should have written in wait_queue. */
6395 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
6396 wait_reading_process_output (0, 20 * 1000 * 1000,
6397 0, 0, Qnil, NULL, 0);
6398 /* Reread queue, to see what is left. */
6399 break;
6401 else if (errno == EPIPE)
6403 p->raw_status_new = 0;
6404 pset_status (p, list2 (Qexit, make_number (256)));
6405 p->tick = ++process_tick;
6406 deactivate_process (proc);
6407 error ("process %s no longer connected to pipe; closed it",
6408 SDATA (p->name));
6410 else
6411 /* This is a real error. */
6412 report_file_error ("Writing to process", proc);
6414 cur_buf += written;
6415 cur_len -= written;
6418 while (!NILP (p->write_queue));
6421 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
6422 3, 3, 0,
6423 doc: /* Send current contents of region as input to PROCESS.
6424 PROCESS may be a process, a buffer, the name of a process or buffer, or
6425 nil, indicating the current buffer's process.
6426 Called from program, takes three arguments, PROCESS, START and END.
6427 If the region is more than 500 characters long,
6428 it is sent in several bunches. This may happen even for shorter regions.
6429 Output from processes can arrive in between bunches.
6431 If PROCESS is a non-blocking network process that hasn't been fully
6432 set up yet, this function will block until socket setup has completed. */)
6433 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
6435 Lisp_Object proc = get_process (process);
6436 ptrdiff_t start_byte, end_byte;
6438 validate_region (&start, &end);
6440 start_byte = CHAR_TO_BYTE (XINT (start));
6441 end_byte = CHAR_TO_BYTE (XINT (end));
6443 if (XINT (start) < GPT && XINT (end) > GPT)
6444 move_gap_both (XINT (start), start_byte);
6446 if (NETCONN_P (proc))
6447 wait_while_connecting (proc);
6449 send_process (proc, (char *) BYTE_POS_ADDR (start_byte),
6450 end_byte - start_byte, Fcurrent_buffer ());
6452 return Qnil;
6455 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
6456 2, 2, 0,
6457 doc: /* Send PROCESS the contents of STRING as input.
6458 PROCESS may be a process, a buffer, the name of a process or buffer, or
6459 nil, indicating the current buffer's process.
6460 If STRING is more than 500 characters long,
6461 it is sent in several bunches. This may happen even for shorter strings.
6462 Output from processes can arrive in between bunches.
6464 If PROCESS is a non-blocking network process that hasn't been fully
6465 set up yet, this function will block until socket setup has completed. */)
6466 (Lisp_Object process, Lisp_Object string)
6468 CHECK_STRING (string);
6469 Lisp_Object proc = get_process (process);
6470 send_process (proc, SSDATA (string),
6471 SBYTES (string), string);
6472 return Qnil;
6475 /* Return the foreground process group for the tty/pty that
6476 the process P uses. */
6477 static pid_t
6478 emacs_get_tty_pgrp (struct Lisp_Process *p)
6480 pid_t gid = -1;
6482 #ifdef TIOCGPGRP
6483 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
6485 int fd;
6486 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
6487 master side. Try the slave side. */
6488 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
6490 if (fd != -1)
6492 ioctl (fd, TIOCGPGRP, &gid);
6493 emacs_close (fd);
6496 #endif /* defined (TIOCGPGRP ) */
6498 return gid;
6501 DEFUN ("process-running-child-p", Fprocess_running_child_p,
6502 Sprocess_running_child_p, 0, 1, 0,
6503 doc: /* Return non-nil if PROCESS has given the terminal to a
6504 child. If the operating system does not make it possible to find out,
6505 return t. If we can find out, return the numeric ID of the foreground
6506 process group. */)
6507 (Lisp_Object process)
6509 /* Initialize in case ioctl doesn't exist or gives an error,
6510 in a way that will cause returning t. */
6511 Lisp_Object proc = get_process (process);
6512 struct Lisp_Process *p = XPROCESS (proc);
6514 if (!EQ (p->type, Qreal))
6515 error ("Process %s is not a subprocess",
6516 SDATA (p->name));
6517 if (p->infd < 0)
6518 error ("Process %s is not active",
6519 SDATA (p->name));
6521 pid_t gid = emacs_get_tty_pgrp (p);
6523 if (gid == p->pid)
6524 return Qnil;
6525 if (gid != -1)
6526 return make_number (gid);
6527 return Qt;
6530 /* Send a signal number SIGNO to PROCESS.
6531 If CURRENT_GROUP is t, that means send to the process group
6532 that currently owns the terminal being used to communicate with PROCESS.
6533 This is used for various commands in shell mode.
6534 If CURRENT_GROUP is lambda, that means send to the process group
6535 that currently owns the terminal, but only if it is NOT the shell itself.
6537 If NOMSG is false, insert signal-announcements into process's buffers
6538 right away.
6540 If we can, we try to signal PROCESS by sending control characters
6541 down the pty. This allows us to signal inferiors who have changed
6542 their uid, for which kill would return an EPERM error. */
6544 static void
6545 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
6546 bool nomsg)
6548 Lisp_Object proc;
6549 struct Lisp_Process *p;
6550 pid_t gid;
6551 bool no_pgrp = 0;
6553 proc = get_process (process);
6554 p = XPROCESS (proc);
6556 if (!EQ (p->type, Qreal))
6557 error ("Process %s is not a subprocess",
6558 SDATA (p->name));
6559 if (p->infd < 0)
6560 error ("Process %s is not active",
6561 SDATA (p->name));
6563 if (!p->pty_flag)
6564 current_group = Qnil;
6566 /* If we are using pgrps, get a pgrp number and make it negative. */
6567 if (NILP (current_group))
6568 /* Send the signal to the shell's process group. */
6569 gid = p->pid;
6570 else
6572 #ifdef SIGNALS_VIA_CHARACTERS
6573 /* If possible, send signals to the entire pgrp
6574 by sending an input character to it. */
6576 struct termios t;
6577 cc_t *sig_char = NULL;
6579 tcgetattr (p->infd, &t);
6581 switch (signo)
6583 case SIGINT:
6584 sig_char = &t.c_cc[VINTR];
6585 break;
6587 case SIGQUIT:
6588 sig_char = &t.c_cc[VQUIT];
6589 break;
6591 case SIGTSTP:
6592 #ifdef VSWTCH
6593 sig_char = &t.c_cc[VSWTCH];
6594 #else
6595 sig_char = &t.c_cc[VSUSP];
6596 #endif
6597 break;
6600 if (sig_char && *sig_char != CDISABLE)
6602 send_process (proc, (char *) sig_char, 1, Qnil);
6603 return;
6605 /* If we can't send the signal with a character,
6606 fall through and send it another way. */
6608 /* The code above may fall through if it can't
6609 handle the signal. */
6610 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
6612 #ifdef TIOCGPGRP
6613 /* Get the current pgrp using the tty itself, if we have that.
6614 Otherwise, use the pty to get the pgrp.
6615 On pfa systems, saka@pfu.fujitsu.co.JP writes:
6616 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
6617 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
6618 His patch indicates that if TIOCGPGRP returns an error, then
6619 we should just assume that p->pid is also the process group id. */
6621 gid = emacs_get_tty_pgrp (p);
6623 if (gid == -1)
6624 /* If we can't get the information, assume
6625 the shell owns the tty. */
6626 gid = p->pid;
6628 /* It is not clear whether anything really can set GID to -1.
6629 Perhaps on some system one of those ioctls can or could do so.
6630 Or perhaps this is vestigial. */
6631 if (gid == -1)
6632 no_pgrp = 1;
6633 #else /* ! defined (TIOCGPGRP) */
6634 /* Can't select pgrps on this system, so we know that
6635 the child itself heads the pgrp. */
6636 gid = p->pid;
6637 #endif /* ! defined (TIOCGPGRP) */
6639 /* If current_group is lambda, and the shell owns the terminal,
6640 don't send any signal. */
6641 if (EQ (current_group, Qlambda) && gid == p->pid)
6642 return;
6645 #ifdef SIGCONT
6646 if (signo == SIGCONT)
6648 p->raw_status_new = 0;
6649 pset_status (p, Qrun);
6650 p->tick = ++process_tick;
6651 if (!nomsg)
6653 status_notify (NULL, NULL);
6654 redisplay_preserve_echo_area (13);
6657 #endif
6659 #ifdef TIOCSIGSEND
6660 /* Work around a HP-UX 7.0 bug that mishandles signals to subjobs.
6661 We don't know whether the bug is fixed in later HP-UX versions. */
6662 if (! NILP (current_group) && ioctl (p->infd, TIOCSIGSEND, signo) != -1)
6663 return;
6664 #endif
6666 /* If we don't have process groups, send the signal to the immediate
6667 subprocess. That isn't really right, but it's better than any
6668 obvious alternative. */
6669 pid_t pid = no_pgrp ? gid : - gid;
6671 /* Do not kill an already-reaped process, as that could kill an
6672 innocent bystander that happens to have the same process ID. */
6673 sigset_t oldset;
6674 block_child_signal (&oldset);
6675 if (p->alive)
6676 kill (pid, signo);
6677 unblock_child_signal (&oldset);
6680 DEFUN ("internal-default-interrupt-process",
6681 Finternal_default_interrupt_process,
6682 Sinternal_default_interrupt_process, 0, 2, 0,
6683 doc: /* Default function to interrupt process PROCESS.
6684 It shall be the last element in list `interrupt-process-functions'.
6685 See function `interrupt-process' for more details on usage. */)
6686 (Lisp_Object process, Lisp_Object current_group)
6688 process_send_signal (process, SIGINT, current_group, 0);
6689 return process;
6692 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
6693 doc: /* Interrupt process PROCESS.
6694 PROCESS may be a process, a buffer, or the name of a process or buffer.
6695 No arg or nil means current buffer's process.
6696 Second arg CURRENT-GROUP non-nil means send signal to
6697 the current process-group of the process's controlling terminal
6698 rather than to the process's own process group.
6699 If the process is a shell, this means interrupt current subjob
6700 rather than the shell.
6702 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
6703 don't send the signal.
6705 This function calls the functions of `interrupt-process-functions' in
6706 the order of the list, until one of them returns non-`nil'. */)
6707 (Lisp_Object process, Lisp_Object current_group)
6709 return CALLN (Frun_hook_with_args_until_success, Qinterrupt_process_functions,
6710 process, current_group);
6713 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
6714 doc: /* Kill process PROCESS. May be process or name of one.
6715 See function `interrupt-process' for more details on usage. */)
6716 (Lisp_Object process, Lisp_Object current_group)
6718 process_send_signal (process, SIGKILL, current_group, 0);
6719 return process;
6722 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
6723 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
6724 See function `interrupt-process' for more details on usage. */)
6725 (Lisp_Object process, Lisp_Object current_group)
6727 process_send_signal (process, SIGQUIT, current_group, 0);
6728 return process;
6731 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
6732 doc: /* Stop process PROCESS. May be process or name of one.
6733 See function `interrupt-process' for more details on usage.
6734 If PROCESS is a network or serial or pipe connection, inhibit handling
6735 of incoming traffic. */)
6736 (Lisp_Object process, Lisp_Object current_group)
6738 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)
6739 || PIPECONN_P (process)))
6741 struct Lisp_Process *p;
6743 p = XPROCESS (process);
6744 if (NILP (p->command)
6745 && p->infd >= 0)
6746 delete_read_fd (p->infd);
6747 pset_command (p, Qt);
6748 return process;
6750 #ifndef SIGTSTP
6751 error ("No SIGTSTP support");
6752 #else
6753 process_send_signal (process, SIGTSTP, current_group, 0);
6754 #endif
6755 return process;
6758 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
6759 doc: /* Continue process PROCESS. May be process or name of one.
6760 See function `interrupt-process' for more details on usage.
6761 If PROCESS is a network or serial process, resume handling of incoming
6762 traffic. */)
6763 (Lisp_Object process, Lisp_Object current_group)
6765 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)
6766 || PIPECONN_P (process)))
6768 struct Lisp_Process *p;
6770 p = XPROCESS (process);
6771 if (EQ (p->command, Qt)
6772 && p->infd >= 0
6773 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
6775 add_process_read_fd (p->infd);
6776 #ifdef WINDOWSNT
6777 if (fd_info[ p->infd ].flags & FILE_SERIAL)
6778 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
6779 #else /* not WINDOWSNT */
6780 tcflush (p->infd, TCIFLUSH);
6781 #endif /* not WINDOWSNT */
6783 pset_command (p, Qnil);
6784 return process;
6786 #ifdef SIGCONT
6787 process_send_signal (process, SIGCONT, current_group, 0);
6788 #else
6789 error ("No SIGCONT support");
6790 #endif
6791 return process;
6794 /* Return the integer value of the signal whose abbreviation is ABBR,
6795 or a negative number if there is no such signal. */
6796 static int
6797 abbr_to_signal (char const *name)
6799 int i, signo;
6800 char sigbuf[20]; /* Large enough for all valid signal abbreviations. */
6802 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
6803 name += 3;
6805 for (i = 0; i < sizeof sigbuf; i++)
6807 sigbuf[i] = c_toupper (name[i]);
6808 if (! sigbuf[i])
6809 return str2sig (sigbuf, &signo) == 0 ? signo : -1;
6812 return -1;
6815 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
6816 2, 2, "sProcess (name or number): \nnSignal code: ",
6817 doc: /* Send PROCESS the signal with code SIGCODE.
6818 PROCESS may also be a number specifying the process id of the
6819 process to signal; in this case, the process need not be a child of
6820 this Emacs.
6821 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
6822 (Lisp_Object process, Lisp_Object sigcode)
6824 pid_t pid;
6825 int signo;
6827 if (STRINGP (process))
6829 Lisp_Object tem = Fget_process (process);
6830 if (NILP (tem))
6832 Lisp_Object process_number
6833 = string_to_number (SSDATA (process), 10, 1);
6834 if (NUMBERP (process_number))
6835 tem = process_number;
6837 process = tem;
6839 else if (!NUMBERP (process))
6840 process = get_process (process);
6842 if (NILP (process))
6843 return process;
6845 if (NUMBERP (process))
6846 CONS_TO_INTEGER (process, pid_t, pid);
6847 else
6849 CHECK_PROCESS (process);
6850 pid = XPROCESS (process)->pid;
6851 if (pid <= 0)
6852 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
6855 if (INTEGERP (sigcode))
6857 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
6858 signo = XINT (sigcode);
6860 else
6862 char *name;
6864 CHECK_SYMBOL (sigcode);
6865 name = SSDATA (SYMBOL_NAME (sigcode));
6867 signo = abbr_to_signal (name);
6868 if (signo < 0)
6869 error ("Undefined signal name %s", name);
6872 return make_number (kill (pid, signo));
6875 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6876 doc: /* Make PROCESS see end-of-file in its input.
6877 EOF comes after any text already sent to it.
6878 PROCESS may be a process, a buffer, the name of a process or buffer, or
6879 nil, indicating the current buffer's process.
6880 If PROCESS is a network connection, or is a process communicating
6881 through a pipe (as opposed to a pty), then you cannot send any more
6882 text to PROCESS after you call this function.
6883 If PROCESS is a serial process, wait until all output written to the
6884 process has been transmitted to the serial port. */)
6885 (Lisp_Object process)
6887 Lisp_Object proc;
6888 struct coding_system *coding = NULL;
6889 int outfd;
6891 proc = get_process (process);
6893 if (NETCONN_P (proc))
6894 wait_while_connecting (proc);
6896 if (DATAGRAM_CONN_P (proc))
6897 return process;
6900 outfd = XPROCESS (proc)->outfd;
6901 if (outfd >= 0)
6902 coding = proc_encode_coding_system[outfd];
6904 /* Make sure the process is really alive. */
6905 if (XPROCESS (proc)->raw_status_new)
6906 update_status (XPROCESS (proc));
6907 if (! EQ (XPROCESS (proc)->status, Qrun))
6908 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6910 if (coding && CODING_REQUIRE_FLUSHING (coding))
6912 coding->mode |= CODING_MODE_LAST_BLOCK;
6913 send_process (proc, "", 0, Qnil);
6916 if (XPROCESS (proc)->pty_flag)
6917 send_process (proc, "\004", 1, Qnil);
6918 else if (EQ (XPROCESS (proc)->type, Qserial))
6920 #ifndef WINDOWSNT
6921 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6922 report_file_error ("Failed tcdrain", Qnil);
6923 #endif /* not WINDOWSNT */
6924 /* Do nothing on Windows because writes are blocking. */
6926 else
6928 struct Lisp_Process *p = XPROCESS (proc);
6929 int old_outfd = p->outfd;
6930 int new_outfd;
6932 #ifdef HAVE_SHUTDOWN
6933 /* If this is a network connection, or socketpair is used
6934 for communication with the subprocess, call shutdown to cause EOF.
6935 (In some old system, shutdown to socketpair doesn't work.
6936 Then we just can't win.) */
6937 if (0 <= old_outfd
6938 && (EQ (p->type, Qnetwork) || p->infd == old_outfd))
6939 shutdown (old_outfd, 1);
6940 #endif
6941 close_process_fd (&p->open_fd[WRITE_TO_SUBPROCESS]);
6942 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6943 if (new_outfd < 0)
6944 report_file_error ("Opening null device", Qnil);
6945 p->open_fd[WRITE_TO_SUBPROCESS] = new_outfd;
6946 p->outfd = new_outfd;
6948 if (!proc_encode_coding_system[new_outfd])
6949 proc_encode_coding_system[new_outfd]
6950 = xmalloc (sizeof (struct coding_system));
6951 if (old_outfd >= 0)
6953 *proc_encode_coding_system[new_outfd]
6954 = *proc_encode_coding_system[old_outfd];
6955 memset (proc_encode_coding_system[old_outfd], 0,
6956 sizeof (struct coding_system));
6958 else
6959 setup_coding_system (p->encode_coding_system,
6960 proc_encode_coding_system[new_outfd]);
6962 return process;
6965 /* The main Emacs thread records child processes in three places:
6967 - Vprocess_alist, for asynchronous subprocesses, which are child
6968 processes visible to Lisp.
6970 - deleted_pid_list, for child processes invisible to Lisp,
6971 typically because of delete-process. These are recorded so that
6972 the processes can be reaped when they exit, so that the operating
6973 system's process table is not cluttered by zombies.
6975 - the local variable PID in Fcall_process, call_process_cleanup and
6976 call_process_kill, for synchronous subprocesses.
6977 record_unwind_protect is used to make sure this process is not
6978 forgotten: if the user interrupts call-process and the child
6979 process refuses to exit immediately even with two C-g's,
6980 call_process_kill adds PID's contents to deleted_pid_list before
6981 returning.
6983 The main Emacs thread invokes waitpid only on child processes that
6984 it creates and that have not been reaped. This avoid races on
6985 platforms such as GTK, where other threads create their own
6986 subprocesses which the main thread should not reap. For example,
6987 if the main thread attempted to reap an already-reaped child, it
6988 might inadvertently reap a GTK-created process that happened to
6989 have the same process ID. */
6991 /* LIB_CHILD_HANDLER is a SIGCHLD handler that Emacs calls while doing
6992 its own SIGCHLD handling. On POSIXish systems, glib needs this to
6993 keep track of its own children. GNUstep is similar. */
6995 static void dummy_handler (int sig) {}
6996 static signal_handler_t volatile lib_child_handler;
6998 /* Handle a SIGCHLD signal by looking for known child processes of
6999 Emacs whose status have changed. For each one found, record its
7000 new status.
7002 All we do is change the status; we do not run sentinels or print
7003 notifications. That is saved for the next time keyboard input is
7004 done, in order to avoid timing errors.
7006 ** WARNING: this can be called during garbage collection.
7007 Therefore, it must not be fooled by the presence of mark bits in
7008 Lisp objects.
7010 ** USG WARNING: Although it is not obvious from the documentation
7011 in signal(2), on a USG system the SIGCLD handler MUST NOT call
7012 signal() before executing at least one wait(), otherwise the
7013 handler will be called again, resulting in an infinite loop. The
7014 relevant portion of the documentation reads "SIGCLD signals will be
7015 queued and the signal-catching function will be continually
7016 reentered until the queue is empty". Invoking signal() causes the
7017 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
7018 Inc.
7020 ** Malloc WARNING: This should never call malloc either directly or
7021 indirectly; if it does, that is a bug. */
7023 static void
7024 handle_child_signal (int sig)
7026 Lisp_Object tail, proc;
7028 /* Find the process that signaled us, and record its status. */
7030 /* The process can have been deleted by Fdelete_process, or have
7031 been started asynchronously by Fcall_process. */
7032 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
7034 bool all_pids_are_fixnums
7035 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
7036 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
7037 Lisp_Object head = XCAR (tail);
7038 Lisp_Object xpid;
7039 if (! CONSP (head))
7040 continue;
7041 xpid = XCAR (head);
7042 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
7044 pid_t deleted_pid;
7045 if (INTEGERP (xpid))
7046 deleted_pid = XINT (xpid);
7047 else
7048 deleted_pid = XFLOAT_DATA (xpid);
7049 if (child_status_changed (deleted_pid, 0, 0))
7051 if (STRINGP (XCDR (head)))
7052 unlink (SSDATA (XCDR (head)));
7053 XSETCAR (tail, Qnil);
7058 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
7059 FOR_EACH_PROCESS (tail, proc)
7061 struct Lisp_Process *p = XPROCESS (proc);
7062 int status;
7064 if (p->alive
7065 && child_status_changed (p->pid, &status, WUNTRACED | WCONTINUED))
7067 /* Change the status of the process that was found. */
7068 p->tick = ++process_tick;
7069 p->raw_status = status;
7070 p->raw_status_new = 1;
7072 /* If process has terminated, stop waiting for its output. */
7073 if (WIFSIGNALED (status) || WIFEXITED (status))
7075 bool clear_desc_flag = 0;
7076 p->alive = 0;
7077 if (p->infd >= 0)
7078 clear_desc_flag = 1;
7080 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
7081 if (clear_desc_flag)
7082 delete_read_fd (p->infd);
7087 lib_child_handler (sig);
7088 #ifdef NS_IMPL_GNUSTEP
7089 /* NSTask in GNUstep sets its child handler each time it is called.
7090 So we must re-set ours. */
7091 catch_child_signal ();
7092 #endif
7095 static void
7096 deliver_child_signal (int sig)
7098 deliver_process_signal (sig, handle_child_signal);
7102 static Lisp_Object
7103 exec_sentinel_error_handler (Lisp_Object error_val)
7105 /* Make sure error_val is a cons cell, as all the rest of error
7106 handling expects that, and will barf otherwise. */
7107 if (!CONSP (error_val))
7108 error_val = Fcons (Qerror, error_val);
7109 cmd_error_internal (error_val, "error in process sentinel: ");
7110 Vinhibit_quit = Qt;
7111 update_echo_area ();
7112 Fsleep_for (make_number (2), Qnil);
7113 return Qt;
7116 static void
7117 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
7119 Lisp_Object sentinel, odeactivate;
7120 struct Lisp_Process *p = XPROCESS (proc);
7121 ptrdiff_t count = SPECPDL_INDEX ();
7122 bool outer_running_asynch_code = running_asynch_code;
7123 int waiting = waiting_for_user_input_p;
7125 if (inhibit_sentinels)
7126 return;
7128 odeactivate = Vdeactivate_mark;
7129 #if 0
7130 Lisp_Object obuffer, okeymap;
7131 XSETBUFFER (obuffer, current_buffer);
7132 okeymap = BVAR (current_buffer, keymap);
7133 #endif
7135 /* There's no good reason to let sentinels change the current
7136 buffer, and many callers of accept-process-output, sit-for, and
7137 friends don't expect current-buffer to be changed from under them. */
7138 record_unwind_current_buffer ();
7140 sentinel = p->sentinel;
7142 /* Inhibit quit so that random quits don't screw up a running filter. */
7143 specbind (Qinhibit_quit, Qt);
7144 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
7146 /* In case we get recursively called,
7147 and we already saved the match data nonrecursively,
7148 save the same match data in safely recursive fashion. */
7149 if (outer_running_asynch_code)
7151 Lisp_Object tem;
7152 tem = Fmatch_data (Qnil, Qnil, Qnil);
7153 restore_search_regs ();
7154 record_unwind_save_match_data ();
7155 Fset_match_data (tem, Qt);
7158 /* For speed, if a search happens within this code,
7159 save the match data in a special nonrecursive fashion. */
7160 running_asynch_code = 1;
7162 internal_condition_case_1 (read_process_output_call,
7163 list3 (sentinel, proc, reason),
7164 !NILP (Vdebug_on_error) ? Qnil : Qerror,
7165 exec_sentinel_error_handler);
7167 /* If we saved the match data nonrecursively, restore it now. */
7168 restore_search_regs ();
7169 running_asynch_code = outer_running_asynch_code;
7171 Vdeactivate_mark = odeactivate;
7173 /* Restore waiting_for_user_input_p as it was
7174 when we were called, in case the filter clobbered it. */
7175 waiting_for_user_input_p = waiting;
7177 #if 0
7178 if (! EQ (Fcurrent_buffer (), obuffer)
7179 || ! EQ (current_buffer->keymap, okeymap))
7180 #endif
7181 /* But do it only if the caller is actually going to read events.
7182 Otherwise there's no need to make him wake up, and it could
7183 cause trouble (for example it would make sit_for return). */
7184 if (waiting_for_user_input_p == -1)
7185 record_asynch_buffer_change ();
7187 unbind_to (count, Qnil);
7190 /* Report all recent events of a change in process status
7191 (either run the sentinel or output a message).
7192 This is usually done while Emacs is waiting for keyboard input
7193 but can be done at other times.
7195 Return positive if any input was received from WAIT_PROC (or from
7196 any process if WAIT_PROC is null), zero if input was attempted but
7197 none received, and negative if we didn't even try. */
7199 static int
7200 status_notify (struct Lisp_Process *deleting_process,
7201 struct Lisp_Process *wait_proc)
7203 Lisp_Object proc;
7204 Lisp_Object tail, msg;
7205 int got_some_output = -1;
7207 tail = Qnil;
7208 msg = Qnil;
7210 /* Set this now, so that if new processes are created by sentinels
7211 that we run, we get called again to handle their status changes. */
7212 update_tick = process_tick;
7214 FOR_EACH_PROCESS (tail, proc)
7216 Lisp_Object symbol;
7217 register struct Lisp_Process *p = XPROCESS (proc);
7219 if (p->tick != p->update_tick)
7221 p->update_tick = p->tick;
7223 /* If process is still active, read any output that remains. */
7224 while (! EQ (p->filter, Qt)
7225 && ! connecting_status (p->status)
7226 && ! EQ (p->status, Qlisten)
7227 /* Network or serial process not stopped: */
7228 && ! EQ (p->command, Qt)
7229 && p->infd >= 0
7230 && p != deleting_process)
7232 int nread = read_process_output (proc, p->infd);
7233 if ((!wait_proc || wait_proc == XPROCESS (proc))
7234 && got_some_output < nread)
7235 got_some_output = nread;
7236 if (nread <= 0)
7237 break;
7240 /* Get the text to use for the message. */
7241 if (p->raw_status_new)
7242 update_status (p);
7243 msg = status_message (p);
7245 /* If process is terminated, deactivate it or delete it. */
7246 symbol = p->status;
7247 if (CONSP (p->status))
7248 symbol = XCAR (p->status);
7250 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
7251 || EQ (symbol, Qclosed))
7253 if (delete_exited_processes)
7254 remove_process (proc);
7255 else
7256 deactivate_process (proc);
7259 /* The actions above may have further incremented p->tick.
7260 So set p->update_tick again so that an error in the sentinel will
7261 not cause this code to be run again. */
7262 p->update_tick = p->tick;
7263 /* Now output the message suitably. */
7264 exec_sentinel (proc, msg);
7265 if (BUFFERP (p->buffer))
7266 /* In case it uses %s in mode-line-format. */
7267 bset_update_mode_line (XBUFFER (p->buffer));
7269 } /* end for */
7271 return got_some_output;
7274 DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel,
7275 Sinternal_default_process_sentinel, 2, 2, 0,
7276 doc: /* Function used as default sentinel for processes.
7277 This inserts a status message into the process's buffer, if there is one. */)
7278 (Lisp_Object proc, Lisp_Object msg)
7280 Lisp_Object buffer, symbol;
7281 struct Lisp_Process *p;
7282 CHECK_PROCESS (proc);
7283 p = XPROCESS (proc);
7284 buffer = p->buffer;
7285 symbol = p->status;
7286 if (CONSP (symbol))
7287 symbol = XCAR (symbol);
7289 if (!EQ (symbol, Qrun) && !NILP (buffer))
7291 Lisp_Object tem;
7292 struct buffer *old = current_buffer;
7293 ptrdiff_t opoint, opoint_byte;
7294 ptrdiff_t before, before_byte;
7296 /* Avoid error if buffer is deleted
7297 (probably that's why the process is dead, too). */
7298 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
7299 return Qnil;
7300 Fset_buffer (buffer);
7302 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
7303 msg = (code_convert_string_norecord
7304 (msg, Vlocale_coding_system, 1));
7306 opoint = PT;
7307 opoint_byte = PT_BYTE;
7308 /* Insert new output into buffer
7309 at the current end-of-output marker,
7310 thus preserving logical ordering of input and output. */
7311 if (XMARKER (p->mark)->buffer)
7312 Fgoto_char (p->mark);
7313 else
7314 SET_PT_BOTH (ZV, ZV_BYTE);
7316 before = PT;
7317 before_byte = PT_BYTE;
7319 tem = BVAR (current_buffer, read_only);
7320 bset_read_only (current_buffer, Qnil);
7321 insert_string ("\nProcess ");
7322 { /* FIXME: temporary kludge. */
7323 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
7324 insert_string (" ");
7325 Finsert (1, &msg);
7326 bset_read_only (current_buffer, tem);
7327 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
7329 if (opoint >= before)
7330 SET_PT_BOTH (opoint + (PT - before),
7331 opoint_byte + (PT_BYTE - before_byte));
7332 else
7333 SET_PT_BOTH (opoint, opoint_byte);
7335 set_buffer_internal (old);
7337 return Qnil;
7341 DEFUN ("set-process-coding-system", Fset_process_coding_system,
7342 Sset_process_coding_system, 1, 3, 0,
7343 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
7344 DECODING will be used to decode subprocess output and ENCODING to
7345 encode subprocess input. */)
7346 (Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
7348 CHECK_PROCESS (process);
7350 struct Lisp_Process *p = XPROCESS (process);
7352 Fcheck_coding_system (decoding);
7353 Fcheck_coding_system (encoding);
7354 encoding = coding_inherit_eol_type (encoding, Qnil);
7355 pset_decode_coding_system (p, decoding);
7356 pset_encode_coding_system (p, encoding);
7358 /* If the sockets haven't been set up yet, the final setup part of
7359 this will be called asynchronously. */
7360 if (p->infd < 0 || p->outfd < 0)
7361 return Qnil;
7363 setup_process_coding_systems (process);
7365 return Qnil;
7368 DEFUN ("process-coding-system",
7369 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
7370 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
7371 (register Lisp_Object process)
7373 CHECK_PROCESS (process);
7374 return Fcons (XPROCESS (process)->decode_coding_system,
7375 XPROCESS (process)->encode_coding_system);
7378 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
7379 Sset_process_filter_multibyte, 2, 2, 0,
7380 doc: /* Set multibyteness of the strings given to PROCESS's filter.
7381 If FLAG is non-nil, the filter is given multibyte strings.
7382 If FLAG is nil, the filter is given unibyte strings. In this case,
7383 all character code conversion except for end-of-line conversion is
7384 suppressed. */)
7385 (Lisp_Object process, Lisp_Object flag)
7387 CHECK_PROCESS (process);
7389 struct Lisp_Process *p = XPROCESS (process);
7390 if (NILP (flag))
7391 pset_decode_coding_system
7392 (p, raw_text_coding_system (p->decode_coding_system));
7394 /* If the sockets haven't been set up yet, the final setup part of
7395 this will be called asynchronously. */
7396 if (p->infd < 0 || p->outfd < 0)
7397 return Qnil;
7399 setup_process_coding_systems (process);
7401 return Qnil;
7404 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
7405 Sprocess_filter_multibyte_p, 1, 1, 0,
7406 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
7407 (Lisp_Object process)
7409 CHECK_PROCESS (process);
7410 struct Lisp_Process *p = XPROCESS (process);
7411 if (p->infd < 0)
7412 return Qnil;
7413 struct coding_system *coding = proc_decode_coding_system[p->infd];
7414 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
7420 # ifdef HAVE_GPM
7422 void
7423 add_gpm_wait_descriptor (int desc)
7425 add_keyboard_wait_descriptor (desc);
7428 void
7429 delete_gpm_wait_descriptor (int desc)
7431 delete_keyboard_wait_descriptor (desc);
7434 # endif
7436 # ifdef USABLE_SIGIO
7438 /* Return true if *MASK has a bit set
7439 that corresponds to one of the keyboard input descriptors. */
7441 static bool
7442 keyboard_bit_set (fd_set *mask)
7444 int fd;
7446 for (fd = 0; fd <= max_desc; fd++)
7447 if (FD_ISSET (fd, mask)
7448 && ((fd_callback_info[fd].flags & (FOR_READ | KEYBOARD_FD))
7449 == (FOR_READ | KEYBOARD_FD)))
7450 return 1;
7452 return 0;
7454 # endif
7456 #else /* not subprocesses */
7458 /* This is referenced in thread.c:run_thread (which is never actually
7459 called, since threads are not enabled for this configuration. */
7460 void
7461 update_processes_for_thread_death (Lisp_Object dying_thread)
7465 /* Defined in msdos.c. */
7466 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
7467 struct timespec *, void *);
7469 /* Implementation of wait_reading_process_output, assuming that there
7470 are no subprocesses. Used only by the MS-DOS build.
7472 Wait for timeout to elapse and/or keyboard input to be available.
7474 TIME_LIMIT is:
7475 timeout in seconds
7476 If negative, gobble data immediately available but don't wait for any.
7478 NSECS is:
7479 an additional duration to wait, measured in nanoseconds
7480 If TIME_LIMIT is zero, then:
7481 If NSECS == 0, there is no limit.
7482 If NSECS > 0, the timeout consists of NSECS only.
7483 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
7485 READ_KBD is:
7486 0 to ignore keyboard input, or
7487 1 to return when input is available, or
7488 -1 means caller will actually read the input, so don't throw to
7489 the quit handler.
7491 see full version for other parameters. We know that wait_proc will
7492 always be NULL, since `subprocesses' isn't defined.
7494 DO_DISPLAY means redisplay should be done to show subprocess
7495 output that arrives.
7497 Return -1 signifying we got no output and did not try. */
7500 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
7501 bool do_display,
7502 Lisp_Object wait_for_cell,
7503 struct Lisp_Process *wait_proc, int just_wait_proc)
7505 register int nfds;
7506 struct timespec end_time, timeout;
7507 enum { MINIMUM = -1, TIMEOUT, INFINITY } wait;
7509 if (TYPE_MAXIMUM (time_t) < time_limit)
7510 time_limit = TYPE_MAXIMUM (time_t);
7512 if (time_limit < 0 || nsecs < 0)
7513 wait = MINIMUM;
7514 else if (time_limit > 0 || nsecs > 0)
7516 wait = TIMEOUT;
7517 end_time = timespec_add (current_timespec (),
7518 make_timespec (time_limit, nsecs));
7520 else
7521 wait = INFINITY;
7523 /* Turn off periodic alarms (in case they are in use)
7524 and then turn off any other atimers,
7525 because the select emulator uses alarms. */
7526 stop_polling ();
7527 turn_on_atimers (0);
7529 while (1)
7531 bool timeout_reduced_for_timers = false;
7532 fd_set waitchannels;
7533 int xerrno;
7535 /* If calling from keyboard input, do not quit
7536 since we want to return C-g as an input character.
7537 Otherwise, do pending quit if requested. */
7538 if (read_kbd >= 0)
7539 maybe_quit ();
7541 /* Exit now if the cell we're waiting for became non-nil. */
7542 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7543 break;
7545 /* Compute time from now till when time limit is up. */
7546 /* Exit if already run out. */
7547 if (wait == TIMEOUT)
7549 struct timespec now = current_timespec ();
7550 if (timespec_cmp (end_time, now) <= 0)
7551 break;
7552 timeout = timespec_sub (end_time, now);
7554 else
7555 timeout = make_timespec (wait < TIMEOUT ? 0 : 100000, 0);
7557 /* If our caller will not immediately handle keyboard events,
7558 run timer events directly.
7559 (Callers that will immediately read keyboard events
7560 call timer_delay on their own.) */
7561 if (NILP (wait_for_cell))
7563 struct timespec timer_delay;
7567 unsigned old_timers_run = timers_run;
7568 timer_delay = timer_check ();
7569 if (timers_run != old_timers_run && do_display)
7570 /* We must retry, since a timer may have requeued itself
7571 and that could alter the time delay. */
7572 redisplay_preserve_echo_area (14);
7573 else
7574 break;
7576 while (!detect_input_pending ());
7578 /* If there is unread keyboard input, also return. */
7579 if (read_kbd != 0
7580 && requeued_events_pending_p ())
7581 break;
7583 if (timespec_valid_p (timer_delay))
7585 if (timespec_cmp (timer_delay, timeout) < 0)
7587 timeout = timer_delay;
7588 timeout_reduced_for_timers = true;
7593 /* Cause C-g and alarm signals to take immediate action,
7594 and cause input available signals to zero out timeout. */
7595 if (read_kbd < 0)
7596 set_waiting_for_input (&timeout);
7598 /* If a frame has been newly mapped and needs updating,
7599 reprocess its display stuff. */
7600 if (frame_garbaged && do_display)
7602 clear_waiting_for_input ();
7603 redisplay_preserve_echo_area (15);
7604 if (read_kbd < 0)
7605 set_waiting_for_input (&timeout);
7608 /* Wait till there is something to do. */
7609 FD_ZERO (&waitchannels);
7610 if (read_kbd && detect_input_pending ())
7611 nfds = 0;
7612 else
7614 if (read_kbd || !NILP (wait_for_cell))
7615 FD_SET (0, &waitchannels);
7616 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
7619 xerrno = errno;
7621 /* Make C-g and alarm signals set flags again. */
7622 clear_waiting_for_input ();
7624 /* If we woke up due to SIGWINCH, actually change size now. */
7625 do_pending_window_change (0);
7627 if (wait < INFINITY && nfds == 0 && ! timeout_reduced_for_timers)
7628 /* We waited the full specified time, so return now. */
7629 break;
7631 if (nfds == -1)
7633 /* If the system call was interrupted, then go around the
7634 loop again. */
7635 if (xerrno == EINTR)
7636 FD_ZERO (&waitchannels);
7637 else
7638 report_file_errno ("Failed select", Qnil, xerrno);
7641 /* Check for keyboard input. */
7643 if (read_kbd
7644 && detect_input_pending_run_timers (do_display))
7646 swallow_events (do_display);
7647 if (detect_input_pending_run_timers (do_display))
7648 break;
7651 /* If there is unread keyboard input, also return. */
7652 if (read_kbd
7653 && requeued_events_pending_p ())
7654 break;
7656 /* If wait_for_cell. check for keyboard input
7657 but don't run any timers.
7658 ??? (It seems wrong to me to check for keyboard
7659 input at all when wait_for_cell, but the code
7660 has been this way since July 1994.
7661 Try changing this after version 19.31.) */
7662 if (! NILP (wait_for_cell)
7663 && detect_input_pending ())
7665 swallow_events (do_display);
7666 if (detect_input_pending ())
7667 break;
7670 /* Exit now if the cell we're waiting for became non-nil. */
7671 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7672 break;
7675 start_polling ();
7677 return -1;
7680 #endif /* not subprocesses */
7682 /* The following functions are needed even if async subprocesses are
7683 not supported. Some of them are no-op stubs in that case. */
7685 #ifdef HAVE_TIMERFD
7687 /* Add FD, which is a descriptor returned by timerfd_create,
7688 to the set of non-keyboard input descriptors. */
7690 void
7691 add_timer_wait_descriptor (int fd)
7693 add_read_fd (fd, timerfd_callback, NULL);
7694 fd_callback_info[fd].flags &= ~KEYBOARD_FD;
7697 #endif /* HAVE_TIMERFD */
7699 /* If program file NAME starts with /: for quoting a magic
7700 name, remove that, preserving the multibyteness of NAME. */
7702 Lisp_Object
7703 remove_slash_colon (Lisp_Object name)
7705 return
7706 (SREF (name, 0) == '/' && SREF (name, 1) == ':'
7707 ? make_specified_string (SSDATA (name) + 2, SCHARS (name) - 2,
7708 SBYTES (name) - 2, STRING_MULTIBYTE (name))
7709 : name);
7712 /* Add DESC to the set of keyboard input descriptors. */
7714 void
7715 add_keyboard_wait_descriptor (int desc)
7717 #ifdef subprocesses /* Actually means "not MSDOS". */
7718 eassert (desc >= 0 && desc < FD_SETSIZE);
7719 fd_callback_info[desc].flags &= ~PROCESS_FD;
7720 fd_callback_info[desc].flags |= (FOR_READ | KEYBOARD_FD);
7721 if (desc > max_desc)
7722 max_desc = desc;
7723 #endif
7726 /* From now on, do not expect DESC to give keyboard input. */
7728 void
7729 delete_keyboard_wait_descriptor (int desc)
7731 #ifdef subprocesses
7732 eassert (desc >= 0 && desc < FD_SETSIZE);
7734 fd_callback_info[desc].flags &= ~(FOR_READ | KEYBOARD_FD | PROCESS_FD);
7736 if (desc == max_desc)
7737 recompute_max_desc ();
7738 #endif
7741 /* Setup coding systems of PROCESS. */
7743 void
7744 setup_process_coding_systems (Lisp_Object process)
7746 #ifdef subprocesses
7747 struct Lisp_Process *p = XPROCESS (process);
7748 int inch = p->infd;
7749 int outch = p->outfd;
7750 Lisp_Object coding_system;
7752 if (inch < 0 || outch < 0)
7753 return;
7755 if (!proc_decode_coding_system[inch])
7756 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
7757 coding_system = p->decode_coding_system;
7758 if (EQ (p->filter, Qinternal_default_process_filter)
7759 && BUFFERP (p->buffer))
7761 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
7762 coding_system = raw_text_coding_system (coding_system);
7764 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
7766 if (!proc_encode_coding_system[outch])
7767 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
7768 setup_coding_system (p->encode_coding_system,
7769 proc_encode_coding_system[outch]);
7770 #endif
7773 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
7774 doc: /* Return the (or a) live process associated with BUFFER.
7775 BUFFER may be a buffer or the name of one.
7776 Return nil if all processes associated with BUFFER have been
7777 deleted or killed. */)
7778 (register Lisp_Object buffer)
7780 #ifdef subprocesses
7781 register Lisp_Object buf, tail, proc;
7783 if (NILP (buffer)) return Qnil;
7784 buf = Fget_buffer (buffer);
7785 if (NILP (buf)) return Qnil;
7787 FOR_EACH_PROCESS (tail, proc)
7788 if (EQ (XPROCESS (proc)->buffer, buf))
7789 return proc;
7790 #endif /* subprocesses */
7791 return Qnil;
7794 DEFUN ("process-inherit-coding-system-flag",
7795 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
7796 1, 1, 0,
7797 doc: /* Return the value of inherit-coding-system flag for PROCESS.
7798 If this flag is t, `buffer-file-coding-system' of the buffer
7799 associated with PROCESS will inherit the coding system used to decode
7800 the process output. */)
7801 (register Lisp_Object process)
7803 #ifdef subprocesses
7804 CHECK_PROCESS (process);
7805 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
7806 #else
7807 /* Ignore the argument and return the value of
7808 inherit-process-coding-system. */
7809 return inherit_process_coding_system ? Qt : Qnil;
7810 #endif
7813 /* Kill all processes associated with `buffer'.
7814 If `buffer' is nil, kill all processes. */
7816 void
7817 kill_buffer_processes (Lisp_Object buffer)
7819 #ifdef subprocesses
7820 Lisp_Object tail, proc;
7822 FOR_EACH_PROCESS (tail, proc)
7823 if (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer))
7825 if (NETCONN_P (proc) || SERIALCONN_P (proc) || PIPECONN_P (proc))
7826 Fdelete_process (proc);
7827 else if (XPROCESS (proc)->infd >= 0)
7828 process_send_signal (proc, SIGHUP, Qnil, 1);
7830 #else /* subprocesses */
7831 /* Since we have no subprocesses, this does nothing. */
7832 #endif /* subprocesses */
7835 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
7836 Swaiting_for_user_input_p, 0, 0, 0,
7837 doc: /* Return non-nil if Emacs is waiting for input from the user.
7838 This is intended for use by asynchronous process output filters and sentinels. */)
7839 (void)
7841 #ifdef subprocesses
7842 return (waiting_for_user_input_p ? Qt : Qnil);
7843 #else
7844 return Qnil;
7845 #endif
7848 /* Stop reading input from keyboard sources. */
7850 void
7851 hold_keyboard_input (void)
7853 kbd_is_on_hold = 1;
7856 /* Resume reading input from keyboard sources. */
7858 void
7859 unhold_keyboard_input (void)
7861 kbd_is_on_hold = 0;
7864 /* Return true if keyboard input is on hold, zero otherwise. */
7866 bool
7867 kbd_on_hold_p (void)
7869 return kbd_is_on_hold;
7873 /* Enumeration of and access to system processes a-la ps(1). */
7875 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
7876 0, 0, 0,
7877 doc: /* Return a list of numerical process IDs of all running processes.
7878 If this functionality is unsupported, return nil.
7880 See `process-attributes' for getting attributes of a process given its ID. */)
7881 (void)
7883 return list_system_processes ();
7886 DEFUN ("process-attributes", Fprocess_attributes,
7887 Sprocess_attributes, 1, 1, 0,
7888 doc: /* Return attributes of the process given by its PID, a number.
7890 Value is an alist where each element is a cons cell of the form
7892 (KEY . VALUE)
7894 If this functionality is unsupported, the value is nil.
7896 See `list-system-processes' for getting a list of all process IDs.
7898 The KEYs of the attributes that this function may return are listed
7899 below, together with the type of the associated VALUE (in parentheses).
7900 Not all platforms support all of these attributes; unsupported
7901 attributes will not appear in the returned alist.
7902 Unless explicitly indicated otherwise, numbers can have either
7903 integer or floating point values.
7905 euid -- Effective user User ID of the process (number)
7906 user -- User name corresponding to euid (string)
7907 egid -- Effective user Group ID of the process (number)
7908 group -- Group name corresponding to egid (string)
7909 comm -- Command name (executable name only) (string)
7910 state -- Process state code, such as "S", "R", or "T" (string)
7911 ppid -- Parent process ID (number)
7912 pgrp -- Process group ID (number)
7913 sess -- Session ID, i.e. process ID of session leader (number)
7914 ttname -- Controlling tty name (string)
7915 tpgid -- ID of foreground process group on the process's tty (number)
7916 minflt -- number of minor page faults (number)
7917 majflt -- number of major page faults (number)
7918 cminflt -- cumulative number of minor page faults (number)
7919 cmajflt -- cumulative number of major page faults (number)
7920 utime -- user time used by the process, in (current-time) format,
7921 which is a list of integers (HIGH LOW USEC PSEC)
7922 stime -- system time used by the process (current-time)
7923 time -- sum of utime and stime (current-time)
7924 cutime -- user time used by the process and its children (current-time)
7925 cstime -- system time used by the process and its children (current-time)
7926 ctime -- sum of cutime and cstime (current-time)
7927 pri -- priority of the process (number)
7928 nice -- nice value of the process (number)
7929 thcount -- process thread count (number)
7930 start -- time the process started (current-time)
7931 vsize -- virtual memory size of the process in KB's (number)
7932 rss -- resident set size of the process in KB's (number)
7933 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7934 pcpu -- percents of CPU time used by the process (floating-point number)
7935 pmem -- percents of total physical memory used by process's resident set
7936 (floating-point number)
7937 args -- command line which invoked the process (string). */)
7938 ( Lisp_Object pid)
7940 return system_process_attributes (pid);
7943 #ifdef subprocesses
7944 /* Arrange to catch SIGCHLD if this hasn't already been arranged.
7945 Invoke this after init_process_emacs, and after glib and/or GNUstep
7946 futz with the SIGCHLD handler, but before Emacs forks any children.
7947 This function's caller should block SIGCHLD. */
7949 void
7950 catch_child_signal (void)
7952 struct sigaction action, old_action;
7953 sigset_t oldset;
7954 emacs_sigaction_init (&action, deliver_child_signal);
7955 block_child_signal (&oldset);
7956 sigaction (SIGCHLD, &action, &old_action);
7957 eassert (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7958 || ! (old_action.sa_flags & SA_SIGINFO));
7960 if (old_action.sa_handler != deliver_child_signal)
7961 lib_child_handler
7962 = (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7963 ? dummy_handler
7964 : old_action.sa_handler);
7965 unblock_child_signal (&oldset);
7967 #endif /* subprocesses */
7969 /* Limit the number of open files to the value it had at startup. */
7971 void
7972 restore_nofile_limit (void)
7974 #ifdef HAVE_SETRLIMIT
7975 if (FD_SETSIZE < nofile_limit.rlim_cur)
7976 setrlimit (RLIMIT_NOFILE, &nofile_limit);
7977 #endif
7981 /* This is not called "init_process" because that is the name of a
7982 Mach system call, so it would cause problems on Darwin systems. */
7983 void
7984 init_process_emacs (int sockfd)
7986 #ifdef subprocesses
7987 int i;
7989 inhibit_sentinels = 0;
7991 #ifndef CANNOT_DUMP
7992 if (! noninteractive || initialized)
7993 #endif
7995 #if defined HAVE_GLIB && !defined WINDOWSNT
7996 /* Tickle glib's child-handling code. Ask glib to wait for Emacs itself;
7997 this should always fail, but is enough to initialize glib's
7998 private SIGCHLD handler, allowing catch_child_signal to copy
7999 it into lib_child_handler. */
8000 g_source_unref (g_child_watch_source_new (getpid ()));
8001 #endif
8002 catch_child_signal ();
8005 #ifdef HAVE_SETRLIMIT
8006 /* Don't allocate more than FD_SETSIZE file descriptors for Emacs itself. */
8007 if (getrlimit (RLIMIT_NOFILE, &nofile_limit) != 0)
8008 nofile_limit.rlim_cur = 0;
8009 else if (FD_SETSIZE < nofile_limit.rlim_cur)
8011 struct rlimit rlim = nofile_limit;
8012 rlim.rlim_cur = FD_SETSIZE;
8013 if (setrlimit (RLIMIT_NOFILE, &rlim) != 0)
8014 nofile_limit.rlim_cur = 0;
8016 #endif
8018 external_sock_fd = sockfd;
8019 max_desc = -1;
8020 memset (fd_callback_info, 0, sizeof (fd_callback_info));
8022 num_pending_connects = 0;
8024 process_output_delay_count = 0;
8025 process_output_skip = 0;
8027 /* Don't do this, it caused infinite select loops. The display
8028 method should call add_keyboard_wait_descriptor on stdin if it
8029 needs that. */
8030 #if 0
8031 FD_SET (0, &input_wait_mask);
8032 #endif
8034 Vprocess_alist = Qnil;
8035 deleted_pid_list = Qnil;
8036 for (i = 0; i < FD_SETSIZE; i++)
8038 chan_process[i] = Qnil;
8039 proc_buffered_char[i] = -1;
8041 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
8042 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
8043 #ifdef DATAGRAM_SOCKETS
8044 memset (datagram_address, 0, sizeof datagram_address);
8045 #endif
8047 #if defined (DARWIN_OS)
8048 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
8049 processes. As such, we only change the default value. */
8050 if (initialized)
8052 char const *release = (STRINGP (Voperating_system_release)
8053 ? SSDATA (Voperating_system_release)
8054 : 0);
8055 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
8056 Vprocess_connection_type = Qnil;
8059 #endif
8060 #endif /* subprocesses */
8061 kbd_is_on_hold = 0;
8064 void
8065 syms_of_process (void)
8067 #ifdef subprocesses
8069 DEFSYM (Qprocessp, "processp");
8070 DEFSYM (Qrun, "run");
8071 DEFSYM (Qstop, "stop");
8072 DEFSYM (Qsignal, "signal");
8074 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
8075 here again. */
8077 DEFSYM (Qopen, "open");
8078 DEFSYM (Qclosed, "closed");
8079 DEFSYM (Qconnect, "connect");
8080 DEFSYM (Qfailed, "failed");
8081 DEFSYM (Qlisten, "listen");
8082 DEFSYM (Qlocal, "local");
8083 DEFSYM (Qipv4, "ipv4");
8084 #ifdef AF_INET6
8085 DEFSYM (Qipv6, "ipv6");
8086 #endif
8087 DEFSYM (Qdatagram, "datagram");
8088 DEFSYM (Qseqpacket, "seqpacket");
8090 DEFSYM (QCport, ":port");
8091 DEFSYM (QCspeed, ":speed");
8092 DEFSYM (QCprocess, ":process");
8094 DEFSYM (QCbytesize, ":bytesize");
8095 DEFSYM (QCstopbits, ":stopbits");
8096 DEFSYM (QCparity, ":parity");
8097 DEFSYM (Qodd, "odd");
8098 DEFSYM (Qeven, "even");
8099 DEFSYM (QCflowcontrol, ":flowcontrol");
8100 DEFSYM (Qhw, "hw");
8101 DEFSYM (Qsw, "sw");
8102 DEFSYM (QCsummary, ":summary");
8104 DEFSYM (Qreal, "real");
8105 DEFSYM (Qnetwork, "network");
8106 DEFSYM (Qserial, "serial");
8107 DEFSYM (QCbuffer, ":buffer");
8108 DEFSYM (QChost, ":host");
8109 DEFSYM (QCservice, ":service");
8110 DEFSYM (QClocal, ":local");
8111 DEFSYM (QCremote, ":remote");
8112 DEFSYM (QCcoding, ":coding");
8113 DEFSYM (QCserver, ":server");
8114 DEFSYM (QCnowait, ":nowait");
8115 DEFSYM (QCsentinel, ":sentinel");
8116 DEFSYM (QCuse_external_socket, ":use-external-socket");
8117 DEFSYM (QCtls_parameters, ":tls-parameters");
8118 DEFSYM (Qnsm_verify_connection, "nsm-verify-connection");
8119 DEFSYM (QClog, ":log");
8120 DEFSYM (QCnoquery, ":noquery");
8121 DEFSYM (QCstop, ":stop");
8122 DEFSYM (QCplist, ":plist");
8123 DEFSYM (QCcommand, ":command");
8124 DEFSYM (QCconnection_type, ":connection-type");
8125 DEFSYM (QCstderr, ":stderr");
8126 DEFSYM (Qpty, "pty");
8127 DEFSYM (Qpipe, "pipe");
8129 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
8131 staticpro (&Vprocess_alist);
8132 staticpro (&deleted_pid_list);
8134 #endif /* subprocesses */
8136 DEFSYM (QCname, ":name");
8137 DEFSYM (QCtype, ":type");
8139 DEFSYM (Qeuid, "euid");
8140 DEFSYM (Qegid, "egid");
8141 DEFSYM (Quser, "user");
8142 DEFSYM (Qgroup, "group");
8143 DEFSYM (Qcomm, "comm");
8144 DEFSYM (Qstate, "state");
8145 DEFSYM (Qppid, "ppid");
8146 DEFSYM (Qpgrp, "pgrp");
8147 DEFSYM (Qsess, "sess");
8148 DEFSYM (Qttname, "ttname");
8149 DEFSYM (Qtpgid, "tpgid");
8150 DEFSYM (Qminflt, "minflt");
8151 DEFSYM (Qmajflt, "majflt");
8152 DEFSYM (Qcminflt, "cminflt");
8153 DEFSYM (Qcmajflt, "cmajflt");
8154 DEFSYM (Qutime, "utime");
8155 DEFSYM (Qstime, "stime");
8156 DEFSYM (Qtime, "time");
8157 DEFSYM (Qcutime, "cutime");
8158 DEFSYM (Qcstime, "cstime");
8159 DEFSYM (Qctime, "ctime");
8160 #ifdef subprocesses
8161 DEFSYM (Qinternal_default_process_sentinel,
8162 "internal-default-process-sentinel");
8163 DEFSYM (Qinternal_default_process_filter,
8164 "internal-default-process-filter");
8165 #endif
8166 DEFSYM (Qpri, "pri");
8167 DEFSYM (Qnice, "nice");
8168 DEFSYM (Qthcount, "thcount");
8169 DEFSYM (Qstart, "start");
8170 DEFSYM (Qvsize, "vsize");
8171 DEFSYM (Qrss, "rss");
8172 DEFSYM (Qetime, "etime");
8173 DEFSYM (Qpcpu, "pcpu");
8174 DEFSYM (Qpmem, "pmem");
8175 DEFSYM (Qargs, "args");
8177 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
8178 doc: /* Non-nil means delete processes immediately when they exit.
8179 A value of nil means don't delete them until `list-processes' is run. */);
8181 delete_exited_processes = 1;
8183 #ifdef subprocesses
8184 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
8185 doc: /* Control type of device used to communicate with subprocesses.
8186 Values are nil to use a pipe, or t or `pty' to use a pty.
8187 The value has no effect if the system has no ptys or if all ptys are busy:
8188 then a pipe is used in any case.
8189 The value takes effect when `start-process' is called. */);
8190 Vprocess_connection_type = Qt;
8192 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
8193 doc: /* If non-nil, improve receive buffering by delaying after short reads.
8194 On some systems, when Emacs reads the output from a subprocess, the output data
8195 is read in very small blocks, potentially resulting in very poor performance.
8196 This behavior can be remedied to some extent by setting this variable to a
8197 non-nil value, as it will automatically delay reading from such processes, to
8198 allow them to produce more output before Emacs tries to read it.
8199 If the value is t, the delay is reset after each write to the process; any other
8200 non-nil value means that the delay is not reset on write.
8201 The variable takes effect when `start-process' is called. */);
8202 Vprocess_adaptive_read_buffering = Qt;
8204 DEFVAR_LISP ("interrupt-process-functions", Vinterrupt_process_functions,
8205 doc: /* List of functions to be called for `interrupt-process'.
8206 The arguments of the functions are the same as for `interrupt-process'.
8207 These functions are called in the order of the list, until one of them
8208 returns non-`nil'. */);
8209 Vinterrupt_process_functions = list1 (Qinternal_default_interrupt_process);
8211 DEFSYM (Qinternal_default_interrupt_process,
8212 "internal-default-interrupt-process");
8213 DEFSYM (Qinterrupt_process_functions, "interrupt-process-functions");
8215 defsubr (&Sprocessp);
8216 defsubr (&Sget_process);
8217 defsubr (&Sdelete_process);
8218 defsubr (&Sprocess_status);
8219 defsubr (&Sprocess_exit_status);
8220 defsubr (&Sprocess_id);
8221 defsubr (&Sprocess_name);
8222 defsubr (&Sprocess_tty_name);
8223 defsubr (&Sprocess_command);
8224 defsubr (&Sset_process_buffer);
8225 defsubr (&Sprocess_buffer);
8226 defsubr (&Sprocess_mark);
8227 defsubr (&Sset_process_filter);
8228 defsubr (&Sprocess_filter);
8229 defsubr (&Sset_process_sentinel);
8230 defsubr (&Sprocess_sentinel);
8231 defsubr (&Sset_process_thread);
8232 defsubr (&Sprocess_thread);
8233 defsubr (&Sset_process_window_size);
8234 defsubr (&Sset_process_inherit_coding_system_flag);
8235 defsubr (&Sset_process_query_on_exit_flag);
8236 defsubr (&Sprocess_query_on_exit_flag);
8237 defsubr (&Sprocess_contact);
8238 defsubr (&Sprocess_plist);
8239 defsubr (&Sset_process_plist);
8240 defsubr (&Sprocess_list);
8241 defsubr (&Smake_process);
8242 defsubr (&Smake_pipe_process);
8243 defsubr (&Sserial_process_configure);
8244 defsubr (&Smake_serial_process);
8245 defsubr (&Sset_network_process_option);
8246 defsubr (&Smake_network_process);
8247 defsubr (&Sformat_network_address);
8248 defsubr (&Snetwork_interface_list);
8249 defsubr (&Snetwork_interface_info);
8250 #ifdef DATAGRAM_SOCKETS
8251 defsubr (&Sprocess_datagram_address);
8252 defsubr (&Sset_process_datagram_address);
8253 #endif
8254 defsubr (&Saccept_process_output);
8255 defsubr (&Sprocess_send_region);
8256 defsubr (&Sprocess_send_string);
8257 defsubr (&Sinternal_default_interrupt_process);
8258 defsubr (&Sinterrupt_process);
8259 defsubr (&Skill_process);
8260 defsubr (&Squit_process);
8261 defsubr (&Sstop_process);
8262 defsubr (&Scontinue_process);
8263 defsubr (&Sprocess_running_child_p);
8264 defsubr (&Sprocess_send_eof);
8265 defsubr (&Ssignal_process);
8266 defsubr (&Swaiting_for_user_input_p);
8267 defsubr (&Sprocess_type);
8268 defsubr (&Sinternal_default_process_sentinel);
8269 defsubr (&Sinternal_default_process_filter);
8270 defsubr (&Sset_process_coding_system);
8271 defsubr (&Sprocess_coding_system);
8272 defsubr (&Sset_process_filter_multibyte);
8273 defsubr (&Sprocess_filter_multibyte_p);
8276 Lisp_Object subfeatures = Qnil;
8277 const struct socket_options *sopt;
8279 #define ADD_SUBFEATURE(key, val) \
8280 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
8282 ADD_SUBFEATURE (QCnowait, Qt);
8283 #ifdef DATAGRAM_SOCKETS
8284 ADD_SUBFEATURE (QCtype, Qdatagram);
8285 #endif
8286 #ifdef HAVE_SEQPACKET
8287 ADD_SUBFEATURE (QCtype, Qseqpacket);
8288 #endif
8289 #ifdef HAVE_LOCAL_SOCKETS
8290 ADD_SUBFEATURE (QCfamily, Qlocal);
8291 #endif
8292 ADD_SUBFEATURE (QCfamily, Qipv4);
8293 #ifdef AF_INET6
8294 ADD_SUBFEATURE (QCfamily, Qipv6);
8295 #endif
8296 #ifdef HAVE_GETSOCKNAME
8297 ADD_SUBFEATURE (QCservice, Qt);
8298 #endif
8299 ADD_SUBFEATURE (QCserver, Qt);
8301 for (sopt = socket_options; sopt->name; sopt++)
8302 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
8304 Fprovide (intern_c_string ("make-network-process"), subfeatures);
8307 #endif /* subprocesses */
8309 defsubr (&Sget_buffer_process);
8310 defsubr (&Sprocess_inherit_coding_system_flag);
8311 defsubr (&Slist_system_processes);
8312 defsubr (&Sprocess_attributes);