Improve responsiveness while in 'replace-buffer-contents'
[emacs.git] / src / process.c
blob7f6ea1261e79eda23a3e97724e16c459f330bd32
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 a filter function to handle the output. BUFFER may be
1622 also nil, meaning that this process is not associated with any buffer.
1624 :command COMMAND -- COMMAND is a list starting with the program file
1625 name, followed by strings to give to the program as arguments.
1627 :coding CODING -- If CODING is a symbol, it specifies the coding
1628 system used for both reading and writing for this process. If CODING
1629 is a cons (DECODING . ENCODING), DECODING is used for reading, and
1630 ENCODING is used for writing.
1632 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
1633 the process is running. If BOOL is not given, query before exiting.
1635 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
1636 In the stopped state, a process does not accept incoming data, but you
1637 can send outgoing data. The stopped state is cleared by
1638 `continue-process' and set by `stop-process'.
1640 :connection-type TYPE -- TYPE is control type of device used to
1641 communicate with subprocesses. Values are `pipe' to use a pipe, `pty'
1642 to use a pty, or nil to use the default specified through
1643 `process-connection-type'.
1645 :filter FILTER -- Install FILTER as the process filter.
1647 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
1649 :stderr STDERR -- STDERR is either a buffer or a pipe process attached
1650 to the standard error of subprocess. Specifying this implies
1651 `:connection-type' is set to `pipe'.
1653 usage: (make-process &rest ARGS) */)
1654 (ptrdiff_t nargs, Lisp_Object *args)
1656 Lisp_Object buffer, name, command, program, proc, contact, current_dir, tem;
1657 Lisp_Object xstderr, stderrproc;
1658 ptrdiff_t count = SPECPDL_INDEX ();
1660 if (nargs == 0)
1661 return Qnil;
1663 /* Save arguments for process-contact and clone-process. */
1664 contact = Flist (nargs, args);
1666 buffer = Fplist_get (contact, QCbuffer);
1667 if (!NILP (buffer))
1668 buffer = Fget_buffer_create (buffer);
1670 /* Make sure that the child will be able to chdir to the current
1671 buffer's current directory, or its unhandled equivalent. We
1672 can't just have the child check for an error when it does the
1673 chdir, since it's in a vfork. */
1674 current_dir = encode_current_directory ();
1676 name = Fplist_get (contact, QCname);
1677 CHECK_STRING (name);
1679 command = Fplist_get (contact, QCcommand);
1680 if (CONSP (command))
1681 program = XCAR (command);
1682 else
1683 program = Qnil;
1685 if (!NILP (program))
1686 CHECK_STRING (program);
1688 bool query_on_exit = NILP (Fplist_get (contact, QCnoquery));
1690 stderrproc = Qnil;
1691 xstderr = Fplist_get (contact, QCstderr);
1692 if (PROCESSP (xstderr))
1694 if (!PIPECONN_P (xstderr))
1695 error ("Process is not a pipe process");
1696 stderrproc = xstderr;
1698 else if (!NILP (xstderr))
1700 CHECK_STRING (program);
1701 stderrproc = CALLN (Fmake_pipe_process,
1702 QCname,
1703 concat2 (name, build_string (" stderr")),
1704 QCbuffer,
1705 Fget_buffer_create (xstderr),
1706 QCnoquery,
1707 query_on_exit ? Qnil : Qt);
1710 proc = make_process (name);
1711 record_unwind_protect (start_process_unwind, proc);
1713 pset_childp (XPROCESS (proc), Qt);
1714 eassert (NILP (XPROCESS (proc)->plist));
1715 pset_type (XPROCESS (proc), Qreal);
1716 pset_buffer (XPROCESS (proc), buffer);
1717 pset_sentinel (XPROCESS (proc), Fplist_get (contact, QCsentinel));
1718 pset_filter (XPROCESS (proc), Fplist_get (contact, QCfilter));
1719 pset_command (XPROCESS (proc), Fcopy_sequence (command));
1721 if (!query_on_exit)
1722 XPROCESS (proc)->kill_without_query = 1;
1723 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
1724 pset_command (XPROCESS (proc), Qt);
1726 tem = Fplist_get (contact, QCconnection_type);
1727 if (EQ (tem, Qpty))
1728 XPROCESS (proc)->pty_flag = true;
1729 else if (EQ (tem, Qpipe))
1730 XPROCESS (proc)->pty_flag = false;
1731 else if (NILP (tem))
1732 XPROCESS (proc)->pty_flag = !NILP (Vprocess_connection_type);
1733 else
1734 report_file_error ("Unknown connection type", tem);
1736 if (!NILP (stderrproc))
1738 pset_stderrproc (XPROCESS (proc), stderrproc);
1740 XPROCESS (proc)->pty_flag = false;
1743 #ifdef HAVE_GNUTLS
1744 /* AKA GNUTLS_INITSTAGE(proc). */
1745 verify (GNUTLS_STAGE_EMPTY == 0);
1746 eassert (XPROCESS (proc)->gnutls_initstage == GNUTLS_STAGE_EMPTY);
1747 eassert (NILP (XPROCESS (proc)->gnutls_cred_type));
1748 #endif
1750 XPROCESS (proc)->adaptive_read_buffering
1751 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1752 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1754 /* Make the process marker point into the process buffer (if any). */
1755 if (BUFFERP (buffer))
1756 set_marker_both (XPROCESS (proc)->mark, buffer,
1757 BUF_ZV (XBUFFER (buffer)),
1758 BUF_ZV_BYTE (XBUFFER (buffer)));
1760 USE_SAFE_ALLOCA;
1763 /* Decide coding systems for communicating with the process. Here
1764 we don't setup the structure coding_system nor pay attention to
1765 unibyte mode. They are done in create_process. */
1767 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1768 Lisp_Object coding_systems = Qt;
1769 Lisp_Object val, *args2;
1771 tem = Fplist_get (contact, QCcoding);
1772 if (!NILP (tem))
1774 val = tem;
1775 if (CONSP (val))
1776 val = XCAR (val);
1778 else
1779 val = Vcoding_system_for_read;
1780 if (NILP (val))
1782 ptrdiff_t nargs2 = 3 + XINT (Flength (command));
1783 Lisp_Object tem2;
1784 SAFE_ALLOCA_LISP (args2, nargs2);
1785 ptrdiff_t i = 0;
1786 args2[i++] = Qstart_process;
1787 args2[i++] = name;
1788 args2[i++] = buffer;
1789 for (tem2 = command; CONSP (tem2); tem2 = XCDR (tem2))
1790 args2[i++] = XCAR (tem2);
1791 if (!NILP (program))
1792 coding_systems = Ffind_operation_coding_system (nargs2, args2);
1793 if (CONSP (coding_systems))
1794 val = XCAR (coding_systems);
1795 else if (CONSP (Vdefault_process_coding_system))
1796 val = XCAR (Vdefault_process_coding_system);
1798 pset_decode_coding_system (XPROCESS (proc), val);
1800 if (!NILP (tem))
1802 val = tem;
1803 if (CONSP (val))
1804 val = XCDR (val);
1806 else
1807 val = Vcoding_system_for_write;
1808 if (NILP (val))
1810 if (EQ (coding_systems, Qt))
1812 ptrdiff_t nargs2 = 3 + XINT (Flength (command));
1813 Lisp_Object tem2;
1814 SAFE_ALLOCA_LISP (args2, nargs2);
1815 ptrdiff_t i = 0;
1816 args2[i++] = Qstart_process;
1817 args2[i++] = name;
1818 args2[i++] = buffer;
1819 for (tem2 = command; CONSP (tem2); tem2 = XCDR (tem2))
1820 args2[i++] = XCAR (tem2);
1821 if (!NILP (program))
1822 coding_systems = Ffind_operation_coding_system (nargs2, args2);
1824 if (CONSP (coding_systems))
1825 val = XCDR (coding_systems);
1826 else if (CONSP (Vdefault_process_coding_system))
1827 val = XCDR (Vdefault_process_coding_system);
1829 pset_encode_coding_system (XPROCESS (proc), val);
1830 /* Note: At this moment, the above coding system may leave
1831 text-conversion or eol-conversion unspecified. They will be
1832 decided after we read output from the process and decode it by
1833 some coding system, or just before we actually send a text to
1834 the process. */
1838 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1839 eassert (XPROCESS (proc)->decoding_carryover == 0);
1840 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1842 XPROCESS (proc)->inherit_coding_system_flag
1843 = !(NILP (buffer) || !inherit_process_coding_system);
1845 if (!NILP (program))
1847 Lisp_Object program_args = XCDR (command);
1849 /* If program file name is not absolute, search our path for it.
1850 Put the name we will really use in TEM. */
1851 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1852 && !(SCHARS (program) > 1
1853 && IS_DEVICE_SEP (SREF (program, 1))))
1855 tem = Qnil;
1856 openp (Vexec_path, program, Vexec_suffixes, &tem,
1857 make_number (X_OK), false);
1858 if (NILP (tem))
1859 report_file_error ("Searching for program", program);
1860 tem = Fexpand_file_name (tem, Qnil);
1862 else
1864 if (!NILP (Ffile_directory_p (program)))
1865 error ("Specified program for new process is a directory");
1866 tem = program;
1869 /* Remove "/:" from TEM. */
1870 tem = remove_slash_colon (tem);
1872 Lisp_Object arg_encoding = Qnil;
1874 /* Encode the file name and put it in NEW_ARGV.
1875 That's where the child will use it to execute the program. */
1876 tem = list1 (ENCODE_FILE (tem));
1877 ptrdiff_t new_argc = 1;
1879 /* Here we encode arguments by the coding system used for sending
1880 data to the process. We don't support using different coding
1881 systems for encoding arguments and for encoding data sent to the
1882 process. */
1884 for (Lisp_Object tem2 = program_args; CONSP (tem2); tem2 = XCDR (tem2))
1886 Lisp_Object arg = XCAR (tem2);
1887 CHECK_STRING (arg);
1888 if (STRING_MULTIBYTE (arg))
1890 if (NILP (arg_encoding))
1891 arg_encoding = (complement_process_encoding_system
1892 (XPROCESS (proc)->encode_coding_system));
1893 arg = code_convert_string_norecord (arg, arg_encoding, 1);
1895 tem = Fcons (arg, tem);
1896 new_argc++;
1899 /* Now that everything is encoded we can collect the strings into
1900 NEW_ARGV. */
1901 char **new_argv;
1902 SAFE_NALLOCA (new_argv, 1, new_argc + 1);
1903 new_argv[new_argc] = 0;
1905 for (ptrdiff_t i = new_argc - 1; i >= 0; i--)
1907 new_argv[i] = SSDATA (XCAR (tem));
1908 tem = XCDR (tem);
1911 create_process (proc, new_argv, current_dir);
1913 else
1914 create_pty (proc);
1916 SAFE_FREE ();
1917 return unbind_to (count, proc);
1920 /* If PROC doesn't have its pid set, then an error was signaled and
1921 the process wasn't started successfully, so remove it. */
1922 static void
1923 start_process_unwind (Lisp_Object proc)
1925 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1926 remove_process (proc);
1929 /* If *FD_ADDR is nonnegative, close it, and mark it as closed. */
1931 static void
1932 close_process_fd (int *fd_addr)
1934 int fd = *fd_addr;
1935 if (0 <= fd)
1937 *fd_addr = -1;
1938 emacs_close (fd);
1942 /* Indexes of file descriptors in open_fds. */
1943 enum
1945 /* The pipe from Emacs to its subprocess. */
1946 SUBPROCESS_STDIN,
1947 WRITE_TO_SUBPROCESS,
1949 /* The main pipe from the subprocess to Emacs. */
1950 READ_FROM_SUBPROCESS,
1951 SUBPROCESS_STDOUT,
1953 /* The pipe from the subprocess to Emacs that is closed when the
1954 subprocess execs. */
1955 READ_FROM_EXEC_MONITOR,
1956 EXEC_MONITOR_OUTPUT
1959 verify (PROCESS_OPEN_FDS == EXEC_MONITOR_OUTPUT + 1);
1961 static void
1962 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1964 struct Lisp_Process *p = XPROCESS (process);
1965 int inchannel, outchannel;
1966 pid_t pid;
1967 int vfork_errno;
1968 int forkin, forkout, forkerr = -1;
1969 bool pty_flag = 0;
1970 char pty_name[PTY_NAME_SIZE];
1971 Lisp_Object lisp_pty_name = Qnil;
1972 sigset_t oldset;
1974 inchannel = outchannel = -1;
1976 if (p->pty_flag)
1977 outchannel = inchannel = allocate_pty (pty_name);
1979 if (inchannel >= 0)
1981 p->open_fd[READ_FROM_SUBPROCESS] = inchannel;
1982 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1983 /* On most USG systems it does not work to open the pty's tty here,
1984 then close it and reopen it in the child. */
1985 /* Don't let this terminal become our controlling terminal
1986 (in case we don't have one). */
1987 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1988 if (forkin < 0)
1989 report_file_error ("Opening pty", Qnil);
1990 p->open_fd[SUBPROCESS_STDIN] = forkin;
1991 #else
1992 forkin = forkout = -1;
1993 #endif /* not USG, or USG_SUBTTY_WORKS */
1994 pty_flag = 1;
1995 lisp_pty_name = build_string (pty_name);
1997 else
1999 if (emacs_pipe (p->open_fd + SUBPROCESS_STDIN) != 0
2000 || emacs_pipe (p->open_fd + READ_FROM_SUBPROCESS) != 0)
2001 report_file_error ("Creating pipe", Qnil);
2002 forkin = p->open_fd[SUBPROCESS_STDIN];
2003 outchannel = p->open_fd[WRITE_TO_SUBPROCESS];
2004 inchannel = p->open_fd[READ_FROM_SUBPROCESS];
2005 forkout = p->open_fd[SUBPROCESS_STDOUT];
2007 if (!NILP (p->stderrproc))
2009 struct Lisp_Process *pp = XPROCESS (p->stderrproc);
2011 forkerr = pp->open_fd[SUBPROCESS_STDOUT];
2013 /* Close unnecessary file descriptors. */
2014 close_process_fd (&pp->open_fd[WRITE_TO_SUBPROCESS]);
2015 close_process_fd (&pp->open_fd[SUBPROCESS_STDIN]);
2019 #ifndef WINDOWSNT
2020 if (emacs_pipe (p->open_fd + READ_FROM_EXEC_MONITOR) != 0)
2021 report_file_error ("Creating pipe", Qnil);
2022 #endif
2024 fcntl (inchannel, F_SETFL, O_NONBLOCK);
2025 fcntl (outchannel, F_SETFL, O_NONBLOCK);
2027 /* Record this as an active process, with its channels. */
2028 chan_process[inchannel] = process;
2029 p->infd = inchannel;
2030 p->outfd = outchannel;
2032 /* Previously we recorded the tty descriptor used in the subprocess.
2033 It was only used for getting the foreground tty process, so now
2034 we just reopen the device (see emacs_get_tty_pgrp) as this is
2035 more portable (see USG_SUBTTY_WORKS above). */
2037 p->pty_flag = pty_flag;
2038 pset_status (p, Qrun);
2040 if (!EQ (p->command, Qt))
2041 add_process_read_fd (inchannel);
2043 /* This may signal an error. */
2044 setup_process_coding_systems (process);
2046 block_input ();
2047 block_child_signal (&oldset);
2049 #ifndef WINDOWSNT
2050 /* vfork, and prevent local vars from being clobbered by the vfork. */
2051 Lisp_Object volatile current_dir_volatile = current_dir;
2052 Lisp_Object volatile lisp_pty_name_volatile = lisp_pty_name;
2053 char **volatile new_argv_volatile = new_argv;
2054 int volatile forkin_volatile = forkin;
2055 int volatile forkout_volatile = forkout;
2056 int volatile forkerr_volatile = forkerr;
2057 struct Lisp_Process *p_volatile = p;
2059 #ifdef DARWIN_OS
2060 /* Darwin doesn't let us run setsid after a vfork, so use fork when
2061 necessary. Also, reset SIGCHLD handling after a vfork, as
2062 apparently macOS can mistakenly deliver SIGCHLD to the child. */
2063 if (pty_flag)
2064 pid = fork ();
2065 else
2067 pid = vfork ();
2068 if (pid == 0)
2069 signal (SIGCHLD, SIG_DFL);
2071 #else
2072 pid = vfork ();
2073 #endif
2075 current_dir = current_dir_volatile;
2076 lisp_pty_name = lisp_pty_name_volatile;
2077 new_argv = new_argv_volatile;
2078 forkin = forkin_volatile;
2079 forkout = forkout_volatile;
2080 forkerr = forkerr_volatile;
2081 p = p_volatile;
2083 pty_flag = p->pty_flag;
2085 if (pid == 0)
2086 #endif /* not WINDOWSNT */
2088 /* Make the pty be the controlling terminal of the process. */
2089 #ifdef HAVE_PTYS
2090 /* First, disconnect its current controlling terminal.
2091 Do this even if !PTY_FLAG; see Bug#30762. */
2092 setsid ();
2093 /* Make the pty's terminal the controlling terminal. */
2094 if (pty_flag && forkin >= 0)
2096 #ifdef TIOCSCTTY
2097 /* We ignore the return value
2098 because faith@cs.unc.edu says that is necessary on Linux. */
2099 ioctl (forkin, TIOCSCTTY, 0);
2100 #endif
2102 #if defined (LDISC1)
2103 if (pty_flag && forkin >= 0)
2105 struct termios t;
2106 tcgetattr (forkin, &t);
2107 t.c_lflag = LDISC1;
2108 if (tcsetattr (forkin, TCSANOW, &t) < 0)
2109 emacs_perror ("create_process/tcsetattr LDISC1");
2111 #else
2112 #if defined (NTTYDISC) && defined (TIOCSETD)
2113 if (pty_flag && forkin >= 0)
2115 /* Use new line discipline. */
2116 int ldisc = NTTYDISC;
2117 ioctl (forkin, TIOCSETD, &ldisc);
2119 #endif
2120 #endif
2121 #ifdef TIOCNOTTY
2122 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
2123 can do TIOCSPGRP only to the process's controlling tty. */
2124 if (pty_flag)
2126 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
2127 I can't test it since I don't have 4.3. */
2128 int j = emacs_open (DEV_TTY, O_RDWR, 0);
2129 if (j >= 0)
2131 ioctl (j, TIOCNOTTY, 0);
2132 emacs_close (j);
2135 #endif /* TIOCNOTTY */
2137 #if !defined (DONT_REOPEN_PTY)
2138 /*** There is a suggestion that this ought to be a
2139 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
2140 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
2141 that system does seem to need this code, even though
2142 both TIOCSCTTY is defined. */
2143 /* Now close the pty (if we had it open) and reopen it.
2144 This makes the pty the controlling terminal of the subprocess. */
2145 if (pty_flag)
2148 /* I wonder if emacs_close (emacs_open (SSDATA (lisp_pty_name), ...))
2149 would work? */
2150 if (forkin >= 0)
2151 emacs_close (forkin);
2152 forkout = forkin = emacs_open (SSDATA (lisp_pty_name), O_RDWR, 0);
2154 if (forkin < 0)
2156 emacs_perror (SSDATA (lisp_pty_name));
2157 _exit (EXIT_CANCELED);
2161 #endif /* not DONT_REOPEN_PTY */
2163 #ifdef SETUP_SLAVE_PTY
2164 if (pty_flag)
2166 SETUP_SLAVE_PTY;
2168 #endif /* SETUP_SLAVE_PTY */
2169 #endif /* HAVE_PTYS */
2171 signal (SIGINT, SIG_DFL);
2172 signal (SIGQUIT, SIG_DFL);
2173 #ifdef SIGPROF
2174 signal (SIGPROF, SIG_DFL);
2175 #endif
2177 /* Emacs ignores SIGPIPE, but the child should not. */
2178 signal (SIGPIPE, SIG_DFL);
2180 /* Stop blocking SIGCHLD in the child. */
2181 unblock_child_signal (&oldset);
2183 if (pty_flag)
2184 child_setup_tty (forkout);
2186 if (forkerr < 0)
2187 forkerr = forkout;
2188 #ifdef WINDOWSNT
2189 pid = child_setup (forkin, forkout, forkerr, new_argv, 1, current_dir);
2190 #else /* not WINDOWSNT */
2191 child_setup (forkin, forkout, forkerr, new_argv, 1, current_dir);
2192 #endif /* not WINDOWSNT */
2195 /* Back in the parent process. */
2197 vfork_errno = errno;
2198 p->pid = pid;
2199 if (pid >= 0)
2200 p->alive = 1;
2202 /* Stop blocking in the parent. */
2203 unblock_child_signal (&oldset);
2204 unblock_input ();
2206 if (pid < 0)
2207 report_file_errno ("Doing vfork", Qnil, vfork_errno);
2208 else
2210 /* vfork succeeded. */
2212 /* Close the pipe ends that the child uses, or the child's pty. */
2213 close_process_fd (&p->open_fd[SUBPROCESS_STDIN]);
2214 close_process_fd (&p->open_fd[SUBPROCESS_STDOUT]);
2216 #ifdef WINDOWSNT
2217 register_child (pid, inchannel);
2218 #endif /* WINDOWSNT */
2220 pset_tty_name (p, lisp_pty_name);
2222 #ifndef WINDOWSNT
2223 /* Wait for child_setup to complete in case that vfork is
2224 actually defined as fork. The descriptor
2225 XPROCESS (proc)->open_fd[EXEC_MONITOR_OUTPUT]
2226 of a pipe is closed at the child side either by close-on-exec
2227 on successful execve or the _exit call in child_setup. */
2229 char dummy;
2231 close_process_fd (&p->open_fd[EXEC_MONITOR_OUTPUT]);
2232 emacs_read (p->open_fd[READ_FROM_EXEC_MONITOR], &dummy, 1);
2233 close_process_fd (&p->open_fd[READ_FROM_EXEC_MONITOR]);
2235 #endif
2236 if (!NILP (p->stderrproc))
2238 struct Lisp_Process *pp = XPROCESS (p->stderrproc);
2239 close_process_fd (&pp->open_fd[SUBPROCESS_STDOUT]);
2244 static void
2245 create_pty (Lisp_Object process)
2247 struct Lisp_Process *p = XPROCESS (process);
2248 char pty_name[PTY_NAME_SIZE];
2249 int pty_fd = !p->pty_flag ? -1 : allocate_pty (pty_name);
2251 if (pty_fd >= 0)
2253 p->open_fd[SUBPROCESS_STDIN] = pty_fd;
2254 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
2255 /* On most USG systems it does not work to open the pty's tty here,
2256 then close it and reopen it in the child. */
2257 /* Don't let this terminal become our controlling terminal
2258 (in case we don't have one). */
2259 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
2260 if (forkout < 0)
2261 report_file_error ("Opening pty", Qnil);
2262 p->open_fd[WRITE_TO_SUBPROCESS] = forkout;
2263 #if defined (DONT_REOPEN_PTY)
2264 /* In the case that vfork is defined as fork, the parent process
2265 (Emacs) may send some data before the child process completes
2266 tty options setup. So we setup tty before forking. */
2267 child_setup_tty (forkout);
2268 #endif /* DONT_REOPEN_PTY */
2269 #endif /* not USG, or USG_SUBTTY_WORKS */
2271 fcntl (pty_fd, F_SETFL, O_NONBLOCK);
2273 /* Record this as an active process, with its channels.
2274 As a result, child_setup will close Emacs's side of the pipes. */
2275 chan_process[pty_fd] = process;
2276 p->infd = pty_fd;
2277 p->outfd = pty_fd;
2279 /* Previously we recorded the tty descriptor used in the subprocess.
2280 It was only used for getting the foreground tty process, so now
2281 we just reopen the device (see emacs_get_tty_pgrp) as this is
2282 more portable (see USG_SUBTTY_WORKS above). */
2284 p->pty_flag = 1;
2285 pset_status (p, Qrun);
2286 setup_process_coding_systems (process);
2288 add_process_read_fd (pty_fd);
2290 pset_tty_name (p, build_string (pty_name));
2293 p->pid = -2;
2296 DEFUN ("make-pipe-process", Fmake_pipe_process, Smake_pipe_process,
2297 0, MANY, 0,
2298 doc: /* Create and return a bidirectional pipe process.
2300 In Emacs, pipes are represented by process objects, so input and
2301 output work as for subprocesses, and `delete-process' closes a pipe.
2302 However, a pipe process has no process id, it cannot be signaled,
2303 and the status codes are different from normal processes.
2305 Arguments are specified as keyword/argument pairs. The following
2306 arguments are defined:
2308 :name NAME -- NAME is the name of the process. It is modified if necessary to make it unique.
2310 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2311 with the process. Process output goes at the end of that buffer,
2312 unless you specify a filter function to handle the output. If BUFFER
2313 is not given, the value of NAME is used.
2315 :coding CODING -- If CODING is a symbol, it specifies the coding
2316 system used for both reading and writing for this process. If CODING
2317 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2318 ENCODING is used for writing.
2320 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2321 the process is running. If BOOL is not given, query before exiting.
2323 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2324 In the stopped state, a pipe process does not accept incoming data,
2325 but you can send outgoing data. The stopped state is cleared by
2326 `continue-process' and set by `stop-process'.
2328 :filter FILTER -- Install FILTER as the process filter.
2330 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2332 usage: (make-pipe-process &rest ARGS) */)
2333 (ptrdiff_t nargs, Lisp_Object *args)
2335 Lisp_Object proc, contact;
2336 struct Lisp_Process *p;
2337 Lisp_Object name, buffer;
2338 Lisp_Object tem;
2339 ptrdiff_t specpdl_count;
2340 int inchannel, outchannel;
2342 if (nargs == 0)
2343 return Qnil;
2345 contact = Flist (nargs, args);
2347 name = Fplist_get (contact, QCname);
2348 CHECK_STRING (name);
2349 proc = make_process (name);
2350 specpdl_count = SPECPDL_INDEX ();
2351 record_unwind_protect (remove_process, proc);
2352 p = XPROCESS (proc);
2354 if (emacs_pipe (p->open_fd + SUBPROCESS_STDIN) != 0
2355 || emacs_pipe (p->open_fd + READ_FROM_SUBPROCESS) != 0)
2356 report_file_error ("Creating pipe", Qnil);
2357 outchannel = p->open_fd[WRITE_TO_SUBPROCESS];
2358 inchannel = p->open_fd[READ_FROM_SUBPROCESS];
2360 fcntl (inchannel, F_SETFL, O_NONBLOCK);
2361 fcntl (outchannel, F_SETFL, O_NONBLOCK);
2363 #ifdef WINDOWSNT
2364 register_aux_fd (inchannel);
2365 #endif
2367 /* Record this as an active process, with its channels. */
2368 chan_process[inchannel] = proc;
2369 p->infd = inchannel;
2370 p->outfd = outchannel;
2372 if (inchannel > max_desc)
2373 max_desc = inchannel;
2375 buffer = Fplist_get (contact, QCbuffer);
2376 if (NILP (buffer))
2377 buffer = name;
2378 buffer = Fget_buffer_create (buffer);
2379 pset_buffer (p, buffer);
2381 pset_childp (p, contact);
2382 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2383 pset_type (p, Qpipe);
2384 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2385 pset_filter (p, Fplist_get (contact, QCfilter));
2386 eassert (NILP (p->log));
2387 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2388 p->kill_without_query = 1;
2389 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2390 pset_command (p, Qt);
2391 eassert (! p->pty_flag);
2393 if (!EQ (p->command, Qt))
2394 add_process_read_fd (inchannel);
2395 p->adaptive_read_buffering
2396 = (NILP (Vprocess_adaptive_read_buffering) ? 0
2397 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
2399 /* Make the process marker point into the process buffer (if any). */
2400 if (BUFFERP (buffer))
2401 set_marker_both (p->mark, buffer,
2402 BUF_ZV (XBUFFER (buffer)),
2403 BUF_ZV_BYTE (XBUFFER (buffer)));
2406 /* Setup coding systems for communicating with the network stream. */
2408 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
2409 Lisp_Object coding_systems = Qt;
2410 Lisp_Object val;
2412 tem = Fplist_get (contact, QCcoding);
2413 val = Qnil;
2414 if (!NILP (tem))
2416 val = tem;
2417 if (CONSP (val))
2418 val = XCAR (val);
2420 else if (!NILP (Vcoding_system_for_read))
2421 val = Vcoding_system_for_read;
2422 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2423 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2424 /* We dare not decode end-of-line format by setting VAL to
2425 Qraw_text, because the existing Emacs Lisp libraries
2426 assume that they receive bare code including a sequence of
2427 CR LF. */
2428 val = Qnil;
2429 else
2431 if (CONSP (coding_systems))
2432 val = XCAR (coding_systems);
2433 else if (CONSP (Vdefault_process_coding_system))
2434 val = XCAR (Vdefault_process_coding_system);
2435 else
2436 val = Qnil;
2438 pset_decode_coding_system (p, val);
2440 if (!NILP (tem))
2442 val = tem;
2443 if (CONSP (val))
2444 val = XCDR (val);
2446 else if (!NILP (Vcoding_system_for_write))
2447 val = Vcoding_system_for_write;
2448 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2449 val = Qnil;
2450 else
2452 if (CONSP (coding_systems))
2453 val = XCDR (coding_systems);
2454 else if (CONSP (Vdefault_process_coding_system))
2455 val = XCDR (Vdefault_process_coding_system);
2456 else
2457 val = Qnil;
2459 pset_encode_coding_system (p, val);
2461 /* This may signal an error. */
2462 setup_process_coding_systems (proc);
2464 pset_decoding_buf (p, empty_unibyte_string);
2465 eassert (p->decoding_carryover == 0);
2466 pset_encoding_buf (p, empty_unibyte_string);
2468 specpdl_ptr = specpdl + specpdl_count;
2470 return proc;
2474 /* Convert an internal struct sockaddr to a lisp object (vector or string).
2475 The address family of sa is not included in the result. */
2477 Lisp_Object
2478 conv_sockaddr_to_lisp (struct sockaddr *sa, ptrdiff_t len)
2480 Lisp_Object address;
2481 ptrdiff_t i;
2482 unsigned char *cp;
2483 struct Lisp_Vector *p;
2485 /* Workaround for a bug in getsockname on BSD: Names bound to
2486 sockets in the UNIX domain are inaccessible; getsockname returns
2487 a zero length name. */
2488 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
2489 return empty_unibyte_string;
2491 switch (sa->sa_family)
2493 case AF_INET:
2495 DECLARE_POINTER_ALIAS (sin, struct sockaddr_in, sa);
2496 len = sizeof (sin->sin_addr) + 1;
2497 address = Fmake_vector (make_number (len), Qnil);
2498 p = XVECTOR (address);
2499 p->contents[--len] = make_number (ntohs (sin->sin_port));
2500 cp = (unsigned char *) &sin->sin_addr;
2501 break;
2503 #ifdef AF_INET6
2504 case AF_INET6:
2506 DECLARE_POINTER_ALIAS (sin6, struct sockaddr_in6, sa);
2507 DECLARE_POINTER_ALIAS (ip6, uint16_t, &sin6->sin6_addr);
2508 len = sizeof (sin6->sin6_addr) / 2 + 1;
2509 address = Fmake_vector (make_number (len), Qnil);
2510 p = XVECTOR (address);
2511 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2512 for (i = 0; i < len; i++)
2513 p->contents[i] = make_number (ntohs (ip6[i]));
2514 return address;
2516 #endif
2517 #ifdef HAVE_LOCAL_SOCKETS
2518 case AF_LOCAL:
2520 DECLARE_POINTER_ALIAS (sockun, struct sockaddr_un, sa);
2521 ptrdiff_t name_length = len - offsetof (struct sockaddr_un, sun_path);
2522 /* If the first byte is NUL, the name is a Linux abstract
2523 socket name, and the name can contain embedded NULs. If
2524 it's not, we have a NUL-terminated string. Be careful not
2525 to walk past the end of the object looking for the name
2526 terminator, however. */
2527 if (name_length > 0 && sockun->sun_path[0] != '\0')
2529 const char *terminator
2530 = memchr (sockun->sun_path, '\0', name_length);
2532 if (terminator)
2533 name_length = terminator - (const char *) sockun->sun_path;
2536 return make_unibyte_string (sockun->sun_path, name_length);
2538 #endif
2539 default:
2540 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2541 address = Fcons (make_number (sa->sa_family),
2542 Fmake_vector (make_number (len), Qnil));
2543 p = XVECTOR (XCDR (address));
2544 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2545 break;
2548 i = 0;
2549 while (i < len)
2550 p->contents[i++] = make_number (*cp++);
2552 return address;
2555 /* Convert an internal struct addrinfo to a Lisp object. */
2557 static Lisp_Object
2558 conv_addrinfo_to_lisp (struct addrinfo *res)
2560 Lisp_Object protocol = make_number (res->ai_protocol);
2561 eassert (XINT (protocol) == res->ai_protocol);
2562 return Fcons (protocol, conv_sockaddr_to_lisp (res->ai_addr, res->ai_addrlen));
2566 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2568 static ptrdiff_t
2569 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2571 struct Lisp_Vector *p;
2573 if (VECTORP (address))
2575 p = XVECTOR (address);
2576 if (p->header.size == 5)
2578 *familyp = AF_INET;
2579 return sizeof (struct sockaddr_in);
2581 #ifdef AF_INET6
2582 else if (p->header.size == 9)
2584 *familyp = AF_INET6;
2585 return sizeof (struct sockaddr_in6);
2587 #endif
2589 #ifdef HAVE_LOCAL_SOCKETS
2590 else if (STRINGP (address))
2592 *familyp = AF_LOCAL;
2593 return sizeof (struct sockaddr_un);
2595 #endif
2596 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2597 && VECTORP (XCDR (address)))
2599 struct sockaddr *sa;
2600 p = XVECTOR (XCDR (address));
2601 if (MAX_ALLOCA - sizeof sa->sa_family < p->header.size)
2602 return 0;
2603 *familyp = XINT (XCAR (address));
2604 return p->header.size + sizeof (sa->sa_family);
2606 return 0;
2609 /* Convert an address object (vector or string) to an internal sockaddr.
2611 The address format has been basically validated by
2612 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2613 it could have come from user data. So if FAMILY is not valid,
2614 we return after zeroing *SA. */
2616 static void
2617 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2619 register struct Lisp_Vector *p;
2620 register unsigned char *cp = NULL;
2621 register int i;
2622 EMACS_INT hostport;
2624 memset (sa, 0, len);
2626 if (VECTORP (address))
2628 p = XVECTOR (address);
2629 if (family == AF_INET)
2631 DECLARE_POINTER_ALIAS (sin, struct sockaddr_in, sa);
2632 len = sizeof (sin->sin_addr) + 1;
2633 hostport = XINT (p->contents[--len]);
2634 sin->sin_port = htons (hostport);
2635 cp = (unsigned char *)&sin->sin_addr;
2636 sa->sa_family = family;
2638 #ifdef AF_INET6
2639 else if (family == AF_INET6)
2641 DECLARE_POINTER_ALIAS (sin6, struct sockaddr_in6, sa);
2642 DECLARE_POINTER_ALIAS (ip6, uint16_t, &sin6->sin6_addr);
2643 len = sizeof (sin6->sin6_addr) / 2 + 1;
2644 hostport = XINT (p->contents[--len]);
2645 sin6->sin6_port = htons (hostport);
2646 for (i = 0; i < len; i++)
2647 if (INTEGERP (p->contents[i]))
2649 int j = XFASTINT (p->contents[i]) & 0xffff;
2650 ip6[i] = ntohs (j);
2652 sa->sa_family = family;
2653 return;
2655 #endif
2656 else
2657 return;
2659 else if (STRINGP (address))
2661 #ifdef HAVE_LOCAL_SOCKETS
2662 if (family == AF_LOCAL)
2664 DECLARE_POINTER_ALIAS (sockun, struct sockaddr_un, sa);
2665 cp = SDATA (address);
2666 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2667 sockun->sun_path[i] = *cp++;
2668 sa->sa_family = family;
2670 #endif
2671 return;
2673 else
2675 p = XVECTOR (XCDR (address));
2676 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2679 for (i = 0; i < len; i++)
2680 if (INTEGERP (p->contents[i]))
2681 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2684 #ifdef DATAGRAM_SOCKETS
2685 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2686 1, 1, 0,
2687 doc: /* Get the current datagram address associated with PROCESS.
2688 If PROCESS is a non-blocking network process that hasn't been fully
2689 set up yet, this function will block until socket setup has completed. */)
2690 (Lisp_Object process)
2692 int channel;
2694 CHECK_PROCESS (process);
2696 if (NETCONN_P (process))
2697 wait_for_socket_fds (process, "process-datagram-address");
2699 if (!DATAGRAM_CONN_P (process))
2700 return Qnil;
2702 channel = XPROCESS (process)->infd;
2703 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2704 datagram_address[channel].len);
2707 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2708 2, 2, 0,
2709 doc: /* Set the datagram address for PROCESS to ADDRESS.
2710 Return nil upon error setting address, ADDRESS otherwise.
2712 If PROCESS is a non-blocking network process that hasn't been fully
2713 set up yet, this function will block until socket setup has completed. */)
2714 (Lisp_Object process, Lisp_Object address)
2716 int channel;
2717 int family;
2718 ptrdiff_t len;
2720 CHECK_PROCESS (process);
2722 if (NETCONN_P (process))
2723 wait_for_socket_fds (process, "set-process-datagram-address");
2725 if (!DATAGRAM_CONN_P (process))
2726 return Qnil;
2728 channel = XPROCESS (process)->infd;
2730 len = get_lisp_to_sockaddr_size (address, &family);
2731 if (len == 0 || datagram_address[channel].len != len)
2732 return Qnil;
2733 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2734 return address;
2736 #endif
2739 static const struct socket_options {
2740 /* The name of this option. Should be lowercase version of option
2741 name without SO_ prefix. */
2742 const char *name;
2743 /* Option level SOL_... */
2744 int optlevel;
2745 /* Option number SO_... */
2746 int optnum;
2747 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2748 enum { OPIX_NONE = 0, OPIX_MISC = 1, OPIX_REUSEADDR = 2 } optbit;
2749 } socket_options[] =
2751 #ifdef SO_BINDTODEVICE
2752 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2753 #endif
2754 #ifdef SO_BROADCAST
2755 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2756 #endif
2757 #ifdef SO_DONTROUTE
2758 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2759 #endif
2760 #ifdef SO_KEEPALIVE
2761 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2762 #endif
2763 #ifdef SO_LINGER
2764 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2765 #endif
2766 #ifdef SO_OOBINLINE
2767 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2768 #endif
2769 #ifdef SO_PRIORITY
2770 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2771 #endif
2772 #ifdef SO_REUSEADDR
2773 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2774 #endif
2775 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2778 /* Set option OPT to value VAL on socket S.
2780 Return (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2781 Signals an error if setting a known option fails.
2784 static int
2785 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2787 char *name;
2788 const struct socket_options *sopt;
2789 int ret = 0;
2791 CHECK_SYMBOL (opt);
2793 name = SSDATA (SYMBOL_NAME (opt));
2794 for (sopt = socket_options; sopt->name; sopt++)
2795 if (strcmp (name, sopt->name) == 0)
2796 break;
2798 switch (sopt->opttype)
2800 case SOPT_BOOL:
2802 int optval;
2803 optval = NILP (val) ? 0 : 1;
2804 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2805 &optval, sizeof (optval));
2806 break;
2809 case SOPT_INT:
2811 int optval;
2812 if (TYPE_RANGED_INTEGERP (int, val))
2813 optval = XINT (val);
2814 else
2815 error ("Bad option value for %s", name);
2816 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2817 &optval, sizeof (optval));
2818 break;
2821 #ifdef SO_BINDTODEVICE
2822 case SOPT_IFNAME:
2824 char devname[IFNAMSIZ + 1];
2826 /* This is broken, at least in the Linux 2.4 kernel.
2827 To unbind, the arg must be a zero integer, not the empty string.
2828 This should work on all systems. KFS. 2003-09-23. */
2829 memset (devname, 0, sizeof devname);
2830 if (STRINGP (val))
2832 char *arg = SSDATA (val);
2833 int len = min (strlen (arg), IFNAMSIZ);
2834 memcpy (devname, arg, len);
2836 else if (!NILP (val))
2837 error ("Bad option value for %s", name);
2838 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2839 devname, IFNAMSIZ);
2840 break;
2842 #endif
2844 #ifdef SO_LINGER
2845 case SOPT_LINGER:
2847 struct linger linger;
2849 linger.l_onoff = 1;
2850 linger.l_linger = 0;
2851 if (TYPE_RANGED_INTEGERP (int, val))
2852 linger.l_linger = XINT (val);
2853 else
2854 linger.l_onoff = NILP (val) ? 0 : 1;
2855 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2856 &linger, sizeof (linger));
2857 break;
2859 #endif
2861 default:
2862 return 0;
2865 if (ret < 0)
2867 int setsockopt_errno = errno;
2868 report_file_errno ("Cannot set network option", list2 (opt, val),
2869 setsockopt_errno);
2872 return (1 << sopt->optbit);
2876 DEFUN ("set-network-process-option",
2877 Fset_network_process_option, Sset_network_process_option,
2878 3, 4, 0,
2879 doc: /* For network process PROCESS set option OPTION to value VALUE.
2880 See `make-network-process' for a list of options and values.
2881 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2882 OPTION is not a supported option, return nil instead; otherwise return t.
2884 If PROCESS is a non-blocking network process that hasn't been fully
2885 set up yet, this function will block until socket setup has completed. */)
2886 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2888 int s;
2889 struct Lisp_Process *p;
2891 CHECK_PROCESS (process);
2892 p = XPROCESS (process);
2893 if (!NETCONN1_P (p))
2894 error ("Process is not a network process");
2896 wait_for_socket_fds (process, "set-network-process-option");
2898 s = p->infd;
2899 if (s < 0)
2900 error ("Process is not running");
2902 if (set_socket_option (s, option, value))
2904 pset_childp (p, Fplist_put (p->childp, option, value));
2905 return Qt;
2908 if (NILP (no_error))
2909 error ("Unknown or unsupported option");
2911 return Qnil;
2915 DEFUN ("serial-process-configure",
2916 Fserial_process_configure,
2917 Sserial_process_configure,
2918 0, MANY, 0,
2919 doc: /* Configure speed, bytesize, etc. of a serial process.
2921 Arguments are specified as keyword/argument pairs. Attributes that
2922 are not given are re-initialized from the process's current
2923 configuration (available via the function `process-contact') or set to
2924 reasonable default values. The following arguments are defined:
2926 :process PROCESS
2927 :name NAME
2928 :buffer BUFFER
2929 :port PORT
2930 -- Any of these arguments can be given to identify the process that is
2931 to be configured. If none of these arguments is given, the current
2932 buffer's process is used.
2934 :speed SPEED -- SPEED is the speed of the serial port in bits per
2935 second, also called baud rate. Any value can be given for SPEED, but
2936 most serial ports work only at a few defined values between 1200 and
2937 115200, with 9600 being the most common value. If SPEED is nil, the
2938 serial port is not configured any further, i.e., all other arguments
2939 are ignored. This may be useful for special serial ports such as
2940 Bluetooth-to-serial converters which can only be configured through AT
2941 commands. A value of nil for SPEED can be used only when passed
2942 through `make-serial-process' or `serial-term'.
2944 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2945 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2947 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2948 `odd' (use odd parity), or the symbol `even' (use even parity). If
2949 PARITY is not given, no parity is used.
2951 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2952 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2953 is not given or nil, 1 stopbit is used.
2955 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2956 flowcontrol to be used, which is either nil (don't use flowcontrol),
2957 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2958 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2959 flowcontrol is used.
2961 `serial-process-configure' is called by `make-serial-process' for the
2962 initial configuration of the serial port.
2964 Examples:
2966 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2968 \(serial-process-configure
2969 :buffer "COM1" :stopbits 1 :parity \\='odd :flowcontrol \\='hw)
2971 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2973 usage: (serial-process-configure &rest ARGS) */)
2974 (ptrdiff_t nargs, Lisp_Object *args)
2976 struct Lisp_Process *p;
2977 Lisp_Object contact = Qnil;
2978 Lisp_Object proc = Qnil;
2980 contact = Flist (nargs, args);
2982 proc = Fplist_get (contact, QCprocess);
2983 if (NILP (proc))
2984 proc = Fplist_get (contact, QCname);
2985 if (NILP (proc))
2986 proc = Fplist_get (contact, QCbuffer);
2987 if (NILP (proc))
2988 proc = Fplist_get (contact, QCport);
2989 proc = get_process (proc);
2990 p = XPROCESS (proc);
2991 if (!EQ (p->type, Qserial))
2992 error ("Not a serial process");
2994 if (NILP (Fplist_get (p->childp, QCspeed)))
2995 return Qnil;
2997 serial_configure (p, contact);
2998 return Qnil;
3001 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
3002 0, MANY, 0,
3003 doc: /* Create and return a serial port process.
3005 In Emacs, serial port connections are represented by process objects,
3006 so input and output work as for subprocesses, and `delete-process'
3007 closes a serial port connection. However, a serial process has no
3008 process id, it cannot be signaled, and the status codes are different
3009 from normal processes.
3011 `make-serial-process' creates a process and a buffer, on which you
3012 probably want to use `process-send-string'. Try \\[serial-term] for
3013 an interactive terminal. See below for examples.
3015 Arguments are specified as keyword/argument pairs. The following
3016 arguments are defined:
3018 :port PORT -- (mandatory) PORT is the path or name of the serial port.
3019 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
3020 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
3021 the backslashes in strings).
3023 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
3024 which this function calls.
3026 :name NAME -- NAME is the name of the process. If NAME is not given,
3027 the value of PORT is used.
3029 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
3030 with the process. Process output goes at the end of that buffer,
3031 unless you specify a filter function to handle the output. If BUFFER
3032 is not given, the value of NAME is used.
3034 :coding CODING -- If CODING is a symbol, it specifies the coding
3035 system used for both reading and writing for this process. If CODING
3036 is a cons (DECODING . ENCODING), DECODING is used for reading, and
3037 ENCODING is used for writing.
3039 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
3040 the process is running. If BOOL is not given, query before exiting.
3042 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
3043 In the stopped state, a serial process does not accept incoming data,
3044 but you can send outgoing data. The stopped state is cleared by
3045 `continue-process' and set by `stop-process'.
3047 :filter FILTER -- Install FILTER as the process filter.
3049 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
3051 :plist PLIST -- Install PLIST as the initial plist of the process.
3053 :bytesize
3054 :parity
3055 :stopbits
3056 :flowcontrol
3057 -- This function calls `serial-process-configure' to handle these
3058 arguments.
3060 The original argument list, possibly modified by later configuration,
3061 is available via the function `process-contact'.
3063 Examples:
3065 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
3067 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
3069 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity \\='odd)
3071 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
3073 usage: (make-serial-process &rest ARGS) */)
3074 (ptrdiff_t nargs, Lisp_Object *args)
3076 int fd = -1;
3077 Lisp_Object proc, contact, port;
3078 struct Lisp_Process *p;
3079 Lisp_Object name, buffer;
3080 Lisp_Object tem, val;
3081 ptrdiff_t specpdl_count;
3083 if (nargs == 0)
3084 return Qnil;
3086 contact = Flist (nargs, args);
3088 port = Fplist_get (contact, QCport);
3089 if (NILP (port))
3090 error ("No port specified");
3091 CHECK_STRING (port);
3093 if (NILP (Fplist_member (contact, QCspeed)))
3094 error (":speed not specified");
3095 if (!NILP (Fplist_get (contact, QCspeed)))
3096 CHECK_NUMBER (Fplist_get (contact, QCspeed));
3098 name = Fplist_get (contact, QCname);
3099 if (NILP (name))
3100 name = port;
3101 CHECK_STRING (name);
3102 proc = make_process (name);
3103 specpdl_count = SPECPDL_INDEX ();
3104 record_unwind_protect (remove_process, proc);
3105 p = XPROCESS (proc);
3107 fd = serial_open (port);
3108 p->open_fd[SUBPROCESS_STDIN] = fd;
3109 p->infd = fd;
3110 p->outfd = fd;
3111 if (fd > max_desc)
3112 max_desc = fd;
3113 chan_process[fd] = proc;
3115 buffer = Fplist_get (contact, QCbuffer);
3116 if (NILP (buffer))
3117 buffer = name;
3118 buffer = Fget_buffer_create (buffer);
3119 pset_buffer (p, buffer);
3121 pset_childp (p, contact);
3122 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3123 pset_type (p, Qserial);
3124 pset_sentinel (p, Fplist_get (contact, QCsentinel));
3125 pset_filter (p, Fplist_get (contact, QCfilter));
3126 eassert (NILP (p->log));
3127 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3128 p->kill_without_query = 1;
3129 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
3130 pset_command (p, Qt);
3131 eassert (! p->pty_flag);
3133 if (!EQ (p->command, Qt))
3134 add_process_read_fd (fd);
3136 if (BUFFERP (buffer))
3138 set_marker_both (p->mark, buffer,
3139 BUF_ZV (XBUFFER (buffer)),
3140 BUF_ZV_BYTE (XBUFFER (buffer)));
3143 tem = Fplist_member (contact, QCcoding);
3144 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3145 tem = Qnil;
3147 val = Qnil;
3148 if (!NILP (tem))
3150 val = XCAR (XCDR (tem));
3151 if (CONSP (val))
3152 val = XCAR (val);
3154 else if (!NILP (Vcoding_system_for_read))
3155 val = Vcoding_system_for_read;
3156 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3157 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3158 val = Qnil;
3159 pset_decode_coding_system (p, val);
3161 val = Qnil;
3162 if (!NILP (tem))
3164 val = XCAR (XCDR (tem));
3165 if (CONSP (val))
3166 val = XCDR (val);
3168 else if (!NILP (Vcoding_system_for_write))
3169 val = Vcoding_system_for_write;
3170 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3171 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3172 val = Qnil;
3173 pset_encode_coding_system (p, val);
3175 setup_process_coding_systems (proc);
3176 pset_decoding_buf (p, empty_unibyte_string);
3177 eassert (p->decoding_carryover == 0);
3178 pset_encoding_buf (p, empty_unibyte_string);
3179 p->inherit_coding_system_flag
3180 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3182 Fserial_process_configure (nargs, args);
3184 specpdl_ptr = specpdl + specpdl_count;
3186 return proc;
3189 static void
3190 set_network_socket_coding_system (Lisp_Object proc, Lisp_Object host,
3191 Lisp_Object service, Lisp_Object name)
3193 Lisp_Object tem;
3194 struct Lisp_Process *p = XPROCESS (proc);
3195 Lisp_Object contact = p->childp;
3196 Lisp_Object coding_systems = Qt;
3197 Lisp_Object val;
3199 tem = Fplist_member (contact, QCcoding);
3200 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3201 tem = Qnil; /* No error message (too late!). */
3203 /* Setup coding systems for communicating with the network stream. */
3204 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3206 if (!NILP (tem))
3208 val = XCAR (XCDR (tem));
3209 if (CONSP (val))
3210 val = XCAR (val);
3212 else if (!NILP (Vcoding_system_for_read))
3213 val = Vcoding_system_for_read;
3214 else if ((!NILP (p->buffer)
3215 && NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
3216 || (NILP (p->buffer)
3217 && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3218 /* We dare not decode end-of-line format by setting VAL to
3219 Qraw_text, because the existing Emacs Lisp libraries
3220 assume that they receive bare code including a sequence of
3221 CR LF. */
3222 val = Qnil;
3223 else
3225 if (NILP (host) || NILP (service))
3226 coding_systems = Qnil;
3227 else
3228 coding_systems = CALLN (Ffind_operation_coding_system,
3229 Qopen_network_stream, name, p->buffer,
3230 host, service);
3231 if (CONSP (coding_systems))
3232 val = XCAR (coding_systems);
3233 else if (CONSP (Vdefault_process_coding_system))
3234 val = XCAR (Vdefault_process_coding_system);
3235 else
3236 val = Qnil;
3238 pset_decode_coding_system (p, val);
3240 if (!NILP (tem))
3242 val = XCAR (XCDR (tem));
3243 if (CONSP (val))
3244 val = XCDR (val);
3246 else if (!NILP (Vcoding_system_for_write))
3247 val = Vcoding_system_for_write;
3248 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3249 val = Qnil;
3250 else
3252 if (EQ (coding_systems, Qt))
3254 if (NILP (host) || NILP (service))
3255 coding_systems = Qnil;
3256 else
3257 coding_systems = CALLN (Ffind_operation_coding_system,
3258 Qopen_network_stream, name, p->buffer,
3259 host, service);
3261 if (CONSP (coding_systems))
3262 val = XCDR (coding_systems);
3263 else if (CONSP (Vdefault_process_coding_system))
3264 val = XCDR (Vdefault_process_coding_system);
3265 else
3266 val = Qnil;
3268 pset_encode_coding_system (p, val);
3270 pset_decoding_buf (p, empty_unibyte_string);
3271 p->decoding_carryover = 0;
3272 pset_encoding_buf (p, empty_unibyte_string);
3274 p->inherit_coding_system_flag
3275 = !(!NILP (tem) || NILP (p->buffer) || !inherit_process_coding_system);
3278 #ifdef HAVE_GNUTLS
3279 static void
3280 finish_after_tls_connection (Lisp_Object proc)
3282 struct Lisp_Process *p = XPROCESS (proc);
3283 Lisp_Object contact = p->childp;
3284 Lisp_Object result = Qt;
3286 if (!NILP (Ffboundp (Qnsm_verify_connection)))
3287 result = call3 (Qnsm_verify_connection,
3288 proc,
3289 Fplist_get (contact, QChost),
3290 Fplist_get (contact, QCservice));
3292 if (NILP (result))
3294 pset_status (p, list2 (Qfailed,
3295 build_string ("The Network Security Manager stopped the connections")));
3296 deactivate_process (proc);
3298 else if (p->outfd < 0)
3300 /* The counterparty may have closed the connection (especially
3301 if the NSM prompt above take a long time), so recheck the file
3302 descriptor here. */
3303 pset_status (p, Qfailed);
3304 deactivate_process (proc);
3306 else if ((fd_callback_info[p->outfd].flags & NON_BLOCKING_CONNECT_FD) == 0)
3308 /* If we cleared the connection wait mask before we did the TLS
3309 setup, then we have to say that the process is finally "open"
3310 here. */
3311 pset_status (p, Qrun);
3312 /* Execute the sentinel here. If we had relied on status_notify
3313 to do it later, it will read input from the process before
3314 calling the sentinel. */
3315 exec_sentinel (proc, build_string ("open\n"));
3318 #endif
3320 static void
3321 connect_network_socket (Lisp_Object proc, Lisp_Object addrinfos,
3322 Lisp_Object use_external_socket_p)
3324 ptrdiff_t count = SPECPDL_INDEX ();
3325 int s = -1, outch, inch;
3326 int xerrno = 0;
3327 int family;
3328 struct sockaddr *sa = NULL;
3329 int ret;
3330 ptrdiff_t addrlen;
3331 struct Lisp_Process *p = XPROCESS (proc);
3332 Lisp_Object contact = p->childp;
3333 int optbits = 0;
3334 int socket_to_use = -1;
3336 if (!NILP (use_external_socket_p))
3338 socket_to_use = external_sock_fd;
3340 /* Ensure we don't consume the external socket twice. */
3341 external_sock_fd = -1;
3344 /* Do this in case we never enter the while-loop below. */
3345 s = -1;
3347 while (!NILP (addrinfos))
3349 Lisp_Object addrinfo = XCAR (addrinfos);
3350 addrinfos = XCDR (addrinfos);
3351 int protocol = XINT (XCAR (addrinfo));
3352 Lisp_Object ip_address = XCDR (addrinfo);
3354 #ifdef WINDOWSNT
3355 retry_connect:
3356 #endif
3358 addrlen = get_lisp_to_sockaddr_size (ip_address, &family);
3359 if (sa)
3360 free (sa);
3361 sa = xmalloc (addrlen);
3362 conv_lisp_to_sockaddr (family, ip_address, sa, addrlen);
3364 s = socket_to_use;
3365 if (s < 0)
3367 int socktype = p->socktype | SOCK_CLOEXEC;
3368 if (p->is_non_blocking_client)
3369 socktype |= SOCK_NONBLOCK;
3370 s = socket (family, socktype, protocol);
3371 if (s < 0)
3373 xerrno = errno;
3374 continue;
3378 if (p->is_non_blocking_client && ! (SOCK_NONBLOCK && socket_to_use < 0))
3380 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3381 if (ret < 0)
3383 xerrno = errno;
3384 emacs_close (s);
3385 s = -1;
3386 if (0 <= socket_to_use)
3387 break;
3388 continue;
3392 #ifdef DATAGRAM_SOCKETS
3393 if (!p->is_server && p->socktype == SOCK_DGRAM)
3394 break;
3395 #endif /* DATAGRAM_SOCKETS */
3397 /* Make us close S if quit. */
3398 record_unwind_protect_int (close_file_unwind, s);
3400 /* Parse network options in the arg list. We simply ignore anything
3401 which isn't a known option (including other keywords). An error
3402 is signaled if setting a known option fails. */
3404 Lisp_Object params = contact, key, val;
3406 while (!NILP (params))
3408 key = XCAR (params);
3409 params = XCDR (params);
3410 val = XCAR (params);
3411 params = XCDR (params);
3412 optbits |= set_socket_option (s, key, val);
3416 if (p->is_server)
3418 /* Configure as a server socket. */
3420 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3421 explicit :reuseaddr key to override this. */
3422 #ifdef HAVE_LOCAL_SOCKETS
3423 if (family != AF_LOCAL)
3424 #endif
3425 if (!(optbits & (1 << OPIX_REUSEADDR)))
3427 int optval = 1;
3428 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3429 report_file_error ("Cannot set reuse option on server socket", Qnil);
3432 /* If passed a socket descriptor, it should be already bound. */
3433 if (socket_to_use < 0 && bind (s, sa, addrlen) != 0)
3434 report_file_error ("Cannot bind server socket", Qnil);
3436 #ifdef HAVE_GETSOCKNAME
3437 if (p->port == 0
3438 #ifdef HAVE_LOCAL_SOCKETS
3439 && family != AF_LOCAL
3440 #endif
3443 struct sockaddr_in sa1;
3444 socklen_t len1 = sizeof (sa1);
3445 #ifdef AF_INET6
3446 /* The code below assumes the port is at the same offset
3447 and of the same width in both IPv4 and IPv6
3448 structures, but the standards don't guarantee that,
3449 so verify it here. */
3450 struct sockaddr_in6 sa6;
3451 verify ((offsetof (struct sockaddr_in, sin_port)
3452 == offsetof (struct sockaddr_in6, sin6_port))
3453 && sizeof (sa1.sin_port) == sizeof (sa6.sin6_port));
3454 #endif
3455 DECLARE_POINTER_ALIAS (psa1, struct sockaddr, &sa1);
3456 if (getsockname (s, psa1, &len1) == 0)
3458 Lisp_Object service = make_number (ntohs (sa1.sin_port));
3459 contact = Fplist_put (contact, QCservice, service);
3460 /* Save the port number so that we can stash it in
3461 the process object later. */
3462 DECLARE_POINTER_ALIAS (psa, struct sockaddr_in, sa);
3463 psa->sin_port = sa1.sin_port;
3466 #endif
3468 if (p->socktype != SOCK_DGRAM && listen (s, p->backlog))
3469 report_file_error ("Cannot listen on server socket", Qnil);
3471 break;
3474 maybe_quit ();
3476 ret = connect (s, sa, addrlen);
3477 xerrno = errno;
3479 if (ret == 0 || xerrno == EISCONN)
3481 /* The unwind-protect will be discarded afterwards. */
3482 break;
3485 if (p->is_non_blocking_client && xerrno == EINPROGRESS)
3486 break;
3488 #ifndef WINDOWSNT
3489 if (xerrno == EINTR)
3491 /* Unlike most other syscalls connect() cannot be called
3492 again. (That would return EALREADY.) The proper way to
3493 wait for completion is pselect(). */
3494 int sc;
3495 socklen_t len;
3496 fd_set fdset;
3497 retry_select:
3498 FD_ZERO (&fdset);
3499 FD_SET (s, &fdset);
3500 maybe_quit ();
3501 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3502 if (sc == -1)
3504 if (errno == EINTR)
3505 goto retry_select;
3506 else
3507 report_file_error ("Failed select", Qnil);
3509 eassert (sc > 0);
3511 len = sizeof xerrno;
3512 eassert (FD_ISSET (s, &fdset));
3513 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) < 0)
3514 report_file_error ("Failed getsockopt", Qnil);
3515 if (xerrno == 0)
3516 break;
3517 if (NILP (addrinfos))
3518 report_file_errno ("Failed connect", Qnil, xerrno);
3520 #endif /* !WINDOWSNT */
3522 /* Discard the unwind protect closing S. */
3523 specpdl_ptr = specpdl + count;
3524 emacs_close (s);
3525 s = -1;
3526 if (0 <= socket_to_use)
3527 break;
3529 #ifdef WINDOWSNT
3530 if (xerrno == EINTR)
3531 goto retry_connect;
3532 #endif
3535 if (s >= 0)
3537 #ifdef DATAGRAM_SOCKETS
3538 if (p->socktype == SOCK_DGRAM)
3540 if (datagram_address[s].sa)
3541 emacs_abort ();
3543 datagram_address[s].sa = xmalloc (addrlen);
3544 datagram_address[s].len = addrlen;
3545 if (p->is_server)
3547 Lisp_Object remote;
3548 memset (datagram_address[s].sa, 0, addrlen);
3549 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3551 int rfamily;
3552 ptrdiff_t rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3553 if (rlen != 0 && rfamily == family
3554 && rlen == addrlen)
3555 conv_lisp_to_sockaddr (rfamily, remote,
3556 datagram_address[s].sa, rlen);
3559 else
3560 memcpy (datagram_address[s].sa, sa, addrlen);
3562 #endif
3564 contact = Fplist_put (contact, p->is_server? QClocal: QCremote,
3565 conv_sockaddr_to_lisp (sa, addrlen));
3566 #ifdef HAVE_GETSOCKNAME
3567 if (!p->is_server)
3569 struct sockaddr_storage sa1;
3570 socklen_t len1 = sizeof (sa1);
3571 DECLARE_POINTER_ALIAS (psa1, struct sockaddr, &sa1);
3572 if (getsockname (s, psa1, &len1) == 0)
3573 contact = Fplist_put (contact, QClocal,
3574 conv_sockaddr_to_lisp (psa1, len1));
3576 #endif
3579 if (s < 0)
3581 /* If non-blocking got this far - and failed - assume non-blocking is
3582 not supported after all. This is probably a wrong assumption, but
3583 the normal blocking calls to open-network-stream handles this error
3584 better. */
3585 if (p->is_non_blocking_client)
3586 return;
3588 report_file_errno ((p->is_server
3589 ? "make server process failed"
3590 : "make client process failed"),
3591 contact, xerrno);
3594 inch = s;
3595 outch = s;
3597 chan_process[inch] = proc;
3599 fcntl (inch, F_SETFL, O_NONBLOCK);
3601 p = XPROCESS (proc);
3602 p->open_fd[SUBPROCESS_STDIN] = inch;
3603 p->infd = inch;
3604 p->outfd = outch;
3606 /* Discard the unwind protect for closing S, if any. */
3607 specpdl_ptr = specpdl + count;
3609 if (p->is_server && p->socktype != SOCK_DGRAM)
3610 pset_status (p, Qlisten);
3612 /* Make the process marker point into the process buffer (if any). */
3613 if (BUFFERP (p->buffer))
3614 set_marker_both (p->mark, p->buffer,
3615 BUF_ZV (XBUFFER (p->buffer)),
3616 BUF_ZV_BYTE (XBUFFER (p->buffer)));
3618 if (p->is_non_blocking_client)
3620 /* We may get here if connect did succeed immediately. However,
3621 in that case, we still need to signal this like a non-blocking
3622 connection. */
3623 if (! (connecting_status (p->status)
3624 && EQ (XCDR (p->status), addrinfos)))
3625 pset_status (p, Fcons (Qconnect, addrinfos));
3626 if ((fd_callback_info[inch].flags & NON_BLOCKING_CONNECT_FD) == 0)
3627 add_non_blocking_write_fd (inch);
3629 else
3630 /* A server may have a client filter setting of Qt, but it must
3631 still listen for incoming connects unless it is stopped. */
3632 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3633 || (EQ (p->status, Qlisten) && NILP (p->command)))
3634 add_process_read_fd (inch);
3636 if (inch > max_desc)
3637 max_desc = inch;
3639 /* Set up the masks based on the process filter. */
3640 set_process_filter_masks (p);
3642 setup_process_coding_systems (proc);
3644 #ifdef HAVE_GNUTLS
3645 /* Continue the asynchronous connection. */
3646 if (!NILP (p->gnutls_boot_parameters))
3648 Lisp_Object boot, params = p->gnutls_boot_parameters;
3650 boot = Fgnutls_boot (proc, XCAR (params), XCDR (params));
3651 p->gnutls_boot_parameters = Qnil;
3653 if (p->gnutls_initstage == GNUTLS_STAGE_READY)
3654 /* Run sentinels, etc. */
3655 finish_after_tls_connection (proc);
3656 else if (p->gnutls_initstage != GNUTLS_STAGE_HANDSHAKE_TRIED)
3658 deactivate_process (proc);
3659 if (NILP (boot))
3660 pset_status (p, list2 (Qfailed,
3661 build_string ("TLS negotiation failed")));
3662 else
3663 pset_status (p, list2 (Qfailed, boot));
3666 #endif
3670 /* Create a network stream/datagram client/server process. Treated
3671 exactly like a normal process when reading and writing. Primary
3672 differences are in status display and process deletion. A network
3673 connection has no PID; you cannot signal it. All you can do is
3674 stop/continue it and deactivate/close it via delete-process. */
3676 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
3677 0, MANY, 0,
3678 doc: /* Create and return a network server or client process.
3680 In Emacs, network connections are represented by process objects, so
3681 input and output work as for subprocesses and `delete-process' closes
3682 a network connection. However, a network process has no process id,
3683 it cannot be signaled, and the status codes are different from normal
3684 processes.
3686 Arguments are specified as keyword/argument pairs. The following
3687 arguments are defined:
3689 :name NAME -- NAME is name for process. It is modified if necessary
3690 to make it unique.
3692 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
3693 with the process. Process output goes at end of that buffer, unless
3694 you specify a filter function to handle the output. BUFFER may be
3695 also nil, meaning that this process is not associated with any buffer.
3697 :host HOST -- HOST is name of the host to connect to, or its IP
3698 address. The symbol `local' specifies the local host. If specified
3699 for a server process, it must be a valid name or address for the local
3700 host, and only clients connecting to that address will be accepted.
3702 :service SERVICE -- SERVICE is name of the service desired, or an
3703 integer specifying a port number to connect to. If SERVICE is t,
3704 a random port number is selected for the server. A port number can
3705 be specified as an integer string, e.g., "80", as well as an integer.
3707 :type TYPE -- TYPE is the type of connection. The default (nil) is a
3708 stream type connection, `datagram' creates a datagram type connection,
3709 `seqpacket' creates a reliable datagram connection.
3711 :family FAMILY -- FAMILY is the address (and protocol) family for the
3712 service specified by HOST and SERVICE. The default (nil) is to use
3713 whatever address family (IPv4 or IPv6) that is defined for the host
3714 and port number specified by HOST and SERVICE. Other address families
3715 supported are:
3716 local -- for a local (i.e. UNIX) address specified by SERVICE.
3717 ipv4 -- use IPv4 address family only.
3718 ipv6 -- use IPv6 address family only.
3720 :local ADDRESS -- ADDRESS is the local address used for the connection.
3721 This parameter is ignored when opening a client process. When specified
3722 for a server process, the FAMILY, HOST and SERVICE args are ignored.
3724 :remote ADDRESS -- ADDRESS is the remote partner's address for the
3725 connection. This parameter is ignored when opening a stream server
3726 process. For a datagram server process, it specifies the initial
3727 setting of the remote datagram address. When specified for a client
3728 process, the FAMILY, HOST, and SERVICE args are ignored.
3730 The format of ADDRESS depends on the address family:
3731 - An IPv4 address is represented as a vector of integers [A B C D P]
3732 corresponding to numeric IP address A.B.C.D and port number P.
3733 - A local address is represented as a string with the address in the
3734 local address space.
3735 - An "unsupported family" address is represented by a cons (F . AV)
3736 where F is the family number and AV is a vector containing the socket
3737 address data with one element per address data byte. Do not rely on
3738 this format in portable code, as it may depend on implementation
3739 defined constants, data sizes, and data structure alignment.
3741 :coding CODING -- If CODING is a symbol, it specifies the coding
3742 system used for both reading and writing for this process. If CODING
3743 is a cons (DECODING . ENCODING), DECODING is used for reading, and
3744 ENCODING is used for writing.
3746 :nowait BOOL -- If NOWAIT is non-nil for a stream type client
3747 process, return without waiting for the connection to complete;
3748 instead, the sentinel function will be called with second arg matching
3749 "open" (if successful) or "failed" when the connect completes.
3750 Default is to use a blocking connect (i.e. wait) for stream type
3751 connections.
3753 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
3754 running when Emacs is exited.
3756 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
3757 In the stopped state, a server process does not accept new
3758 connections, and a client process does not handle incoming traffic.
3759 The stopped state is cleared by `continue-process' and set by
3760 `stop-process'.
3762 :filter FILTER -- Install FILTER as the process filter.
3764 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
3765 process filter are multibyte, otherwise they are unibyte.
3766 If this keyword is not specified, the strings are multibyte if
3767 the default value of `enable-multibyte-characters' is non-nil.
3769 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
3771 :log LOG -- Install LOG as the server process log function. This
3772 function is called when the server accepts a network connection from a
3773 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
3774 is the server process, CLIENT is the new process for the connection,
3775 and MESSAGE is a string.
3777 :plist PLIST -- Install PLIST as the new process's initial plist.
3779 :tls-parameters LIST -- is a list that should be supplied if you're
3780 opening a TLS connection. The first element is the TLS type (either
3781 `gnutls-x509pki' or `gnutls-anon'), and the remaining elements should
3782 be a keyword list accepted by gnutls-boot (as returned by
3783 `gnutls-boot-parameters').
3785 :server QLEN -- if QLEN is non-nil, create a server process for the
3786 specified FAMILY, SERVICE, and connection type (stream or datagram).
3787 If QLEN is an integer, it is used as the max. length of the server's
3788 pending connection queue (also known as the backlog); the default
3789 queue length is 5. Default is to create a client process.
3791 The following network options can be specified for this connection:
3793 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
3794 :dontroute BOOL -- Only send to directly connected hosts.
3795 :keepalive BOOL -- Send keep-alive messages on network stream.
3796 :linger BOOL or TIMEOUT -- Send queued messages before closing.
3797 :oobinline BOOL -- Place out-of-band data in receive data stream.
3798 :priority INT -- Set protocol defined priority for sent packets.
3799 :reuseaddr BOOL -- Allow reusing a recently used local address
3800 (this is allowed by default for a server process).
3801 :bindtodevice NAME -- bind to interface NAME. Using this may require
3802 special privileges on some systems.
3803 :use-external-socket BOOL -- Use any pre-allocated sockets that have
3804 been passed to Emacs. If Emacs wasn't
3805 passed a socket, this option is silently
3806 ignored.
3809 Consult the relevant system programmer's manual pages for more
3810 information on using these options.
3813 A server process will listen for and accept connections from clients.
3814 When a client connection is accepted, a new network process is created
3815 for the connection with the following parameters:
3817 - The client's process name is constructed by concatenating the server
3818 process's NAME and a client identification string.
3819 - If the FILTER argument is non-nil, the client process will not get a
3820 separate process buffer; otherwise, the client's process buffer is a newly
3821 created buffer named after the server process's BUFFER name or process
3822 NAME concatenated with the client identification string.
3823 - The connection type and the process filter and sentinel parameters are
3824 inherited from the server process's TYPE, FILTER and SENTINEL.
3825 - The client process's contact info is set according to the client's
3826 addressing information (typically an IP address and a port number).
3827 - The client process's plist is initialized from the server's plist.
3829 Notice that the FILTER and SENTINEL args are never used directly by
3830 the server process. Also, the BUFFER argument is not used directly by
3831 the server process, but via the optional :log function, accepted (and
3832 failed) connections may be logged in the server process's buffer.
3834 The original argument list, modified with the actual connection
3835 information, is available via the `process-contact' function.
3837 usage: (make-network-process &rest ARGS) */)
3838 (ptrdiff_t nargs, Lisp_Object *args)
3840 Lisp_Object proc;
3841 Lisp_Object contact;
3842 struct Lisp_Process *p;
3843 const char *portstring UNINIT;
3844 ptrdiff_t portstringlen ATTRIBUTE_UNUSED;
3845 char portbuf[INT_BUFSIZE_BOUND (EMACS_INT)];
3846 #ifdef HAVE_LOCAL_SOCKETS
3847 struct sockaddr_un address_un;
3848 #endif
3849 EMACS_INT port = 0;
3850 Lisp_Object tem;
3851 Lisp_Object name, buffer, host, service, address;
3852 Lisp_Object filter, sentinel, use_external_socket_p;
3853 Lisp_Object addrinfos = Qnil;
3854 int socktype;
3855 int family = -1;
3856 enum { any_protocol = 0 };
3857 #ifdef HAVE_GETADDRINFO_A
3858 struct gaicb *dns_request = NULL;
3859 #endif
3860 ptrdiff_t count = SPECPDL_INDEX ();
3862 if (nargs == 0)
3863 return Qnil;
3865 /* Save arguments for process-contact and clone-process. */
3866 contact = Flist (nargs, args);
3868 #ifdef WINDOWSNT
3869 /* Ensure socket support is loaded if available. */
3870 init_winsock (TRUE);
3871 #endif
3873 /* :type TYPE (nil: stream, datagram */
3874 tem = Fplist_get (contact, QCtype);
3875 if (NILP (tem))
3876 socktype = SOCK_STREAM;
3877 #ifdef DATAGRAM_SOCKETS
3878 else if (EQ (tem, Qdatagram))
3879 socktype = SOCK_DGRAM;
3880 #endif
3881 #ifdef HAVE_SEQPACKET
3882 else if (EQ (tem, Qseqpacket))
3883 socktype = SOCK_SEQPACKET;
3884 #endif
3885 else
3886 error ("Unsupported connection type");
3888 name = Fplist_get (contact, QCname);
3889 buffer = Fplist_get (contact, QCbuffer);
3890 filter = Fplist_get (contact, QCfilter);
3891 sentinel = Fplist_get (contact, QCsentinel);
3892 use_external_socket_p = Fplist_get (contact, QCuse_external_socket);
3894 CHECK_STRING (name);
3896 /* :local ADDRESS or :remote ADDRESS */
3897 tem = Fplist_get (contact, QCserver);
3898 if (NILP (tem))
3899 address = Fplist_get (contact, QCremote);
3900 else
3901 address = Fplist_get (contact, QClocal);
3902 if (!NILP (address))
3904 host = service = Qnil;
3906 if (!get_lisp_to_sockaddr_size (address, &family))
3907 error ("Malformed :address");
3909 addrinfos = list1 (Fcons (make_number (any_protocol), address));
3910 goto open_socket;
3913 /* :family FAMILY -- nil (for Inet), local, or integer. */
3914 tem = Fplist_get (contact, QCfamily);
3915 if (NILP (tem))
3917 #ifdef AF_INET6
3918 family = AF_UNSPEC;
3919 #else
3920 family = AF_INET;
3921 #endif
3923 #ifdef HAVE_LOCAL_SOCKETS
3924 else if (EQ (tem, Qlocal))
3925 family = AF_LOCAL;
3926 #endif
3927 #ifdef AF_INET6
3928 else if (EQ (tem, Qipv6))
3929 family = AF_INET6;
3930 #endif
3931 else if (EQ (tem, Qipv4))
3932 family = AF_INET;
3933 else if (TYPE_RANGED_INTEGERP (int, tem))
3934 family = XINT (tem);
3935 else
3936 error ("Unknown address family");
3938 /* :service SERVICE -- string, integer (port number), or t (random port). */
3939 service = Fplist_get (contact, QCservice);
3941 /* :host HOST -- hostname, ip address, or 'local for localhost. */
3942 host = Fplist_get (contact, QChost);
3943 if (NILP (host))
3945 /* The "connection" function gets it bind info from the address we're
3946 given, so use this dummy address if nothing is specified. */
3947 #ifdef HAVE_LOCAL_SOCKETS
3948 if (family != AF_LOCAL)
3949 #endif
3950 host = build_string ("127.0.0.1");
3952 else
3954 if (EQ (host, Qlocal))
3955 /* Depending on setup, "localhost" may map to different IPv4 and/or
3956 IPv6 addresses, so it's better to be explicit (Bug#6781). */
3957 host = build_string ("127.0.0.1");
3958 CHECK_STRING (host);
3961 #ifdef HAVE_LOCAL_SOCKETS
3962 if (family == AF_LOCAL)
3964 if (!NILP (host))
3966 message (":family local ignores the :host property");
3967 contact = Fplist_put (contact, QChost, Qnil);
3968 host = Qnil;
3970 CHECK_STRING (service);
3971 if (sizeof address_un.sun_path <= SBYTES (service))
3972 error ("Service name too long");
3973 addrinfos = list1 (Fcons (make_number (any_protocol), service));
3974 goto open_socket;
3976 #endif
3978 /* Slow down polling to every ten seconds.
3979 Some kernels have a bug which causes retrying connect to fail
3980 after a connect. Polling can interfere with gethostbyname too. */
3981 #ifdef POLL_FOR_INPUT
3982 if (socktype != SOCK_DGRAM)
3984 record_unwind_protect_void (run_all_atimers);
3985 bind_polling_period (10);
3987 #endif
3989 if (!NILP (host))
3991 /* SERVICE can either be a string or int.
3992 Convert to a C string for later use by getaddrinfo. */
3993 if (EQ (service, Qt))
3995 portstring = "0";
3996 portstringlen = 1;
3998 else if (INTEGERP (service))
4000 portstring = portbuf;
4001 portstringlen = sprintf (portbuf, "%"pI"d", XINT (service));
4003 else
4005 CHECK_STRING (service);
4006 portstring = SSDATA (service);
4007 portstringlen = SBYTES (service);
4011 #ifdef HAVE_GETADDRINFO_A
4012 if (!NILP (host) && !NILP (Fplist_get (contact, QCnowait)))
4014 ptrdiff_t hostlen = SBYTES (host);
4015 struct req
4017 struct gaicb gaicb;
4018 struct addrinfo hints;
4019 char str[FLEXIBLE_ARRAY_MEMBER];
4020 } *req = xmalloc (FLEXSIZEOF (struct req, str,
4021 hostlen + 1 + portstringlen + 1));
4022 dns_request = &req->gaicb;
4023 dns_request->ar_name = req->str;
4024 dns_request->ar_service = req->str + hostlen + 1;
4025 dns_request->ar_request = &req->hints;
4026 dns_request->ar_result = NULL;
4027 memset (&req->hints, 0, sizeof req->hints);
4028 req->hints.ai_family = family;
4029 req->hints.ai_socktype = socktype;
4030 strcpy (req->str, SSDATA (host));
4031 strcpy (req->str + hostlen + 1, portstring);
4033 int ret = getaddrinfo_a (GAI_NOWAIT, &dns_request, 1, NULL);
4034 if (ret)
4035 error ("%s/%s getaddrinfo_a error %d", SSDATA (host), portstring, ret);
4037 goto open_socket;
4039 #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 uintmax_t prev_wait_proc_nbytes_read = wait_proc ? wait_proc->nbytes_read : 0;
5013 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
5014 bool retry_for_async;
5015 #endif
5016 ptrdiff_t count = SPECPDL_INDEX ();
5018 /* Close to the current time if known, an invalid timespec otherwise. */
5019 struct timespec now = invalid_timespec ();
5021 eassert (wait_proc == NULL
5022 || EQ (wait_proc->thread, Qnil)
5023 || XTHREAD (wait_proc->thread) == current_thread);
5025 FD_ZERO (&Available);
5026 FD_ZERO (&Writeok);
5028 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
5029 && !(CONSP (wait_proc->status)
5030 && EQ (XCAR (wait_proc->status), Qexit)))
5031 message1 ("Blocking call to accept-process-output with quit inhibited!!");
5033 record_unwind_protect_int (wait_reading_process_output_unwind,
5034 waiting_for_user_input_p);
5035 waiting_for_user_input_p = read_kbd;
5037 if (TYPE_MAXIMUM (time_t) < time_limit)
5038 time_limit = TYPE_MAXIMUM (time_t);
5040 if (time_limit < 0 || nsecs < 0)
5041 wait = MINIMUM;
5042 else if (time_limit > 0 || nsecs > 0)
5044 wait = TIMEOUT;
5045 now = current_timespec ();
5046 end_time = timespec_add (now, make_timespec (time_limit, nsecs));
5048 else
5049 wait = INFINITY;
5051 while (1)
5053 bool process_skipped = false;
5055 /* If calling from keyboard input, do not quit
5056 since we want to return C-g as an input character.
5057 Otherwise, do pending quit if requested. */
5058 if (read_kbd >= 0)
5059 maybe_quit ();
5060 else if (pending_signals)
5061 process_pending_signals ();
5063 /* Exit now if the cell we're waiting for became non-nil. */
5064 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
5065 break;
5067 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
5069 Lisp_Object process_list_head, aproc;
5070 struct Lisp_Process *p;
5072 retry_for_async = false;
5073 FOR_EACH_PROCESS(process_list_head, aproc)
5075 p = XPROCESS (aproc);
5077 if (! wait_proc || p == wait_proc)
5079 #ifdef HAVE_GETADDRINFO_A
5080 /* Check for pending DNS requests. */
5081 if (p->dns_request)
5083 Lisp_Object addrinfos = check_for_dns (aproc);
5084 if (!NILP (addrinfos) && !EQ (addrinfos, Qt))
5085 connect_network_socket (aproc, addrinfos, Qnil);
5086 else
5087 retry_for_async = true;
5089 #endif
5090 #ifdef HAVE_GNUTLS
5091 /* Continue TLS negotiation. */
5092 if (p->gnutls_initstage == GNUTLS_STAGE_HANDSHAKE_TRIED
5093 && p->is_non_blocking_client)
5095 gnutls_try_handshake (p);
5096 p->gnutls_handshakes_tried++;
5098 if (p->gnutls_initstage == GNUTLS_STAGE_READY)
5100 gnutls_verify_boot (aproc, Qnil);
5101 finish_after_tls_connection (aproc);
5103 else
5105 retry_for_async = true;
5106 if (p->gnutls_handshakes_tried
5107 > GNUTLS_EMACS_HANDSHAKES_LIMIT)
5109 deactivate_process (aproc);
5110 pset_status (p, list2 (Qfailed,
5111 build_string ("TLS negotiation failed")));
5115 #endif
5119 #endif /* GETADDRINFO_A or GNUTLS */
5121 /* Compute time from now till when time limit is up. */
5122 /* Exit if already run out. */
5123 if (wait == TIMEOUT)
5125 if (!timespec_valid_p (now))
5126 now = current_timespec ();
5127 if (timespec_cmp (end_time, now) <= 0)
5128 break;
5129 timeout = timespec_sub (end_time, now);
5131 else
5132 timeout = make_timespec (wait < TIMEOUT ? 0 : 100000, 0);
5134 /* Normally we run timers here.
5135 But not if wait_for_cell; in those cases,
5136 the wait is supposed to be short,
5137 and those callers cannot handle running arbitrary Lisp code here. */
5138 if (NILP (wait_for_cell)
5139 && just_wait_proc >= 0)
5143 unsigned old_timers_run = timers_run;
5144 struct buffer *old_buffer = current_buffer;
5145 Lisp_Object old_window = selected_window;
5147 timer_delay = timer_check ();
5149 /* If a timer has run, this might have changed buffers
5150 an alike. Make read_key_sequence aware of that. */
5151 if (timers_run != old_timers_run
5152 && (old_buffer != current_buffer
5153 || !EQ (old_window, selected_window))
5154 && waiting_for_user_input_p == -1)
5155 record_asynch_buffer_change ();
5157 if (timers_run != old_timers_run && do_display)
5158 /* We must retry, since a timer may have requeued itself
5159 and that could alter the time_delay. */
5160 redisplay_preserve_echo_area (9);
5161 else
5162 break;
5164 while (!detect_input_pending ());
5166 /* If there is unread keyboard input, also return. */
5167 if (read_kbd != 0
5168 && requeued_events_pending_p ())
5169 break;
5171 /* This is so a breakpoint can be put here. */
5172 if (!timespec_valid_p (timer_delay))
5173 wait_reading_process_output_1 ();
5176 /* Cause C-g and alarm signals to take immediate action,
5177 and cause input available signals to zero out timeout.
5179 It is important that we do this before checking for process
5180 activity. If we get a SIGCHLD after the explicit checks for
5181 process activity, timeout is the only way we will know. */
5182 if (read_kbd < 0)
5183 set_waiting_for_input (&timeout);
5185 /* If status of something has changed, and no input is
5186 available, notify the user of the change right away. After
5187 this explicit check, we'll let the SIGCHLD handler zap
5188 timeout to get our attention. */
5189 if (update_tick != process_tick)
5191 fd_set Atemp;
5192 fd_set Ctemp;
5194 if (kbd_on_hold_p ())
5195 FD_ZERO (&Atemp);
5196 else
5197 compute_input_wait_mask (&Atemp);
5198 compute_write_mask (&Ctemp);
5200 timeout = make_timespec (0, 0);
5201 if ((thread_select (pselect, max_desc + 1,
5202 &Atemp,
5203 (num_pending_connects > 0 ? &Ctemp : NULL),
5204 NULL, &timeout, NULL)
5205 <= 0))
5207 /* It's okay for us to do this and then continue with
5208 the loop, since timeout has already been zeroed out. */
5209 clear_waiting_for_input ();
5210 got_some_output = status_notify (NULL, wait_proc);
5211 if (do_display) redisplay_preserve_echo_area (13);
5215 /* Don't wait for output from a non-running process. Just
5216 read whatever data has already been received. */
5217 if (wait_proc && wait_proc->raw_status_new)
5218 update_status (wait_proc);
5219 if (wait_proc
5220 && ! EQ (wait_proc->status, Qrun)
5221 && ! connecting_status (wait_proc->status))
5223 bool read_some_bytes = false;
5225 clear_waiting_for_input ();
5227 /* If data can be read from the process, do so until exhausted. */
5228 if (wait_proc->infd >= 0)
5230 XSETPROCESS (proc, wait_proc);
5232 while (true)
5234 int nread = read_process_output (proc, wait_proc->infd);
5235 if (nread < 0)
5237 if (errno == EIO || would_block (errno))
5238 break;
5240 else
5242 if (got_some_output < nread)
5243 got_some_output = nread;
5244 if (nread == 0)
5245 break;
5246 read_some_bytes = true;
5251 if (read_some_bytes && do_display)
5252 redisplay_preserve_echo_area (10);
5254 break;
5257 /* Wait till there is something to do. */
5259 if (wait_proc && just_wait_proc)
5261 if (wait_proc->infd < 0) /* Terminated. */
5262 break;
5263 FD_SET (wait_proc->infd, &Available);
5264 check_delay = 0;
5265 check_write = 0;
5267 else if (!NILP (wait_for_cell))
5269 compute_non_process_wait_mask (&Available);
5270 check_delay = 0;
5271 check_write = 0;
5273 else
5275 if (! read_kbd)
5276 compute_non_keyboard_wait_mask (&Available);
5277 else
5278 compute_input_wait_mask (&Available);
5279 compute_write_mask (&Writeok);
5280 check_delay = wait_proc ? 0 : process_output_delay_count;
5281 check_write = true;
5284 /* If frame size has changed or the window is newly mapped,
5285 redisplay now, before we start to wait. There is a race
5286 condition here; if a SIGIO arrives between now and the select
5287 and indicates that a frame is trashed, the select may block
5288 displaying a trashed screen. */
5289 if (frame_garbaged && do_display)
5291 clear_waiting_for_input ();
5292 redisplay_preserve_echo_area (11);
5293 if (read_kbd < 0)
5294 set_waiting_for_input (&timeout);
5297 /* Skip the `select' call if input is available and we're
5298 waiting for keyboard input or a cell change (which can be
5299 triggered by processing X events). In the latter case, set
5300 nfds to 1 to avoid breaking the loop. */
5301 no_avail = 0;
5302 if ((read_kbd || !NILP (wait_for_cell))
5303 && detect_input_pending ())
5305 nfds = read_kbd ? 0 : 1;
5306 no_avail = 1;
5307 FD_ZERO (&Available);
5309 else
5311 /* Set the timeout for adaptive read buffering if any
5312 process has non-zero read_output_skip and non-zero
5313 read_output_delay, and we are not reading output for a
5314 specific process. It is not executed if
5315 Vprocess_adaptive_read_buffering is nil. */
5316 if (process_output_skip && check_delay > 0)
5318 int adaptive_nsecs = timeout.tv_nsec;
5319 if (timeout.tv_sec > 0 || adaptive_nsecs > READ_OUTPUT_DELAY_MAX)
5320 adaptive_nsecs = READ_OUTPUT_DELAY_MAX;
5321 for (channel = 0; check_delay > 0 && channel <= max_desc; channel++)
5323 proc = chan_process[channel];
5324 if (NILP (proc))
5325 continue;
5326 /* Find minimum non-zero read_output_delay among the
5327 processes with non-zero read_output_skip. */
5328 if (XPROCESS (proc)->read_output_delay > 0)
5330 check_delay--;
5331 if (!XPROCESS (proc)->read_output_skip)
5332 continue;
5333 FD_CLR (channel, &Available);
5334 process_skipped = true;
5335 XPROCESS (proc)->read_output_skip = 0;
5336 if (XPROCESS (proc)->read_output_delay < adaptive_nsecs)
5337 adaptive_nsecs = XPROCESS (proc)->read_output_delay;
5340 timeout = make_timespec (0, adaptive_nsecs);
5341 process_output_skip = 0;
5344 /* If we've got some output and haven't limited our timeout
5345 with adaptive read buffering, limit it. */
5346 if (got_some_output > 0 && !process_skipped
5347 && (timeout.tv_sec
5348 || timeout.tv_nsec > READ_OUTPUT_DELAY_INCREMENT))
5349 timeout = make_timespec (0, READ_OUTPUT_DELAY_INCREMENT);
5352 if (NILP (wait_for_cell) && just_wait_proc >= 0
5353 && timespec_valid_p (timer_delay)
5354 && timespec_cmp (timer_delay, timeout) < 0)
5356 if (!timespec_valid_p (now))
5357 now = current_timespec ();
5358 struct timespec timeout_abs = timespec_add (now, timeout);
5359 if (!timespec_valid_p (got_output_end_time)
5360 || timespec_cmp (timeout_abs, got_output_end_time) < 0)
5361 got_output_end_time = timeout_abs;
5362 timeout = timer_delay;
5364 else
5365 got_output_end_time = invalid_timespec ();
5367 /* NOW can become inaccurate if time can pass during pselect. */
5368 if (timeout.tv_sec > 0 || timeout.tv_nsec > 0)
5369 now = invalid_timespec ();
5371 #if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
5372 if (retry_for_async
5373 && (timeout.tv_sec > 0 || timeout.tv_nsec > ASYNC_RETRY_NSEC))
5375 timeout.tv_sec = 0;
5376 timeout.tv_nsec = ASYNC_RETRY_NSEC;
5378 #endif
5380 /* Non-macOS HAVE_GLIB builds call thread_select in xgselect.c. */
5381 #if defined HAVE_GLIB && !defined HAVE_NS
5382 nfds = xg_select (max_desc + 1,
5383 &Available, (check_write ? &Writeok : 0),
5384 NULL, &timeout, NULL);
5385 #elif defined HAVE_NS
5386 /* And NS builds call thread_select in ns_select. */
5387 nfds = ns_select (max_desc + 1,
5388 &Available, (check_write ? &Writeok : 0),
5389 NULL, &timeout, NULL);
5390 #else /* !HAVE_GLIB */
5391 nfds = thread_select (pselect, max_desc + 1,
5392 &Available,
5393 (check_write ? &Writeok : 0),
5394 NULL, &timeout, NULL);
5395 #endif /* !HAVE_GLIB */
5397 #ifdef HAVE_GNUTLS
5398 /* GnuTLS buffers data internally. In lowat mode it leaves
5399 some data in the TCP buffers so that select works, but
5400 with custom pull/push functions we need to check if some
5401 data is available in the buffers manually. */
5402 if (nfds == 0)
5404 fd_set tls_available;
5405 int set = 0;
5407 FD_ZERO (&tls_available);
5408 if (! wait_proc)
5410 /* We're not waiting on a specific process, so loop
5411 through all the channels and check for data.
5412 This is a workaround needed for some versions of
5413 the gnutls library -- 2.12.14 has been confirmed
5414 to need it. See
5415 http://comments.gmane.org/gmane.emacs.devel/145074 */
5416 for (channel = 0; channel < FD_SETSIZE; ++channel)
5417 if (! NILP (chan_process[channel]))
5419 struct Lisp_Process *p =
5420 XPROCESS (chan_process[channel]);
5421 if (p && p->gnutls_p && p->gnutls_state
5422 && ((emacs_gnutls_record_check_pending
5423 (p->gnutls_state))
5424 > 0))
5426 nfds++;
5427 eassert (p->infd == channel);
5428 FD_SET (p->infd, &tls_available);
5429 set++;
5433 else
5435 /* Check this specific channel. */
5436 if (wait_proc->gnutls_p /* Check for valid process. */
5437 && wait_proc->gnutls_state
5438 /* Do we have pending data? */
5439 && ((emacs_gnutls_record_check_pending
5440 (wait_proc->gnutls_state))
5441 > 0))
5443 nfds = 1;
5444 eassert (0 <= wait_proc->infd);
5445 /* Set to Available. */
5446 FD_SET (wait_proc->infd, &tls_available);
5447 set++;
5450 if (set)
5451 Available = tls_available;
5453 #endif
5456 xerrno = errno;
5458 /* Make C-g and alarm signals set flags again. */
5459 clear_waiting_for_input ();
5461 /* If we woke up due to SIGWINCH, actually change size now. */
5462 do_pending_window_change (0);
5464 if (nfds == 0)
5466 /* Exit the main loop if we've passed the requested timeout,
5467 or have read some bytes from our wait_proc (either directly
5468 in this call or indirectly through timers / process filters),
5469 or aren't skipping processes and got some output and
5470 haven't lowered our timeout due to timers or SIGIO and
5471 have waited a long amount of time due to repeated
5472 timers. */
5473 struct timespec huge_timespec
5474 = make_timespec (TYPE_MAXIMUM (time_t), 2 * TIMESPEC_RESOLUTION);
5475 struct timespec cmp_time = huge_timespec;
5476 if (wait < TIMEOUT
5477 || (wait_proc
5478 && wait_proc->nbytes_read != prev_wait_proc_nbytes_read))
5479 break;
5480 if (wait == TIMEOUT)
5481 cmp_time = end_time;
5482 if (!process_skipped && got_some_output > 0
5483 && (timeout.tv_sec > 0 || timeout.tv_nsec > 0))
5485 if (!timespec_valid_p (got_output_end_time))
5486 break;
5487 if (timespec_cmp (got_output_end_time, cmp_time) < 0)
5488 cmp_time = got_output_end_time;
5490 if (timespec_cmp (cmp_time, huge_timespec) < 0)
5492 now = current_timespec ();
5493 if (timespec_cmp (cmp_time, now) <= 0)
5494 break;
5498 if (nfds < 0)
5500 if (xerrno == EINTR)
5501 no_avail = 1;
5502 else if (xerrno == EBADF)
5503 emacs_abort ();
5504 else
5505 report_file_errno ("Failed select", Qnil, xerrno);
5508 /* Check for keyboard input. */
5509 /* If there is any, return immediately
5510 to give it higher priority than subprocesses. */
5512 if (read_kbd != 0)
5514 unsigned old_timers_run = timers_run;
5515 struct buffer *old_buffer = current_buffer;
5516 Lisp_Object old_window = selected_window;
5517 bool leave = false;
5519 if (detect_input_pending_run_timers (do_display))
5521 swallow_events (do_display);
5522 if (detect_input_pending_run_timers (do_display))
5523 leave = true;
5526 /* If a timer has run, this might have changed buffers
5527 an alike. Make read_key_sequence aware of that. */
5528 if (timers_run != old_timers_run
5529 && waiting_for_user_input_p == -1
5530 && (old_buffer != current_buffer
5531 || !EQ (old_window, selected_window)))
5532 record_asynch_buffer_change ();
5534 if (leave)
5535 break;
5538 /* If there is unread keyboard input, also return. */
5539 if (read_kbd != 0
5540 && requeued_events_pending_p ())
5541 break;
5543 /* If we are not checking for keyboard input now,
5544 do process events (but don't run any timers).
5545 This is so that X events will be processed.
5546 Otherwise they may have to wait until polling takes place.
5547 That would causes delays in pasting selections, for example.
5549 (We used to do this only if wait_for_cell.) */
5550 if (read_kbd == 0 && detect_input_pending ())
5552 swallow_events (do_display);
5553 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
5554 if (detect_input_pending ())
5555 break;
5556 #endif
5559 /* Exit now if the cell we're waiting for became non-nil. */
5560 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
5561 break;
5563 #ifdef USABLE_SIGIO
5564 /* If we think we have keyboard input waiting, but didn't get SIGIO,
5565 go read it. This can happen with X on BSD after logging out.
5566 In that case, there really is no input and no SIGIO,
5567 but select says there is input. */
5569 if (read_kbd && interrupt_input
5570 && keyboard_bit_set (&Available) && ! noninteractive)
5571 handle_input_available_signal (SIGIO);
5572 #endif
5574 /* If checking input just got us a size-change event from X,
5575 obey it now if we should. */
5576 if (read_kbd || ! NILP (wait_for_cell))
5577 do_pending_window_change (0);
5579 /* Check for data from a process. */
5580 if (no_avail || nfds == 0)
5581 continue;
5583 for (channel = 0; channel <= max_desc; ++channel)
5585 struct fd_callback_data *d = &fd_callback_info[channel];
5586 if (d->func
5587 && ((d->flags & FOR_READ
5588 && FD_ISSET (channel, &Available))
5589 || ((d->flags & FOR_WRITE)
5590 && FD_ISSET (channel, &Writeok))))
5591 d->func (channel, d->data);
5594 for (channel = 0; channel <= max_desc; channel++)
5596 if (FD_ISSET (channel, &Available)
5597 && ((fd_callback_info[channel].flags & (KEYBOARD_FD | PROCESS_FD))
5598 == PROCESS_FD))
5600 int nread;
5602 /* If waiting for this channel, arrange to return as
5603 soon as no more input to be processed. No more
5604 waiting. */
5605 proc = chan_process[channel];
5606 if (NILP (proc))
5607 continue;
5609 /* If this is a server stream socket, accept connection. */
5610 if (EQ (XPROCESS (proc)->status, Qlisten))
5612 server_accept_connection (proc, channel);
5613 continue;
5616 /* Read data from the process, starting with our
5617 buffered-ahead character if we have one. */
5619 nread = read_process_output (proc, channel);
5620 if ((!wait_proc || wait_proc == XPROCESS (proc))
5621 && got_some_output < nread)
5622 got_some_output = nread;
5623 if (nread > 0)
5625 /* Vacuum up any leftovers without waiting. */
5626 if (wait_proc == XPROCESS (proc))
5627 wait = MINIMUM;
5628 /* Since read_process_output can run a filter,
5629 which can call accept-process-output,
5630 don't try to read from any other processes
5631 before doing the select again. */
5632 FD_ZERO (&Available);
5634 if (do_display)
5635 redisplay_preserve_echo_area (12);
5637 else if (nread == -1 && would_block (errno))
5639 #ifdef WINDOWSNT
5640 /* FIXME: Is this special case still needed? */
5641 /* Note that we cannot distinguish between no input
5642 available now and a closed pipe.
5643 With luck, a closed pipe will be accompanied by
5644 subprocess termination and SIGCHLD. */
5645 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc)
5646 && !PIPECONN_P (proc))
5648 #endif
5649 #ifdef HAVE_PTYS
5650 /* On some OSs with ptys, when the process on one end of
5651 a pty exits, the other end gets an error reading with
5652 errno = EIO instead of getting an EOF (0 bytes read).
5653 Therefore, if we get an error reading and errno =
5654 EIO, just continue, because the child process has
5655 exited and should clean itself up soon (e.g. when we
5656 get a SIGCHLD). */
5657 else if (nread == -1 && errno == EIO)
5659 struct Lisp_Process *p = XPROCESS (proc);
5661 /* Clear the descriptor now, so we only raise the
5662 signal once. */
5663 delete_read_fd (channel);
5665 if (p->pid == -2)
5667 /* If the EIO occurs on a pty, the SIGCHLD handler's
5668 waitpid call will not find the process object to
5669 delete. Do it here. */
5670 p->tick = ++process_tick;
5671 pset_status (p, Qfailed);
5674 #endif /* HAVE_PTYS */
5675 /* If we can detect process termination, don't consider the
5676 process gone just because its pipe is closed. */
5677 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc)
5678 && !PIPECONN_P (proc))
5680 else if (nread == 0 && PIPECONN_P (proc))
5682 /* Preserve status of processes already terminated. */
5683 XPROCESS (proc)->tick = ++process_tick;
5684 deactivate_process (proc);
5685 if (EQ (XPROCESS (proc)->status, Qrun))
5686 pset_status (XPROCESS (proc),
5687 list2 (Qexit, make_number (0)));
5689 else
5691 /* Preserve status of processes already terminated. */
5692 XPROCESS (proc)->tick = ++process_tick;
5693 deactivate_process (proc);
5694 if (XPROCESS (proc)->raw_status_new)
5695 update_status (XPROCESS (proc));
5696 if (EQ (XPROCESS (proc)->status, Qrun))
5697 pset_status (XPROCESS (proc),
5698 list2 (Qexit, make_number (256)));
5701 if (FD_ISSET (channel, &Writeok)
5702 && (fd_callback_info[channel].flags
5703 & NON_BLOCKING_CONNECT_FD) != 0)
5705 struct Lisp_Process *p;
5707 delete_write_fd (channel);
5709 proc = chan_process[channel];
5710 if (NILP (proc))
5711 continue;
5713 p = XPROCESS (proc);
5715 #ifndef WINDOWSNT
5717 socklen_t xlen = sizeof (xerrno);
5718 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
5719 xerrno = errno;
5721 #else
5722 /* On MS-Windows, getsockopt clears the error for the
5723 entire process, which may not be the right thing; see
5724 w32.c. Use getpeername instead. */
5726 struct sockaddr pname;
5727 socklen_t pnamelen = sizeof (pname);
5729 /* If connection failed, getpeername will fail. */
5730 xerrno = 0;
5731 if (getpeername (channel, &pname, &pnamelen) < 0)
5733 /* Obtain connect failure code through error slippage. */
5734 char dummy;
5735 xerrno = errno;
5736 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
5737 xerrno = errno;
5740 #endif
5741 if (xerrno)
5743 Lisp_Object addrinfos
5744 = connecting_status (p->status) ? XCDR (p->status) : Qnil;
5745 if (!NILP (addrinfos))
5746 XSETCDR (p->status, XCDR (addrinfos));
5747 else
5749 p->tick = ++process_tick;
5750 pset_status (p, list2 (Qfailed, make_number (xerrno)));
5752 deactivate_process (proc);
5753 if (!NILP (addrinfos))
5754 connect_network_socket (proc, addrinfos, Qnil);
5756 else
5758 #ifdef HAVE_GNUTLS
5759 /* If we have an incompletely set up TLS connection,
5760 then defer the sentinel signaling until
5761 later. */
5762 if (NILP (p->gnutls_boot_parameters)
5763 && !p->gnutls_p)
5764 #endif
5766 pset_status (p, Qrun);
5767 /* Execute the sentinel here. If we had relied on
5768 status_notify to do it later, it will read input
5769 from the process before calling the sentinel. */
5770 exec_sentinel (proc, build_string ("open\n"));
5773 if (0 <= p->infd && !EQ (p->filter, Qt)
5774 && !EQ (p->command, Qt))
5775 add_process_read_fd (p->infd);
5778 } /* End for each file descriptor. */
5779 } /* End while exit conditions not met. */
5781 unbind_to (count, Qnil);
5783 /* If calling from keyboard input, do not quit
5784 since we want to return C-g as an input character.
5785 Otherwise, do pending quit if requested. */
5786 if (read_kbd >= 0)
5788 /* Prevent input_pending from remaining set if we quit. */
5789 clear_input_pending ();
5790 maybe_quit ();
5793 /* Timers and/or process filters that we have run could have themselves called
5794 `accept-process-output' (and by that indirectly this function), thus
5795 possibly reading some (or all) output of wait_proc without us noticing it.
5796 This could potentially lead to an endless wait (dealt with earlier in the
5797 function) and/or a wrong return value (dealt with here). */
5798 if (wait_proc && wait_proc->nbytes_read != prev_wait_proc_nbytes_read)
5799 got_some_output = min (INT_MAX, (wait_proc->nbytes_read
5800 - prev_wait_proc_nbytes_read));
5802 return got_some_output;
5805 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
5807 static Lisp_Object
5808 read_process_output_call (Lisp_Object fun_and_args)
5810 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
5813 static Lisp_Object
5814 read_process_output_error_handler (Lisp_Object error_val)
5816 cmd_error_internal (error_val, "error in process filter: ");
5817 Vinhibit_quit = Qt;
5818 update_echo_area ();
5819 Fsleep_for (make_number (2), Qnil);
5820 return Qt;
5823 static void
5824 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5825 ssize_t nbytes,
5826 struct coding_system *coding);
5828 /* Read pending output from the process channel,
5829 starting with our buffered-ahead character if we have one.
5830 Yield number of decoded characters read.
5832 This function reads at most 4096 characters.
5833 If you want to read all available subprocess output,
5834 you must call it repeatedly until it returns zero.
5836 The characters read are decoded according to PROC's coding-system
5837 for decoding. */
5839 static int
5840 read_process_output (Lisp_Object proc, int channel)
5842 ssize_t nbytes;
5843 struct Lisp_Process *p = XPROCESS (proc);
5844 struct coding_system *coding = proc_decode_coding_system[channel];
5845 int carryover = p->decoding_carryover;
5846 enum { readmax = 4096 };
5847 ptrdiff_t count = SPECPDL_INDEX ();
5848 Lisp_Object odeactivate;
5849 char chars[sizeof coding->carryover + readmax];
5851 if (carryover)
5852 /* See the comment above. */
5853 memcpy (chars, SDATA (p->decoding_buf), carryover);
5855 #ifdef DATAGRAM_SOCKETS
5856 /* We have a working select, so proc_buffered_char is always -1. */
5857 if (DATAGRAM_CHAN_P (channel))
5859 socklen_t len = datagram_address[channel].len;
5860 nbytes = recvfrom (channel, chars + carryover, readmax,
5861 0, datagram_address[channel].sa, &len);
5863 else
5864 #endif
5866 bool buffered = proc_buffered_char[channel] >= 0;
5867 if (buffered)
5869 chars[carryover] = proc_buffered_char[channel];
5870 proc_buffered_char[channel] = -1;
5872 #ifdef HAVE_GNUTLS
5873 if (p->gnutls_p && p->gnutls_state)
5874 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
5875 readmax - buffered);
5876 else
5877 #endif
5878 nbytes = emacs_read (channel, chars + carryover + buffered,
5879 readmax - buffered);
5880 if (nbytes > 0 && p->adaptive_read_buffering)
5882 int delay = p->read_output_delay;
5883 if (nbytes < 256)
5885 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5887 if (delay == 0)
5888 process_output_delay_count++;
5889 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5892 else if (delay > 0 && nbytes == readmax - buffered)
5894 delay -= READ_OUTPUT_DELAY_INCREMENT;
5895 if (delay == 0)
5896 process_output_delay_count--;
5898 p->read_output_delay = delay;
5899 if (delay)
5901 p->read_output_skip = 1;
5902 process_output_skip = 1;
5905 nbytes += buffered;
5906 nbytes += buffered && nbytes <= 0;
5909 p->decoding_carryover = 0;
5911 /* At this point, NBYTES holds number of bytes just received
5912 (including the one in proc_buffered_char[channel]). */
5913 if (nbytes <= 0)
5915 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5916 return nbytes;
5917 coding->mode |= CODING_MODE_LAST_BLOCK;
5920 /* Ignore carryover, it's been added by a previous iteration already. */
5921 p->nbytes_read += nbytes;
5923 /* Now set NBYTES how many bytes we must decode. */
5924 nbytes += carryover;
5926 odeactivate = Vdeactivate_mark;
5927 /* There's no good reason to let process filters change the current
5928 buffer, and many callers of accept-process-output, sit-for, and
5929 friends don't expect current-buffer to be changed from under them. */
5930 record_unwind_current_buffer ();
5932 read_and_dispose_of_process_output (p, chars, nbytes, coding);
5934 /* Handling the process output should not deactivate the mark. */
5935 Vdeactivate_mark = odeactivate;
5937 unbind_to (count, Qnil);
5938 return nbytes;
5941 static void
5942 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5943 ssize_t nbytes,
5944 struct coding_system *coding)
5946 Lisp_Object outstream = p->filter;
5947 Lisp_Object text;
5948 bool outer_running_asynch_code = running_asynch_code;
5949 int waiting = waiting_for_user_input_p;
5951 #if 0
5952 Lisp_Object obuffer, okeymap;
5953 XSETBUFFER (obuffer, current_buffer);
5954 okeymap = BVAR (current_buffer, keymap);
5955 #endif
5957 /* We inhibit quit here instead of just catching it so that
5958 hitting ^G when a filter happens to be running won't screw
5959 it up. */
5960 specbind (Qinhibit_quit, Qt);
5961 specbind (Qlast_nonmenu_event, Qt);
5963 /* In case we get recursively called,
5964 and we already saved the match data nonrecursively,
5965 save the same match data in safely recursive fashion. */
5966 if (outer_running_asynch_code)
5968 Lisp_Object tem;
5969 /* Don't clobber the CURRENT match data, either! */
5970 tem = Fmatch_data (Qnil, Qnil, Qnil);
5971 restore_search_regs ();
5972 record_unwind_save_match_data ();
5973 Fset_match_data (tem, Qt);
5976 /* For speed, if a search happens within this code,
5977 save the match data in a special nonrecursive fashion. */
5978 running_asynch_code = 1;
5980 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5981 text = coding->dst_object;
5982 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5983 /* A new coding system might be found. */
5984 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5986 pset_decode_coding_system (p, Vlast_coding_system_used);
5988 /* Don't call setup_coding_system for
5989 proc_decode_coding_system[channel] here. It is done in
5990 detect_coding called via decode_coding above. */
5992 /* If a coding system for encoding is not yet decided, we set
5993 it as the same as coding-system for decoding.
5995 But, before doing that we must check if
5996 proc_encode_coding_system[p->outfd] surely points to a
5997 valid memory because p->outfd will be changed once EOF is
5998 sent to the process. */
5999 if (NILP (p->encode_coding_system) && p->outfd >= 0
6000 && proc_encode_coding_system[p->outfd])
6002 pset_encode_coding_system
6003 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
6004 setup_coding_system (p->encode_coding_system,
6005 proc_encode_coding_system[p->outfd]);
6009 if (coding->carryover_bytes > 0)
6011 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
6012 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
6013 memcpy (SDATA (p->decoding_buf), coding->carryover,
6014 coding->carryover_bytes);
6015 p->decoding_carryover = coding->carryover_bytes;
6017 if (SBYTES (text) > 0)
6018 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
6019 sometimes it's simply wrong to wrap (e.g. when called from
6020 accept-process-output). */
6021 internal_condition_case_1 (read_process_output_call,
6022 list3 (outstream, make_lisp_proc (p), text),
6023 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6024 read_process_output_error_handler);
6026 /* If we saved the match data nonrecursively, restore it now. */
6027 restore_search_regs ();
6028 running_asynch_code = outer_running_asynch_code;
6030 /* Restore waiting_for_user_input_p as it was
6031 when we were called, in case the filter clobbered it. */
6032 waiting_for_user_input_p = waiting;
6034 #if 0 /* Call record_asynch_buffer_change unconditionally,
6035 because we might have changed minor modes or other things
6036 that affect key bindings. */
6037 if (! EQ (Fcurrent_buffer (), obuffer)
6038 || ! EQ (current_buffer->keymap, okeymap))
6039 #endif
6040 /* But do it only if the caller is actually going to read events.
6041 Otherwise there's no need to make him wake up, and it could
6042 cause trouble (for example it would make sit_for return). */
6043 if (waiting_for_user_input_p == -1)
6044 record_asynch_buffer_change ();
6047 DEFUN ("internal-default-process-filter", Finternal_default_process_filter,
6048 Sinternal_default_process_filter, 2, 2, 0,
6049 doc: /* Function used as default process filter.
6050 This inserts the process's output into its buffer, if there is one.
6051 Otherwise it discards the output. */)
6052 (Lisp_Object proc, Lisp_Object text)
6054 struct Lisp_Process *p;
6055 ptrdiff_t opoint;
6057 CHECK_PROCESS (proc);
6058 p = XPROCESS (proc);
6059 CHECK_STRING (text);
6061 if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
6063 Lisp_Object old_read_only;
6064 ptrdiff_t old_begv, old_zv;
6065 ptrdiff_t old_begv_byte, old_zv_byte;
6066 ptrdiff_t before, before_byte;
6067 ptrdiff_t opoint_byte;
6068 struct buffer *b;
6070 Fset_buffer (p->buffer);
6071 opoint = PT;
6072 opoint_byte = PT_BYTE;
6073 old_read_only = BVAR (current_buffer, read_only);
6074 old_begv = BEGV;
6075 old_zv = ZV;
6076 old_begv_byte = BEGV_BYTE;
6077 old_zv_byte = ZV_BYTE;
6079 bset_read_only (current_buffer, Qnil);
6081 /* Insert new output into buffer at the current end-of-output
6082 marker, thus preserving logical ordering of input and output. */
6083 if (XMARKER (p->mark)->buffer)
6084 set_point_from_marker (p->mark);
6085 else
6086 SET_PT_BOTH (ZV, ZV_BYTE);
6087 before = PT;
6088 before_byte = PT_BYTE;
6090 /* If the output marker is outside of the visible region, save
6091 the restriction and widen. */
6092 if (! (BEGV <= PT && PT <= ZV))
6093 Fwiden ();
6095 /* Adjust the multibyteness of TEXT to that of the buffer. */
6096 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
6097 != ! STRING_MULTIBYTE (text))
6098 text = (STRING_MULTIBYTE (text)
6099 ? Fstring_as_unibyte (text)
6100 : Fstring_to_multibyte (text));
6101 /* Insert before markers in case we are inserting where
6102 the buffer's mark is, and the user's next command is Meta-y. */
6103 insert_from_string_before_markers (text, 0, 0,
6104 SCHARS (text), SBYTES (text), 0);
6106 /* Make sure the process marker's position is valid when the
6107 process buffer is changed in the signal_after_change above.
6108 W3 is known to do that. */
6109 if (BUFFERP (p->buffer)
6110 && (b = XBUFFER (p->buffer), b != current_buffer))
6111 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
6112 else
6113 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6115 update_mode_lines = 23;
6117 /* Make sure opoint and the old restrictions
6118 float ahead of any new text just as point would. */
6119 if (opoint >= before)
6121 opoint += PT - before;
6122 opoint_byte += PT_BYTE - before_byte;
6124 if (old_begv > before)
6126 old_begv += PT - before;
6127 old_begv_byte += PT_BYTE - before_byte;
6129 if (old_zv >= before)
6131 old_zv += PT - before;
6132 old_zv_byte += PT_BYTE - before_byte;
6135 /* If the restriction isn't what it should be, set it. */
6136 if (old_begv != BEGV || old_zv != ZV)
6137 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
6139 bset_read_only (current_buffer, old_read_only);
6140 SET_PT_BOTH (opoint, opoint_byte);
6142 return Qnil;
6145 /* Sending data to subprocess. */
6147 /* In send_process, when a write fails temporarily,
6148 wait_reading_process_output is called. It may execute user code,
6149 e.g. timers, that attempts to write new data to the same process.
6150 We must ensure that data is sent in the right order, and not
6151 interspersed half-completed with other writes (Bug#10815). This is
6152 handled by the write_queue element of struct process. It is a list
6153 with each entry having the form
6155 (string . (offset . length))
6157 where STRING is a lisp string, OFFSET is the offset into the
6158 string's byte sequence from which we should begin to send, and
6159 LENGTH is the number of bytes left to send. */
6161 /* Create a new entry in write_queue.
6162 INPUT_OBJ should be a buffer, string Qt, or Qnil.
6163 BUF is a pointer to the string sequence of the input_obj or a C
6164 string in case of Qt or Qnil. */
6166 static void
6167 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
6168 const char *buf, ptrdiff_t len, bool front)
6170 ptrdiff_t offset;
6171 Lisp_Object entry, obj;
6173 if (STRINGP (input_obj))
6175 offset = buf - SSDATA (input_obj);
6176 obj = input_obj;
6178 else
6180 offset = 0;
6181 obj = make_unibyte_string (buf, len);
6184 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
6186 if (front)
6187 pset_write_queue (p, Fcons (entry, p->write_queue));
6188 else
6189 pset_write_queue (p, nconc2 (p->write_queue, list1 (entry)));
6192 /* Remove the first element in the write_queue of process P, put its
6193 contents in OBJ, BUF and LEN, and return true. If the
6194 write_queue is empty, return false. */
6196 static bool
6197 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
6198 const char **buf, ptrdiff_t *len)
6200 Lisp_Object entry, offset_length;
6201 ptrdiff_t offset;
6203 if (NILP (p->write_queue))
6204 return 0;
6206 entry = XCAR (p->write_queue);
6207 pset_write_queue (p, XCDR (p->write_queue));
6209 *obj = XCAR (entry);
6210 offset_length = XCDR (entry);
6212 *len = XINT (XCDR (offset_length));
6213 offset = XINT (XCAR (offset_length));
6214 *buf = SSDATA (*obj) + offset;
6216 return 1;
6219 /* Send some data to process PROC.
6220 BUF is the beginning of the data; LEN is the number of characters.
6221 OBJECT is the Lisp object that the data comes from. If OBJECT is
6222 nil or t, it means that the data comes from C string.
6224 If OBJECT is not nil, the data is encoded by PROC's coding-system
6225 for encoding before it is sent.
6227 This function can evaluate Lisp code and can garbage collect. */
6229 static void
6230 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
6231 Lisp_Object object)
6233 struct Lisp_Process *p = XPROCESS (proc);
6234 ssize_t rv;
6235 struct coding_system *coding;
6237 if (NETCONN_P (proc))
6239 wait_while_connecting (proc);
6240 wait_for_tls_negotiation (proc);
6243 if (p->raw_status_new)
6244 update_status (p);
6245 if (! EQ (p->status, Qrun))
6246 error ("Process %s not running", SDATA (p->name));
6247 if (p->outfd < 0)
6248 error ("Output file descriptor of %s is closed", SDATA (p->name));
6250 coding = proc_encode_coding_system[p->outfd];
6251 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
6253 if ((STRINGP (object) && STRING_MULTIBYTE (object))
6254 || (BUFFERP (object)
6255 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
6256 || EQ (object, Qt))
6258 pset_encode_coding_system
6259 (p, complement_process_encoding_system (p->encode_coding_system));
6260 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
6262 /* The coding system for encoding was changed to raw-text
6263 because we sent a unibyte text previously. Now we are
6264 sending a multibyte text, thus we must encode it by the
6265 original coding system specified for the current process.
6267 Another reason we come here is that the coding system
6268 was just complemented and a new one was returned by
6269 complement_process_encoding_system. */
6270 setup_coding_system (p->encode_coding_system, coding);
6271 Vlast_coding_system_used = p->encode_coding_system;
6273 coding->src_multibyte = 1;
6275 else
6277 coding->src_multibyte = 0;
6278 /* For sending a unibyte text, character code conversion should
6279 not take place but EOL conversion should. So, setup raw-text
6280 or one of the subsidiary if we have not yet done it. */
6281 if (CODING_REQUIRE_ENCODING (coding))
6283 if (CODING_REQUIRE_FLUSHING (coding))
6285 /* But, before changing the coding, we must flush out data. */
6286 coding->mode |= CODING_MODE_LAST_BLOCK;
6287 send_process (proc, "", 0, Qt);
6288 coding->mode &= CODING_MODE_LAST_BLOCK;
6290 setup_coding_system (raw_text_coding_system
6291 (Vlast_coding_system_used),
6292 coding);
6293 coding->src_multibyte = 0;
6296 coding->dst_multibyte = 0;
6298 if (CODING_REQUIRE_ENCODING (coding))
6300 coding->dst_object = Qt;
6301 if (BUFFERP (object))
6303 ptrdiff_t from_byte, from, to;
6304 ptrdiff_t save_pt, save_pt_byte;
6305 struct buffer *cur = current_buffer;
6307 set_buffer_internal (XBUFFER (object));
6308 save_pt = PT, save_pt_byte = PT_BYTE;
6310 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
6311 from = BYTE_TO_CHAR (from_byte);
6312 to = BYTE_TO_CHAR (from_byte + len);
6313 TEMP_SET_PT_BOTH (from, from_byte);
6314 encode_coding_object (coding, object, from, from_byte,
6315 to, from_byte + len, Qt);
6316 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
6317 set_buffer_internal (cur);
6319 else if (STRINGP (object))
6321 encode_coding_object (coding, object, 0, 0, SCHARS (object),
6322 SBYTES (object), Qt);
6324 else
6326 coding->dst_object = make_unibyte_string (buf, len);
6327 coding->produced = len;
6330 len = coding->produced;
6331 object = coding->dst_object;
6332 buf = SSDATA (object);
6335 /* If there is already data in the write_queue, put the new data
6336 in the back of queue. Otherwise, ignore it. */
6337 if (!NILP (p->write_queue))
6338 write_queue_push (p, object, buf, len, 0);
6340 do /* while !NILP (p->write_queue) */
6342 ptrdiff_t cur_len = -1;
6343 const char *cur_buf;
6344 Lisp_Object cur_object;
6346 /* If write_queue is empty, ignore it. */
6347 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
6349 cur_len = len;
6350 cur_buf = buf;
6351 cur_object = object;
6354 while (cur_len > 0)
6356 /* Send this batch, using one or more write calls. */
6357 ptrdiff_t written = 0;
6358 int outfd = p->outfd;
6359 #ifdef DATAGRAM_SOCKETS
6360 if (DATAGRAM_CHAN_P (outfd))
6362 rv = sendto (outfd, cur_buf, cur_len,
6363 0, datagram_address[outfd].sa,
6364 datagram_address[outfd].len);
6365 if (rv >= 0)
6366 written = rv;
6367 else if (errno == EMSGSIZE)
6368 report_file_error ("Sending datagram", proc);
6370 else
6371 #endif
6373 #ifdef HAVE_GNUTLS
6374 if (p->gnutls_p && p->gnutls_state)
6375 written = emacs_gnutls_write (p, cur_buf, cur_len);
6376 else
6377 #endif
6378 written = emacs_write_sig (outfd, cur_buf, cur_len);
6379 rv = (written ? 0 : -1);
6380 if (p->read_output_delay > 0
6381 && p->adaptive_read_buffering == 1)
6383 p->read_output_delay = 0;
6384 process_output_delay_count--;
6385 p->read_output_skip = 0;
6389 if (rv < 0)
6391 if (would_block (errno))
6392 /* Buffer is full. Wait, accepting input;
6393 that may allow the program
6394 to finish doing output and read more. */
6396 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
6397 /* A gross hack to work around a bug in FreeBSD.
6398 In the following sequence, read(2) returns
6399 bogus data:
6401 write(2) 1022 bytes
6402 write(2) 954 bytes, get EAGAIN
6403 read(2) 1024 bytes in process_read_output
6404 read(2) 11 bytes in process_read_output
6406 That is, read(2) returns more bytes than have
6407 ever been written successfully. The 1033 bytes
6408 read are the 1022 bytes written successfully
6409 after processing (for example with CRs added if
6410 the terminal is set up that way which it is
6411 here). The same bytes will be seen again in a
6412 later read(2), without the CRs. */
6414 if (errno == EAGAIN)
6416 int flags = FWRITE;
6417 ioctl (p->outfd, TIOCFLUSH, &flags);
6419 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
6421 /* Put what we should have written in wait_queue. */
6422 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
6423 wait_reading_process_output (0, 20 * 1000 * 1000,
6424 0, 0, Qnil, NULL, 0);
6425 /* Reread queue, to see what is left. */
6426 break;
6428 else if (errno == EPIPE)
6430 p->raw_status_new = 0;
6431 pset_status (p, list2 (Qexit, make_number (256)));
6432 p->tick = ++process_tick;
6433 deactivate_process (proc);
6434 error ("process %s no longer connected to pipe; closed it",
6435 SDATA (p->name));
6437 else
6438 /* This is a real error. */
6439 report_file_error ("Writing to process", proc);
6441 cur_buf += written;
6442 cur_len -= written;
6445 while (!NILP (p->write_queue));
6448 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
6449 3, 3, 0,
6450 doc: /* Send current contents of region as input to PROCESS.
6451 PROCESS may be a process, a buffer, the name of a process or buffer, or
6452 nil, indicating the current buffer's process.
6453 Called from program, takes three arguments, PROCESS, START and END.
6454 If the region is more than 500 characters long,
6455 it is sent in several bunches. This may happen even for shorter regions.
6456 Output from processes can arrive in between bunches.
6458 If PROCESS is a non-blocking network process that hasn't been fully
6459 set up yet, this function will block until socket setup has completed. */)
6460 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
6462 Lisp_Object proc = get_process (process);
6463 ptrdiff_t start_byte, end_byte;
6465 validate_region (&start, &end);
6467 start_byte = CHAR_TO_BYTE (XINT (start));
6468 end_byte = CHAR_TO_BYTE (XINT (end));
6470 if (XINT (start) < GPT && XINT (end) > GPT)
6471 move_gap_both (XINT (start), start_byte);
6473 if (NETCONN_P (proc))
6474 wait_while_connecting (proc);
6476 send_process (proc, (char *) BYTE_POS_ADDR (start_byte),
6477 end_byte - start_byte, Fcurrent_buffer ());
6479 return Qnil;
6482 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
6483 2, 2, 0,
6484 doc: /* Send PROCESS the contents of STRING as input.
6485 PROCESS may be a process, a buffer, the name of a process or buffer, or
6486 nil, indicating the current buffer's process.
6487 If STRING is more than 500 characters long,
6488 it is sent in several bunches. This may happen even for shorter strings.
6489 Output from processes can arrive in between bunches.
6491 If PROCESS is a non-blocking network process that hasn't been fully
6492 set up yet, this function will block until socket setup has completed. */)
6493 (Lisp_Object process, Lisp_Object string)
6495 CHECK_STRING (string);
6496 Lisp_Object proc = get_process (process);
6497 send_process (proc, SSDATA (string),
6498 SBYTES (string), string);
6499 return Qnil;
6502 /* Return the foreground process group for the tty/pty that
6503 the process P uses. */
6504 static pid_t
6505 emacs_get_tty_pgrp (struct Lisp_Process *p)
6507 pid_t gid = -1;
6509 #ifdef TIOCGPGRP
6510 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
6512 int fd;
6513 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
6514 master side. Try the slave side. */
6515 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
6517 if (fd != -1)
6519 ioctl (fd, TIOCGPGRP, &gid);
6520 emacs_close (fd);
6523 #endif /* defined (TIOCGPGRP ) */
6525 return gid;
6528 DEFUN ("process-running-child-p", Fprocess_running_child_p,
6529 Sprocess_running_child_p, 0, 1, 0,
6530 doc: /* Return non-nil if PROCESS has given the terminal to a
6531 child. If the operating system does not make it possible to find out,
6532 return t. If we can find out, return the numeric ID of the foreground
6533 process group. */)
6534 (Lisp_Object process)
6536 /* Initialize in case ioctl doesn't exist or gives an error,
6537 in a way that will cause returning t. */
6538 Lisp_Object proc = get_process (process);
6539 struct Lisp_Process *p = XPROCESS (proc);
6541 if (!EQ (p->type, Qreal))
6542 error ("Process %s is not a subprocess",
6543 SDATA (p->name));
6544 if (p->infd < 0)
6545 error ("Process %s is not active",
6546 SDATA (p->name));
6548 pid_t gid = emacs_get_tty_pgrp (p);
6550 if (gid == p->pid)
6551 return Qnil;
6552 if (gid != -1)
6553 return make_number (gid);
6554 return Qt;
6557 /* Send a signal number SIGNO to PROCESS.
6558 If CURRENT_GROUP is t, that means send to the process group
6559 that currently owns the terminal being used to communicate with PROCESS.
6560 This is used for various commands in shell mode.
6561 If CURRENT_GROUP is lambda, that means send to the process group
6562 that currently owns the terminal, but only if it is NOT the shell itself.
6564 If NOMSG is false, insert signal-announcements into process's buffers
6565 right away.
6567 If we can, we try to signal PROCESS by sending control characters
6568 down the pty. This allows us to signal inferiors who have changed
6569 their uid, for which kill would return an EPERM error. */
6571 static void
6572 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
6573 bool nomsg)
6575 Lisp_Object proc;
6576 struct Lisp_Process *p;
6577 pid_t gid;
6578 bool no_pgrp = 0;
6580 proc = get_process (process);
6581 p = XPROCESS (proc);
6583 if (!EQ (p->type, Qreal))
6584 error ("Process %s is not a subprocess",
6585 SDATA (p->name));
6586 if (p->infd < 0)
6587 error ("Process %s is not active",
6588 SDATA (p->name));
6590 if (!p->pty_flag)
6591 current_group = Qnil;
6593 /* If we are using pgrps, get a pgrp number and make it negative. */
6594 if (NILP (current_group))
6595 /* Send the signal to the shell's process group. */
6596 gid = p->pid;
6597 else
6599 #ifdef SIGNALS_VIA_CHARACTERS
6600 /* If possible, send signals to the entire pgrp
6601 by sending an input character to it. */
6603 struct termios t;
6604 cc_t *sig_char = NULL;
6606 tcgetattr (p->infd, &t);
6608 switch (signo)
6610 case SIGINT:
6611 sig_char = &t.c_cc[VINTR];
6612 break;
6614 case SIGQUIT:
6615 sig_char = &t.c_cc[VQUIT];
6616 break;
6618 case SIGTSTP:
6619 #ifdef VSWTCH
6620 sig_char = &t.c_cc[VSWTCH];
6621 #else
6622 sig_char = &t.c_cc[VSUSP];
6623 #endif
6624 break;
6627 if (sig_char && *sig_char != CDISABLE)
6629 send_process (proc, (char *) sig_char, 1, Qnil);
6630 return;
6632 /* If we can't send the signal with a character,
6633 fall through and send it another way. */
6635 /* The code above may fall through if it can't
6636 handle the signal. */
6637 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
6639 #ifdef TIOCGPGRP
6640 /* Get the current pgrp using the tty itself, if we have that.
6641 Otherwise, use the pty to get the pgrp.
6642 On pfa systems, saka@pfu.fujitsu.co.JP writes:
6643 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
6644 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
6645 His patch indicates that if TIOCGPGRP returns an error, then
6646 we should just assume that p->pid is also the process group id. */
6648 gid = emacs_get_tty_pgrp (p);
6650 if (gid == -1)
6651 /* If we can't get the information, assume
6652 the shell owns the tty. */
6653 gid = p->pid;
6655 /* It is not clear whether anything really can set GID to -1.
6656 Perhaps on some system one of those ioctls can or could do so.
6657 Or perhaps this is vestigial. */
6658 if (gid == -1)
6659 no_pgrp = 1;
6660 #else /* ! defined (TIOCGPGRP) */
6661 /* Can't select pgrps on this system, so we know that
6662 the child itself heads the pgrp. */
6663 gid = p->pid;
6664 #endif /* ! defined (TIOCGPGRP) */
6666 /* If current_group is lambda, and the shell owns the terminal,
6667 don't send any signal. */
6668 if (EQ (current_group, Qlambda) && gid == p->pid)
6669 return;
6672 #ifdef SIGCONT
6673 if (signo == SIGCONT)
6675 p->raw_status_new = 0;
6676 pset_status (p, Qrun);
6677 p->tick = ++process_tick;
6678 if (!nomsg)
6680 status_notify (NULL, NULL);
6681 redisplay_preserve_echo_area (13);
6684 #endif
6686 #ifdef TIOCSIGSEND
6687 /* Work around a HP-UX 7.0 bug that mishandles signals to subjobs.
6688 We don't know whether the bug is fixed in later HP-UX versions. */
6689 if (! NILP (current_group) && ioctl (p->infd, TIOCSIGSEND, signo) != -1)
6690 return;
6691 #endif
6693 /* If we don't have process groups, send the signal to the immediate
6694 subprocess. That isn't really right, but it's better than any
6695 obvious alternative. */
6696 pid_t pid = no_pgrp ? gid : - gid;
6698 /* Do not kill an already-reaped process, as that could kill an
6699 innocent bystander that happens to have the same process ID. */
6700 sigset_t oldset;
6701 block_child_signal (&oldset);
6702 if (p->alive)
6703 kill (pid, signo);
6704 unblock_child_signal (&oldset);
6707 DEFUN ("internal-default-interrupt-process",
6708 Finternal_default_interrupt_process,
6709 Sinternal_default_interrupt_process, 0, 2, 0,
6710 doc: /* Default function to interrupt process PROCESS.
6711 It shall be the last element in list `interrupt-process-functions'.
6712 See function `interrupt-process' for more details on usage. */)
6713 (Lisp_Object process, Lisp_Object current_group)
6715 process_send_signal (process, SIGINT, current_group, 0);
6716 return process;
6719 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
6720 doc: /* Interrupt process PROCESS.
6721 PROCESS may be a process, a buffer, or the name of a process or buffer.
6722 No arg or nil means current buffer's process.
6723 Second arg CURRENT-GROUP non-nil means send signal to
6724 the current process-group of the process's controlling terminal
6725 rather than to the process's own process group.
6726 If the process is a shell, this means interrupt current subjob
6727 rather than the shell.
6729 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
6730 don't send the signal.
6732 This function calls the functions of `interrupt-process-functions' in
6733 the order of the list, until one of them returns non-`nil'. */)
6734 (Lisp_Object process, Lisp_Object current_group)
6736 return CALLN (Frun_hook_with_args_until_success, Qinterrupt_process_functions,
6737 process, current_group);
6740 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
6741 doc: /* Kill process PROCESS. May be process or name of one.
6742 See function `interrupt-process' for more details on usage. */)
6743 (Lisp_Object process, Lisp_Object current_group)
6745 process_send_signal (process, SIGKILL, current_group, 0);
6746 return process;
6749 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
6750 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
6751 See function `interrupt-process' for more details on usage. */)
6752 (Lisp_Object process, Lisp_Object current_group)
6754 process_send_signal (process, SIGQUIT, current_group, 0);
6755 return process;
6758 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
6759 doc: /* Stop 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 or pipe connection, inhibit handling
6762 of incoming 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 (NILP (p->command)
6772 && p->infd >= 0)
6773 delete_read_fd (p->infd);
6774 pset_command (p, Qt);
6775 return process;
6777 #ifndef SIGTSTP
6778 error ("No SIGTSTP support");
6779 #else
6780 process_send_signal (process, SIGTSTP, current_group, 0);
6781 #endif
6782 return process;
6785 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
6786 doc: /* Continue process PROCESS. May be process or name of one.
6787 See function `interrupt-process' for more details on usage.
6788 If PROCESS is a network or serial process, resume handling of incoming
6789 traffic. */)
6790 (Lisp_Object process, Lisp_Object current_group)
6792 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)
6793 || PIPECONN_P (process)))
6795 struct Lisp_Process *p;
6797 p = XPROCESS (process);
6798 if (EQ (p->command, Qt)
6799 && p->infd >= 0
6800 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
6802 add_process_read_fd (p->infd);
6803 #ifdef WINDOWSNT
6804 if (fd_info[ p->infd ].flags & FILE_SERIAL)
6805 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
6806 #else /* not WINDOWSNT */
6807 tcflush (p->infd, TCIFLUSH);
6808 #endif /* not WINDOWSNT */
6810 pset_command (p, Qnil);
6811 return process;
6813 #ifdef SIGCONT
6814 process_send_signal (process, SIGCONT, current_group, 0);
6815 #else
6816 error ("No SIGCONT support");
6817 #endif
6818 return process;
6821 /* Return the integer value of the signal whose abbreviation is ABBR,
6822 or a negative number if there is no such signal. */
6823 static int
6824 abbr_to_signal (char const *name)
6826 int i, signo;
6827 char sigbuf[20]; /* Large enough for all valid signal abbreviations. */
6829 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
6830 name += 3;
6832 for (i = 0; i < sizeof sigbuf; i++)
6834 sigbuf[i] = c_toupper (name[i]);
6835 if (! sigbuf[i])
6836 return str2sig (sigbuf, &signo) == 0 ? signo : -1;
6839 return -1;
6842 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
6843 2, 2, "sProcess (name or number): \nnSignal code: ",
6844 doc: /* Send PROCESS the signal with code SIGCODE.
6845 PROCESS may also be a number specifying the process id of the
6846 process to signal; in this case, the process need not be a child of
6847 this Emacs.
6848 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
6849 (Lisp_Object process, Lisp_Object sigcode)
6851 pid_t pid;
6852 int signo;
6854 if (STRINGP (process))
6856 Lisp_Object tem = Fget_process (process);
6857 if (NILP (tem))
6859 Lisp_Object process_number
6860 = string_to_number (SSDATA (process), 10, 1);
6861 if (NUMBERP (process_number))
6862 tem = process_number;
6864 process = tem;
6866 else if (!NUMBERP (process))
6867 process = get_process (process);
6869 if (NILP (process))
6870 return process;
6872 if (NUMBERP (process))
6873 CONS_TO_INTEGER (process, pid_t, pid);
6874 else
6876 CHECK_PROCESS (process);
6877 pid = XPROCESS (process)->pid;
6878 if (pid <= 0)
6879 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
6882 if (INTEGERP (sigcode))
6884 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
6885 signo = XINT (sigcode);
6887 else
6889 char *name;
6891 CHECK_SYMBOL (sigcode);
6892 name = SSDATA (SYMBOL_NAME (sigcode));
6894 signo = abbr_to_signal (name);
6895 if (signo < 0)
6896 error ("Undefined signal name %s", name);
6899 return make_number (kill (pid, signo));
6902 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6903 doc: /* Make PROCESS see end-of-file in its input.
6904 EOF comes after any text already sent to it.
6905 PROCESS may be a process, a buffer, the name of a process or buffer, or
6906 nil, indicating the current buffer's process.
6907 If PROCESS is a network connection, or is a process communicating
6908 through a pipe (as opposed to a pty), then you cannot send any more
6909 text to PROCESS after you call this function.
6910 If PROCESS is a serial process, wait until all output written to the
6911 process has been transmitted to the serial port. */)
6912 (Lisp_Object process)
6914 Lisp_Object proc;
6915 struct coding_system *coding = NULL;
6916 int outfd;
6918 proc = get_process (process);
6920 if (NETCONN_P (proc))
6921 wait_while_connecting (proc);
6923 if (DATAGRAM_CONN_P (proc))
6924 return process;
6927 outfd = XPROCESS (proc)->outfd;
6928 if (outfd >= 0)
6929 coding = proc_encode_coding_system[outfd];
6931 /* Make sure the process is really alive. */
6932 if (XPROCESS (proc)->raw_status_new)
6933 update_status (XPROCESS (proc));
6934 if (! EQ (XPROCESS (proc)->status, Qrun))
6935 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6937 if (coding && CODING_REQUIRE_FLUSHING (coding))
6939 coding->mode |= CODING_MODE_LAST_BLOCK;
6940 send_process (proc, "", 0, Qnil);
6943 if (XPROCESS (proc)->pty_flag)
6944 send_process (proc, "\004", 1, Qnil);
6945 else if (EQ (XPROCESS (proc)->type, Qserial))
6947 #ifndef WINDOWSNT
6948 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6949 report_file_error ("Failed tcdrain", Qnil);
6950 #endif /* not WINDOWSNT */
6951 /* Do nothing on Windows because writes are blocking. */
6953 else
6955 struct Lisp_Process *p = XPROCESS (proc);
6956 int old_outfd = p->outfd;
6957 int new_outfd;
6959 #ifdef HAVE_SHUTDOWN
6960 /* If this is a network connection, or socketpair is used
6961 for communication with the subprocess, call shutdown to cause EOF.
6962 (In some old system, shutdown to socketpair doesn't work.
6963 Then we just can't win.) */
6964 if (0 <= old_outfd
6965 && (EQ (p->type, Qnetwork) || p->infd == old_outfd))
6966 shutdown (old_outfd, 1);
6967 #endif
6968 close_process_fd (&p->open_fd[WRITE_TO_SUBPROCESS]);
6969 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6970 if (new_outfd < 0)
6971 report_file_error ("Opening null device", Qnil);
6972 p->open_fd[WRITE_TO_SUBPROCESS] = new_outfd;
6973 p->outfd = new_outfd;
6975 if (!proc_encode_coding_system[new_outfd])
6976 proc_encode_coding_system[new_outfd]
6977 = xmalloc (sizeof (struct coding_system));
6978 if (old_outfd >= 0)
6980 *proc_encode_coding_system[new_outfd]
6981 = *proc_encode_coding_system[old_outfd];
6982 memset (proc_encode_coding_system[old_outfd], 0,
6983 sizeof (struct coding_system));
6985 else
6986 setup_coding_system (p->encode_coding_system,
6987 proc_encode_coding_system[new_outfd]);
6989 return process;
6992 /* The main Emacs thread records child processes in three places:
6994 - Vprocess_alist, for asynchronous subprocesses, which are child
6995 processes visible to Lisp.
6997 - deleted_pid_list, for child processes invisible to Lisp,
6998 typically because of delete-process. These are recorded so that
6999 the processes can be reaped when they exit, so that the operating
7000 system's process table is not cluttered by zombies.
7002 - the local variable PID in Fcall_process, call_process_cleanup and
7003 call_process_kill, for synchronous subprocesses.
7004 record_unwind_protect is used to make sure this process is not
7005 forgotten: if the user interrupts call-process and the child
7006 process refuses to exit immediately even with two C-g's,
7007 call_process_kill adds PID's contents to deleted_pid_list before
7008 returning.
7010 The main Emacs thread invokes waitpid only on child processes that
7011 it creates and that have not been reaped. This avoid races on
7012 platforms such as GTK, where other threads create their own
7013 subprocesses which the main thread should not reap. For example,
7014 if the main thread attempted to reap an already-reaped child, it
7015 might inadvertently reap a GTK-created process that happened to
7016 have the same process ID. */
7018 /* LIB_CHILD_HANDLER is a SIGCHLD handler that Emacs calls while doing
7019 its own SIGCHLD handling. On POSIXish systems, glib needs this to
7020 keep track of its own children. GNUstep is similar. */
7022 static void dummy_handler (int sig) {}
7023 static signal_handler_t volatile lib_child_handler;
7025 /* Handle a SIGCHLD signal by looking for known child processes of
7026 Emacs whose status have changed. For each one found, record its
7027 new status.
7029 All we do is change the status; we do not run sentinels or print
7030 notifications. That is saved for the next time keyboard input is
7031 done, in order to avoid timing errors.
7033 ** WARNING: this can be called during garbage collection.
7034 Therefore, it must not be fooled by the presence of mark bits in
7035 Lisp objects.
7037 ** USG WARNING: Although it is not obvious from the documentation
7038 in signal(2), on a USG system the SIGCLD handler MUST NOT call
7039 signal() before executing at least one wait(), otherwise the
7040 handler will be called again, resulting in an infinite loop. The
7041 relevant portion of the documentation reads "SIGCLD signals will be
7042 queued and the signal-catching function will be continually
7043 reentered until the queue is empty". Invoking signal() causes the
7044 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
7045 Inc.
7047 ** Malloc WARNING: This should never call malloc either directly or
7048 indirectly; if it does, that is a bug. */
7050 static void
7051 handle_child_signal (int sig)
7053 Lisp_Object tail, proc;
7055 /* Find the process that signaled us, and record its status. */
7057 /* The process can have been deleted by Fdelete_process, or have
7058 been started asynchronously by Fcall_process. */
7059 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
7061 bool all_pids_are_fixnums
7062 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
7063 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
7064 Lisp_Object head = XCAR (tail);
7065 Lisp_Object xpid;
7066 if (! CONSP (head))
7067 continue;
7068 xpid = XCAR (head);
7069 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
7071 pid_t deleted_pid;
7072 if (INTEGERP (xpid))
7073 deleted_pid = XINT (xpid);
7074 else
7075 deleted_pid = XFLOAT_DATA (xpid);
7076 if (child_status_changed (deleted_pid, 0, 0))
7078 if (STRINGP (XCDR (head)))
7079 unlink (SSDATA (XCDR (head)));
7080 XSETCAR (tail, Qnil);
7085 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
7086 FOR_EACH_PROCESS (tail, proc)
7088 struct Lisp_Process *p = XPROCESS (proc);
7089 int status;
7091 if (p->alive
7092 && child_status_changed (p->pid, &status, WUNTRACED | WCONTINUED))
7094 /* Change the status of the process that was found. */
7095 p->tick = ++process_tick;
7096 p->raw_status = status;
7097 p->raw_status_new = 1;
7099 /* If process has terminated, stop waiting for its output. */
7100 if (WIFSIGNALED (status) || WIFEXITED (status))
7102 bool clear_desc_flag = 0;
7103 p->alive = 0;
7104 if (p->infd >= 0)
7105 clear_desc_flag = 1;
7107 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
7108 if (clear_desc_flag)
7109 delete_read_fd (p->infd);
7114 lib_child_handler (sig);
7115 #ifdef NS_IMPL_GNUSTEP
7116 /* NSTask in GNUstep sets its child handler each time it is called.
7117 So we must re-set ours. */
7118 catch_child_signal ();
7119 #endif
7122 static void
7123 deliver_child_signal (int sig)
7125 deliver_process_signal (sig, handle_child_signal);
7129 static Lisp_Object
7130 exec_sentinel_error_handler (Lisp_Object error_val)
7132 /* Make sure error_val is a cons cell, as all the rest of error
7133 handling expects that, and will barf otherwise. */
7134 if (!CONSP (error_val))
7135 error_val = Fcons (Qerror, error_val);
7136 cmd_error_internal (error_val, "error in process sentinel: ");
7137 Vinhibit_quit = Qt;
7138 update_echo_area ();
7139 Fsleep_for (make_number (2), Qnil);
7140 return Qt;
7143 static void
7144 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
7146 Lisp_Object sentinel, odeactivate;
7147 struct Lisp_Process *p = XPROCESS (proc);
7148 ptrdiff_t count = SPECPDL_INDEX ();
7149 bool outer_running_asynch_code = running_asynch_code;
7150 int waiting = waiting_for_user_input_p;
7152 if (inhibit_sentinels)
7153 return;
7155 odeactivate = Vdeactivate_mark;
7156 #if 0
7157 Lisp_Object obuffer, okeymap;
7158 XSETBUFFER (obuffer, current_buffer);
7159 okeymap = BVAR (current_buffer, keymap);
7160 #endif
7162 /* There's no good reason to let sentinels change the current
7163 buffer, and many callers of accept-process-output, sit-for, and
7164 friends don't expect current-buffer to be changed from under them. */
7165 record_unwind_current_buffer ();
7167 sentinel = p->sentinel;
7169 /* Inhibit quit so that random quits don't screw up a running filter. */
7170 specbind (Qinhibit_quit, Qt);
7171 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
7173 /* In case we get recursively called,
7174 and we already saved the match data nonrecursively,
7175 save the same match data in safely recursive fashion. */
7176 if (outer_running_asynch_code)
7178 Lisp_Object tem;
7179 tem = Fmatch_data (Qnil, Qnil, Qnil);
7180 restore_search_regs ();
7181 record_unwind_save_match_data ();
7182 Fset_match_data (tem, Qt);
7185 /* For speed, if a search happens within this code,
7186 save the match data in a special nonrecursive fashion. */
7187 running_asynch_code = 1;
7189 internal_condition_case_1 (read_process_output_call,
7190 list3 (sentinel, proc, reason),
7191 !NILP (Vdebug_on_error) ? Qnil : Qerror,
7192 exec_sentinel_error_handler);
7194 /* If we saved the match data nonrecursively, restore it now. */
7195 restore_search_regs ();
7196 running_asynch_code = outer_running_asynch_code;
7198 Vdeactivate_mark = odeactivate;
7200 /* Restore waiting_for_user_input_p as it was
7201 when we were called, in case the filter clobbered it. */
7202 waiting_for_user_input_p = waiting;
7204 #if 0
7205 if (! EQ (Fcurrent_buffer (), obuffer)
7206 || ! EQ (current_buffer->keymap, okeymap))
7207 #endif
7208 /* But do it only if the caller is actually going to read events.
7209 Otherwise there's no need to make him wake up, and it could
7210 cause trouble (for example it would make sit_for return). */
7211 if (waiting_for_user_input_p == -1)
7212 record_asynch_buffer_change ();
7214 unbind_to (count, Qnil);
7217 /* Report all recent events of a change in process status
7218 (either run the sentinel or output a message).
7219 This is usually done while Emacs is waiting for keyboard input
7220 but can be done at other times.
7222 Return positive if any input was received from WAIT_PROC (or from
7223 any process if WAIT_PROC is null), zero if input was attempted but
7224 none received, and negative if we didn't even try. */
7226 static int
7227 status_notify (struct Lisp_Process *deleting_process,
7228 struct Lisp_Process *wait_proc)
7230 Lisp_Object proc;
7231 Lisp_Object tail, msg;
7232 int got_some_output = -1;
7234 tail = Qnil;
7235 msg = Qnil;
7237 /* Set this now, so that if new processes are created by sentinels
7238 that we run, we get called again to handle their status changes. */
7239 update_tick = process_tick;
7241 FOR_EACH_PROCESS (tail, proc)
7243 Lisp_Object symbol;
7244 register struct Lisp_Process *p = XPROCESS (proc);
7246 if (p->tick != p->update_tick)
7248 p->update_tick = p->tick;
7250 /* If process is still active, read any output that remains. */
7251 while (! EQ (p->filter, Qt)
7252 && ! connecting_status (p->status)
7253 && ! EQ (p->status, Qlisten)
7254 /* Network or serial process not stopped: */
7255 && ! EQ (p->command, Qt)
7256 && p->infd >= 0
7257 && p != deleting_process)
7259 int nread = read_process_output (proc, p->infd);
7260 if ((!wait_proc || wait_proc == XPROCESS (proc))
7261 && got_some_output < nread)
7262 got_some_output = nread;
7263 if (nread <= 0)
7264 break;
7267 /* Get the text to use for the message. */
7268 if (p->raw_status_new)
7269 update_status (p);
7270 msg = status_message (p);
7272 /* If process is terminated, deactivate it or delete it. */
7273 symbol = p->status;
7274 if (CONSP (p->status))
7275 symbol = XCAR (p->status);
7277 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
7278 || EQ (symbol, Qclosed))
7280 if (delete_exited_processes)
7281 remove_process (proc);
7282 else
7283 deactivate_process (proc);
7286 /* The actions above may have further incremented p->tick.
7287 So set p->update_tick again so that an error in the sentinel will
7288 not cause this code to be run again. */
7289 p->update_tick = p->tick;
7290 /* Now output the message suitably. */
7291 exec_sentinel (proc, msg);
7292 if (BUFFERP (p->buffer))
7293 /* In case it uses %s in mode-line-format. */
7294 bset_update_mode_line (XBUFFER (p->buffer));
7296 } /* end for */
7298 return got_some_output;
7301 DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel,
7302 Sinternal_default_process_sentinel, 2, 2, 0,
7303 doc: /* Function used as default sentinel for processes.
7304 This inserts a status message into the process's buffer, if there is one. */)
7305 (Lisp_Object proc, Lisp_Object msg)
7307 Lisp_Object buffer, symbol;
7308 struct Lisp_Process *p;
7309 CHECK_PROCESS (proc);
7310 p = XPROCESS (proc);
7311 buffer = p->buffer;
7312 symbol = p->status;
7313 if (CONSP (symbol))
7314 symbol = XCAR (symbol);
7316 if (!EQ (symbol, Qrun) && !NILP (buffer))
7318 Lisp_Object tem;
7319 struct buffer *old = current_buffer;
7320 ptrdiff_t opoint, opoint_byte;
7321 ptrdiff_t before, before_byte;
7323 /* Avoid error if buffer is deleted
7324 (probably that's why the process is dead, too). */
7325 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
7326 return Qnil;
7327 Fset_buffer (buffer);
7329 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
7330 msg = (code_convert_string_norecord
7331 (msg, Vlocale_coding_system, 1));
7333 opoint = PT;
7334 opoint_byte = PT_BYTE;
7335 /* Insert new output into buffer
7336 at the current end-of-output marker,
7337 thus preserving logical ordering of input and output. */
7338 if (XMARKER (p->mark)->buffer)
7339 Fgoto_char (p->mark);
7340 else
7341 SET_PT_BOTH (ZV, ZV_BYTE);
7343 before = PT;
7344 before_byte = PT_BYTE;
7346 tem = BVAR (current_buffer, read_only);
7347 bset_read_only (current_buffer, Qnil);
7348 insert_string ("\nProcess ");
7349 { /* FIXME: temporary kludge. */
7350 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
7351 insert_string (" ");
7352 Finsert (1, &msg);
7353 bset_read_only (current_buffer, tem);
7354 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
7356 if (opoint >= before)
7357 SET_PT_BOTH (opoint + (PT - before),
7358 opoint_byte + (PT_BYTE - before_byte));
7359 else
7360 SET_PT_BOTH (opoint, opoint_byte);
7362 set_buffer_internal (old);
7364 return Qnil;
7368 DEFUN ("set-process-coding-system", Fset_process_coding_system,
7369 Sset_process_coding_system, 1, 3, 0,
7370 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
7371 DECODING will be used to decode subprocess output and ENCODING to
7372 encode subprocess input. */)
7373 (Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
7375 CHECK_PROCESS (process);
7377 struct Lisp_Process *p = XPROCESS (process);
7379 Fcheck_coding_system (decoding);
7380 Fcheck_coding_system (encoding);
7381 encoding = coding_inherit_eol_type (encoding, Qnil);
7382 pset_decode_coding_system (p, decoding);
7383 pset_encode_coding_system (p, encoding);
7385 /* If the sockets haven't been set up yet, the final setup part of
7386 this will be called asynchronously. */
7387 if (p->infd < 0 || p->outfd < 0)
7388 return Qnil;
7390 setup_process_coding_systems (process);
7392 return Qnil;
7395 DEFUN ("process-coding-system",
7396 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
7397 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
7398 (register Lisp_Object process)
7400 CHECK_PROCESS (process);
7401 return Fcons (XPROCESS (process)->decode_coding_system,
7402 XPROCESS (process)->encode_coding_system);
7405 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
7406 Sset_process_filter_multibyte, 2, 2, 0,
7407 doc: /* Set multibyteness of the strings given to PROCESS's filter.
7408 If FLAG is non-nil, the filter is given multibyte strings.
7409 If FLAG is nil, the filter is given unibyte strings. In this case,
7410 all character code conversion except for end-of-line conversion is
7411 suppressed. */)
7412 (Lisp_Object process, Lisp_Object flag)
7414 CHECK_PROCESS (process);
7416 struct Lisp_Process *p = XPROCESS (process);
7417 if (NILP (flag))
7418 pset_decode_coding_system
7419 (p, raw_text_coding_system (p->decode_coding_system));
7421 /* If the sockets haven't been set up yet, the final setup part of
7422 this will be called asynchronously. */
7423 if (p->infd < 0 || p->outfd < 0)
7424 return Qnil;
7426 setup_process_coding_systems (process);
7428 return Qnil;
7431 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
7432 Sprocess_filter_multibyte_p, 1, 1, 0,
7433 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
7434 (Lisp_Object process)
7436 CHECK_PROCESS (process);
7437 struct Lisp_Process *p = XPROCESS (process);
7438 if (p->infd < 0)
7439 return Qnil;
7440 struct coding_system *coding = proc_decode_coding_system[p->infd];
7441 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
7447 # ifdef HAVE_GPM
7449 void
7450 add_gpm_wait_descriptor (int desc)
7452 add_keyboard_wait_descriptor (desc);
7455 void
7456 delete_gpm_wait_descriptor (int desc)
7458 delete_keyboard_wait_descriptor (desc);
7461 # endif
7463 # ifdef USABLE_SIGIO
7465 /* Return true if *MASK has a bit set
7466 that corresponds to one of the keyboard input descriptors. */
7468 static bool
7469 keyboard_bit_set (fd_set *mask)
7471 int fd;
7473 for (fd = 0; fd <= max_desc; fd++)
7474 if (FD_ISSET (fd, mask)
7475 && ((fd_callback_info[fd].flags & (FOR_READ | KEYBOARD_FD))
7476 == (FOR_READ | KEYBOARD_FD)))
7477 return 1;
7479 return 0;
7481 # endif
7483 #else /* not subprocesses */
7485 /* This is referenced in thread.c:run_thread (which is never actually
7486 called, since threads are not enabled for this configuration. */
7487 void
7488 update_processes_for_thread_death (Lisp_Object dying_thread)
7492 /* Defined in msdos.c. */
7493 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
7494 struct timespec *, void *);
7496 /* Implementation of wait_reading_process_output, assuming that there
7497 are no subprocesses. Used only by the MS-DOS build.
7499 Wait for timeout to elapse and/or keyboard input to be available.
7501 TIME_LIMIT is:
7502 timeout in seconds
7503 If negative, gobble data immediately available but don't wait for any.
7505 NSECS is:
7506 an additional duration to wait, measured in nanoseconds
7507 If TIME_LIMIT is zero, then:
7508 If NSECS == 0, there is no limit.
7509 If NSECS > 0, the timeout consists of NSECS only.
7510 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
7512 READ_KBD is:
7513 0 to ignore keyboard input, or
7514 1 to return when input is available, or
7515 -1 means caller will actually read the input, so don't throw to
7516 the quit handler.
7518 see full version for other parameters. We know that wait_proc will
7519 always be NULL, since `subprocesses' isn't defined.
7521 DO_DISPLAY means redisplay should be done to show subprocess
7522 output that arrives.
7524 Return -1 signifying we got no output and did not try. */
7527 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
7528 bool do_display,
7529 Lisp_Object wait_for_cell,
7530 struct Lisp_Process *wait_proc, int just_wait_proc)
7532 register int nfds;
7533 struct timespec end_time, timeout;
7534 enum { MINIMUM = -1, TIMEOUT, INFINITY } wait;
7536 if (TYPE_MAXIMUM (time_t) < time_limit)
7537 time_limit = TYPE_MAXIMUM (time_t);
7539 if (time_limit < 0 || nsecs < 0)
7540 wait = MINIMUM;
7541 else if (time_limit > 0 || nsecs > 0)
7543 wait = TIMEOUT;
7544 end_time = timespec_add (current_timespec (),
7545 make_timespec (time_limit, nsecs));
7547 else
7548 wait = INFINITY;
7550 /* Turn off periodic alarms (in case they are in use)
7551 and then turn off any other atimers,
7552 because the select emulator uses alarms. */
7553 stop_polling ();
7554 turn_on_atimers (0);
7556 while (1)
7558 bool timeout_reduced_for_timers = false;
7559 fd_set waitchannels;
7560 int xerrno;
7562 /* If calling from keyboard input, do not quit
7563 since we want to return C-g as an input character.
7564 Otherwise, do pending quit if requested. */
7565 if (read_kbd >= 0)
7566 maybe_quit ();
7568 /* Exit now if the cell we're waiting for became non-nil. */
7569 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7570 break;
7572 /* Compute time from now till when time limit is up. */
7573 /* Exit if already run out. */
7574 if (wait == TIMEOUT)
7576 struct timespec now = current_timespec ();
7577 if (timespec_cmp (end_time, now) <= 0)
7578 break;
7579 timeout = timespec_sub (end_time, now);
7581 else
7582 timeout = make_timespec (wait < TIMEOUT ? 0 : 100000, 0);
7584 /* If our caller will not immediately handle keyboard events,
7585 run timer events directly.
7586 (Callers that will immediately read keyboard events
7587 call timer_delay on their own.) */
7588 if (NILP (wait_for_cell))
7590 struct timespec timer_delay;
7594 unsigned old_timers_run = timers_run;
7595 timer_delay = timer_check ();
7596 if (timers_run != old_timers_run && do_display)
7597 /* We must retry, since a timer may have requeued itself
7598 and that could alter the time delay. */
7599 redisplay_preserve_echo_area (14);
7600 else
7601 break;
7603 while (!detect_input_pending ());
7605 /* If there is unread keyboard input, also return. */
7606 if (read_kbd != 0
7607 && requeued_events_pending_p ())
7608 break;
7610 if (timespec_valid_p (timer_delay))
7612 if (timespec_cmp (timer_delay, timeout) < 0)
7614 timeout = timer_delay;
7615 timeout_reduced_for_timers = true;
7620 /* Cause C-g and alarm signals to take immediate action,
7621 and cause input available signals to zero out timeout. */
7622 if (read_kbd < 0)
7623 set_waiting_for_input (&timeout);
7625 /* If a frame has been newly mapped and needs updating,
7626 reprocess its display stuff. */
7627 if (frame_garbaged && do_display)
7629 clear_waiting_for_input ();
7630 redisplay_preserve_echo_area (15);
7631 if (read_kbd < 0)
7632 set_waiting_for_input (&timeout);
7635 /* Wait till there is something to do. */
7636 FD_ZERO (&waitchannels);
7637 if (read_kbd && detect_input_pending ())
7638 nfds = 0;
7639 else
7641 if (read_kbd || !NILP (wait_for_cell))
7642 FD_SET (0, &waitchannels);
7643 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
7646 xerrno = errno;
7648 /* Make C-g and alarm signals set flags again. */
7649 clear_waiting_for_input ();
7651 /* If we woke up due to SIGWINCH, actually change size now. */
7652 do_pending_window_change (0);
7654 if (wait < INFINITY && nfds == 0 && ! timeout_reduced_for_timers)
7655 /* We waited the full specified time, so return now. */
7656 break;
7658 if (nfds == -1)
7660 /* If the system call was interrupted, then go around the
7661 loop again. */
7662 if (xerrno == EINTR)
7663 FD_ZERO (&waitchannels);
7664 else
7665 report_file_errno ("Failed select", Qnil, xerrno);
7668 /* Check for keyboard input. */
7670 if (read_kbd
7671 && detect_input_pending_run_timers (do_display))
7673 swallow_events (do_display);
7674 if (detect_input_pending_run_timers (do_display))
7675 break;
7678 /* If there is unread keyboard input, also return. */
7679 if (read_kbd
7680 && requeued_events_pending_p ())
7681 break;
7683 /* If wait_for_cell. check for keyboard input
7684 but don't run any timers.
7685 ??? (It seems wrong to me to check for keyboard
7686 input at all when wait_for_cell, but the code
7687 has been this way since July 1994.
7688 Try changing this after version 19.31.) */
7689 if (! NILP (wait_for_cell)
7690 && detect_input_pending ())
7692 swallow_events (do_display);
7693 if (detect_input_pending ())
7694 break;
7697 /* Exit now if the cell we're waiting for became non-nil. */
7698 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7699 break;
7702 start_polling ();
7704 return -1;
7707 #endif /* not subprocesses */
7709 /* The following functions are needed even if async subprocesses are
7710 not supported. Some of them are no-op stubs in that case. */
7712 #ifdef HAVE_TIMERFD
7714 /* Add FD, which is a descriptor returned by timerfd_create,
7715 to the set of non-keyboard input descriptors. */
7717 void
7718 add_timer_wait_descriptor (int fd)
7720 add_read_fd (fd, timerfd_callback, NULL);
7721 fd_callback_info[fd].flags &= ~KEYBOARD_FD;
7724 #endif /* HAVE_TIMERFD */
7726 /* If program file NAME starts with /: for quoting a magic
7727 name, remove that, preserving the multibyteness of NAME. */
7729 Lisp_Object
7730 remove_slash_colon (Lisp_Object name)
7732 return
7733 (SREF (name, 0) == '/' && SREF (name, 1) == ':'
7734 ? make_specified_string (SSDATA (name) + 2, SCHARS (name) - 2,
7735 SBYTES (name) - 2, STRING_MULTIBYTE (name))
7736 : name);
7739 /* Add DESC to the set of keyboard input descriptors. */
7741 void
7742 add_keyboard_wait_descriptor (int desc)
7744 #ifdef subprocesses /* Actually means "not MSDOS". */
7745 eassert (desc >= 0 && desc < FD_SETSIZE);
7746 fd_callback_info[desc].flags &= ~PROCESS_FD;
7747 fd_callback_info[desc].flags |= (FOR_READ | KEYBOARD_FD);
7748 if (desc > max_desc)
7749 max_desc = desc;
7750 #endif
7753 /* From now on, do not expect DESC to give keyboard input. */
7755 void
7756 delete_keyboard_wait_descriptor (int desc)
7758 #ifdef subprocesses
7759 eassert (desc >= 0 && desc < FD_SETSIZE);
7761 fd_callback_info[desc].flags &= ~(FOR_READ | KEYBOARD_FD | PROCESS_FD);
7763 if (desc == max_desc)
7764 recompute_max_desc ();
7765 #endif
7768 /* Setup coding systems of PROCESS. */
7770 void
7771 setup_process_coding_systems (Lisp_Object process)
7773 #ifdef subprocesses
7774 struct Lisp_Process *p = XPROCESS (process);
7775 int inch = p->infd;
7776 int outch = p->outfd;
7777 Lisp_Object coding_system;
7779 if (inch < 0 || outch < 0)
7780 return;
7782 if (!proc_decode_coding_system[inch])
7783 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
7784 coding_system = p->decode_coding_system;
7785 if (EQ (p->filter, Qinternal_default_process_filter)
7786 && BUFFERP (p->buffer))
7788 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
7789 coding_system = raw_text_coding_system (coding_system);
7791 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
7793 if (!proc_encode_coding_system[outch])
7794 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
7795 setup_coding_system (p->encode_coding_system,
7796 proc_encode_coding_system[outch]);
7797 #endif
7800 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
7801 doc: /* Return the (or a) live process associated with BUFFER.
7802 BUFFER may be a buffer or the name of one.
7803 Return nil if all processes associated with BUFFER have been
7804 deleted or killed. */)
7805 (register Lisp_Object buffer)
7807 #ifdef subprocesses
7808 register Lisp_Object buf, tail, proc;
7810 if (NILP (buffer)) return Qnil;
7811 buf = Fget_buffer (buffer);
7812 if (NILP (buf)) return Qnil;
7814 FOR_EACH_PROCESS (tail, proc)
7815 if (EQ (XPROCESS (proc)->buffer, buf))
7816 return proc;
7817 #endif /* subprocesses */
7818 return Qnil;
7821 DEFUN ("process-inherit-coding-system-flag",
7822 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
7823 1, 1, 0,
7824 doc: /* Return the value of inherit-coding-system flag for PROCESS.
7825 If this flag is t, `buffer-file-coding-system' of the buffer
7826 associated with PROCESS will inherit the coding system used to decode
7827 the process output. */)
7828 (register Lisp_Object process)
7830 #ifdef subprocesses
7831 CHECK_PROCESS (process);
7832 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
7833 #else
7834 /* Ignore the argument and return the value of
7835 inherit-process-coding-system. */
7836 return inherit_process_coding_system ? Qt : Qnil;
7837 #endif
7840 /* Kill all processes associated with `buffer'.
7841 If `buffer' is nil, kill all processes. */
7843 void
7844 kill_buffer_processes (Lisp_Object buffer)
7846 #ifdef subprocesses
7847 Lisp_Object tail, proc;
7849 FOR_EACH_PROCESS (tail, proc)
7850 if (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer))
7852 if (NETCONN_P (proc) || SERIALCONN_P (proc) || PIPECONN_P (proc))
7853 Fdelete_process (proc);
7854 else if (XPROCESS (proc)->infd >= 0)
7855 process_send_signal (proc, SIGHUP, Qnil, 1);
7857 #else /* subprocesses */
7858 /* Since we have no subprocesses, this does nothing. */
7859 #endif /* subprocesses */
7862 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
7863 Swaiting_for_user_input_p, 0, 0, 0,
7864 doc: /* Return non-nil if Emacs is waiting for input from the user.
7865 This is intended for use by asynchronous process output filters and sentinels. */)
7866 (void)
7868 #ifdef subprocesses
7869 return (waiting_for_user_input_p ? Qt : Qnil);
7870 #else
7871 return Qnil;
7872 #endif
7875 /* Stop reading input from keyboard sources. */
7877 void
7878 hold_keyboard_input (void)
7880 kbd_is_on_hold = 1;
7883 /* Resume reading input from keyboard sources. */
7885 void
7886 unhold_keyboard_input (void)
7888 kbd_is_on_hold = 0;
7891 /* Return true if keyboard input is on hold, zero otherwise. */
7893 bool
7894 kbd_on_hold_p (void)
7896 return kbd_is_on_hold;
7900 /* Enumeration of and access to system processes a-la ps(1). */
7902 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
7903 0, 0, 0,
7904 doc: /* Return a list of numerical process IDs of all running processes.
7905 If this functionality is unsupported, return nil.
7907 See `process-attributes' for getting attributes of a process given its ID. */)
7908 (void)
7910 return list_system_processes ();
7913 DEFUN ("process-attributes", Fprocess_attributes,
7914 Sprocess_attributes, 1, 1, 0,
7915 doc: /* Return attributes of the process given by its PID, a number.
7917 Value is an alist where each element is a cons cell of the form
7919 (KEY . VALUE)
7921 If this functionality is unsupported, the value is nil.
7923 See `list-system-processes' for getting a list of all process IDs.
7925 The KEYs of the attributes that this function may return are listed
7926 below, together with the type of the associated VALUE (in parentheses).
7927 Not all platforms support all of these attributes; unsupported
7928 attributes will not appear in the returned alist.
7929 Unless explicitly indicated otherwise, numbers can have either
7930 integer or floating point values.
7932 euid -- Effective user User ID of the process (number)
7933 user -- User name corresponding to euid (string)
7934 egid -- Effective user Group ID of the process (number)
7935 group -- Group name corresponding to egid (string)
7936 comm -- Command name (executable name only) (string)
7937 state -- Process state code, such as "S", "R", or "T" (string)
7938 ppid -- Parent process ID (number)
7939 pgrp -- Process group ID (number)
7940 sess -- Session ID, i.e. process ID of session leader (number)
7941 ttname -- Controlling tty name (string)
7942 tpgid -- ID of foreground process group on the process's tty (number)
7943 minflt -- number of minor page faults (number)
7944 majflt -- number of major page faults (number)
7945 cminflt -- cumulative number of minor page faults (number)
7946 cmajflt -- cumulative number of major page faults (number)
7947 utime -- user time used by the process, in (current-time) format,
7948 which is a list of integers (HIGH LOW USEC PSEC)
7949 stime -- system time used by the process (current-time)
7950 time -- sum of utime and stime (current-time)
7951 cutime -- user time used by the process and its children (current-time)
7952 cstime -- system time used by the process and its children (current-time)
7953 ctime -- sum of cutime and cstime (current-time)
7954 pri -- priority of the process (number)
7955 nice -- nice value of the process (number)
7956 thcount -- process thread count (number)
7957 start -- time the process started (current-time)
7958 vsize -- virtual memory size of the process in KB's (number)
7959 rss -- resident set size of the process in KB's (number)
7960 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7961 pcpu -- percents of CPU time used by the process (floating-point number)
7962 pmem -- percents of total physical memory used by process's resident set
7963 (floating-point number)
7964 args -- command line which invoked the process (string). */)
7965 ( Lisp_Object pid)
7967 return system_process_attributes (pid);
7970 #ifdef subprocesses
7971 /* Arrange to catch SIGCHLD if this hasn't already been arranged.
7972 Invoke this after init_process_emacs, and after glib and/or GNUstep
7973 futz with the SIGCHLD handler, but before Emacs forks any children.
7974 This function's caller should block SIGCHLD. */
7976 void
7977 catch_child_signal (void)
7979 struct sigaction action, old_action;
7980 sigset_t oldset;
7981 emacs_sigaction_init (&action, deliver_child_signal);
7982 block_child_signal (&oldset);
7983 sigaction (SIGCHLD, &action, &old_action);
7984 eassert (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7985 || ! (old_action.sa_flags & SA_SIGINFO));
7987 if (old_action.sa_handler != deliver_child_signal)
7988 lib_child_handler
7989 = (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7990 ? dummy_handler
7991 : old_action.sa_handler);
7992 unblock_child_signal (&oldset);
7994 #endif /* subprocesses */
7996 /* Limit the number of open files to the value it had at startup. */
7998 void
7999 restore_nofile_limit (void)
8001 #ifdef HAVE_SETRLIMIT
8002 if (FD_SETSIZE < nofile_limit.rlim_cur)
8003 setrlimit (RLIMIT_NOFILE, &nofile_limit);
8004 #endif
8008 /* This is not called "init_process" because that is the name of a
8009 Mach system call, so it would cause problems on Darwin systems. */
8010 void
8011 init_process_emacs (int sockfd)
8013 #ifdef subprocesses
8014 int i;
8016 inhibit_sentinels = 0;
8018 #ifndef CANNOT_DUMP
8019 if (! noninteractive || initialized)
8020 #endif
8022 #if defined HAVE_GLIB && !defined WINDOWSNT
8023 /* Tickle glib's child-handling code. Ask glib to wait for Emacs itself;
8024 this should always fail, but is enough to initialize glib's
8025 private SIGCHLD handler, allowing catch_child_signal to copy
8026 it into lib_child_handler. */
8027 g_source_unref (g_child_watch_source_new (getpid ()));
8028 #endif
8029 catch_child_signal ();
8032 #ifdef HAVE_SETRLIMIT
8033 /* Don't allocate more than FD_SETSIZE file descriptors for Emacs itself. */
8034 if (getrlimit (RLIMIT_NOFILE, &nofile_limit) != 0)
8035 nofile_limit.rlim_cur = 0;
8036 else if (FD_SETSIZE < nofile_limit.rlim_cur)
8038 struct rlimit rlim = nofile_limit;
8039 rlim.rlim_cur = FD_SETSIZE;
8040 if (setrlimit (RLIMIT_NOFILE, &rlim) != 0)
8041 nofile_limit.rlim_cur = 0;
8043 #endif
8045 external_sock_fd = sockfd;
8046 max_desc = -1;
8047 memset (fd_callback_info, 0, sizeof (fd_callback_info));
8049 num_pending_connects = 0;
8051 process_output_delay_count = 0;
8052 process_output_skip = 0;
8054 /* Don't do this, it caused infinite select loops. The display
8055 method should call add_keyboard_wait_descriptor on stdin if it
8056 needs that. */
8057 #if 0
8058 FD_SET (0, &input_wait_mask);
8059 #endif
8061 Vprocess_alist = Qnil;
8062 deleted_pid_list = Qnil;
8063 for (i = 0; i < FD_SETSIZE; i++)
8065 chan_process[i] = Qnil;
8066 proc_buffered_char[i] = -1;
8068 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
8069 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
8070 #ifdef DATAGRAM_SOCKETS
8071 memset (datagram_address, 0, sizeof datagram_address);
8072 #endif
8074 #if defined (DARWIN_OS)
8075 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
8076 processes. As such, we only change the default value. */
8077 if (initialized)
8079 char const *release = (STRINGP (Voperating_system_release)
8080 ? SSDATA (Voperating_system_release)
8081 : 0);
8082 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
8083 Vprocess_connection_type = Qnil;
8086 #endif
8087 #endif /* subprocesses */
8088 kbd_is_on_hold = 0;
8091 void
8092 syms_of_process (void)
8094 #ifdef subprocesses
8096 DEFSYM (Qprocessp, "processp");
8097 DEFSYM (Qrun, "run");
8098 DEFSYM (Qstop, "stop");
8099 DEFSYM (Qsignal, "signal");
8101 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
8102 here again. */
8104 DEFSYM (Qopen, "open");
8105 DEFSYM (Qclosed, "closed");
8106 DEFSYM (Qconnect, "connect");
8107 DEFSYM (Qfailed, "failed");
8108 DEFSYM (Qlisten, "listen");
8109 DEFSYM (Qlocal, "local");
8110 DEFSYM (Qipv4, "ipv4");
8111 #ifdef AF_INET6
8112 DEFSYM (Qipv6, "ipv6");
8113 #endif
8114 DEFSYM (Qdatagram, "datagram");
8115 DEFSYM (Qseqpacket, "seqpacket");
8117 DEFSYM (QCport, ":port");
8118 DEFSYM (QCspeed, ":speed");
8119 DEFSYM (QCprocess, ":process");
8121 DEFSYM (QCbytesize, ":bytesize");
8122 DEFSYM (QCstopbits, ":stopbits");
8123 DEFSYM (QCparity, ":parity");
8124 DEFSYM (Qodd, "odd");
8125 DEFSYM (Qeven, "even");
8126 DEFSYM (QCflowcontrol, ":flowcontrol");
8127 DEFSYM (Qhw, "hw");
8128 DEFSYM (Qsw, "sw");
8129 DEFSYM (QCsummary, ":summary");
8131 DEFSYM (Qreal, "real");
8132 DEFSYM (Qnetwork, "network");
8133 DEFSYM (Qserial, "serial");
8134 DEFSYM (QCbuffer, ":buffer");
8135 DEFSYM (QChost, ":host");
8136 DEFSYM (QCservice, ":service");
8137 DEFSYM (QClocal, ":local");
8138 DEFSYM (QCremote, ":remote");
8139 DEFSYM (QCcoding, ":coding");
8140 DEFSYM (QCserver, ":server");
8141 DEFSYM (QCnowait, ":nowait");
8142 DEFSYM (QCsentinel, ":sentinel");
8143 DEFSYM (QCuse_external_socket, ":use-external-socket");
8144 DEFSYM (QCtls_parameters, ":tls-parameters");
8145 DEFSYM (Qnsm_verify_connection, "nsm-verify-connection");
8146 DEFSYM (QClog, ":log");
8147 DEFSYM (QCnoquery, ":noquery");
8148 DEFSYM (QCstop, ":stop");
8149 DEFSYM (QCplist, ":plist");
8150 DEFSYM (QCcommand, ":command");
8151 DEFSYM (QCconnection_type, ":connection-type");
8152 DEFSYM (QCstderr, ":stderr");
8153 DEFSYM (Qpty, "pty");
8154 DEFSYM (Qpipe, "pipe");
8156 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
8158 staticpro (&Vprocess_alist);
8159 staticpro (&deleted_pid_list);
8161 #endif /* subprocesses */
8163 DEFSYM (QCname, ":name");
8164 DEFSYM (QCtype, ":type");
8166 DEFSYM (Qeuid, "euid");
8167 DEFSYM (Qegid, "egid");
8168 DEFSYM (Quser, "user");
8169 DEFSYM (Qgroup, "group");
8170 DEFSYM (Qcomm, "comm");
8171 DEFSYM (Qstate, "state");
8172 DEFSYM (Qppid, "ppid");
8173 DEFSYM (Qpgrp, "pgrp");
8174 DEFSYM (Qsess, "sess");
8175 DEFSYM (Qttname, "ttname");
8176 DEFSYM (Qtpgid, "tpgid");
8177 DEFSYM (Qminflt, "minflt");
8178 DEFSYM (Qmajflt, "majflt");
8179 DEFSYM (Qcminflt, "cminflt");
8180 DEFSYM (Qcmajflt, "cmajflt");
8181 DEFSYM (Qutime, "utime");
8182 DEFSYM (Qstime, "stime");
8183 DEFSYM (Qtime, "time");
8184 DEFSYM (Qcutime, "cutime");
8185 DEFSYM (Qcstime, "cstime");
8186 DEFSYM (Qctime, "ctime");
8187 #ifdef subprocesses
8188 DEFSYM (Qinternal_default_process_sentinel,
8189 "internal-default-process-sentinel");
8190 DEFSYM (Qinternal_default_process_filter,
8191 "internal-default-process-filter");
8192 #endif
8193 DEFSYM (Qpri, "pri");
8194 DEFSYM (Qnice, "nice");
8195 DEFSYM (Qthcount, "thcount");
8196 DEFSYM (Qstart, "start");
8197 DEFSYM (Qvsize, "vsize");
8198 DEFSYM (Qrss, "rss");
8199 DEFSYM (Qetime, "etime");
8200 DEFSYM (Qpcpu, "pcpu");
8201 DEFSYM (Qpmem, "pmem");
8202 DEFSYM (Qargs, "args");
8204 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
8205 doc: /* Non-nil means delete processes immediately when they exit.
8206 A value of nil means don't delete them until `list-processes' is run. */);
8208 delete_exited_processes = 1;
8210 #ifdef subprocesses
8211 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
8212 doc: /* Control type of device used to communicate with subprocesses.
8213 Values are nil to use a pipe, or t or `pty' to use a pty.
8214 The value has no effect if the system has no ptys or if all ptys are busy:
8215 then a pipe is used in any case.
8216 The value takes effect when `start-process' is called. */);
8217 Vprocess_connection_type = Qt;
8219 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
8220 doc: /* If non-nil, improve receive buffering by delaying after short reads.
8221 On some systems, when Emacs reads the output from a subprocess, the output data
8222 is read in very small blocks, potentially resulting in very poor performance.
8223 This behavior can be remedied to some extent by setting this variable to a
8224 non-nil value, as it will automatically delay reading from such processes, to
8225 allow them to produce more output before Emacs tries to read it.
8226 If the value is t, the delay is reset after each write to the process; any other
8227 non-nil value means that the delay is not reset on write.
8228 The variable takes effect when `start-process' is called. */);
8229 Vprocess_adaptive_read_buffering = Qt;
8231 DEFVAR_LISP ("interrupt-process-functions", Vinterrupt_process_functions,
8232 doc: /* List of functions to be called for `interrupt-process'.
8233 The arguments of the functions are the same as for `interrupt-process'.
8234 These functions are called in the order of the list, until one of them
8235 returns non-`nil'. */);
8236 Vinterrupt_process_functions = list1 (Qinternal_default_interrupt_process);
8238 DEFSYM (Qinternal_default_interrupt_process,
8239 "internal-default-interrupt-process");
8240 DEFSYM (Qinterrupt_process_functions, "interrupt-process-functions");
8242 defsubr (&Sprocessp);
8243 defsubr (&Sget_process);
8244 defsubr (&Sdelete_process);
8245 defsubr (&Sprocess_status);
8246 defsubr (&Sprocess_exit_status);
8247 defsubr (&Sprocess_id);
8248 defsubr (&Sprocess_name);
8249 defsubr (&Sprocess_tty_name);
8250 defsubr (&Sprocess_command);
8251 defsubr (&Sset_process_buffer);
8252 defsubr (&Sprocess_buffer);
8253 defsubr (&Sprocess_mark);
8254 defsubr (&Sset_process_filter);
8255 defsubr (&Sprocess_filter);
8256 defsubr (&Sset_process_sentinel);
8257 defsubr (&Sprocess_sentinel);
8258 defsubr (&Sset_process_thread);
8259 defsubr (&Sprocess_thread);
8260 defsubr (&Sset_process_window_size);
8261 defsubr (&Sset_process_inherit_coding_system_flag);
8262 defsubr (&Sset_process_query_on_exit_flag);
8263 defsubr (&Sprocess_query_on_exit_flag);
8264 defsubr (&Sprocess_contact);
8265 defsubr (&Sprocess_plist);
8266 defsubr (&Sset_process_plist);
8267 defsubr (&Sprocess_list);
8268 defsubr (&Smake_process);
8269 defsubr (&Smake_pipe_process);
8270 defsubr (&Sserial_process_configure);
8271 defsubr (&Smake_serial_process);
8272 defsubr (&Sset_network_process_option);
8273 defsubr (&Smake_network_process);
8274 defsubr (&Sformat_network_address);
8275 defsubr (&Snetwork_interface_list);
8276 defsubr (&Snetwork_interface_info);
8277 #ifdef DATAGRAM_SOCKETS
8278 defsubr (&Sprocess_datagram_address);
8279 defsubr (&Sset_process_datagram_address);
8280 #endif
8281 defsubr (&Saccept_process_output);
8282 defsubr (&Sprocess_send_region);
8283 defsubr (&Sprocess_send_string);
8284 defsubr (&Sinternal_default_interrupt_process);
8285 defsubr (&Sinterrupt_process);
8286 defsubr (&Skill_process);
8287 defsubr (&Squit_process);
8288 defsubr (&Sstop_process);
8289 defsubr (&Scontinue_process);
8290 defsubr (&Sprocess_running_child_p);
8291 defsubr (&Sprocess_send_eof);
8292 defsubr (&Ssignal_process);
8293 defsubr (&Swaiting_for_user_input_p);
8294 defsubr (&Sprocess_type);
8295 defsubr (&Sinternal_default_process_sentinel);
8296 defsubr (&Sinternal_default_process_filter);
8297 defsubr (&Sset_process_coding_system);
8298 defsubr (&Sprocess_coding_system);
8299 defsubr (&Sset_process_filter_multibyte);
8300 defsubr (&Sprocess_filter_multibyte_p);
8303 Lisp_Object subfeatures = Qnil;
8304 const struct socket_options *sopt;
8306 #define ADD_SUBFEATURE(key, val) \
8307 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
8309 ADD_SUBFEATURE (QCnowait, Qt);
8310 #ifdef DATAGRAM_SOCKETS
8311 ADD_SUBFEATURE (QCtype, Qdatagram);
8312 #endif
8313 #ifdef HAVE_SEQPACKET
8314 ADD_SUBFEATURE (QCtype, Qseqpacket);
8315 #endif
8316 #ifdef HAVE_LOCAL_SOCKETS
8317 ADD_SUBFEATURE (QCfamily, Qlocal);
8318 #endif
8319 ADD_SUBFEATURE (QCfamily, Qipv4);
8320 #ifdef AF_INET6
8321 ADD_SUBFEATURE (QCfamily, Qipv6);
8322 #endif
8323 #ifdef HAVE_GETSOCKNAME
8324 ADD_SUBFEATURE (QCservice, Qt);
8325 #endif
8326 ADD_SUBFEATURE (QCserver, Qt);
8328 for (sopt = socket_options; sopt->name; sopt++)
8329 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
8331 Fprovide (intern_c_string ("make-network-process"), subfeatures);
8334 #endif /* subprocesses */
8336 defsubr (&Sget_buffer_process);
8337 defsubr (&Sprocess_inherit_coding_system_flag);
8338 defsubr (&Slist_system_processes);
8339 defsubr (&Sprocess_attributes);