.bzrignore: Add GNU GLOBAL files.
[emacs.git] / src / process.c
blob9ef01dae765bad5a35cdb4a5f4b90ec6c0262504
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 <netinet/in.h>
82 #include <arpa/nameser.h>
83 #include <resolv.h>
84 #endif
86 #ifdef HAVE_UTIL_H
87 #include <util.h>
88 #endif
90 #ifdef HAVE_PTY_H
91 #include <pty.h>
92 #endif
94 #include <c-ctype.h>
95 #include <sig2str.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, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
136 EMACS_TIME *, void *);
137 #endif
139 /* Work around GCC 4.7.0 bug with strict overflow checking; see
140 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
141 These lines can be removed once the GCC bug is fixed. */
142 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
143 # pragma GCC diagnostic ignored "-Wstrict-overflow"
144 #endif
146 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
147 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
148 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
149 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
150 Lisp_Object QCname, QCtype;
152 /* True if keyboard input is on hold, zero otherwise. */
154 static bool kbd_is_on_hold;
156 /* Nonzero means don't run process sentinels. This is used
157 when exiting. */
158 bool inhibit_sentinels;
160 #ifdef subprocesses
162 Lisp_Object Qprocessp;
163 static Lisp_Object Qrun, Qstop, Qsignal;
164 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
165 Lisp_Object Qlocal;
166 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
167 static Lisp_Object Qreal, Qnetwork, Qserial;
168 #ifdef AF_INET6
169 static Lisp_Object Qipv6;
170 #endif
171 static Lisp_Object QCport, QCprocess;
172 Lisp_Object QCspeed;
173 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
174 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
175 static Lisp_Object QCbuffer, QChost, QCservice;
176 static Lisp_Object QClocal, QCremote, QCcoding;
177 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
178 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
179 static Lisp_Object Qlast_nonmenu_event;
180 static Lisp_Object Qinternal_default_process_sentinel;
181 static Lisp_Object Qinternal_default_process_filter;
183 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
184 #define NETCONN1_P(p) (EQ (p->type, Qnetwork))
185 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
186 #define SERIALCONN1_P(p) (EQ (p->type, Qserial))
188 /* Number of events of change of status of a process. */
189 static EMACS_INT process_tick;
190 /* Number of events for which the user or sentinel has been notified. */
191 static EMACS_INT update_tick;
193 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
195 /* Only W32 has this, it really means that select can't take write mask. */
196 #ifdef BROKEN_NON_BLOCKING_CONNECT
197 #undef NON_BLOCKING_CONNECT
198 #define SELECT_CANT_DO_WRITE_MASK
199 #else
200 #ifndef NON_BLOCKING_CONNECT
201 #ifdef HAVE_SELECT
202 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
203 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
204 #define NON_BLOCKING_CONNECT
205 #endif /* EWOULDBLOCK || EINPROGRESS */
206 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
207 #endif /* HAVE_SELECT */
208 #endif /* NON_BLOCKING_CONNECT */
209 #endif /* BROKEN_NON_BLOCKING_CONNECT */
211 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
212 this system. We need to read full packets, so we need a
213 "non-destructive" select. So we require either native select,
214 or emulation of select using FIONREAD. */
216 #ifndef BROKEN_DATAGRAM_SOCKETS
217 # if defined HAVE_SELECT || defined USABLE_FIONREAD
218 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
219 # define DATAGRAM_SOCKETS
220 # endif
221 # endif
222 #endif
224 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
225 # define HAVE_SEQPACKET
226 #endif
228 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
229 #define ADAPTIVE_READ_BUFFERING
230 #endif
232 #ifdef ADAPTIVE_READ_BUFFERING
233 #define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
234 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
235 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
237 /* Number of processes which have a non-zero read_output_delay,
238 and therefore might be delayed for adaptive read buffering. */
240 static int process_output_delay_count;
242 /* True if any process has non-nil read_output_skip. */
244 static bool process_output_skip;
246 #else
247 #define process_output_delay_count 0
248 #endif
250 static void create_process (Lisp_Object, char **, Lisp_Object);
251 #ifdef USABLE_SIGIO
252 static bool keyboard_bit_set (SELECT_TYPE *);
253 #endif
254 static void deactivate_process (Lisp_Object);
255 static void status_notify (struct Lisp_Process *);
256 static int read_process_output (Lisp_Object, int);
257 static void handle_child_signal (int);
258 static void create_pty (Lisp_Object);
260 /* If we support a window system, turn on the code to poll periodically
261 to detect C-g. It isn't actually used when doing interrupt input. */
262 #ifdef HAVE_WINDOW_SYSTEM
263 #define POLL_FOR_INPUT
264 #endif
266 static Lisp_Object get_process (register Lisp_Object name);
267 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
269 /* Mask of bits indicating the descriptors that we wait for input on. */
271 static SELECT_TYPE input_wait_mask;
273 /* Mask that excludes keyboard input descriptor(s). */
275 static SELECT_TYPE non_keyboard_wait_mask;
277 /* Mask that excludes process input descriptor(s). */
279 static SELECT_TYPE non_process_wait_mask;
281 /* Mask for selecting for write. */
283 static SELECT_TYPE write_mask;
285 #ifdef NON_BLOCKING_CONNECT
286 /* Mask of bits indicating the descriptors that we wait for connect to
287 complete on. Once they complete, they are removed from this mask
288 and added to the input_wait_mask and non_keyboard_wait_mask. */
290 static SELECT_TYPE connect_wait_mask;
292 /* Number of bits set in connect_wait_mask. */
293 static int num_pending_connects;
294 #endif /* NON_BLOCKING_CONNECT */
296 /* The largest descriptor currently in use for a process object. */
297 static int max_process_desc;
299 /* The largest descriptor currently in use for input. */
300 static int max_input_desc;
302 /* Indexed by descriptor, gives the process (if any) for that descriptor */
303 static Lisp_Object chan_process[MAXDESC];
305 /* Alist of elements (NAME . PROCESS) */
306 static Lisp_Object Vprocess_alist;
308 /* Buffered-ahead input char from process, indexed by channel.
309 -1 means empty (no char is buffered).
310 Used on sys V where the only way to tell if there is any
311 output from the process is to read at least one char.
312 Always -1 on systems that support FIONREAD. */
314 static int proc_buffered_char[MAXDESC];
316 /* Table of `struct coding-system' for each process. */
317 static struct coding_system *proc_decode_coding_system[MAXDESC];
318 static struct coding_system *proc_encode_coding_system[MAXDESC];
320 #ifdef DATAGRAM_SOCKETS
321 /* Table of `partner address' for datagram sockets. */
322 static struct sockaddr_and_len {
323 struct sockaddr *sa;
324 int len;
325 } datagram_address[MAXDESC];
326 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
327 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
328 #else
329 #define DATAGRAM_CHAN_P(chan) (0)
330 #define DATAGRAM_CONN_P(proc) (0)
331 #endif
333 /* These setters are used only in this file, so they can be private. */
334 static void
335 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
337 p->buffer = val;
339 static void
340 pset_command (struct Lisp_Process *p, Lisp_Object val)
342 p->command = val;
344 static void
345 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
347 p->decode_coding_system = val;
349 static void
350 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
352 p->decoding_buf = val;
354 static void
355 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
357 p->encode_coding_system = val;
359 static void
360 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
362 p->encoding_buf = val;
364 static void
365 pset_filter (struct Lisp_Process *p, Lisp_Object val)
367 p->filter = NILP (val) ? Qinternal_default_process_filter : val;
369 static void
370 pset_log (struct Lisp_Process *p, Lisp_Object val)
372 p->log = val;
374 static void
375 pset_mark (struct Lisp_Process *p, Lisp_Object val)
377 p->mark = val;
379 static void
380 pset_name (struct Lisp_Process *p, Lisp_Object val)
382 p->name = val;
384 static void
385 pset_plist (struct Lisp_Process *p, Lisp_Object val)
387 p->plist = val;
389 static void
390 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
392 p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
394 static void
395 pset_status (struct Lisp_Process *p, Lisp_Object val)
397 p->status = val;
399 static void
400 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
402 p->tty_name = val;
404 static void
405 pset_type (struct Lisp_Process *p, Lisp_Object val)
407 p->type = val;
409 static void
410 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
412 p->write_queue = val;
417 static struct fd_callback_data
419 fd_callback func;
420 void *data;
421 #define FOR_READ 1
422 #define FOR_WRITE 2
423 int condition; /* mask of the defines above. */
424 } fd_callback_info[MAXDESC];
427 /* Add a file descriptor FD to be monitored for when read is possible.
428 When read is possible, call FUNC with argument DATA. */
430 void
431 add_read_fd (int fd, fd_callback func, void *data)
433 eassert (fd < MAXDESC);
434 add_keyboard_wait_descriptor (fd);
436 fd_callback_info[fd].func = func;
437 fd_callback_info[fd].data = data;
438 fd_callback_info[fd].condition |= FOR_READ;
441 /* Stop monitoring file descriptor FD for when read is possible. */
443 void
444 delete_read_fd (int fd)
446 eassert (fd < MAXDESC);
447 delete_keyboard_wait_descriptor (fd);
449 fd_callback_info[fd].condition &= ~FOR_READ;
450 if (fd_callback_info[fd].condition == 0)
452 fd_callback_info[fd].func = 0;
453 fd_callback_info[fd].data = 0;
457 /* Add a file descriptor FD to be monitored for when write is possible.
458 When write is possible, call FUNC with argument DATA. */
460 void
461 add_write_fd (int fd, fd_callback func, void *data)
463 eassert (fd < MAXDESC);
464 FD_SET (fd, &write_mask);
465 if (fd > max_input_desc)
466 max_input_desc = fd;
468 fd_callback_info[fd].func = func;
469 fd_callback_info[fd].data = data;
470 fd_callback_info[fd].condition |= FOR_WRITE;
473 /* Stop monitoring file descriptor FD for when write is possible. */
475 void
476 delete_write_fd (int fd)
478 int lim = max_input_desc;
480 eassert (fd < MAXDESC);
481 FD_CLR (fd, &write_mask);
482 fd_callback_info[fd].condition &= ~FOR_WRITE;
483 if (fd_callback_info[fd].condition == 0)
485 fd_callback_info[fd].func = 0;
486 fd_callback_info[fd].data = 0;
488 if (fd == max_input_desc)
489 for (fd = lim; fd >= 0; fd--)
490 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
492 max_input_desc = fd;
493 break;
500 /* Compute the Lisp form of the process status, p->status, from
501 the numeric status that was returned by `wait'. */
503 static Lisp_Object status_convert (int);
505 static void
506 update_status (struct Lisp_Process *p)
508 eassert (p->raw_status_new);
509 pset_status (p, status_convert (p->raw_status));
510 p->raw_status_new = 0;
513 /* Convert a process status word in Unix format to
514 the list that we use internally. */
516 static Lisp_Object
517 status_convert (int w)
519 if (WIFSTOPPED (w))
520 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
521 else if (WIFEXITED (w))
522 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
523 WCOREDUMP (w) ? Qt : Qnil));
524 else if (WIFSIGNALED (w))
525 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
526 WCOREDUMP (w) ? Qt : Qnil));
527 else
528 return Qrun;
531 /* Given a status-list, extract the three pieces of information
532 and store them individually through the three pointers. */
534 static void
535 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
537 Lisp_Object tem;
539 if (SYMBOLP (l))
541 *symbol = l;
542 *code = 0;
543 *coredump = 0;
545 else
547 *symbol = XCAR (l);
548 tem = XCDR (l);
549 *code = XFASTINT (XCAR (tem));
550 tem = XCDR (tem);
551 *coredump = !NILP (tem);
555 /* Return a string describing a process status list. */
557 static Lisp_Object
558 status_message (struct Lisp_Process *p)
560 Lisp_Object status = p->status;
561 Lisp_Object symbol;
562 int code;
563 bool coredump;
564 Lisp_Object string, string2;
566 decode_status (status, &symbol, &code, &coredump);
568 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
570 char const *signame;
571 synchronize_system_messages_locale ();
572 signame = strsignal (code);
573 if (signame == 0)
574 string = build_string ("unknown");
575 else
577 int c1, c2;
579 string = build_unibyte_string (signame);
580 if (! NILP (Vlocale_coding_system))
581 string = (code_convert_string_norecord
582 (string, Vlocale_coding_system, 0));
583 c1 = STRING_CHAR (SDATA (string));
584 c2 = downcase (c1);
585 if (c1 != c2)
586 Faset (string, make_number (0), make_number (c2));
588 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
589 return concat2 (string, string2);
591 else if (EQ (symbol, Qexit))
593 if (NETCONN1_P (p))
594 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
595 if (code == 0)
596 return build_string ("finished\n");
597 string = Fnumber_to_string (make_number (code));
598 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
599 return concat3 (build_string ("exited abnormally with code "),
600 string, string2);
602 else if (EQ (symbol, Qfailed))
604 string = Fnumber_to_string (make_number (code));
605 string2 = build_string ("\n");
606 return concat3 (build_string ("failed with code "),
607 string, string2);
609 else
610 return Fcopy_sequence (Fsymbol_name (symbol));
613 #ifdef HAVE_PTYS
615 /* The file name of the pty opened by allocate_pty. */
616 static char pty_name[24];
618 /* Open an available pty, returning a file descriptor.
619 Return -1 on failure.
620 The file name of the terminal corresponding to the pty
621 is left in the variable pty_name. */
623 static int
624 allocate_pty (void)
626 int fd;
628 #ifdef PTY_ITERATION
629 PTY_ITERATION
630 #else
631 register int c, i;
632 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
633 for (i = 0; i < 16; i++)
634 #endif
636 #ifdef PTY_NAME_SPRINTF
637 PTY_NAME_SPRINTF
638 #else
639 sprintf (pty_name, "/dev/pty%c%x", c, i);
640 #endif /* no PTY_NAME_SPRINTF */
642 #ifdef PTY_OPEN
643 PTY_OPEN;
644 #else /* no PTY_OPEN */
645 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
646 #endif /* no PTY_OPEN */
648 if (fd >= 0)
650 /* check to make certain that both sides are available
651 this avoids a nasty yet stupid bug in rlogins */
652 #ifdef PTY_TTY_NAME_SPRINTF
653 PTY_TTY_NAME_SPRINTF
654 #else
655 sprintf (pty_name, "/dev/tty%c%x", c, i);
656 #endif /* no PTY_TTY_NAME_SPRINTF */
657 if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
659 emacs_close (fd);
660 # ifndef __sgi
661 continue;
662 # else
663 return -1;
664 # endif /* __sgi */
666 setup_pty (fd);
667 return fd;
670 return -1;
672 #endif /* HAVE_PTYS */
674 static Lisp_Object
675 make_process (Lisp_Object name)
677 register Lisp_Object val, tem, name1;
678 register struct Lisp_Process *p;
679 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
680 printmax_t i;
682 p = allocate_process ();
683 /* Initialize Lisp data. Note that allocate_process initializes all
684 Lisp data to nil, so do it only for slots which should not be nil. */
685 pset_status (p, Qrun);
686 pset_mark (p, Fmake_marker ());
688 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
689 non-Lisp data, so do it only for slots which should not be zero. */
690 p->infd = -1;
691 p->outfd = -1;
693 #ifdef HAVE_GNUTLS
694 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
695 #endif
697 /* If name is already in use, modify it until it is unused. */
699 name1 = name;
700 for (i = 1; ; i++)
702 tem = Fget_process (name1);
703 if (NILP (tem)) break;
704 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
706 name = name1;
707 pset_name (p, name);
708 pset_sentinel (p, Qinternal_default_process_sentinel);
709 pset_filter (p, Qinternal_default_process_filter);
710 XSETPROCESS (val, p);
711 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
712 return val;
715 static void
716 remove_process (register Lisp_Object proc)
718 register Lisp_Object pair;
720 pair = Frassq (proc, Vprocess_alist);
721 Vprocess_alist = Fdelq (pair, Vprocess_alist);
723 deactivate_process (proc);
727 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
728 doc: /* Return t if OBJECT is a process. */)
729 (Lisp_Object object)
731 return PROCESSP (object) ? Qt : Qnil;
734 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
735 doc: /* Return the process named NAME, or nil if there is none. */)
736 (register Lisp_Object name)
738 if (PROCESSP (name))
739 return name;
740 CHECK_STRING (name);
741 return Fcdr (Fassoc (name, Vprocess_alist));
744 /* This is how commands for the user decode process arguments. It
745 accepts a process, a process name, a buffer, a buffer name, or nil.
746 Buffers denote the first process in the buffer, and nil denotes the
747 current buffer. */
749 static Lisp_Object
750 get_process (register Lisp_Object name)
752 register Lisp_Object proc, obj;
753 if (STRINGP (name))
755 obj = Fget_process (name);
756 if (NILP (obj))
757 obj = Fget_buffer (name);
758 if (NILP (obj))
759 error ("Process %s does not exist", SDATA (name));
761 else if (NILP (name))
762 obj = Fcurrent_buffer ();
763 else
764 obj = name;
766 /* Now obj should be either a buffer object or a process object.
768 if (BUFFERP (obj))
770 proc = Fget_buffer_process (obj);
771 if (NILP (proc))
772 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
774 else
776 CHECK_PROCESS (obj);
777 proc = obj;
779 return proc;
783 /* Fdelete_process promises to immediately forget about the process, but in
784 reality, Emacs needs to remember those processes until they have been
785 treated by the SIGCHLD handler and waitpid has been invoked on them;
786 otherwise they might fill up the kernel's process table.
788 Some processes created by call-process are also put onto this list. */
789 static Lisp_Object deleted_pid_list;
791 void
792 record_deleted_pid (pid_t pid)
794 deleted_pid_list = Fcons (make_fixnum_or_float (pid),
795 /* GC treated elements set to nil. */
796 Fdelq (Qnil, deleted_pid_list));
800 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
801 doc: /* Delete PROCESS: kill it and forget about it immediately.
802 PROCESS may be a process, a buffer, the name of a process or buffer, or
803 nil, indicating the current buffer's process. */)
804 (register Lisp_Object process)
806 register struct Lisp_Process *p;
808 process = get_process (process);
809 p = XPROCESS (process);
811 p->raw_status_new = 0;
812 if (NETCONN1_P (p) || SERIALCONN1_P (p))
814 pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
815 p->tick = ++process_tick;
816 status_notify (p);
817 redisplay_preserve_echo_area (13);
819 else
821 if (p->alive)
822 record_kill_process (p);
824 if (p->infd >= 0)
826 /* Update P's status, since record_kill_process will make the
827 SIGCHLD handler update deleted_pid_list, not *P. */
828 Lisp_Object symbol;
829 if (p->raw_status_new)
830 update_status (p);
831 symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
832 if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
833 pset_status (p, list2 (Qsignal, make_number (SIGKILL)));
835 p->tick = ++process_tick;
836 status_notify (p);
837 redisplay_preserve_echo_area (13);
840 remove_process (process);
841 return Qnil;
844 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
845 doc: /* Return the status of PROCESS.
846 The returned value is one of the following symbols:
847 run -- for a process that is running.
848 stop -- for a process stopped but continuable.
849 exit -- for a process that has exited.
850 signal -- for a process that has got a fatal signal.
851 open -- for a network stream connection that is open.
852 listen -- for a network stream server that is listening.
853 closed -- for a network stream connection that is closed.
854 connect -- when waiting for a non-blocking connection to complete.
855 failed -- when a non-blocking connection has failed.
856 nil -- if arg is a process name and no such process exists.
857 PROCESS may be a process, a buffer, the name of a process, or
858 nil, indicating the current buffer's process. */)
859 (register Lisp_Object process)
861 register struct Lisp_Process *p;
862 register Lisp_Object status;
864 if (STRINGP (process))
865 process = Fget_process (process);
866 else
867 process = get_process (process);
869 if (NILP (process))
870 return process;
872 p = XPROCESS (process);
873 if (p->raw_status_new)
874 update_status (p);
875 status = p->status;
876 if (CONSP (status))
877 status = XCAR (status);
878 if (NETCONN1_P (p) || SERIALCONN1_P (p))
880 if (EQ (status, Qexit))
881 status = Qclosed;
882 else if (EQ (p->command, Qt))
883 status = Qstop;
884 else if (EQ (status, Qrun))
885 status = Qopen;
887 return status;
890 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
891 1, 1, 0,
892 doc: /* Return the exit status of PROCESS or the signal number that killed it.
893 If PROCESS has not yet exited or died, return 0. */)
894 (register Lisp_Object process)
896 CHECK_PROCESS (process);
897 if (XPROCESS (process)->raw_status_new)
898 update_status (XPROCESS (process));
899 if (CONSP (XPROCESS (process)->status))
900 return XCAR (XCDR (XPROCESS (process)->status));
901 return make_number (0);
904 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
905 doc: /* Return the process id of PROCESS.
906 This is the pid of the external process which PROCESS uses or talks to.
907 For a network connection, this value is nil. */)
908 (register Lisp_Object process)
910 pid_t pid;
912 CHECK_PROCESS (process);
913 pid = XPROCESS (process)->pid;
914 return (pid ? make_fixnum_or_float (pid) : Qnil);
917 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
918 doc: /* Return the name of PROCESS, as a string.
919 This is the name of the program invoked in PROCESS,
920 possibly modified to make it unique among process names. */)
921 (register Lisp_Object process)
923 CHECK_PROCESS (process);
924 return XPROCESS (process)->name;
927 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
928 doc: /* Return the command that was executed to start PROCESS.
929 This is a list of strings, the first string being the program executed
930 and the rest of the strings being the arguments given to it.
931 For a network or serial process, this is nil (process is running) or t
932 \(process is stopped). */)
933 (register Lisp_Object process)
935 CHECK_PROCESS (process);
936 return XPROCESS (process)->command;
939 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
940 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
941 This is the terminal that the process itself reads and writes on,
942 not the name of the pty that Emacs uses to talk with that terminal. */)
943 (register Lisp_Object process)
945 CHECK_PROCESS (process);
946 return XPROCESS (process)->tty_name;
949 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
950 2, 2, 0,
951 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
952 Return BUFFER. */)
953 (register Lisp_Object process, Lisp_Object buffer)
955 struct Lisp_Process *p;
957 CHECK_PROCESS (process);
958 if (!NILP (buffer))
959 CHECK_BUFFER (buffer);
960 p = XPROCESS (process);
961 pset_buffer (p, buffer);
962 if (NETCONN1_P (p) || SERIALCONN1_P (p))
963 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
964 setup_process_coding_systems (process);
965 return buffer;
968 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
969 1, 1, 0,
970 doc: /* Return the buffer PROCESS is associated with.
971 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
972 (register Lisp_Object process)
974 CHECK_PROCESS (process);
975 return XPROCESS (process)->buffer;
978 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
979 1, 1, 0,
980 doc: /* Return the marker for the end of the last output from PROCESS. */)
981 (register Lisp_Object process)
983 CHECK_PROCESS (process);
984 return XPROCESS (process)->mark;
987 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
988 2, 2, 0,
989 doc: /* Give PROCESS the filter function FILTER; nil means default.
990 A value of t means stop accepting output from the process.
992 When a process has a non-default filter, its buffer is not used for output.
993 Instead, each time it does output, the entire string of output is
994 passed to the filter.
996 The filter gets two arguments: the process and the string of output.
997 The string argument is normally a multibyte string, except:
998 - if the process' input coding system is no-conversion or raw-text,
999 it is a unibyte string (the non-converted input), or else
1000 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1001 string (the result of converting the decoded input multibyte
1002 string to unibyte with `string-make-unibyte'). */)
1003 (register Lisp_Object process, Lisp_Object filter)
1005 struct Lisp_Process *p;
1007 CHECK_PROCESS (process);
1008 p = XPROCESS (process);
1010 /* Don't signal an error if the process' input file descriptor
1011 is closed. This could make debugging Lisp more difficult,
1012 for example when doing something like
1014 (setq process (start-process ...))
1015 (debug)
1016 (set-process-filter process ...) */
1018 if (NILP (filter))
1019 filter = Qinternal_default_process_filter;
1021 if (p->infd >= 0)
1023 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1025 FD_CLR (p->infd, &input_wait_mask);
1026 FD_CLR (p->infd, &non_keyboard_wait_mask);
1028 else if (EQ (p->filter, Qt)
1029 /* Network or serial process not stopped: */
1030 && !EQ (p->command, Qt))
1032 FD_SET (p->infd, &input_wait_mask);
1033 FD_SET (p->infd, &non_keyboard_wait_mask);
1037 pset_filter (p, filter);
1038 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1039 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1040 setup_process_coding_systems (process);
1041 return filter;
1044 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1045 1, 1, 0,
1046 doc: /* Return the filter function of PROCESS.
1047 See `set-process-filter' for more info on filter functions. */)
1048 (register Lisp_Object process)
1050 CHECK_PROCESS (process);
1051 return XPROCESS (process)->filter;
1054 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1055 2, 2, 0,
1056 doc: /* Give PROCESS the sentinel SENTINEL; nil for default.
1057 The sentinel is called as a function when the process changes state.
1058 It gets two arguments: the process, and a string describing the change. */)
1059 (register Lisp_Object process, Lisp_Object sentinel)
1061 struct Lisp_Process *p;
1063 CHECK_PROCESS (process);
1064 p = XPROCESS (process);
1066 if (NILP (sentinel))
1067 sentinel = Qinternal_default_process_sentinel;
1069 pset_sentinel (p, sentinel);
1070 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1071 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1072 return sentinel;
1075 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1076 1, 1, 0,
1077 doc: /* Return the sentinel of PROCESS.
1078 See `set-process-sentinel' for more info on sentinels. */)
1079 (register Lisp_Object process)
1081 CHECK_PROCESS (process);
1082 return XPROCESS (process)->sentinel;
1085 DEFUN ("set-process-window-size", Fset_process_window_size,
1086 Sset_process_window_size, 3, 3, 0,
1087 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1088 (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1090 CHECK_PROCESS (process);
1091 CHECK_RANGED_INTEGER (height, 0, INT_MAX);
1092 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
1094 if (XPROCESS (process)->infd < 0
1095 || set_window_size (XPROCESS (process)->infd,
1096 XINT (height), XINT (width)) <= 0)
1097 return Qnil;
1098 else
1099 return Qt;
1102 DEFUN ("set-process-inherit-coding-system-flag",
1103 Fset_process_inherit_coding_system_flag,
1104 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1105 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1106 If the second argument FLAG is non-nil, then the variable
1107 `buffer-file-coding-system' of the buffer associated with PROCESS
1108 will be bound to the value of the coding system used to decode
1109 the process output.
1111 This is useful when the coding system specified for the process buffer
1112 leaves either the character code conversion or the end-of-line conversion
1113 unspecified, or if the coding system used to decode the process output
1114 is more appropriate for saving the process buffer.
1116 Binding the variable `inherit-process-coding-system' to non-nil before
1117 starting the process is an alternative way of setting the inherit flag
1118 for the process which will run.
1120 This function returns FLAG. */)
1121 (register Lisp_Object process, Lisp_Object flag)
1123 CHECK_PROCESS (process);
1124 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1125 return flag;
1128 DEFUN ("set-process-query-on-exit-flag",
1129 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1130 2, 2, 0,
1131 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1132 If the second argument FLAG is non-nil, Emacs will query the user before
1133 exiting or killing a buffer if PROCESS is running. This function
1134 returns FLAG. */)
1135 (register Lisp_Object process, Lisp_Object flag)
1137 CHECK_PROCESS (process);
1138 XPROCESS (process)->kill_without_query = NILP (flag);
1139 return flag;
1142 DEFUN ("process-query-on-exit-flag",
1143 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1144 1, 1, 0,
1145 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1146 (register Lisp_Object process)
1148 CHECK_PROCESS (process);
1149 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1152 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1153 1, 2, 0,
1154 doc: /* Return the contact info of PROCESS; t for a real child.
1155 For a network or serial connection, the value depends on the optional
1156 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1157 SERVICE) for a network connection or (PORT SPEED) for a serial
1158 connection. If KEY is t, the complete contact information for the
1159 connection is returned, else the specific value for the keyword KEY is
1160 returned. See `make-network-process' or `make-serial-process' for a
1161 list of keywords. */)
1162 (register Lisp_Object process, Lisp_Object key)
1164 Lisp_Object contact;
1166 CHECK_PROCESS (process);
1167 contact = XPROCESS (process)->childp;
1169 #ifdef DATAGRAM_SOCKETS
1170 if (DATAGRAM_CONN_P (process)
1171 && (EQ (key, Qt) || EQ (key, QCremote)))
1172 contact = Fplist_put (contact, QCremote,
1173 Fprocess_datagram_address (process));
1174 #endif
1176 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1177 return contact;
1178 if (NILP (key) && NETCONN_P (process))
1179 return Fcons (Fplist_get (contact, QChost),
1180 Fcons (Fplist_get (contact, QCservice), Qnil));
1181 if (NILP (key) && SERIALCONN_P (process))
1182 return Fcons (Fplist_get (contact, QCport),
1183 Fcons (Fplist_get (contact, QCspeed), Qnil));
1184 return Fplist_get (contact, key);
1187 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1188 1, 1, 0,
1189 doc: /* Return the plist of PROCESS. */)
1190 (register Lisp_Object process)
1192 CHECK_PROCESS (process);
1193 return XPROCESS (process)->plist;
1196 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1197 2, 2, 0,
1198 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1199 (register Lisp_Object process, Lisp_Object plist)
1201 CHECK_PROCESS (process);
1202 CHECK_LIST (plist);
1204 pset_plist (XPROCESS (process), plist);
1205 return plist;
1208 #if 0 /* Turned off because we don't currently record this info
1209 in the process. Perhaps add it. */
1210 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1211 doc: /* Return the connection type of PROCESS.
1212 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1213 a socket connection. */)
1214 (Lisp_Object process)
1216 return XPROCESS (process)->type;
1218 #endif
1220 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1221 doc: /* Return the connection type of PROCESS.
1222 The value is either the symbol `real', `network', or `serial'.
1223 PROCESS may be a process, a buffer, the name of a process or buffer, or
1224 nil, indicating the current buffer's process. */)
1225 (Lisp_Object process)
1227 Lisp_Object proc;
1228 proc = get_process (process);
1229 return XPROCESS (proc)->type;
1232 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1233 1, 2, 0,
1234 doc: /* Convert network ADDRESS from internal format to a string.
1235 A 4 or 5 element vector represents an IPv4 address (with port number).
1236 An 8 or 9 element vector represents an IPv6 address (with port number).
1237 If optional second argument OMIT-PORT is non-nil, don't include a port
1238 number in the string, even when present in ADDRESS.
1239 Returns nil if format of ADDRESS is invalid. */)
1240 (Lisp_Object address, Lisp_Object omit_port)
1242 if (NILP (address))
1243 return Qnil;
1245 if (STRINGP (address)) /* AF_LOCAL */
1246 return address;
1248 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1250 register struct Lisp_Vector *p = XVECTOR (address);
1251 ptrdiff_t size = p->header.size;
1252 Lisp_Object args[10];
1253 int nargs, i;
1255 if (size == 4 || (size == 5 && !NILP (omit_port)))
1257 args[0] = build_string ("%d.%d.%d.%d");
1258 nargs = 4;
1260 else if (size == 5)
1262 args[0] = build_string ("%d.%d.%d.%d:%d");
1263 nargs = 5;
1265 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1267 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1268 nargs = 8;
1270 else if (size == 9)
1272 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1273 nargs = 9;
1275 else
1276 return Qnil;
1278 for (i = 0; i < nargs; i++)
1280 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1281 return Qnil;
1283 if (nargs <= 5 /* IPv4 */
1284 && i < 4 /* host, not port */
1285 && XINT (p->contents[i]) > 255)
1286 return Qnil;
1288 args[i+1] = p->contents[i];
1291 return Fformat (nargs+1, args);
1294 if (CONSP (address))
1296 Lisp_Object args[2];
1297 args[0] = build_string ("<Family %d>");
1298 args[1] = Fcar (address);
1299 return Fformat (2, args);
1302 return Qnil;
1305 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1306 doc: /* Return a list of all processes. */)
1307 (void)
1309 return Fmapcar (Qcdr, Vprocess_alist);
1312 /* Starting asynchronous inferior processes. */
1314 static Lisp_Object start_process_unwind (Lisp_Object proc);
1316 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1317 doc: /* Start a program in a subprocess. Return the process object for it.
1318 NAME is name for process. It is modified if necessary to make it unique.
1319 BUFFER is the buffer (or buffer name) to associate with the process.
1321 Process output (both standard output and standard error streams) goes
1322 at end of BUFFER, unless you specify an output stream or filter
1323 function to handle the output. BUFFER may also be nil, meaning that
1324 this process is not associated with any buffer.
1326 PROGRAM is the program file name. It is searched for in `exec-path'
1327 (which see). If nil, just associate a pty with the buffer. Remaining
1328 arguments are strings to give program as arguments.
1330 If you want to separate standard output from standard error, invoke
1331 the command through a shell and redirect one of them using the shell
1332 syntax.
1334 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1335 (ptrdiff_t nargs, Lisp_Object *args)
1337 Lisp_Object buffer, name, program, proc, current_dir, tem;
1338 register unsigned char **new_argv;
1339 ptrdiff_t i;
1340 ptrdiff_t count = SPECPDL_INDEX ();
1342 buffer = args[1];
1343 if (!NILP (buffer))
1344 buffer = Fget_buffer_create (buffer);
1346 /* Make sure that the child will be able to chdir to the current
1347 buffer's current directory, or its unhandled equivalent. We
1348 can't just have the child check for an error when it does the
1349 chdir, since it's in a vfork.
1351 We have to GCPRO around this because Fexpand_file_name and
1352 Funhandled_file_name_directory might call a file name handling
1353 function. The argument list is protected by the caller, so all
1354 we really have to worry about is buffer. */
1356 struct gcpro gcpro1, gcpro2;
1358 current_dir = BVAR (current_buffer, directory);
1360 GCPRO2 (buffer, current_dir);
1362 current_dir = Funhandled_file_name_directory (current_dir);
1363 if (NILP (current_dir))
1364 /* If the file name handler says that current_dir is unreachable, use
1365 a sensible default. */
1366 current_dir = build_string ("~/");
1367 current_dir = expand_and_dir_to_file (current_dir, Qnil);
1368 if (NILP (Ffile_accessible_directory_p (current_dir)))
1369 report_file_error ("Setting current directory",
1370 Fcons (BVAR (current_buffer, directory), Qnil));
1372 UNGCPRO;
1375 name = args[0];
1376 CHECK_STRING (name);
1378 program = args[2];
1380 if (!NILP (program))
1381 CHECK_STRING (program);
1383 proc = make_process (name);
1384 /* If an error occurs and we can't start the process, we want to
1385 remove it from the process list. This means that each error
1386 check in create_process doesn't need to call remove_process
1387 itself; it's all taken care of here. */
1388 record_unwind_protect (start_process_unwind, proc);
1390 pset_childp (XPROCESS (proc), Qt);
1391 pset_plist (XPROCESS (proc), Qnil);
1392 pset_type (XPROCESS (proc), Qreal);
1393 pset_buffer (XPROCESS (proc), buffer);
1394 pset_sentinel (XPROCESS (proc), Qinternal_default_process_sentinel);
1395 pset_filter (XPROCESS (proc), Qinternal_default_process_filter);
1396 pset_command (XPROCESS (proc), Flist (nargs - 2, args + 2));
1398 #ifdef HAVE_GNUTLS
1399 /* AKA GNUTLS_INITSTAGE(proc). */
1400 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1401 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1402 #endif
1404 #ifdef ADAPTIVE_READ_BUFFERING
1405 XPROCESS (proc)->adaptive_read_buffering
1406 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1407 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1408 #endif
1410 /* Make the process marker point into the process buffer (if any). */
1411 if (BUFFERP (buffer))
1412 set_marker_both (XPROCESS (proc)->mark, buffer,
1413 BUF_ZV (XBUFFER (buffer)),
1414 BUF_ZV_BYTE (XBUFFER (buffer)));
1417 /* Decide coding systems for communicating with the process. Here
1418 we don't setup the structure coding_system nor pay attention to
1419 unibyte mode. They are done in create_process. */
1421 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1422 Lisp_Object coding_systems = Qt;
1423 Lisp_Object val, *args2;
1424 struct gcpro gcpro1, gcpro2;
1426 val = Vcoding_system_for_read;
1427 if (NILP (val))
1429 args2 = alloca ((nargs + 1) * sizeof *args2);
1430 args2[0] = Qstart_process;
1431 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1432 GCPRO2 (proc, current_dir);
1433 if (!NILP (program))
1434 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1435 UNGCPRO;
1436 if (CONSP (coding_systems))
1437 val = XCAR (coding_systems);
1438 else if (CONSP (Vdefault_process_coding_system))
1439 val = XCAR (Vdefault_process_coding_system);
1441 pset_decode_coding_system (XPROCESS (proc), val);
1443 val = Vcoding_system_for_write;
1444 if (NILP (val))
1446 if (EQ (coding_systems, Qt))
1448 args2 = alloca ((nargs + 1) * sizeof *args2);
1449 args2[0] = Qstart_process;
1450 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1451 GCPRO2 (proc, current_dir);
1452 if (!NILP (program))
1453 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1454 UNGCPRO;
1456 if (CONSP (coding_systems))
1457 val = XCDR (coding_systems);
1458 else if (CONSP (Vdefault_process_coding_system))
1459 val = XCDR (Vdefault_process_coding_system);
1461 pset_encode_coding_system (XPROCESS (proc), val);
1462 /* Note: At this moment, the above coding system may leave
1463 text-conversion or eol-conversion unspecified. They will be
1464 decided after we read output from the process and decode it by
1465 some coding system, or just before we actually send a text to
1466 the process. */
1470 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1471 XPROCESS (proc)->decoding_carryover = 0;
1472 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1474 XPROCESS (proc)->inherit_coding_system_flag
1475 = !(NILP (buffer) || !inherit_process_coding_system);
1477 if (!NILP (program))
1479 /* If program file name is not absolute, search our path for it.
1480 Put the name we will really use in TEM. */
1481 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1482 && !(SCHARS (program) > 1
1483 && IS_DEVICE_SEP (SREF (program, 1))))
1485 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1487 tem = Qnil;
1488 GCPRO4 (name, program, buffer, current_dir);
1489 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1490 UNGCPRO;
1491 if (NILP (tem))
1492 report_file_error ("Searching for program", Fcons (program, Qnil));
1493 tem = Fexpand_file_name (tem, Qnil);
1495 else
1497 if (!NILP (Ffile_directory_p (program)))
1498 error ("Specified program for new process is a directory");
1499 tem = program;
1502 /* If program file name starts with /: for quoting a magic name,
1503 discard that. */
1504 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1505 && SREF (tem, 1) == ':')
1506 tem = Fsubstring (tem, make_number (2), Qnil);
1509 Lisp_Object arg_encoding = Qnil;
1510 struct gcpro gcpro1;
1511 GCPRO1 (tem);
1513 /* Encode the file name and put it in NEW_ARGV.
1514 That's where the child will use it to execute the program. */
1515 tem = Fcons (ENCODE_FILE (tem), Qnil);
1517 /* Here we encode arguments by the coding system used for sending
1518 data to the process. We don't support using different coding
1519 systems for encoding arguments and for encoding data sent to the
1520 process. */
1522 for (i = 3; i < nargs; i++)
1524 tem = Fcons (args[i], tem);
1525 CHECK_STRING (XCAR (tem));
1526 if (STRING_MULTIBYTE (XCAR (tem)))
1528 if (NILP (arg_encoding))
1529 arg_encoding = (complement_process_encoding_system
1530 (XPROCESS (proc)->encode_coding_system));
1531 XSETCAR (tem,
1532 code_convert_string_norecord
1533 (XCAR (tem), arg_encoding, 1));
1537 UNGCPRO;
1540 /* Now that everything is encoded we can collect the strings into
1541 NEW_ARGV. */
1542 new_argv = alloca ((nargs - 1) * sizeof *new_argv);
1543 new_argv[nargs - 2] = 0;
1545 for (i = nargs - 2; i-- != 0; )
1547 new_argv[i] = SDATA (XCAR (tem));
1548 tem = XCDR (tem);
1551 create_process (proc, (char **) new_argv, current_dir);
1553 else
1554 create_pty (proc);
1556 return unbind_to (count, proc);
1559 /* This function is the unwind_protect form for Fstart_process. If
1560 PROC doesn't have its pid set, then we know someone has signaled
1561 an error and the process wasn't started successfully, so we should
1562 remove it from the process list. */
1563 static Lisp_Object
1564 start_process_unwind (Lisp_Object proc)
1566 if (!PROCESSP (proc))
1567 emacs_abort ();
1569 /* Was PROC started successfully?
1570 -2 is used for a pty with no process, eg for gdb. */
1571 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1572 remove_process (proc);
1574 return Qnil;
1577 static void
1578 create_process_1 (struct atimer *timer)
1580 /* Nothing to do. */
1584 static void
1585 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1587 int inchannel, outchannel;
1588 pid_t pid;
1589 int sv[2];
1590 #ifndef WINDOWSNT
1591 int wait_child_setup[2];
1592 #endif
1593 sigset_t blocked;
1594 /* Use volatile to protect variables from being clobbered by vfork. */
1595 volatile int forkin, forkout;
1596 volatile bool pty_flag = 0;
1597 volatile Lisp_Object lisp_pty_name = Qnil;
1598 volatile Lisp_Object encoded_current_dir;
1600 inchannel = outchannel = -1;
1602 #ifdef HAVE_PTYS
1603 if (!NILP (Vprocess_connection_type))
1604 outchannel = inchannel = allocate_pty ();
1606 if (inchannel >= 0)
1608 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1609 /* On most USG systems it does not work to open the pty's tty here,
1610 then close it and reopen it in the child. */
1611 /* Don't let this terminal become our controlling terminal
1612 (in case we don't have one). */
1613 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1614 if (forkin < 0)
1615 report_file_error ("Opening pty", Qnil);
1616 #else
1617 forkin = forkout = -1;
1618 #endif /* not USG, or USG_SUBTTY_WORKS */
1619 pty_flag = 1;
1620 lisp_pty_name = build_string (pty_name);
1622 else
1623 #endif /* HAVE_PTYS */
1625 int tem;
1626 tem = pipe (sv);
1627 if (tem < 0)
1628 report_file_error ("Creating pipe", Qnil);
1629 inchannel = sv[0];
1630 forkout = sv[1];
1631 tem = pipe (sv);
1632 if (tem < 0)
1634 emacs_close (inchannel);
1635 emacs_close (forkout);
1636 report_file_error ("Creating pipe", Qnil);
1638 outchannel = sv[1];
1639 forkin = sv[0];
1642 #ifndef WINDOWSNT
1644 int tem;
1646 tem = pipe (wait_child_setup);
1647 if (tem < 0)
1648 report_file_error ("Creating pipe", Qnil);
1649 tem = fcntl (wait_child_setup[1], F_GETFD, 0);
1650 if (tem >= 0)
1651 tem = fcntl (wait_child_setup[1], F_SETFD, tem | FD_CLOEXEC);
1652 if (tem < 0)
1654 emacs_close (wait_child_setup[0]);
1655 emacs_close (wait_child_setup[1]);
1656 report_file_error ("Setting file descriptor flags", Qnil);
1659 #endif
1661 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1662 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1664 /* Record this as an active process, with its channels.
1665 As a result, child_setup will close Emacs's side of the pipes. */
1666 chan_process[inchannel] = process;
1667 XPROCESS (process)->infd = inchannel;
1668 XPROCESS (process)->outfd = outchannel;
1670 /* Previously we recorded the tty descriptor used in the subprocess.
1671 It was only used for getting the foreground tty process, so now
1672 we just reopen the device (see emacs_get_tty_pgrp) as this is
1673 more portable (see USG_SUBTTY_WORKS above). */
1675 XPROCESS (process)->pty_flag = pty_flag;
1676 pset_status (XPROCESS (process), Qrun);
1678 FD_SET (inchannel, &input_wait_mask);
1679 FD_SET (inchannel, &non_keyboard_wait_mask);
1680 if (inchannel > max_process_desc)
1681 max_process_desc = inchannel;
1683 /* This may signal an error. */
1684 setup_process_coding_systems (process);
1686 encoded_current_dir = ENCODE_FILE (current_dir);
1688 block_input ();
1690 /* Block SIGCHLD until we have a chance to store the new fork's
1691 pid in its process structure. */
1692 sigemptyset (&blocked);
1693 sigaddset (&blocked, SIGCHLD);
1694 pthread_sigmask (SIG_BLOCK, &blocked, 0);
1696 #ifndef WINDOWSNT
1697 pid = vfork ();
1698 if (pid == 0)
1699 #endif /* not WINDOWSNT */
1701 int xforkin = forkin;
1702 int xforkout = forkout;
1704 /* Make the pty be the controlling terminal of the process. */
1705 #ifdef HAVE_PTYS
1706 /* First, disconnect its current controlling terminal. */
1707 /* We tried doing setsid only if pty_flag, but it caused
1708 process_set_signal to fail on SGI when using a pipe. */
1709 setsid ();
1710 /* Make the pty's terminal the controlling terminal. */
1711 if (pty_flag && xforkin >= 0)
1713 #ifdef TIOCSCTTY
1714 /* We ignore the return value
1715 because faith@cs.unc.edu says that is necessary on Linux. */
1716 ioctl (xforkin, TIOCSCTTY, 0);
1717 #endif
1719 #if defined (LDISC1)
1720 if (pty_flag && xforkin >= 0)
1722 struct termios t;
1723 tcgetattr (xforkin, &t);
1724 t.c_lflag = LDISC1;
1725 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1726 emacs_write (1, "create_process/tcsetattr LDISC1 failed\n", 39);
1728 #else
1729 #if defined (NTTYDISC) && defined (TIOCSETD)
1730 if (pty_flag && xforkin >= 0)
1732 /* Use new line discipline. */
1733 int ldisc = NTTYDISC;
1734 ioctl (xforkin, TIOCSETD, &ldisc);
1736 #endif
1737 #endif
1738 #ifdef TIOCNOTTY
1739 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1740 can do TIOCSPGRP only to the process's controlling tty. */
1741 if (pty_flag)
1743 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1744 I can't test it since I don't have 4.3. */
1745 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1746 if (j >= 0)
1748 ioctl (j, TIOCNOTTY, 0);
1749 emacs_close (j);
1752 #endif /* TIOCNOTTY */
1754 #if !defined (DONT_REOPEN_PTY)
1755 /*** There is a suggestion that this ought to be a
1756 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
1757 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1758 that system does seem to need this code, even though
1759 both TIOCSCTTY is defined. */
1760 /* Now close the pty (if we had it open) and reopen it.
1761 This makes the pty the controlling terminal of the subprocess. */
1762 if (pty_flag)
1765 /* I wonder if emacs_close (emacs_open (pty_name, ...))
1766 would work? */
1767 if (xforkin >= 0)
1768 emacs_close (xforkin);
1769 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
1771 if (xforkin < 0)
1773 emacs_write (1, "Couldn't open the pty terminal ", 31);
1774 emacs_write (1, pty_name, strlen (pty_name));
1775 emacs_write (1, "\n", 1);
1776 _exit (1);
1780 #endif /* not DONT_REOPEN_PTY */
1782 #ifdef SETUP_SLAVE_PTY
1783 if (pty_flag)
1785 SETUP_SLAVE_PTY;
1787 #endif /* SETUP_SLAVE_PTY */
1788 #ifdef AIX
1789 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
1790 Now reenable it in the child, so it will die when we want it to. */
1791 if (pty_flag)
1792 signal (SIGHUP, SIG_DFL);
1793 #endif
1794 #endif /* HAVE_PTYS */
1796 signal (SIGINT, SIG_DFL);
1797 signal (SIGQUIT, SIG_DFL);
1799 /* Emacs ignores SIGPIPE, but the child should not. */
1800 signal (SIGPIPE, SIG_DFL);
1802 /* Stop blocking signals in the child. */
1803 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
1805 if (pty_flag)
1806 child_setup_tty (xforkout);
1807 #ifdef WINDOWSNT
1808 pid = child_setup (xforkin, xforkout, xforkout,
1809 new_argv, 1, encoded_current_dir);
1810 #else /* not WINDOWSNT */
1811 emacs_close (wait_child_setup[0]);
1812 child_setup (xforkin, xforkout, xforkout,
1813 new_argv, 1, encoded_current_dir);
1814 #endif /* not WINDOWSNT */
1817 /* Back in the parent process. */
1819 XPROCESS (process)->pid = pid;
1820 if (pid >= 0)
1821 XPROCESS (process)->alive = 1;
1823 /* Stop blocking signals in the parent. */
1824 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
1825 unblock_input ();
1827 if (pid < 0)
1829 if (forkin >= 0)
1830 emacs_close (forkin);
1831 if (forkin != forkout && forkout >= 0)
1832 emacs_close (forkout);
1834 else
1836 /* vfork succeeded. */
1838 #ifdef WINDOWSNT
1839 register_child (pid, inchannel);
1840 #endif /* WINDOWSNT */
1842 /* If the subfork execv fails, and it exits,
1843 this close hangs. I don't know why.
1844 So have an interrupt jar it loose. */
1846 struct atimer *timer;
1847 EMACS_TIME offset = make_emacs_time (1, 0);
1849 stop_polling ();
1850 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
1852 if (forkin >= 0)
1853 emacs_close (forkin);
1855 cancel_atimer (timer);
1856 start_polling ();
1859 if (forkin != forkout && forkout >= 0)
1860 emacs_close (forkout);
1862 pset_tty_name (XPROCESS (process), lisp_pty_name);
1864 #ifndef WINDOWSNT
1865 /* Wait for child_setup to complete in case that vfork is
1866 actually defined as fork. The descriptor wait_child_setup[1]
1867 of a pipe is closed at the child side either by close-on-exec
1868 on successful execve or the _exit call in child_setup. */
1870 char dummy;
1872 emacs_close (wait_child_setup[1]);
1873 emacs_read (wait_child_setup[0], &dummy, 1);
1874 emacs_close (wait_child_setup[0]);
1876 #endif
1879 /* Now generate the error if vfork failed. */
1880 if (pid < 0)
1881 report_file_error ("Doing vfork", Qnil);
1884 void
1885 create_pty (Lisp_Object process)
1887 int inchannel, outchannel;
1888 bool pty_flag = 0;
1890 inchannel = outchannel = -1;
1892 #ifdef HAVE_PTYS
1893 if (!NILP (Vprocess_connection_type))
1894 outchannel = inchannel = allocate_pty ();
1896 if (inchannel >= 0)
1898 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1899 /* On most USG systems it does not work to open the pty's tty here,
1900 then close it and reopen it in the child. */
1901 /* Don't let this terminal become our controlling terminal
1902 (in case we don't have one). */
1903 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1904 if (forkout < 0)
1905 report_file_error ("Opening pty", Qnil);
1906 #if defined (DONT_REOPEN_PTY)
1907 /* In the case that vfork is defined as fork, the parent process
1908 (Emacs) may send some data before the child process completes
1909 tty options setup. So we setup tty before forking. */
1910 child_setup_tty (forkout);
1911 #endif /* DONT_REOPEN_PTY */
1912 #endif /* not USG, or USG_SUBTTY_WORKS */
1913 pty_flag = 1;
1915 #endif /* HAVE_PTYS */
1917 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1918 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1920 /* Record this as an active process, with its channels.
1921 As a result, child_setup will close Emacs's side of the pipes. */
1922 chan_process[inchannel] = process;
1923 XPROCESS (process)->infd = inchannel;
1924 XPROCESS (process)->outfd = outchannel;
1926 /* Previously we recorded the tty descriptor used in the subprocess.
1927 It was only used for getting the foreground tty process, so now
1928 we just reopen the device (see emacs_get_tty_pgrp) as this is
1929 more portable (see USG_SUBTTY_WORKS above). */
1931 XPROCESS (process)->pty_flag = pty_flag;
1932 pset_status (XPROCESS (process), Qrun);
1933 setup_process_coding_systems (process);
1935 FD_SET (inchannel, &input_wait_mask);
1936 FD_SET (inchannel, &non_keyboard_wait_mask);
1937 if (inchannel > max_process_desc)
1938 max_process_desc = inchannel;
1940 XPROCESS (process)->pid = -2;
1941 #ifdef HAVE_PTYS
1942 if (pty_flag)
1943 pset_tty_name (XPROCESS (process), build_string (pty_name));
1944 else
1945 #endif
1946 pset_tty_name (XPROCESS (process), Qnil);
1950 /* Convert an internal struct sockaddr to a lisp object (vector or string).
1951 The address family of sa is not included in the result. */
1953 static Lisp_Object
1954 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
1956 Lisp_Object address;
1957 int i;
1958 unsigned char *cp;
1959 register struct Lisp_Vector *p;
1961 /* Workaround for a bug in getsockname on BSD: Names bound to
1962 sockets in the UNIX domain are inaccessible; getsockname returns
1963 a zero length name. */
1964 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
1965 return empty_unibyte_string;
1967 switch (sa->sa_family)
1969 case AF_INET:
1971 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
1972 len = sizeof (sin->sin_addr) + 1;
1973 address = Fmake_vector (make_number (len), Qnil);
1974 p = XVECTOR (address);
1975 p->contents[--len] = make_number (ntohs (sin->sin_port));
1976 cp = (unsigned char *) &sin->sin_addr;
1977 break;
1979 #ifdef AF_INET6
1980 case AF_INET6:
1982 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
1983 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
1984 len = sizeof (sin6->sin6_addr)/2 + 1;
1985 address = Fmake_vector (make_number (len), Qnil);
1986 p = XVECTOR (address);
1987 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
1988 for (i = 0; i < len; i++)
1989 p->contents[i] = make_number (ntohs (ip6[i]));
1990 return address;
1992 #endif
1993 #ifdef HAVE_LOCAL_SOCKETS
1994 case AF_LOCAL:
1996 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
1997 for (i = 0; i < sizeof (sockun->sun_path); i++)
1998 if (sockun->sun_path[i] == 0)
1999 break;
2000 return make_unibyte_string (sockun->sun_path, i);
2002 #endif
2003 default:
2004 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2005 address = Fcons (make_number (sa->sa_family),
2006 Fmake_vector (make_number (len), Qnil));
2007 p = XVECTOR (XCDR (address));
2008 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2009 break;
2012 i = 0;
2013 while (i < len)
2014 p->contents[i++] = make_number (*cp++);
2016 return address;
2020 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2022 static int
2023 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2025 register struct Lisp_Vector *p;
2027 if (VECTORP (address))
2029 p = XVECTOR (address);
2030 if (p->header.size == 5)
2032 *familyp = AF_INET;
2033 return sizeof (struct sockaddr_in);
2035 #ifdef AF_INET6
2036 else if (p->header.size == 9)
2038 *familyp = AF_INET6;
2039 return sizeof (struct sockaddr_in6);
2041 #endif
2043 #ifdef HAVE_LOCAL_SOCKETS
2044 else if (STRINGP (address))
2046 *familyp = AF_LOCAL;
2047 return sizeof (struct sockaddr_un);
2049 #endif
2050 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2051 && VECTORP (XCDR (address)))
2053 struct sockaddr *sa;
2054 *familyp = XINT (XCAR (address));
2055 p = XVECTOR (XCDR (address));
2056 return p->header.size + sizeof (sa->sa_family);
2058 return 0;
2061 /* Convert an address object (vector or string) to an internal sockaddr.
2063 The address format has been basically validated by
2064 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2065 it could have come from user data. So if FAMILY is not valid,
2066 we return after zeroing *SA. */
2068 static void
2069 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2071 register struct Lisp_Vector *p;
2072 register unsigned char *cp = NULL;
2073 register int i;
2074 EMACS_INT hostport;
2076 memset (sa, 0, len);
2078 if (VECTORP (address))
2080 p = XVECTOR (address);
2081 if (family == AF_INET)
2083 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2084 len = sizeof (sin->sin_addr) + 1;
2085 hostport = XINT (p->contents[--len]);
2086 sin->sin_port = htons (hostport);
2087 cp = (unsigned char *)&sin->sin_addr;
2088 sa->sa_family = family;
2090 #ifdef AF_INET6
2091 else if (family == AF_INET6)
2093 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2094 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2095 len = sizeof (sin6->sin6_addr) + 1;
2096 hostport = XINT (p->contents[--len]);
2097 sin6->sin6_port = htons (hostport);
2098 for (i = 0; i < len; i++)
2099 if (INTEGERP (p->contents[i]))
2101 int j = XFASTINT (p->contents[i]) & 0xffff;
2102 ip6[i] = ntohs (j);
2104 sa->sa_family = family;
2105 return;
2107 #endif
2108 else
2109 return;
2111 else if (STRINGP (address))
2113 #ifdef HAVE_LOCAL_SOCKETS
2114 if (family == AF_LOCAL)
2116 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2117 cp = SDATA (address);
2118 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2119 sockun->sun_path[i] = *cp++;
2120 sa->sa_family = family;
2122 #endif
2123 return;
2125 else
2127 p = XVECTOR (XCDR (address));
2128 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2131 for (i = 0; i < len; i++)
2132 if (INTEGERP (p->contents[i]))
2133 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2136 #ifdef DATAGRAM_SOCKETS
2137 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2138 1, 1, 0,
2139 doc: /* Get the current datagram address associated with PROCESS. */)
2140 (Lisp_Object process)
2142 int channel;
2144 CHECK_PROCESS (process);
2146 if (!DATAGRAM_CONN_P (process))
2147 return Qnil;
2149 channel = XPROCESS (process)->infd;
2150 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2151 datagram_address[channel].len);
2154 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2155 2, 2, 0,
2156 doc: /* Set the datagram address for PROCESS to ADDRESS.
2157 Returns nil upon error setting address, ADDRESS otherwise. */)
2158 (Lisp_Object process, Lisp_Object address)
2160 int channel;
2161 int family, len;
2163 CHECK_PROCESS (process);
2165 if (!DATAGRAM_CONN_P (process))
2166 return Qnil;
2168 channel = XPROCESS (process)->infd;
2170 len = get_lisp_to_sockaddr_size (address, &family);
2171 if (len == 0 || datagram_address[channel].len != len)
2172 return Qnil;
2173 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2174 return address;
2176 #endif
2179 static const struct socket_options {
2180 /* The name of this option. Should be lowercase version of option
2181 name without SO_ prefix. */
2182 const char *name;
2183 /* Option level SOL_... */
2184 int optlevel;
2185 /* Option number SO_... */
2186 int optnum;
2187 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2188 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2189 } socket_options[] =
2191 #ifdef SO_BINDTODEVICE
2192 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2193 #endif
2194 #ifdef SO_BROADCAST
2195 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2196 #endif
2197 #ifdef SO_DONTROUTE
2198 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2199 #endif
2200 #ifdef SO_KEEPALIVE
2201 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2202 #endif
2203 #ifdef SO_LINGER
2204 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2205 #endif
2206 #ifdef SO_OOBINLINE
2207 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2208 #endif
2209 #ifdef SO_PRIORITY
2210 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2211 #endif
2212 #ifdef SO_REUSEADDR
2213 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2214 #endif
2215 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2218 /* Set option OPT to value VAL on socket S.
2220 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2221 Signals an error if setting a known option fails.
2224 static int
2225 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2227 char *name;
2228 const struct socket_options *sopt;
2229 int ret = 0;
2231 CHECK_SYMBOL (opt);
2233 name = SSDATA (SYMBOL_NAME (opt));
2234 for (sopt = socket_options; sopt->name; sopt++)
2235 if (strcmp (name, sopt->name) == 0)
2236 break;
2238 switch (sopt->opttype)
2240 case SOPT_BOOL:
2242 int optval;
2243 optval = NILP (val) ? 0 : 1;
2244 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2245 &optval, sizeof (optval));
2246 break;
2249 case SOPT_INT:
2251 int optval;
2252 if (TYPE_RANGED_INTEGERP (int, val))
2253 optval = XINT (val);
2254 else
2255 error ("Bad option value for %s", name);
2256 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2257 &optval, sizeof (optval));
2258 break;
2261 #ifdef SO_BINDTODEVICE
2262 case SOPT_IFNAME:
2264 char devname[IFNAMSIZ+1];
2266 /* This is broken, at least in the Linux 2.4 kernel.
2267 To unbind, the arg must be a zero integer, not the empty string.
2268 This should work on all systems. KFS. 2003-09-23. */
2269 memset (devname, 0, sizeof devname);
2270 if (STRINGP (val))
2272 char *arg = SSDATA (val);
2273 int len = min (strlen (arg), IFNAMSIZ);
2274 memcpy (devname, arg, len);
2276 else if (!NILP (val))
2277 error ("Bad option value for %s", name);
2278 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2279 devname, IFNAMSIZ);
2280 break;
2282 #endif
2284 #ifdef SO_LINGER
2285 case SOPT_LINGER:
2287 struct linger linger;
2289 linger.l_onoff = 1;
2290 linger.l_linger = 0;
2291 if (TYPE_RANGED_INTEGERP (int, val))
2292 linger.l_linger = XINT (val);
2293 else
2294 linger.l_onoff = NILP (val) ? 0 : 1;
2295 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2296 &linger, sizeof (linger));
2297 break;
2299 #endif
2301 default:
2302 return 0;
2305 if (ret < 0)
2306 report_file_error ("Cannot set network option",
2307 Fcons (opt, Fcons (val, Qnil)));
2308 return (1 << sopt->optbit);
2312 DEFUN ("set-network-process-option",
2313 Fset_network_process_option, Sset_network_process_option,
2314 3, 4, 0,
2315 doc: /* For network process PROCESS set option OPTION to value VALUE.
2316 See `make-network-process' for a list of options and values.
2317 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2318 OPTION is not a supported option, return nil instead; otherwise return t. */)
2319 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2321 int s;
2322 struct Lisp_Process *p;
2324 CHECK_PROCESS (process);
2325 p = XPROCESS (process);
2326 if (!NETCONN1_P (p))
2327 error ("Process is not a network process");
2329 s = p->infd;
2330 if (s < 0)
2331 error ("Process is not running");
2333 if (set_socket_option (s, option, value))
2335 pset_childp (p, Fplist_put (p->childp, option, value));
2336 return Qt;
2339 if (NILP (no_error))
2340 error ("Unknown or unsupported option");
2342 return Qnil;
2346 DEFUN ("serial-process-configure",
2347 Fserial_process_configure,
2348 Sserial_process_configure,
2349 0, MANY, 0,
2350 doc: /* Configure speed, bytesize, etc. of a serial process.
2352 Arguments are specified as keyword/argument pairs. Attributes that
2353 are not given are re-initialized from the process's current
2354 configuration (available via the function `process-contact') or set to
2355 reasonable default values. The following arguments are defined:
2357 :process PROCESS
2358 :name NAME
2359 :buffer BUFFER
2360 :port PORT
2361 -- Any of these arguments can be given to identify the process that is
2362 to be configured. If none of these arguments is given, the current
2363 buffer's process is used.
2365 :speed SPEED -- SPEED is the speed of the serial port in bits per
2366 second, also called baud rate. Any value can be given for SPEED, but
2367 most serial ports work only at a few defined values between 1200 and
2368 115200, with 9600 being the most common value. If SPEED is nil, the
2369 serial port is not configured any further, i.e., all other arguments
2370 are ignored. This may be useful for special serial ports such as
2371 Bluetooth-to-serial converters which can only be configured through AT
2372 commands. A value of nil for SPEED can be used only when passed
2373 through `make-serial-process' or `serial-term'.
2375 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2376 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2378 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2379 `odd' (use odd parity), or the symbol `even' (use even parity). If
2380 PARITY is not given, no parity is used.
2382 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2383 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2384 is not given or nil, 1 stopbit is used.
2386 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2387 flowcontrol to be used, which is either nil (don't use flowcontrol),
2388 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2389 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2390 flowcontrol is used.
2392 `serial-process-configure' is called by `make-serial-process' for the
2393 initial configuration of the serial port.
2395 Examples:
2397 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2399 \(serial-process-configure
2400 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2402 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2404 usage: (serial-process-configure &rest ARGS) */)
2405 (ptrdiff_t nargs, Lisp_Object *args)
2407 struct Lisp_Process *p;
2408 Lisp_Object contact = Qnil;
2409 Lisp_Object proc = Qnil;
2410 struct gcpro gcpro1;
2412 contact = Flist (nargs, args);
2413 GCPRO1 (contact);
2415 proc = Fplist_get (contact, QCprocess);
2416 if (NILP (proc))
2417 proc = Fplist_get (contact, QCname);
2418 if (NILP (proc))
2419 proc = Fplist_get (contact, QCbuffer);
2420 if (NILP (proc))
2421 proc = Fplist_get (contact, QCport);
2422 proc = get_process (proc);
2423 p = XPROCESS (proc);
2424 if (!EQ (p->type, Qserial))
2425 error ("Not a serial process");
2427 if (NILP (Fplist_get (p->childp, QCspeed)))
2429 UNGCPRO;
2430 return Qnil;
2433 serial_configure (p, contact);
2435 UNGCPRO;
2436 return Qnil;
2439 /* Used by make-serial-process to recover from errors. */
2440 static Lisp_Object
2441 make_serial_process_unwind (Lisp_Object proc)
2443 if (!PROCESSP (proc))
2444 emacs_abort ();
2445 remove_process (proc);
2446 return Qnil;
2449 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2450 0, MANY, 0,
2451 doc: /* Create and return a serial port process.
2453 In Emacs, serial port connections are represented by process objects,
2454 so input and output work as for subprocesses, and `delete-process'
2455 closes a serial port connection. However, a serial process has no
2456 process id, it cannot be signaled, and the status codes are different
2457 from normal processes.
2459 `make-serial-process' creates a process and a buffer, on which you
2460 probably want to use `process-send-string'. Try \\[serial-term] for
2461 an interactive terminal. See below for examples.
2463 Arguments are specified as keyword/argument pairs. The following
2464 arguments are defined:
2466 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2467 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2468 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2469 the backslashes in strings).
2471 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2472 which this function calls.
2474 :name NAME -- NAME is the name of the process. If NAME is not given,
2475 the value of PORT is used.
2477 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2478 with the process. Process output goes at the end of that buffer,
2479 unless you specify an output stream or filter function to handle the
2480 output. If BUFFER is not given, the value of NAME is used.
2482 :coding CODING -- If CODING is a symbol, it specifies the coding
2483 system used for both reading and writing for this process. If CODING
2484 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2485 ENCODING is used for writing.
2487 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2488 the process is running. If BOOL is not given, query before exiting.
2490 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2491 In the stopped state, a serial process does not accept incoming data,
2492 but you can send outgoing data. The stopped state is cleared by
2493 `continue-process' and set by `stop-process'.
2495 :filter FILTER -- Install FILTER as the process filter.
2497 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2499 :plist PLIST -- Install PLIST as the initial plist of the process.
2501 :bytesize
2502 :parity
2503 :stopbits
2504 :flowcontrol
2505 -- This function calls `serial-process-configure' to handle these
2506 arguments.
2508 The original argument list, possibly modified by later configuration,
2509 is available via the function `process-contact'.
2511 Examples:
2513 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2515 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2517 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2519 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2521 usage: (make-serial-process &rest ARGS) */)
2522 (ptrdiff_t nargs, Lisp_Object *args)
2524 int fd = -1;
2525 Lisp_Object proc, contact, port;
2526 struct Lisp_Process *p;
2527 struct gcpro gcpro1;
2528 Lisp_Object name, buffer;
2529 Lisp_Object tem, val;
2530 ptrdiff_t specpdl_count;
2532 if (nargs == 0)
2533 return Qnil;
2535 contact = Flist (nargs, args);
2536 GCPRO1 (contact);
2538 port = Fplist_get (contact, QCport);
2539 if (NILP (port))
2540 error ("No port specified");
2541 CHECK_STRING (port);
2543 if (NILP (Fplist_member (contact, QCspeed)))
2544 error (":speed not specified");
2545 if (!NILP (Fplist_get (contact, QCspeed)))
2546 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2548 name = Fplist_get (contact, QCname);
2549 if (NILP (name))
2550 name = port;
2551 CHECK_STRING (name);
2552 proc = make_process (name);
2553 specpdl_count = SPECPDL_INDEX ();
2554 record_unwind_protect (make_serial_process_unwind, proc);
2555 p = XPROCESS (proc);
2557 fd = serial_open (SSDATA (port));
2558 p->infd = fd;
2559 p->outfd = fd;
2560 if (fd > max_process_desc)
2561 max_process_desc = fd;
2562 chan_process[fd] = proc;
2564 buffer = Fplist_get (contact, QCbuffer);
2565 if (NILP (buffer))
2566 buffer = name;
2567 buffer = Fget_buffer_create (buffer);
2568 pset_buffer (p, buffer);
2570 pset_childp (p, contact);
2571 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2572 pset_type (p, Qserial);
2573 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2574 pset_filter (p, Fplist_get (contact, QCfilter));
2575 pset_log (p, Qnil);
2576 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2577 p->kill_without_query = 1;
2578 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2579 pset_command (p, Qt);
2580 p->pty_flag = 0;
2582 if (!EQ (p->command, Qt))
2584 FD_SET (fd, &input_wait_mask);
2585 FD_SET (fd, &non_keyboard_wait_mask);
2588 if (BUFFERP (buffer))
2590 set_marker_both (p->mark, buffer,
2591 BUF_ZV (XBUFFER (buffer)),
2592 BUF_ZV_BYTE (XBUFFER (buffer)));
2595 tem = Fplist_member (contact, QCcoding);
2596 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2597 tem = Qnil;
2599 val = Qnil;
2600 if (!NILP (tem))
2602 val = XCAR (XCDR (tem));
2603 if (CONSP (val))
2604 val = XCAR (val);
2606 else if (!NILP (Vcoding_system_for_read))
2607 val = Vcoding_system_for_read;
2608 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2609 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2610 val = Qnil;
2611 pset_decode_coding_system (p, val);
2613 val = Qnil;
2614 if (!NILP (tem))
2616 val = XCAR (XCDR (tem));
2617 if (CONSP (val))
2618 val = XCDR (val);
2620 else if (!NILP (Vcoding_system_for_write))
2621 val = Vcoding_system_for_write;
2622 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2623 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2624 val = Qnil;
2625 pset_encode_coding_system (p, val);
2627 setup_process_coding_systems (proc);
2628 pset_decoding_buf (p, empty_unibyte_string);
2629 p->decoding_carryover = 0;
2630 pset_encoding_buf (p, empty_unibyte_string);
2631 p->inherit_coding_system_flag
2632 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2634 Fserial_process_configure (nargs, args);
2636 specpdl_ptr = specpdl + specpdl_count;
2638 UNGCPRO;
2639 return proc;
2642 /* Create a network stream/datagram client/server process. Treated
2643 exactly like a normal process when reading and writing. Primary
2644 differences are in status display and process deletion. A network
2645 connection has no PID; you cannot signal it. All you can do is
2646 stop/continue it and deactivate/close it via delete-process */
2648 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2649 0, MANY, 0,
2650 doc: /* Create and return a network server or client process.
2652 In Emacs, network connections are represented by process objects, so
2653 input and output work as for subprocesses and `delete-process' closes
2654 a network connection. However, a network process has no process id,
2655 it cannot be signaled, and the status codes are different from normal
2656 processes.
2658 Arguments are specified as keyword/argument pairs. The following
2659 arguments are defined:
2661 :name NAME -- NAME is name for process. It is modified if necessary
2662 to make it unique.
2664 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2665 with the process. Process output goes at end of that buffer, unless
2666 you specify an output stream or filter function to handle the output.
2667 BUFFER may be also nil, meaning that this process is not associated
2668 with any buffer.
2670 :host HOST -- HOST is name of the host to connect to, or its IP
2671 address. The symbol `local' specifies the local host. If specified
2672 for a server process, it must be a valid name or address for the local
2673 host, and only clients connecting to that address will be accepted.
2675 :service SERVICE -- SERVICE is name of the service desired, or an
2676 integer specifying a port number to connect to. If SERVICE is t,
2677 a random port number is selected for the server. (If Emacs was
2678 compiled with getaddrinfo, a port number can also be specified as a
2679 string, e.g. "80", as well as an integer. This is not portable.)
2681 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2682 stream type connection, `datagram' creates a datagram type connection,
2683 `seqpacket' creates a reliable datagram connection.
2685 :family FAMILY -- FAMILY is the address (and protocol) family for the
2686 service specified by HOST and SERVICE. The default (nil) is to use
2687 whatever address family (IPv4 or IPv6) that is defined for the host
2688 and port number specified by HOST and SERVICE. Other address families
2689 supported are:
2690 local -- for a local (i.e. UNIX) address specified by SERVICE.
2691 ipv4 -- use IPv4 address family only.
2692 ipv6 -- use IPv6 address family only.
2694 :local ADDRESS -- ADDRESS is the local address used for the connection.
2695 This parameter is ignored when opening a client process. When specified
2696 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2698 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2699 connection. This parameter is ignored when opening a stream server
2700 process. For a datagram server process, it specifies the initial
2701 setting of the remote datagram address. When specified for a client
2702 process, the FAMILY, HOST, and SERVICE args are ignored.
2704 The format of ADDRESS depends on the address family:
2705 - An IPv4 address is represented as an vector of integers [A B C D P]
2706 corresponding to numeric IP address A.B.C.D and port number P.
2707 - A local address is represented as a string with the address in the
2708 local address space.
2709 - An "unsupported family" address is represented by a cons (F . AV)
2710 where F is the family number and AV is a vector containing the socket
2711 address data with one element per address data byte. Do not rely on
2712 this format in portable code, as it may depend on implementation
2713 defined constants, data sizes, and data structure alignment.
2715 :coding CODING -- If CODING is a symbol, it specifies the coding
2716 system used for both reading and writing for this process. If CODING
2717 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2718 ENCODING is used for writing.
2720 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2721 return without waiting for the connection to complete; instead, the
2722 sentinel function will be called with second arg matching "open" (if
2723 successful) or "failed" when the connect completes. Default is to use
2724 a blocking connect (i.e. wait) for stream type connections.
2726 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2727 running when Emacs is exited.
2729 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2730 In the stopped state, a server process does not accept new
2731 connections, and a client process does not handle incoming traffic.
2732 The stopped state is cleared by `continue-process' and set by
2733 `stop-process'.
2735 :filter FILTER -- Install FILTER as the process filter.
2737 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2738 process filter are multibyte, otherwise they are unibyte.
2739 If this keyword is not specified, the strings are multibyte if
2740 the default value of `enable-multibyte-characters' is non-nil.
2742 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2744 :log LOG -- Install LOG as the server process log function. This
2745 function is called when the server accepts a network connection from a
2746 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2747 is the server process, CLIENT is the new process for the connection,
2748 and MESSAGE is a string.
2750 :plist PLIST -- Install PLIST as the new process' initial plist.
2752 :server QLEN -- if QLEN is non-nil, create a server process for the
2753 specified FAMILY, SERVICE, and connection type (stream or datagram).
2754 If QLEN is an integer, it is used as the max. length of the server's
2755 pending connection queue (also known as the backlog); the default
2756 queue length is 5. Default is to create a client process.
2758 The following network options can be specified for this connection:
2760 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2761 :dontroute BOOL -- Only send to directly connected hosts.
2762 :keepalive BOOL -- Send keep-alive messages on network stream.
2763 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2764 :oobinline BOOL -- Place out-of-band data in receive data stream.
2765 :priority INT -- Set protocol defined priority for sent packets.
2766 :reuseaddr BOOL -- Allow reusing a recently used local address
2767 (this is allowed by default for a server process).
2768 :bindtodevice NAME -- bind to interface NAME. Using this may require
2769 special privileges on some systems.
2771 Consult the relevant system programmer's manual pages for more
2772 information on using these options.
2775 A server process will listen for and accept connections from clients.
2776 When a client connection is accepted, a new network process is created
2777 for the connection with the following parameters:
2779 - The client's process name is constructed by concatenating the server
2780 process' NAME and a client identification string.
2781 - If the FILTER argument is non-nil, the client process will not get a
2782 separate process buffer; otherwise, the client's process buffer is a newly
2783 created buffer named after the server process' BUFFER name or process
2784 NAME concatenated with the client identification string.
2785 - The connection type and the process filter and sentinel parameters are
2786 inherited from the server process' TYPE, FILTER and SENTINEL.
2787 - The client process' contact info is set according to the client's
2788 addressing information (typically an IP address and a port number).
2789 - The client process' plist is initialized from the server's plist.
2791 Notice that the FILTER and SENTINEL args are never used directly by
2792 the server process. Also, the BUFFER argument is not used directly by
2793 the server process, but via the optional :log function, accepted (and
2794 failed) connections may be logged in the server process' buffer.
2796 The original argument list, modified with the actual connection
2797 information, is available via the `process-contact' function.
2799 usage: (make-network-process &rest ARGS) */)
2800 (ptrdiff_t nargs, Lisp_Object *args)
2802 Lisp_Object proc;
2803 Lisp_Object contact;
2804 struct Lisp_Process *p;
2805 #ifdef HAVE_GETADDRINFO
2806 struct addrinfo ai, *res, *lres;
2807 struct addrinfo hints;
2808 const char *portstring;
2809 char portbuf[128];
2810 #else /* HAVE_GETADDRINFO */
2811 struct _emacs_addrinfo
2813 int ai_family;
2814 int ai_socktype;
2815 int ai_protocol;
2816 int ai_addrlen;
2817 struct sockaddr *ai_addr;
2818 struct _emacs_addrinfo *ai_next;
2819 } ai, *res, *lres;
2820 #endif /* HAVE_GETADDRINFO */
2821 struct sockaddr_in address_in;
2822 #ifdef HAVE_LOCAL_SOCKETS
2823 struct sockaddr_un address_un;
2824 #endif
2825 int port;
2826 int ret = 0;
2827 int xerrno = 0;
2828 int s = -1, outch, inch;
2829 struct gcpro gcpro1;
2830 ptrdiff_t count = SPECPDL_INDEX ();
2831 ptrdiff_t count1;
2832 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2833 Lisp_Object tem;
2834 Lisp_Object name, buffer, host, service, address;
2835 Lisp_Object filter, sentinel;
2836 bool is_non_blocking_client = 0;
2837 bool is_server = 0;
2838 int backlog = 5;
2839 int socktype;
2840 int family = -1;
2842 if (nargs == 0)
2843 return Qnil;
2845 /* Save arguments for process-contact and clone-process. */
2846 contact = Flist (nargs, args);
2847 GCPRO1 (contact);
2849 #ifdef WINDOWSNT
2850 /* Ensure socket support is loaded if available. */
2851 init_winsock (TRUE);
2852 #endif
2854 /* :type TYPE (nil: stream, datagram */
2855 tem = Fplist_get (contact, QCtype);
2856 if (NILP (tem))
2857 socktype = SOCK_STREAM;
2858 #ifdef DATAGRAM_SOCKETS
2859 else if (EQ (tem, Qdatagram))
2860 socktype = SOCK_DGRAM;
2861 #endif
2862 #ifdef HAVE_SEQPACKET
2863 else if (EQ (tem, Qseqpacket))
2864 socktype = SOCK_SEQPACKET;
2865 #endif
2866 else
2867 error ("Unsupported connection type");
2869 /* :server BOOL */
2870 tem = Fplist_get (contact, QCserver);
2871 if (!NILP (tem))
2873 /* Don't support network sockets when non-blocking mode is
2874 not available, since a blocked Emacs is not useful. */
2875 is_server = 1;
2876 if (TYPE_RANGED_INTEGERP (int, tem))
2877 backlog = XINT (tem);
2880 /* Make QCaddress an alias for :local (server) or :remote (client). */
2881 QCaddress = is_server ? QClocal : QCremote;
2883 /* :nowait BOOL */
2884 if (!is_server && socktype != SOCK_DGRAM
2885 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2887 #ifndef NON_BLOCKING_CONNECT
2888 error ("Non-blocking connect not supported");
2889 #else
2890 is_non_blocking_client = 1;
2891 #endif
2894 name = Fplist_get (contact, QCname);
2895 buffer = Fplist_get (contact, QCbuffer);
2896 filter = Fplist_get (contact, QCfilter);
2897 sentinel = Fplist_get (contact, QCsentinel);
2899 CHECK_STRING (name);
2901 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2902 ai.ai_socktype = socktype;
2903 ai.ai_protocol = 0;
2904 ai.ai_next = NULL;
2905 res = &ai;
2907 /* :local ADDRESS or :remote ADDRESS */
2908 address = Fplist_get (contact, QCaddress);
2909 if (!NILP (address))
2911 host = service = Qnil;
2913 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2914 error ("Malformed :address");
2915 ai.ai_family = family;
2916 ai.ai_addr = alloca (ai.ai_addrlen);
2917 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2918 goto open_socket;
2921 /* :family FAMILY -- nil (for Inet), local, or integer. */
2922 tem = Fplist_get (contact, QCfamily);
2923 if (NILP (tem))
2925 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
2926 family = AF_UNSPEC;
2927 #else
2928 family = AF_INET;
2929 #endif
2931 #ifdef HAVE_LOCAL_SOCKETS
2932 else if (EQ (tem, Qlocal))
2933 family = AF_LOCAL;
2934 #endif
2935 #ifdef AF_INET6
2936 else if (EQ (tem, Qipv6))
2937 family = AF_INET6;
2938 #endif
2939 else if (EQ (tem, Qipv4))
2940 family = AF_INET;
2941 else if (TYPE_RANGED_INTEGERP (int, tem))
2942 family = XINT (tem);
2943 else
2944 error ("Unknown address family");
2946 ai.ai_family = family;
2948 /* :service SERVICE -- string, integer (port number), or t (random port). */
2949 service = Fplist_get (contact, QCservice);
2951 /* :host HOST -- hostname, ip address, or 'local for localhost. */
2952 host = Fplist_get (contact, QChost);
2953 if (!NILP (host))
2955 if (EQ (host, Qlocal))
2956 /* Depending on setup, "localhost" may map to different IPv4 and/or
2957 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
2958 host = build_string ("127.0.0.1");
2959 CHECK_STRING (host);
2962 #ifdef HAVE_LOCAL_SOCKETS
2963 if (family == AF_LOCAL)
2965 if (!NILP (host))
2967 message (":family local ignores the :host \"%s\" property",
2968 SDATA (host));
2969 contact = Fplist_put (contact, QChost, Qnil);
2970 host = Qnil;
2972 CHECK_STRING (service);
2973 memset (&address_un, 0, sizeof address_un);
2974 address_un.sun_family = AF_LOCAL;
2975 if (sizeof address_un.sun_path <= SBYTES (service))
2976 error ("Service name too long");
2977 strcpy (address_un.sun_path, SSDATA (service));
2978 ai.ai_addr = (struct sockaddr *) &address_un;
2979 ai.ai_addrlen = sizeof address_un;
2980 goto open_socket;
2982 #endif
2984 /* Slow down polling to every ten seconds.
2985 Some kernels have a bug which causes retrying connect to fail
2986 after a connect. Polling can interfere with gethostbyname too. */
2987 #ifdef POLL_FOR_INPUT
2988 if (socktype != SOCK_DGRAM)
2990 record_unwind_protect (unwind_stop_other_atimers, Qnil);
2991 bind_polling_period (10);
2993 #endif
2995 #ifdef HAVE_GETADDRINFO
2996 /* If we have a host, use getaddrinfo to resolve both host and service.
2997 Otherwise, use getservbyname to lookup the service. */
2998 if (!NILP (host))
3001 /* SERVICE can either be a string or int.
3002 Convert to a C string for later use by getaddrinfo. */
3003 if (EQ (service, Qt))
3004 portstring = "0";
3005 else if (INTEGERP (service))
3007 sprintf (portbuf, "%"pI"d", XINT (service));
3008 portstring = portbuf;
3010 else
3012 CHECK_STRING (service);
3013 portstring = SSDATA (service);
3016 immediate_quit = 1;
3017 QUIT;
3018 memset (&hints, 0, sizeof (hints));
3019 hints.ai_flags = 0;
3020 hints.ai_family = family;
3021 hints.ai_socktype = socktype;
3022 hints.ai_protocol = 0;
3024 #ifdef HAVE_RES_INIT
3025 res_init ();
3026 #endif
3028 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3029 if (ret)
3030 #ifdef HAVE_GAI_STRERROR
3031 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3032 #else
3033 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3034 #endif
3035 immediate_quit = 0;
3037 goto open_socket;
3039 #endif /* HAVE_GETADDRINFO */
3041 /* We end up here if getaddrinfo is not defined, or in case no hostname
3042 has been specified (e.g. for a local server process). */
3044 if (EQ (service, Qt))
3045 port = 0;
3046 else if (INTEGERP (service))
3047 port = htons ((unsigned short) XINT (service));
3048 else
3050 struct servent *svc_info;
3051 CHECK_STRING (service);
3052 svc_info = getservbyname (SSDATA (service),
3053 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3054 if (svc_info == 0)
3055 error ("Unknown service: %s", SDATA (service));
3056 port = svc_info->s_port;
3059 memset (&address_in, 0, sizeof address_in);
3060 address_in.sin_family = family;
3061 address_in.sin_addr.s_addr = INADDR_ANY;
3062 address_in.sin_port = port;
3064 #ifndef HAVE_GETADDRINFO
3065 if (!NILP (host))
3067 struct hostent *host_info_ptr;
3069 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3070 as it may `hang' Emacs for a very long time. */
3071 immediate_quit = 1;
3072 QUIT;
3074 #ifdef HAVE_RES_INIT
3075 res_init ();
3076 #endif
3078 host_info_ptr = gethostbyname (SDATA (host));
3079 immediate_quit = 0;
3081 if (host_info_ptr)
3083 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3084 host_info_ptr->h_length);
3085 family = host_info_ptr->h_addrtype;
3086 address_in.sin_family = family;
3088 else
3089 /* Attempt to interpret host as numeric inet address */
3091 unsigned long numeric_addr;
3092 numeric_addr = inet_addr (SSDATA (host));
3093 if (numeric_addr == -1)
3094 error ("Unknown host \"%s\"", SDATA (host));
3096 memcpy (&address_in.sin_addr, &numeric_addr,
3097 sizeof (address_in.sin_addr));
3101 #endif /* not HAVE_GETADDRINFO */
3103 ai.ai_family = family;
3104 ai.ai_addr = (struct sockaddr *) &address_in;
3105 ai.ai_addrlen = sizeof address_in;
3107 open_socket:
3109 /* Do this in case we never enter the for-loop below. */
3110 count1 = SPECPDL_INDEX ();
3111 s = -1;
3113 for (lres = res; lres; lres = lres->ai_next)
3115 ptrdiff_t optn;
3116 int optbits;
3118 #ifdef WINDOWSNT
3119 retry_connect:
3120 #endif
3122 s = socket (lres->ai_family, lres->ai_socktype, lres->ai_protocol);
3123 if (s < 0)
3125 xerrno = errno;
3126 continue;
3129 #ifdef DATAGRAM_SOCKETS
3130 if (!is_server && socktype == SOCK_DGRAM)
3131 break;
3132 #endif /* DATAGRAM_SOCKETS */
3134 #ifdef NON_BLOCKING_CONNECT
3135 if (is_non_blocking_client)
3137 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3138 if (ret < 0)
3140 xerrno = errno;
3141 emacs_close (s);
3142 s = -1;
3143 continue;
3146 #endif
3148 /* Make us close S if quit. */
3149 record_unwind_protect (close_file_unwind, make_number (s));
3151 /* Parse network options in the arg list.
3152 We simply ignore anything which isn't a known option (including other keywords).
3153 An error is signaled if setting a known option fails. */
3154 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3155 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3157 if (is_server)
3159 /* Configure as a server socket. */
3161 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3162 explicit :reuseaddr key to override this. */
3163 #ifdef HAVE_LOCAL_SOCKETS
3164 if (family != AF_LOCAL)
3165 #endif
3166 if (!(optbits & (1 << OPIX_REUSEADDR)))
3168 int optval = 1;
3169 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3170 report_file_error ("Cannot set reuse option on server socket", Qnil);
3173 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3174 report_file_error ("Cannot bind server socket", Qnil);
3176 #ifdef HAVE_GETSOCKNAME
3177 if (EQ (service, Qt))
3179 struct sockaddr_in sa1;
3180 socklen_t len1 = sizeof (sa1);
3181 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3183 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3184 service = make_number (ntohs (sa1.sin_port));
3185 contact = Fplist_put (contact, QCservice, service);
3188 #endif
3190 if (socktype != SOCK_DGRAM && listen (s, backlog))
3191 report_file_error ("Cannot listen on server socket", Qnil);
3193 break;
3196 immediate_quit = 1;
3197 QUIT;
3199 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3200 xerrno = errno;
3202 if (ret == 0 || xerrno == EISCONN)
3204 /* The unwind-protect will be discarded afterwards.
3205 Likewise for immediate_quit. */
3206 break;
3209 #ifdef NON_BLOCKING_CONNECT
3210 #ifdef EINPROGRESS
3211 if (is_non_blocking_client && xerrno == EINPROGRESS)
3212 break;
3213 #else
3214 #ifdef EWOULDBLOCK
3215 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3216 break;
3217 #endif
3218 #endif
3219 #endif
3221 #ifndef WINDOWSNT
3222 if (xerrno == EINTR)
3224 /* Unlike most other syscalls connect() cannot be called
3225 again. (That would return EALREADY.) The proper way to
3226 wait for completion is pselect(). */
3227 int sc;
3228 socklen_t len;
3229 SELECT_TYPE fdset;
3230 retry_select:
3231 FD_ZERO (&fdset);
3232 FD_SET (s, &fdset);
3233 QUIT;
3234 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3235 if (sc == -1)
3237 if (errno == EINTR)
3238 goto retry_select;
3239 else
3240 report_file_error ("select failed", Qnil);
3242 eassert (sc > 0);
3244 len = sizeof xerrno;
3245 eassert (FD_ISSET (s, &fdset));
3246 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) == -1)
3247 report_file_error ("getsockopt failed", Qnil);
3248 if (xerrno)
3249 errno = xerrno, report_file_error ("error during connect", Qnil);
3250 else
3251 break;
3253 #endif /* !WINDOWSNT */
3255 immediate_quit = 0;
3257 /* Discard the unwind protect closing S. */
3258 specpdl_ptr = specpdl + count1;
3259 emacs_close (s);
3260 s = -1;
3262 #ifdef WINDOWSNT
3263 if (xerrno == EINTR)
3264 goto retry_connect;
3265 #endif
3268 if (s >= 0)
3270 #ifdef DATAGRAM_SOCKETS
3271 if (socktype == SOCK_DGRAM)
3273 if (datagram_address[s].sa)
3274 emacs_abort ();
3275 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3276 datagram_address[s].len = lres->ai_addrlen;
3277 if (is_server)
3279 Lisp_Object remote;
3280 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3281 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3283 int rfamily, rlen;
3284 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3285 if (rlen != 0 && rfamily == lres->ai_family
3286 && rlen == lres->ai_addrlen)
3287 conv_lisp_to_sockaddr (rfamily, remote,
3288 datagram_address[s].sa, rlen);
3291 else
3292 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3294 #endif
3295 contact = Fplist_put (contact, QCaddress,
3296 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3297 #ifdef HAVE_GETSOCKNAME
3298 if (!is_server)
3300 struct sockaddr_in sa1;
3301 socklen_t len1 = sizeof (sa1);
3302 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3303 contact = Fplist_put (contact, QClocal,
3304 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3306 #endif
3309 immediate_quit = 0;
3311 #ifdef HAVE_GETADDRINFO
3312 if (res != &ai)
3314 block_input ();
3315 freeaddrinfo (res);
3316 unblock_input ();
3318 #endif
3320 /* Discard the unwind protect for closing S, if any. */
3321 specpdl_ptr = specpdl + count1;
3323 /* Unwind bind_polling_period and request_sigio. */
3324 unbind_to (count, Qnil);
3326 if (s < 0)
3328 /* If non-blocking got this far - and failed - assume non-blocking is
3329 not supported after all. This is probably a wrong assumption, but
3330 the normal blocking calls to open-network-stream handles this error
3331 better. */
3332 if (is_non_blocking_client)
3333 return Qnil;
3335 errno = xerrno;
3336 if (is_server)
3337 report_file_error ("make server process failed", contact);
3338 else
3339 report_file_error ("make client process failed", contact);
3342 inch = s;
3343 outch = s;
3345 if (!NILP (buffer))
3346 buffer = Fget_buffer_create (buffer);
3347 proc = make_process (name);
3349 chan_process[inch] = proc;
3351 fcntl (inch, F_SETFL, O_NONBLOCK);
3353 p = XPROCESS (proc);
3355 pset_childp (p, contact);
3356 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3357 pset_type (p, Qnetwork);
3359 pset_buffer (p, buffer);
3360 pset_sentinel (p, sentinel);
3361 pset_filter (p, filter);
3362 pset_log (p, Fplist_get (contact, QClog));
3363 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3364 p->kill_without_query = 1;
3365 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3366 pset_command (p, Qt);
3367 p->pid = 0;
3368 p->infd = inch;
3369 p->outfd = outch;
3370 if (is_server && socktype != SOCK_DGRAM)
3371 pset_status (p, Qlisten);
3373 /* Make the process marker point into the process buffer (if any). */
3374 if (BUFFERP (buffer))
3375 set_marker_both (p->mark, buffer,
3376 BUF_ZV (XBUFFER (buffer)),
3377 BUF_ZV_BYTE (XBUFFER (buffer)));
3379 #ifdef NON_BLOCKING_CONNECT
3380 if (is_non_blocking_client)
3382 /* We may get here if connect did succeed immediately. However,
3383 in that case, we still need to signal this like a non-blocking
3384 connection. */
3385 pset_status (p, Qconnect);
3386 if (!FD_ISSET (inch, &connect_wait_mask))
3388 FD_SET (inch, &connect_wait_mask);
3389 FD_SET (inch, &write_mask);
3390 num_pending_connects++;
3393 else
3394 #endif
3395 /* A server may have a client filter setting of Qt, but it must
3396 still listen for incoming connects unless it is stopped. */
3397 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3398 || (EQ (p->status, Qlisten) && NILP (p->command)))
3400 FD_SET (inch, &input_wait_mask);
3401 FD_SET (inch, &non_keyboard_wait_mask);
3404 if (inch > max_process_desc)
3405 max_process_desc = inch;
3407 tem = Fplist_member (contact, QCcoding);
3408 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3409 tem = Qnil; /* No error message (too late!). */
3412 /* Setup coding systems for communicating with the network stream. */
3413 struct gcpro gcpro1;
3414 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3415 Lisp_Object coding_systems = Qt;
3416 Lisp_Object fargs[5], val;
3418 if (!NILP (tem))
3420 val = XCAR (XCDR (tem));
3421 if (CONSP (val))
3422 val = XCAR (val);
3424 else if (!NILP (Vcoding_system_for_read))
3425 val = Vcoding_system_for_read;
3426 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3427 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3428 /* We dare not decode end-of-line format by setting VAL to
3429 Qraw_text, because the existing Emacs Lisp libraries
3430 assume that they receive bare code including a sequence of
3431 CR LF. */
3432 val = Qnil;
3433 else
3435 if (NILP (host) || NILP (service))
3436 coding_systems = Qnil;
3437 else
3439 fargs[0] = Qopen_network_stream, fargs[1] = name,
3440 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3441 GCPRO1 (proc);
3442 coding_systems = Ffind_operation_coding_system (5, fargs);
3443 UNGCPRO;
3445 if (CONSP (coding_systems))
3446 val = XCAR (coding_systems);
3447 else if (CONSP (Vdefault_process_coding_system))
3448 val = XCAR (Vdefault_process_coding_system);
3449 else
3450 val = Qnil;
3452 pset_decode_coding_system (p, val);
3454 if (!NILP (tem))
3456 val = XCAR (XCDR (tem));
3457 if (CONSP (val))
3458 val = XCDR (val);
3460 else if (!NILP (Vcoding_system_for_write))
3461 val = Vcoding_system_for_write;
3462 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3463 val = Qnil;
3464 else
3466 if (EQ (coding_systems, Qt))
3468 if (NILP (host) || NILP (service))
3469 coding_systems = Qnil;
3470 else
3472 fargs[0] = Qopen_network_stream, fargs[1] = name,
3473 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3474 GCPRO1 (proc);
3475 coding_systems = Ffind_operation_coding_system (5, fargs);
3476 UNGCPRO;
3479 if (CONSP (coding_systems))
3480 val = XCDR (coding_systems);
3481 else if (CONSP (Vdefault_process_coding_system))
3482 val = XCDR (Vdefault_process_coding_system);
3483 else
3484 val = Qnil;
3486 pset_encode_coding_system (p, val);
3488 setup_process_coding_systems (proc);
3490 pset_decoding_buf (p, empty_unibyte_string);
3491 p->decoding_carryover = 0;
3492 pset_encoding_buf (p, empty_unibyte_string);
3494 p->inherit_coding_system_flag
3495 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3497 UNGCPRO;
3498 return proc;
3502 #if defined (HAVE_NET_IF_H)
3504 #ifdef SIOCGIFCONF
3505 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3506 doc: /* Return an alist of all network interfaces and their network address.
3507 Each element is a cons, the car of which is a string containing the
3508 interface name, and the cdr is the network address in internal
3509 format; see the description of ADDRESS in `make-network-process'. */)
3510 (void)
3512 struct ifconf ifconf;
3513 struct ifreq *ifreq;
3514 void *buf = NULL;
3515 ptrdiff_t buf_size = 512;
3516 int s;
3517 Lisp_Object res;
3519 s = socket (AF_INET, SOCK_STREAM, 0);
3520 if (s < 0)
3521 return Qnil;
3525 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3526 ifconf.ifc_buf = buf;
3527 ifconf.ifc_len = buf_size;
3528 if (ioctl (s, SIOCGIFCONF, &ifconf))
3530 close (s);
3531 xfree (buf);
3532 return Qnil;
3535 while (ifconf.ifc_len == buf_size);
3537 close (s);
3539 res = Qnil;
3540 ifreq = ifconf.ifc_req;
3541 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3543 struct ifreq *ifq = ifreq;
3544 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3545 #define SIZEOF_IFREQ(sif) \
3546 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3547 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3549 int len = SIZEOF_IFREQ (ifq);
3550 #else
3551 int len = sizeof (*ifreq);
3552 #endif
3553 char namebuf[sizeof (ifq->ifr_name) + 1];
3554 ifreq = (struct ifreq *) ((char *) ifreq + len);
3556 if (ifq->ifr_addr.sa_family != AF_INET)
3557 continue;
3559 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3560 namebuf[sizeof (ifq->ifr_name)] = 0;
3561 res = Fcons (Fcons (build_string (namebuf),
3562 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3563 sizeof (struct sockaddr))),
3564 res);
3567 xfree (buf);
3568 return res;
3570 #endif /* SIOCGIFCONF */
3572 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3574 struct ifflag_def {
3575 int flag_bit;
3576 const char *flag_sym;
3579 static const struct ifflag_def ifflag_table[] = {
3580 #ifdef IFF_UP
3581 { IFF_UP, "up" },
3582 #endif
3583 #ifdef IFF_BROADCAST
3584 { IFF_BROADCAST, "broadcast" },
3585 #endif
3586 #ifdef IFF_DEBUG
3587 { IFF_DEBUG, "debug" },
3588 #endif
3589 #ifdef IFF_LOOPBACK
3590 { IFF_LOOPBACK, "loopback" },
3591 #endif
3592 #ifdef IFF_POINTOPOINT
3593 { IFF_POINTOPOINT, "pointopoint" },
3594 #endif
3595 #ifdef IFF_RUNNING
3596 { IFF_RUNNING, "running" },
3597 #endif
3598 #ifdef IFF_NOARP
3599 { IFF_NOARP, "noarp" },
3600 #endif
3601 #ifdef IFF_PROMISC
3602 { IFF_PROMISC, "promisc" },
3603 #endif
3604 #ifdef IFF_NOTRAILERS
3605 #ifdef NS_IMPL_COCOA
3606 /* Really means smart, notrailers is obsolete */
3607 { IFF_NOTRAILERS, "smart" },
3608 #else
3609 { IFF_NOTRAILERS, "notrailers" },
3610 #endif
3611 #endif
3612 #ifdef IFF_ALLMULTI
3613 { IFF_ALLMULTI, "allmulti" },
3614 #endif
3615 #ifdef IFF_MASTER
3616 { IFF_MASTER, "master" },
3617 #endif
3618 #ifdef IFF_SLAVE
3619 { IFF_SLAVE, "slave" },
3620 #endif
3621 #ifdef IFF_MULTICAST
3622 { IFF_MULTICAST, "multicast" },
3623 #endif
3624 #ifdef IFF_PORTSEL
3625 { IFF_PORTSEL, "portsel" },
3626 #endif
3627 #ifdef IFF_AUTOMEDIA
3628 { IFF_AUTOMEDIA, "automedia" },
3629 #endif
3630 #ifdef IFF_DYNAMIC
3631 { IFF_DYNAMIC, "dynamic" },
3632 #endif
3633 #ifdef IFF_OACTIVE
3634 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3635 #endif
3636 #ifdef IFF_SIMPLEX
3637 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3638 #endif
3639 #ifdef IFF_LINK0
3640 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3641 #endif
3642 #ifdef IFF_LINK1
3643 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3644 #endif
3645 #ifdef IFF_LINK2
3646 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3647 #endif
3648 { 0, 0 }
3651 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3652 doc: /* Return information about network interface named IFNAME.
3653 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3654 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3655 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
3656 FLAGS is the current flags of the interface. */)
3657 (Lisp_Object ifname)
3659 struct ifreq rq;
3660 Lisp_Object res = Qnil;
3661 Lisp_Object elt;
3662 int s;
3663 bool any = 0;
3664 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3665 && defined HAVE_GETIFADDRS && defined LLADDR)
3666 struct ifaddrs *ifap;
3667 #endif
3669 CHECK_STRING (ifname);
3671 if (sizeof rq.ifr_name <= SBYTES (ifname))
3672 error ("interface name too long");
3673 strcpy (rq.ifr_name, SSDATA (ifname));
3675 s = socket (AF_INET, SOCK_STREAM, 0);
3676 if (s < 0)
3677 return Qnil;
3679 elt = Qnil;
3680 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3681 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3683 int flags = rq.ifr_flags;
3684 const struct ifflag_def *fp;
3685 int fnum;
3687 /* If flags is smaller than int (i.e. short) it may have the high bit set
3688 due to IFF_MULTICAST. In that case, sign extending it into
3689 an int is wrong. */
3690 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3691 flags = (unsigned short) rq.ifr_flags;
3693 any = 1;
3694 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3696 if (flags & fp->flag_bit)
3698 elt = Fcons (intern (fp->flag_sym), elt);
3699 flags -= fp->flag_bit;
3702 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3704 if (flags & 1)
3706 elt = Fcons (make_number (fnum), elt);
3710 #endif
3711 res = Fcons (elt, res);
3713 elt = Qnil;
3714 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3715 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3717 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3718 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3719 int n;
3721 any = 1;
3722 for (n = 0; n < 6; n++)
3723 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3724 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3726 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3727 if (getifaddrs (&ifap) != -1)
3729 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3730 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3731 struct ifaddrs *it;
3733 for (it = ifap; it != NULL; it = it->ifa_next)
3735 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3736 unsigned char linkaddr[6];
3737 int n;
3739 if (it->ifa_addr->sa_family != AF_LINK
3740 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3741 || sdl->sdl_alen != 6)
3742 continue;
3744 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3745 for (n = 0; n < 6; n++)
3746 p->contents[n] = make_number (linkaddr[n]);
3748 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3749 break;
3752 #ifdef HAVE_FREEIFADDRS
3753 freeifaddrs (ifap);
3754 #endif
3756 #endif /* HAVE_GETIFADDRS && LLADDR */
3758 res = Fcons (elt, res);
3760 elt = Qnil;
3761 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3762 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3764 any = 1;
3765 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3766 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3767 #else
3768 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3769 #endif
3771 #endif
3772 res = Fcons (elt, res);
3774 elt = Qnil;
3775 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3776 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3778 any = 1;
3779 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3781 #endif
3782 res = Fcons (elt, res);
3784 elt = Qnil;
3785 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3786 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3788 any = 1;
3789 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3791 #endif
3792 res = Fcons (elt, res);
3794 close (s);
3796 return any ? res : Qnil;
3798 #endif
3799 #endif /* defined (HAVE_NET_IF_H) */
3801 /* Turn off input and output for process PROC. */
3803 static void
3804 deactivate_process (Lisp_Object proc)
3806 register int inchannel, outchannel;
3807 register struct Lisp_Process *p = XPROCESS (proc);
3809 #ifdef HAVE_GNUTLS
3810 /* Delete GnuTLS structures in PROC, if any. */
3811 emacs_gnutls_deinit (proc);
3812 #endif /* HAVE_GNUTLS */
3814 inchannel = p->infd;
3815 outchannel = p->outfd;
3817 #ifdef ADAPTIVE_READ_BUFFERING
3818 if (p->read_output_delay > 0)
3820 if (--process_output_delay_count < 0)
3821 process_output_delay_count = 0;
3822 p->read_output_delay = 0;
3823 p->read_output_skip = 0;
3825 #endif
3827 if (inchannel >= 0)
3829 /* Beware SIGCHLD hereabouts. */
3830 flush_pending_output (inchannel);
3831 emacs_close (inchannel);
3832 if (outchannel >= 0 && outchannel != inchannel)
3833 emacs_close (outchannel);
3835 p->infd = -1;
3836 p->outfd = -1;
3837 #ifdef DATAGRAM_SOCKETS
3838 if (DATAGRAM_CHAN_P (inchannel))
3840 xfree (datagram_address[inchannel].sa);
3841 datagram_address[inchannel].sa = 0;
3842 datagram_address[inchannel].len = 0;
3844 #endif
3845 chan_process[inchannel] = Qnil;
3846 FD_CLR (inchannel, &input_wait_mask);
3847 FD_CLR (inchannel, &non_keyboard_wait_mask);
3848 #ifdef NON_BLOCKING_CONNECT
3849 if (FD_ISSET (inchannel, &connect_wait_mask))
3851 FD_CLR (inchannel, &connect_wait_mask);
3852 FD_CLR (inchannel, &write_mask);
3853 if (--num_pending_connects < 0)
3854 emacs_abort ();
3856 #endif
3857 if (inchannel == max_process_desc)
3859 int i;
3860 /* We just closed the highest-numbered process input descriptor,
3861 so recompute the highest-numbered one now. */
3862 max_process_desc = 0;
3863 for (i = 0; i < MAXDESC; i++)
3864 if (!NILP (chan_process[i]))
3865 max_process_desc = i;
3871 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3872 0, 4, 0,
3873 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3874 It is read into the process' buffers or given to their filter functions.
3875 Non-nil arg PROCESS means do not return until some output has been received
3876 from PROCESS.
3878 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3879 and milliseconds to wait; return after that much time whether or not
3880 there is any subprocess output. If SECONDS is a floating point number,
3881 it specifies a fractional number of seconds to wait.
3882 The MILLISEC argument is obsolete and should be avoided.
3884 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3885 from PROCESS, suspending reading output from other processes.
3886 If JUST-THIS-ONE is an integer, don't run any timers either.
3887 Return non-nil if we received any output before the timeout expired. */)
3888 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3890 intmax_t secs;
3891 int nsecs;
3893 if (! NILP (process))
3894 CHECK_PROCESS (process);
3895 else
3896 just_this_one = Qnil;
3898 if (!NILP (millisec))
3899 { /* Obsolete calling convention using integers rather than floats. */
3900 CHECK_NUMBER (millisec);
3901 if (NILP (seconds))
3902 seconds = make_float (XINT (millisec) / 1000.0);
3903 else
3905 CHECK_NUMBER (seconds);
3906 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3910 secs = 0;
3911 nsecs = -1;
3913 if (!NILP (seconds))
3915 if (INTEGERP (seconds))
3917 if (XINT (seconds) > 0)
3919 secs = XINT (seconds);
3920 nsecs = 0;
3923 else if (FLOATP (seconds))
3925 if (XFLOAT_DATA (seconds) > 0)
3927 EMACS_TIME t = EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (seconds));
3928 secs = min (EMACS_SECS (t), WAIT_READING_MAX);
3929 nsecs = EMACS_NSECS (t);
3932 else
3933 wrong_type_argument (Qnumberp, seconds);
3935 else if (! NILP (process))
3936 nsecs = 0;
3938 return
3939 (wait_reading_process_output (secs, nsecs, 0, 0,
3940 Qnil,
3941 !NILP (process) ? XPROCESS (process) : NULL,
3942 NILP (just_this_one) ? 0 :
3943 !INTEGERP (just_this_one) ? 1 : -1)
3944 ? Qt : Qnil);
3947 /* Accept a connection for server process SERVER on CHANNEL. */
3949 static EMACS_INT connect_counter = 0;
3951 static void
3952 server_accept_connection (Lisp_Object server, int channel)
3954 Lisp_Object proc, caller, name, buffer;
3955 Lisp_Object contact, host, service;
3956 struct Lisp_Process *ps= XPROCESS (server);
3957 struct Lisp_Process *p;
3958 int s;
3959 union u_sockaddr {
3960 struct sockaddr sa;
3961 struct sockaddr_in in;
3962 #ifdef AF_INET6
3963 struct sockaddr_in6 in6;
3964 #endif
3965 #ifdef HAVE_LOCAL_SOCKETS
3966 struct sockaddr_un un;
3967 #endif
3968 } saddr;
3969 socklen_t len = sizeof saddr;
3971 s = accept (channel, &saddr.sa, &len);
3973 if (s < 0)
3975 int code = errno;
3977 if (code == EAGAIN)
3978 return;
3979 #ifdef EWOULDBLOCK
3980 if (code == EWOULDBLOCK)
3981 return;
3982 #endif
3984 if (!NILP (ps->log))
3985 call3 (ps->log, server, Qnil,
3986 concat3 (build_string ("accept failed with code"),
3987 Fnumber_to_string (make_number (code)),
3988 build_string ("\n")));
3989 return;
3992 connect_counter++;
3994 /* Setup a new process to handle the connection. */
3996 /* Generate a unique identification of the caller, and build contact
3997 information for this process. */
3998 host = Qt;
3999 service = Qnil;
4000 switch (saddr.sa.sa_family)
4002 case AF_INET:
4004 Lisp_Object args[5];
4005 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4006 args[0] = build_string ("%d.%d.%d.%d");
4007 args[1] = make_number (*ip++);
4008 args[2] = make_number (*ip++);
4009 args[3] = make_number (*ip++);
4010 args[4] = make_number (*ip++);
4011 host = Fformat (5, args);
4012 service = make_number (ntohs (saddr.in.sin_port));
4014 args[0] = build_string (" <%s:%d>");
4015 args[1] = host;
4016 args[2] = service;
4017 caller = Fformat (3, args);
4019 break;
4021 #ifdef AF_INET6
4022 case AF_INET6:
4024 Lisp_Object args[9];
4025 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4026 int i;
4027 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4028 for (i = 0; i < 8; i++)
4029 args[i+1] = make_number (ntohs (ip6[i]));
4030 host = Fformat (9, args);
4031 service = make_number (ntohs (saddr.in.sin_port));
4033 args[0] = build_string (" <[%s]:%d>");
4034 args[1] = host;
4035 args[2] = service;
4036 caller = Fformat (3, args);
4038 break;
4039 #endif
4041 #ifdef HAVE_LOCAL_SOCKETS
4042 case AF_LOCAL:
4043 #endif
4044 default:
4045 caller = Fnumber_to_string (make_number (connect_counter));
4046 caller = concat3 (build_string (" <"), caller, build_string (">"));
4047 break;
4050 /* Create a new buffer name for this process if it doesn't have a
4051 filter. The new buffer name is based on the buffer name or
4052 process name of the server process concatenated with the caller
4053 identification. */
4055 if (!(EQ (ps->filter, Qinternal_default_process_filter)
4056 || EQ (ps->filter, Qt)))
4057 buffer = Qnil;
4058 else
4060 buffer = ps->buffer;
4061 if (!NILP (buffer))
4062 buffer = Fbuffer_name (buffer);
4063 else
4064 buffer = ps->name;
4065 if (!NILP (buffer))
4067 buffer = concat2 (buffer, caller);
4068 buffer = Fget_buffer_create (buffer);
4072 /* Generate a unique name for the new server process. Combine the
4073 server process name with the caller identification. */
4075 name = concat2 (ps->name, caller);
4076 proc = make_process (name);
4078 chan_process[s] = proc;
4080 fcntl (s, F_SETFL, O_NONBLOCK);
4082 p = XPROCESS (proc);
4084 /* Build new contact information for this setup. */
4085 contact = Fcopy_sequence (ps->childp);
4086 contact = Fplist_put (contact, QCserver, Qnil);
4087 contact = Fplist_put (contact, QChost, host);
4088 if (!NILP (service))
4089 contact = Fplist_put (contact, QCservice, service);
4090 contact = Fplist_put (contact, QCremote,
4091 conv_sockaddr_to_lisp (&saddr.sa, len));
4092 #ifdef HAVE_GETSOCKNAME
4093 len = sizeof saddr;
4094 if (getsockname (s, &saddr.sa, &len) == 0)
4095 contact = Fplist_put (contact, QClocal,
4096 conv_sockaddr_to_lisp (&saddr.sa, len));
4097 #endif
4099 pset_childp (p, contact);
4100 pset_plist (p, Fcopy_sequence (ps->plist));
4101 pset_type (p, Qnetwork);
4103 pset_buffer (p, buffer);
4104 pset_sentinel (p, ps->sentinel);
4105 pset_filter (p, ps->filter);
4106 pset_command (p, Qnil);
4107 p->pid = 0;
4108 p->infd = s;
4109 p->outfd = s;
4110 pset_status (p, Qrun);
4112 /* Client processes for accepted connections are not stopped initially. */
4113 if (!EQ (p->filter, Qt))
4115 FD_SET (s, &input_wait_mask);
4116 FD_SET (s, &non_keyboard_wait_mask);
4119 if (s > max_process_desc)
4120 max_process_desc = s;
4122 /* Setup coding system for new process based on server process.
4123 This seems to be the proper thing to do, as the coding system
4124 of the new process should reflect the settings at the time the
4125 server socket was opened; not the current settings. */
4127 pset_decode_coding_system (p, ps->decode_coding_system);
4128 pset_encode_coding_system (p, ps->encode_coding_system);
4129 setup_process_coding_systems (proc);
4131 pset_decoding_buf (p, empty_unibyte_string);
4132 p->decoding_carryover = 0;
4133 pset_encoding_buf (p, empty_unibyte_string);
4135 p->inherit_coding_system_flag
4136 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4138 if (!NILP (ps->log))
4139 call3 (ps->log, server, proc,
4140 concat3 (build_string ("accept from "),
4141 (STRINGP (host) ? host : build_string ("-")),
4142 build_string ("\n")));
4144 exec_sentinel (proc,
4145 concat3 (build_string ("open from "),
4146 (STRINGP (host) ? host : build_string ("-")),
4147 build_string ("\n")));
4150 /* This variable is different from waiting_for_input in keyboard.c.
4151 It is used to communicate to a lisp process-filter/sentinel (via the
4152 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4153 for user-input when that process-filter was called.
4154 waiting_for_input cannot be used as that is by definition 0 when
4155 lisp code is being evalled.
4156 This is also used in record_asynch_buffer_change.
4157 For that purpose, this must be 0
4158 when not inside wait_reading_process_output. */
4159 static int waiting_for_user_input_p;
4161 static Lisp_Object
4162 wait_reading_process_output_unwind (Lisp_Object data)
4164 waiting_for_user_input_p = XINT (data);
4165 return Qnil;
4168 /* This is here so breakpoints can be put on it. */
4169 static void
4170 wait_reading_process_output_1 (void)
4174 /* Read and dispose of subprocess output while waiting for timeout to
4175 elapse and/or keyboard input to be available.
4177 TIME_LIMIT is:
4178 timeout in seconds
4179 If negative, gobble data immediately available but don't wait for any.
4181 NSECS is:
4182 an additional duration to wait, measured in nanoseconds
4183 If TIME_LIMIT is zero, then:
4184 If NSECS == 0, there is no limit.
4185 If NSECS > 0, the timeout consists of NSECS only.
4186 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4188 READ_KBD is:
4189 0 to ignore keyboard input, or
4190 1 to return when input is available, or
4191 -1 meaning caller will actually read the input, so don't throw to
4192 the quit handler, or
4194 DO_DISPLAY means redisplay should be done to show subprocess
4195 output that arrives.
4197 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4198 (and gobble terminal input into the buffer if any arrives).
4200 If WAIT_PROC is specified, wait until something arrives from that
4201 process. The return value is true if we read some input from
4202 that process.
4204 If JUST_WAIT_PROC is nonzero, handle only output from WAIT_PROC
4205 (suspending output from other processes). A negative value
4206 means don't run any timers either.
4208 If WAIT_PROC is specified, then the function returns true if we
4209 received input from that process before the timeout elapsed.
4210 Otherwise, return true if we received input from any process. */
4212 bool
4213 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4214 bool do_display,
4215 Lisp_Object wait_for_cell,
4216 struct Lisp_Process *wait_proc, int just_wait_proc)
4218 int channel, nfds;
4219 SELECT_TYPE Available;
4220 SELECT_TYPE Writeok;
4221 bool check_write;
4222 int check_delay;
4223 bool no_avail;
4224 int xerrno;
4225 Lisp_Object proc;
4226 EMACS_TIME timeout, end_time;
4227 int wait_channel = -1;
4228 bool got_some_input = 0;
4229 ptrdiff_t count = SPECPDL_INDEX ();
4231 FD_ZERO (&Available);
4232 FD_ZERO (&Writeok);
4234 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4235 && !(CONSP (wait_proc->status)
4236 && EQ (XCAR (wait_proc->status), Qexit)))
4237 message1 ("Blocking call to accept-process-output with quit inhibited!!");
4239 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4240 if (wait_proc != NULL)
4241 wait_channel = wait_proc->infd;
4243 record_unwind_protect (wait_reading_process_output_unwind,
4244 make_number (waiting_for_user_input_p));
4245 waiting_for_user_input_p = read_kbd;
4247 if (time_limit < 0)
4249 time_limit = 0;
4250 nsecs = -1;
4252 else if (TYPE_MAXIMUM (time_t) < time_limit)
4253 time_limit = TYPE_MAXIMUM (time_t);
4255 /* Since we may need to wait several times,
4256 compute the absolute time to return at. */
4257 if (time_limit || nsecs > 0)
4259 timeout = make_emacs_time (time_limit, nsecs);
4260 end_time = add_emacs_time (current_emacs_time (), timeout);
4263 while (1)
4265 bool timeout_reduced_for_timers = 0;
4267 /* If calling from keyboard input, do not quit
4268 since we want to return C-g as an input character.
4269 Otherwise, do pending quit if requested. */
4270 if (read_kbd >= 0)
4271 QUIT;
4272 else if (pending_signals)
4273 process_pending_signals ();
4275 /* Exit now if the cell we're waiting for became non-nil. */
4276 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4277 break;
4279 /* Compute time from now till when time limit is up. */
4280 /* Exit if already run out. */
4281 if (nsecs < 0)
4283 /* A negative timeout means
4284 gobble output available now
4285 but don't wait at all. */
4287 timeout = make_emacs_time (0, 0);
4289 else if (time_limit || nsecs > 0)
4291 EMACS_TIME now = current_emacs_time ();
4292 if (EMACS_TIME_LE (end_time, now))
4293 break;
4294 timeout = sub_emacs_time (end_time, now);
4296 else
4298 timeout = make_emacs_time (100000, 0);
4301 /* Normally we run timers here.
4302 But not if wait_for_cell; in those cases,
4303 the wait is supposed to be short,
4304 and those callers cannot handle running arbitrary Lisp code here. */
4305 if (NILP (wait_for_cell)
4306 && just_wait_proc >= 0)
4308 EMACS_TIME timer_delay;
4312 unsigned old_timers_run = timers_run;
4313 struct buffer *old_buffer = current_buffer;
4314 Lisp_Object old_window = selected_window;
4316 timer_delay = timer_check ();
4318 /* If a timer has run, this might have changed buffers
4319 an alike. Make read_key_sequence aware of that. */
4320 if (timers_run != old_timers_run
4321 && (old_buffer != current_buffer
4322 || !EQ (old_window, selected_window))
4323 && waiting_for_user_input_p == -1)
4324 record_asynch_buffer_change ();
4326 if (timers_run != old_timers_run && do_display)
4327 /* We must retry, since a timer may have requeued itself
4328 and that could alter the time_delay. */
4329 redisplay_preserve_echo_area (9);
4330 else
4331 break;
4333 while (!detect_input_pending ());
4335 /* If there is unread keyboard input, also return. */
4336 if (read_kbd != 0
4337 && requeued_events_pending_p ())
4338 break;
4340 /* A negative timeout means do not wait at all. */
4341 if (nsecs >= 0)
4343 if (EMACS_TIME_VALID_P (timer_delay))
4345 if (EMACS_TIME_LT (timer_delay, timeout))
4347 timeout = timer_delay;
4348 timeout_reduced_for_timers = 1;
4351 else
4353 /* This is so a breakpoint can be put here. */
4354 wait_reading_process_output_1 ();
4359 /* Cause C-g and alarm signals to take immediate action,
4360 and cause input available signals to zero out timeout.
4362 It is important that we do this before checking for process
4363 activity. If we get a SIGCHLD after the explicit checks for
4364 process activity, timeout is the only way we will know. */
4365 if (read_kbd < 0)
4366 set_waiting_for_input (&timeout);
4368 /* If status of something has changed, and no input is
4369 available, notify the user of the change right away. After
4370 this explicit check, we'll let the SIGCHLD handler zap
4371 timeout to get our attention. */
4372 if (update_tick != process_tick)
4374 SELECT_TYPE Atemp;
4375 SELECT_TYPE Ctemp;
4377 if (kbd_on_hold_p ())
4378 FD_ZERO (&Atemp);
4379 else
4380 Atemp = input_wait_mask;
4381 Ctemp = write_mask;
4383 timeout = make_emacs_time (0, 0);
4384 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4385 &Atemp,
4386 #ifdef NON_BLOCKING_CONNECT
4387 (num_pending_connects > 0 ? &Ctemp : NULL),
4388 #else
4389 NULL,
4390 #endif
4391 NULL, &timeout, NULL)
4392 <= 0))
4394 /* It's okay for us to do this and then continue with
4395 the loop, since timeout has already been zeroed out. */
4396 clear_waiting_for_input ();
4397 status_notify (NULL);
4398 if (do_display) redisplay_preserve_echo_area (13);
4402 /* Don't wait for output from a non-running process. Just
4403 read whatever data has already been received. */
4404 if (wait_proc && wait_proc->raw_status_new)
4405 update_status (wait_proc);
4406 if (wait_proc
4407 && ! EQ (wait_proc->status, Qrun)
4408 && ! EQ (wait_proc->status, Qconnect))
4410 int nread, total_nread = 0;
4412 clear_waiting_for_input ();
4413 XSETPROCESS (proc, wait_proc);
4415 /* Read data from the process, until we exhaust it. */
4416 while (wait_proc->infd >= 0)
4418 nread = read_process_output (proc, wait_proc->infd);
4420 if (nread == 0)
4421 break;
4423 if (nread > 0)
4425 total_nread += nread;
4426 got_some_input = 1;
4428 else if (nread == -1 && (errno == EIO || errno == EAGAIN))
4429 break;
4430 #ifdef EWOULDBLOCK
4431 else if (nread == -1 && EWOULDBLOCK == errno)
4432 break;
4433 #endif
4435 if (total_nread > 0 && do_display)
4436 redisplay_preserve_echo_area (10);
4438 break;
4441 /* Wait till there is something to do */
4443 if (wait_proc && just_wait_proc)
4445 if (wait_proc->infd < 0) /* Terminated */
4446 break;
4447 FD_SET (wait_proc->infd, &Available);
4448 check_delay = 0;
4449 check_write = 0;
4451 else if (!NILP (wait_for_cell))
4453 Available = non_process_wait_mask;
4454 check_delay = 0;
4455 check_write = 0;
4457 else
4459 if (! read_kbd)
4460 Available = non_keyboard_wait_mask;
4461 else
4462 Available = input_wait_mask;
4463 Writeok = write_mask;
4464 #ifdef SELECT_CANT_DO_WRITE_MASK
4465 check_write = 0;
4466 #else
4467 check_write = 1;
4468 #endif
4469 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4472 /* If frame size has changed or the window is newly mapped,
4473 redisplay now, before we start to wait. There is a race
4474 condition here; if a SIGIO arrives between now and the select
4475 and indicates that a frame is trashed, the select may block
4476 displaying a trashed screen. */
4477 if (frame_garbaged && do_display)
4479 clear_waiting_for_input ();
4480 redisplay_preserve_echo_area (11);
4481 if (read_kbd < 0)
4482 set_waiting_for_input (&timeout);
4485 /* Skip the `select' call if input is available and we're
4486 waiting for keyboard input or a cell change (which can be
4487 triggered by processing X events). In the latter case, set
4488 nfds to 1 to avoid breaking the loop. */
4489 no_avail = 0;
4490 if ((read_kbd || !NILP (wait_for_cell))
4491 && detect_input_pending ())
4493 nfds = read_kbd ? 0 : 1;
4494 no_avail = 1;
4497 if (!no_avail)
4500 #ifdef ADAPTIVE_READ_BUFFERING
4501 /* Set the timeout for adaptive read buffering if any
4502 process has non-zero read_output_skip and non-zero
4503 read_output_delay, and we are not reading output for a
4504 specific wait_channel. It is not executed if
4505 Vprocess_adaptive_read_buffering is nil. */
4506 if (process_output_skip && check_delay > 0)
4508 int nsecs = EMACS_NSECS (timeout);
4509 if (EMACS_SECS (timeout) > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4510 nsecs = READ_OUTPUT_DELAY_MAX;
4511 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4513 proc = chan_process[channel];
4514 if (NILP (proc))
4515 continue;
4516 /* Find minimum non-zero read_output_delay among the
4517 processes with non-zero read_output_skip. */
4518 if (XPROCESS (proc)->read_output_delay > 0)
4520 check_delay--;
4521 if (!XPROCESS (proc)->read_output_skip)
4522 continue;
4523 FD_CLR (channel, &Available);
4524 XPROCESS (proc)->read_output_skip = 0;
4525 if (XPROCESS (proc)->read_output_delay < nsecs)
4526 nsecs = XPROCESS (proc)->read_output_delay;
4529 timeout = make_emacs_time (0, nsecs);
4530 process_output_skip = 0;
4532 #endif
4534 #if defined (HAVE_NS)
4535 nfds = ns_select
4536 #elif defined (HAVE_GLIB)
4537 nfds = xg_select
4538 #else
4539 nfds = pselect
4540 #endif
4541 (max (max_process_desc, max_input_desc) + 1,
4542 &Available,
4543 (check_write ? &Writeok : (SELECT_TYPE *)0),
4544 NULL, &timeout, NULL);
4546 #ifdef HAVE_GNUTLS
4547 /* GnuTLS buffers data internally. In lowat mode it leaves
4548 some data in the TCP buffers so that select works, but
4549 with custom pull/push functions we need to check if some
4550 data is available in the buffers manually. */
4551 if (nfds == 0)
4553 if (! wait_proc)
4555 /* We're not waiting on a specific process, so loop
4556 through all the channels and check for data.
4557 This is a workaround needed for some versions of
4558 the gnutls library -- 2.12.14 has been confirmed
4559 to need it. See
4560 http://comments.gmane.org/gmane.emacs.devel/145074 */
4561 for (channel = 0; channel < MAXDESC; ++channel)
4562 if (! NILP (chan_process[channel]))
4564 struct Lisp_Process *p =
4565 XPROCESS (chan_process[channel]);
4566 if (p && p->gnutls_p && p->infd
4567 && ((emacs_gnutls_record_check_pending
4568 (p->gnutls_state))
4569 > 0))
4571 nfds++;
4572 FD_SET (p->infd, &Available);
4576 else
4578 /* Check this specific channel. */
4579 if (wait_proc->gnutls_p /* Check for valid process. */
4580 /* Do we have pending data? */
4581 && ((emacs_gnutls_record_check_pending
4582 (wait_proc->gnutls_state))
4583 > 0))
4585 nfds = 1;
4586 /* Set to Available. */
4587 FD_SET (wait_proc->infd, &Available);
4591 #endif
4594 xerrno = errno;
4596 /* Make C-g and alarm signals set flags again */
4597 clear_waiting_for_input ();
4599 /* If we woke up due to SIGWINCH, actually change size now. */
4600 do_pending_window_change (0);
4602 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4603 /* We waited the full specified time, so return now. */
4604 break;
4605 if (nfds < 0)
4607 if (xerrno == EINTR)
4608 no_avail = 1;
4609 else if (xerrno == EBADF)
4611 #ifdef AIX
4612 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
4613 the child's closure of the pts gives the parent a SIGHUP, and
4614 the ptc file descriptor is automatically closed,
4615 yielding EBADF here or at select() call above.
4616 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
4617 in m/ibmrt-aix.h), and here we just ignore the select error.
4618 Cleanup occurs c/o status_notify after SIGCHLD. */
4619 no_avail = 1; /* Cannot depend on values returned */
4620 #else
4621 emacs_abort ();
4622 #endif
4624 else
4625 error ("select error: %s", emacs_strerror (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 Fcons (outstream,
5125 Fcons (make_lisp_proc (p),
5126 Fcons (text, Qnil))),
5127 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5128 read_process_output_error_handler);
5130 /* If we saved the match data nonrecursively, restore it now. */
5131 restore_search_regs ();
5132 running_asynch_code = outer_running_asynch_code;
5134 /* Restore waiting_for_user_input_p as it was
5135 when we were called, in case the filter clobbered it. */
5136 waiting_for_user_input_p = waiting;
5138 #if 0 /* Call record_asynch_buffer_change unconditionally,
5139 because we might have changed minor modes or other things
5140 that affect key bindings. */
5141 if (! EQ (Fcurrent_buffer (), obuffer)
5142 || ! EQ (current_buffer->keymap, okeymap))
5143 #endif
5144 /* But do it only if the caller is actually going to read events.
5145 Otherwise there's no need to make him wake up, and it could
5146 cause trouble (for example it would make sit_for return). */
5147 if (waiting_for_user_input_p == -1)
5148 record_asynch_buffer_change ();
5151 DEFUN ("internal-default-process-filter", Finternal_default_process_filter,
5152 Sinternal_default_process_filter, 2, 2, 0,
5153 doc: /* Function used as default process filter. */)
5154 (Lisp_Object proc, Lisp_Object text)
5156 struct Lisp_Process *p;
5157 ptrdiff_t opoint;
5159 CHECK_PROCESS (proc);
5160 p = XPROCESS (proc);
5161 CHECK_STRING (text);
5163 if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5165 Lisp_Object old_read_only;
5166 ptrdiff_t old_begv, old_zv;
5167 ptrdiff_t old_begv_byte, old_zv_byte;
5168 ptrdiff_t before, before_byte;
5169 ptrdiff_t opoint_byte;
5170 struct buffer *b;
5172 Fset_buffer (p->buffer);
5173 opoint = PT;
5174 opoint_byte = PT_BYTE;
5175 old_read_only = BVAR (current_buffer, read_only);
5176 old_begv = BEGV;
5177 old_zv = ZV;
5178 old_begv_byte = BEGV_BYTE;
5179 old_zv_byte = ZV_BYTE;
5181 bset_read_only (current_buffer, Qnil);
5183 /* Insert new output into buffer
5184 at the current end-of-output marker,
5185 thus preserving logical ordering of input and output. */
5186 if (XMARKER (p->mark)->buffer)
5187 SET_PT_BOTH (clip_to_bounds (BEGV,
5188 marker_position (p->mark), ZV),
5189 clip_to_bounds (BEGV_BYTE,
5190 marker_byte_position (p->mark),
5191 ZV_BYTE));
5192 else
5193 SET_PT_BOTH (ZV, ZV_BYTE);
5194 before = PT;
5195 before_byte = PT_BYTE;
5197 /* If the output marker is outside of the visible region, save
5198 the restriction and widen. */
5199 if (! (BEGV <= PT && PT <= ZV))
5200 Fwiden ();
5202 /* Adjust the multibyteness of TEXT to that of the buffer. */
5203 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5204 != ! STRING_MULTIBYTE (text))
5205 text = (STRING_MULTIBYTE (text)
5206 ? Fstring_as_unibyte (text)
5207 : Fstring_to_multibyte (text));
5208 /* Insert before markers in case we are inserting where
5209 the buffer's mark is, and the user's next command is Meta-y. */
5210 insert_from_string_before_markers (text, 0, 0,
5211 SCHARS (text), SBYTES (text), 0);
5213 /* Make sure the process marker's position is valid when the
5214 process buffer is changed in the signal_after_change above.
5215 W3 is known to do that. */
5216 if (BUFFERP (p->buffer)
5217 && (b = XBUFFER (p->buffer), b != current_buffer))
5218 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5219 else
5220 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5222 update_mode_lines++;
5224 /* Make sure opoint and the old restrictions
5225 float ahead of any new text just as point would. */
5226 if (opoint >= before)
5228 opoint += PT - before;
5229 opoint_byte += PT_BYTE - before_byte;
5231 if (old_begv > before)
5233 old_begv += PT - before;
5234 old_begv_byte += PT_BYTE - before_byte;
5236 if (old_zv >= before)
5238 old_zv += PT - before;
5239 old_zv_byte += PT_BYTE - before_byte;
5242 /* If the restriction isn't what it should be, set it. */
5243 if (old_begv != BEGV || old_zv != ZV)
5244 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5246 bset_read_only (current_buffer, old_read_only);
5247 SET_PT_BOTH (opoint, opoint_byte);
5249 return Qnil;
5252 /* Sending data to subprocess. */
5254 /* In send_process, when a write fails temporarily,
5255 wait_reading_process_output is called. It may execute user code,
5256 e.g. timers, that attempts to write new data to the same process.
5257 We must ensure that data is sent in the right order, and not
5258 interspersed half-completed with other writes (Bug#10815). This is
5259 handled by the write_queue element of struct process. It is a list
5260 with each entry having the form
5262 (string . (offset . length))
5264 where STRING is a lisp string, OFFSET is the offset into the
5265 string's byte sequence from which we should begin to send, and
5266 LENGTH is the number of bytes left to send. */
5268 /* Create a new entry in write_queue.
5269 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5270 BUF is a pointer to the string sequence of the input_obj or a C
5271 string in case of Qt or Qnil. */
5273 static void
5274 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5275 const char *buf, ptrdiff_t len, bool front)
5277 ptrdiff_t offset;
5278 Lisp_Object entry, obj;
5280 if (STRINGP (input_obj))
5282 offset = buf - SSDATA (input_obj);
5283 obj = input_obj;
5285 else
5287 offset = 0;
5288 obj = make_unibyte_string (buf, len);
5291 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5293 if (front)
5294 pset_write_queue (p, Fcons (entry, p->write_queue));
5295 else
5296 pset_write_queue (p, nconc2 (p->write_queue, Fcons (entry, Qnil)));
5299 /* Remove the first element in the write_queue of process P, put its
5300 contents in OBJ, BUF and LEN, and return true. If the
5301 write_queue is empty, return false. */
5303 static bool
5304 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5305 const char **buf, ptrdiff_t *len)
5307 Lisp_Object entry, offset_length;
5308 ptrdiff_t offset;
5310 if (NILP (p->write_queue))
5311 return 0;
5313 entry = XCAR (p->write_queue);
5314 pset_write_queue (p, XCDR (p->write_queue));
5316 *obj = XCAR (entry);
5317 offset_length = XCDR (entry);
5319 *len = XINT (XCDR (offset_length));
5320 offset = XINT (XCAR (offset_length));
5321 *buf = SSDATA (*obj) + offset;
5323 return 1;
5326 /* Send some data to process PROC.
5327 BUF is the beginning of the data; LEN is the number of characters.
5328 OBJECT is the Lisp object that the data comes from. If OBJECT is
5329 nil or t, it means that the data comes from C string.
5331 If OBJECT is not nil, the data is encoded by PROC's coding-system
5332 for encoding before it is sent.
5334 This function can evaluate Lisp code and can garbage collect. */
5336 static void
5337 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
5338 Lisp_Object object)
5340 struct Lisp_Process *p = XPROCESS (proc);
5341 ssize_t rv;
5342 struct coding_system *coding;
5344 if (p->raw_status_new)
5345 update_status (p);
5346 if (! EQ (p->status, Qrun))
5347 error ("Process %s not running", SDATA (p->name));
5348 if (p->outfd < 0)
5349 error ("Output file descriptor of %s is closed", SDATA (p->name));
5351 coding = proc_encode_coding_system[p->outfd];
5352 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5354 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5355 || (BUFFERP (object)
5356 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5357 || EQ (object, Qt))
5359 pset_encode_coding_system
5360 (p, complement_process_encoding_system (p->encode_coding_system));
5361 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5363 /* The coding system for encoding was changed to raw-text
5364 because we sent a unibyte text previously. Now we are
5365 sending a multibyte text, thus we must encode it by the
5366 original coding system specified for the current process.
5368 Another reason we come here is that the coding system
5369 was just complemented and a new one was returned by
5370 complement_process_encoding_system. */
5371 setup_coding_system (p->encode_coding_system, coding);
5372 Vlast_coding_system_used = p->encode_coding_system;
5374 coding->src_multibyte = 1;
5376 else
5378 coding->src_multibyte = 0;
5379 /* For sending a unibyte text, character code conversion should
5380 not take place but EOL conversion should. So, setup raw-text
5381 or one of the subsidiary if we have not yet done it. */
5382 if (CODING_REQUIRE_ENCODING (coding))
5384 if (CODING_REQUIRE_FLUSHING (coding))
5386 /* But, before changing the coding, we must flush out data. */
5387 coding->mode |= CODING_MODE_LAST_BLOCK;
5388 send_process (proc, "", 0, Qt);
5389 coding->mode &= CODING_MODE_LAST_BLOCK;
5391 setup_coding_system (raw_text_coding_system
5392 (Vlast_coding_system_used),
5393 coding);
5394 coding->src_multibyte = 0;
5397 coding->dst_multibyte = 0;
5399 if (CODING_REQUIRE_ENCODING (coding))
5401 coding->dst_object = Qt;
5402 if (BUFFERP (object))
5404 ptrdiff_t from_byte, from, to;
5405 ptrdiff_t save_pt, save_pt_byte;
5406 struct buffer *cur = current_buffer;
5408 set_buffer_internal (XBUFFER (object));
5409 save_pt = PT, save_pt_byte = PT_BYTE;
5411 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5412 from = BYTE_TO_CHAR (from_byte);
5413 to = BYTE_TO_CHAR (from_byte + len);
5414 TEMP_SET_PT_BOTH (from, from_byte);
5415 encode_coding_object (coding, object, from, from_byte,
5416 to, from_byte + len, Qt);
5417 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5418 set_buffer_internal (cur);
5420 else if (STRINGP (object))
5422 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5423 SBYTES (object), Qt);
5425 else
5427 coding->dst_object = make_unibyte_string (buf, len);
5428 coding->produced = len;
5431 len = coding->produced;
5432 object = coding->dst_object;
5433 buf = SSDATA (object);
5436 /* If there is already data in the write_queue, put the new data
5437 in the back of queue. Otherwise, ignore it. */
5438 if (!NILP (p->write_queue))
5439 write_queue_push (p, object, buf, len, 0);
5441 do /* while !NILP (p->write_queue) */
5443 ptrdiff_t cur_len = -1;
5444 const char *cur_buf;
5445 Lisp_Object cur_object;
5447 /* If write_queue is empty, ignore it. */
5448 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5450 cur_len = len;
5451 cur_buf = buf;
5452 cur_object = object;
5455 while (cur_len > 0)
5457 /* Send this batch, using one or more write calls. */
5458 ptrdiff_t written = 0;
5459 int outfd = p->outfd;
5460 #ifdef DATAGRAM_SOCKETS
5461 if (DATAGRAM_CHAN_P (outfd))
5463 rv = sendto (outfd, cur_buf, cur_len,
5464 0, datagram_address[outfd].sa,
5465 datagram_address[outfd].len);
5466 if (rv >= 0)
5467 written = rv;
5468 else if (errno == EMSGSIZE)
5469 report_file_error ("sending datagram", Fcons (proc, Qnil));
5471 else
5472 #endif
5474 #ifdef HAVE_GNUTLS
5475 if (p->gnutls_p)
5476 written = emacs_gnutls_write (p, cur_buf, cur_len);
5477 else
5478 #endif
5479 written = emacs_write (outfd, cur_buf, cur_len);
5480 rv = (written ? 0 : -1);
5481 #ifdef ADAPTIVE_READ_BUFFERING
5482 if (p->read_output_delay > 0
5483 && p->adaptive_read_buffering == 1)
5485 p->read_output_delay = 0;
5486 process_output_delay_count--;
5487 p->read_output_skip = 0;
5489 #endif
5492 if (rv < 0)
5494 if (errno == EAGAIN
5495 #ifdef EWOULDBLOCK
5496 || errno == EWOULDBLOCK
5497 #endif
5499 /* Buffer is full. Wait, accepting input;
5500 that may allow the program
5501 to finish doing output and read more. */
5503 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5504 /* A gross hack to work around a bug in FreeBSD.
5505 In the following sequence, read(2) returns
5506 bogus data:
5508 write(2) 1022 bytes
5509 write(2) 954 bytes, get EAGAIN
5510 read(2) 1024 bytes in process_read_output
5511 read(2) 11 bytes in process_read_output
5513 That is, read(2) returns more bytes than have
5514 ever been written successfully. The 1033 bytes
5515 read are the 1022 bytes written successfully
5516 after processing (for example with CRs added if
5517 the terminal is set up that way which it is
5518 here). The same bytes will be seen again in a
5519 later read(2), without the CRs. */
5521 if (errno == EAGAIN)
5523 int flags = FWRITE;
5524 ioctl (p->outfd, TIOCFLUSH, &flags);
5526 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5528 /* Put what we should have written in wait_queue. */
5529 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5530 wait_reading_process_output (0, 20 * 1000 * 1000,
5531 0, 0, Qnil, NULL, 0);
5532 /* Reread queue, to see what is left. */
5533 break;
5535 else if (errno == EPIPE)
5537 p->raw_status_new = 0;
5538 pset_status (p, list2 (Qexit, make_number (256)));
5539 p->tick = ++process_tick;
5540 deactivate_process (proc);
5541 error ("process %s no longer connected to pipe; closed it",
5542 SDATA (p->name));
5544 else
5545 /* This is a real error. */
5546 report_file_error ("writing to process", Fcons (proc, Qnil));
5548 cur_buf += written;
5549 cur_len -= written;
5552 while (!NILP (p->write_queue));
5555 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5556 3, 3, 0,
5557 doc: /* Send current contents of region as input to PROCESS.
5558 PROCESS may be a process, a buffer, the name of a process or buffer, or
5559 nil, indicating the current buffer's process.
5560 Called from program, takes three arguments, PROCESS, START and END.
5561 If the region is more than 500 characters long,
5562 it is sent in several bunches. This may happen even for shorter regions.
5563 Output from processes can arrive in between bunches. */)
5564 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5566 Lisp_Object proc = get_process (process);
5567 ptrdiff_t start_byte, end_byte;
5569 validate_region (&start, &end);
5571 start_byte = CHAR_TO_BYTE (XINT (start));
5572 end_byte = CHAR_TO_BYTE (XINT (end));
5574 if (XINT (start) < GPT && XINT (end) > GPT)
5575 move_gap_both (XINT (start), start_byte);
5577 send_process (proc, (char *) BYTE_POS_ADDR (start_byte),
5578 end_byte - start_byte, Fcurrent_buffer ());
5580 return Qnil;
5583 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5584 2, 2, 0,
5585 doc: /* Send PROCESS the contents of STRING as input.
5586 PROCESS may be a process, a buffer, the name of a process or buffer, or
5587 nil, indicating the current buffer's process.
5588 If STRING is more than 500 characters long,
5589 it is sent in several bunches. This may happen even for shorter strings.
5590 Output from processes can arrive in between bunches. */)
5591 (Lisp_Object process, Lisp_Object string)
5593 Lisp_Object proc;
5594 CHECK_STRING (string);
5595 proc = get_process (process);
5596 send_process (proc, SSDATA (string),
5597 SBYTES (string), string);
5598 return Qnil;
5601 /* Return the foreground process group for the tty/pty that
5602 the process P uses. */
5603 static pid_t
5604 emacs_get_tty_pgrp (struct Lisp_Process *p)
5606 pid_t gid = -1;
5608 #ifdef TIOCGPGRP
5609 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5611 int fd;
5612 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5613 master side. Try the slave side. */
5614 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5616 if (fd != -1)
5618 ioctl (fd, TIOCGPGRP, &gid);
5619 emacs_close (fd);
5622 #endif /* defined (TIOCGPGRP ) */
5624 return gid;
5627 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5628 Sprocess_running_child_p, 0, 1, 0,
5629 doc: /* Return t if PROCESS has given the terminal to a child.
5630 If the operating system does not make it possible to find out,
5631 return t unconditionally. */)
5632 (Lisp_Object process)
5634 /* Initialize in case ioctl doesn't exist or gives an error,
5635 in a way that will cause returning t. */
5636 pid_t gid;
5637 Lisp_Object proc;
5638 struct Lisp_Process *p;
5640 proc = get_process (process);
5641 p = XPROCESS (proc);
5643 if (!EQ (p->type, Qreal))
5644 error ("Process %s is not a subprocess",
5645 SDATA (p->name));
5646 if (p->infd < 0)
5647 error ("Process %s is not active",
5648 SDATA (p->name));
5650 gid = emacs_get_tty_pgrp (p);
5652 if (gid == p->pid)
5653 return Qnil;
5654 return Qt;
5657 /* send a signal number SIGNO to PROCESS.
5658 If CURRENT_GROUP is t, that means send to the process group
5659 that currently owns the terminal being used to communicate with PROCESS.
5660 This is used for various commands in shell mode.
5661 If CURRENT_GROUP is lambda, that means send to the process group
5662 that currently owns the terminal, but only if it is NOT the shell itself.
5664 If NOMSG is false, insert signal-announcements into process's buffers
5665 right away.
5667 If we can, we try to signal PROCESS by sending control characters
5668 down the pty. This allows us to signal inferiors who have changed
5669 their uid, for which kill would return an EPERM error. */
5671 static void
5672 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5673 bool nomsg)
5675 Lisp_Object proc;
5676 struct Lisp_Process *p;
5677 pid_t gid;
5678 bool no_pgrp = 0;
5680 proc = get_process (process);
5681 p = XPROCESS (proc);
5683 if (!EQ (p->type, Qreal))
5684 error ("Process %s is not a subprocess",
5685 SDATA (p->name));
5686 if (p->infd < 0)
5687 error ("Process %s is not active",
5688 SDATA (p->name));
5690 if (!p->pty_flag)
5691 current_group = Qnil;
5693 /* If we are using pgrps, get a pgrp number and make it negative. */
5694 if (NILP (current_group))
5695 /* Send the signal to the shell's process group. */
5696 gid = p->pid;
5697 else
5699 #ifdef SIGNALS_VIA_CHARACTERS
5700 /* If possible, send signals to the entire pgrp
5701 by sending an input character to it. */
5703 struct termios t;
5704 cc_t *sig_char = NULL;
5706 tcgetattr (p->infd, &t);
5708 switch (signo)
5710 case SIGINT:
5711 sig_char = &t.c_cc[VINTR];
5712 break;
5714 case SIGQUIT:
5715 sig_char = &t.c_cc[VQUIT];
5716 break;
5718 case SIGTSTP:
5719 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5720 sig_char = &t.c_cc[VSWTCH];
5721 #else
5722 sig_char = &t.c_cc[VSUSP];
5723 #endif
5724 break;
5727 if (sig_char && *sig_char != CDISABLE)
5729 send_process (proc, (char *) sig_char, 1, Qnil);
5730 return;
5732 /* If we can't send the signal with a character,
5733 fall through and send it another way. */
5735 /* The code above may fall through if it can't
5736 handle the signal. */
5737 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5739 #ifdef TIOCGPGRP
5740 /* Get the current pgrp using the tty itself, if we have that.
5741 Otherwise, use the pty to get the pgrp.
5742 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5743 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5744 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5745 His patch indicates that if TIOCGPGRP returns an error, then
5746 we should just assume that p->pid is also the process group id. */
5748 gid = emacs_get_tty_pgrp (p);
5750 if (gid == -1)
5751 /* If we can't get the information, assume
5752 the shell owns the tty. */
5753 gid = p->pid;
5755 /* It is not clear whether anything really can set GID to -1.
5756 Perhaps on some system one of those ioctls can or could do so.
5757 Or perhaps this is vestigial. */
5758 if (gid == -1)
5759 no_pgrp = 1;
5760 #else /* ! defined (TIOCGPGRP ) */
5761 /* Can't select pgrps on this system, so we know that
5762 the child itself heads the pgrp. */
5763 gid = p->pid;
5764 #endif /* ! defined (TIOCGPGRP ) */
5766 /* If current_group is lambda, and the shell owns the terminal,
5767 don't send any signal. */
5768 if (EQ (current_group, Qlambda) && gid == p->pid)
5769 return;
5772 switch (signo)
5774 #ifdef SIGCONT
5775 case SIGCONT:
5776 p->raw_status_new = 0;
5777 pset_status (p, Qrun);
5778 p->tick = ++process_tick;
5779 if (!nomsg)
5781 status_notify (NULL);
5782 redisplay_preserve_echo_area (13);
5784 break;
5785 #endif /* ! defined (SIGCONT) */
5786 case SIGINT:
5787 case SIGQUIT:
5788 case SIGKILL:
5789 flush_pending_output (p->infd);
5790 break;
5793 /* If we don't have process groups, send the signal to the immediate
5794 subprocess. That isn't really right, but it's better than any
5795 obvious alternative. */
5796 if (no_pgrp)
5798 kill (p->pid, signo);
5799 return;
5802 /* gid may be a pid, or minus a pgrp's number */
5803 #ifdef TIOCSIGSEND
5804 if (!NILP (current_group))
5806 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5807 kill (-gid, signo);
5809 else
5811 gid = - p->pid;
5812 kill (gid, signo);
5814 #else /* ! defined (TIOCSIGSEND) */
5815 kill (-gid, signo);
5816 #endif /* ! defined (TIOCSIGSEND) */
5819 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5820 doc: /* Interrupt process PROCESS.
5821 PROCESS may be a process, a buffer, or the name of a process or buffer.
5822 No arg or nil means current buffer's process.
5823 Second arg CURRENT-GROUP non-nil means send signal to
5824 the current process-group of the process's controlling terminal
5825 rather than to the process's own process group.
5826 If the process is a shell, this means interrupt current subjob
5827 rather than the shell.
5829 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5830 don't send the signal. */)
5831 (Lisp_Object process, Lisp_Object current_group)
5833 process_send_signal (process, SIGINT, current_group, 0);
5834 return process;
5837 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5838 doc: /* Kill process PROCESS. May be process or name of one.
5839 See function `interrupt-process' for more details on usage. */)
5840 (Lisp_Object process, Lisp_Object current_group)
5842 process_send_signal (process, SIGKILL, current_group, 0);
5843 return process;
5846 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5847 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5848 See function `interrupt-process' for more details on usage. */)
5849 (Lisp_Object process, Lisp_Object current_group)
5851 process_send_signal (process, SIGQUIT, current_group, 0);
5852 return process;
5855 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
5856 doc: /* Stop process PROCESS. May be process or name of one.
5857 See function `interrupt-process' for more details on usage.
5858 If PROCESS is a network or serial process, inhibit handling of incoming
5859 traffic. */)
5860 (Lisp_Object process, Lisp_Object current_group)
5862 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5864 struct Lisp_Process *p;
5866 p = XPROCESS (process);
5867 if (NILP (p->command)
5868 && p->infd >= 0)
5870 FD_CLR (p->infd, &input_wait_mask);
5871 FD_CLR (p->infd, &non_keyboard_wait_mask);
5873 pset_command (p, Qt);
5874 return process;
5876 #ifndef SIGTSTP
5877 error ("No SIGTSTP support");
5878 #else
5879 process_send_signal (process, SIGTSTP, current_group, 0);
5880 #endif
5881 return process;
5884 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
5885 doc: /* Continue process PROCESS. May be process or name of one.
5886 See function `interrupt-process' for more details on usage.
5887 If PROCESS is a network or serial process, resume handling of incoming
5888 traffic. */)
5889 (Lisp_Object process, Lisp_Object current_group)
5891 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5893 struct Lisp_Process *p;
5895 p = XPROCESS (process);
5896 if (EQ (p->command, Qt)
5897 && p->infd >= 0
5898 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
5900 FD_SET (p->infd, &input_wait_mask);
5901 FD_SET (p->infd, &non_keyboard_wait_mask);
5902 #ifdef WINDOWSNT
5903 if (fd_info[ p->infd ].flags & FILE_SERIAL)
5904 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
5905 #else /* not WINDOWSNT */
5906 tcflush (p->infd, TCIFLUSH);
5907 #endif /* not WINDOWSNT */
5909 pset_command (p, Qnil);
5910 return process;
5912 #ifdef SIGCONT
5913 process_send_signal (process, SIGCONT, current_group, 0);
5914 #else
5915 error ("No SIGCONT support");
5916 #endif
5917 return process;
5920 /* Return the integer value of the signal whose abbreviation is ABBR,
5921 or a negative number if there is no such signal. */
5922 static int
5923 abbr_to_signal (char const *name)
5925 int i, signo;
5926 char sigbuf[20]; /* Large enough for all valid signal abbreviations. */
5928 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
5929 name += 3;
5931 for (i = 0; i < sizeof sigbuf; i++)
5933 sigbuf[i] = c_toupper (name[i]);
5934 if (! sigbuf[i])
5935 return str2sig (sigbuf, &signo) == 0 ? signo : -1;
5938 return -1;
5941 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
5942 2, 2, "sProcess (name or number): \nnSignal code: ",
5943 doc: /* Send PROCESS the signal with code SIGCODE.
5944 PROCESS may also be a number specifying the process id of the
5945 process to signal; in this case, the process need not be a child of
5946 this Emacs.
5947 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
5948 (Lisp_Object process, Lisp_Object sigcode)
5950 pid_t pid;
5951 int signo;
5953 if (STRINGP (process))
5955 Lisp_Object tem = Fget_process (process);
5956 if (NILP (tem))
5958 Lisp_Object process_number =
5959 string_to_number (SSDATA (process), 10, 1);
5960 if (INTEGERP (process_number) || FLOATP (process_number))
5961 tem = process_number;
5963 process = tem;
5965 else if (!NUMBERP (process))
5966 process = get_process (process);
5968 if (NILP (process))
5969 return process;
5971 if (NUMBERP (process))
5972 CONS_TO_INTEGER (process, pid_t, pid);
5973 else
5975 CHECK_PROCESS (process);
5976 pid = XPROCESS (process)->pid;
5977 if (pid <= 0)
5978 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
5981 if (INTEGERP (sigcode))
5983 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
5984 signo = XINT (sigcode);
5986 else
5988 char *name;
5990 CHECK_SYMBOL (sigcode);
5991 name = SSDATA (SYMBOL_NAME (sigcode));
5993 signo = abbr_to_signal (name);
5994 if (signo < 0)
5995 error ("Undefined signal name %s", name);
5998 return make_number (kill (pid, signo));
6001 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6002 doc: /* Make PROCESS see end-of-file in its input.
6003 EOF comes after any text already sent to it.
6004 PROCESS may be a process, a buffer, the name of a process or buffer, or
6005 nil, indicating the current buffer's process.
6006 If PROCESS is a network connection, or is a process communicating
6007 through a pipe (as opposed to a pty), then you cannot send any more
6008 text to PROCESS after you call this function.
6009 If PROCESS is a serial process, wait until all output written to the
6010 process has been transmitted to the serial port. */)
6011 (Lisp_Object process)
6013 Lisp_Object proc;
6014 struct coding_system *coding;
6016 if (DATAGRAM_CONN_P (process))
6017 return process;
6019 proc = get_process (process);
6020 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6022 /* Make sure the process is really alive. */
6023 if (XPROCESS (proc)->raw_status_new)
6024 update_status (XPROCESS (proc));
6025 if (! EQ (XPROCESS (proc)->status, Qrun))
6026 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6028 if (CODING_REQUIRE_FLUSHING (coding))
6030 coding->mode |= CODING_MODE_LAST_BLOCK;
6031 send_process (proc, "", 0, Qnil);
6034 if (XPROCESS (proc)->pty_flag)
6035 send_process (proc, "\004", 1, Qnil);
6036 else if (EQ (XPROCESS (proc)->type, Qserial))
6038 #ifndef WINDOWSNT
6039 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6040 error ("tcdrain() failed: %s", emacs_strerror (errno));
6041 #endif /* not WINDOWSNT */
6042 /* Do nothing on Windows because writes are blocking. */
6044 else
6046 int old_outfd, new_outfd;
6048 #ifdef HAVE_SHUTDOWN
6049 /* If this is a network connection, or socketpair is used
6050 for communication with the subprocess, call shutdown to cause EOF.
6051 (In some old system, shutdown to socketpair doesn't work.
6052 Then we just can't win.) */
6053 if (EQ (XPROCESS (proc)->type, Qnetwork)
6054 || XPROCESS (proc)->outfd == XPROCESS (proc)->infd)
6055 shutdown (XPROCESS (proc)->outfd, 1);
6056 /* In case of socketpair, outfd == infd, so don't close it. */
6057 if (XPROCESS (proc)->outfd != XPROCESS (proc)->infd)
6058 emacs_close (XPROCESS (proc)->outfd);
6059 #else /* not HAVE_SHUTDOWN */
6060 emacs_close (XPROCESS (proc)->outfd);
6061 #endif /* not HAVE_SHUTDOWN */
6062 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6063 if (new_outfd < 0)
6064 emacs_abort ();
6065 old_outfd = XPROCESS (proc)->outfd;
6067 if (!proc_encode_coding_system[new_outfd])
6068 proc_encode_coding_system[new_outfd]
6069 = xmalloc (sizeof (struct coding_system));
6070 *proc_encode_coding_system[new_outfd]
6071 = *proc_encode_coding_system[old_outfd];
6072 memset (proc_encode_coding_system[old_outfd], 0,
6073 sizeof (struct coding_system));
6075 XPROCESS (proc)->outfd = new_outfd;
6077 return process;
6080 /* The main Emacs thread records child processes in three places:
6082 - Vprocess_alist, for asynchronous subprocesses, which are child
6083 processes visible to Lisp.
6085 - deleted_pid_list, for child processes invisible to Lisp,
6086 typically because of delete-process. These are recorded so that
6087 the processes can be reaped when they exit, so that the operating
6088 system's process table is not cluttered by zombies.
6090 - the local variable PID in Fcall_process, call_process_cleanup and
6091 call_process_kill, for synchronous subprocesses.
6092 record_unwind_protect is used to make sure this process is not
6093 forgotten: if the user interrupts call-process and the child
6094 process refuses to exit immediately even with two C-g's,
6095 call_process_kill adds PID's contents to deleted_pid_list before
6096 returning.
6098 The main Emacs thread invokes waitpid only on child processes that
6099 it creates and that have not been reaped. This avoid races on
6100 platforms such as GTK, where other threads create their own
6101 subprocesses which the main thread should not reap. For example,
6102 if the main thread attempted to reap an already-reaped child, it
6103 might inadvertently reap a GTK-created process that happened to
6104 have the same process ID. */
6106 /* LIB_CHILD_HANDLER is a SIGCHLD handler that Emacs calls while doing
6107 its own SIGCHLD handling. On POSIXish systems, glib needs this to
6108 keep track of its own children. The default handler does nothing. */
6109 static void dummy_handler (int sig) {}
6110 static signal_handler_t volatile lib_child_handler = dummy_handler;
6112 /* Handle a SIGCHLD signal by looking for known child processes of
6113 Emacs whose status have changed. For each one found, record its
6114 new status.
6116 All we do is change the status; we do not run sentinels or print
6117 notifications. That is saved for the next time keyboard input is
6118 done, in order to avoid timing errors.
6120 ** WARNING: this can be called during garbage collection.
6121 Therefore, it must not be fooled by the presence of mark bits in
6122 Lisp objects.
6124 ** USG WARNING: Although it is not obvious from the documentation
6125 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6126 signal() before executing at least one wait(), otherwise the
6127 handler will be called again, resulting in an infinite loop. The
6128 relevant portion of the documentation reads "SIGCLD signals will be
6129 queued and the signal-catching function will be continually
6130 reentered until the queue is empty". Invoking signal() causes the
6131 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6132 Inc.
6134 ** Malloc WARNING: This should never call malloc either directly or
6135 indirectly; if it does, that is a bug */
6137 static void
6138 handle_child_signal (int sig)
6140 Lisp_Object tail;
6142 /* Find the process that signaled us, and record its status. */
6144 /* The process can have been deleted by Fdelete_process, or have
6145 been started asynchronously by Fcall_process. */
6146 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6148 bool all_pids_are_fixnums
6149 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
6150 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
6151 Lisp_Object xpid = XCAR (tail);
6152 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
6154 pid_t deleted_pid;
6155 if (INTEGERP (xpid))
6156 deleted_pid = XINT (xpid);
6157 else
6158 deleted_pid = XFLOAT_DATA (xpid);
6159 if (child_status_changed (deleted_pid, 0, 0))
6160 XSETCAR (tail, Qnil);
6164 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6165 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6167 Lisp_Object proc = XCDR (XCAR (tail));
6168 struct Lisp_Process *p = XPROCESS (proc);
6169 int status;
6171 if (p->alive
6172 && child_status_changed (p->pid, &status, WUNTRACED | WCONTINUED))
6174 /* Change the status of the process that was found. */
6175 p->tick = ++process_tick;
6176 p->raw_status = status;
6177 p->raw_status_new = 1;
6179 /* If process has terminated, stop waiting for its output. */
6180 if (WIFSIGNALED (status) || WIFEXITED (status))
6182 bool clear_desc_flag = 0;
6183 p->alive = 0;
6184 if (p->infd >= 0)
6185 clear_desc_flag = 1;
6187 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
6188 if (clear_desc_flag)
6190 FD_CLR (p->infd, &input_wait_mask);
6191 FD_CLR (p->infd, &non_keyboard_wait_mask);
6197 lib_child_handler (sig);
6200 static void
6201 deliver_child_signal (int sig)
6203 deliver_process_signal (sig, handle_child_signal);
6207 static Lisp_Object
6208 exec_sentinel_error_handler (Lisp_Object error_val)
6210 cmd_error_internal (error_val, "error in process sentinel: ");
6211 Vinhibit_quit = Qt;
6212 update_echo_area ();
6213 Fsleep_for (make_number (2), Qnil);
6214 return Qt;
6217 static void
6218 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6220 Lisp_Object sentinel, odeactivate;
6221 struct Lisp_Process *p = XPROCESS (proc);
6222 ptrdiff_t count = SPECPDL_INDEX ();
6223 bool outer_running_asynch_code = running_asynch_code;
6224 int waiting = waiting_for_user_input_p;
6226 if (inhibit_sentinels)
6227 return;
6229 /* No need to gcpro these, because all we do with them later
6230 is test them for EQness, and none of them should be a string. */
6231 odeactivate = Vdeactivate_mark;
6232 #if 0
6233 Lisp_Object obuffer, okeymap;
6234 XSETBUFFER (obuffer, current_buffer);
6235 okeymap = BVAR (current_buffer, keymap);
6236 #endif
6238 /* There's no good reason to let sentinels change the current
6239 buffer, and many callers of accept-process-output, sit-for, and
6240 friends don't expect current-buffer to be changed from under them. */
6241 record_unwind_current_buffer ();
6243 sentinel = p->sentinel;
6245 /* Inhibit quit so that random quits don't screw up a running filter. */
6246 specbind (Qinhibit_quit, Qt);
6247 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6249 /* In case we get recursively called,
6250 and we already saved the match data nonrecursively,
6251 save the same match data in safely recursive fashion. */
6252 if (outer_running_asynch_code)
6254 Lisp_Object tem;
6255 tem = Fmatch_data (Qnil, Qnil, Qnil);
6256 restore_search_regs ();
6257 record_unwind_save_match_data ();
6258 Fset_match_data (tem, Qt);
6261 /* For speed, if a search happens within this code,
6262 save the match data in a special nonrecursive fashion. */
6263 running_asynch_code = 1;
6265 internal_condition_case_1 (read_process_output_call,
6266 Fcons (sentinel,
6267 Fcons (proc, Fcons (reason, Qnil))),
6268 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6269 exec_sentinel_error_handler);
6271 /* If we saved the match data nonrecursively, restore it now. */
6272 restore_search_regs ();
6273 running_asynch_code = outer_running_asynch_code;
6275 Vdeactivate_mark = odeactivate;
6277 /* Restore waiting_for_user_input_p as it was
6278 when we were called, in case the filter clobbered it. */
6279 waiting_for_user_input_p = waiting;
6281 #if 0
6282 if (! EQ (Fcurrent_buffer (), obuffer)
6283 || ! EQ (current_buffer->keymap, okeymap))
6284 #endif
6285 /* But do it only if the caller is actually going to read events.
6286 Otherwise there's no need to make him wake up, and it could
6287 cause trouble (for example it would make sit_for return). */
6288 if (waiting_for_user_input_p == -1)
6289 record_asynch_buffer_change ();
6291 unbind_to (count, Qnil);
6294 /* Report all recent events of a change in process status
6295 (either run the sentinel or output a message).
6296 This is usually done while Emacs is waiting for keyboard input
6297 but can be done at other times. */
6299 static void
6300 status_notify (struct Lisp_Process *deleting_process)
6302 register Lisp_Object proc;
6303 Lisp_Object tail, msg;
6304 struct gcpro gcpro1, gcpro2;
6306 tail = Qnil;
6307 msg = Qnil;
6308 /* We need to gcpro tail; if read_process_output calls a filter
6309 which deletes a process and removes the cons to which tail points
6310 from Vprocess_alist, and then causes a GC, tail is an unprotected
6311 reference. */
6312 GCPRO2 (tail, msg);
6314 /* Set this now, so that if new processes are created by sentinels
6315 that we run, we get called again to handle their status changes. */
6316 update_tick = process_tick;
6318 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6320 Lisp_Object symbol;
6321 register struct Lisp_Process *p;
6323 proc = Fcdr (XCAR (tail));
6324 p = XPROCESS (proc);
6326 if (p->tick != p->update_tick)
6328 p->update_tick = p->tick;
6330 /* If process is still active, read any output that remains. */
6331 while (! EQ (p->filter, Qt)
6332 && ! EQ (p->status, Qconnect)
6333 && ! EQ (p->status, Qlisten)
6334 /* Network or serial process not stopped: */
6335 && ! EQ (p->command, Qt)
6336 && p->infd >= 0
6337 && p != deleting_process
6338 && read_process_output (proc, p->infd) > 0);
6340 /* Get the text to use for the message. */
6341 if (p->raw_status_new)
6342 update_status (p);
6343 msg = status_message (p);
6345 /* If process is terminated, deactivate it or delete it. */
6346 symbol = p->status;
6347 if (CONSP (p->status))
6348 symbol = XCAR (p->status);
6350 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6351 || EQ (symbol, Qclosed))
6353 if (delete_exited_processes)
6354 remove_process (proc);
6355 else
6356 deactivate_process (proc);
6359 /* The actions above may have further incremented p->tick.
6360 So set p->update_tick again so that an error in the sentinel will
6361 not cause this code to be run again. */
6362 p->update_tick = p->tick;
6363 /* Now output the message suitably. */
6364 exec_sentinel (proc, msg);
6366 } /* end for */
6368 update_mode_lines++; /* In case buffers use %s in mode-line-format. */
6369 UNGCPRO;
6372 DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel,
6373 Sinternal_default_process_sentinel, 2, 2, 0,
6374 doc: /* Function used as default sentinel for processes. */)
6375 (Lisp_Object proc, Lisp_Object msg)
6377 Lisp_Object buffer, symbol;
6378 struct Lisp_Process *p;
6379 CHECK_PROCESS (proc);
6380 p = XPROCESS (proc);
6381 buffer = p->buffer;
6382 symbol = p->status;
6383 if (CONSP (symbol))
6384 symbol = XCAR (symbol);
6386 if (!EQ (symbol, Qrun) && !NILP (buffer))
6388 Lisp_Object tem;
6389 struct buffer *old = current_buffer;
6390 ptrdiff_t opoint, opoint_byte;
6391 ptrdiff_t before, before_byte;
6393 /* Avoid error if buffer is deleted
6394 (probably that's why the process is dead, too). */
6395 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
6396 return Qnil;
6397 Fset_buffer (buffer);
6399 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
6400 msg = (code_convert_string_norecord
6401 (msg, Vlocale_coding_system, 1));
6403 opoint = PT;
6404 opoint_byte = PT_BYTE;
6405 /* Insert new output into buffer
6406 at the current end-of-output marker,
6407 thus preserving logical ordering of input and output. */
6408 if (XMARKER (p->mark)->buffer)
6409 Fgoto_char (p->mark);
6410 else
6411 SET_PT_BOTH (ZV, ZV_BYTE);
6413 before = PT;
6414 before_byte = PT_BYTE;
6416 tem = BVAR (current_buffer, read_only);
6417 bset_read_only (current_buffer, Qnil);
6418 insert_string ("\nProcess ");
6419 { /* FIXME: temporary kludge. */
6420 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
6421 insert_string (" ");
6422 Finsert (1, &msg);
6423 bset_read_only (current_buffer, tem);
6424 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6426 if (opoint >= before)
6427 SET_PT_BOTH (opoint + (PT - before),
6428 opoint_byte + (PT_BYTE - before_byte));
6429 else
6430 SET_PT_BOTH (opoint, opoint_byte);
6432 set_buffer_internal (old);
6434 return Qnil;
6438 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6439 Sset_process_coding_system, 1, 3, 0,
6440 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6441 DECODING will be used to decode subprocess output and ENCODING to
6442 encode subprocess input. */)
6443 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6445 register struct Lisp_Process *p;
6447 CHECK_PROCESS (process);
6448 p = XPROCESS (process);
6449 if (p->infd < 0)
6450 error ("Input file descriptor of %s closed", SDATA (p->name));
6451 if (p->outfd < 0)
6452 error ("Output file descriptor of %s closed", SDATA (p->name));
6453 Fcheck_coding_system (decoding);
6454 Fcheck_coding_system (encoding);
6455 encoding = coding_inherit_eol_type (encoding, Qnil);
6456 pset_decode_coding_system (p, decoding);
6457 pset_encode_coding_system (p, encoding);
6458 setup_process_coding_systems (process);
6460 return Qnil;
6463 DEFUN ("process-coding-system",
6464 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6465 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6466 (register Lisp_Object process)
6468 CHECK_PROCESS (process);
6469 return Fcons (XPROCESS (process)->decode_coding_system,
6470 XPROCESS (process)->encode_coding_system);
6473 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6474 Sset_process_filter_multibyte, 2, 2, 0,
6475 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6476 If FLAG is non-nil, the filter is given multibyte strings.
6477 If FLAG is nil, the filter is given unibyte strings. In this case,
6478 all character code conversion except for end-of-line conversion is
6479 suppressed. */)
6480 (Lisp_Object process, Lisp_Object flag)
6482 register struct Lisp_Process *p;
6484 CHECK_PROCESS (process);
6485 p = XPROCESS (process);
6486 if (NILP (flag))
6487 pset_decode_coding_system
6488 (p, raw_text_coding_system (p->decode_coding_system));
6489 setup_process_coding_systems (process);
6491 return Qnil;
6494 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6495 Sprocess_filter_multibyte_p, 1, 1, 0,
6496 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6497 (Lisp_Object process)
6499 register struct Lisp_Process *p;
6500 struct coding_system *coding;
6502 CHECK_PROCESS (process);
6503 p = XPROCESS (process);
6504 coding = proc_decode_coding_system[p->infd];
6505 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6511 # ifdef HAVE_GPM
6513 void
6514 add_gpm_wait_descriptor (int desc)
6516 add_keyboard_wait_descriptor (desc);
6519 void
6520 delete_gpm_wait_descriptor (int desc)
6522 delete_keyboard_wait_descriptor (desc);
6525 # endif
6527 # ifdef USABLE_SIGIO
6529 /* Return true if *MASK has a bit set
6530 that corresponds to one of the keyboard input descriptors. */
6532 static bool
6533 keyboard_bit_set (fd_set *mask)
6535 int fd;
6537 for (fd = 0; fd <= max_input_desc; fd++)
6538 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6539 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6540 return 1;
6542 return 0;
6544 # endif
6546 #else /* not subprocesses */
6548 /* Defined on msdos.c. */
6549 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
6550 EMACS_TIME *, void *);
6552 /* Implementation of wait_reading_process_output, assuming that there
6553 are no subprocesses. Used only by the MS-DOS build.
6555 Wait for timeout to elapse and/or keyboard input to be available.
6557 TIME_LIMIT is:
6558 timeout in seconds
6559 If negative, gobble data immediately available but don't wait for any.
6561 NSECS is:
6562 an additional duration to wait, measured in nanoseconds
6563 If TIME_LIMIT is zero, then:
6564 If NSECS == 0, there is no limit.
6565 If NSECS > 0, the timeout consists of NSECS only.
6566 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6568 READ_KBD is:
6569 0 to ignore keyboard input, or
6570 1 to return when input is available, or
6571 -1 means caller will actually read the input, so don't throw to
6572 the quit handler.
6574 see full version for other parameters. We know that wait_proc will
6575 always be NULL, since `subprocesses' isn't defined.
6577 DO_DISPLAY means redisplay should be done to show subprocess
6578 output that arrives.
6580 Return true if we received input from any process. */
6582 bool
6583 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6584 bool do_display,
6585 Lisp_Object wait_for_cell,
6586 struct Lisp_Process *wait_proc, int just_wait_proc)
6588 register int nfds;
6589 EMACS_TIME end_time, timeout;
6591 if (time_limit < 0)
6593 time_limit = 0;
6594 nsecs = -1;
6596 else if (TYPE_MAXIMUM (time_t) < time_limit)
6597 time_limit = TYPE_MAXIMUM (time_t);
6599 /* What does time_limit really mean? */
6600 if (time_limit || nsecs > 0)
6602 timeout = make_emacs_time (time_limit, nsecs);
6603 end_time = add_emacs_time (current_emacs_time (), timeout);
6606 /* Turn off periodic alarms (in case they are in use)
6607 and then turn off any other atimers,
6608 because the select emulator uses alarms. */
6609 stop_polling ();
6610 turn_on_atimers (0);
6612 while (1)
6614 bool timeout_reduced_for_timers = 0;
6615 SELECT_TYPE waitchannels;
6616 int xerrno;
6618 /* If calling from keyboard input, do not quit
6619 since we want to return C-g as an input character.
6620 Otherwise, do pending quit if requested. */
6621 if (read_kbd >= 0)
6622 QUIT;
6624 /* Exit now if the cell we're waiting for became non-nil. */
6625 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6626 break;
6628 /* Compute time from now till when time limit is up. */
6629 /* Exit if already run out. */
6630 if (nsecs < 0)
6632 /* A negative timeout means
6633 gobble output available now
6634 but don't wait at all. */
6636 timeout = make_emacs_time (0, 0);
6638 else if (time_limit || nsecs > 0)
6640 EMACS_TIME now = current_emacs_time ();
6641 if (EMACS_TIME_LE (end_time, now))
6642 break;
6643 timeout = sub_emacs_time (end_time, now);
6645 else
6647 timeout = make_emacs_time (100000, 0);
6650 /* If our caller will not immediately handle keyboard events,
6651 run timer events directly.
6652 (Callers that will immediately read keyboard events
6653 call timer_delay on their own.) */
6654 if (NILP (wait_for_cell))
6656 EMACS_TIME timer_delay;
6660 unsigned old_timers_run = timers_run;
6661 timer_delay = timer_check ();
6662 if (timers_run != old_timers_run && do_display)
6663 /* We must retry, since a timer may have requeued itself
6664 and that could alter the time delay. */
6665 redisplay_preserve_echo_area (14);
6666 else
6667 break;
6669 while (!detect_input_pending ());
6671 /* If there is unread keyboard input, also return. */
6672 if (read_kbd != 0
6673 && requeued_events_pending_p ())
6674 break;
6676 if (EMACS_TIME_VALID_P (timer_delay) && nsecs >= 0)
6678 if (EMACS_TIME_LT (timer_delay, timeout))
6680 timeout = timer_delay;
6681 timeout_reduced_for_timers = 1;
6686 /* Cause C-g and alarm signals to take immediate action,
6687 and cause input available signals to zero out timeout. */
6688 if (read_kbd < 0)
6689 set_waiting_for_input (&timeout);
6691 /* If a frame has been newly mapped and needs updating,
6692 reprocess its display stuff. */
6693 if (frame_garbaged && do_display)
6695 clear_waiting_for_input ();
6696 redisplay_preserve_echo_area (15);
6697 if (read_kbd < 0)
6698 set_waiting_for_input (&timeout);
6701 /* Wait till there is something to do. */
6702 FD_ZERO (&waitchannels);
6703 if (read_kbd && detect_input_pending ())
6704 nfds = 0;
6705 else
6707 if (read_kbd || !NILP (wait_for_cell))
6708 FD_SET (0, &waitchannels);
6709 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6712 xerrno = errno;
6714 /* Make C-g and alarm signals set flags again */
6715 clear_waiting_for_input ();
6717 /* If we woke up due to SIGWINCH, actually change size now. */
6718 do_pending_window_change (0);
6720 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6721 /* We waited the full specified time, so return now. */
6722 break;
6724 if (nfds == -1)
6726 /* If the system call was interrupted, then go around the
6727 loop again. */
6728 if (xerrno == EINTR)
6729 FD_ZERO (&waitchannels);
6730 else
6731 error ("select error: %s", emacs_strerror (xerrno));
6734 /* Check for keyboard input */
6736 if (read_kbd
6737 && detect_input_pending_run_timers (do_display))
6739 swallow_events (do_display);
6740 if (detect_input_pending_run_timers (do_display))
6741 break;
6744 /* If there is unread keyboard input, also return. */
6745 if (read_kbd
6746 && requeued_events_pending_p ())
6747 break;
6749 /* If wait_for_cell. check for keyboard input
6750 but don't run any timers.
6751 ??? (It seems wrong to me to check for keyboard
6752 input at all when wait_for_cell, but the code
6753 has been this way since July 1994.
6754 Try changing this after version 19.31.) */
6755 if (! NILP (wait_for_cell)
6756 && detect_input_pending ())
6758 swallow_events (do_display);
6759 if (detect_input_pending ())
6760 break;
6763 /* Exit now if the cell we're waiting for became non-nil. */
6764 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6765 break;
6768 start_polling ();
6770 return 0;
6773 #endif /* not subprocesses */
6775 /* The following functions are needed even if async subprocesses are
6776 not supported. Some of them are no-op stubs in that case. */
6778 /* Add DESC to the set of keyboard input descriptors. */
6780 void
6781 add_keyboard_wait_descriptor (int desc)
6783 #ifdef subprocesses /* actually means "not MSDOS" */
6784 FD_SET (desc, &input_wait_mask);
6785 FD_SET (desc, &non_process_wait_mask);
6786 if (desc > max_input_desc)
6787 max_input_desc = desc;
6788 #endif
6791 /* From now on, do not expect DESC to give keyboard input. */
6793 void
6794 delete_keyboard_wait_descriptor (int desc)
6796 #ifdef subprocesses
6797 int fd;
6798 int lim = max_input_desc;
6800 FD_CLR (desc, &input_wait_mask);
6801 FD_CLR (desc, &non_process_wait_mask);
6803 if (desc == max_input_desc)
6804 for (fd = 0; fd < lim; fd++)
6805 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
6806 max_input_desc = fd;
6807 #endif
6810 /* Setup coding systems of PROCESS. */
6812 void
6813 setup_process_coding_systems (Lisp_Object process)
6815 #ifdef subprocesses
6816 struct Lisp_Process *p = XPROCESS (process);
6817 int inch = p->infd;
6818 int outch = p->outfd;
6819 Lisp_Object coding_system;
6821 if (inch < 0 || outch < 0)
6822 return;
6824 if (!proc_decode_coding_system[inch])
6825 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
6826 coding_system = p->decode_coding_system;
6827 if (EQ (p->filter, Qinternal_default_process_filter)
6828 && BUFFERP (p->buffer))
6830 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
6831 coding_system = raw_text_coding_system (coding_system);
6833 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
6835 if (!proc_encode_coding_system[outch])
6836 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
6837 setup_coding_system (p->encode_coding_system,
6838 proc_encode_coding_system[outch]);
6839 #endif
6842 /* Close all descriptors currently in use for communication
6843 with subprocess. This is used in a newly-forked subprocess
6844 to get rid of irrelevant descriptors. */
6846 void
6847 close_process_descs (void)
6849 #ifndef DOS_NT
6850 int i;
6851 for (i = 0; i < MAXDESC; i++)
6853 Lisp_Object process;
6854 process = chan_process[i];
6855 if (!NILP (process))
6857 int in = XPROCESS (process)->infd;
6858 int out = XPROCESS (process)->outfd;
6859 if (in >= 0)
6860 emacs_close (in);
6861 if (out >= 0 && in != out)
6862 emacs_close (out);
6865 #endif
6868 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
6869 doc: /* Return the (or a) process associated with BUFFER.
6870 BUFFER may be a buffer or the name of one. */)
6871 (register Lisp_Object buffer)
6873 #ifdef subprocesses
6874 register Lisp_Object buf, tail, proc;
6876 if (NILP (buffer)) return Qnil;
6877 buf = Fget_buffer (buffer);
6878 if (NILP (buf)) return Qnil;
6880 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6882 proc = Fcdr (XCAR (tail));
6883 if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
6884 return proc;
6886 #endif /* subprocesses */
6887 return Qnil;
6890 DEFUN ("process-inherit-coding-system-flag",
6891 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
6892 1, 1, 0,
6893 doc: /* Return the value of inherit-coding-system flag for PROCESS.
6894 If this flag is t, `buffer-file-coding-system' of the buffer
6895 associated with PROCESS will inherit the coding system used to decode
6896 the process output. */)
6897 (register Lisp_Object process)
6899 #ifdef subprocesses
6900 CHECK_PROCESS (process);
6901 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
6902 #else
6903 /* Ignore the argument and return the value of
6904 inherit-process-coding-system. */
6905 return inherit_process_coding_system ? Qt : Qnil;
6906 #endif
6909 /* Kill all processes associated with `buffer'.
6910 If `buffer' is nil, kill all processes */
6912 void
6913 kill_buffer_processes (Lisp_Object buffer)
6915 #ifdef subprocesses
6916 Lisp_Object tail, proc;
6918 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6920 proc = XCDR (XCAR (tail));
6921 if (PROCESSP (proc)
6922 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
6924 if (NETCONN_P (proc) || SERIALCONN_P (proc))
6925 Fdelete_process (proc);
6926 else if (XPROCESS (proc)->infd >= 0)
6927 process_send_signal (proc, SIGHUP, Qnil, 1);
6930 #else /* subprocesses */
6931 /* Since we have no subprocesses, this does nothing. */
6932 #endif /* subprocesses */
6935 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
6936 Swaiting_for_user_input_p, 0, 0, 0,
6937 doc: /* Return non-nil if Emacs is waiting for input from the user.
6938 This is intended for use by asynchronous process output filters and sentinels. */)
6939 (void)
6941 #ifdef subprocesses
6942 return (waiting_for_user_input_p ? Qt : Qnil);
6943 #else
6944 return Qnil;
6945 #endif
6948 /* Stop reading input from keyboard sources. */
6950 void
6951 hold_keyboard_input (void)
6953 kbd_is_on_hold = 1;
6956 /* Resume reading input from keyboard sources. */
6958 void
6959 unhold_keyboard_input (void)
6961 kbd_is_on_hold = 0;
6964 /* Return true if keyboard input is on hold, zero otherwise. */
6966 bool
6967 kbd_on_hold_p (void)
6969 return kbd_is_on_hold;
6973 /* Enumeration of and access to system processes a-la ps(1). */
6975 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
6976 0, 0, 0,
6977 doc: /* Return a list of numerical process IDs of all running processes.
6978 If this functionality is unsupported, return nil.
6980 See `process-attributes' for getting attributes of a process given its ID. */)
6981 (void)
6983 return list_system_processes ();
6986 DEFUN ("process-attributes", Fprocess_attributes,
6987 Sprocess_attributes, 1, 1, 0,
6988 doc: /* Return attributes of the process given by its PID, a number.
6990 Value is an alist where each element is a cons cell of the form
6992 \(KEY . VALUE)
6994 If this functionality is unsupported, the value is nil.
6996 See `list-system-processes' for getting a list of all process IDs.
6998 The KEYs of the attributes that this function may return are listed
6999 below, together with the type of the associated VALUE (in parentheses).
7000 Not all platforms support all of these attributes; unsupported
7001 attributes will not appear in the returned alist.
7002 Unless explicitly indicated otherwise, numbers can have either
7003 integer or floating point values.
7005 euid -- Effective user User ID of the process (number)
7006 user -- User name corresponding to euid (string)
7007 egid -- Effective user Group ID of the process (number)
7008 group -- Group name corresponding to egid (string)
7009 comm -- Command name (executable name only) (string)
7010 state -- Process state code, such as "S", "R", or "T" (string)
7011 ppid -- Parent process ID (number)
7012 pgrp -- Process group ID (number)
7013 sess -- Session ID, i.e. process ID of session leader (number)
7014 ttname -- Controlling tty name (string)
7015 tpgid -- ID of foreground process group on the process's tty (number)
7016 minflt -- number of minor page faults (number)
7017 majflt -- number of major page faults (number)
7018 cminflt -- cumulative number of minor page faults (number)
7019 cmajflt -- cumulative number of major page faults (number)
7020 utime -- user time used by the process, in (current-time) format,
7021 which is a list of integers (HIGH LOW USEC PSEC)
7022 stime -- system time used by the process (current-time)
7023 time -- sum of utime and stime (current-time)
7024 cutime -- user time used by the process and its children (current-time)
7025 cstime -- system time used by the process and its children (current-time)
7026 ctime -- sum of cutime and cstime (current-time)
7027 pri -- priority of the process (number)
7028 nice -- nice value of the process (number)
7029 thcount -- process thread count (number)
7030 start -- time the process started (current-time)
7031 vsize -- virtual memory size of the process in KB's (number)
7032 rss -- resident set size of the process in KB's (number)
7033 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7034 pcpu -- percents of CPU time used by the process (floating-point number)
7035 pmem -- percents of total physical memory used by process's resident set
7036 (floating-point number)
7037 args -- command line which invoked the process (string). */)
7038 ( Lisp_Object pid)
7040 return system_process_attributes (pid);
7043 #ifndef NS_IMPL_GNUSTEP
7044 static
7045 #endif
7046 void
7047 catch_child_signal (void)
7049 struct sigaction action, old_action;
7050 emacs_sigaction_init (&action, deliver_child_signal);
7051 sigaction (SIGCHLD, &action, &old_action);
7052 eassert (! (old_action.sa_flags & SA_SIGINFO));
7053 if (old_action.sa_handler != SIG_DFL && old_action.sa_handler != SIG_IGN
7054 && old_action.sa_handler != deliver_child_signal)
7055 lib_child_handler = old_action.sa_handler;
7059 /* This is not called "init_process" because that is the name of a
7060 Mach system call, so it would cause problems on Darwin systems. */
7061 void
7062 init_process_emacs (void)
7064 #ifdef subprocesses
7065 register int i;
7067 inhibit_sentinels = 0;
7069 #ifndef CANNOT_DUMP
7070 if (! noninteractive || initialized)
7071 #endif
7073 #if defined HAVE_GLIB && !defined WINDOWSNT
7074 /* Tickle glib's child-handling code. Ask glib to wait for Emacs itself;
7075 this should always fail, but is enough to initialize glib's
7076 private SIGCHLD handler. */
7077 g_source_unref (g_child_watch_source_new (getpid ()));
7078 #endif
7079 catch_child_signal ();
7082 FD_ZERO (&input_wait_mask);
7083 FD_ZERO (&non_keyboard_wait_mask);
7084 FD_ZERO (&non_process_wait_mask);
7085 FD_ZERO (&write_mask);
7086 max_process_desc = 0;
7087 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7089 #ifdef NON_BLOCKING_CONNECT
7090 FD_ZERO (&connect_wait_mask);
7091 num_pending_connects = 0;
7092 #endif
7094 #ifdef ADAPTIVE_READ_BUFFERING
7095 process_output_delay_count = 0;
7096 process_output_skip = 0;
7097 #endif
7099 /* Don't do this, it caused infinite select loops. The display
7100 method should call add_keyboard_wait_descriptor on stdin if it
7101 needs that. */
7102 #if 0
7103 FD_SET (0, &input_wait_mask);
7104 #endif
7106 Vprocess_alist = Qnil;
7107 deleted_pid_list = Qnil;
7108 for (i = 0; i < MAXDESC; i++)
7110 chan_process[i] = Qnil;
7111 proc_buffered_char[i] = -1;
7113 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7114 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7115 #ifdef DATAGRAM_SOCKETS
7116 memset (datagram_address, 0, sizeof datagram_address);
7117 #endif
7120 Lisp_Object subfeatures = Qnil;
7121 const struct socket_options *sopt;
7123 #define ADD_SUBFEATURE(key, val) \
7124 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7126 #ifdef NON_BLOCKING_CONNECT
7127 ADD_SUBFEATURE (QCnowait, Qt);
7128 #endif
7129 #ifdef DATAGRAM_SOCKETS
7130 ADD_SUBFEATURE (QCtype, Qdatagram);
7131 #endif
7132 #ifdef HAVE_SEQPACKET
7133 ADD_SUBFEATURE (QCtype, Qseqpacket);
7134 #endif
7135 #ifdef HAVE_LOCAL_SOCKETS
7136 ADD_SUBFEATURE (QCfamily, Qlocal);
7137 #endif
7138 ADD_SUBFEATURE (QCfamily, Qipv4);
7139 #ifdef AF_INET6
7140 ADD_SUBFEATURE (QCfamily, Qipv6);
7141 #endif
7142 #ifdef HAVE_GETSOCKNAME
7143 ADD_SUBFEATURE (QCservice, Qt);
7144 #endif
7145 ADD_SUBFEATURE (QCserver, Qt);
7147 for (sopt = socket_options; sopt->name; sopt++)
7148 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7150 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7153 #if defined (DARWIN_OS)
7154 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7155 processes. As such, we only change the default value. */
7156 if (initialized)
7158 char const *release = (STRINGP (Voperating_system_release)
7159 ? SSDATA (Voperating_system_release)
7160 : 0);
7161 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7162 Vprocess_connection_type = Qnil;
7165 #endif
7166 #endif /* subprocesses */
7167 kbd_is_on_hold = 0;
7170 void
7171 syms_of_process (void)
7173 #ifdef subprocesses
7175 DEFSYM (Qprocessp, "processp");
7176 DEFSYM (Qrun, "run");
7177 DEFSYM (Qstop, "stop");
7178 DEFSYM (Qsignal, "signal");
7180 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7181 here again.
7183 Qexit = intern_c_string ("exit");
7184 staticpro (&Qexit); */
7186 DEFSYM (Qopen, "open");
7187 DEFSYM (Qclosed, "closed");
7188 DEFSYM (Qconnect, "connect");
7189 DEFSYM (Qfailed, "failed");
7190 DEFSYM (Qlisten, "listen");
7191 DEFSYM (Qlocal, "local");
7192 DEFSYM (Qipv4, "ipv4");
7193 #ifdef AF_INET6
7194 DEFSYM (Qipv6, "ipv6");
7195 #endif
7196 DEFSYM (Qdatagram, "datagram");
7197 DEFSYM (Qseqpacket, "seqpacket");
7199 DEFSYM (QCport, ":port");
7200 DEFSYM (QCspeed, ":speed");
7201 DEFSYM (QCprocess, ":process");
7203 DEFSYM (QCbytesize, ":bytesize");
7204 DEFSYM (QCstopbits, ":stopbits");
7205 DEFSYM (QCparity, ":parity");
7206 DEFSYM (Qodd, "odd");
7207 DEFSYM (Qeven, "even");
7208 DEFSYM (QCflowcontrol, ":flowcontrol");
7209 DEFSYM (Qhw, "hw");
7210 DEFSYM (Qsw, "sw");
7211 DEFSYM (QCsummary, ":summary");
7213 DEFSYM (Qreal, "real");
7214 DEFSYM (Qnetwork, "network");
7215 DEFSYM (Qserial, "serial");
7216 DEFSYM (QCbuffer, ":buffer");
7217 DEFSYM (QChost, ":host");
7218 DEFSYM (QCservice, ":service");
7219 DEFSYM (QClocal, ":local");
7220 DEFSYM (QCremote, ":remote");
7221 DEFSYM (QCcoding, ":coding");
7222 DEFSYM (QCserver, ":server");
7223 DEFSYM (QCnowait, ":nowait");
7224 DEFSYM (QCsentinel, ":sentinel");
7225 DEFSYM (QClog, ":log");
7226 DEFSYM (QCnoquery, ":noquery");
7227 DEFSYM (QCstop, ":stop");
7228 DEFSYM (QCoptions, ":options");
7229 DEFSYM (QCplist, ":plist");
7231 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7233 staticpro (&Vprocess_alist);
7234 staticpro (&deleted_pid_list);
7236 #endif /* subprocesses */
7238 DEFSYM (QCname, ":name");
7239 DEFSYM (QCtype, ":type");
7241 DEFSYM (Qeuid, "euid");
7242 DEFSYM (Qegid, "egid");
7243 DEFSYM (Quser, "user");
7244 DEFSYM (Qgroup, "group");
7245 DEFSYM (Qcomm, "comm");
7246 DEFSYM (Qstate, "state");
7247 DEFSYM (Qppid, "ppid");
7248 DEFSYM (Qpgrp, "pgrp");
7249 DEFSYM (Qsess, "sess");
7250 DEFSYM (Qttname, "ttname");
7251 DEFSYM (Qtpgid, "tpgid");
7252 DEFSYM (Qminflt, "minflt");
7253 DEFSYM (Qmajflt, "majflt");
7254 DEFSYM (Qcminflt, "cminflt");
7255 DEFSYM (Qcmajflt, "cmajflt");
7256 DEFSYM (Qutime, "utime");
7257 DEFSYM (Qstime, "stime");
7258 DEFSYM (Qtime, "time");
7259 DEFSYM (Qcutime, "cutime");
7260 DEFSYM (Qcstime, "cstime");
7261 DEFSYM (Qctime, "ctime");
7262 DEFSYM (Qinternal_default_process_sentinel,
7263 "internal-default-process-sentinel");
7264 DEFSYM (Qinternal_default_process_filter,
7265 "internal-default-process-filter");
7266 DEFSYM (Qpri, "pri");
7267 DEFSYM (Qnice, "nice");
7268 DEFSYM (Qthcount, "thcount");
7269 DEFSYM (Qstart, "start");
7270 DEFSYM (Qvsize, "vsize");
7271 DEFSYM (Qrss, "rss");
7272 DEFSYM (Qetime, "etime");
7273 DEFSYM (Qpcpu, "pcpu");
7274 DEFSYM (Qpmem, "pmem");
7275 DEFSYM (Qargs, "args");
7277 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7278 doc: /* Non-nil means delete processes immediately when they exit.
7279 A value of nil means don't delete them until `list-processes' is run. */);
7281 delete_exited_processes = 1;
7283 #ifdef subprocesses
7284 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7285 doc: /* Control type of device used to communicate with subprocesses.
7286 Values are nil to use a pipe, or t or `pty' to use a pty.
7287 The value has no effect if the system has no ptys or if all ptys are busy:
7288 then a pipe is used in any case.
7289 The value takes effect when `start-process' is called. */);
7290 Vprocess_connection_type = Qt;
7292 #ifdef ADAPTIVE_READ_BUFFERING
7293 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7294 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7295 On some systems, when Emacs reads the output from a subprocess, the output data
7296 is read in very small blocks, potentially resulting in very poor performance.
7297 This behavior can be remedied to some extent by setting this variable to a
7298 non-nil value, as it will automatically delay reading from such processes, to
7299 allow them to produce more output before Emacs tries to read it.
7300 If the value is t, the delay is reset after each write to the process; any other
7301 non-nil value means that the delay is not reset on write.
7302 The variable takes effect when `start-process' is called. */);
7303 Vprocess_adaptive_read_buffering = Qt;
7304 #endif
7306 defsubr (&Sprocessp);
7307 defsubr (&Sget_process);
7308 defsubr (&Sdelete_process);
7309 defsubr (&Sprocess_status);
7310 defsubr (&Sprocess_exit_status);
7311 defsubr (&Sprocess_id);
7312 defsubr (&Sprocess_name);
7313 defsubr (&Sprocess_tty_name);
7314 defsubr (&Sprocess_command);
7315 defsubr (&Sset_process_buffer);
7316 defsubr (&Sprocess_buffer);
7317 defsubr (&Sprocess_mark);
7318 defsubr (&Sset_process_filter);
7319 defsubr (&Sprocess_filter);
7320 defsubr (&Sset_process_sentinel);
7321 defsubr (&Sprocess_sentinel);
7322 defsubr (&Sset_process_window_size);
7323 defsubr (&Sset_process_inherit_coding_system_flag);
7324 defsubr (&Sset_process_query_on_exit_flag);
7325 defsubr (&Sprocess_query_on_exit_flag);
7326 defsubr (&Sprocess_contact);
7327 defsubr (&Sprocess_plist);
7328 defsubr (&Sset_process_plist);
7329 defsubr (&Sprocess_list);
7330 defsubr (&Sstart_process);
7331 defsubr (&Sserial_process_configure);
7332 defsubr (&Smake_serial_process);
7333 defsubr (&Sset_network_process_option);
7334 defsubr (&Smake_network_process);
7335 defsubr (&Sformat_network_address);
7336 #if defined (HAVE_NET_IF_H)
7337 #ifdef SIOCGIFCONF
7338 defsubr (&Snetwork_interface_list);
7339 #endif
7340 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
7341 defsubr (&Snetwork_interface_info);
7342 #endif
7343 #endif /* defined (HAVE_NET_IF_H) */
7344 #ifdef DATAGRAM_SOCKETS
7345 defsubr (&Sprocess_datagram_address);
7346 defsubr (&Sset_process_datagram_address);
7347 #endif
7348 defsubr (&Saccept_process_output);
7349 defsubr (&Sprocess_send_region);
7350 defsubr (&Sprocess_send_string);
7351 defsubr (&Sinterrupt_process);
7352 defsubr (&Skill_process);
7353 defsubr (&Squit_process);
7354 defsubr (&Sstop_process);
7355 defsubr (&Scontinue_process);
7356 defsubr (&Sprocess_running_child_p);
7357 defsubr (&Sprocess_send_eof);
7358 defsubr (&Ssignal_process);
7359 defsubr (&Swaiting_for_user_input_p);
7360 defsubr (&Sprocess_type);
7361 defsubr (&Sinternal_default_process_sentinel);
7362 defsubr (&Sinternal_default_process_filter);
7363 defsubr (&Sset_process_coding_system);
7364 defsubr (&Sprocess_coding_system);
7365 defsubr (&Sset_process_filter_multibyte);
7366 defsubr (&Sprocess_filter_multibyte_p);
7368 #endif /* subprocesses */
7370 defsubr (&Sget_buffer_process);
7371 defsubr (&Sprocess_inherit_coding_system_flag);
7372 defsubr (&Slist_system_processes);
7373 defsubr (&Sprocess_attributes);