Comment formatting
[emacs.git] / src / process.c
blob20f84990d6f84a5be55eec5f36fb5161a45aca63
1 /* Asynchronous subprocess control for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2013 Free Software
4 Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
24 #define PROCESS_INLINE EXTERN_INLINE
26 #include <stdio.h>
27 #include <errno.h>
28 #include <sys/types.h> /* Some typedefs are used in sys/file.h. */
29 #include <sys/file.h>
30 #include <sys/stat.h>
31 #include <unistd.h>
32 #include <fcntl.h>
34 #include "lisp.h"
36 /* Only MS-DOS does not define `subprocesses'. */
37 #ifdef subprocesses
39 #include <sys/socket.h>
40 #include <netdb.h>
41 #include <netinet/in.h>
42 #include <arpa/inet.h>
44 /* Are local (unix) sockets supported? */
45 #if defined (HAVE_SYS_UN_H)
46 #if !defined (AF_LOCAL) && defined (AF_UNIX)
47 #define AF_LOCAL AF_UNIX
48 #endif
49 #ifdef AF_LOCAL
50 #define HAVE_LOCAL_SOCKETS
51 #include <sys/un.h>
52 #endif
53 #endif
55 #include <sys/ioctl.h>
56 #if defined (HAVE_NET_IF_H)
57 #include <net/if.h>
58 #endif /* HAVE_NET_IF_H */
60 #if defined (HAVE_IFADDRS_H)
61 /* Must be after net/if.h */
62 #include <ifaddrs.h>
64 /* We only use structs from this header when we use getifaddrs. */
65 #if defined (HAVE_NET_IF_DL_H)
66 #include <net/if_dl.h>
67 #endif
69 #endif
71 #ifdef NEED_BSDTTY
72 #include <bsdtty.h>
73 #endif
75 #ifdef USG5_4
76 # include <sys/stream.h>
77 # include <sys/stropts.h>
78 #endif
80 #ifdef HAVE_RES_INIT
81 #include <arpa/nameser.h>
82 #include <resolv.h>
83 #endif
85 #ifdef HAVE_UTIL_H
86 #include <util.h>
87 #endif
89 #ifdef HAVE_PTY_H
90 #include <pty.h>
91 #endif
93 #include <c-ctype.h>
94 #include <sig2str.h>
95 #include <verify.h>
97 #endif /* subprocesses */
99 #include "systime.h"
100 #include "systty.h"
102 #include "window.h"
103 #include "character.h"
104 #include "buffer.h"
105 #include "coding.h"
106 #include "process.h"
107 #include "frame.h"
108 #include "termhooks.h"
109 #include "termopts.h"
110 #include "commands.h"
111 #include "keyboard.h"
112 #include "blockinput.h"
113 #include "dispextern.h"
114 #include "composite.h"
115 #include "atimer.h"
116 #include "sysselect.h"
117 #include "syssignal.h"
118 #include "syswait.h"
119 #ifdef HAVE_GNUTLS
120 #include "gnutls.h"
121 #endif
123 #ifdef HAVE_WINDOW_SYSTEM
124 #include TERM_HEADER
125 #endif /* HAVE_WINDOW_SYSTEM */
127 #ifdef HAVE_GLIB
128 #include "xgselect.h"
129 #ifndef WINDOWSNT
130 #include <glib.h>
131 #endif
132 #endif
134 #ifdef WINDOWSNT
135 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
136 struct timespec *, void *);
137 #endif
139 #ifndef SOCK_CLOEXEC
140 # define SOCK_CLOEXEC 0
141 #endif
143 #ifndef HAVE_ACCEPT4
145 /* Emulate GNU/Linux accept4 and socket well enough for this module. */
147 static int
148 close_on_exec (int fd)
150 if (0 <= fd)
151 fcntl (fd, F_SETFD, FD_CLOEXEC);
152 return fd;
155 static int
156 accept4 (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags)
158 return close_on_exec (accept (sockfd, addr, addrlen));
161 static int
162 process_socket (int domain, int type, int protocol)
164 return close_on_exec (socket (domain, type, protocol));
166 # undef socket
167 # define socket(domain, type, protocol) process_socket (domain, type, protocol)
168 #endif
170 /* Work around GCC 4.7.0 bug with strict overflow checking; see
171 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
172 These lines can be removed once the GCC bug is fixed. */
173 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
174 # pragma GCC diagnostic ignored "-Wstrict-overflow"
175 #endif
177 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
178 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
179 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
180 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
181 Lisp_Object QCname, QCtype;
183 /* True if keyboard input is on hold, zero otherwise. */
185 static bool kbd_is_on_hold;
187 /* Nonzero means don't run process sentinels. This is used
188 when exiting. */
189 bool inhibit_sentinels;
191 #ifdef subprocesses
193 Lisp_Object Qprocessp;
194 static Lisp_Object Qrun, Qstop, Qsignal;
195 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
196 Lisp_Object Qlocal;
197 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
198 static Lisp_Object Qreal, Qnetwork, Qserial;
199 #ifdef AF_INET6
200 static Lisp_Object Qipv6;
201 #endif
202 static Lisp_Object QCport, QCprocess;
203 Lisp_Object QCspeed;
204 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
205 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
206 static Lisp_Object QCbuffer, QChost, QCservice;
207 static Lisp_Object QClocal, QCremote, QCcoding;
208 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
209 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
210 static Lisp_Object Qlast_nonmenu_event;
211 static Lisp_Object Qinternal_default_process_sentinel;
212 static Lisp_Object Qinternal_default_process_filter;
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))
219 /* Number of events of change of status of a process. */
220 static EMACS_INT process_tick;
221 /* Number of events for which the user or sentinel has been notified. */
222 static EMACS_INT update_tick;
224 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
226 /* Only W32 has this, it really means that select can't take write mask. */
227 #ifdef BROKEN_NON_BLOCKING_CONNECT
228 #undef NON_BLOCKING_CONNECT
229 #define SELECT_CANT_DO_WRITE_MASK
230 #else
231 #ifndef NON_BLOCKING_CONNECT
232 #ifdef HAVE_SELECT
233 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
234 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
235 #define NON_BLOCKING_CONNECT
236 #endif /* EWOULDBLOCK || EINPROGRESS */
237 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
238 #endif /* HAVE_SELECT */
239 #endif /* NON_BLOCKING_CONNECT */
240 #endif /* BROKEN_NON_BLOCKING_CONNECT */
242 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
243 this system. We need to read full packets, so we need a
244 "non-destructive" select. So we require either native select,
245 or emulation of select using FIONREAD. */
247 #ifndef BROKEN_DATAGRAM_SOCKETS
248 # if defined HAVE_SELECT || defined USABLE_FIONREAD
249 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
250 # define DATAGRAM_SOCKETS
251 # endif
252 # endif
253 #endif
255 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
256 # define HAVE_SEQPACKET
257 #endif
259 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
260 #define ADAPTIVE_READ_BUFFERING
261 #endif
263 #ifdef ADAPTIVE_READ_BUFFERING
264 #define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
265 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
266 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
268 /* Number of processes which have a non-zero read_output_delay,
269 and therefore might be delayed for adaptive read buffering. */
271 static int process_output_delay_count;
273 /* True if any process has non-nil read_output_skip. */
275 static bool process_output_skip;
277 #else
278 #define process_output_delay_count 0
279 #endif
281 static void create_process (Lisp_Object, char **, Lisp_Object);
282 #ifdef USABLE_SIGIO
283 static bool keyboard_bit_set (fd_set *);
284 #endif
285 static void deactivate_process (Lisp_Object);
286 static void status_notify (struct Lisp_Process *);
287 static int read_process_output (Lisp_Object, int);
288 static void handle_child_signal (int);
289 static void create_pty (Lisp_Object);
291 /* If we support a window system, turn on the code to poll periodically
292 to detect C-g. It isn't actually used when doing interrupt input. */
293 #ifdef HAVE_WINDOW_SYSTEM
294 #define POLL_FOR_INPUT
295 #endif
297 static Lisp_Object get_process (register Lisp_Object name);
298 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
300 /* Mask of bits indicating the descriptors that we wait for input on. */
302 static fd_set input_wait_mask;
304 /* Mask that excludes keyboard input descriptor(s). */
306 static fd_set non_keyboard_wait_mask;
308 /* Mask that excludes process input descriptor(s). */
310 static fd_set non_process_wait_mask;
312 /* Mask for selecting for write. */
314 static fd_set write_mask;
316 #ifdef NON_BLOCKING_CONNECT
317 /* Mask of bits indicating the descriptors that we wait for connect to
318 complete on. Once they complete, they are removed from this mask
319 and added to the input_wait_mask and non_keyboard_wait_mask. */
321 static fd_set connect_wait_mask;
323 /* Number of bits set in connect_wait_mask. */
324 static int num_pending_connects;
325 #endif /* NON_BLOCKING_CONNECT */
327 /* The largest descriptor currently in use for a process object; -1 if none. */
328 static int max_process_desc;
330 /* The largest descriptor currently in use for input; -1 if none. */
331 static int max_input_desc;
333 /* Indexed by descriptor, gives the process (if any) for that descriptor */
334 static Lisp_Object chan_process[FD_SETSIZE];
336 /* Alist of elements (NAME . PROCESS) */
337 static Lisp_Object Vprocess_alist;
339 /* Buffered-ahead input char from process, indexed by channel.
340 -1 means empty (no char is buffered).
341 Used on sys V where the only way to tell if there is any
342 output from the process is to read at least one char.
343 Always -1 on systems that support FIONREAD. */
345 static int proc_buffered_char[FD_SETSIZE];
347 /* Table of `struct coding-system' for each process. */
348 static struct coding_system *proc_decode_coding_system[FD_SETSIZE];
349 static struct coding_system *proc_encode_coding_system[FD_SETSIZE];
351 #ifdef DATAGRAM_SOCKETS
352 /* Table of `partner address' for datagram sockets. */
353 static struct sockaddr_and_len {
354 struct sockaddr *sa;
355 int len;
356 } datagram_address[FD_SETSIZE];
357 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
358 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
359 #else
360 #define DATAGRAM_CHAN_P(chan) (0)
361 #define DATAGRAM_CONN_P(proc) (0)
362 #endif
364 /* FOR_EACH_PROCESS (LIST_VAR, PROC_VAR) followed by a statement is
365 a `for' loop which iterates over processes from Vprocess_alist. */
367 #define FOR_EACH_PROCESS(list_var, proc_var) \
368 FOR_EACH_ALIST_VALUE (Vprocess_alist, list_var, proc_var)
370 /* These setters are used only in this file, so they can be private. */
371 static void
372 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
374 p->buffer = val;
376 static void
377 pset_command (struct Lisp_Process *p, Lisp_Object val)
379 p->command = val;
381 static void
382 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
384 p->decode_coding_system = val;
386 static void
387 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
389 p->decoding_buf = val;
391 static void
392 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
394 p->encode_coding_system = val;
396 static void
397 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
399 p->encoding_buf = val;
401 static void
402 pset_filter (struct Lisp_Process *p, Lisp_Object val)
404 p->filter = NILP (val) ? Qinternal_default_process_filter : val;
406 static void
407 pset_log (struct Lisp_Process *p, Lisp_Object val)
409 p->log = val;
411 static void
412 pset_mark (struct Lisp_Process *p, Lisp_Object val)
414 p->mark = val;
416 static void
417 pset_name (struct Lisp_Process *p, Lisp_Object val)
419 p->name = val;
421 static void
422 pset_plist (struct Lisp_Process *p, Lisp_Object val)
424 p->plist = val;
426 static void
427 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
429 p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
431 static void
432 pset_status (struct Lisp_Process *p, Lisp_Object val)
434 p->status = val;
436 static void
437 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
439 p->tty_name = val;
441 static void
442 pset_type (struct Lisp_Process *p, Lisp_Object val)
444 p->type = val;
446 static void
447 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
449 p->write_queue = val;
454 static struct fd_callback_data
456 fd_callback func;
457 void *data;
458 #define FOR_READ 1
459 #define FOR_WRITE 2
460 int condition; /* mask of the defines above. */
461 } fd_callback_info[FD_SETSIZE];
464 /* Add a file descriptor FD to be monitored for when read is possible.
465 When read is possible, call FUNC with argument DATA. */
467 void
468 add_read_fd (int fd, fd_callback func, void *data)
470 eassert (fd < FD_SETSIZE);
471 add_keyboard_wait_descriptor (fd);
473 fd_callback_info[fd].func = func;
474 fd_callback_info[fd].data = data;
475 fd_callback_info[fd].condition |= FOR_READ;
478 /* Stop monitoring file descriptor FD for when read is possible. */
480 void
481 delete_read_fd (int fd)
483 eassert (fd < FD_SETSIZE);
484 delete_keyboard_wait_descriptor (fd);
486 fd_callback_info[fd].condition &= ~FOR_READ;
487 if (fd_callback_info[fd].condition == 0)
489 fd_callback_info[fd].func = 0;
490 fd_callback_info[fd].data = 0;
494 /* Add a file descriptor FD to be monitored for when write is possible.
495 When write is possible, call FUNC with argument DATA. */
497 void
498 add_write_fd (int fd, fd_callback func, void *data)
500 eassert (fd < FD_SETSIZE);
501 FD_SET (fd, &write_mask);
502 if (fd > max_input_desc)
503 max_input_desc = fd;
505 fd_callback_info[fd].func = func;
506 fd_callback_info[fd].data = data;
507 fd_callback_info[fd].condition |= FOR_WRITE;
510 /* FD is no longer an input descriptor; update max_input_desc accordingly. */
512 static void
513 delete_input_desc (int fd)
515 if (fd == max_input_desc)
518 fd--;
519 while (0 <= fd && ! (FD_ISSET (fd, &input_wait_mask)
520 || FD_ISSET (fd, &write_mask)));
522 max_input_desc = fd;
526 /* Stop monitoring file descriptor FD for when write is possible. */
528 void
529 delete_write_fd (int fd)
531 eassert (fd < FD_SETSIZE);
532 FD_CLR (fd, &write_mask);
533 fd_callback_info[fd].condition &= ~FOR_WRITE;
534 if (fd_callback_info[fd].condition == 0)
536 fd_callback_info[fd].func = 0;
537 fd_callback_info[fd].data = 0;
538 delete_input_desc (fd);
543 /* Compute the Lisp form of the process status, p->status, from
544 the numeric status that was returned by `wait'. */
546 static Lisp_Object status_convert (int);
548 static void
549 update_status (struct Lisp_Process *p)
551 eassert (p->raw_status_new);
552 pset_status (p, status_convert (p->raw_status));
553 p->raw_status_new = 0;
556 /* Convert a process status word in Unix format to
557 the list that we use internally. */
559 static Lisp_Object
560 status_convert (int w)
562 if (WIFSTOPPED (w))
563 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
564 else if (WIFEXITED (w))
565 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
566 WCOREDUMP (w) ? Qt : Qnil));
567 else if (WIFSIGNALED (w))
568 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
569 WCOREDUMP (w) ? Qt : Qnil));
570 else
571 return Qrun;
574 /* Given a status-list, extract the three pieces of information
575 and store them individually through the three pointers. */
577 static void
578 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
580 Lisp_Object tem;
582 if (SYMBOLP (l))
584 *symbol = l;
585 *code = 0;
586 *coredump = 0;
588 else
590 *symbol = XCAR (l);
591 tem = XCDR (l);
592 *code = XFASTINT (XCAR (tem));
593 tem = XCDR (tem);
594 *coredump = !NILP (tem);
598 /* Return a string describing a process status list. */
600 static Lisp_Object
601 status_message (struct Lisp_Process *p)
603 Lisp_Object status = p->status;
604 Lisp_Object symbol;
605 int code;
606 bool coredump;
607 Lisp_Object string, string2;
609 decode_status (status, &symbol, &code, &coredump);
611 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
613 char const *signame;
614 synchronize_system_messages_locale ();
615 signame = strsignal (code);
616 if (signame == 0)
617 string = build_string ("unknown");
618 else
620 int c1, c2;
622 string = build_unibyte_string (signame);
623 if (! NILP (Vlocale_coding_system))
624 string = (code_convert_string_norecord
625 (string, Vlocale_coding_system, 0));
626 c1 = STRING_CHAR (SDATA (string));
627 c2 = downcase (c1);
628 if (c1 != c2)
629 Faset (string, make_number (0), make_number (c2));
631 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
632 return concat2 (string, string2);
634 else if (EQ (symbol, Qexit))
636 if (NETCONN1_P (p))
637 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
638 if (code == 0)
639 return build_string ("finished\n");
640 string = Fnumber_to_string (make_number (code));
641 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
642 return concat3 (build_string ("exited abnormally with code "),
643 string, string2);
645 else if (EQ (symbol, Qfailed))
647 string = Fnumber_to_string (make_number (code));
648 string2 = build_string ("\n");
649 return concat3 (build_string ("failed with code "),
650 string, string2);
652 else
653 return Fcopy_sequence (Fsymbol_name (symbol));
656 enum { PTY_NAME_SIZE = 24 };
658 /* Open an available pty, returning a file descriptor.
659 Store into PTY_NAME the file name of the terminal corresponding to the pty.
660 Return -1 on failure. */
662 static int
663 allocate_pty (char pty_name[PTY_NAME_SIZE])
665 #ifdef HAVE_PTYS
666 int fd;
668 #ifdef PTY_ITERATION
669 PTY_ITERATION
670 #else
671 register int c, i;
672 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
673 for (i = 0; i < 16; i++)
674 #endif
676 #ifdef PTY_NAME_SPRINTF
677 PTY_NAME_SPRINTF
678 #else
679 sprintf (pty_name, "/dev/pty%c%x", c, i);
680 #endif /* no PTY_NAME_SPRINTF */
682 #ifdef PTY_OPEN
683 PTY_OPEN;
684 #else /* no PTY_OPEN */
685 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
686 #endif /* no PTY_OPEN */
688 if (fd >= 0)
690 #ifdef PTY_OPEN
691 /* Set FD's close-on-exec flag. This is needed even if
692 PT_OPEN calls posix_openpt with O_CLOEXEC, since POSIX
693 doesn't require support for that combination.
694 Multithreaded platforms where posix_openpt ignores
695 O_CLOEXEC (or where PTY_OPEN doesn't call posix_openpt)
696 have a race condition between the PTY_OPEN and here. */
697 fcntl (fd, F_SETFD, FD_CLOEXEC);
698 #endif
699 /* check to make certain that both sides are available
700 this avoids a nasty yet stupid bug in rlogins */
701 #ifdef PTY_TTY_NAME_SPRINTF
702 PTY_TTY_NAME_SPRINTF
703 #else
704 sprintf (pty_name, "/dev/tty%c%x", c, i);
705 #endif /* no PTY_TTY_NAME_SPRINTF */
706 if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
708 emacs_close (fd);
709 # ifndef __sgi
710 continue;
711 # else
712 return -1;
713 # endif /* __sgi */
715 setup_pty (fd);
716 return fd;
719 #endif /* HAVE_PTYS */
720 return -1;
723 static Lisp_Object
724 make_process (Lisp_Object name)
726 register Lisp_Object val, tem, name1;
727 register struct Lisp_Process *p;
728 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
729 printmax_t i;
731 p = allocate_process ();
732 /* Initialize Lisp data. Note that allocate_process initializes all
733 Lisp data to nil, so do it only for slots which should not be nil. */
734 pset_status (p, Qrun);
735 pset_mark (p, Fmake_marker ());
737 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
738 non-Lisp data, so do it only for slots which should not be zero. */
739 p->infd = -1;
740 p->outfd = -1;
741 for (i = 0; i < PROCESS_OPEN_FDS; i++)
742 p->open_fd[i] = -1;
744 #ifdef HAVE_GNUTLS
745 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
746 #endif
748 /* If name is already in use, modify it until it is unused. */
750 name1 = name;
751 for (i = 1; ; i++)
753 tem = Fget_process (name1);
754 if (NILP (tem)) break;
755 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
757 name = name1;
758 pset_name (p, name);
759 pset_sentinel (p, Qinternal_default_process_sentinel);
760 pset_filter (p, Qinternal_default_process_filter);
761 XSETPROCESS (val, p);
762 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
763 return val;
766 static void
767 remove_process (register Lisp_Object proc)
769 register Lisp_Object pair;
771 pair = Frassq (proc, Vprocess_alist);
772 Vprocess_alist = Fdelq (pair, Vprocess_alist);
774 deactivate_process (proc);
778 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
779 doc: /* Return t if OBJECT is a process. */)
780 (Lisp_Object object)
782 return PROCESSP (object) ? Qt : Qnil;
785 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
786 doc: /* Return the process named NAME, or nil if there is none. */)
787 (register Lisp_Object name)
789 if (PROCESSP (name))
790 return name;
791 CHECK_STRING (name);
792 return Fcdr (Fassoc (name, Vprocess_alist));
795 /* This is how commands for the user decode process arguments. It
796 accepts a process, a process name, a buffer, a buffer name, or nil.
797 Buffers denote the first process in the buffer, and nil denotes the
798 current buffer. */
800 static Lisp_Object
801 get_process (register Lisp_Object name)
803 register Lisp_Object proc, obj;
804 if (STRINGP (name))
806 obj = Fget_process (name);
807 if (NILP (obj))
808 obj = Fget_buffer (name);
809 if (NILP (obj))
810 error ("Process %s does not exist", SDATA (name));
812 else if (NILP (name))
813 obj = Fcurrent_buffer ();
814 else
815 obj = name;
817 /* Now obj should be either a buffer object or a process object.
819 if (BUFFERP (obj))
821 proc = Fget_buffer_process (obj);
822 if (NILP (proc))
823 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
825 else
827 CHECK_PROCESS (obj);
828 proc = obj;
830 return proc;
834 /* Fdelete_process promises to immediately forget about the process, but in
835 reality, Emacs needs to remember those processes until they have been
836 treated by the SIGCHLD handler and waitpid has been invoked on them;
837 otherwise they might fill up the kernel's process table.
839 Some processes created by call-process are also put onto this list.
841 Members of this list are (process-ID . filename) pairs. The
842 process-ID is a number; the filename, if a string, is a file that
843 needs to be removed after the process exits. */
844 static Lisp_Object deleted_pid_list;
846 void
847 record_deleted_pid (pid_t pid, Lisp_Object filename)
849 deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
850 /* GC treated elements set to nil. */
851 Fdelq (Qnil, deleted_pid_list));
855 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
856 doc: /* Delete PROCESS: kill it and forget about it immediately.
857 PROCESS may be a process, a buffer, the name of a process or buffer, or
858 nil, indicating the current buffer's process. */)
859 (register Lisp_Object process)
861 register struct Lisp_Process *p;
863 process = get_process (process);
864 p = XPROCESS (process);
866 p->raw_status_new = 0;
867 if (NETCONN1_P (p) || SERIALCONN1_P (p))
869 pset_status (p, list2 (Qexit, make_number (0)));
870 p->tick = ++process_tick;
871 status_notify (p);
872 redisplay_preserve_echo_area (13);
874 else
876 if (p->alive)
877 record_kill_process (p, Qnil);
879 if (p->infd >= 0)
881 /* Update P's status, since record_kill_process will make the
882 SIGCHLD handler update deleted_pid_list, not *P. */
883 Lisp_Object symbol;
884 if (p->raw_status_new)
885 update_status (p);
886 symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
887 if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
888 pset_status (p, list2 (Qsignal, make_number (SIGKILL)));
890 p->tick = ++process_tick;
891 status_notify (p);
892 redisplay_preserve_echo_area (13);
895 remove_process (process);
896 return Qnil;
899 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
900 doc: /* Return the status of PROCESS.
901 The returned value is one of the following symbols:
902 run -- for a process that is running.
903 stop -- for a process stopped but continuable.
904 exit -- for a process that has exited.
905 signal -- for a process that has got a fatal signal.
906 open -- for a network stream connection that is open.
907 listen -- for a network stream server that is listening.
908 closed -- for a network stream connection that is closed.
909 connect -- when waiting for a non-blocking connection to complete.
910 failed -- when a non-blocking connection has failed.
911 nil -- if arg is a process name and no such process exists.
912 PROCESS may be a process, a buffer, the name of a process, or
913 nil, indicating the current buffer's process. */)
914 (register Lisp_Object process)
916 register struct Lisp_Process *p;
917 register Lisp_Object status;
919 if (STRINGP (process))
920 process = Fget_process (process);
921 else
922 process = get_process (process);
924 if (NILP (process))
925 return process;
927 p = XPROCESS (process);
928 if (p->raw_status_new)
929 update_status (p);
930 status = p->status;
931 if (CONSP (status))
932 status = XCAR (status);
933 if (NETCONN1_P (p) || SERIALCONN1_P (p))
935 if (EQ (status, Qexit))
936 status = Qclosed;
937 else if (EQ (p->command, Qt))
938 status = Qstop;
939 else if (EQ (status, Qrun))
940 status = Qopen;
942 return status;
945 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
946 1, 1, 0,
947 doc: /* Return the exit status of PROCESS or the signal number that killed it.
948 If PROCESS has not yet exited or died, return 0. */)
949 (register Lisp_Object process)
951 CHECK_PROCESS (process);
952 if (XPROCESS (process)->raw_status_new)
953 update_status (XPROCESS (process));
954 if (CONSP (XPROCESS (process)->status))
955 return XCAR (XCDR (XPROCESS (process)->status));
956 return make_number (0);
959 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
960 doc: /* Return the process id of PROCESS.
961 This is the pid of the external process which PROCESS uses or talks to.
962 For a network connection, this value is nil. */)
963 (register Lisp_Object process)
965 pid_t pid;
967 CHECK_PROCESS (process);
968 pid = XPROCESS (process)->pid;
969 return (pid ? make_fixnum_or_float (pid) : Qnil);
972 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
973 doc: /* Return the name of PROCESS, as a string.
974 This is the name of the program invoked in PROCESS,
975 possibly modified to make it unique among process names. */)
976 (register Lisp_Object process)
978 CHECK_PROCESS (process);
979 return XPROCESS (process)->name;
982 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
983 doc: /* Return the command that was executed to start PROCESS.
984 This is a list of strings, the first string being the program executed
985 and the rest of the strings being the arguments given to it.
986 For a network or serial process, this is nil (process is running) or t
987 \(process is stopped). */)
988 (register Lisp_Object process)
990 CHECK_PROCESS (process);
991 return XPROCESS (process)->command;
994 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
995 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
996 This is the terminal that the process itself reads and writes on,
997 not the name of the pty that Emacs uses to talk with that terminal. */)
998 (register Lisp_Object process)
1000 CHECK_PROCESS (process);
1001 return XPROCESS (process)->tty_name;
1004 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
1005 2, 2, 0,
1006 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
1007 Return BUFFER. */)
1008 (register Lisp_Object process, Lisp_Object buffer)
1010 struct Lisp_Process *p;
1012 CHECK_PROCESS (process);
1013 if (!NILP (buffer))
1014 CHECK_BUFFER (buffer);
1015 p = XPROCESS (process);
1016 pset_buffer (p, buffer);
1017 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1018 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
1019 setup_process_coding_systems (process);
1020 return buffer;
1023 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
1024 1, 1, 0,
1025 doc: /* Return the buffer PROCESS is associated with.
1026 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
1027 (register Lisp_Object process)
1029 CHECK_PROCESS (process);
1030 return XPROCESS (process)->buffer;
1033 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1034 1, 1, 0,
1035 doc: /* Return the marker for the end of the last output from PROCESS. */)
1036 (register Lisp_Object process)
1038 CHECK_PROCESS (process);
1039 return XPROCESS (process)->mark;
1042 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1043 2, 2, 0,
1044 doc: /* Give PROCESS the filter function FILTER; nil means default.
1045 A value of t means stop accepting output from the process.
1047 When a process has a non-default filter, its buffer is not used for output.
1048 Instead, each time it does output, the entire string of output is
1049 passed to the filter.
1051 The filter gets two arguments: the process and the string of output.
1052 The string argument is normally a multibyte string, except:
1053 - if the process' input coding system is no-conversion or raw-text,
1054 it is a unibyte string (the non-converted input), or else
1055 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1056 string (the result of converting the decoded input multibyte
1057 string to unibyte with `string-make-unibyte'). */)
1058 (register Lisp_Object process, Lisp_Object filter)
1060 struct Lisp_Process *p;
1062 CHECK_PROCESS (process);
1063 p = XPROCESS (process);
1065 /* Don't signal an error if the process' input file descriptor
1066 is closed. This could make debugging Lisp more difficult,
1067 for example when doing something like
1069 (setq process (start-process ...))
1070 (debug)
1071 (set-process-filter process ...) */
1073 if (NILP (filter))
1074 filter = Qinternal_default_process_filter;
1076 if (p->infd >= 0)
1078 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1080 FD_CLR (p->infd, &input_wait_mask);
1081 FD_CLR (p->infd, &non_keyboard_wait_mask);
1083 else if (EQ (p->filter, Qt)
1084 /* Network or serial process not stopped: */
1085 && !EQ (p->command, Qt))
1087 FD_SET (p->infd, &input_wait_mask);
1088 FD_SET (p->infd, &non_keyboard_wait_mask);
1092 pset_filter (p, filter);
1093 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1094 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1095 setup_process_coding_systems (process);
1096 return filter;
1099 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1100 1, 1, 0,
1101 doc: /* Return the filter function of PROCESS.
1102 See `set-process-filter' for more info on filter functions. */)
1103 (register Lisp_Object process)
1105 CHECK_PROCESS (process);
1106 return XPROCESS (process)->filter;
1109 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1110 2, 2, 0,
1111 doc: /* Give PROCESS the sentinel SENTINEL; nil for default.
1112 The sentinel is called as a function when the process changes state.
1113 It gets two arguments: the process, and a string describing the change. */)
1114 (register Lisp_Object process, Lisp_Object sentinel)
1116 struct Lisp_Process *p;
1118 CHECK_PROCESS (process);
1119 p = XPROCESS (process);
1121 if (NILP (sentinel))
1122 sentinel = Qinternal_default_process_sentinel;
1124 pset_sentinel (p, sentinel);
1125 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1126 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1127 return sentinel;
1130 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1131 1, 1, 0,
1132 doc: /* Return the sentinel of PROCESS.
1133 See `set-process-sentinel' for more info on sentinels. */)
1134 (register Lisp_Object process)
1136 CHECK_PROCESS (process);
1137 return XPROCESS (process)->sentinel;
1140 DEFUN ("set-process-window-size", Fset_process_window_size,
1141 Sset_process_window_size, 3, 3, 0,
1142 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1143 (Lisp_Object process, Lisp_Object height, Lisp_Object width)
1145 CHECK_PROCESS (process);
1147 /* All known platforms store window sizes as 'unsigned short'. */
1148 CHECK_RANGED_INTEGER (height, 0, USHRT_MAX);
1149 CHECK_RANGED_INTEGER (width, 0, USHRT_MAX);
1151 if (XPROCESS (process)->infd < 0
1152 || (set_window_size (XPROCESS (process)->infd,
1153 XINT (height), XINT (width))
1154 < 0))
1155 return Qnil;
1156 else
1157 return Qt;
1160 DEFUN ("set-process-inherit-coding-system-flag",
1161 Fset_process_inherit_coding_system_flag,
1162 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1163 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1164 If the second argument FLAG is non-nil, then the variable
1165 `buffer-file-coding-system' of the buffer associated with PROCESS
1166 will be bound to the value of the coding system used to decode
1167 the process output.
1169 This is useful when the coding system specified for the process buffer
1170 leaves either the character code conversion or the end-of-line conversion
1171 unspecified, or if the coding system used to decode the process output
1172 is more appropriate for saving the process buffer.
1174 Binding the variable `inherit-process-coding-system' to non-nil before
1175 starting the process is an alternative way of setting the inherit flag
1176 for the process which will run.
1178 This function returns FLAG. */)
1179 (register Lisp_Object process, Lisp_Object flag)
1181 CHECK_PROCESS (process);
1182 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1183 return flag;
1186 DEFUN ("set-process-query-on-exit-flag",
1187 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1188 2, 2, 0,
1189 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1190 If the second argument FLAG is non-nil, Emacs will query the user before
1191 exiting or killing a buffer if PROCESS is running. This function
1192 returns FLAG. */)
1193 (register Lisp_Object process, Lisp_Object flag)
1195 CHECK_PROCESS (process);
1196 XPROCESS (process)->kill_without_query = NILP (flag);
1197 return flag;
1200 DEFUN ("process-query-on-exit-flag",
1201 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1202 1, 1, 0,
1203 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1204 (register Lisp_Object process)
1206 CHECK_PROCESS (process);
1207 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1210 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1211 1, 2, 0,
1212 doc: /* Return the contact info of PROCESS; t for a real child.
1213 For a network or serial connection, the value depends on the optional
1214 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1215 SERVICE) for a network connection or (PORT SPEED) for a serial
1216 connection. If KEY is t, the complete contact information for the
1217 connection is returned, else the specific value for the keyword KEY is
1218 returned. See `make-network-process' or `make-serial-process' for a
1219 list of keywords. */)
1220 (register Lisp_Object process, Lisp_Object key)
1222 Lisp_Object contact;
1224 CHECK_PROCESS (process);
1225 contact = XPROCESS (process)->childp;
1227 #ifdef DATAGRAM_SOCKETS
1228 if (DATAGRAM_CONN_P (process)
1229 && (EQ (key, Qt) || EQ (key, QCremote)))
1230 contact = Fplist_put (contact, QCremote,
1231 Fprocess_datagram_address (process));
1232 #endif
1234 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1235 return contact;
1236 if (NILP (key) && NETCONN_P (process))
1237 return list2 (Fplist_get (contact, QChost),
1238 Fplist_get (contact, QCservice));
1239 if (NILP (key) && SERIALCONN_P (process))
1240 return list2 (Fplist_get (contact, QCport),
1241 Fplist_get (contact, QCspeed));
1242 return Fplist_get (contact, key);
1245 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1246 1, 1, 0,
1247 doc: /* Return the plist of PROCESS. */)
1248 (register Lisp_Object process)
1250 CHECK_PROCESS (process);
1251 return XPROCESS (process)->plist;
1254 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1255 2, 2, 0,
1256 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1257 (register Lisp_Object process, Lisp_Object plist)
1259 CHECK_PROCESS (process);
1260 CHECK_LIST (plist);
1262 pset_plist (XPROCESS (process), plist);
1263 return plist;
1266 #if 0 /* Turned off because we don't currently record this info
1267 in the process. Perhaps add it. */
1268 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1269 doc: /* Return the connection type of PROCESS.
1270 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1271 a socket connection. */)
1272 (Lisp_Object process)
1274 return XPROCESS (process)->type;
1276 #endif
1278 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1279 doc: /* Return the connection type of PROCESS.
1280 The value is either the symbol `real', `network', or `serial'.
1281 PROCESS may be a process, a buffer, the name of a process or buffer, or
1282 nil, indicating the current buffer's process. */)
1283 (Lisp_Object process)
1285 Lisp_Object proc;
1286 proc = get_process (process);
1287 return XPROCESS (proc)->type;
1290 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1291 1, 2, 0,
1292 doc: /* Convert network ADDRESS from internal format to a string.
1293 A 4 or 5 element vector represents an IPv4 address (with port number).
1294 An 8 or 9 element vector represents an IPv6 address (with port number).
1295 If optional second argument OMIT-PORT is non-nil, don't include a port
1296 number in the string, even when present in ADDRESS.
1297 Returns nil if format of ADDRESS is invalid. */)
1298 (Lisp_Object address, Lisp_Object omit_port)
1300 if (NILP (address))
1301 return Qnil;
1303 if (STRINGP (address)) /* AF_LOCAL */
1304 return address;
1306 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1308 register struct Lisp_Vector *p = XVECTOR (address);
1309 ptrdiff_t size = p->header.size;
1310 Lisp_Object args[10];
1311 int nargs, i;
1313 if (size == 4 || (size == 5 && !NILP (omit_port)))
1315 args[0] = build_string ("%d.%d.%d.%d");
1316 nargs = 4;
1318 else if (size == 5)
1320 args[0] = build_string ("%d.%d.%d.%d:%d");
1321 nargs = 5;
1323 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1325 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1326 nargs = 8;
1328 else if (size == 9)
1330 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1331 nargs = 9;
1333 else
1334 return Qnil;
1336 for (i = 0; i < nargs; i++)
1338 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1339 return Qnil;
1341 if (nargs <= 5 /* IPv4 */
1342 && i < 4 /* host, not port */
1343 && XINT (p->contents[i]) > 255)
1344 return Qnil;
1346 args[i+1] = p->contents[i];
1349 return Fformat (nargs+1, args);
1352 if (CONSP (address))
1354 Lisp_Object args[2];
1355 args[0] = build_string ("<Family %d>");
1356 args[1] = Fcar (address);
1357 return Fformat (2, args);
1360 return Qnil;
1363 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1364 doc: /* Return a list of all processes that are Emacs sub-processes. */)
1365 (void)
1367 return Fmapcar (Qcdr, Vprocess_alist);
1370 /* Starting asynchronous inferior processes. */
1372 static void start_process_unwind (Lisp_Object proc);
1374 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1375 doc: /* Start a program in a subprocess. Return the process object for it.
1376 NAME is name for process. It is modified if necessary to make it unique.
1377 BUFFER is the buffer (or buffer name) to associate with the process.
1379 Process output (both standard output and standard error streams) goes
1380 at end of BUFFER, unless you specify an output stream or filter
1381 function to handle the output. BUFFER may also be nil, meaning that
1382 this process is not associated with any buffer.
1384 PROGRAM is the program file name. It is searched for in `exec-path'
1385 (which see). If nil, just associate a pty with the buffer. Remaining
1386 arguments are strings to give program as arguments.
1388 If you want to separate standard output from standard error, invoke
1389 the command through a shell and redirect one of them using the shell
1390 syntax.
1392 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1393 (ptrdiff_t nargs, Lisp_Object *args)
1395 Lisp_Object buffer, name, program, proc, current_dir, tem;
1396 register unsigned char **new_argv;
1397 ptrdiff_t i;
1398 ptrdiff_t count = SPECPDL_INDEX ();
1400 buffer = args[1];
1401 if (!NILP (buffer))
1402 buffer = Fget_buffer_create (buffer);
1404 /* Make sure that the child will be able to chdir to the current
1405 buffer's current directory, or its unhandled equivalent. We
1406 can't just have the child check for an error when it does the
1407 chdir, since it's in a vfork.
1409 We have to GCPRO around this because Fexpand_file_name and
1410 Funhandled_file_name_directory might call a file name handling
1411 function. The argument list is protected by the caller, so all
1412 we really have to worry about is buffer. */
1414 struct gcpro gcpro1;
1415 GCPRO1 (buffer);
1416 current_dir = encode_current_directory ();
1417 UNGCPRO;
1420 name = args[0];
1421 CHECK_STRING (name);
1423 program = args[2];
1425 if (!NILP (program))
1426 CHECK_STRING (program);
1428 proc = make_process (name);
1429 /* If an error occurs and we can't start the process, we want to
1430 remove it from the process list. This means that each error
1431 check in create_process doesn't need to call remove_process
1432 itself; it's all taken care of here. */
1433 record_unwind_protect (start_process_unwind, proc);
1435 pset_childp (XPROCESS (proc), Qt);
1436 pset_plist (XPROCESS (proc), Qnil);
1437 pset_type (XPROCESS (proc), Qreal);
1438 pset_buffer (XPROCESS (proc), buffer);
1439 pset_sentinel (XPROCESS (proc), Qinternal_default_process_sentinel);
1440 pset_filter (XPROCESS (proc), Qinternal_default_process_filter);
1441 pset_command (XPROCESS (proc), Flist (nargs - 2, args + 2));
1443 #ifdef HAVE_GNUTLS
1444 /* AKA GNUTLS_INITSTAGE(proc). */
1445 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1446 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1447 #endif
1449 #ifdef ADAPTIVE_READ_BUFFERING
1450 XPROCESS (proc)->adaptive_read_buffering
1451 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1452 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1453 #endif
1455 /* Make the process marker point into the process buffer (if any). */
1456 if (BUFFERP (buffer))
1457 set_marker_both (XPROCESS (proc)->mark, buffer,
1458 BUF_ZV (XBUFFER (buffer)),
1459 BUF_ZV_BYTE (XBUFFER (buffer)));
1462 /* Decide coding systems for communicating with the process. Here
1463 we don't setup the structure coding_system nor pay attention to
1464 unibyte mode. They are done in create_process. */
1466 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1467 Lisp_Object coding_systems = Qt;
1468 Lisp_Object val, *args2;
1469 struct gcpro gcpro1, gcpro2;
1471 val = Vcoding_system_for_read;
1472 if (NILP (val))
1474 args2 = alloca ((nargs + 1) * sizeof *args2);
1475 args2[0] = Qstart_process;
1476 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1477 GCPRO2 (proc, current_dir);
1478 if (!NILP (program))
1479 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1480 UNGCPRO;
1481 if (CONSP (coding_systems))
1482 val = XCAR (coding_systems);
1483 else if (CONSP (Vdefault_process_coding_system))
1484 val = XCAR (Vdefault_process_coding_system);
1486 pset_decode_coding_system (XPROCESS (proc), val);
1488 val = Vcoding_system_for_write;
1489 if (NILP (val))
1491 if (EQ (coding_systems, Qt))
1493 args2 = alloca ((nargs + 1) * sizeof *args2);
1494 args2[0] = Qstart_process;
1495 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1496 GCPRO2 (proc, current_dir);
1497 if (!NILP (program))
1498 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1499 UNGCPRO;
1501 if (CONSP (coding_systems))
1502 val = XCDR (coding_systems);
1503 else if (CONSP (Vdefault_process_coding_system))
1504 val = XCDR (Vdefault_process_coding_system);
1506 pset_encode_coding_system (XPROCESS (proc), val);
1507 /* Note: At this moment, the above coding system may leave
1508 text-conversion or eol-conversion unspecified. They will be
1509 decided after we read output from the process and decode it by
1510 some coding system, or just before we actually send a text to
1511 the process. */
1515 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1516 XPROCESS (proc)->decoding_carryover = 0;
1517 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1519 XPROCESS (proc)->inherit_coding_system_flag
1520 = !(NILP (buffer) || !inherit_process_coding_system);
1522 if (!NILP (program))
1524 /* If program file name is not absolute, search our path for it.
1525 Put the name we will really use in TEM. */
1526 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1527 && !(SCHARS (program) > 1
1528 && IS_DEVICE_SEP (SREF (program, 1))))
1530 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1532 tem = Qnil;
1533 GCPRO4 (name, program, buffer, current_dir);
1534 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1535 UNGCPRO;
1536 if (NILP (tem))
1537 report_file_error ("Searching for program", program);
1538 tem = Fexpand_file_name (tem, Qnil);
1540 else
1542 if (!NILP (Ffile_directory_p (program)))
1543 error ("Specified program for new process is a directory");
1544 tem = program;
1547 /* If program file name starts with /: for quoting a magic name,
1548 discard that. */
1549 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1550 && SREF (tem, 1) == ':')
1551 tem = Fsubstring (tem, make_number (2), Qnil);
1554 Lisp_Object arg_encoding = Qnil;
1555 struct gcpro gcpro1;
1556 GCPRO1 (tem);
1558 /* Encode the file name and put it in NEW_ARGV.
1559 That's where the child will use it to execute the program. */
1560 tem = list1 (ENCODE_FILE (tem));
1562 /* Here we encode arguments by the coding system used for sending
1563 data to the process. We don't support using different coding
1564 systems for encoding arguments and for encoding data sent to the
1565 process. */
1567 for (i = 3; i < nargs; i++)
1569 tem = Fcons (args[i], tem);
1570 CHECK_STRING (XCAR (tem));
1571 if (STRING_MULTIBYTE (XCAR (tem)))
1573 if (NILP (arg_encoding))
1574 arg_encoding = (complement_process_encoding_system
1575 (XPROCESS (proc)->encode_coding_system));
1576 XSETCAR (tem,
1577 code_convert_string_norecord
1578 (XCAR (tem), arg_encoding, 1));
1582 UNGCPRO;
1585 /* Now that everything is encoded we can collect the strings into
1586 NEW_ARGV. */
1587 new_argv = alloca ((nargs - 1) * sizeof *new_argv);
1588 new_argv[nargs - 2] = 0;
1590 for (i = nargs - 2; i-- != 0; )
1592 new_argv[i] = SDATA (XCAR (tem));
1593 tem = XCDR (tem);
1596 create_process (proc, (char **) new_argv, current_dir);
1598 else
1599 create_pty (proc);
1601 return unbind_to (count, proc);
1604 /* This function is the unwind_protect form for Fstart_process. If
1605 PROC doesn't have its pid set, then we know someone has signaled
1606 an error and the process wasn't started successfully, so we should
1607 remove it from the process list. */
1608 static void
1609 start_process_unwind (Lisp_Object proc)
1611 if (!PROCESSP (proc))
1612 emacs_abort ();
1614 /* Was PROC started successfully?
1615 -2 is used for a pty with no process, eg for gdb. */
1616 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1617 remove_process (proc);
1620 /* If *FD_ADDR is nonnegative, close it, and mark it as closed. */
1622 static void
1623 close_process_fd (int *fd_addr)
1625 int fd = *fd_addr;
1626 if (0 <= fd)
1628 *fd_addr = -1;
1629 emacs_close (fd);
1633 /* Indexes of file descriptors in open_fds. */
1634 enum
1636 /* The pipe from Emacs to its subprocess. */
1637 SUBPROCESS_STDIN,
1638 WRITE_TO_SUBPROCESS,
1640 /* The main pipe from the subprocess to Emacs. */
1641 READ_FROM_SUBPROCESS,
1642 SUBPROCESS_STDOUT,
1644 /* The pipe from the subprocess to Emacs that is closed when the
1645 subprocess execs. */
1646 READ_FROM_EXEC_MONITOR,
1647 EXEC_MONITOR_OUTPUT
1650 verify (PROCESS_OPEN_FDS == EXEC_MONITOR_OUTPUT + 1);
1652 static void
1653 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1655 struct Lisp_Process *p = XPROCESS (process);
1656 int inchannel, outchannel;
1657 pid_t pid;
1658 int vfork_errno;
1659 int forkin, forkout;
1660 bool pty_flag = 0;
1661 char pty_name[PTY_NAME_SIZE];
1662 Lisp_Object lisp_pty_name = Qnil;
1664 inchannel = outchannel = -1;
1666 if (!NILP (Vprocess_connection_type))
1667 outchannel = inchannel = allocate_pty (pty_name);
1669 if (inchannel >= 0)
1671 p->open_fd[READ_FROM_SUBPROCESS] = inchannel;
1672 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1673 /* On most USG systems it does not work to open the pty's tty here,
1674 then close it and reopen it in the child. */
1675 /* Don't let this terminal become our controlling terminal
1676 (in case we don't have one). */
1677 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1678 if (forkin < 0)
1679 report_file_error ("Opening pty", Qnil);
1680 p->open_fd[SUBPROCESS_STDIN] = forkin;
1681 #else
1682 forkin = forkout = -1;
1683 #endif /* not USG, or USG_SUBTTY_WORKS */
1684 pty_flag = 1;
1685 lisp_pty_name = build_string (pty_name);
1687 else
1689 if (emacs_pipe (p->open_fd + SUBPROCESS_STDIN) != 0
1690 || emacs_pipe (p->open_fd + READ_FROM_SUBPROCESS) != 0)
1691 report_file_error ("Creating pipe", Qnil);
1692 forkin = p->open_fd[SUBPROCESS_STDIN];
1693 outchannel = p->open_fd[WRITE_TO_SUBPROCESS];
1694 inchannel = p->open_fd[READ_FROM_SUBPROCESS];
1695 forkout = p->open_fd[SUBPROCESS_STDOUT];
1698 #ifndef WINDOWSNT
1699 if (emacs_pipe (p->open_fd + READ_FROM_EXEC_MONITOR) != 0)
1700 report_file_error ("Creating pipe", Qnil);
1701 #endif
1703 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1704 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1706 /* Record this as an active process, with its channels. */
1707 chan_process[inchannel] = process;
1708 p->infd = inchannel;
1709 p->outfd = outchannel;
1711 /* Previously we recorded the tty descriptor used in the subprocess.
1712 It was only used for getting the foreground tty process, so now
1713 we just reopen the device (see emacs_get_tty_pgrp) as this is
1714 more portable (see USG_SUBTTY_WORKS above). */
1716 p->pty_flag = pty_flag;
1717 pset_status (p, Qrun);
1719 FD_SET (inchannel, &input_wait_mask);
1720 FD_SET (inchannel, &non_keyboard_wait_mask);
1721 if (inchannel > max_process_desc)
1722 max_process_desc = inchannel;
1724 /* This may signal an error. */
1725 setup_process_coding_systems (process);
1727 block_input ();
1728 block_child_signal ();
1730 #ifndef WINDOWSNT
1731 /* vfork, and prevent local vars from being clobbered by the vfork. */
1733 Lisp_Object volatile current_dir_volatile = current_dir;
1734 Lisp_Object volatile lisp_pty_name_volatile = lisp_pty_name;
1735 char **volatile new_argv_volatile = new_argv;
1736 int volatile forkin_volatile = forkin;
1737 int volatile forkout_volatile = forkout;
1738 struct Lisp_Process *p_volatile = p;
1740 pid = vfork ();
1742 current_dir = current_dir_volatile;
1743 lisp_pty_name = lisp_pty_name_volatile;
1744 new_argv = new_argv_volatile;
1745 forkin = forkin_volatile;
1746 forkout = forkout_volatile;
1747 p = p_volatile;
1749 pty_flag = p->pty_flag;
1752 if (pid == 0)
1753 #endif /* not WINDOWSNT */
1755 int xforkin = forkin;
1756 int xforkout = forkout;
1758 /* Make the pty be the controlling terminal of the process. */
1759 #ifdef HAVE_PTYS
1760 /* First, disconnect its current controlling terminal. */
1761 /* We tried doing setsid only if pty_flag, but it caused
1762 process_set_signal to fail on SGI when using a pipe. */
1763 setsid ();
1764 /* Make the pty's terminal the controlling terminal. */
1765 if (pty_flag && xforkin >= 0)
1767 #ifdef TIOCSCTTY
1768 /* We ignore the return value
1769 because faith@cs.unc.edu says that is necessary on Linux. */
1770 ioctl (xforkin, TIOCSCTTY, 0);
1771 #endif
1773 #if defined (LDISC1)
1774 if (pty_flag && xforkin >= 0)
1776 struct termios t;
1777 tcgetattr (xforkin, &t);
1778 t.c_lflag = LDISC1;
1779 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1780 emacs_perror ("create_process/tcsetattr LDISC1");
1782 #else
1783 #if defined (NTTYDISC) && defined (TIOCSETD)
1784 if (pty_flag && xforkin >= 0)
1786 /* Use new line discipline. */
1787 int ldisc = NTTYDISC;
1788 ioctl (xforkin, TIOCSETD, &ldisc);
1790 #endif
1791 #endif
1792 #ifdef TIOCNOTTY
1793 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1794 can do TIOCSPGRP only to the process's controlling tty. */
1795 if (pty_flag)
1797 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1798 I can't test it since I don't have 4.3. */
1799 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1800 if (j >= 0)
1802 ioctl (j, TIOCNOTTY, 0);
1803 emacs_close (j);
1806 #endif /* TIOCNOTTY */
1808 #if !defined (DONT_REOPEN_PTY)
1809 /*** There is a suggestion that this ought to be a
1810 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
1811 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1812 that system does seem to need this code, even though
1813 both TIOCSCTTY is defined. */
1814 /* Now close the pty (if we had it open) and reopen it.
1815 This makes the pty the controlling terminal of the subprocess. */
1816 if (pty_flag)
1819 /* I wonder if emacs_close (emacs_open (SSDATA (lisp_pty_name), ...))
1820 would work? */
1821 if (xforkin >= 0)
1822 emacs_close (xforkin);
1823 xforkout = xforkin = emacs_open (SSDATA (lisp_pty_name), O_RDWR, 0);
1825 if (xforkin < 0)
1827 emacs_perror (SSDATA (lisp_pty_name));
1828 _exit (EXIT_CANCELED);
1832 #endif /* not DONT_REOPEN_PTY */
1834 #ifdef SETUP_SLAVE_PTY
1835 if (pty_flag)
1837 SETUP_SLAVE_PTY;
1839 #endif /* SETUP_SLAVE_PTY */
1840 #endif /* HAVE_PTYS */
1842 signal (SIGINT, SIG_DFL);
1843 signal (SIGQUIT, SIG_DFL);
1845 /* Emacs ignores SIGPIPE, but the child should not. */
1846 signal (SIGPIPE, SIG_DFL);
1848 /* Stop blocking SIGCHLD in the child. */
1849 unblock_child_signal ();
1851 if (pty_flag)
1852 child_setup_tty (xforkout);
1853 #ifdef WINDOWSNT
1854 pid = child_setup (xforkin, xforkout, xforkout, new_argv, 1, current_dir);
1855 #else /* not WINDOWSNT */
1856 child_setup (xforkin, xforkout, xforkout, new_argv, 1, current_dir);
1857 #endif /* not WINDOWSNT */
1860 /* Back in the parent process. */
1862 vfork_errno = errno;
1863 p->pid = pid;
1864 if (pid >= 0)
1865 p->alive = 1;
1867 /* Stop blocking in the parent. */
1868 unblock_child_signal ();
1869 unblock_input ();
1871 if (pid < 0)
1872 report_file_errno ("Doing vfork", Qnil, vfork_errno);
1873 else
1875 /* vfork succeeded. */
1877 /* Close the pipe ends that the child uses, or the child's pty. */
1878 close_process_fd (&p->open_fd[SUBPROCESS_STDIN]);
1879 close_process_fd (&p->open_fd[SUBPROCESS_STDOUT]);
1881 #ifdef WINDOWSNT
1882 register_child (pid, inchannel);
1883 #endif /* WINDOWSNT */
1885 pset_tty_name (p, lisp_pty_name);
1887 #ifndef WINDOWSNT
1888 /* Wait for child_setup to complete in case that vfork is
1889 actually defined as fork. The descriptor
1890 XPROCESS (proc)->open_fd[EXEC_MONITOR_OUTPUT]
1891 of a pipe is closed at the child side either by close-on-exec
1892 on successful execve or the _exit call in child_setup. */
1894 char dummy;
1896 close_process_fd (&p->open_fd[EXEC_MONITOR_OUTPUT]);
1897 emacs_read (p->open_fd[READ_FROM_EXEC_MONITOR], &dummy, 1);
1898 close_process_fd (&p->open_fd[READ_FROM_EXEC_MONITOR]);
1900 #endif
1904 static void
1905 create_pty (Lisp_Object process)
1907 struct Lisp_Process *p = XPROCESS (process);
1908 char pty_name[PTY_NAME_SIZE];
1909 int pty_fd = NILP (Vprocess_connection_type) ? -1 : allocate_pty (pty_name);
1911 if (pty_fd >= 0)
1913 p->open_fd[SUBPROCESS_STDIN] = pty_fd;
1914 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1915 /* On most USG systems it does not work to open the pty's tty here,
1916 then close it and reopen it in the child. */
1917 /* Don't let this terminal become our controlling terminal
1918 (in case we don't have one). */
1919 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1920 if (forkout < 0)
1921 report_file_error ("Opening pty", Qnil);
1922 p->open_fd[WRITE_TO_SUBPROCESS] = forkout;
1923 #if defined (DONT_REOPEN_PTY)
1924 /* In the case that vfork is defined as fork, the parent process
1925 (Emacs) may send some data before the child process completes
1926 tty options setup. So we setup tty before forking. */
1927 child_setup_tty (forkout);
1928 #endif /* DONT_REOPEN_PTY */
1929 #endif /* not USG, or USG_SUBTTY_WORKS */
1931 fcntl (pty_fd, F_SETFL, O_NONBLOCK);
1933 /* Record this as an active process, with its channels.
1934 As a result, child_setup will close Emacs's side of the pipes. */
1935 chan_process[pty_fd] = process;
1936 p->infd = pty_fd;
1937 p->outfd = pty_fd;
1939 /* Previously we recorded the tty descriptor used in the subprocess.
1940 It was only used for getting the foreground tty process, so now
1941 we just reopen the device (see emacs_get_tty_pgrp) as this is
1942 more portable (see USG_SUBTTY_WORKS above). */
1944 p->pty_flag = 1;
1945 pset_status (p, Qrun);
1946 setup_process_coding_systems (process);
1948 FD_SET (pty_fd, &input_wait_mask);
1949 FD_SET (pty_fd, &non_keyboard_wait_mask);
1950 if (pty_fd > max_process_desc)
1951 max_process_desc = pty_fd;
1953 pset_tty_name (p, build_string (pty_name));
1956 p->pid = -2;
1960 /* Convert an internal struct sockaddr to a lisp object (vector or string).
1961 The address family of sa is not included in the result. */
1963 static Lisp_Object
1964 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
1966 Lisp_Object address;
1967 int i;
1968 unsigned char *cp;
1969 register struct Lisp_Vector *p;
1971 /* Workaround for a bug in getsockname on BSD: Names bound to
1972 sockets in the UNIX domain are inaccessible; getsockname returns
1973 a zero length name. */
1974 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
1975 return empty_unibyte_string;
1977 switch (sa->sa_family)
1979 case AF_INET:
1981 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
1982 len = sizeof (sin->sin_addr) + 1;
1983 address = Fmake_vector (make_number (len), Qnil);
1984 p = XVECTOR (address);
1985 p->contents[--len] = make_number (ntohs (sin->sin_port));
1986 cp = (unsigned char *) &sin->sin_addr;
1987 break;
1989 #ifdef AF_INET6
1990 case AF_INET6:
1992 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
1993 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
1994 len = sizeof (sin6->sin6_addr)/2 + 1;
1995 address = Fmake_vector (make_number (len), Qnil);
1996 p = XVECTOR (address);
1997 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
1998 for (i = 0; i < len; i++)
1999 p->contents[i] = make_number (ntohs (ip6[i]));
2000 return address;
2002 #endif
2003 #ifdef HAVE_LOCAL_SOCKETS
2004 case AF_LOCAL:
2006 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2007 for (i = 0; i < sizeof (sockun->sun_path); i++)
2008 if (sockun->sun_path[i] == 0)
2009 break;
2010 return make_unibyte_string (sockun->sun_path, i);
2012 #endif
2013 default:
2014 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2015 address = Fcons (make_number (sa->sa_family),
2016 Fmake_vector (make_number (len), Qnil));
2017 p = XVECTOR (XCDR (address));
2018 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2019 break;
2022 i = 0;
2023 while (i < len)
2024 p->contents[i++] = make_number (*cp++);
2026 return address;
2030 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2032 static int
2033 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2035 register struct Lisp_Vector *p;
2037 if (VECTORP (address))
2039 p = XVECTOR (address);
2040 if (p->header.size == 5)
2042 *familyp = AF_INET;
2043 return sizeof (struct sockaddr_in);
2045 #ifdef AF_INET6
2046 else if (p->header.size == 9)
2048 *familyp = AF_INET6;
2049 return sizeof (struct sockaddr_in6);
2051 #endif
2053 #ifdef HAVE_LOCAL_SOCKETS
2054 else if (STRINGP (address))
2056 *familyp = AF_LOCAL;
2057 return sizeof (struct sockaddr_un);
2059 #endif
2060 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2061 && VECTORP (XCDR (address)))
2063 struct sockaddr *sa;
2064 *familyp = XINT (XCAR (address));
2065 p = XVECTOR (XCDR (address));
2066 return p->header.size + sizeof (sa->sa_family);
2068 return 0;
2071 /* Convert an address object (vector or string) to an internal sockaddr.
2073 The address format has been basically validated by
2074 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2075 it could have come from user data. So if FAMILY is not valid,
2076 we return after zeroing *SA. */
2078 static void
2079 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2081 register struct Lisp_Vector *p;
2082 register unsigned char *cp = NULL;
2083 register int i;
2084 EMACS_INT hostport;
2086 memset (sa, 0, len);
2088 if (VECTORP (address))
2090 p = XVECTOR (address);
2091 if (family == AF_INET)
2093 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2094 len = sizeof (sin->sin_addr) + 1;
2095 hostport = XINT (p->contents[--len]);
2096 sin->sin_port = htons (hostport);
2097 cp = (unsigned char *)&sin->sin_addr;
2098 sa->sa_family = family;
2100 #ifdef AF_INET6
2101 else if (family == AF_INET6)
2103 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2104 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2105 len = sizeof (sin6->sin6_addr) + 1;
2106 hostport = XINT (p->contents[--len]);
2107 sin6->sin6_port = htons (hostport);
2108 for (i = 0; i < len; i++)
2109 if (INTEGERP (p->contents[i]))
2111 int j = XFASTINT (p->contents[i]) & 0xffff;
2112 ip6[i] = ntohs (j);
2114 sa->sa_family = family;
2115 return;
2117 #endif
2118 else
2119 return;
2121 else if (STRINGP (address))
2123 #ifdef HAVE_LOCAL_SOCKETS
2124 if (family == AF_LOCAL)
2126 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2127 cp = SDATA (address);
2128 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2129 sockun->sun_path[i] = *cp++;
2130 sa->sa_family = family;
2132 #endif
2133 return;
2135 else
2137 p = XVECTOR (XCDR (address));
2138 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2141 for (i = 0; i < len; i++)
2142 if (INTEGERP (p->contents[i]))
2143 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2146 #ifdef DATAGRAM_SOCKETS
2147 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2148 1, 1, 0,
2149 doc: /* Get the current datagram address associated with PROCESS. */)
2150 (Lisp_Object process)
2152 int channel;
2154 CHECK_PROCESS (process);
2156 if (!DATAGRAM_CONN_P (process))
2157 return Qnil;
2159 channel = XPROCESS (process)->infd;
2160 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2161 datagram_address[channel].len);
2164 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2165 2, 2, 0,
2166 doc: /* Set the datagram address for PROCESS to ADDRESS.
2167 Returns nil upon error setting address, ADDRESS otherwise. */)
2168 (Lisp_Object process, Lisp_Object address)
2170 int channel;
2171 int family, len;
2173 CHECK_PROCESS (process);
2175 if (!DATAGRAM_CONN_P (process))
2176 return Qnil;
2178 channel = XPROCESS (process)->infd;
2180 len = get_lisp_to_sockaddr_size (address, &family);
2181 if (len == 0 || datagram_address[channel].len != len)
2182 return Qnil;
2183 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2184 return address;
2186 #endif
2189 static const struct socket_options {
2190 /* The name of this option. Should be lowercase version of option
2191 name without SO_ prefix. */
2192 const char *name;
2193 /* Option level SOL_... */
2194 int optlevel;
2195 /* Option number SO_... */
2196 int optnum;
2197 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2198 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2199 } socket_options[] =
2201 #ifdef SO_BINDTODEVICE
2202 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2203 #endif
2204 #ifdef SO_BROADCAST
2205 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2206 #endif
2207 #ifdef SO_DONTROUTE
2208 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2209 #endif
2210 #ifdef SO_KEEPALIVE
2211 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2212 #endif
2213 #ifdef SO_LINGER
2214 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2215 #endif
2216 #ifdef SO_OOBINLINE
2217 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2218 #endif
2219 #ifdef SO_PRIORITY
2220 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2221 #endif
2222 #ifdef SO_REUSEADDR
2223 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2224 #endif
2225 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2228 /* Set option OPT to value VAL on socket S.
2230 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2231 Signals an error if setting a known option fails.
2234 static int
2235 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2237 char *name;
2238 const struct socket_options *sopt;
2239 int ret = 0;
2241 CHECK_SYMBOL (opt);
2243 name = SSDATA (SYMBOL_NAME (opt));
2244 for (sopt = socket_options; sopt->name; sopt++)
2245 if (strcmp (name, sopt->name) == 0)
2246 break;
2248 switch (sopt->opttype)
2250 case SOPT_BOOL:
2252 int optval;
2253 optval = NILP (val) ? 0 : 1;
2254 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2255 &optval, sizeof (optval));
2256 break;
2259 case SOPT_INT:
2261 int optval;
2262 if (TYPE_RANGED_INTEGERP (int, val))
2263 optval = XINT (val);
2264 else
2265 error ("Bad option value for %s", name);
2266 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2267 &optval, sizeof (optval));
2268 break;
2271 #ifdef SO_BINDTODEVICE
2272 case SOPT_IFNAME:
2274 char devname[IFNAMSIZ+1];
2276 /* This is broken, at least in the Linux 2.4 kernel.
2277 To unbind, the arg must be a zero integer, not the empty string.
2278 This should work on all systems. KFS. 2003-09-23. */
2279 memset (devname, 0, sizeof devname);
2280 if (STRINGP (val))
2282 char *arg = SSDATA (val);
2283 int len = min (strlen (arg), IFNAMSIZ);
2284 memcpy (devname, arg, len);
2286 else if (!NILP (val))
2287 error ("Bad option value for %s", name);
2288 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2289 devname, IFNAMSIZ);
2290 break;
2292 #endif
2294 #ifdef SO_LINGER
2295 case SOPT_LINGER:
2297 struct linger linger;
2299 linger.l_onoff = 1;
2300 linger.l_linger = 0;
2301 if (TYPE_RANGED_INTEGERP (int, val))
2302 linger.l_linger = XINT (val);
2303 else
2304 linger.l_onoff = NILP (val) ? 0 : 1;
2305 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2306 &linger, sizeof (linger));
2307 break;
2309 #endif
2311 default:
2312 return 0;
2315 if (ret < 0)
2317 int setsockopt_errno = errno;
2318 report_file_errno ("Cannot set network option", list2 (opt, val),
2319 setsockopt_errno);
2322 return (1 << sopt->optbit);
2326 DEFUN ("set-network-process-option",
2327 Fset_network_process_option, Sset_network_process_option,
2328 3, 4, 0,
2329 doc: /* For network process PROCESS set option OPTION to value VALUE.
2330 See `make-network-process' for a list of options and values.
2331 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2332 OPTION is not a supported option, return nil instead; otherwise return t. */)
2333 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2335 int s;
2336 struct Lisp_Process *p;
2338 CHECK_PROCESS (process);
2339 p = XPROCESS (process);
2340 if (!NETCONN1_P (p))
2341 error ("Process is not a network process");
2343 s = p->infd;
2344 if (s < 0)
2345 error ("Process is not running");
2347 if (set_socket_option (s, option, value))
2349 pset_childp (p, Fplist_put (p->childp, option, value));
2350 return Qt;
2353 if (NILP (no_error))
2354 error ("Unknown or unsupported option");
2356 return Qnil;
2360 DEFUN ("serial-process-configure",
2361 Fserial_process_configure,
2362 Sserial_process_configure,
2363 0, MANY, 0,
2364 doc: /* Configure speed, bytesize, etc. of a serial process.
2366 Arguments are specified as keyword/argument pairs. Attributes that
2367 are not given are re-initialized from the process's current
2368 configuration (available via the function `process-contact') or set to
2369 reasonable default values. The following arguments are defined:
2371 :process PROCESS
2372 :name NAME
2373 :buffer BUFFER
2374 :port PORT
2375 -- Any of these arguments can be given to identify the process that is
2376 to be configured. If none of these arguments is given, the current
2377 buffer's process is used.
2379 :speed SPEED -- SPEED is the speed of the serial port in bits per
2380 second, also called baud rate. Any value can be given for SPEED, but
2381 most serial ports work only at a few defined values between 1200 and
2382 115200, with 9600 being the most common value. If SPEED is nil, the
2383 serial port is not configured any further, i.e., all other arguments
2384 are ignored. This may be useful for special serial ports such as
2385 Bluetooth-to-serial converters which can only be configured through AT
2386 commands. A value of nil for SPEED can be used only when passed
2387 through `make-serial-process' or `serial-term'.
2389 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2390 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2392 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2393 `odd' (use odd parity), or the symbol `even' (use even parity). If
2394 PARITY is not given, no parity is used.
2396 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2397 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2398 is not given or nil, 1 stopbit is used.
2400 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2401 flowcontrol to be used, which is either nil (don't use flowcontrol),
2402 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2403 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2404 flowcontrol is used.
2406 `serial-process-configure' is called by `make-serial-process' for the
2407 initial configuration of the serial port.
2409 Examples:
2411 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2413 \(serial-process-configure
2414 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2416 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2418 usage: (serial-process-configure &rest ARGS) */)
2419 (ptrdiff_t nargs, Lisp_Object *args)
2421 struct Lisp_Process *p;
2422 Lisp_Object contact = Qnil;
2423 Lisp_Object proc = Qnil;
2424 struct gcpro gcpro1;
2426 contact = Flist (nargs, args);
2427 GCPRO1 (contact);
2429 proc = Fplist_get (contact, QCprocess);
2430 if (NILP (proc))
2431 proc = Fplist_get (contact, QCname);
2432 if (NILP (proc))
2433 proc = Fplist_get (contact, QCbuffer);
2434 if (NILP (proc))
2435 proc = Fplist_get (contact, QCport);
2436 proc = get_process (proc);
2437 p = XPROCESS (proc);
2438 if (!EQ (p->type, Qserial))
2439 error ("Not a serial process");
2441 if (NILP (Fplist_get (p->childp, QCspeed)))
2443 UNGCPRO;
2444 return Qnil;
2447 serial_configure (p, contact);
2449 UNGCPRO;
2450 return Qnil;
2453 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2454 0, MANY, 0,
2455 doc: /* Create and return a serial port process.
2457 In Emacs, serial port connections are represented by process objects,
2458 so input and output work as for subprocesses, and `delete-process'
2459 closes a serial port connection. However, a serial process has no
2460 process id, it cannot be signaled, and the status codes are different
2461 from normal processes.
2463 `make-serial-process' creates a process and a buffer, on which you
2464 probably want to use `process-send-string'. Try \\[serial-term] for
2465 an interactive terminal. See below for examples.
2467 Arguments are specified as keyword/argument pairs. The following
2468 arguments are defined:
2470 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2471 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2472 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2473 the backslashes in strings).
2475 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2476 which this function calls.
2478 :name NAME -- NAME is the name of the process. If NAME is not given,
2479 the value of PORT is used.
2481 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2482 with the process. Process output goes at the end of that buffer,
2483 unless you specify an output stream or filter function to handle the
2484 output. If BUFFER is not given, the value of NAME is used.
2486 :coding CODING -- If CODING is a symbol, it specifies the coding
2487 system used for both reading and writing for this process. If CODING
2488 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2489 ENCODING is used for writing.
2491 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2492 the process is running. If BOOL is not given, query before exiting.
2494 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2495 In the stopped state, a serial process does not accept incoming data,
2496 but you can send outgoing data. The stopped state is cleared by
2497 `continue-process' and set by `stop-process'.
2499 :filter FILTER -- Install FILTER as the process filter.
2501 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2503 :plist PLIST -- Install PLIST as the initial plist of the process.
2505 :bytesize
2506 :parity
2507 :stopbits
2508 :flowcontrol
2509 -- This function calls `serial-process-configure' to handle these
2510 arguments.
2512 The original argument list, possibly modified by later configuration,
2513 is available via the function `process-contact'.
2515 Examples:
2517 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2519 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2521 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2523 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2525 usage: (make-serial-process &rest ARGS) */)
2526 (ptrdiff_t nargs, Lisp_Object *args)
2528 int fd = -1;
2529 Lisp_Object proc, contact, port;
2530 struct Lisp_Process *p;
2531 struct gcpro gcpro1;
2532 Lisp_Object name, buffer;
2533 Lisp_Object tem, val;
2534 ptrdiff_t specpdl_count;
2536 if (nargs == 0)
2537 return Qnil;
2539 contact = Flist (nargs, args);
2540 GCPRO1 (contact);
2542 port = Fplist_get (contact, QCport);
2543 if (NILP (port))
2544 error ("No port specified");
2545 CHECK_STRING (port);
2547 if (NILP (Fplist_member (contact, QCspeed)))
2548 error (":speed not specified");
2549 if (!NILP (Fplist_get (contact, QCspeed)))
2550 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2552 name = Fplist_get (contact, QCname);
2553 if (NILP (name))
2554 name = port;
2555 CHECK_STRING (name);
2556 proc = make_process (name);
2557 specpdl_count = SPECPDL_INDEX ();
2558 record_unwind_protect (remove_process, proc);
2559 p = XPROCESS (proc);
2561 fd = serial_open (port);
2562 p->open_fd[SUBPROCESS_STDIN] = fd;
2563 p->infd = fd;
2564 p->outfd = fd;
2565 if (fd > max_process_desc)
2566 max_process_desc = fd;
2567 chan_process[fd] = proc;
2569 buffer = Fplist_get (contact, QCbuffer);
2570 if (NILP (buffer))
2571 buffer = name;
2572 buffer = Fget_buffer_create (buffer);
2573 pset_buffer (p, buffer);
2575 pset_childp (p, contact);
2576 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2577 pset_type (p, Qserial);
2578 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2579 pset_filter (p, Fplist_get (contact, QCfilter));
2580 pset_log (p, Qnil);
2581 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2582 p->kill_without_query = 1;
2583 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2584 pset_command (p, Qt);
2585 eassert (! p->pty_flag);
2587 if (!EQ (p->command, Qt))
2589 FD_SET (fd, &input_wait_mask);
2590 FD_SET (fd, &non_keyboard_wait_mask);
2593 if (BUFFERP (buffer))
2595 set_marker_both (p->mark, buffer,
2596 BUF_ZV (XBUFFER (buffer)),
2597 BUF_ZV_BYTE (XBUFFER (buffer)));
2600 tem = Fplist_member (contact, QCcoding);
2601 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2602 tem = Qnil;
2604 val = Qnil;
2605 if (!NILP (tem))
2607 val = XCAR (XCDR (tem));
2608 if (CONSP (val))
2609 val = XCAR (val);
2611 else if (!NILP (Vcoding_system_for_read))
2612 val = Vcoding_system_for_read;
2613 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2614 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2615 val = Qnil;
2616 pset_decode_coding_system (p, val);
2618 val = Qnil;
2619 if (!NILP (tem))
2621 val = XCAR (XCDR (tem));
2622 if (CONSP (val))
2623 val = XCDR (val);
2625 else if (!NILP (Vcoding_system_for_write))
2626 val = Vcoding_system_for_write;
2627 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2628 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2629 val = Qnil;
2630 pset_encode_coding_system (p, val);
2632 setup_process_coding_systems (proc);
2633 pset_decoding_buf (p, empty_unibyte_string);
2634 p->decoding_carryover = 0;
2635 pset_encoding_buf (p, empty_unibyte_string);
2636 p->inherit_coding_system_flag
2637 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2639 Fserial_process_configure (nargs, args);
2641 specpdl_ptr = specpdl + specpdl_count;
2643 UNGCPRO;
2644 return proc;
2647 /* Create a network stream/datagram client/server process. Treated
2648 exactly like a normal process when reading and writing. Primary
2649 differences are in status display and process deletion. A network
2650 connection has no PID; you cannot signal it. All you can do is
2651 stop/continue it and deactivate/close it via delete-process */
2653 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2654 0, MANY, 0,
2655 doc: /* Create and return a network server or client process.
2657 In Emacs, network connections are represented by process objects, so
2658 input and output work as for subprocesses and `delete-process' closes
2659 a network connection. However, a network process has no process id,
2660 it cannot be signaled, and the status codes are different from normal
2661 processes.
2663 Arguments are specified as keyword/argument pairs. The following
2664 arguments are defined:
2666 :name NAME -- NAME is name for process. It is modified if necessary
2667 to make it unique.
2669 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2670 with the process. Process output goes at end of that buffer, unless
2671 you specify an output stream or filter function to handle the output.
2672 BUFFER may be also nil, meaning that this process is not associated
2673 with any buffer.
2675 :host HOST -- HOST is name of the host to connect to, or its IP
2676 address. The symbol `local' specifies the local host. If specified
2677 for a server process, it must be a valid name or address for the local
2678 host, and only clients connecting to that address will be accepted.
2680 :service SERVICE -- SERVICE is name of the service desired, or an
2681 integer specifying a port number to connect to. If SERVICE is t,
2682 a random port number is selected for the server. (If Emacs was
2683 compiled with getaddrinfo, a port number can also be specified as a
2684 string, e.g. "80", as well as an integer. This is not portable.)
2686 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2687 stream type connection, `datagram' creates a datagram type connection,
2688 `seqpacket' creates a reliable datagram connection.
2690 :family FAMILY -- FAMILY is the address (and protocol) family for the
2691 service specified by HOST and SERVICE. The default (nil) is to use
2692 whatever address family (IPv4 or IPv6) that is defined for the host
2693 and port number specified by HOST and SERVICE. Other address families
2694 supported are:
2695 local -- for a local (i.e. UNIX) address specified by SERVICE.
2696 ipv4 -- use IPv4 address family only.
2697 ipv6 -- use IPv6 address family only.
2699 :local ADDRESS -- ADDRESS is the local address used for the connection.
2700 This parameter is ignored when opening a client process. When specified
2701 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2703 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2704 connection. This parameter is ignored when opening a stream server
2705 process. For a datagram server process, it specifies the initial
2706 setting of the remote datagram address. When specified for a client
2707 process, the FAMILY, HOST, and SERVICE args are ignored.
2709 The format of ADDRESS depends on the address family:
2710 - An IPv4 address is represented as an vector of integers [A B C D P]
2711 corresponding to numeric IP address A.B.C.D and port number P.
2712 - A local address is represented as a string with the address in the
2713 local address space.
2714 - An "unsupported family" address is represented by a cons (F . AV)
2715 where F is the family number and AV is a vector containing the socket
2716 address data with one element per address data byte. Do not rely on
2717 this format in portable code, as it may depend on implementation
2718 defined constants, data sizes, and data structure alignment.
2720 :coding CODING -- If CODING is a symbol, it specifies the coding
2721 system used for both reading and writing for this process. If CODING
2722 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2723 ENCODING is used for writing.
2725 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2726 return without waiting for the connection to complete; instead, the
2727 sentinel function will be called with second arg matching "open" (if
2728 successful) or "failed" when the connect completes. Default is to use
2729 a blocking connect (i.e. wait) for stream type connections.
2731 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2732 running when Emacs is exited.
2734 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2735 In the stopped state, a server process does not accept new
2736 connections, and a client process does not handle incoming traffic.
2737 The stopped state is cleared by `continue-process' and set by
2738 `stop-process'.
2740 :filter FILTER -- Install FILTER as the process filter.
2742 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2743 process filter are multibyte, otherwise they are unibyte.
2744 If this keyword is not specified, the strings are multibyte if
2745 the default value of `enable-multibyte-characters' is non-nil.
2747 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2749 :log LOG -- Install LOG as the server process log function. This
2750 function is called when the server accepts a network connection from a
2751 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2752 is the server process, CLIENT is the new process for the connection,
2753 and MESSAGE is a string.
2755 :plist PLIST -- Install PLIST as the new process' initial plist.
2757 :server QLEN -- if QLEN is non-nil, create a server process for the
2758 specified FAMILY, SERVICE, and connection type (stream or datagram).
2759 If QLEN is an integer, it is used as the max. length of the server's
2760 pending connection queue (also known as the backlog); the default
2761 queue length is 5. Default is to create a client process.
2763 The following network options can be specified for this connection:
2765 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2766 :dontroute BOOL -- Only send to directly connected hosts.
2767 :keepalive BOOL -- Send keep-alive messages on network stream.
2768 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2769 :oobinline BOOL -- Place out-of-band data in receive data stream.
2770 :priority INT -- Set protocol defined priority for sent packets.
2771 :reuseaddr BOOL -- Allow reusing a recently used local address
2772 (this is allowed by default for a server process).
2773 :bindtodevice NAME -- bind to interface NAME. Using this may require
2774 special privileges on some systems.
2776 Consult the relevant system programmer's manual pages for more
2777 information on using these options.
2780 A server process will listen for and accept connections from clients.
2781 When a client connection is accepted, a new network process is created
2782 for the connection with the following parameters:
2784 - The client's process name is constructed by concatenating the server
2785 process' NAME and a client identification string.
2786 - If the FILTER argument is non-nil, the client process will not get a
2787 separate process buffer; otherwise, the client's process buffer is a newly
2788 created buffer named after the server process' BUFFER name or process
2789 NAME concatenated with the client identification string.
2790 - The connection type and the process filter and sentinel parameters are
2791 inherited from the server process' TYPE, FILTER and SENTINEL.
2792 - The client process' contact info is set according to the client's
2793 addressing information (typically an IP address and a port number).
2794 - The client process' plist is initialized from the server's plist.
2796 Notice that the FILTER and SENTINEL args are never used directly by
2797 the server process. Also, the BUFFER argument is not used directly by
2798 the server process, but via the optional :log function, accepted (and
2799 failed) connections may be logged in the server process' buffer.
2801 The original argument list, modified with the actual connection
2802 information, is available via the `process-contact' function.
2804 usage: (make-network-process &rest ARGS) */)
2805 (ptrdiff_t nargs, Lisp_Object *args)
2807 Lisp_Object proc;
2808 Lisp_Object contact;
2809 struct Lisp_Process *p;
2810 #ifdef HAVE_GETADDRINFO
2811 struct addrinfo ai, *res, *lres;
2812 struct addrinfo hints;
2813 const char *portstring;
2814 char portbuf[128];
2815 #else /* HAVE_GETADDRINFO */
2816 struct _emacs_addrinfo
2818 int ai_family;
2819 int ai_socktype;
2820 int ai_protocol;
2821 int ai_addrlen;
2822 struct sockaddr *ai_addr;
2823 struct _emacs_addrinfo *ai_next;
2824 } ai, *res, *lres;
2825 #endif /* HAVE_GETADDRINFO */
2826 struct sockaddr_in address_in;
2827 #ifdef HAVE_LOCAL_SOCKETS
2828 struct sockaddr_un address_un;
2829 #endif
2830 int port;
2831 int ret = 0;
2832 int xerrno = 0;
2833 int s = -1, outch, inch;
2834 struct gcpro gcpro1;
2835 ptrdiff_t count = SPECPDL_INDEX ();
2836 ptrdiff_t count1;
2837 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2838 Lisp_Object tem;
2839 Lisp_Object name, buffer, host, service, address;
2840 Lisp_Object filter, sentinel;
2841 bool is_non_blocking_client = 0;
2842 bool is_server = 0;
2843 int backlog = 5;
2844 int socktype;
2845 int family = -1;
2847 if (nargs == 0)
2848 return Qnil;
2850 /* Save arguments for process-contact and clone-process. */
2851 contact = Flist (nargs, args);
2852 GCPRO1 (contact);
2854 #ifdef WINDOWSNT
2855 /* Ensure socket support is loaded if available. */
2856 init_winsock (TRUE);
2857 #endif
2859 /* :type TYPE (nil: stream, datagram */
2860 tem = Fplist_get (contact, QCtype);
2861 if (NILP (tem))
2862 socktype = SOCK_STREAM;
2863 #ifdef DATAGRAM_SOCKETS
2864 else if (EQ (tem, Qdatagram))
2865 socktype = SOCK_DGRAM;
2866 #endif
2867 #ifdef HAVE_SEQPACKET
2868 else if (EQ (tem, Qseqpacket))
2869 socktype = SOCK_SEQPACKET;
2870 #endif
2871 else
2872 error ("Unsupported connection type");
2874 /* :server BOOL */
2875 tem = Fplist_get (contact, QCserver);
2876 if (!NILP (tem))
2878 /* Don't support network sockets when non-blocking mode is
2879 not available, since a blocked Emacs is not useful. */
2880 is_server = 1;
2881 if (TYPE_RANGED_INTEGERP (int, tem))
2882 backlog = XINT (tem);
2885 /* Make QCaddress an alias for :local (server) or :remote (client). */
2886 QCaddress = is_server ? QClocal : QCremote;
2888 /* :nowait BOOL */
2889 if (!is_server && socktype != SOCK_DGRAM
2890 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2892 #ifndef NON_BLOCKING_CONNECT
2893 error ("Non-blocking connect not supported");
2894 #else
2895 is_non_blocking_client = 1;
2896 #endif
2899 name = Fplist_get (contact, QCname);
2900 buffer = Fplist_get (contact, QCbuffer);
2901 filter = Fplist_get (contact, QCfilter);
2902 sentinel = Fplist_get (contact, QCsentinel);
2904 CHECK_STRING (name);
2906 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2907 ai.ai_socktype = socktype;
2908 ai.ai_protocol = 0;
2909 ai.ai_next = NULL;
2910 res = &ai;
2912 /* :local ADDRESS or :remote ADDRESS */
2913 address = Fplist_get (contact, QCaddress);
2914 if (!NILP (address))
2916 host = service = Qnil;
2918 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2919 error ("Malformed :address");
2920 ai.ai_family = family;
2921 ai.ai_addr = alloca (ai.ai_addrlen);
2922 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2923 goto open_socket;
2926 /* :family FAMILY -- nil (for Inet), local, or integer. */
2927 tem = Fplist_get (contact, QCfamily);
2928 if (NILP (tem))
2930 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
2931 family = AF_UNSPEC;
2932 #else
2933 family = AF_INET;
2934 #endif
2936 #ifdef HAVE_LOCAL_SOCKETS
2937 else if (EQ (tem, Qlocal))
2938 family = AF_LOCAL;
2939 #endif
2940 #ifdef AF_INET6
2941 else if (EQ (tem, Qipv6))
2942 family = AF_INET6;
2943 #endif
2944 else if (EQ (tem, Qipv4))
2945 family = AF_INET;
2946 else if (TYPE_RANGED_INTEGERP (int, tem))
2947 family = XINT (tem);
2948 else
2949 error ("Unknown address family");
2951 ai.ai_family = family;
2953 /* :service SERVICE -- string, integer (port number), or t (random port). */
2954 service = Fplist_get (contact, QCservice);
2956 /* :host HOST -- hostname, ip address, or 'local for localhost. */
2957 host = Fplist_get (contact, QChost);
2958 if (!NILP (host))
2960 if (EQ (host, Qlocal))
2961 /* Depending on setup, "localhost" may map to different IPv4 and/or
2962 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
2963 host = build_string ("127.0.0.1");
2964 CHECK_STRING (host);
2967 #ifdef HAVE_LOCAL_SOCKETS
2968 if (family == AF_LOCAL)
2970 if (!NILP (host))
2972 message (":family local ignores the :host \"%s\" property",
2973 SDATA (host));
2974 contact = Fplist_put (contact, QChost, Qnil);
2975 host = Qnil;
2977 CHECK_STRING (service);
2978 memset (&address_un, 0, sizeof address_un);
2979 address_un.sun_family = AF_LOCAL;
2980 if (sizeof address_un.sun_path <= SBYTES (service))
2981 error ("Service name too long");
2982 strcpy (address_un.sun_path, SSDATA (service));
2983 ai.ai_addr = (struct sockaddr *) &address_un;
2984 ai.ai_addrlen = sizeof address_un;
2985 goto open_socket;
2987 #endif
2989 /* Slow down polling to every ten seconds.
2990 Some kernels have a bug which causes retrying connect to fail
2991 after a connect. Polling can interfere with gethostbyname too. */
2992 #ifdef POLL_FOR_INPUT
2993 if (socktype != SOCK_DGRAM)
2995 record_unwind_protect_void (run_all_atimers);
2996 bind_polling_period (10);
2998 #endif
3000 #ifdef HAVE_GETADDRINFO
3001 /* If we have a host, use getaddrinfo to resolve both host and service.
3002 Otherwise, use getservbyname to lookup the service. */
3003 if (!NILP (host))
3006 /* SERVICE can either be a string or int.
3007 Convert to a C string for later use by getaddrinfo. */
3008 if (EQ (service, Qt))
3009 portstring = "0";
3010 else if (INTEGERP (service))
3012 sprintf (portbuf, "%"pI"d", XINT (service));
3013 portstring = portbuf;
3015 else
3017 CHECK_STRING (service);
3018 portstring = SSDATA (service);
3021 immediate_quit = 1;
3022 QUIT;
3023 memset (&hints, 0, sizeof (hints));
3024 hints.ai_flags = 0;
3025 hints.ai_family = family;
3026 hints.ai_socktype = socktype;
3027 hints.ai_protocol = 0;
3029 #ifdef HAVE_RES_INIT
3030 res_init ();
3031 #endif
3033 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3034 if (ret)
3035 #ifdef HAVE_GAI_STRERROR
3036 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3037 #else
3038 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3039 #endif
3040 immediate_quit = 0;
3042 goto open_socket;
3044 #endif /* HAVE_GETADDRINFO */
3046 /* We end up here if getaddrinfo is not defined, or in case no hostname
3047 has been specified (e.g. for a local server process). */
3049 if (EQ (service, Qt))
3050 port = 0;
3051 else if (INTEGERP (service))
3052 port = htons ((unsigned short) XINT (service));
3053 else
3055 struct servent *svc_info;
3056 CHECK_STRING (service);
3057 svc_info = getservbyname (SSDATA (service),
3058 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3059 if (svc_info == 0)
3060 error ("Unknown service: %s", SDATA (service));
3061 port = svc_info->s_port;
3064 memset (&address_in, 0, sizeof address_in);
3065 address_in.sin_family = family;
3066 address_in.sin_addr.s_addr = INADDR_ANY;
3067 address_in.sin_port = port;
3069 #ifndef HAVE_GETADDRINFO
3070 if (!NILP (host))
3072 struct hostent *host_info_ptr;
3074 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3075 as it may `hang' Emacs for a very long time. */
3076 immediate_quit = 1;
3077 QUIT;
3079 #ifdef HAVE_RES_INIT
3080 res_init ();
3081 #endif
3083 host_info_ptr = gethostbyname (SDATA (host));
3084 immediate_quit = 0;
3086 if (host_info_ptr)
3088 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3089 host_info_ptr->h_length);
3090 family = host_info_ptr->h_addrtype;
3091 address_in.sin_family = family;
3093 else
3094 /* Attempt to interpret host as numeric inet address */
3096 unsigned long numeric_addr;
3097 numeric_addr = inet_addr (SSDATA (host));
3098 if (numeric_addr == -1)
3099 error ("Unknown host \"%s\"", SDATA (host));
3101 memcpy (&address_in.sin_addr, &numeric_addr,
3102 sizeof (address_in.sin_addr));
3106 #endif /* not HAVE_GETADDRINFO */
3108 ai.ai_family = family;
3109 ai.ai_addr = (struct sockaddr *) &address_in;
3110 ai.ai_addrlen = sizeof address_in;
3112 open_socket:
3114 /* Do this in case we never enter the for-loop below. */
3115 count1 = SPECPDL_INDEX ();
3116 s = -1;
3118 for (lres = res; lres; lres = lres->ai_next)
3120 ptrdiff_t optn;
3121 int optbits;
3123 #ifdef WINDOWSNT
3124 retry_connect:
3125 #endif
3127 s = socket (lres->ai_family, lres->ai_socktype | SOCK_CLOEXEC,
3128 lres->ai_protocol);
3129 if (s < 0)
3131 xerrno = errno;
3132 continue;
3135 #ifdef DATAGRAM_SOCKETS
3136 if (!is_server && socktype == SOCK_DGRAM)
3137 break;
3138 #endif /* DATAGRAM_SOCKETS */
3140 #ifdef NON_BLOCKING_CONNECT
3141 if (is_non_blocking_client)
3143 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3144 if (ret < 0)
3146 xerrno = errno;
3147 emacs_close (s);
3148 s = -1;
3149 continue;
3152 #endif
3154 /* Make us close S if quit. */
3155 record_unwind_protect_int (close_file_unwind, s);
3157 /* Parse network options in the arg list.
3158 We simply ignore anything which isn't a known option (including other keywords).
3159 An error is signaled if setting a known option fails. */
3160 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3161 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3163 if (is_server)
3165 /* Configure as a server socket. */
3167 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3168 explicit :reuseaddr key to override this. */
3169 #ifdef HAVE_LOCAL_SOCKETS
3170 if (family != AF_LOCAL)
3171 #endif
3172 if (!(optbits & (1 << OPIX_REUSEADDR)))
3174 int optval = 1;
3175 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3176 report_file_error ("Cannot set reuse option on server socket", Qnil);
3179 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3180 report_file_error ("Cannot bind server socket", Qnil);
3182 #ifdef HAVE_GETSOCKNAME
3183 if (EQ (service, Qt))
3185 struct sockaddr_in sa1;
3186 socklen_t len1 = sizeof (sa1);
3187 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3189 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3190 service = make_number (ntohs (sa1.sin_port));
3191 contact = Fplist_put (contact, QCservice, service);
3194 #endif
3196 if (socktype != SOCK_DGRAM && listen (s, backlog))
3197 report_file_error ("Cannot listen on server socket", Qnil);
3199 break;
3202 immediate_quit = 1;
3203 QUIT;
3205 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3206 xerrno = errno;
3208 if (ret == 0 || xerrno == EISCONN)
3210 /* The unwind-protect will be discarded afterwards.
3211 Likewise for immediate_quit. */
3212 break;
3215 #ifdef NON_BLOCKING_CONNECT
3216 #ifdef EINPROGRESS
3217 if (is_non_blocking_client && xerrno == EINPROGRESS)
3218 break;
3219 #else
3220 #ifdef EWOULDBLOCK
3221 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3222 break;
3223 #endif
3224 #endif
3225 #endif
3227 #ifndef WINDOWSNT
3228 if (xerrno == EINTR)
3230 /* Unlike most other syscalls connect() cannot be called
3231 again. (That would return EALREADY.) The proper way to
3232 wait for completion is pselect(). */
3233 int sc;
3234 socklen_t len;
3235 fd_set fdset;
3236 retry_select:
3237 FD_ZERO (&fdset);
3238 FD_SET (s, &fdset);
3239 QUIT;
3240 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3241 if (sc == -1)
3243 if (errno == EINTR)
3244 goto retry_select;
3245 else
3246 report_file_error ("Failed select", Qnil);
3248 eassert (sc > 0);
3250 len = sizeof xerrno;
3251 eassert (FD_ISSET (s, &fdset));
3252 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) < 0)
3253 report_file_error ("Failed getsockopt", Qnil);
3254 if (xerrno)
3255 report_file_errno ("Failed connect", Qnil, xerrno);
3256 break;
3258 #endif /* !WINDOWSNT */
3260 immediate_quit = 0;
3262 /* Discard the unwind protect closing S. */
3263 specpdl_ptr = specpdl + count1;
3264 emacs_close (s);
3265 s = -1;
3267 #ifdef WINDOWSNT
3268 if (xerrno == EINTR)
3269 goto retry_connect;
3270 #endif
3273 if (s >= 0)
3275 #ifdef DATAGRAM_SOCKETS
3276 if (socktype == SOCK_DGRAM)
3278 if (datagram_address[s].sa)
3279 emacs_abort ();
3280 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3281 datagram_address[s].len = lres->ai_addrlen;
3282 if (is_server)
3284 Lisp_Object remote;
3285 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3286 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3288 int rfamily, rlen;
3289 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3290 if (rlen != 0 && rfamily == lres->ai_family
3291 && rlen == lres->ai_addrlen)
3292 conv_lisp_to_sockaddr (rfamily, remote,
3293 datagram_address[s].sa, rlen);
3296 else
3297 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3299 #endif
3300 contact = Fplist_put (contact, QCaddress,
3301 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3302 #ifdef HAVE_GETSOCKNAME
3303 if (!is_server)
3305 struct sockaddr_in sa1;
3306 socklen_t len1 = sizeof (sa1);
3307 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3308 contact = Fplist_put (contact, QClocal,
3309 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3311 #endif
3314 immediate_quit = 0;
3316 #ifdef HAVE_GETADDRINFO
3317 if (res != &ai)
3319 block_input ();
3320 freeaddrinfo (res);
3321 unblock_input ();
3323 #endif
3325 if (s < 0)
3327 /* If non-blocking got this far - and failed - assume non-blocking is
3328 not supported after all. This is probably a wrong assumption, but
3329 the normal blocking calls to open-network-stream handles this error
3330 better. */
3331 if (is_non_blocking_client)
3332 return Qnil;
3334 report_file_errno ((is_server
3335 ? "make server process failed"
3336 : "make client process failed"),
3337 contact, xerrno);
3340 inch = s;
3341 outch = s;
3343 if (!NILP (buffer))
3344 buffer = Fget_buffer_create (buffer);
3345 proc = make_process (name);
3347 chan_process[inch] = proc;
3349 fcntl (inch, F_SETFL, O_NONBLOCK);
3351 p = XPROCESS (proc);
3353 pset_childp (p, contact);
3354 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3355 pset_type (p, Qnetwork);
3357 pset_buffer (p, buffer);
3358 pset_sentinel (p, sentinel);
3359 pset_filter (p, filter);
3360 pset_log (p, Fplist_get (contact, QClog));
3361 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3362 p->kill_without_query = 1;
3363 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3364 pset_command (p, Qt);
3365 p->pid = 0;
3367 p->open_fd[SUBPROCESS_STDIN] = inch;
3368 p->infd = inch;
3369 p->outfd = outch;
3371 /* Discard the unwind protect for closing S, if any. */
3372 specpdl_ptr = specpdl + count1;
3374 /* Unwind bind_polling_period and request_sigio. */
3375 unbind_to (count, Qnil);
3377 if (is_server && socktype != SOCK_DGRAM)
3378 pset_status (p, Qlisten);
3380 /* Make the process marker point into the process buffer (if any). */
3381 if (BUFFERP (buffer))
3382 set_marker_both (p->mark, buffer,
3383 BUF_ZV (XBUFFER (buffer)),
3384 BUF_ZV_BYTE (XBUFFER (buffer)));
3386 #ifdef NON_BLOCKING_CONNECT
3387 if (is_non_blocking_client)
3389 /* We may get here if connect did succeed immediately. However,
3390 in that case, we still need to signal this like a non-blocking
3391 connection. */
3392 pset_status (p, Qconnect);
3393 if (!FD_ISSET (inch, &connect_wait_mask))
3395 FD_SET (inch, &connect_wait_mask);
3396 FD_SET (inch, &write_mask);
3397 num_pending_connects++;
3400 else
3401 #endif
3402 /* A server may have a client filter setting of Qt, but it must
3403 still listen for incoming connects unless it is stopped. */
3404 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3405 || (EQ (p->status, Qlisten) && NILP (p->command)))
3407 FD_SET (inch, &input_wait_mask);
3408 FD_SET (inch, &non_keyboard_wait_mask);
3411 if (inch > max_process_desc)
3412 max_process_desc = inch;
3414 tem = Fplist_member (contact, QCcoding);
3415 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3416 tem = Qnil; /* No error message (too late!). */
3419 /* Setup coding systems for communicating with the network stream. */
3420 struct gcpro gcpro1;
3421 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3422 Lisp_Object coding_systems = Qt;
3423 Lisp_Object fargs[5], val;
3425 if (!NILP (tem))
3427 val = XCAR (XCDR (tem));
3428 if (CONSP (val))
3429 val = XCAR (val);
3431 else if (!NILP (Vcoding_system_for_read))
3432 val = Vcoding_system_for_read;
3433 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3434 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3435 /* We dare not decode end-of-line format by setting VAL to
3436 Qraw_text, because the existing Emacs Lisp libraries
3437 assume that they receive bare code including a sequence of
3438 CR LF. */
3439 val = Qnil;
3440 else
3442 if (NILP (host) || NILP (service))
3443 coding_systems = Qnil;
3444 else
3446 fargs[0] = Qopen_network_stream, fargs[1] = name,
3447 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3448 GCPRO1 (proc);
3449 coding_systems = Ffind_operation_coding_system (5, fargs);
3450 UNGCPRO;
3452 if (CONSP (coding_systems))
3453 val = XCAR (coding_systems);
3454 else if (CONSP (Vdefault_process_coding_system))
3455 val = XCAR (Vdefault_process_coding_system);
3456 else
3457 val = Qnil;
3459 pset_decode_coding_system (p, val);
3461 if (!NILP (tem))
3463 val = XCAR (XCDR (tem));
3464 if (CONSP (val))
3465 val = XCDR (val);
3467 else if (!NILP (Vcoding_system_for_write))
3468 val = Vcoding_system_for_write;
3469 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3470 val = Qnil;
3471 else
3473 if (EQ (coding_systems, Qt))
3475 if (NILP (host) || NILP (service))
3476 coding_systems = Qnil;
3477 else
3479 fargs[0] = Qopen_network_stream, fargs[1] = name,
3480 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3481 GCPRO1 (proc);
3482 coding_systems = Ffind_operation_coding_system (5, fargs);
3483 UNGCPRO;
3486 if (CONSP (coding_systems))
3487 val = XCDR (coding_systems);
3488 else if (CONSP (Vdefault_process_coding_system))
3489 val = XCDR (Vdefault_process_coding_system);
3490 else
3491 val = Qnil;
3493 pset_encode_coding_system (p, val);
3495 setup_process_coding_systems (proc);
3497 pset_decoding_buf (p, empty_unibyte_string);
3498 p->decoding_carryover = 0;
3499 pset_encoding_buf (p, empty_unibyte_string);
3501 p->inherit_coding_system_flag
3502 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3504 UNGCPRO;
3505 return proc;
3509 #if defined (HAVE_NET_IF_H)
3511 #ifdef SIOCGIFCONF
3512 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3513 doc: /* Return an alist of all network interfaces and their network address.
3514 Each element is a cons, the car of which is a string containing the
3515 interface name, and the cdr is the network address in internal
3516 format; see the description of ADDRESS in `make-network-process'. */)
3517 (void)
3519 struct ifconf ifconf;
3520 struct ifreq *ifreq;
3521 void *buf = NULL;
3522 ptrdiff_t buf_size = 512;
3523 int s;
3524 Lisp_Object res;
3525 ptrdiff_t count;
3527 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
3528 if (s < 0)
3529 return Qnil;
3530 count = SPECPDL_INDEX ();
3531 record_unwind_protect_int (close_file_unwind, s);
3535 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3536 ifconf.ifc_buf = buf;
3537 ifconf.ifc_len = buf_size;
3538 if (ioctl (s, SIOCGIFCONF, &ifconf))
3540 emacs_close (s);
3541 xfree (buf);
3542 return Qnil;
3545 while (ifconf.ifc_len == buf_size);
3547 res = unbind_to (count, Qnil);
3548 ifreq = ifconf.ifc_req;
3549 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3551 struct ifreq *ifq = ifreq;
3552 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3553 #define SIZEOF_IFREQ(sif) \
3554 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3555 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3557 int len = SIZEOF_IFREQ (ifq);
3558 #else
3559 int len = sizeof (*ifreq);
3560 #endif
3561 char namebuf[sizeof (ifq->ifr_name) + 1];
3562 ifreq = (struct ifreq *) ((char *) ifreq + len);
3564 if (ifq->ifr_addr.sa_family != AF_INET)
3565 continue;
3567 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3568 namebuf[sizeof (ifq->ifr_name)] = 0;
3569 res = Fcons (Fcons (build_string (namebuf),
3570 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3571 sizeof (struct sockaddr))),
3572 res);
3575 xfree (buf);
3576 return res;
3578 #endif /* SIOCGIFCONF */
3580 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3582 struct ifflag_def {
3583 int flag_bit;
3584 const char *flag_sym;
3587 static const struct ifflag_def ifflag_table[] = {
3588 #ifdef IFF_UP
3589 { IFF_UP, "up" },
3590 #endif
3591 #ifdef IFF_BROADCAST
3592 { IFF_BROADCAST, "broadcast" },
3593 #endif
3594 #ifdef IFF_DEBUG
3595 { IFF_DEBUG, "debug" },
3596 #endif
3597 #ifdef IFF_LOOPBACK
3598 { IFF_LOOPBACK, "loopback" },
3599 #endif
3600 #ifdef IFF_POINTOPOINT
3601 { IFF_POINTOPOINT, "pointopoint" },
3602 #endif
3603 #ifdef IFF_RUNNING
3604 { IFF_RUNNING, "running" },
3605 #endif
3606 #ifdef IFF_NOARP
3607 { IFF_NOARP, "noarp" },
3608 #endif
3609 #ifdef IFF_PROMISC
3610 { IFF_PROMISC, "promisc" },
3611 #endif
3612 #ifdef IFF_NOTRAILERS
3613 #ifdef NS_IMPL_COCOA
3614 /* Really means smart, notrailers is obsolete */
3615 { IFF_NOTRAILERS, "smart" },
3616 #else
3617 { IFF_NOTRAILERS, "notrailers" },
3618 #endif
3619 #endif
3620 #ifdef IFF_ALLMULTI
3621 { IFF_ALLMULTI, "allmulti" },
3622 #endif
3623 #ifdef IFF_MASTER
3624 { IFF_MASTER, "master" },
3625 #endif
3626 #ifdef IFF_SLAVE
3627 { IFF_SLAVE, "slave" },
3628 #endif
3629 #ifdef IFF_MULTICAST
3630 { IFF_MULTICAST, "multicast" },
3631 #endif
3632 #ifdef IFF_PORTSEL
3633 { IFF_PORTSEL, "portsel" },
3634 #endif
3635 #ifdef IFF_AUTOMEDIA
3636 { IFF_AUTOMEDIA, "automedia" },
3637 #endif
3638 #ifdef IFF_DYNAMIC
3639 { IFF_DYNAMIC, "dynamic" },
3640 #endif
3641 #ifdef IFF_OACTIVE
3642 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3643 #endif
3644 #ifdef IFF_SIMPLEX
3645 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3646 #endif
3647 #ifdef IFF_LINK0
3648 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3649 #endif
3650 #ifdef IFF_LINK1
3651 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3652 #endif
3653 #ifdef IFF_LINK2
3654 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3655 #endif
3656 { 0, 0 }
3659 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3660 doc: /* Return information about network interface named IFNAME.
3661 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3662 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3663 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
3664 FLAGS is the current flags of the interface. */)
3665 (Lisp_Object ifname)
3667 struct ifreq rq;
3668 Lisp_Object res = Qnil;
3669 Lisp_Object elt;
3670 int s;
3671 bool any = 0;
3672 ptrdiff_t count;
3673 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3674 && defined HAVE_GETIFADDRS && defined LLADDR)
3675 struct ifaddrs *ifap;
3676 #endif
3678 CHECK_STRING (ifname);
3680 if (sizeof rq.ifr_name <= SBYTES (ifname))
3681 error ("interface name too long");
3682 strcpy (rq.ifr_name, SSDATA (ifname));
3684 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
3685 if (s < 0)
3686 return Qnil;
3687 count = SPECPDL_INDEX ();
3688 record_unwind_protect_int (close_file_unwind, s);
3690 elt = Qnil;
3691 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3692 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3694 int flags = rq.ifr_flags;
3695 const struct ifflag_def *fp;
3696 int fnum;
3698 /* If flags is smaller than int (i.e. short) it may have the high bit set
3699 due to IFF_MULTICAST. In that case, sign extending it into
3700 an int is wrong. */
3701 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3702 flags = (unsigned short) rq.ifr_flags;
3704 any = 1;
3705 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3707 if (flags & fp->flag_bit)
3709 elt = Fcons (intern (fp->flag_sym), elt);
3710 flags -= fp->flag_bit;
3713 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3715 if (flags & 1)
3717 elt = Fcons (make_number (fnum), elt);
3721 #endif
3722 res = Fcons (elt, res);
3724 elt = Qnil;
3725 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3726 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3728 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3729 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3730 int n;
3732 any = 1;
3733 for (n = 0; n < 6; n++)
3734 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3735 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3737 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3738 if (getifaddrs (&ifap) != -1)
3740 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3741 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3742 struct ifaddrs *it;
3744 for (it = ifap; it != NULL; it = it->ifa_next)
3746 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3747 unsigned char linkaddr[6];
3748 int n;
3750 if (it->ifa_addr->sa_family != AF_LINK
3751 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3752 || sdl->sdl_alen != 6)
3753 continue;
3755 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3756 for (n = 0; n < 6; n++)
3757 p->contents[n] = make_number (linkaddr[n]);
3759 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3760 break;
3763 #ifdef HAVE_FREEIFADDRS
3764 freeifaddrs (ifap);
3765 #endif
3767 #endif /* HAVE_GETIFADDRS && LLADDR */
3769 res = Fcons (elt, res);
3771 elt = Qnil;
3772 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3773 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3775 any = 1;
3776 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3777 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3778 #else
3779 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3780 #endif
3782 #endif
3783 res = Fcons (elt, res);
3785 elt = Qnil;
3786 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3787 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3789 any = 1;
3790 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3792 #endif
3793 res = Fcons (elt, res);
3795 elt = Qnil;
3796 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3797 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3799 any = 1;
3800 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3802 #endif
3803 res = Fcons (elt, res);
3805 return unbind_to (count, any ? res : Qnil);
3807 #endif
3808 #endif /* defined (HAVE_NET_IF_H) */
3810 /* Turn off input and output for process PROC. */
3812 static void
3813 deactivate_process (Lisp_Object proc)
3815 int inchannel;
3816 struct Lisp_Process *p = XPROCESS (proc);
3817 int i;
3819 #ifdef HAVE_GNUTLS
3820 /* Delete GnuTLS structures in PROC, if any. */
3821 emacs_gnutls_deinit (proc);
3822 #endif /* HAVE_GNUTLS */
3824 #ifdef ADAPTIVE_READ_BUFFERING
3825 if (p->read_output_delay > 0)
3827 if (--process_output_delay_count < 0)
3828 process_output_delay_count = 0;
3829 p->read_output_delay = 0;
3830 p->read_output_skip = 0;
3832 #endif
3834 /* Beware SIGCHLD hereabouts. */
3836 for (i = 0; i < PROCESS_OPEN_FDS; i++)
3837 close_process_fd (&p->open_fd[i]);
3839 inchannel = p->infd;
3840 if (inchannel >= 0)
3842 p->infd = -1;
3843 p->outfd = -1;
3844 #ifdef DATAGRAM_SOCKETS
3845 if (DATAGRAM_CHAN_P (inchannel))
3847 xfree (datagram_address[inchannel].sa);
3848 datagram_address[inchannel].sa = 0;
3849 datagram_address[inchannel].len = 0;
3851 #endif
3852 chan_process[inchannel] = Qnil;
3853 FD_CLR (inchannel, &input_wait_mask);
3854 FD_CLR (inchannel, &non_keyboard_wait_mask);
3855 #ifdef NON_BLOCKING_CONNECT
3856 if (FD_ISSET (inchannel, &connect_wait_mask))
3858 FD_CLR (inchannel, &connect_wait_mask);
3859 FD_CLR (inchannel, &write_mask);
3860 if (--num_pending_connects < 0)
3861 emacs_abort ();
3863 #endif
3864 if (inchannel == max_process_desc)
3866 /* We just closed the highest-numbered process input descriptor,
3867 so recompute the highest-numbered one now. */
3868 int i = inchannel;
3870 i--;
3871 while (0 <= i && NILP (chan_process[i]));
3873 max_process_desc = i;
3879 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3880 0, 4, 0,
3881 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3882 It is read into the process' buffers or given to their filter functions.
3883 Non-nil arg PROCESS means do not return until some output has been received
3884 from PROCESS.
3886 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3887 and milliseconds to wait; return after that much time whether or not
3888 there is any subprocess output. If SECONDS is a floating point number,
3889 it specifies a fractional number of seconds to wait.
3890 The MILLISEC argument is obsolete and should be avoided.
3892 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3893 from PROCESS, suspending reading output from other processes.
3894 If JUST-THIS-ONE is an integer, don't run any timers either.
3895 Return non-nil if we received any output before the timeout expired. */)
3896 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3898 intmax_t secs;
3899 int nsecs;
3901 if (! NILP (process))
3902 CHECK_PROCESS (process);
3903 else
3904 just_this_one = Qnil;
3906 if (!NILP (millisec))
3907 { /* Obsolete calling convention using integers rather than floats. */
3908 CHECK_NUMBER (millisec);
3909 if (NILP (seconds))
3910 seconds = make_float (XINT (millisec) / 1000.0);
3911 else
3913 CHECK_NUMBER (seconds);
3914 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3918 secs = 0;
3919 nsecs = -1;
3921 if (!NILP (seconds))
3923 if (INTEGERP (seconds))
3925 if (XINT (seconds) > 0)
3927 secs = XINT (seconds);
3928 nsecs = 0;
3931 else if (FLOATP (seconds))
3933 if (XFLOAT_DATA (seconds) > 0)
3935 struct timespec t = dtotimespec (XFLOAT_DATA (seconds));
3936 secs = min (t.tv_sec, WAIT_READING_MAX);
3937 nsecs = t.tv_nsec;
3940 else
3941 wrong_type_argument (Qnumberp, seconds);
3943 else if (! NILP (process))
3944 nsecs = 0;
3946 return
3947 (wait_reading_process_output (secs, nsecs, 0, 0,
3948 Qnil,
3949 !NILP (process) ? XPROCESS (process) : NULL,
3950 NILP (just_this_one) ? 0 :
3951 !INTEGERP (just_this_one) ? 1 : -1)
3952 ? Qt : Qnil);
3955 /* Accept a connection for server process SERVER on CHANNEL. */
3957 static EMACS_INT connect_counter = 0;
3959 static void
3960 server_accept_connection (Lisp_Object server, int channel)
3962 Lisp_Object proc, caller, name, buffer;
3963 Lisp_Object contact, host, service;
3964 struct Lisp_Process *ps= XPROCESS (server);
3965 struct Lisp_Process *p;
3966 int s;
3967 union u_sockaddr {
3968 struct sockaddr sa;
3969 struct sockaddr_in in;
3970 #ifdef AF_INET6
3971 struct sockaddr_in6 in6;
3972 #endif
3973 #ifdef HAVE_LOCAL_SOCKETS
3974 struct sockaddr_un un;
3975 #endif
3976 } saddr;
3977 socklen_t len = sizeof saddr;
3978 ptrdiff_t count;
3980 s = accept4 (channel, &saddr.sa, &len, SOCK_CLOEXEC);
3982 if (s < 0)
3984 int code = errno;
3986 if (code == EAGAIN)
3987 return;
3988 #ifdef EWOULDBLOCK
3989 if (code == EWOULDBLOCK)
3990 return;
3991 #endif
3993 if (!NILP (ps->log))
3994 call3 (ps->log, server, Qnil,
3995 concat3 (build_string ("accept failed with code"),
3996 Fnumber_to_string (make_number (code)),
3997 build_string ("\n")));
3998 return;
4001 count = SPECPDL_INDEX ();
4002 record_unwind_protect_int (close_file_unwind, s);
4004 connect_counter++;
4006 /* Setup a new process to handle the connection. */
4008 /* Generate a unique identification of the caller, and build contact
4009 information for this process. */
4010 host = Qt;
4011 service = Qnil;
4012 switch (saddr.sa.sa_family)
4014 case AF_INET:
4016 Lisp_Object args[5];
4017 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4018 args[0] = build_string ("%d.%d.%d.%d");
4019 args[1] = make_number (*ip++);
4020 args[2] = make_number (*ip++);
4021 args[3] = make_number (*ip++);
4022 args[4] = make_number (*ip++);
4023 host = Fformat (5, args);
4024 service = make_number (ntohs (saddr.in.sin_port));
4026 args[0] = build_string (" <%s:%d>");
4027 args[1] = host;
4028 args[2] = service;
4029 caller = Fformat (3, args);
4031 break;
4033 #ifdef AF_INET6
4034 case AF_INET6:
4036 Lisp_Object args[9];
4037 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4038 int i;
4039 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4040 for (i = 0; i < 8; i++)
4041 args[i+1] = make_number (ntohs (ip6[i]));
4042 host = Fformat (9, args);
4043 service = make_number (ntohs (saddr.in.sin_port));
4045 args[0] = build_string (" <[%s]:%d>");
4046 args[1] = host;
4047 args[2] = service;
4048 caller = Fformat (3, args);
4050 break;
4051 #endif
4053 #ifdef HAVE_LOCAL_SOCKETS
4054 case AF_LOCAL:
4055 #endif
4056 default:
4057 caller = Fnumber_to_string (make_number (connect_counter));
4058 caller = concat3 (build_string (" <"), caller, build_string (">"));
4059 break;
4062 /* Create a new buffer name for this process if it doesn't have a
4063 filter. The new buffer name is based on the buffer name or
4064 process name of the server process concatenated with the caller
4065 identification. */
4067 if (!(EQ (ps->filter, Qinternal_default_process_filter)
4068 || EQ (ps->filter, Qt)))
4069 buffer = Qnil;
4070 else
4072 buffer = ps->buffer;
4073 if (!NILP (buffer))
4074 buffer = Fbuffer_name (buffer);
4075 else
4076 buffer = ps->name;
4077 if (!NILP (buffer))
4079 buffer = concat2 (buffer, caller);
4080 buffer = Fget_buffer_create (buffer);
4084 /* Generate a unique name for the new server process. Combine the
4085 server process name with the caller identification. */
4087 name = concat2 (ps->name, caller);
4088 proc = make_process (name);
4090 chan_process[s] = proc;
4092 fcntl (s, F_SETFL, O_NONBLOCK);
4094 p = XPROCESS (proc);
4096 /* Build new contact information for this setup. */
4097 contact = Fcopy_sequence (ps->childp);
4098 contact = Fplist_put (contact, QCserver, Qnil);
4099 contact = Fplist_put (contact, QChost, host);
4100 if (!NILP (service))
4101 contact = Fplist_put (contact, QCservice, service);
4102 contact = Fplist_put (contact, QCremote,
4103 conv_sockaddr_to_lisp (&saddr.sa, len));
4104 #ifdef HAVE_GETSOCKNAME
4105 len = sizeof saddr;
4106 if (getsockname (s, &saddr.sa, &len) == 0)
4107 contact = Fplist_put (contact, QClocal,
4108 conv_sockaddr_to_lisp (&saddr.sa, len));
4109 #endif
4111 pset_childp (p, contact);
4112 pset_plist (p, Fcopy_sequence (ps->plist));
4113 pset_type (p, Qnetwork);
4115 pset_buffer (p, buffer);
4116 pset_sentinel (p, ps->sentinel);
4117 pset_filter (p, ps->filter);
4118 pset_command (p, Qnil);
4119 p->pid = 0;
4121 /* Discard the unwind protect for closing S. */
4122 specpdl_ptr = specpdl + count;
4124 p->open_fd[SUBPROCESS_STDIN] = s;
4125 p->infd = s;
4126 p->outfd = s;
4127 pset_status (p, Qrun);
4129 /* Client processes for accepted connections are not stopped initially. */
4130 if (!EQ (p->filter, Qt))
4132 FD_SET (s, &input_wait_mask);
4133 FD_SET (s, &non_keyboard_wait_mask);
4136 if (s > max_process_desc)
4137 max_process_desc = s;
4139 /* Setup coding system for new process based on server process.
4140 This seems to be the proper thing to do, as the coding system
4141 of the new process should reflect the settings at the time the
4142 server socket was opened; not the current settings. */
4144 pset_decode_coding_system (p, ps->decode_coding_system);
4145 pset_encode_coding_system (p, ps->encode_coding_system);
4146 setup_process_coding_systems (proc);
4148 pset_decoding_buf (p, empty_unibyte_string);
4149 p->decoding_carryover = 0;
4150 pset_encoding_buf (p, empty_unibyte_string);
4152 p->inherit_coding_system_flag
4153 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4155 if (!NILP (ps->log))
4156 call3 (ps->log, server, proc,
4157 concat3 (build_string ("accept from "),
4158 (STRINGP (host) ? host : build_string ("-")),
4159 build_string ("\n")));
4161 exec_sentinel (proc,
4162 concat3 (build_string ("open from "),
4163 (STRINGP (host) ? host : build_string ("-")),
4164 build_string ("\n")));
4167 /* This variable is different from waiting_for_input in keyboard.c.
4168 It is used to communicate to a lisp process-filter/sentinel (via the
4169 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4170 for user-input when that process-filter was called.
4171 waiting_for_input cannot be used as that is by definition 0 when
4172 lisp code is being evalled.
4173 This is also used in record_asynch_buffer_change.
4174 For that purpose, this must be 0
4175 when not inside wait_reading_process_output. */
4176 static int waiting_for_user_input_p;
4178 static void
4179 wait_reading_process_output_unwind (int data)
4181 waiting_for_user_input_p = data;
4184 /* This is here so breakpoints can be put on it. */
4185 static void
4186 wait_reading_process_output_1 (void)
4190 /* Read and dispose of subprocess output while waiting for timeout to
4191 elapse and/or keyboard input to be available.
4193 TIME_LIMIT is:
4194 timeout in seconds
4195 If negative, gobble data immediately available but don't wait for any.
4197 NSECS is:
4198 an additional duration to wait, measured in nanoseconds
4199 If TIME_LIMIT is zero, then:
4200 If NSECS == 0, there is no limit.
4201 If NSECS > 0, the timeout consists of NSECS only.
4202 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4204 READ_KBD is:
4205 0 to ignore keyboard input, or
4206 1 to return when input is available, or
4207 -1 meaning caller will actually read the input, so don't throw to
4208 the quit handler, or
4210 DO_DISPLAY means redisplay should be done to show subprocess
4211 output that arrives.
4213 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4214 (and gobble terminal input into the buffer if any arrives).
4216 If WAIT_PROC is specified, wait until something arrives from that
4217 process. The return value is true if we read some input from
4218 that process.
4220 If JUST_WAIT_PROC is nonzero, handle only output from WAIT_PROC
4221 (suspending output from other processes). A negative value
4222 means don't run any timers either.
4224 If WAIT_PROC is specified, then the function returns true if we
4225 received input from that process before the timeout elapsed.
4226 Otherwise, return true if we received input from any process. */
4228 bool
4229 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4230 bool do_display,
4231 Lisp_Object wait_for_cell,
4232 struct Lisp_Process *wait_proc, int just_wait_proc)
4234 int channel, nfds;
4235 fd_set Available;
4236 fd_set Writeok;
4237 bool check_write;
4238 int check_delay;
4239 bool no_avail;
4240 int xerrno;
4241 Lisp_Object proc;
4242 struct timespec timeout, end_time;
4243 int wait_channel = -1;
4244 bool got_some_input = 0;
4245 ptrdiff_t count = SPECPDL_INDEX ();
4247 FD_ZERO (&Available);
4248 FD_ZERO (&Writeok);
4250 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4251 && !(CONSP (wait_proc->status)
4252 && EQ (XCAR (wait_proc->status), Qexit)))
4253 message1 ("Blocking call to accept-process-output with quit inhibited!!");
4255 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4256 if (wait_proc != NULL)
4257 wait_channel = wait_proc->infd;
4259 record_unwind_protect_int (wait_reading_process_output_unwind,
4260 waiting_for_user_input_p);
4261 waiting_for_user_input_p = read_kbd;
4263 if (time_limit < 0)
4265 time_limit = 0;
4266 nsecs = -1;
4268 else if (TYPE_MAXIMUM (time_t) < time_limit)
4269 time_limit = TYPE_MAXIMUM (time_t);
4271 /* Since we may need to wait several times,
4272 compute the absolute time to return at. */
4273 if (time_limit || nsecs > 0)
4275 timeout = make_timespec (time_limit, nsecs);
4276 end_time = timespec_add (current_timespec (), timeout);
4279 while (1)
4281 bool timeout_reduced_for_timers = 0;
4283 /* If calling from keyboard input, do not quit
4284 since we want to return C-g as an input character.
4285 Otherwise, do pending quit if requested. */
4286 if (read_kbd >= 0)
4287 QUIT;
4288 else if (pending_signals)
4289 process_pending_signals ();
4291 /* Exit now if the cell we're waiting for became non-nil. */
4292 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4293 break;
4295 /* Compute time from now till when time limit is up. */
4296 /* Exit if already run out. */
4297 if (nsecs < 0)
4299 /* A negative timeout means
4300 gobble output available now
4301 but don't wait at all. */
4303 timeout = make_timespec (0, 0);
4305 else if (time_limit || nsecs > 0)
4307 struct timespec now = current_timespec ();
4308 if (timespec_cmp (end_time, now) <= 0)
4309 break;
4310 timeout = timespec_sub (end_time, now);
4312 else
4314 timeout = make_timespec (100000, 0);
4317 /* Normally we run timers here.
4318 But not if wait_for_cell; in those cases,
4319 the wait is supposed to be short,
4320 and those callers cannot handle running arbitrary Lisp code here. */
4321 if (NILP (wait_for_cell)
4322 && just_wait_proc >= 0)
4324 struct timespec timer_delay;
4328 unsigned old_timers_run = timers_run;
4329 struct buffer *old_buffer = current_buffer;
4330 Lisp_Object old_window = selected_window;
4332 timer_delay = timer_check ();
4334 /* If a timer has run, this might have changed buffers
4335 an alike. Make read_key_sequence aware of that. */
4336 if (timers_run != old_timers_run
4337 && (old_buffer != current_buffer
4338 || !EQ (old_window, selected_window))
4339 && waiting_for_user_input_p == -1)
4340 record_asynch_buffer_change ();
4342 if (timers_run != old_timers_run && do_display)
4343 /* We must retry, since a timer may have requeued itself
4344 and that could alter the time_delay. */
4345 redisplay_preserve_echo_area (9);
4346 else
4347 break;
4349 while (!detect_input_pending ());
4351 /* If there is unread keyboard input, also return. */
4352 if (read_kbd != 0
4353 && requeued_events_pending_p ())
4354 break;
4356 /* A negative timeout means do not wait at all. */
4357 if (nsecs >= 0)
4359 if (timespec_valid_p (timer_delay))
4361 if (timespec_cmp (timer_delay, timeout) < 0)
4363 timeout = timer_delay;
4364 timeout_reduced_for_timers = 1;
4367 else
4369 /* This is so a breakpoint can be put here. */
4370 wait_reading_process_output_1 ();
4375 /* Cause C-g and alarm signals to take immediate action,
4376 and cause input available signals to zero out timeout.
4378 It is important that we do this before checking for process
4379 activity. If we get a SIGCHLD after the explicit checks for
4380 process activity, timeout is the only way we will know. */
4381 if (read_kbd < 0)
4382 set_waiting_for_input (&timeout);
4384 /* If status of something has changed, and no input is
4385 available, notify the user of the change right away. After
4386 this explicit check, we'll let the SIGCHLD handler zap
4387 timeout to get our attention. */
4388 if (update_tick != process_tick)
4390 fd_set Atemp;
4391 fd_set Ctemp;
4393 if (kbd_on_hold_p ())
4394 FD_ZERO (&Atemp);
4395 else
4396 Atemp = input_wait_mask;
4397 Ctemp = write_mask;
4399 timeout = make_timespec (0, 0);
4400 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4401 &Atemp,
4402 #ifdef NON_BLOCKING_CONNECT
4403 (num_pending_connects > 0 ? &Ctemp : NULL),
4404 #else
4405 NULL,
4406 #endif
4407 NULL, &timeout, NULL)
4408 <= 0))
4410 /* It's okay for us to do this and then continue with
4411 the loop, since timeout has already been zeroed out. */
4412 clear_waiting_for_input ();
4413 status_notify (NULL);
4414 if (do_display) redisplay_preserve_echo_area (13);
4418 /* Don't wait for output from a non-running process. Just
4419 read whatever data has already been received. */
4420 if (wait_proc && wait_proc->raw_status_new)
4421 update_status (wait_proc);
4422 if (wait_proc
4423 && ! EQ (wait_proc->status, Qrun)
4424 && ! EQ (wait_proc->status, Qconnect))
4426 bool read_some_bytes = 0;
4428 clear_waiting_for_input ();
4429 XSETPROCESS (proc, wait_proc);
4431 /* Read data from the process, until we exhaust it. */
4432 while (wait_proc->infd >= 0)
4434 int nread = read_process_output (proc, wait_proc->infd);
4436 if (nread == 0)
4437 break;
4439 if (nread > 0)
4440 got_some_input = read_some_bytes = 1;
4441 else if (nread == -1 && (errno == EIO || errno == EAGAIN))
4442 break;
4443 #ifdef EWOULDBLOCK
4444 else if (nread == -1 && EWOULDBLOCK == errno)
4445 break;
4446 #endif
4448 if (read_some_bytes && do_display)
4449 redisplay_preserve_echo_area (10);
4451 break;
4454 /* Wait till there is something to do */
4456 if (wait_proc && just_wait_proc)
4458 if (wait_proc->infd < 0) /* Terminated */
4459 break;
4460 FD_SET (wait_proc->infd, &Available);
4461 check_delay = 0;
4462 check_write = 0;
4464 else if (!NILP (wait_for_cell))
4466 Available = non_process_wait_mask;
4467 check_delay = 0;
4468 check_write = 0;
4470 else
4472 if (! read_kbd)
4473 Available = non_keyboard_wait_mask;
4474 else
4475 Available = input_wait_mask;
4476 Writeok = write_mask;
4477 #ifdef SELECT_CANT_DO_WRITE_MASK
4478 check_write = 0;
4479 #else
4480 check_write = 1;
4481 #endif
4482 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4485 /* If frame size has changed or the window is newly mapped,
4486 redisplay now, before we start to wait. There is a race
4487 condition here; if a SIGIO arrives between now and the select
4488 and indicates that a frame is trashed, the select may block
4489 displaying a trashed screen. */
4490 if (frame_garbaged && do_display)
4492 clear_waiting_for_input ();
4493 redisplay_preserve_echo_area (11);
4494 if (read_kbd < 0)
4495 set_waiting_for_input (&timeout);
4498 /* Skip the `select' call if input is available and we're
4499 waiting for keyboard input or a cell change (which can be
4500 triggered by processing X events). In the latter case, set
4501 nfds to 1 to avoid breaking the loop. */
4502 no_avail = 0;
4503 if ((read_kbd || !NILP (wait_for_cell))
4504 && detect_input_pending ())
4506 nfds = read_kbd ? 0 : 1;
4507 no_avail = 1;
4510 if (!no_avail)
4513 #ifdef ADAPTIVE_READ_BUFFERING
4514 /* Set the timeout for adaptive read buffering if any
4515 process has non-zero read_output_skip and non-zero
4516 read_output_delay, and we are not reading output for a
4517 specific wait_channel. It is not executed if
4518 Vprocess_adaptive_read_buffering is nil. */
4519 if (process_output_skip && check_delay > 0)
4521 int nsecs = timeout.tv_nsec;
4522 if (timeout.tv_sec > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4523 nsecs = READ_OUTPUT_DELAY_MAX;
4524 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4526 proc = chan_process[channel];
4527 if (NILP (proc))
4528 continue;
4529 /* Find minimum non-zero read_output_delay among the
4530 processes with non-zero read_output_skip. */
4531 if (XPROCESS (proc)->read_output_delay > 0)
4533 check_delay--;
4534 if (!XPROCESS (proc)->read_output_skip)
4535 continue;
4536 FD_CLR (channel, &Available);
4537 XPROCESS (proc)->read_output_skip = 0;
4538 if (XPROCESS (proc)->read_output_delay < nsecs)
4539 nsecs = XPROCESS (proc)->read_output_delay;
4542 timeout = make_timespec (0, nsecs);
4543 process_output_skip = 0;
4545 #endif
4547 #if defined (HAVE_NS)
4548 nfds = ns_select
4549 #elif defined (HAVE_GLIB)
4550 nfds = xg_select
4551 #else
4552 nfds = pselect
4553 #endif
4554 (max (max_process_desc, max_input_desc) + 1,
4555 &Available,
4556 (check_write ? &Writeok : 0),
4557 NULL, &timeout, NULL);
4559 #ifdef HAVE_GNUTLS
4560 /* GnuTLS buffers data internally. In lowat mode it leaves
4561 some data in the TCP buffers so that select works, but
4562 with custom pull/push functions we need to check if some
4563 data is available in the buffers manually. */
4564 if (nfds == 0)
4566 if (! wait_proc)
4568 /* We're not waiting on a specific process, so loop
4569 through all the channels and check for data.
4570 This is a workaround needed for some versions of
4571 the gnutls library -- 2.12.14 has been confirmed
4572 to need it. See
4573 http://comments.gmane.org/gmane.emacs.devel/145074 */
4574 for (channel = 0; channel < FD_SETSIZE; ++channel)
4575 if (! NILP (chan_process[channel]))
4577 struct Lisp_Process *p =
4578 XPROCESS (chan_process[channel]);
4579 if (p && p->gnutls_p && p->infd
4580 && ((emacs_gnutls_record_check_pending
4581 (p->gnutls_state))
4582 > 0))
4584 nfds++;
4585 FD_SET (p->infd, &Available);
4589 else
4591 /* Check this specific channel. */
4592 if (wait_proc->gnutls_p /* Check for valid process. */
4593 /* Do we have pending data? */
4594 && ((emacs_gnutls_record_check_pending
4595 (wait_proc->gnutls_state))
4596 > 0))
4598 nfds = 1;
4599 /* Set to Available. */
4600 FD_SET (wait_proc->infd, &Available);
4604 #endif
4607 xerrno = errno;
4609 /* Make C-g and alarm signals set flags again */
4610 clear_waiting_for_input ();
4612 /* If we woke up due to SIGWINCH, actually change size now. */
4613 do_pending_window_change (0);
4615 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4616 /* We waited the full specified time, so return now. */
4617 break;
4618 if (nfds < 0)
4620 if (xerrno == EINTR)
4621 no_avail = 1;
4622 else if (xerrno == EBADF)
4623 emacs_abort ();
4624 else
4625 report_file_errno ("Failed select", Qnil, xerrno);
4628 if (no_avail)
4630 FD_ZERO (&Available);
4631 check_write = 0;
4634 /* Check for keyboard input */
4635 /* If there is any, return immediately
4636 to give it higher priority than subprocesses */
4638 if (read_kbd != 0)
4640 unsigned old_timers_run = timers_run;
4641 struct buffer *old_buffer = current_buffer;
4642 Lisp_Object old_window = selected_window;
4643 bool leave = 0;
4645 if (detect_input_pending_run_timers (do_display))
4647 swallow_events (do_display);
4648 if (detect_input_pending_run_timers (do_display))
4649 leave = 1;
4652 /* If a timer has run, this might have changed buffers
4653 an alike. Make read_key_sequence aware of that. */
4654 if (timers_run != old_timers_run
4655 && waiting_for_user_input_p == -1
4656 && (old_buffer != current_buffer
4657 || !EQ (old_window, selected_window)))
4658 record_asynch_buffer_change ();
4660 if (leave)
4661 break;
4664 /* If there is unread keyboard input, also return. */
4665 if (read_kbd != 0
4666 && requeued_events_pending_p ())
4667 break;
4669 /* If we are not checking for keyboard input now,
4670 do process events (but don't run any timers).
4671 This is so that X events will be processed.
4672 Otherwise they may have to wait until polling takes place.
4673 That would causes delays in pasting selections, for example.
4675 (We used to do this only if wait_for_cell.) */
4676 if (read_kbd == 0 && detect_input_pending ())
4678 swallow_events (do_display);
4679 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4680 if (detect_input_pending ())
4681 break;
4682 #endif
4685 /* Exit now if the cell we're waiting for became non-nil. */
4686 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4687 break;
4689 #ifdef USABLE_SIGIO
4690 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4691 go read it. This can happen with X on BSD after logging out.
4692 In that case, there really is no input and no SIGIO,
4693 but select says there is input. */
4695 if (read_kbd && interrupt_input
4696 && keyboard_bit_set (&Available) && ! noninteractive)
4697 handle_input_available_signal (SIGIO);
4698 #endif
4700 if (! wait_proc)
4701 got_some_input |= nfds > 0;
4703 /* If checking input just got us a size-change event from X,
4704 obey it now if we should. */
4705 if (read_kbd || ! NILP (wait_for_cell))
4706 do_pending_window_change (0);
4708 /* Check for data from a process. */
4709 if (no_avail || nfds == 0)
4710 continue;
4712 for (channel = 0; channel <= max_input_desc; ++channel)
4714 struct fd_callback_data *d = &fd_callback_info[channel];
4715 if (d->func
4716 && ((d->condition & FOR_READ
4717 && FD_ISSET (channel, &Available))
4718 || (d->condition & FOR_WRITE
4719 && FD_ISSET (channel, &write_mask))))
4720 d->func (channel, d->data);
4723 for (channel = 0; channel <= max_process_desc; channel++)
4725 if (FD_ISSET (channel, &Available)
4726 && FD_ISSET (channel, &non_keyboard_wait_mask)
4727 && !FD_ISSET (channel, &non_process_wait_mask))
4729 int nread;
4731 /* If waiting for this channel, arrange to return as
4732 soon as no more input to be processed. No more
4733 waiting. */
4734 if (wait_channel == channel)
4736 wait_channel = -1;
4737 nsecs = -1;
4738 got_some_input = 1;
4740 proc = chan_process[channel];
4741 if (NILP (proc))
4742 continue;
4744 /* If this is a server stream socket, accept connection. */
4745 if (EQ (XPROCESS (proc)->status, Qlisten))
4747 server_accept_connection (proc, channel);
4748 continue;
4751 /* Read data from the process, starting with our
4752 buffered-ahead character if we have one. */
4754 nread = read_process_output (proc, channel);
4755 if (nread > 0)
4757 /* Since read_process_output can run a filter,
4758 which can call accept-process-output,
4759 don't try to read from any other processes
4760 before doing the select again. */
4761 FD_ZERO (&Available);
4763 if (do_display)
4764 redisplay_preserve_echo_area (12);
4766 #ifdef EWOULDBLOCK
4767 else if (nread == -1 && errno == EWOULDBLOCK)
4769 #endif
4770 else if (nread == -1 && errno == EAGAIN)
4772 #ifdef WINDOWSNT
4773 /* FIXME: Is this special case still needed? */
4774 /* Note that we cannot distinguish between no input
4775 available now and a closed pipe.
4776 With luck, a closed pipe will be accompanied by
4777 subprocess termination and SIGCHLD. */
4778 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4780 #endif
4781 #ifdef HAVE_PTYS
4782 /* On some OSs with ptys, when the process on one end of
4783 a pty exits, the other end gets an error reading with
4784 errno = EIO instead of getting an EOF (0 bytes read).
4785 Therefore, if we get an error reading and errno =
4786 EIO, just continue, because the child process has
4787 exited and should clean itself up soon (e.g. when we
4788 get a SIGCHLD). */
4789 else if (nread == -1 && errno == EIO)
4791 struct Lisp_Process *p = XPROCESS (proc);
4793 /* Clear the descriptor now, so we only raise the
4794 signal once. */
4795 FD_CLR (channel, &input_wait_mask);
4796 FD_CLR (channel, &non_keyboard_wait_mask);
4798 if (p->pid == -2)
4800 /* If the EIO occurs on a pty, the SIGCHLD handler's
4801 waitpid call will not find the process object to
4802 delete. Do it here. */
4803 p->tick = ++process_tick;
4804 pset_status (p, Qfailed);
4807 #endif /* HAVE_PTYS */
4808 /* If we can detect process termination, don't consider the
4809 process gone just because its pipe is closed. */
4810 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4812 else
4814 /* Preserve status of processes already terminated. */
4815 XPROCESS (proc)->tick = ++process_tick;
4816 deactivate_process (proc);
4817 if (XPROCESS (proc)->raw_status_new)
4818 update_status (XPROCESS (proc));
4819 if (EQ (XPROCESS (proc)->status, Qrun))
4820 pset_status (XPROCESS (proc),
4821 list2 (Qexit, make_number (256)));
4824 #ifdef NON_BLOCKING_CONNECT
4825 if (FD_ISSET (channel, &Writeok)
4826 && FD_ISSET (channel, &connect_wait_mask))
4828 struct Lisp_Process *p;
4830 FD_CLR (channel, &connect_wait_mask);
4831 FD_CLR (channel, &write_mask);
4832 if (--num_pending_connects < 0)
4833 emacs_abort ();
4835 proc = chan_process[channel];
4836 if (NILP (proc))
4837 continue;
4839 p = XPROCESS (proc);
4841 #ifdef GNU_LINUX
4842 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4843 So only use it on systems where it is known to work. */
4845 socklen_t xlen = sizeof (xerrno);
4846 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4847 xerrno = errno;
4849 #else
4851 struct sockaddr pname;
4852 int pnamelen = sizeof (pname);
4854 /* If connection failed, getpeername will fail. */
4855 xerrno = 0;
4856 if (getpeername (channel, &pname, &pnamelen) < 0)
4858 /* Obtain connect failure code through error slippage. */
4859 char dummy;
4860 xerrno = errno;
4861 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4862 xerrno = errno;
4865 #endif
4866 if (xerrno)
4868 p->tick = ++process_tick;
4869 pset_status (p, list2 (Qfailed, make_number (xerrno)));
4870 deactivate_process (proc);
4872 else
4874 pset_status (p, Qrun);
4875 /* Execute the sentinel here. If we had relied on
4876 status_notify to do it later, it will read input
4877 from the process before calling the sentinel. */
4878 exec_sentinel (proc, build_string ("open\n"));
4879 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
4881 FD_SET (p->infd, &input_wait_mask);
4882 FD_SET (p->infd, &non_keyboard_wait_mask);
4886 #endif /* NON_BLOCKING_CONNECT */
4887 } /* End for each file descriptor. */
4888 } /* End while exit conditions not met. */
4890 unbind_to (count, Qnil);
4892 /* If calling from keyboard input, do not quit
4893 since we want to return C-g as an input character.
4894 Otherwise, do pending quit if requested. */
4895 if (read_kbd >= 0)
4897 /* Prevent input_pending from remaining set if we quit. */
4898 clear_input_pending ();
4899 QUIT;
4902 return got_some_input;
4905 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
4907 static Lisp_Object
4908 read_process_output_call (Lisp_Object fun_and_args)
4910 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
4913 static Lisp_Object
4914 read_process_output_error_handler (Lisp_Object error_val)
4916 cmd_error_internal (error_val, "error in process filter: ");
4917 Vinhibit_quit = Qt;
4918 update_echo_area ();
4919 Fsleep_for (make_number (2), Qnil);
4920 return Qt;
4923 static void
4924 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
4925 ssize_t nbytes,
4926 struct coding_system *coding);
4928 /* Read pending output from the process channel,
4929 starting with our buffered-ahead character if we have one.
4930 Yield number of decoded characters read.
4932 This function reads at most 4096 characters.
4933 If you want to read all available subprocess output,
4934 you must call it repeatedly until it returns zero.
4936 The characters read are decoded according to PROC's coding-system
4937 for decoding. */
4939 static int
4940 read_process_output (Lisp_Object proc, register int channel)
4942 register ssize_t nbytes;
4943 char *chars;
4944 register struct Lisp_Process *p = XPROCESS (proc);
4945 struct coding_system *coding = proc_decode_coding_system[channel];
4946 int carryover = p->decoding_carryover;
4947 int readmax = 4096;
4948 ptrdiff_t count = SPECPDL_INDEX ();
4949 Lisp_Object odeactivate;
4951 chars = alloca (carryover + readmax);
4952 if (carryover)
4953 /* See the comment above. */
4954 memcpy (chars, SDATA (p->decoding_buf), carryover);
4956 #ifdef DATAGRAM_SOCKETS
4957 /* We have a working select, so proc_buffered_char is always -1. */
4958 if (DATAGRAM_CHAN_P (channel))
4960 socklen_t len = datagram_address[channel].len;
4961 nbytes = recvfrom (channel, chars + carryover, readmax,
4962 0, datagram_address[channel].sa, &len);
4964 else
4965 #endif
4967 bool buffered = proc_buffered_char[channel] >= 0;
4968 if (buffered)
4970 chars[carryover] = proc_buffered_char[channel];
4971 proc_buffered_char[channel] = -1;
4973 #ifdef HAVE_GNUTLS
4974 if (p->gnutls_p)
4975 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
4976 readmax - buffered);
4977 else
4978 #endif
4979 nbytes = emacs_read (channel, chars + carryover + buffered,
4980 readmax - buffered);
4981 #ifdef ADAPTIVE_READ_BUFFERING
4982 if (nbytes > 0 && p->adaptive_read_buffering)
4984 int delay = p->read_output_delay;
4985 if (nbytes < 256)
4987 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
4989 if (delay == 0)
4990 process_output_delay_count++;
4991 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
4994 else if (delay > 0 && nbytes == readmax - buffered)
4996 delay -= READ_OUTPUT_DELAY_INCREMENT;
4997 if (delay == 0)
4998 process_output_delay_count--;
5000 p->read_output_delay = delay;
5001 if (delay)
5003 p->read_output_skip = 1;
5004 process_output_skip = 1;
5007 #endif
5008 nbytes += buffered;
5009 nbytes += buffered && nbytes <= 0;
5012 p->decoding_carryover = 0;
5014 /* At this point, NBYTES holds number of bytes just received
5015 (including the one in proc_buffered_char[channel]). */
5016 if (nbytes <= 0)
5018 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5019 return nbytes;
5020 coding->mode |= CODING_MODE_LAST_BLOCK;
5023 /* Now set NBYTES how many bytes we must decode. */
5024 nbytes += carryover;
5026 odeactivate = Vdeactivate_mark;
5027 /* There's no good reason to let process filters change the current
5028 buffer, and many callers of accept-process-output, sit-for, and
5029 friends don't expect current-buffer to be changed from under them. */
5030 record_unwind_current_buffer ();
5032 read_and_dispose_of_process_output (p, chars, nbytes, coding);
5034 /* Handling the process output should not deactivate the mark. */
5035 Vdeactivate_mark = odeactivate;
5037 unbind_to (count, Qnil);
5038 return nbytes;
5041 static void
5042 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5043 ssize_t nbytes,
5044 struct coding_system *coding)
5046 Lisp_Object outstream = p->filter;
5047 Lisp_Object text;
5048 bool outer_running_asynch_code = running_asynch_code;
5049 int waiting = waiting_for_user_input_p;
5051 /* No need to gcpro these, because all we do with them later
5052 is test them for EQness, and none of them should be a string. */
5053 #if 0
5054 Lisp_Object obuffer, okeymap;
5055 XSETBUFFER (obuffer, current_buffer);
5056 okeymap = BVAR (current_buffer, keymap);
5057 #endif
5059 /* We inhibit quit here instead of just catching it so that
5060 hitting ^G when a filter happens to be running won't screw
5061 it up. */
5062 specbind (Qinhibit_quit, Qt);
5063 specbind (Qlast_nonmenu_event, Qt);
5065 /* In case we get recursively called,
5066 and we already saved the match data nonrecursively,
5067 save the same match data in safely recursive fashion. */
5068 if (outer_running_asynch_code)
5070 Lisp_Object tem;
5071 /* Don't clobber the CURRENT match data, either! */
5072 tem = Fmatch_data (Qnil, Qnil, Qnil);
5073 restore_search_regs ();
5074 record_unwind_save_match_data ();
5075 Fset_match_data (tem, Qt);
5078 /* For speed, if a search happens within this code,
5079 save the match data in a special nonrecursive fashion. */
5080 running_asynch_code = 1;
5082 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5083 text = coding->dst_object;
5084 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5085 /* A new coding system might be found. */
5086 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5088 pset_decode_coding_system (p, Vlast_coding_system_used);
5090 /* Don't call setup_coding_system for
5091 proc_decode_coding_system[channel] here. It is done in
5092 detect_coding called via decode_coding above. */
5094 /* If a coding system for encoding is not yet decided, we set
5095 it as the same as coding-system for decoding.
5097 But, before doing that we must check if
5098 proc_encode_coding_system[p->outfd] surely points to a
5099 valid memory because p->outfd will be changed once EOF is
5100 sent to the process. */
5101 if (NILP (p->encode_coding_system)
5102 && proc_encode_coding_system[p->outfd])
5104 pset_encode_coding_system
5105 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5106 setup_coding_system (p->encode_coding_system,
5107 proc_encode_coding_system[p->outfd]);
5111 if (coding->carryover_bytes > 0)
5113 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5114 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5115 memcpy (SDATA (p->decoding_buf), coding->carryover,
5116 coding->carryover_bytes);
5117 p->decoding_carryover = coding->carryover_bytes;
5119 if (SBYTES (text) > 0)
5120 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5121 sometimes it's simply wrong to wrap (e.g. when called from
5122 accept-process-output). */
5123 internal_condition_case_1 (read_process_output_call,
5124 list3 (outstream, make_lisp_proc (p), text),
5125 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5126 read_process_output_error_handler);
5128 /* If we saved the match data nonrecursively, restore it now. */
5129 restore_search_regs ();
5130 running_asynch_code = outer_running_asynch_code;
5132 /* Restore waiting_for_user_input_p as it was
5133 when we were called, in case the filter clobbered it. */
5134 waiting_for_user_input_p = waiting;
5136 #if 0 /* Call record_asynch_buffer_change unconditionally,
5137 because we might have changed minor modes or other things
5138 that affect key bindings. */
5139 if (! EQ (Fcurrent_buffer (), obuffer)
5140 || ! EQ (current_buffer->keymap, okeymap))
5141 #endif
5142 /* But do it only if the caller is actually going to read events.
5143 Otherwise there's no need to make him wake up, and it could
5144 cause trouble (for example it would make sit_for return). */
5145 if (waiting_for_user_input_p == -1)
5146 record_asynch_buffer_change ();
5149 DEFUN ("internal-default-process-filter", Finternal_default_process_filter,
5150 Sinternal_default_process_filter, 2, 2, 0,
5151 doc: /* Function used as default process filter. */)
5152 (Lisp_Object proc, Lisp_Object text)
5154 struct Lisp_Process *p;
5155 ptrdiff_t opoint;
5157 CHECK_PROCESS (proc);
5158 p = XPROCESS (proc);
5159 CHECK_STRING (text);
5161 if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5163 Lisp_Object old_read_only;
5164 ptrdiff_t old_begv, old_zv;
5165 ptrdiff_t old_begv_byte, old_zv_byte;
5166 ptrdiff_t before, before_byte;
5167 ptrdiff_t opoint_byte;
5168 struct buffer *b;
5170 Fset_buffer (p->buffer);
5171 opoint = PT;
5172 opoint_byte = PT_BYTE;
5173 old_read_only = BVAR (current_buffer, read_only);
5174 old_begv = BEGV;
5175 old_zv = ZV;
5176 old_begv_byte = BEGV_BYTE;
5177 old_zv_byte = ZV_BYTE;
5179 bset_read_only (current_buffer, Qnil);
5181 /* Insert new output into buffer at the current end-of-output
5182 marker, thus preserving logical ordering of input and output. */
5183 if (XMARKER (p->mark)->buffer)
5184 set_point_from_marker (p->mark);
5185 else
5186 SET_PT_BOTH (ZV, ZV_BYTE);
5187 before = PT;
5188 before_byte = PT_BYTE;
5190 /* If the output marker is outside of the visible region, save
5191 the restriction and widen. */
5192 if (! (BEGV <= PT && PT <= ZV))
5193 Fwiden ();
5195 /* Adjust the multibyteness of TEXT to that of the buffer. */
5196 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5197 != ! STRING_MULTIBYTE (text))
5198 text = (STRING_MULTIBYTE (text)
5199 ? Fstring_as_unibyte (text)
5200 : Fstring_to_multibyte (text));
5201 /* Insert before markers in case we are inserting where
5202 the buffer's mark is, and the user's next command is Meta-y. */
5203 insert_from_string_before_markers (text, 0, 0,
5204 SCHARS (text), SBYTES (text), 0);
5206 /* Make sure the process marker's position is valid when the
5207 process buffer is changed in the signal_after_change above.
5208 W3 is known to do that. */
5209 if (BUFFERP (p->buffer)
5210 && (b = XBUFFER (p->buffer), b != current_buffer))
5211 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5212 else
5213 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5215 update_mode_lines++;
5217 /* Make sure opoint and the old restrictions
5218 float ahead of any new text just as point would. */
5219 if (opoint >= before)
5221 opoint += PT - before;
5222 opoint_byte += PT_BYTE - before_byte;
5224 if (old_begv > before)
5226 old_begv += PT - before;
5227 old_begv_byte += PT_BYTE - before_byte;
5229 if (old_zv >= before)
5231 old_zv += PT - before;
5232 old_zv_byte += PT_BYTE - before_byte;
5235 /* If the restriction isn't what it should be, set it. */
5236 if (old_begv != BEGV || old_zv != ZV)
5237 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5239 bset_read_only (current_buffer, old_read_only);
5240 SET_PT_BOTH (opoint, opoint_byte);
5242 return Qnil;
5245 /* Sending data to subprocess. */
5247 /* In send_process, when a write fails temporarily,
5248 wait_reading_process_output is called. It may execute user code,
5249 e.g. timers, that attempts to write new data to the same process.
5250 We must ensure that data is sent in the right order, and not
5251 interspersed half-completed with other writes (Bug#10815). This is
5252 handled by the write_queue element of struct process. It is a list
5253 with each entry having the form
5255 (string . (offset . length))
5257 where STRING is a lisp string, OFFSET is the offset into the
5258 string's byte sequence from which we should begin to send, and
5259 LENGTH is the number of bytes left to send. */
5261 /* Create a new entry in write_queue.
5262 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5263 BUF is a pointer to the string sequence of the input_obj or a C
5264 string in case of Qt or Qnil. */
5266 static void
5267 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5268 const char *buf, ptrdiff_t len, bool front)
5270 ptrdiff_t offset;
5271 Lisp_Object entry, obj;
5273 if (STRINGP (input_obj))
5275 offset = buf - SSDATA (input_obj);
5276 obj = input_obj;
5278 else
5280 offset = 0;
5281 obj = make_unibyte_string (buf, len);
5284 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5286 if (front)
5287 pset_write_queue (p, Fcons (entry, p->write_queue));
5288 else
5289 pset_write_queue (p, nconc2 (p->write_queue, list1 (entry)));
5292 /* Remove the first element in the write_queue of process P, put its
5293 contents in OBJ, BUF and LEN, and return true. If the
5294 write_queue is empty, return false. */
5296 static bool
5297 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5298 const char **buf, ptrdiff_t *len)
5300 Lisp_Object entry, offset_length;
5301 ptrdiff_t offset;
5303 if (NILP (p->write_queue))
5304 return 0;
5306 entry = XCAR (p->write_queue);
5307 pset_write_queue (p, XCDR (p->write_queue));
5309 *obj = XCAR (entry);
5310 offset_length = XCDR (entry);
5312 *len = XINT (XCDR (offset_length));
5313 offset = XINT (XCAR (offset_length));
5314 *buf = SSDATA (*obj) + offset;
5316 return 1;
5319 /* Send some data to process PROC.
5320 BUF is the beginning of the data; LEN is the number of characters.
5321 OBJECT is the Lisp object that the data comes from. If OBJECT is
5322 nil or t, it means that the data comes from C string.
5324 If OBJECT is not nil, the data is encoded by PROC's coding-system
5325 for encoding before it is sent.
5327 This function can evaluate Lisp code and can garbage collect. */
5329 static void
5330 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
5331 Lisp_Object object)
5333 struct Lisp_Process *p = XPROCESS (proc);
5334 ssize_t rv;
5335 struct coding_system *coding;
5337 if (p->raw_status_new)
5338 update_status (p);
5339 if (! EQ (p->status, Qrun))
5340 error ("Process %s not running", SDATA (p->name));
5341 if (p->outfd < 0)
5342 error ("Output file descriptor of %s is closed", SDATA (p->name));
5344 coding = proc_encode_coding_system[p->outfd];
5345 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5347 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5348 || (BUFFERP (object)
5349 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5350 || EQ (object, Qt))
5352 pset_encode_coding_system
5353 (p, complement_process_encoding_system (p->encode_coding_system));
5354 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5356 /* The coding system for encoding was changed to raw-text
5357 because we sent a unibyte text previously. Now we are
5358 sending a multibyte text, thus we must encode it by the
5359 original coding system specified for the current process.
5361 Another reason we come here is that the coding system
5362 was just complemented and a new one was returned by
5363 complement_process_encoding_system. */
5364 setup_coding_system (p->encode_coding_system, coding);
5365 Vlast_coding_system_used = p->encode_coding_system;
5367 coding->src_multibyte = 1;
5369 else
5371 coding->src_multibyte = 0;
5372 /* For sending a unibyte text, character code conversion should
5373 not take place but EOL conversion should. So, setup raw-text
5374 or one of the subsidiary if we have not yet done it. */
5375 if (CODING_REQUIRE_ENCODING (coding))
5377 if (CODING_REQUIRE_FLUSHING (coding))
5379 /* But, before changing the coding, we must flush out data. */
5380 coding->mode |= CODING_MODE_LAST_BLOCK;
5381 send_process (proc, "", 0, Qt);
5382 coding->mode &= CODING_MODE_LAST_BLOCK;
5384 setup_coding_system (raw_text_coding_system
5385 (Vlast_coding_system_used),
5386 coding);
5387 coding->src_multibyte = 0;
5390 coding->dst_multibyte = 0;
5392 if (CODING_REQUIRE_ENCODING (coding))
5394 coding->dst_object = Qt;
5395 if (BUFFERP (object))
5397 ptrdiff_t from_byte, from, to;
5398 ptrdiff_t save_pt, save_pt_byte;
5399 struct buffer *cur = current_buffer;
5401 set_buffer_internal (XBUFFER (object));
5402 save_pt = PT, save_pt_byte = PT_BYTE;
5404 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5405 from = BYTE_TO_CHAR (from_byte);
5406 to = BYTE_TO_CHAR (from_byte + len);
5407 TEMP_SET_PT_BOTH (from, from_byte);
5408 encode_coding_object (coding, object, from, from_byte,
5409 to, from_byte + len, Qt);
5410 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5411 set_buffer_internal (cur);
5413 else if (STRINGP (object))
5415 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5416 SBYTES (object), Qt);
5418 else
5420 coding->dst_object = make_unibyte_string (buf, len);
5421 coding->produced = len;
5424 len = coding->produced;
5425 object = coding->dst_object;
5426 buf = SSDATA (object);
5429 /* If there is already data in the write_queue, put the new data
5430 in the back of queue. Otherwise, ignore it. */
5431 if (!NILP (p->write_queue))
5432 write_queue_push (p, object, buf, len, 0);
5434 do /* while !NILP (p->write_queue) */
5436 ptrdiff_t cur_len = -1;
5437 const char *cur_buf;
5438 Lisp_Object cur_object;
5440 /* If write_queue is empty, ignore it. */
5441 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5443 cur_len = len;
5444 cur_buf = buf;
5445 cur_object = object;
5448 while (cur_len > 0)
5450 /* Send this batch, using one or more write calls. */
5451 ptrdiff_t written = 0;
5452 int outfd = p->outfd;
5453 #ifdef DATAGRAM_SOCKETS
5454 if (DATAGRAM_CHAN_P (outfd))
5456 rv = sendto (outfd, cur_buf, cur_len,
5457 0, datagram_address[outfd].sa,
5458 datagram_address[outfd].len);
5459 if (rv >= 0)
5460 written = rv;
5461 else if (errno == EMSGSIZE)
5462 report_file_error ("Sending datagram", proc);
5464 else
5465 #endif
5467 #ifdef HAVE_GNUTLS
5468 if (p->gnutls_p)
5469 written = emacs_gnutls_write (p, cur_buf, cur_len);
5470 else
5471 #endif
5472 written = emacs_write_sig (outfd, cur_buf, cur_len);
5473 rv = (written ? 0 : -1);
5474 #ifdef ADAPTIVE_READ_BUFFERING
5475 if (p->read_output_delay > 0
5476 && p->adaptive_read_buffering == 1)
5478 p->read_output_delay = 0;
5479 process_output_delay_count--;
5480 p->read_output_skip = 0;
5482 #endif
5485 if (rv < 0)
5487 if (errno == EAGAIN
5488 #ifdef EWOULDBLOCK
5489 || errno == EWOULDBLOCK
5490 #endif
5492 /* Buffer is full. Wait, accepting input;
5493 that may allow the program
5494 to finish doing output and read more. */
5496 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5497 /* A gross hack to work around a bug in FreeBSD.
5498 In the following sequence, read(2) returns
5499 bogus data:
5501 write(2) 1022 bytes
5502 write(2) 954 bytes, get EAGAIN
5503 read(2) 1024 bytes in process_read_output
5504 read(2) 11 bytes in process_read_output
5506 That is, read(2) returns more bytes than have
5507 ever been written successfully. The 1033 bytes
5508 read are the 1022 bytes written successfully
5509 after processing (for example with CRs added if
5510 the terminal is set up that way which it is
5511 here). The same bytes will be seen again in a
5512 later read(2), without the CRs. */
5514 if (errno == EAGAIN)
5516 int flags = FWRITE;
5517 ioctl (p->outfd, TIOCFLUSH, &flags);
5519 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5521 /* Put what we should have written in wait_queue. */
5522 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5523 wait_reading_process_output (0, 20 * 1000 * 1000,
5524 0, 0, Qnil, NULL, 0);
5525 /* Reread queue, to see what is left. */
5526 break;
5528 else if (errno == EPIPE)
5530 p->raw_status_new = 0;
5531 pset_status (p, list2 (Qexit, make_number (256)));
5532 p->tick = ++process_tick;
5533 deactivate_process (proc);
5534 error ("process %s no longer connected to pipe; closed it",
5535 SDATA (p->name));
5537 else
5538 /* This is a real error. */
5539 report_file_error ("Writing to process", proc);
5541 cur_buf += written;
5542 cur_len -= written;
5545 while (!NILP (p->write_queue));
5548 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5549 3, 3, 0,
5550 doc: /* Send current contents of region as input to PROCESS.
5551 PROCESS may be a process, a buffer, the name of a process or buffer, or
5552 nil, indicating the current buffer's process.
5553 Called from program, takes three arguments, PROCESS, START and END.
5554 If the region is more than 500 characters long,
5555 it is sent in several bunches. This may happen even for shorter regions.
5556 Output from processes can arrive in between bunches. */)
5557 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5559 Lisp_Object proc = get_process (process);
5560 ptrdiff_t start_byte, end_byte;
5562 validate_region (&start, &end);
5564 start_byte = CHAR_TO_BYTE (XINT (start));
5565 end_byte = CHAR_TO_BYTE (XINT (end));
5567 if (XINT (start) < GPT && XINT (end) > GPT)
5568 move_gap_both (XINT (start), start_byte);
5570 send_process (proc, (char *) BYTE_POS_ADDR (start_byte),
5571 end_byte - start_byte, Fcurrent_buffer ());
5573 return Qnil;
5576 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5577 2, 2, 0,
5578 doc: /* Send PROCESS the contents of STRING as input.
5579 PROCESS may be a process, a buffer, the name of a process or buffer, or
5580 nil, indicating the current buffer's process.
5581 If STRING is more than 500 characters long,
5582 it is sent in several bunches. This may happen even for shorter strings.
5583 Output from processes can arrive in between bunches. */)
5584 (Lisp_Object process, Lisp_Object string)
5586 Lisp_Object proc;
5587 CHECK_STRING (string);
5588 proc = get_process (process);
5589 send_process (proc, SSDATA (string),
5590 SBYTES (string), string);
5591 return Qnil;
5594 /* Return the foreground process group for the tty/pty that
5595 the process P uses. */
5596 static pid_t
5597 emacs_get_tty_pgrp (struct Lisp_Process *p)
5599 pid_t gid = -1;
5601 #ifdef TIOCGPGRP
5602 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5604 int fd;
5605 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5606 master side. Try the slave side. */
5607 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5609 if (fd != -1)
5611 ioctl (fd, TIOCGPGRP, &gid);
5612 emacs_close (fd);
5615 #endif /* defined (TIOCGPGRP ) */
5617 return gid;
5620 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5621 Sprocess_running_child_p, 0, 1, 0,
5622 doc: /* Return t if PROCESS has given the terminal to a child.
5623 If the operating system does not make it possible to find out,
5624 return t unconditionally. */)
5625 (Lisp_Object process)
5627 /* Initialize in case ioctl doesn't exist or gives an error,
5628 in a way that will cause returning t. */
5629 pid_t gid;
5630 Lisp_Object proc;
5631 struct Lisp_Process *p;
5633 proc = get_process (process);
5634 p = XPROCESS (proc);
5636 if (!EQ (p->type, Qreal))
5637 error ("Process %s is not a subprocess",
5638 SDATA (p->name));
5639 if (p->infd < 0)
5640 error ("Process %s is not active",
5641 SDATA (p->name));
5643 gid = emacs_get_tty_pgrp (p);
5645 if (gid == p->pid)
5646 return Qnil;
5647 return Qt;
5650 /* send a signal number SIGNO to PROCESS.
5651 If CURRENT_GROUP is t, that means send to the process group
5652 that currently owns the terminal being used to communicate with PROCESS.
5653 This is used for various commands in shell mode.
5654 If CURRENT_GROUP is lambda, that means send to the process group
5655 that currently owns the terminal, but only if it is NOT the shell itself.
5657 If NOMSG is false, insert signal-announcements into process's buffers
5658 right away.
5660 If we can, we try to signal PROCESS by sending control characters
5661 down the pty. This allows us to signal inferiors who have changed
5662 their uid, for which kill would return an EPERM error. */
5664 static void
5665 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5666 bool nomsg)
5668 Lisp_Object proc;
5669 struct Lisp_Process *p;
5670 pid_t gid;
5671 bool no_pgrp = 0;
5673 proc = get_process (process);
5674 p = XPROCESS (proc);
5676 if (!EQ (p->type, Qreal))
5677 error ("Process %s is not a subprocess",
5678 SDATA (p->name));
5679 if (p->infd < 0)
5680 error ("Process %s is not active",
5681 SDATA (p->name));
5683 if (!p->pty_flag)
5684 current_group = Qnil;
5686 /* If we are using pgrps, get a pgrp number and make it negative. */
5687 if (NILP (current_group))
5688 /* Send the signal to the shell's process group. */
5689 gid = p->pid;
5690 else
5692 #ifdef SIGNALS_VIA_CHARACTERS
5693 /* If possible, send signals to the entire pgrp
5694 by sending an input character to it. */
5696 struct termios t;
5697 cc_t *sig_char = NULL;
5699 tcgetattr (p->infd, &t);
5701 switch (signo)
5703 case SIGINT:
5704 sig_char = &t.c_cc[VINTR];
5705 break;
5707 case SIGQUIT:
5708 sig_char = &t.c_cc[VQUIT];
5709 break;
5711 case SIGTSTP:
5712 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5713 sig_char = &t.c_cc[VSWTCH];
5714 #else
5715 sig_char = &t.c_cc[VSUSP];
5716 #endif
5717 break;
5720 if (sig_char && *sig_char != CDISABLE)
5722 send_process (proc, (char *) sig_char, 1, Qnil);
5723 return;
5725 /* If we can't send the signal with a character,
5726 fall through and send it another way. */
5728 /* The code above may fall through if it can't
5729 handle the signal. */
5730 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5732 #ifdef TIOCGPGRP
5733 /* Get the current pgrp using the tty itself, if we have that.
5734 Otherwise, use the pty to get the pgrp.
5735 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5736 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5737 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5738 His patch indicates that if TIOCGPGRP returns an error, then
5739 we should just assume that p->pid is also the process group id. */
5741 gid = emacs_get_tty_pgrp (p);
5743 if (gid == -1)
5744 /* If we can't get the information, assume
5745 the shell owns the tty. */
5746 gid = p->pid;
5748 /* It is not clear whether anything really can set GID to -1.
5749 Perhaps on some system one of those ioctls can or could do so.
5750 Or perhaps this is vestigial. */
5751 if (gid == -1)
5752 no_pgrp = 1;
5753 #else /* ! defined (TIOCGPGRP ) */
5754 /* Can't select pgrps on this system, so we know that
5755 the child itself heads the pgrp. */
5756 gid = p->pid;
5757 #endif /* ! defined (TIOCGPGRP ) */
5759 /* If current_group is lambda, and the shell owns the terminal,
5760 don't send any signal. */
5761 if (EQ (current_group, Qlambda) && gid == p->pid)
5762 return;
5765 #ifdef SIGCONT
5766 if (signo == SIGCONT)
5768 p->raw_status_new = 0;
5769 pset_status (p, Qrun);
5770 p->tick = ++process_tick;
5771 if (!nomsg)
5773 status_notify (NULL);
5774 redisplay_preserve_echo_area (13);
5777 #endif
5779 /* If we don't have process groups, send the signal to the immediate
5780 subprocess. That isn't really right, but it's better than any
5781 obvious alternative. */
5782 if (no_pgrp)
5784 kill (p->pid, signo);
5785 return;
5788 /* gid may be a pid, or minus a pgrp's number */
5789 #ifdef TIOCSIGSEND
5790 if (!NILP (current_group))
5792 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5793 kill (-gid, signo);
5795 else
5797 gid = - p->pid;
5798 kill (gid, signo);
5800 #else /* ! defined (TIOCSIGSEND) */
5801 kill (-gid, signo);
5802 #endif /* ! defined (TIOCSIGSEND) */
5805 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5806 doc: /* Interrupt process PROCESS.
5807 PROCESS may be a process, a buffer, or the name of a process or buffer.
5808 No arg or nil means current buffer's process.
5809 Second arg CURRENT-GROUP non-nil means send signal to
5810 the current process-group of the process's controlling terminal
5811 rather than to the process's own process group.
5812 If the process is a shell, this means interrupt current subjob
5813 rather than the shell.
5815 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5816 don't send the signal. */)
5817 (Lisp_Object process, Lisp_Object current_group)
5819 process_send_signal (process, SIGINT, current_group, 0);
5820 return process;
5823 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5824 doc: /* Kill process PROCESS. May be process or name of one.
5825 See function `interrupt-process' for more details on usage. */)
5826 (Lisp_Object process, Lisp_Object current_group)
5828 process_send_signal (process, SIGKILL, current_group, 0);
5829 return process;
5832 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5833 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5834 See function `interrupt-process' for more details on usage. */)
5835 (Lisp_Object process, Lisp_Object current_group)
5837 process_send_signal (process, SIGQUIT, current_group, 0);
5838 return process;
5841 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
5842 doc: /* Stop process PROCESS. May be process or name of one.
5843 See function `interrupt-process' for more details on usage.
5844 If PROCESS is a network or serial process, inhibit handling of incoming
5845 traffic. */)
5846 (Lisp_Object process, Lisp_Object current_group)
5848 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5850 struct Lisp_Process *p;
5852 p = XPROCESS (process);
5853 if (NILP (p->command)
5854 && p->infd >= 0)
5856 FD_CLR (p->infd, &input_wait_mask);
5857 FD_CLR (p->infd, &non_keyboard_wait_mask);
5859 pset_command (p, Qt);
5860 return process;
5862 #ifndef SIGTSTP
5863 error ("No SIGTSTP support");
5864 #else
5865 process_send_signal (process, SIGTSTP, current_group, 0);
5866 #endif
5867 return process;
5870 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
5871 doc: /* Continue process PROCESS. May be process or name of one.
5872 See function `interrupt-process' for more details on usage.
5873 If PROCESS is a network or serial process, resume handling of incoming
5874 traffic. */)
5875 (Lisp_Object process, Lisp_Object current_group)
5877 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5879 struct Lisp_Process *p;
5881 p = XPROCESS (process);
5882 if (EQ (p->command, Qt)
5883 && p->infd >= 0
5884 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
5886 FD_SET (p->infd, &input_wait_mask);
5887 FD_SET (p->infd, &non_keyboard_wait_mask);
5888 #ifdef WINDOWSNT
5889 if (fd_info[ p->infd ].flags & FILE_SERIAL)
5890 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
5891 #else /* not WINDOWSNT */
5892 tcflush (p->infd, TCIFLUSH);
5893 #endif /* not WINDOWSNT */
5895 pset_command (p, Qnil);
5896 return process;
5898 #ifdef SIGCONT
5899 process_send_signal (process, SIGCONT, current_group, 0);
5900 #else
5901 error ("No SIGCONT support");
5902 #endif
5903 return process;
5906 /* Return the integer value of the signal whose abbreviation is ABBR,
5907 or a negative number if there is no such signal. */
5908 static int
5909 abbr_to_signal (char const *name)
5911 int i, signo;
5912 char sigbuf[20]; /* Large enough for all valid signal abbreviations. */
5914 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
5915 name += 3;
5917 for (i = 0; i < sizeof sigbuf; i++)
5919 sigbuf[i] = c_toupper (name[i]);
5920 if (! sigbuf[i])
5921 return str2sig (sigbuf, &signo) == 0 ? signo : -1;
5924 return -1;
5927 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
5928 2, 2, "sProcess (name or number): \nnSignal code: ",
5929 doc: /* Send PROCESS the signal with code SIGCODE.
5930 PROCESS may also be a number specifying the process id of the
5931 process to signal; in this case, the process need not be a child of
5932 this Emacs.
5933 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
5934 (Lisp_Object process, Lisp_Object sigcode)
5936 pid_t pid;
5937 int signo;
5939 if (STRINGP (process))
5941 Lisp_Object tem = Fget_process (process);
5942 if (NILP (tem))
5944 Lisp_Object process_number =
5945 string_to_number (SSDATA (process), 10, 1);
5946 if (INTEGERP (process_number) || FLOATP (process_number))
5947 tem = process_number;
5949 process = tem;
5951 else if (!NUMBERP (process))
5952 process = get_process (process);
5954 if (NILP (process))
5955 return process;
5957 if (NUMBERP (process))
5958 CONS_TO_INTEGER (process, pid_t, pid);
5959 else
5961 CHECK_PROCESS (process);
5962 pid = XPROCESS (process)->pid;
5963 if (pid <= 0)
5964 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
5967 if (INTEGERP (sigcode))
5969 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
5970 signo = XINT (sigcode);
5972 else
5974 char *name;
5976 CHECK_SYMBOL (sigcode);
5977 name = SSDATA (SYMBOL_NAME (sigcode));
5979 signo = abbr_to_signal (name);
5980 if (signo < 0)
5981 error ("Undefined signal name %s", name);
5984 return make_number (kill (pid, signo));
5987 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
5988 doc: /* Make PROCESS see end-of-file in its input.
5989 EOF comes after any text already sent to it.
5990 PROCESS may be a process, a buffer, the name of a process or buffer, or
5991 nil, indicating the current buffer's process.
5992 If PROCESS is a network connection, or is a process communicating
5993 through a pipe (as opposed to a pty), then you cannot send any more
5994 text to PROCESS after you call this function.
5995 If PROCESS is a serial process, wait until all output written to the
5996 process has been transmitted to the serial port. */)
5997 (Lisp_Object process)
5999 Lisp_Object proc;
6000 struct coding_system *coding;
6002 if (DATAGRAM_CONN_P (process))
6003 return process;
6005 proc = get_process (process);
6006 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6008 /* Make sure the process is really alive. */
6009 if (XPROCESS (proc)->raw_status_new)
6010 update_status (XPROCESS (proc));
6011 if (! EQ (XPROCESS (proc)->status, Qrun))
6012 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6014 if (CODING_REQUIRE_FLUSHING (coding))
6016 coding->mode |= CODING_MODE_LAST_BLOCK;
6017 send_process (proc, "", 0, Qnil);
6020 if (XPROCESS (proc)->pty_flag)
6021 send_process (proc, "\004", 1, Qnil);
6022 else if (EQ (XPROCESS (proc)->type, Qserial))
6024 #ifndef WINDOWSNT
6025 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6026 report_file_error ("Failed tcdrain", Qnil);
6027 #endif /* not WINDOWSNT */
6028 /* Do nothing on Windows because writes are blocking. */
6030 else
6032 int old_outfd = XPROCESS (proc)->outfd;
6033 int new_outfd;
6035 #ifdef HAVE_SHUTDOWN
6036 /* If this is a network connection, or socketpair is used
6037 for communication with the subprocess, call shutdown to cause EOF.
6038 (In some old system, shutdown to socketpair doesn't work.
6039 Then we just can't win.) */
6040 if (EQ (XPROCESS (proc)->type, Qnetwork)
6041 || XPROCESS (proc)->infd == old_outfd)
6042 shutdown (old_outfd, 1);
6043 #endif
6044 close_process_fd (&XPROCESS (proc)->open_fd[WRITE_TO_SUBPROCESS]);
6045 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6046 if (new_outfd < 0)
6047 report_file_error ("Opening null device", Qnil);
6048 XPROCESS (proc)->open_fd[WRITE_TO_SUBPROCESS] = new_outfd;
6049 XPROCESS (proc)->outfd = new_outfd;
6051 if (!proc_encode_coding_system[new_outfd])
6052 proc_encode_coding_system[new_outfd]
6053 = xmalloc (sizeof (struct coding_system));
6054 *proc_encode_coding_system[new_outfd]
6055 = *proc_encode_coding_system[old_outfd];
6056 memset (proc_encode_coding_system[old_outfd], 0,
6057 sizeof (struct coding_system));
6059 return process;
6062 /* The main Emacs thread records child processes in three places:
6064 - Vprocess_alist, for asynchronous subprocesses, which are child
6065 processes visible to Lisp.
6067 - deleted_pid_list, for child processes invisible to Lisp,
6068 typically because of delete-process. These are recorded so that
6069 the processes can be reaped when they exit, so that the operating
6070 system's process table is not cluttered by zombies.
6072 - the local variable PID in Fcall_process, call_process_cleanup and
6073 call_process_kill, for synchronous subprocesses.
6074 record_unwind_protect is used to make sure this process is not
6075 forgotten: if the user interrupts call-process and the child
6076 process refuses to exit immediately even with two C-g's,
6077 call_process_kill adds PID's contents to deleted_pid_list before
6078 returning.
6080 The main Emacs thread invokes waitpid only on child processes that
6081 it creates and that have not been reaped. This avoid races on
6082 platforms such as GTK, where other threads create their own
6083 subprocesses which the main thread should not reap. For example,
6084 if the main thread attempted to reap an already-reaped child, it
6085 might inadvertently reap a GTK-created process that happened to
6086 have the same process ID. */
6088 /* LIB_CHILD_HANDLER is a SIGCHLD handler that Emacs calls while doing
6089 its own SIGCHLD handling. On POSIXish systems, glib needs this to
6090 keep track of its own children. GNUstep is similar. */
6092 static void dummy_handler (int sig) {}
6093 static signal_handler_t volatile lib_child_handler;
6095 /* Handle a SIGCHLD signal by looking for known child processes of
6096 Emacs whose status have changed. For each one found, record its
6097 new status.
6099 All we do is change the status; we do not run sentinels or print
6100 notifications. That is saved for the next time keyboard input is
6101 done, in order to avoid timing errors.
6103 ** WARNING: this can be called during garbage collection.
6104 Therefore, it must not be fooled by the presence of mark bits in
6105 Lisp objects.
6107 ** USG WARNING: Although it is not obvious from the documentation
6108 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6109 signal() before executing at least one wait(), otherwise the
6110 handler will be called again, resulting in an infinite loop. The
6111 relevant portion of the documentation reads "SIGCLD signals will be
6112 queued and the signal-catching function will be continually
6113 reentered until the queue is empty". Invoking signal() causes the
6114 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6115 Inc.
6117 ** Malloc WARNING: This should never call malloc either directly or
6118 indirectly; if it does, that is a bug */
6120 static void
6121 handle_child_signal (int sig)
6123 Lisp_Object tail, proc;
6125 /* Find the process that signaled us, and record its status. */
6127 /* The process can have been deleted by Fdelete_process, or have
6128 been started asynchronously by Fcall_process. */
6129 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6131 bool all_pids_are_fixnums
6132 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
6133 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
6134 Lisp_Object head = XCAR (tail);
6135 Lisp_Object xpid;
6136 if (! CONSP (head))
6137 continue;
6138 xpid = XCAR (head);
6139 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
6141 pid_t deleted_pid;
6142 if (INTEGERP (xpid))
6143 deleted_pid = XINT (xpid);
6144 else
6145 deleted_pid = XFLOAT_DATA (xpid);
6146 if (child_status_changed (deleted_pid, 0, 0))
6148 if (STRINGP (XCDR (head)))
6149 unlink (SSDATA (XCDR (head)));
6150 XSETCAR (tail, Qnil);
6155 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6156 FOR_EACH_PROCESS (tail, proc)
6158 struct Lisp_Process *p = XPROCESS (proc);
6159 int status;
6161 if (p->alive
6162 && child_status_changed (p->pid, &status, WUNTRACED | WCONTINUED))
6164 /* Change the status of the process that was found. */
6165 p->tick = ++process_tick;
6166 p->raw_status = status;
6167 p->raw_status_new = 1;
6169 /* If process has terminated, stop waiting for its output. */
6170 if (WIFSIGNALED (status) || WIFEXITED (status))
6172 bool clear_desc_flag = 0;
6173 p->alive = 0;
6174 if (p->infd >= 0)
6175 clear_desc_flag = 1;
6177 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
6178 if (clear_desc_flag)
6180 FD_CLR (p->infd, &input_wait_mask);
6181 FD_CLR (p->infd, &non_keyboard_wait_mask);
6187 lib_child_handler (sig);
6188 #ifdef NS_IMPL_GNUSTEP
6189 /* NSTask in GNUStep sets its child handler each time it is called.
6190 So we must re-set ours. */
6191 catch_child_signal();
6192 #endif
6195 static void
6196 deliver_child_signal (int sig)
6198 deliver_process_signal (sig, handle_child_signal);
6202 static Lisp_Object
6203 exec_sentinel_error_handler (Lisp_Object error_val)
6205 cmd_error_internal (error_val, "error in process sentinel: ");
6206 Vinhibit_quit = Qt;
6207 update_echo_area ();
6208 Fsleep_for (make_number (2), Qnil);
6209 return Qt;
6212 static void
6213 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6215 Lisp_Object sentinel, odeactivate;
6216 struct Lisp_Process *p = XPROCESS (proc);
6217 ptrdiff_t count = SPECPDL_INDEX ();
6218 bool outer_running_asynch_code = running_asynch_code;
6219 int waiting = waiting_for_user_input_p;
6221 if (inhibit_sentinels)
6222 return;
6224 /* No need to gcpro these, because all we do with them later
6225 is test them for EQness, and none of them should be a string. */
6226 odeactivate = Vdeactivate_mark;
6227 #if 0
6228 Lisp_Object obuffer, okeymap;
6229 XSETBUFFER (obuffer, current_buffer);
6230 okeymap = BVAR (current_buffer, keymap);
6231 #endif
6233 /* There's no good reason to let sentinels change the current
6234 buffer, and many callers of accept-process-output, sit-for, and
6235 friends don't expect current-buffer to be changed from under them. */
6236 record_unwind_current_buffer ();
6238 sentinel = p->sentinel;
6240 /* Inhibit quit so that random quits don't screw up a running filter. */
6241 specbind (Qinhibit_quit, Qt);
6242 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6244 /* In case we get recursively called,
6245 and we already saved the match data nonrecursively,
6246 save the same match data in safely recursive fashion. */
6247 if (outer_running_asynch_code)
6249 Lisp_Object tem;
6250 tem = Fmatch_data (Qnil, Qnil, Qnil);
6251 restore_search_regs ();
6252 record_unwind_save_match_data ();
6253 Fset_match_data (tem, Qt);
6256 /* For speed, if a search happens within this code,
6257 save the match data in a special nonrecursive fashion. */
6258 running_asynch_code = 1;
6260 internal_condition_case_1 (read_process_output_call,
6261 list3 (sentinel, proc, reason),
6262 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6263 exec_sentinel_error_handler);
6265 /* If we saved the match data nonrecursively, restore it now. */
6266 restore_search_regs ();
6267 running_asynch_code = outer_running_asynch_code;
6269 Vdeactivate_mark = odeactivate;
6271 /* Restore waiting_for_user_input_p as it was
6272 when we were called, in case the filter clobbered it. */
6273 waiting_for_user_input_p = waiting;
6275 #if 0
6276 if (! EQ (Fcurrent_buffer (), obuffer)
6277 || ! EQ (current_buffer->keymap, okeymap))
6278 #endif
6279 /* But do it only if the caller is actually going to read events.
6280 Otherwise there's no need to make him wake up, and it could
6281 cause trouble (for example it would make sit_for return). */
6282 if (waiting_for_user_input_p == -1)
6283 record_asynch_buffer_change ();
6285 unbind_to (count, Qnil);
6288 /* Report all recent events of a change in process status
6289 (either run the sentinel or output a message).
6290 This is usually done while Emacs is waiting for keyboard input
6291 but can be done at other times. */
6293 static void
6294 status_notify (struct Lisp_Process *deleting_process)
6296 register Lisp_Object proc;
6297 Lisp_Object tail, msg;
6298 struct gcpro gcpro1, gcpro2;
6300 tail = Qnil;
6301 msg = Qnil;
6302 /* We need to gcpro tail; if read_process_output calls a filter
6303 which deletes a process and removes the cons to which tail points
6304 from Vprocess_alist, and then causes a GC, tail is an unprotected
6305 reference. */
6306 GCPRO2 (tail, msg);
6308 /* Set this now, so that if new processes are created by sentinels
6309 that we run, we get called again to handle their status changes. */
6310 update_tick = process_tick;
6312 FOR_EACH_PROCESS (tail, proc)
6314 Lisp_Object symbol;
6315 register struct Lisp_Process *p = XPROCESS (proc);
6317 if (p->tick != p->update_tick)
6319 p->update_tick = p->tick;
6321 /* If process is still active, read any output that remains. */
6322 while (! EQ (p->filter, Qt)
6323 && ! EQ (p->status, Qconnect)
6324 && ! EQ (p->status, Qlisten)
6325 /* Network or serial process not stopped: */
6326 && ! EQ (p->command, Qt)
6327 && p->infd >= 0
6328 && p != deleting_process
6329 && read_process_output (proc, p->infd) > 0);
6331 /* Get the text to use for the message. */
6332 if (p->raw_status_new)
6333 update_status (p);
6334 msg = status_message (p);
6336 /* If process is terminated, deactivate it or delete it. */
6337 symbol = p->status;
6338 if (CONSP (p->status))
6339 symbol = XCAR (p->status);
6341 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6342 || EQ (symbol, Qclosed))
6344 if (delete_exited_processes)
6345 remove_process (proc);
6346 else
6347 deactivate_process (proc);
6350 /* The actions above may have further incremented p->tick.
6351 So set p->update_tick again so that an error in the sentinel will
6352 not cause this code to be run again. */
6353 p->update_tick = p->tick;
6354 /* Now output the message suitably. */
6355 exec_sentinel (proc, msg);
6357 } /* end for */
6359 update_mode_lines++; /* In case buffers use %s in mode-line-format. */
6360 UNGCPRO;
6363 DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel,
6364 Sinternal_default_process_sentinel, 2, 2, 0,
6365 doc: /* Function used as default sentinel for processes. */)
6366 (Lisp_Object proc, Lisp_Object msg)
6368 Lisp_Object buffer, symbol;
6369 struct Lisp_Process *p;
6370 CHECK_PROCESS (proc);
6371 p = XPROCESS (proc);
6372 buffer = p->buffer;
6373 symbol = p->status;
6374 if (CONSP (symbol))
6375 symbol = XCAR (symbol);
6377 if (!EQ (symbol, Qrun) && !NILP (buffer))
6379 Lisp_Object tem;
6380 struct buffer *old = current_buffer;
6381 ptrdiff_t opoint, opoint_byte;
6382 ptrdiff_t before, before_byte;
6384 /* Avoid error if buffer is deleted
6385 (probably that's why the process is dead, too). */
6386 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
6387 return Qnil;
6388 Fset_buffer (buffer);
6390 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
6391 msg = (code_convert_string_norecord
6392 (msg, Vlocale_coding_system, 1));
6394 opoint = PT;
6395 opoint_byte = PT_BYTE;
6396 /* Insert new output into buffer
6397 at the current end-of-output marker,
6398 thus preserving logical ordering of input and output. */
6399 if (XMARKER (p->mark)->buffer)
6400 Fgoto_char (p->mark);
6401 else
6402 SET_PT_BOTH (ZV, ZV_BYTE);
6404 before = PT;
6405 before_byte = PT_BYTE;
6407 tem = BVAR (current_buffer, read_only);
6408 bset_read_only (current_buffer, Qnil);
6409 insert_string ("\nProcess ");
6410 { /* FIXME: temporary kludge. */
6411 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
6412 insert_string (" ");
6413 Finsert (1, &msg);
6414 bset_read_only (current_buffer, tem);
6415 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6417 if (opoint >= before)
6418 SET_PT_BOTH (opoint + (PT - before),
6419 opoint_byte + (PT_BYTE - before_byte));
6420 else
6421 SET_PT_BOTH (opoint, opoint_byte);
6423 set_buffer_internal (old);
6425 return Qnil;
6429 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6430 Sset_process_coding_system, 1, 3, 0,
6431 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6432 DECODING will be used to decode subprocess output and ENCODING to
6433 encode subprocess input. */)
6434 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6436 register struct Lisp_Process *p;
6438 CHECK_PROCESS (process);
6439 p = XPROCESS (process);
6440 if (p->infd < 0)
6441 error ("Input file descriptor of %s closed", SDATA (p->name));
6442 if (p->outfd < 0)
6443 error ("Output file descriptor of %s closed", SDATA (p->name));
6444 Fcheck_coding_system (decoding);
6445 Fcheck_coding_system (encoding);
6446 encoding = coding_inherit_eol_type (encoding, Qnil);
6447 pset_decode_coding_system (p, decoding);
6448 pset_encode_coding_system (p, encoding);
6449 setup_process_coding_systems (process);
6451 return Qnil;
6454 DEFUN ("process-coding-system",
6455 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6456 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6457 (register Lisp_Object process)
6459 CHECK_PROCESS (process);
6460 return Fcons (XPROCESS (process)->decode_coding_system,
6461 XPROCESS (process)->encode_coding_system);
6464 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6465 Sset_process_filter_multibyte, 2, 2, 0,
6466 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6467 If FLAG is non-nil, the filter is given multibyte strings.
6468 If FLAG is nil, the filter is given unibyte strings. In this case,
6469 all character code conversion except for end-of-line conversion is
6470 suppressed. */)
6471 (Lisp_Object process, Lisp_Object flag)
6473 register struct Lisp_Process *p;
6475 CHECK_PROCESS (process);
6476 p = XPROCESS (process);
6477 if (NILP (flag))
6478 pset_decode_coding_system
6479 (p, raw_text_coding_system (p->decode_coding_system));
6480 setup_process_coding_systems (process);
6482 return Qnil;
6485 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6486 Sprocess_filter_multibyte_p, 1, 1, 0,
6487 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6488 (Lisp_Object process)
6490 register struct Lisp_Process *p;
6491 struct coding_system *coding;
6493 CHECK_PROCESS (process);
6494 p = XPROCESS (process);
6495 coding = proc_decode_coding_system[p->infd];
6496 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6502 # ifdef HAVE_GPM
6504 void
6505 add_gpm_wait_descriptor (int desc)
6507 add_keyboard_wait_descriptor (desc);
6510 void
6511 delete_gpm_wait_descriptor (int desc)
6513 delete_keyboard_wait_descriptor (desc);
6516 # endif
6518 # ifdef USABLE_SIGIO
6520 /* Return true if *MASK has a bit set
6521 that corresponds to one of the keyboard input descriptors. */
6523 static bool
6524 keyboard_bit_set (fd_set *mask)
6526 int fd;
6528 for (fd = 0; fd <= max_input_desc; fd++)
6529 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6530 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6531 return 1;
6533 return 0;
6535 # endif
6537 #else /* not subprocesses */
6539 /* Defined on msdos.c. */
6540 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
6541 struct timespec *, void *);
6543 /* Implementation of wait_reading_process_output, assuming that there
6544 are no subprocesses. Used only by the MS-DOS build.
6546 Wait for timeout to elapse and/or keyboard input to be available.
6548 TIME_LIMIT is:
6549 timeout in seconds
6550 If negative, gobble data immediately available but don't wait for any.
6552 NSECS is:
6553 an additional duration to wait, measured in nanoseconds
6554 If TIME_LIMIT is zero, then:
6555 If NSECS == 0, there is no limit.
6556 If NSECS > 0, the timeout consists of NSECS only.
6557 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6559 READ_KBD is:
6560 0 to ignore keyboard input, or
6561 1 to return when input is available, or
6562 -1 means caller will actually read the input, so don't throw to
6563 the quit handler.
6565 see full version for other parameters. We know that wait_proc will
6566 always be NULL, since `subprocesses' isn't defined.
6568 DO_DISPLAY means redisplay should be done to show subprocess
6569 output that arrives.
6571 Return true if we received input from any process. */
6573 bool
6574 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6575 bool do_display,
6576 Lisp_Object wait_for_cell,
6577 struct Lisp_Process *wait_proc, int just_wait_proc)
6579 register int nfds;
6580 struct timespec end_time, timeout;
6582 if (time_limit < 0)
6584 time_limit = 0;
6585 nsecs = -1;
6587 else if (TYPE_MAXIMUM (time_t) < time_limit)
6588 time_limit = TYPE_MAXIMUM (time_t);
6590 /* What does time_limit really mean? */
6591 if (time_limit || nsecs > 0)
6593 timeout = make_timespec (time_limit, nsecs);
6594 end_time = timespec_add (current_timespec (), timeout);
6597 /* Turn off periodic alarms (in case they are in use)
6598 and then turn off any other atimers,
6599 because the select emulator uses alarms. */
6600 stop_polling ();
6601 turn_on_atimers (0);
6603 while (1)
6605 bool timeout_reduced_for_timers = 0;
6606 fd_set waitchannels;
6607 int xerrno;
6609 /* If calling from keyboard input, do not quit
6610 since we want to return C-g as an input character.
6611 Otherwise, do pending quit if requested. */
6612 if (read_kbd >= 0)
6613 QUIT;
6615 /* Exit now if the cell we're waiting for became non-nil. */
6616 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6617 break;
6619 /* Compute time from now till when time limit is up. */
6620 /* Exit if already run out. */
6621 if (nsecs < 0)
6623 /* A negative timeout means
6624 gobble output available now
6625 but don't wait at all. */
6627 timeout = make_timespec (0, 0);
6629 else if (time_limit || nsecs > 0)
6631 struct timespec now = current_timespec ();
6632 if (timespec_cmp (end_time, now) <= 0)
6633 break;
6634 timeout = timespec_sub (end_time, now);
6636 else
6638 timeout = make_timespec (100000, 0);
6641 /* If our caller will not immediately handle keyboard events,
6642 run timer events directly.
6643 (Callers that will immediately read keyboard events
6644 call timer_delay on their own.) */
6645 if (NILP (wait_for_cell))
6647 struct timespec timer_delay;
6651 unsigned old_timers_run = timers_run;
6652 timer_delay = timer_check ();
6653 if (timers_run != old_timers_run && do_display)
6654 /* We must retry, since a timer may have requeued itself
6655 and that could alter the time delay. */
6656 redisplay_preserve_echo_area (14);
6657 else
6658 break;
6660 while (!detect_input_pending ());
6662 /* If there is unread keyboard input, also return. */
6663 if (read_kbd != 0
6664 && requeued_events_pending_p ())
6665 break;
6667 if (timespec_valid_p (timer_delay) && nsecs >= 0)
6669 if (timespec_cmp (timer_delay, timeout) < 0)
6671 timeout = timer_delay;
6672 timeout_reduced_for_timers = 1;
6677 /* Cause C-g and alarm signals to take immediate action,
6678 and cause input available signals to zero out timeout. */
6679 if (read_kbd < 0)
6680 set_waiting_for_input (&timeout);
6682 /* If a frame has been newly mapped and needs updating,
6683 reprocess its display stuff. */
6684 if (frame_garbaged && do_display)
6686 clear_waiting_for_input ();
6687 redisplay_preserve_echo_area (15);
6688 if (read_kbd < 0)
6689 set_waiting_for_input (&timeout);
6692 /* Wait till there is something to do. */
6693 FD_ZERO (&waitchannels);
6694 if (read_kbd && detect_input_pending ())
6695 nfds = 0;
6696 else
6698 if (read_kbd || !NILP (wait_for_cell))
6699 FD_SET (0, &waitchannels);
6700 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6703 xerrno = errno;
6705 /* Make C-g and alarm signals set flags again */
6706 clear_waiting_for_input ();
6708 /* If we woke up due to SIGWINCH, actually change size now. */
6709 do_pending_window_change (0);
6711 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6712 /* We waited the full specified time, so return now. */
6713 break;
6715 if (nfds == -1)
6717 /* If the system call was interrupted, then go around the
6718 loop again. */
6719 if (xerrno == EINTR)
6720 FD_ZERO (&waitchannels);
6721 else
6722 report_file_errno ("Failed select", Qnil, xerrno);
6725 /* Check for keyboard input */
6727 if (read_kbd
6728 && detect_input_pending_run_timers (do_display))
6730 swallow_events (do_display);
6731 if (detect_input_pending_run_timers (do_display))
6732 break;
6735 /* If there is unread keyboard input, also return. */
6736 if (read_kbd
6737 && requeued_events_pending_p ())
6738 break;
6740 /* If wait_for_cell. check for keyboard input
6741 but don't run any timers.
6742 ??? (It seems wrong to me to check for keyboard
6743 input at all when wait_for_cell, but the code
6744 has been this way since July 1994.
6745 Try changing this after version 19.31.) */
6746 if (! NILP (wait_for_cell)
6747 && detect_input_pending ())
6749 swallow_events (do_display);
6750 if (detect_input_pending ())
6751 break;
6754 /* Exit now if the cell we're waiting for became non-nil. */
6755 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6756 break;
6759 start_polling ();
6761 return 0;
6764 #endif /* not subprocesses */
6766 /* The following functions are needed even if async subprocesses are
6767 not supported. Some of them are no-op stubs in that case. */
6769 /* Add DESC to the set of keyboard input descriptors. */
6771 void
6772 add_keyboard_wait_descriptor (int desc)
6774 #ifdef subprocesses /* actually means "not MSDOS" */
6775 FD_SET (desc, &input_wait_mask);
6776 FD_SET (desc, &non_process_wait_mask);
6777 if (desc > max_input_desc)
6778 max_input_desc = desc;
6779 #endif
6782 /* From now on, do not expect DESC to give keyboard input. */
6784 void
6785 delete_keyboard_wait_descriptor (int desc)
6787 #ifdef subprocesses
6788 FD_CLR (desc, &input_wait_mask);
6789 FD_CLR (desc, &non_process_wait_mask);
6790 delete_input_desc (desc);
6791 #endif
6794 /* Setup coding systems of PROCESS. */
6796 void
6797 setup_process_coding_systems (Lisp_Object process)
6799 #ifdef subprocesses
6800 struct Lisp_Process *p = XPROCESS (process);
6801 int inch = p->infd;
6802 int outch = p->outfd;
6803 Lisp_Object coding_system;
6805 if (inch < 0 || outch < 0)
6806 return;
6808 if (!proc_decode_coding_system[inch])
6809 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
6810 coding_system = p->decode_coding_system;
6811 if (EQ (p->filter, Qinternal_default_process_filter)
6812 && BUFFERP (p->buffer))
6814 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
6815 coding_system = raw_text_coding_system (coding_system);
6817 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
6819 if (!proc_encode_coding_system[outch])
6820 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
6821 setup_coding_system (p->encode_coding_system,
6822 proc_encode_coding_system[outch]);
6823 #endif
6826 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
6827 doc: /* Return the (or a) process associated with BUFFER.
6828 BUFFER may be a buffer or the name of one. */)
6829 (register Lisp_Object buffer)
6831 #ifdef subprocesses
6832 register Lisp_Object buf, tail, proc;
6834 if (NILP (buffer)) return Qnil;
6835 buf = Fget_buffer (buffer);
6836 if (NILP (buf)) return Qnil;
6838 FOR_EACH_PROCESS (tail, proc)
6839 if (EQ (XPROCESS (proc)->buffer, buf))
6840 return proc;
6841 #endif /* subprocesses */
6842 return Qnil;
6845 DEFUN ("process-inherit-coding-system-flag",
6846 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
6847 1, 1, 0,
6848 doc: /* Return the value of inherit-coding-system flag for PROCESS.
6849 If this flag is t, `buffer-file-coding-system' of the buffer
6850 associated with PROCESS will inherit the coding system used to decode
6851 the process output. */)
6852 (register Lisp_Object process)
6854 #ifdef subprocesses
6855 CHECK_PROCESS (process);
6856 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
6857 #else
6858 /* Ignore the argument and return the value of
6859 inherit-process-coding-system. */
6860 return inherit_process_coding_system ? Qt : Qnil;
6861 #endif
6864 /* Kill all processes associated with `buffer'.
6865 If `buffer' is nil, kill all processes */
6867 void
6868 kill_buffer_processes (Lisp_Object buffer)
6870 #ifdef subprocesses
6871 Lisp_Object tail, proc;
6873 FOR_EACH_PROCESS (tail, proc)
6874 if (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer))
6876 if (NETCONN_P (proc) || SERIALCONN_P (proc))
6877 Fdelete_process (proc);
6878 else if (XPROCESS (proc)->infd >= 0)
6879 process_send_signal (proc, SIGHUP, Qnil, 1);
6881 #else /* subprocesses */
6882 /* Since we have no subprocesses, this does nothing. */
6883 #endif /* subprocesses */
6886 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
6887 Swaiting_for_user_input_p, 0, 0, 0,
6888 doc: /* Return non-nil if Emacs is waiting for input from the user.
6889 This is intended for use by asynchronous process output filters and sentinels. */)
6890 (void)
6892 #ifdef subprocesses
6893 return (waiting_for_user_input_p ? Qt : Qnil);
6894 #else
6895 return Qnil;
6896 #endif
6899 /* Stop reading input from keyboard sources. */
6901 void
6902 hold_keyboard_input (void)
6904 kbd_is_on_hold = 1;
6907 /* Resume reading input from keyboard sources. */
6909 void
6910 unhold_keyboard_input (void)
6912 kbd_is_on_hold = 0;
6915 /* Return true if keyboard input is on hold, zero otherwise. */
6917 bool
6918 kbd_on_hold_p (void)
6920 return kbd_is_on_hold;
6924 /* Enumeration of and access to system processes a-la ps(1). */
6926 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
6927 0, 0, 0,
6928 doc: /* Return a list of numerical process IDs of all running processes.
6929 If this functionality is unsupported, return nil.
6931 See `process-attributes' for getting attributes of a process given its ID. */)
6932 (void)
6934 return list_system_processes ();
6937 DEFUN ("process-attributes", Fprocess_attributes,
6938 Sprocess_attributes, 1, 1, 0,
6939 doc: /* Return attributes of the process given by its PID, a number.
6941 Value is an alist where each element is a cons cell of the form
6943 \(KEY . VALUE)
6945 If this functionality is unsupported, the value is nil.
6947 See `list-system-processes' for getting a list of all process IDs.
6949 The KEYs of the attributes that this function may return are listed
6950 below, together with the type of the associated VALUE (in parentheses).
6951 Not all platforms support all of these attributes; unsupported
6952 attributes will not appear in the returned alist.
6953 Unless explicitly indicated otherwise, numbers can have either
6954 integer or floating point values.
6956 euid -- Effective user User ID of the process (number)
6957 user -- User name corresponding to euid (string)
6958 egid -- Effective user Group ID of the process (number)
6959 group -- Group name corresponding to egid (string)
6960 comm -- Command name (executable name only) (string)
6961 state -- Process state code, such as "S", "R", or "T" (string)
6962 ppid -- Parent process ID (number)
6963 pgrp -- Process group ID (number)
6964 sess -- Session ID, i.e. process ID of session leader (number)
6965 ttname -- Controlling tty name (string)
6966 tpgid -- ID of foreground process group on the process's tty (number)
6967 minflt -- number of minor page faults (number)
6968 majflt -- number of major page faults (number)
6969 cminflt -- cumulative number of minor page faults (number)
6970 cmajflt -- cumulative number of major page faults (number)
6971 utime -- user time used by the process, in (current-time) format,
6972 which is a list of integers (HIGH LOW USEC PSEC)
6973 stime -- system time used by the process (current-time)
6974 time -- sum of utime and stime (current-time)
6975 cutime -- user time used by the process and its children (current-time)
6976 cstime -- system time used by the process and its children (current-time)
6977 ctime -- sum of cutime and cstime (current-time)
6978 pri -- priority of the process (number)
6979 nice -- nice value of the process (number)
6980 thcount -- process thread count (number)
6981 start -- time the process started (current-time)
6982 vsize -- virtual memory size of the process in KB's (number)
6983 rss -- resident set size of the process in KB's (number)
6984 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
6985 pcpu -- percents of CPU time used by the process (floating-point number)
6986 pmem -- percents of total physical memory used by process's resident set
6987 (floating-point number)
6988 args -- command line which invoked the process (string). */)
6989 ( Lisp_Object pid)
6991 return system_process_attributes (pid);
6994 /* Arrange to catch SIGCHLD if this hasn't already been arranged.
6995 Invoke this after init_process_emacs, and after glib and/or GNUstep
6996 futz with the SIGCHLD handler, but before Emacs forks any children.
6997 This function's caller should block SIGCHLD. */
6999 #ifndef NS_IMPL_GNUSTEP
7000 static
7001 #endif
7002 void
7003 catch_child_signal (void)
7005 struct sigaction action, old_action;
7006 emacs_sigaction_init (&action, deliver_child_signal);
7007 block_child_signal ();
7008 sigaction (SIGCHLD, &action, &old_action);
7009 eassert (! (old_action.sa_flags & SA_SIGINFO));
7011 if (old_action.sa_handler != deliver_child_signal)
7012 lib_child_handler
7013 = (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7014 ? dummy_handler
7015 : old_action.sa_handler);
7016 unblock_child_signal ();
7020 /* This is not called "init_process" because that is the name of a
7021 Mach system call, so it would cause problems on Darwin systems. */
7022 void
7023 init_process_emacs (void)
7025 #ifdef subprocesses
7026 register int i;
7028 inhibit_sentinels = 0;
7030 #ifndef CANNOT_DUMP
7031 if (! noninteractive || initialized)
7032 #endif
7034 #if defined HAVE_GLIB && !defined WINDOWSNT
7035 /* Tickle glib's child-handling code. Ask glib to wait for Emacs itself;
7036 this should always fail, but is enough to initialize glib's
7037 private SIGCHLD handler, allowing catch_child_signal to copy
7038 it into lib_child_handler. */
7039 g_source_unref (g_child_watch_source_new (getpid ()));
7040 #endif
7041 catch_child_signal ();
7044 FD_ZERO (&input_wait_mask);
7045 FD_ZERO (&non_keyboard_wait_mask);
7046 FD_ZERO (&non_process_wait_mask);
7047 FD_ZERO (&write_mask);
7048 max_process_desc = max_input_desc = -1;
7049 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7051 #ifdef NON_BLOCKING_CONNECT
7052 FD_ZERO (&connect_wait_mask);
7053 num_pending_connects = 0;
7054 #endif
7056 #ifdef ADAPTIVE_READ_BUFFERING
7057 process_output_delay_count = 0;
7058 process_output_skip = 0;
7059 #endif
7061 /* Don't do this, it caused infinite select loops. The display
7062 method should call add_keyboard_wait_descriptor on stdin if it
7063 needs that. */
7064 #if 0
7065 FD_SET (0, &input_wait_mask);
7066 #endif
7068 Vprocess_alist = Qnil;
7069 deleted_pid_list = Qnil;
7070 for (i = 0; i < FD_SETSIZE; i++)
7072 chan_process[i] = Qnil;
7073 proc_buffered_char[i] = -1;
7075 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7076 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7077 #ifdef DATAGRAM_SOCKETS
7078 memset (datagram_address, 0, sizeof datagram_address);
7079 #endif
7082 Lisp_Object subfeatures = Qnil;
7083 const struct socket_options *sopt;
7085 #define ADD_SUBFEATURE(key, val) \
7086 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7088 #ifdef NON_BLOCKING_CONNECT
7089 ADD_SUBFEATURE (QCnowait, Qt);
7090 #endif
7091 #ifdef DATAGRAM_SOCKETS
7092 ADD_SUBFEATURE (QCtype, Qdatagram);
7093 #endif
7094 #ifdef HAVE_SEQPACKET
7095 ADD_SUBFEATURE (QCtype, Qseqpacket);
7096 #endif
7097 #ifdef HAVE_LOCAL_SOCKETS
7098 ADD_SUBFEATURE (QCfamily, Qlocal);
7099 #endif
7100 ADD_SUBFEATURE (QCfamily, Qipv4);
7101 #ifdef AF_INET6
7102 ADD_SUBFEATURE (QCfamily, Qipv6);
7103 #endif
7104 #ifdef HAVE_GETSOCKNAME
7105 ADD_SUBFEATURE (QCservice, Qt);
7106 #endif
7107 ADD_SUBFEATURE (QCserver, Qt);
7109 for (sopt = socket_options; sopt->name; sopt++)
7110 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7112 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7115 #if defined (DARWIN_OS)
7116 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7117 processes. As such, we only change the default value. */
7118 if (initialized)
7120 char const *release = (STRINGP (Voperating_system_release)
7121 ? SSDATA (Voperating_system_release)
7122 : 0);
7123 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7124 Vprocess_connection_type = Qnil;
7127 #endif
7128 #endif /* subprocesses */
7129 kbd_is_on_hold = 0;
7132 void
7133 syms_of_process (void)
7135 #ifdef subprocesses
7137 DEFSYM (Qprocessp, "processp");
7138 DEFSYM (Qrun, "run");
7139 DEFSYM (Qstop, "stop");
7140 DEFSYM (Qsignal, "signal");
7142 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7143 here again.
7145 Qexit = intern_c_string ("exit");
7146 staticpro (&Qexit); */
7148 DEFSYM (Qopen, "open");
7149 DEFSYM (Qclosed, "closed");
7150 DEFSYM (Qconnect, "connect");
7151 DEFSYM (Qfailed, "failed");
7152 DEFSYM (Qlisten, "listen");
7153 DEFSYM (Qlocal, "local");
7154 DEFSYM (Qipv4, "ipv4");
7155 #ifdef AF_INET6
7156 DEFSYM (Qipv6, "ipv6");
7157 #endif
7158 DEFSYM (Qdatagram, "datagram");
7159 DEFSYM (Qseqpacket, "seqpacket");
7161 DEFSYM (QCport, ":port");
7162 DEFSYM (QCspeed, ":speed");
7163 DEFSYM (QCprocess, ":process");
7165 DEFSYM (QCbytesize, ":bytesize");
7166 DEFSYM (QCstopbits, ":stopbits");
7167 DEFSYM (QCparity, ":parity");
7168 DEFSYM (Qodd, "odd");
7169 DEFSYM (Qeven, "even");
7170 DEFSYM (QCflowcontrol, ":flowcontrol");
7171 DEFSYM (Qhw, "hw");
7172 DEFSYM (Qsw, "sw");
7173 DEFSYM (QCsummary, ":summary");
7175 DEFSYM (Qreal, "real");
7176 DEFSYM (Qnetwork, "network");
7177 DEFSYM (Qserial, "serial");
7178 DEFSYM (QCbuffer, ":buffer");
7179 DEFSYM (QChost, ":host");
7180 DEFSYM (QCservice, ":service");
7181 DEFSYM (QClocal, ":local");
7182 DEFSYM (QCremote, ":remote");
7183 DEFSYM (QCcoding, ":coding");
7184 DEFSYM (QCserver, ":server");
7185 DEFSYM (QCnowait, ":nowait");
7186 DEFSYM (QCsentinel, ":sentinel");
7187 DEFSYM (QClog, ":log");
7188 DEFSYM (QCnoquery, ":noquery");
7189 DEFSYM (QCstop, ":stop");
7190 DEFSYM (QCoptions, ":options");
7191 DEFSYM (QCplist, ":plist");
7193 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7195 staticpro (&Vprocess_alist);
7196 staticpro (&deleted_pid_list);
7198 #endif /* subprocesses */
7200 DEFSYM (QCname, ":name");
7201 DEFSYM (QCtype, ":type");
7203 DEFSYM (Qeuid, "euid");
7204 DEFSYM (Qegid, "egid");
7205 DEFSYM (Quser, "user");
7206 DEFSYM (Qgroup, "group");
7207 DEFSYM (Qcomm, "comm");
7208 DEFSYM (Qstate, "state");
7209 DEFSYM (Qppid, "ppid");
7210 DEFSYM (Qpgrp, "pgrp");
7211 DEFSYM (Qsess, "sess");
7212 DEFSYM (Qttname, "ttname");
7213 DEFSYM (Qtpgid, "tpgid");
7214 DEFSYM (Qminflt, "minflt");
7215 DEFSYM (Qmajflt, "majflt");
7216 DEFSYM (Qcminflt, "cminflt");
7217 DEFSYM (Qcmajflt, "cmajflt");
7218 DEFSYM (Qutime, "utime");
7219 DEFSYM (Qstime, "stime");
7220 DEFSYM (Qtime, "time");
7221 DEFSYM (Qcutime, "cutime");
7222 DEFSYM (Qcstime, "cstime");
7223 DEFSYM (Qctime, "ctime");
7224 DEFSYM (Qinternal_default_process_sentinel,
7225 "internal-default-process-sentinel");
7226 DEFSYM (Qinternal_default_process_filter,
7227 "internal-default-process-filter");
7228 DEFSYM (Qpri, "pri");
7229 DEFSYM (Qnice, "nice");
7230 DEFSYM (Qthcount, "thcount");
7231 DEFSYM (Qstart, "start");
7232 DEFSYM (Qvsize, "vsize");
7233 DEFSYM (Qrss, "rss");
7234 DEFSYM (Qetime, "etime");
7235 DEFSYM (Qpcpu, "pcpu");
7236 DEFSYM (Qpmem, "pmem");
7237 DEFSYM (Qargs, "args");
7239 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7240 doc: /* Non-nil means delete processes immediately when they exit.
7241 A value of nil means don't delete them until `list-processes' is run. */);
7243 delete_exited_processes = 1;
7245 #ifdef subprocesses
7246 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7247 doc: /* Control type of device used to communicate with subprocesses.
7248 Values are nil to use a pipe, or t or `pty' to use a pty.
7249 The value has no effect if the system has no ptys or if all ptys are busy:
7250 then a pipe is used in any case.
7251 The value takes effect when `start-process' is called. */);
7252 Vprocess_connection_type = Qt;
7254 #ifdef ADAPTIVE_READ_BUFFERING
7255 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7256 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7257 On some systems, when Emacs reads the output from a subprocess, the output data
7258 is read in very small blocks, potentially resulting in very poor performance.
7259 This behavior can be remedied to some extent by setting this variable to a
7260 non-nil value, as it will automatically delay reading from such processes, to
7261 allow them to produce more output before Emacs tries to read it.
7262 If the value is t, the delay is reset after each write to the process; any other
7263 non-nil value means that the delay is not reset on write.
7264 The variable takes effect when `start-process' is called. */);
7265 Vprocess_adaptive_read_buffering = Qt;
7266 #endif
7268 defsubr (&Sprocessp);
7269 defsubr (&Sget_process);
7270 defsubr (&Sdelete_process);
7271 defsubr (&Sprocess_status);
7272 defsubr (&Sprocess_exit_status);
7273 defsubr (&Sprocess_id);
7274 defsubr (&Sprocess_name);
7275 defsubr (&Sprocess_tty_name);
7276 defsubr (&Sprocess_command);
7277 defsubr (&Sset_process_buffer);
7278 defsubr (&Sprocess_buffer);
7279 defsubr (&Sprocess_mark);
7280 defsubr (&Sset_process_filter);
7281 defsubr (&Sprocess_filter);
7282 defsubr (&Sset_process_sentinel);
7283 defsubr (&Sprocess_sentinel);
7284 defsubr (&Sset_process_window_size);
7285 defsubr (&Sset_process_inherit_coding_system_flag);
7286 defsubr (&Sset_process_query_on_exit_flag);
7287 defsubr (&Sprocess_query_on_exit_flag);
7288 defsubr (&Sprocess_contact);
7289 defsubr (&Sprocess_plist);
7290 defsubr (&Sset_process_plist);
7291 defsubr (&Sprocess_list);
7292 defsubr (&Sstart_process);
7293 defsubr (&Sserial_process_configure);
7294 defsubr (&Smake_serial_process);
7295 defsubr (&Sset_network_process_option);
7296 defsubr (&Smake_network_process);
7297 defsubr (&Sformat_network_address);
7298 #if defined (HAVE_NET_IF_H)
7299 #ifdef SIOCGIFCONF
7300 defsubr (&Snetwork_interface_list);
7301 #endif
7302 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
7303 defsubr (&Snetwork_interface_info);
7304 #endif
7305 #endif /* defined (HAVE_NET_IF_H) */
7306 #ifdef DATAGRAM_SOCKETS
7307 defsubr (&Sprocess_datagram_address);
7308 defsubr (&Sset_process_datagram_address);
7309 #endif
7310 defsubr (&Saccept_process_output);
7311 defsubr (&Sprocess_send_region);
7312 defsubr (&Sprocess_send_string);
7313 defsubr (&Sinterrupt_process);
7314 defsubr (&Skill_process);
7315 defsubr (&Squit_process);
7316 defsubr (&Sstop_process);
7317 defsubr (&Scontinue_process);
7318 defsubr (&Sprocess_running_child_p);
7319 defsubr (&Sprocess_send_eof);
7320 defsubr (&Ssignal_process);
7321 defsubr (&Swaiting_for_user_input_p);
7322 defsubr (&Sprocess_type);
7323 defsubr (&Sinternal_default_process_sentinel);
7324 defsubr (&Sinternal_default_process_filter);
7325 defsubr (&Sset_process_coding_system);
7326 defsubr (&Sprocess_coding_system);
7327 defsubr (&Sset_process_filter_multibyte);
7328 defsubr (&Sprocess_filter_multibyte_p);
7330 #endif /* subprocesses */
7332 defsubr (&Sget_buffer_process);
7333 defsubr (&Sprocess_inherit_coding_system_flag);
7334 defsubr (&Slist_system_processes);
7335 defsubr (&Sprocess_attributes);