* term.el (term-default-fg-color, term-default-bg-color): Fix custom type.
[emacs.git] / src / process.c
blob2fb5b16a19ff68a5bf4ac54f463a5139b8e7e23d
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 #endif /* subprocesses */
96 #include "systime.h"
97 #include "systty.h"
99 #include "window.h"
100 #include "character.h"
101 #include "buffer.h"
102 #include "coding.h"
103 #include "process.h"
104 #include "frame.h"
105 #include "termhooks.h"
106 #include "termopts.h"
107 #include "commands.h"
108 #include "keyboard.h"
109 #include "blockinput.h"
110 #include "dispextern.h"
111 #include "composite.h"
112 #include "atimer.h"
113 #include "sysselect.h"
114 #include "syssignal.h"
115 #include "syswait.h"
116 #ifdef HAVE_GNUTLS
117 #include "gnutls.h"
118 #endif
120 #ifdef HAVE_WINDOW_SYSTEM
121 #include TERM_HEADER
122 #endif /* HAVE_WINDOW_SYSTEM */
124 #if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
125 #include "xgselect.h"
126 #endif
128 #ifdef WINDOWSNT
129 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
130 EMACS_TIME *, void *);
131 #endif
133 #ifndef WNOHANG
134 # undef waitpid
135 # define waitpid(pid, status, options) wait (status)
136 #endif
137 #ifndef WUNTRACED
138 # define WUNTRACED 0
139 #endif
141 /* Work around GCC 4.7.0 bug with strict overflow checking; see
142 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
143 These lines can be removed once the GCC bug is fixed. */
144 #if (__GNUC__ == 4 && 3 <= __GNUC_MINOR__) || 4 < __GNUC__
145 # pragma GCC diagnostic ignored "-Wstrict-overflow"
146 #endif
148 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
149 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
150 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
151 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
152 Lisp_Object QCname, QCtype;
154 /* Non-zero if keyboard input is on hold, zero otherwise. */
156 static int kbd_is_on_hold;
158 /* Nonzero means don't run process sentinels. This is used
159 when exiting. */
160 int inhibit_sentinels;
162 #ifdef subprocesses
164 Lisp_Object Qprocessp;
165 static Lisp_Object Qrun, Qstop, Qsignal;
166 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
167 Lisp_Object Qlocal;
168 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
169 static Lisp_Object Qreal, Qnetwork, Qserial;
170 #ifdef AF_INET6
171 static Lisp_Object Qipv6;
172 #endif
173 static Lisp_Object QCport, QCprocess;
174 Lisp_Object QCspeed;
175 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
176 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
177 static Lisp_Object QCbuffer, QChost, QCservice;
178 static Lisp_Object QClocal, QCremote, QCcoding;
179 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
180 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
181 static Lisp_Object Qlast_nonmenu_event;
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 #ifndef HAVE_H_ERRNO
189 extern int h_errno;
190 #endif
192 /* Number of events of change of status of a process. */
193 static EMACS_INT process_tick;
194 /* Number of events for which the user or sentinel has been notified. */
195 static EMACS_INT update_tick;
197 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
199 /* Only W32 has this, it really means that select can't take write mask. */
200 #ifdef BROKEN_NON_BLOCKING_CONNECT
201 #undef NON_BLOCKING_CONNECT
202 #define SELECT_CANT_DO_WRITE_MASK
203 #else
204 #ifndef NON_BLOCKING_CONNECT
205 #ifdef HAVE_SELECT
206 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
207 #if defined (O_NONBLOCK) || defined (O_NDELAY)
208 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
209 #define NON_BLOCKING_CONNECT
210 #endif /* EWOULDBLOCK || EINPROGRESS */
211 #endif /* O_NONBLOCK || O_NDELAY */
212 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
213 #endif /* HAVE_SELECT */
214 #endif /* NON_BLOCKING_CONNECT */
215 #endif /* BROKEN_NON_BLOCKING_CONNECT */
217 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
218 this system. We need to read full packets, so we need a
219 "non-destructive" select. So we require either native select,
220 or emulation of select using FIONREAD. */
222 #ifndef BROKEN_DATAGRAM_SOCKETS
223 # if defined HAVE_SELECT || defined USABLE_FIONREAD
224 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
225 # define DATAGRAM_SOCKETS
226 # endif
227 # endif
228 #endif
230 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
231 # define HAVE_SEQPACKET
232 #endif
234 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
235 #define ADAPTIVE_READ_BUFFERING
236 #endif
238 #ifdef ADAPTIVE_READ_BUFFERING
239 #define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
240 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
241 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
243 /* Number of processes which have a non-zero read_output_delay,
244 and therefore might be delayed for adaptive read buffering. */
246 static int process_output_delay_count;
248 /* Non-zero if any process has non-nil read_output_skip. */
250 static int process_output_skip;
252 #else
253 #define process_output_delay_count 0
254 #endif
256 static void create_process (Lisp_Object, char **, Lisp_Object);
257 #ifdef USABLE_SIGIO
258 static int keyboard_bit_set (SELECT_TYPE *);
259 #endif
260 static void deactivate_process (Lisp_Object);
261 static void status_notify (struct Lisp_Process *);
262 static int read_process_output (Lisp_Object, int);
263 static void handle_child_signal (int);
264 static void create_pty (Lisp_Object);
266 /* If we support a window system, turn on the code to poll periodically
267 to detect C-g. It isn't actually used when doing interrupt input. */
268 #ifdef HAVE_WINDOW_SYSTEM
269 #define POLL_FOR_INPUT
270 #endif
272 static Lisp_Object get_process (register Lisp_Object name);
273 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
275 /* Mask of bits indicating the descriptors that we wait for input on. */
277 static SELECT_TYPE input_wait_mask;
279 /* Mask that excludes keyboard input descriptor(s). */
281 static SELECT_TYPE non_keyboard_wait_mask;
283 /* Mask that excludes process input descriptor(s). */
285 static SELECT_TYPE non_process_wait_mask;
287 /* Mask for selecting for write. */
289 static SELECT_TYPE write_mask;
291 #ifdef NON_BLOCKING_CONNECT
292 /* Mask of bits indicating the descriptors that we wait for connect to
293 complete on. Once they complete, they are removed from this mask
294 and added to the input_wait_mask and non_keyboard_wait_mask. */
296 static SELECT_TYPE connect_wait_mask;
298 /* Number of bits set in connect_wait_mask. */
299 static int num_pending_connects;
300 #endif /* NON_BLOCKING_CONNECT */
302 /* The largest descriptor currently in use for a process object. */
303 static int max_process_desc;
305 /* The largest descriptor currently in use for input. */
306 static int max_input_desc;
308 /* Indexed by descriptor, gives the process (if any) for that descriptor */
309 static Lisp_Object chan_process[MAXDESC];
311 /* Alist of elements (NAME . PROCESS) */
312 static Lisp_Object Vprocess_alist;
314 /* Buffered-ahead input char from process, indexed by channel.
315 -1 means empty (no char is buffered).
316 Used on sys V where the only way to tell if there is any
317 output from the process is to read at least one char.
318 Always -1 on systems that support FIONREAD. */
320 static int proc_buffered_char[MAXDESC];
322 /* Table of `struct coding-system' for each process. */
323 static struct coding_system *proc_decode_coding_system[MAXDESC];
324 static struct coding_system *proc_encode_coding_system[MAXDESC];
326 #ifdef DATAGRAM_SOCKETS
327 /* Table of `partner address' for datagram sockets. */
328 static struct sockaddr_and_len {
329 struct sockaddr *sa;
330 int len;
331 } datagram_address[MAXDESC];
332 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
333 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
334 #else
335 #define DATAGRAM_CHAN_P(chan) (0)
336 #define DATAGRAM_CONN_P(proc) (0)
337 #endif
339 /* Maximum number of bytes to send to a pty without an eof. */
340 static int pty_max_bytes;
342 /* These setters are used only in this file, so they can be private. */
343 static void
344 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
346 p->buffer = val;
348 static void
349 pset_command (struct Lisp_Process *p, Lisp_Object val)
351 p->command = val;
353 static void
354 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
356 p->decode_coding_system = val;
358 static void
359 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
361 p->decoding_buf = val;
363 static void
364 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
366 p->encode_coding_system = val;
368 static void
369 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
371 p->encoding_buf = val;
373 static void
374 pset_filter (struct Lisp_Process *p, Lisp_Object val)
376 p->filter = val;
378 static void
379 pset_log (struct Lisp_Process *p, Lisp_Object val)
381 p->log = val;
383 static void
384 pset_mark (struct Lisp_Process *p, Lisp_Object val)
386 p->mark = val;
388 static void
389 pset_name (struct Lisp_Process *p, Lisp_Object val)
391 p->name = val;
393 static void
394 pset_plist (struct Lisp_Process *p, Lisp_Object val)
396 p->plist = val;
398 static void
399 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
401 p->sentinel = val;
403 static void
404 pset_status (struct Lisp_Process *p, Lisp_Object val)
406 p->status = val;
408 static void
409 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
411 p->tty_name = val;
413 static void
414 pset_type (struct Lisp_Process *p, Lisp_Object val)
416 p->type = val;
418 static void
419 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
421 p->write_queue = val;
426 static struct fd_callback_data
428 fd_callback func;
429 void *data;
430 #define FOR_READ 1
431 #define FOR_WRITE 2
432 int condition; /* mask of the defines above. */
433 } fd_callback_info[MAXDESC];
436 /* Add a file descriptor FD to be monitored for when read is possible.
437 When read is possible, call FUNC with argument DATA. */
439 void
440 add_read_fd (int fd, fd_callback func, void *data)
442 eassert (fd < MAXDESC);
443 add_keyboard_wait_descriptor (fd);
445 fd_callback_info[fd].func = func;
446 fd_callback_info[fd].data = data;
447 fd_callback_info[fd].condition |= FOR_READ;
450 /* Stop monitoring file descriptor FD for when read is possible. */
452 void
453 delete_read_fd (int fd)
455 eassert (fd < MAXDESC);
456 delete_keyboard_wait_descriptor (fd);
458 fd_callback_info[fd].condition &= ~FOR_READ;
459 if (fd_callback_info[fd].condition == 0)
461 fd_callback_info[fd].func = 0;
462 fd_callback_info[fd].data = 0;
466 /* Add a file descriptor FD to be monitored for when write is possible.
467 When write is possible, call FUNC with argument DATA. */
469 void
470 add_write_fd (int fd, fd_callback func, void *data)
472 eassert (fd < MAXDESC);
473 FD_SET (fd, &write_mask);
474 if (fd > max_input_desc)
475 max_input_desc = fd;
477 fd_callback_info[fd].func = func;
478 fd_callback_info[fd].data = data;
479 fd_callback_info[fd].condition |= FOR_WRITE;
482 /* Stop monitoring file descriptor FD for when write is possible. */
484 void
485 delete_write_fd (int fd)
487 int lim = max_input_desc;
489 eassert (fd < MAXDESC);
490 FD_CLR (fd, &write_mask);
491 fd_callback_info[fd].condition &= ~FOR_WRITE;
492 if (fd_callback_info[fd].condition == 0)
494 fd_callback_info[fd].func = 0;
495 fd_callback_info[fd].data = 0;
497 if (fd == max_input_desc)
498 for (fd = lim; fd >= 0; fd--)
499 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
501 max_input_desc = fd;
502 break;
509 /* Compute the Lisp form of the process status, p->status, from
510 the numeric status that was returned by `wait'. */
512 static Lisp_Object status_convert (int);
514 static void
515 update_status (struct Lisp_Process *p)
517 eassert (p->raw_status_new);
518 pset_status (p, status_convert (p->raw_status));
519 p->raw_status_new = 0;
522 /* Convert a process status word in Unix format to
523 the list that we use internally. */
525 static Lisp_Object
526 status_convert (int w)
528 if (WIFSTOPPED (w))
529 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
530 else if (WIFEXITED (w))
531 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
532 WCOREDUMP (w) ? Qt : Qnil));
533 else if (WIFSIGNALED (w))
534 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
535 WCOREDUMP (w) ? Qt : Qnil));
536 else
537 return Qrun;
540 /* Given a status-list, extract the three pieces of information
541 and store them individually through the three pointers. */
543 static void
544 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
546 Lisp_Object tem;
548 if (SYMBOLP (l))
550 *symbol = l;
551 *code = 0;
552 *coredump = 0;
554 else
556 *symbol = XCAR (l);
557 tem = XCDR (l);
558 *code = XFASTINT (XCAR (tem));
559 tem = XCDR (tem);
560 *coredump = !NILP (tem);
564 /* Return a string describing a process status list. */
566 static Lisp_Object
567 status_message (struct Lisp_Process *p)
569 Lisp_Object status = p->status;
570 Lisp_Object symbol;
571 int code, coredump;
572 Lisp_Object string, string2;
574 decode_status (status, &symbol, &code, &coredump);
576 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
578 char const *signame;
579 synchronize_system_messages_locale ();
580 signame = strsignal (code);
581 if (signame == 0)
582 string = build_string ("unknown");
583 else
585 int c1, c2;
587 string = build_unibyte_string (signame);
588 if (! NILP (Vlocale_coding_system))
589 string = (code_convert_string_norecord
590 (string, Vlocale_coding_system, 0));
591 c1 = STRING_CHAR (SDATA (string));
592 c2 = downcase (c1);
593 if (c1 != c2)
594 Faset (string, make_number (0), make_number (c2));
596 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
597 return concat2 (string, string2);
599 else if (EQ (symbol, Qexit))
601 if (NETCONN1_P (p))
602 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
603 if (code == 0)
604 return build_string ("finished\n");
605 string = Fnumber_to_string (make_number (code));
606 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
607 return concat3 (build_string ("exited abnormally with code "),
608 string, string2);
610 else if (EQ (symbol, Qfailed))
612 string = Fnumber_to_string (make_number (code));
613 string2 = build_string ("\n");
614 return concat3 (build_string ("failed with code "),
615 string, string2);
617 else
618 return Fcopy_sequence (Fsymbol_name (symbol));
621 #ifdef HAVE_PTYS
623 /* The file name of the pty opened by allocate_pty. */
624 static char pty_name[24];
626 /* Open an available pty, returning a file descriptor.
627 Return -1 on failure.
628 The file name of the terminal corresponding to the pty
629 is left in the variable pty_name. */
631 static int
632 allocate_pty (void)
634 int fd;
636 #ifdef PTY_ITERATION
637 PTY_ITERATION
638 #else
639 register int c, i;
640 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
641 for (i = 0; i < 16; i++)
642 #endif
644 #ifdef PTY_NAME_SPRINTF
645 PTY_NAME_SPRINTF
646 #else
647 sprintf (pty_name, "/dev/pty%c%x", c, i);
648 #endif /* no PTY_NAME_SPRINTF */
650 #ifdef PTY_OPEN
651 PTY_OPEN;
652 #else /* no PTY_OPEN */
654 # ifdef O_NONBLOCK
655 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
656 # else
657 fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
658 # endif
660 #endif /* no PTY_OPEN */
662 if (fd >= 0)
664 /* check to make certain that both sides are available
665 this avoids a nasty yet stupid bug in rlogins */
666 #ifdef PTY_TTY_NAME_SPRINTF
667 PTY_TTY_NAME_SPRINTF
668 #else
669 sprintf (pty_name, "/dev/tty%c%x", c, i);
670 #endif /* no PTY_TTY_NAME_SPRINTF */
671 if (access (pty_name, 6) != 0)
673 emacs_close (fd);
674 # ifndef __sgi
675 continue;
676 # else
677 return -1;
678 # endif /* __sgi */
680 setup_pty (fd);
681 return fd;
684 return -1;
686 #endif /* HAVE_PTYS */
688 static Lisp_Object
689 make_process (Lisp_Object name)
691 register Lisp_Object val, tem, name1;
692 register struct Lisp_Process *p;
693 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
694 printmax_t i;
696 p = allocate_process ();
697 /* Initialize Lisp data. Note that allocate_process initializes all
698 Lisp data to nil, so do it only for slots which should not be nil. */
699 pset_status (p, Qrun);
700 pset_mark (p, Fmake_marker ());
702 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
703 non-Lisp data, so do it only for slots which should not be zero. */
704 p->infd = -1;
705 p->outfd = -1;
707 #ifdef HAVE_GNUTLS
708 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
709 #endif
711 /* If name is already in use, modify it until it is unused. */
713 name1 = name;
714 for (i = 1; ; i++)
716 tem = Fget_process (name1);
717 if (NILP (tem)) break;
718 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
720 name = name1;
721 pset_name (p, name);
722 XSETPROCESS (val, p);
723 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
724 return val;
727 static void
728 remove_process (register Lisp_Object proc)
730 register Lisp_Object pair;
732 pair = Frassq (proc, Vprocess_alist);
733 Vprocess_alist = Fdelq (pair, Vprocess_alist);
735 deactivate_process (proc);
739 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
740 doc: /* Return t if OBJECT is a process. */)
741 (Lisp_Object object)
743 return PROCESSP (object) ? Qt : Qnil;
746 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
747 doc: /* Return the process named NAME, or nil if there is none. */)
748 (register Lisp_Object name)
750 if (PROCESSP (name))
751 return name;
752 CHECK_STRING (name);
753 return Fcdr (Fassoc (name, Vprocess_alist));
756 /* This is how commands for the user decode process arguments. It
757 accepts a process, a process name, a buffer, a buffer name, or nil.
758 Buffers denote the first process in the buffer, and nil denotes the
759 current buffer. */
761 static Lisp_Object
762 get_process (register Lisp_Object name)
764 register Lisp_Object proc, obj;
765 if (STRINGP (name))
767 obj = Fget_process (name);
768 if (NILP (obj))
769 obj = Fget_buffer (name);
770 if (NILP (obj))
771 error ("Process %s does not exist", SDATA (name));
773 else if (NILP (name))
774 obj = Fcurrent_buffer ();
775 else
776 obj = name;
778 /* Now obj should be either a buffer object or a process object.
780 if (BUFFERP (obj))
782 proc = Fget_buffer_process (obj);
783 if (NILP (proc))
784 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
786 else
788 CHECK_PROCESS (obj);
789 proc = obj;
791 return proc;
795 #ifdef SIGCHLD
796 /* Fdelete_process promises to immediately forget about the process, but in
797 reality, Emacs needs to remember those processes until they have been
798 treated by the SIGCHLD handler; otherwise this handler would consider the
799 process as being synchronous and say that the synchronous process is
800 dead. */
801 static Lisp_Object deleted_pid_list;
802 #endif
804 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
805 doc: /* Delete PROCESS: kill it and forget about it immediately.
806 PROCESS may be a process, a buffer, the name of a process or buffer, or
807 nil, indicating the current buffer's process. */)
808 (register Lisp_Object process)
810 register struct Lisp_Process *p;
812 process = get_process (process);
813 p = XPROCESS (process);
815 p->raw_status_new = 0;
816 if (NETCONN1_P (p) || SERIALCONN1_P (p))
818 pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
819 p->tick = ++process_tick;
820 status_notify (p);
821 redisplay_preserve_echo_area (13);
823 else if (p->infd >= 0)
825 #ifdef SIGCHLD
826 Lisp_Object symbol;
827 pid_t pid = p->pid;
829 /* No problem storing the pid here, as it is still in Vprocess_alist. */
830 deleted_pid_list = Fcons (make_fixnum_or_float (pid),
831 /* GC treated elements set to nil. */
832 Fdelq (Qnil, deleted_pid_list));
833 /* If the process has already signaled, remove it from the list. */
834 if (p->raw_status_new)
835 update_status (p);
836 symbol = p->status;
837 if (CONSP (p->status))
838 symbol = XCAR (p->status);
839 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
840 deleted_pid_list
841 = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
842 else
843 #endif
845 Fkill_process (process, Qnil);
846 /* Do this now, since remove_process will make the
847 SIGCHLD handler do nothing. */
848 pset_status (p, Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil)));
849 p->tick = ++process_tick;
850 status_notify (p);
851 redisplay_preserve_echo_area (13);
854 remove_process (process);
855 return Qnil;
858 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
859 doc: /* Return the status of PROCESS.
860 The returned value is one of the following symbols:
861 run -- for a process that is running.
862 stop -- for a process stopped but continuable.
863 exit -- for a process that has exited.
864 signal -- for a process that has got a fatal signal.
865 open -- for a network stream connection that is open.
866 listen -- for a network stream server that is listening.
867 closed -- for a network stream connection that is closed.
868 connect -- when waiting for a non-blocking connection to complete.
869 failed -- when a non-blocking connection has failed.
870 nil -- if arg is a process name and no such process exists.
871 PROCESS may be a process, a buffer, the name of a process, or
872 nil, indicating the current buffer's process. */)
873 (register Lisp_Object process)
875 register struct Lisp_Process *p;
876 register Lisp_Object status;
878 if (STRINGP (process))
879 process = Fget_process (process);
880 else
881 process = get_process (process);
883 if (NILP (process))
884 return process;
886 p = XPROCESS (process);
887 if (p->raw_status_new)
888 update_status (p);
889 status = p->status;
890 if (CONSP (status))
891 status = XCAR (status);
892 if (NETCONN1_P (p) || SERIALCONN1_P (p))
894 if (EQ (status, Qexit))
895 status = Qclosed;
896 else if (EQ (p->command, Qt))
897 status = Qstop;
898 else if (EQ (status, Qrun))
899 status = Qopen;
901 return status;
904 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
905 1, 1, 0,
906 doc: /* Return the exit status of PROCESS or the signal number that killed it.
907 If PROCESS has not yet exited or died, return 0. */)
908 (register Lisp_Object process)
910 CHECK_PROCESS (process);
911 if (XPROCESS (process)->raw_status_new)
912 update_status (XPROCESS (process));
913 if (CONSP (XPROCESS (process)->status))
914 return XCAR (XCDR (XPROCESS (process)->status));
915 return make_number (0);
918 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
919 doc: /* Return the process id of PROCESS.
920 This is the pid of the external process which PROCESS uses or talks to.
921 For a network connection, this value is nil. */)
922 (register Lisp_Object process)
924 pid_t pid;
926 CHECK_PROCESS (process);
927 pid = XPROCESS (process)->pid;
928 return (pid ? make_fixnum_or_float (pid) : Qnil);
931 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
932 doc: /* Return the name of PROCESS, as a string.
933 This is the name of the program invoked in PROCESS,
934 possibly modified to make it unique among process names. */)
935 (register Lisp_Object process)
937 CHECK_PROCESS (process);
938 return XPROCESS (process)->name;
941 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
942 doc: /* Return the command that was executed to start PROCESS.
943 This is a list of strings, the first string being the program executed
944 and the rest of the strings being the arguments given to it.
945 For a network or serial process, this is nil (process is running) or t
946 \(process is stopped). */)
947 (register Lisp_Object process)
949 CHECK_PROCESS (process);
950 return XPROCESS (process)->command;
953 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
954 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
955 This is the terminal that the process itself reads and writes on,
956 not the name of the pty that Emacs uses to talk with that terminal. */)
957 (register Lisp_Object process)
959 CHECK_PROCESS (process);
960 return XPROCESS (process)->tty_name;
963 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
964 2, 2, 0,
965 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
966 Return BUFFER. */)
967 (register Lisp_Object process, Lisp_Object buffer)
969 struct Lisp_Process *p;
971 CHECK_PROCESS (process);
972 if (!NILP (buffer))
973 CHECK_BUFFER (buffer);
974 p = XPROCESS (process);
975 pset_buffer (p, buffer);
976 if (NETCONN1_P (p) || SERIALCONN1_P (p))
977 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
978 setup_process_coding_systems (process);
979 return buffer;
982 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
983 1, 1, 0,
984 doc: /* Return the buffer PROCESS is associated with.
985 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
986 (register Lisp_Object process)
988 CHECK_PROCESS (process);
989 return XPROCESS (process)->buffer;
992 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
993 1, 1, 0,
994 doc: /* Return the marker for the end of the last output from PROCESS. */)
995 (register Lisp_Object process)
997 CHECK_PROCESS (process);
998 return XPROCESS (process)->mark;
1001 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1002 2, 2, 0,
1003 doc: /* Give PROCESS the filter function FILTER; nil means no filter.
1004 A value of t means stop accepting output from the process.
1006 When a process has a filter, its buffer is not used for output.
1007 Instead, each time it does output, the entire string of output is
1008 passed to the filter.
1010 The filter gets two arguments: the process and the string of output.
1011 The string argument is normally a multibyte string, except:
1012 - if the process' input coding system is no-conversion or raw-text,
1013 it is a unibyte string (the non-converted input), or else
1014 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1015 string (the result of converting the decoded input multibyte
1016 string to unibyte with `string-make-unibyte'). */)
1017 (register Lisp_Object process, Lisp_Object filter)
1019 struct Lisp_Process *p;
1021 CHECK_PROCESS (process);
1022 p = XPROCESS (process);
1024 /* Don't signal an error if the process' input file descriptor
1025 is closed. This could make debugging Lisp more difficult,
1026 for example when doing something like
1028 (setq process (start-process ...))
1029 (debug)
1030 (set-process-filter process ...) */
1032 if (p->infd >= 0)
1034 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1036 FD_CLR (p->infd, &input_wait_mask);
1037 FD_CLR (p->infd, &non_keyboard_wait_mask);
1039 else if (EQ (p->filter, Qt)
1040 /* Network or serial process not stopped: */
1041 && !EQ (p->command, Qt))
1043 FD_SET (p->infd, &input_wait_mask);
1044 FD_SET (p->infd, &non_keyboard_wait_mask);
1048 pset_filter (p, filter);
1049 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1050 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1051 setup_process_coding_systems (process);
1052 return filter;
1055 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1056 1, 1, 0,
1057 doc: /* Returns the filter function of PROCESS; nil if none.
1058 See `set-process-filter' for more info on filter functions. */)
1059 (register Lisp_Object process)
1061 CHECK_PROCESS (process);
1062 return XPROCESS (process)->filter;
1065 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1066 2, 2, 0,
1067 doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
1068 The sentinel is called as a function when the process changes state.
1069 It gets two arguments: the process, and a string describing the change. */)
1070 (register Lisp_Object process, Lisp_Object sentinel)
1072 struct Lisp_Process *p;
1074 CHECK_PROCESS (process);
1075 p = XPROCESS (process);
1077 pset_sentinel (p, sentinel);
1078 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1079 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1080 return sentinel;
1083 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1084 1, 1, 0,
1085 doc: /* Return the sentinel of PROCESS; nil if none.
1086 See `set-process-sentinel' for more info on sentinels. */)
1087 (register Lisp_Object process)
1089 CHECK_PROCESS (process);
1090 return XPROCESS (process)->sentinel;
1093 DEFUN ("set-process-window-size", Fset_process_window_size,
1094 Sset_process_window_size, 3, 3, 0,
1095 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1096 (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1098 CHECK_PROCESS (process);
1099 CHECK_RANGED_INTEGER (height, 0, INT_MAX);
1100 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
1102 if (XPROCESS (process)->infd < 0
1103 || set_window_size (XPROCESS (process)->infd,
1104 XINT (height), XINT (width)) <= 0)
1105 return Qnil;
1106 else
1107 return Qt;
1110 DEFUN ("set-process-inherit-coding-system-flag",
1111 Fset_process_inherit_coding_system_flag,
1112 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1113 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1114 If the second argument FLAG is non-nil, then the variable
1115 `buffer-file-coding-system' of the buffer associated with PROCESS
1116 will be bound to the value of the coding system used to decode
1117 the process output.
1119 This is useful when the coding system specified for the process buffer
1120 leaves either the character code conversion or the end-of-line conversion
1121 unspecified, or if the coding system used to decode the process output
1122 is more appropriate for saving the process buffer.
1124 Binding the variable `inherit-process-coding-system' to non-nil before
1125 starting the process is an alternative way of setting the inherit flag
1126 for the process which will run.
1128 This function returns FLAG. */)
1129 (register Lisp_Object process, Lisp_Object flag)
1131 CHECK_PROCESS (process);
1132 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1133 return flag;
1136 DEFUN ("set-process-query-on-exit-flag",
1137 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1138 2, 2, 0,
1139 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1140 If the second argument FLAG is non-nil, Emacs will query the user before
1141 exiting or killing a buffer if PROCESS is running. This function
1142 returns FLAG. */)
1143 (register Lisp_Object process, Lisp_Object flag)
1145 CHECK_PROCESS (process);
1146 XPROCESS (process)->kill_without_query = NILP (flag);
1147 return flag;
1150 DEFUN ("process-query-on-exit-flag",
1151 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1152 1, 1, 0,
1153 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1154 (register Lisp_Object process)
1156 CHECK_PROCESS (process);
1157 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1160 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1161 1, 2, 0,
1162 doc: /* Return the contact info of PROCESS; t for a real child.
1163 For a network or serial connection, the value depends on the optional
1164 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1165 SERVICE) for a network connection or (PORT SPEED) for a serial
1166 connection. If KEY is t, the complete contact information for the
1167 connection is returned, else the specific value for the keyword KEY is
1168 returned. See `make-network-process' or `make-serial-process' for a
1169 list of keywords. */)
1170 (register Lisp_Object process, Lisp_Object key)
1172 Lisp_Object contact;
1174 CHECK_PROCESS (process);
1175 contact = XPROCESS (process)->childp;
1177 #ifdef DATAGRAM_SOCKETS
1178 if (DATAGRAM_CONN_P (process)
1179 && (EQ (key, Qt) || EQ (key, QCremote)))
1180 contact = Fplist_put (contact, QCremote,
1181 Fprocess_datagram_address (process));
1182 #endif
1184 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1185 return contact;
1186 if (NILP (key) && NETCONN_P (process))
1187 return Fcons (Fplist_get (contact, QChost),
1188 Fcons (Fplist_get (contact, QCservice), Qnil));
1189 if (NILP (key) && SERIALCONN_P (process))
1190 return Fcons (Fplist_get (contact, QCport),
1191 Fcons (Fplist_get (contact, QCspeed), Qnil));
1192 return Fplist_get (contact, key);
1195 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1196 1, 1, 0,
1197 doc: /* Return the plist of PROCESS. */)
1198 (register Lisp_Object process)
1200 CHECK_PROCESS (process);
1201 return XPROCESS (process)->plist;
1204 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1205 2, 2, 0,
1206 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1207 (register Lisp_Object process, Lisp_Object plist)
1209 CHECK_PROCESS (process);
1210 CHECK_LIST (plist);
1212 pset_plist (XPROCESS (process), plist);
1213 return plist;
1216 #if 0 /* Turned off because we don't currently record this info
1217 in the process. Perhaps add it. */
1218 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1219 doc: /* Return the connection type of PROCESS.
1220 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1221 a socket connection. */)
1222 (Lisp_Object process)
1224 return XPROCESS (process)->type;
1226 #endif
1228 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1229 doc: /* Return the connection type of PROCESS.
1230 The value is either the symbol `real', `network', or `serial'.
1231 PROCESS may be a process, a buffer, the name of a process or buffer, or
1232 nil, indicating the current buffer's process. */)
1233 (Lisp_Object process)
1235 Lisp_Object proc;
1236 proc = get_process (process);
1237 return XPROCESS (proc)->type;
1240 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1241 1, 2, 0,
1242 doc: /* Convert network ADDRESS from internal format to a string.
1243 A 4 or 5 element vector represents an IPv4 address (with port number).
1244 An 8 or 9 element vector represents an IPv6 address (with port number).
1245 If optional second argument OMIT-PORT is non-nil, don't include a port
1246 number in the string, even when present in ADDRESS.
1247 Returns nil if format of ADDRESS is invalid. */)
1248 (Lisp_Object address, Lisp_Object omit_port)
1250 if (NILP (address))
1251 return Qnil;
1253 if (STRINGP (address)) /* AF_LOCAL */
1254 return address;
1256 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1258 register struct Lisp_Vector *p = XVECTOR (address);
1259 ptrdiff_t size = p->header.size;
1260 Lisp_Object args[10];
1261 int nargs, i;
1263 if (size == 4 || (size == 5 && !NILP (omit_port)))
1265 args[0] = build_string ("%d.%d.%d.%d");
1266 nargs = 4;
1268 else if (size == 5)
1270 args[0] = build_string ("%d.%d.%d.%d:%d");
1271 nargs = 5;
1273 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1275 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1276 nargs = 8;
1278 else if (size == 9)
1280 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1281 nargs = 9;
1283 else
1284 return Qnil;
1286 for (i = 0; i < nargs; i++)
1288 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1289 return Qnil;
1291 if (nargs <= 5 /* IPv4 */
1292 && i < 4 /* host, not port */
1293 && XINT (p->contents[i]) > 255)
1294 return Qnil;
1296 args[i+1] = p->contents[i];
1299 return Fformat (nargs+1, args);
1302 if (CONSP (address))
1304 Lisp_Object args[2];
1305 args[0] = build_string ("<Family %d>");
1306 args[1] = Fcar (address);
1307 return Fformat (2, args);
1310 return Qnil;
1313 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1314 doc: /* Return a list of all processes. */)
1315 (void)
1317 return Fmapcar (Qcdr, Vprocess_alist);
1320 /* Starting asynchronous inferior processes. */
1322 static Lisp_Object start_process_unwind (Lisp_Object proc);
1324 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1325 doc: /* Start a program in a subprocess. Return the process object for it.
1326 NAME is name for process. It is modified if necessary to make it unique.
1327 BUFFER is the buffer (or buffer name) to associate with the process.
1329 Process output (both standard output and standard error streams) goes
1330 at end of BUFFER, unless you specify an output stream or filter
1331 function to handle the output. BUFFER may also be nil, meaning that
1332 this process is not associated with any buffer.
1334 PROGRAM is the program file name. It is searched for in `exec-path'
1335 (which see). If nil, just associate a pty with the buffer. Remaining
1336 arguments are strings to give program as arguments.
1338 If you want to separate standard output from standard error, invoke
1339 the command through a shell and redirect one of them using the shell
1340 syntax.
1342 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1343 (ptrdiff_t nargs, Lisp_Object *args)
1345 Lisp_Object buffer, name, program, proc, current_dir, tem;
1346 register unsigned char **new_argv;
1347 ptrdiff_t i;
1348 ptrdiff_t count = SPECPDL_INDEX ();
1350 buffer = args[1];
1351 if (!NILP (buffer))
1352 buffer = Fget_buffer_create (buffer);
1354 /* Make sure that the child will be able to chdir to the current
1355 buffer's current directory, or its unhandled equivalent. We
1356 can't just have the child check for an error when it does the
1357 chdir, since it's in a vfork.
1359 We have to GCPRO around this because Fexpand_file_name and
1360 Funhandled_file_name_directory might call a file name handling
1361 function. The argument list is protected by the caller, so all
1362 we really have to worry about is buffer. */
1364 struct gcpro gcpro1, gcpro2;
1366 current_dir = BVAR (current_buffer, directory);
1368 GCPRO2 (buffer, current_dir);
1370 current_dir = Funhandled_file_name_directory (current_dir);
1371 if (NILP (current_dir))
1372 /* If the file name handler says that current_dir is unreachable, use
1373 a sensible default. */
1374 current_dir = build_string ("~/");
1375 current_dir = expand_and_dir_to_file (current_dir, Qnil);
1376 if (NILP (Ffile_accessible_directory_p (current_dir)))
1377 report_file_error ("Setting current directory",
1378 Fcons (BVAR (current_buffer, directory), Qnil));
1380 UNGCPRO;
1383 name = args[0];
1384 CHECK_STRING (name);
1386 program = args[2];
1388 if (!NILP (program))
1389 CHECK_STRING (program);
1391 proc = make_process (name);
1392 /* If an error occurs and we can't start the process, we want to
1393 remove it from the process list. This means that each error
1394 check in create_process doesn't need to call remove_process
1395 itself; it's all taken care of here. */
1396 record_unwind_protect (start_process_unwind, proc);
1398 pset_childp (XPROCESS (proc), Qt);
1399 pset_plist (XPROCESS (proc), Qnil);
1400 pset_type (XPROCESS (proc), Qreal);
1401 pset_buffer (XPROCESS (proc), buffer);
1402 pset_sentinel (XPROCESS (proc), Qnil);
1403 pset_filter (XPROCESS (proc), Qnil);
1404 pset_command (XPROCESS (proc), Flist (nargs - 2, args + 2));
1406 #ifdef HAVE_GNUTLS
1407 /* AKA GNUTLS_INITSTAGE(proc). */
1408 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1409 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1410 #endif
1412 #ifdef ADAPTIVE_READ_BUFFERING
1413 XPROCESS (proc)->adaptive_read_buffering
1414 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1415 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1416 #endif
1418 /* Make the process marker point into the process buffer (if any). */
1419 if (BUFFERP (buffer))
1420 set_marker_both (XPROCESS (proc)->mark, buffer,
1421 BUF_ZV (XBUFFER (buffer)),
1422 BUF_ZV_BYTE (XBUFFER (buffer)));
1425 /* Decide coding systems for communicating with the process. Here
1426 we don't setup the structure coding_system nor pay attention to
1427 unibyte mode. They are done in create_process. */
1429 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1430 Lisp_Object coding_systems = Qt;
1431 Lisp_Object val, *args2;
1432 struct gcpro gcpro1, gcpro2;
1434 val = Vcoding_system_for_read;
1435 if (NILP (val))
1437 args2 = alloca ((nargs + 1) * sizeof *args2);
1438 args2[0] = Qstart_process;
1439 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1440 GCPRO2 (proc, current_dir);
1441 if (!NILP (program))
1442 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1443 UNGCPRO;
1444 if (CONSP (coding_systems))
1445 val = XCAR (coding_systems);
1446 else if (CONSP (Vdefault_process_coding_system))
1447 val = XCAR (Vdefault_process_coding_system);
1449 pset_decode_coding_system (XPROCESS (proc), val);
1451 val = Vcoding_system_for_write;
1452 if (NILP (val))
1454 if (EQ (coding_systems, Qt))
1456 args2 = alloca ((nargs + 1) * sizeof *args2);
1457 args2[0] = Qstart_process;
1458 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1459 GCPRO2 (proc, current_dir);
1460 if (!NILP (program))
1461 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1462 UNGCPRO;
1464 if (CONSP (coding_systems))
1465 val = XCDR (coding_systems);
1466 else if (CONSP (Vdefault_process_coding_system))
1467 val = XCDR (Vdefault_process_coding_system);
1469 pset_encode_coding_system (XPROCESS (proc), val);
1470 /* Note: At this moment, the above coding system may leave
1471 text-conversion or eol-conversion unspecified. They will be
1472 decided after we read output from the process and decode it by
1473 some coding system, or just before we actually send a text to
1474 the process. */
1478 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1479 XPROCESS (proc)->decoding_carryover = 0;
1480 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1482 XPROCESS (proc)->inherit_coding_system_flag
1483 = !(NILP (buffer) || !inherit_process_coding_system);
1485 if (!NILP (program))
1487 /* If program file name is not absolute, search our path for it.
1488 Put the name we will really use in TEM. */
1489 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1490 && !(SCHARS (program) > 1
1491 && IS_DEVICE_SEP (SREF (program, 1))))
1493 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1495 tem = Qnil;
1496 GCPRO4 (name, program, buffer, current_dir);
1497 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1498 UNGCPRO;
1499 if (NILP (tem))
1500 report_file_error ("Searching for program", Fcons (program, Qnil));
1501 tem = Fexpand_file_name (tem, Qnil);
1503 else
1505 if (!NILP (Ffile_directory_p (program)))
1506 error ("Specified program for new process is a directory");
1507 tem = program;
1510 /* If program file name starts with /: for quoting a magic name,
1511 discard that. */
1512 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1513 && SREF (tem, 1) == ':')
1514 tem = Fsubstring (tem, make_number (2), Qnil);
1517 Lisp_Object arg_encoding = Qnil;
1518 struct gcpro gcpro1;
1519 GCPRO1 (tem);
1521 /* Encode the file name and put it in NEW_ARGV.
1522 That's where the child will use it to execute the program. */
1523 tem = Fcons (ENCODE_FILE (tem), Qnil);
1525 /* Here we encode arguments by the coding system used for sending
1526 data to the process. We don't support using different coding
1527 systems for encoding arguments and for encoding data sent to the
1528 process. */
1530 for (i = 3; i < nargs; i++)
1532 tem = Fcons (args[i], tem);
1533 CHECK_STRING (XCAR (tem));
1534 if (STRING_MULTIBYTE (XCAR (tem)))
1536 if (NILP (arg_encoding))
1537 arg_encoding = (complement_process_encoding_system
1538 (XPROCESS (proc)->encode_coding_system));
1539 XSETCAR (tem,
1540 code_convert_string_norecord
1541 (XCAR (tem), arg_encoding, 1));
1545 UNGCPRO;
1548 /* Now that everything is encoded we can collect the strings into
1549 NEW_ARGV. */
1550 new_argv = alloca ((nargs - 1) * sizeof *new_argv);
1551 new_argv[nargs - 2] = 0;
1553 for (i = nargs - 2; i-- != 0; )
1555 new_argv[i] = SDATA (XCAR (tem));
1556 tem = XCDR (tem);
1559 create_process (proc, (char **) new_argv, current_dir);
1561 else
1562 create_pty (proc);
1564 return unbind_to (count, proc);
1567 /* This function is the unwind_protect form for Fstart_process. If
1568 PROC doesn't have its pid set, then we know someone has signaled
1569 an error and the process wasn't started successfully, so we should
1570 remove it from the process list. */
1571 static Lisp_Object
1572 start_process_unwind (Lisp_Object proc)
1574 if (!PROCESSP (proc))
1575 emacs_abort ();
1577 /* Was PROC started successfully?
1578 -2 is used for a pty with no process, eg for gdb. */
1579 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1580 remove_process (proc);
1582 return Qnil;
1585 static void
1586 create_process_1 (struct atimer *timer)
1588 /* Nothing to do. */
1592 static void
1593 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1595 int inchannel, outchannel;
1596 pid_t pid;
1597 int sv[2];
1598 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1599 int wait_child_setup[2];
1600 #endif
1601 #ifdef SIGCHLD
1602 sigset_t blocked;
1603 #endif
1604 /* Use volatile to protect variables from being clobbered by vfork. */
1605 volatile int forkin, forkout;
1606 volatile int pty_flag = 0;
1607 volatile Lisp_Object lisp_pty_name = Qnil;
1608 volatile Lisp_Object encoded_current_dir;
1609 #if HAVE_WORKING_VFORK
1610 char **volatile save_environ;
1611 #endif
1613 inchannel = outchannel = -1;
1615 #ifdef HAVE_PTYS
1616 if (!NILP (Vprocess_connection_type))
1617 outchannel = inchannel = allocate_pty ();
1619 if (inchannel >= 0)
1621 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1622 /* On most USG systems it does not work to open the pty's tty here,
1623 then close it and reopen it in the child. */
1624 #ifdef O_NOCTTY
1625 /* Don't let this terminal become our controlling terminal
1626 (in case we don't have one). */
1627 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1628 #else
1629 forkout = forkin = emacs_open (pty_name, O_RDWR, 0);
1630 #endif
1631 if (forkin < 0)
1632 report_file_error ("Opening pty", Qnil);
1633 #else
1634 forkin = forkout = -1;
1635 #endif /* not USG, or USG_SUBTTY_WORKS */
1636 pty_flag = 1;
1637 lisp_pty_name = build_string (pty_name);
1639 else
1640 #endif /* HAVE_PTYS */
1642 int tem;
1643 tem = pipe (sv);
1644 if (tem < 0)
1645 report_file_error ("Creating pipe", Qnil);
1646 inchannel = sv[0];
1647 forkout = sv[1];
1648 tem = pipe (sv);
1649 if (tem < 0)
1651 emacs_close (inchannel);
1652 emacs_close (forkout);
1653 report_file_error ("Creating pipe", Qnil);
1655 outchannel = sv[1];
1656 forkin = sv[0];
1659 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1661 int tem;
1663 tem = pipe (wait_child_setup);
1664 if (tem < 0)
1665 report_file_error ("Creating pipe", Qnil);
1666 tem = fcntl (wait_child_setup[1], F_GETFD, 0);
1667 if (tem >= 0)
1668 tem = fcntl (wait_child_setup[1], F_SETFD, tem | FD_CLOEXEC);
1669 if (tem < 0)
1671 emacs_close (wait_child_setup[0]);
1672 emacs_close (wait_child_setup[1]);
1673 report_file_error ("Setting file descriptor flags", Qnil);
1676 #endif
1678 #ifdef O_NONBLOCK
1679 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1680 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1681 #else
1682 #ifdef O_NDELAY
1683 fcntl (inchannel, F_SETFL, O_NDELAY);
1684 fcntl (outchannel, F_SETFL, O_NDELAY);
1685 #endif
1686 #endif
1688 /* Record this as an active process, with its channels.
1689 As a result, child_setup will close Emacs's side of the pipes. */
1690 chan_process[inchannel] = process;
1691 XPROCESS (process)->infd = inchannel;
1692 XPROCESS (process)->outfd = outchannel;
1694 /* Previously we recorded the tty descriptor used in the subprocess.
1695 It was only used for getting the foreground tty process, so now
1696 we just reopen the device (see emacs_get_tty_pgrp) as this is
1697 more portable (see USG_SUBTTY_WORKS above). */
1699 XPROCESS (process)->pty_flag = pty_flag;
1700 pset_status (XPROCESS (process), Qrun);
1702 FD_SET (inchannel, &input_wait_mask);
1703 FD_SET (inchannel, &non_keyboard_wait_mask);
1704 if (inchannel > max_process_desc)
1705 max_process_desc = inchannel;
1707 /* Until we store the proper pid, enable the SIGCHLD handler
1708 to recognize an unknown pid as standing for this process.
1709 It is very important not to let this `marker' value stay
1710 in the table after this function has returned; if it does
1711 it might cause call-process to hang and subsequent asynchronous
1712 processes to get their return values scrambled. */
1713 XPROCESS (process)->pid = -1;
1715 /* This must be called after the above line because it may signal an
1716 error. */
1717 setup_process_coding_systems (process);
1719 encoded_current_dir = ENCODE_FILE (current_dir);
1721 block_input ();
1723 #ifdef SIGCHLD
1724 /* Block SIGCHLD until we have a chance to store the new fork's
1725 pid in its process structure. */
1726 sigemptyset (&blocked);
1727 sigaddset (&blocked, SIGCHLD);
1728 pthread_sigmask (SIG_BLOCK, &blocked, 0);
1729 #endif
1731 #if HAVE_WORKING_VFORK
1732 /* child_setup must clobber environ on systems with true vfork.
1733 Protect it from permanent change. */
1734 save_environ = environ;
1735 #endif
1737 #ifndef WINDOWSNT
1738 pid = vfork ();
1739 if (pid == 0)
1740 #endif /* not WINDOWSNT */
1742 int xforkin = forkin;
1743 int xforkout = forkout;
1745 /* Make the pty be the controlling terminal of the process. */
1746 #ifdef HAVE_PTYS
1747 /* First, disconnect its current controlling terminal. */
1748 #ifdef HAVE_SETSID
1749 /* We tried doing setsid only if pty_flag, but it caused
1750 process_set_signal to fail on SGI when using a pipe. */
1751 setsid ();
1752 /* Make the pty's terminal the controlling terminal. */
1753 if (pty_flag && xforkin >= 0)
1755 #ifdef TIOCSCTTY
1756 /* We ignore the return value
1757 because faith@cs.unc.edu says that is necessary on Linux. */
1758 ioctl (xforkin, TIOCSCTTY, 0);
1759 #endif
1761 #else /* not HAVE_SETSID */
1762 /* It's very important to call setpgid here and no time
1763 afterwards. Otherwise, we lose our controlling tty which
1764 is set when we open the pty. */
1765 setpgid (0, 0);
1766 #endif /* not HAVE_SETSID */
1767 #if defined (LDISC1)
1768 if (pty_flag && xforkin >= 0)
1770 struct termios t;
1771 tcgetattr (xforkin, &t);
1772 t.c_lflag = LDISC1;
1773 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1774 emacs_write (1, "create_process/tcsetattr LDISC1 failed\n", 39);
1776 #else
1777 #if defined (NTTYDISC) && defined (TIOCSETD)
1778 if (pty_flag && xforkin >= 0)
1780 /* Use new line discipline. */
1781 int ldisc = NTTYDISC;
1782 ioctl (xforkin, TIOCSETD, &ldisc);
1784 #endif
1785 #endif
1786 #ifdef TIOCNOTTY
1787 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1788 can do TIOCSPGRP only to the process's controlling tty. */
1789 if (pty_flag)
1791 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1792 I can't test it since I don't have 4.3. */
1793 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1794 if (j >= 0)
1796 ioctl (j, TIOCNOTTY, 0);
1797 emacs_close (j);
1799 #ifndef USG
1800 /* In order to get a controlling terminal on some versions
1801 of BSD, it is necessary to put the process in pgrp 0
1802 before it opens the terminal. */
1803 setpgid (0, 0);
1804 #endif
1806 #endif /* TIOCNOTTY */
1808 #if !defined (DONT_REOPEN_PTY)
1809 /*** There is a suggestion that this ought to be a
1810 conditional on TIOCSPGRP,
1811 or !(defined (HAVE_SETSID) && defined (TIOCSCTTY)).
1812 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1813 that system does seem to need this code, even though
1814 both HAVE_SETSID and TIOCSCTTY are defined. */
1815 /* Now close the pty (if we had it open) and reopen it.
1816 This makes the pty the controlling terminal of the subprocess. */
1817 if (pty_flag)
1820 /* I wonder if emacs_close (emacs_open (pty_name, ...))
1821 would work? */
1822 if (xforkin >= 0)
1823 emacs_close (xforkin);
1824 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
1826 if (xforkin < 0)
1828 emacs_write (1, "Couldn't open the pty terminal ", 31);
1829 emacs_write (1, pty_name, strlen (pty_name));
1830 emacs_write (1, "\n", 1);
1831 _exit (1);
1835 #endif /* not DONT_REOPEN_PTY */
1837 #ifdef SETUP_SLAVE_PTY
1838 if (pty_flag)
1840 SETUP_SLAVE_PTY;
1842 #endif /* SETUP_SLAVE_PTY */
1843 #ifdef AIX
1844 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
1845 Now reenable it in the child, so it will die when we want it to. */
1846 if (pty_flag)
1847 signal (SIGHUP, SIG_DFL);
1848 #endif
1849 #endif /* HAVE_PTYS */
1851 signal (SIGINT, SIG_DFL);
1852 signal (SIGQUIT, SIG_DFL);
1854 /* Emacs ignores SIGPIPE, but the child should not. */
1855 signal (SIGPIPE, SIG_DFL);
1857 #ifdef SIGCHLD
1858 /* Stop blocking signals in the child. */
1859 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
1860 #endif
1862 if (pty_flag)
1863 child_setup_tty (xforkout);
1864 #ifdef WINDOWSNT
1865 pid = child_setup (xforkin, xforkout, xforkout,
1866 new_argv, 1, encoded_current_dir);
1867 #else /* not WINDOWSNT */
1868 #ifdef FD_CLOEXEC
1869 emacs_close (wait_child_setup[0]);
1870 #endif
1871 child_setup (xforkin, xforkout, xforkout,
1872 new_argv, 1, encoded_current_dir);
1873 #endif /* not WINDOWSNT */
1876 /* Back in the parent process. */
1878 #if HAVE_WORKING_VFORK
1879 environ = save_environ;
1880 #endif
1882 XPROCESS (process)->pid = pid;
1884 /* Stop blocking signals in the parent. */
1885 #ifdef SIGCHLD
1886 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
1887 #endif
1888 unblock_input ();
1890 if (pid < 0)
1892 if (forkin >= 0)
1893 emacs_close (forkin);
1894 if (forkin != forkout && forkout >= 0)
1895 emacs_close (forkout);
1897 else
1899 /* vfork succeeded. */
1901 #ifdef WINDOWSNT
1902 register_child (pid, inchannel);
1903 #endif /* WINDOWSNT */
1905 /* If the subfork execv fails, and it exits,
1906 this close hangs. I don't know why.
1907 So have an interrupt jar it loose. */
1909 struct atimer *timer;
1910 EMACS_TIME offset = make_emacs_time (1, 0);
1912 stop_polling ();
1913 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
1915 if (forkin >= 0)
1916 emacs_close (forkin);
1918 cancel_atimer (timer);
1919 start_polling ();
1922 if (forkin != forkout && forkout >= 0)
1923 emacs_close (forkout);
1925 pset_tty_name (XPROCESS (process), lisp_pty_name);
1927 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1928 /* Wait for child_setup to complete in case that vfork is
1929 actually defined as fork. The descriptor wait_child_setup[1]
1930 of a pipe is closed at the child side either by close-on-exec
1931 on successful execvp or the _exit call in child_setup. */
1933 char dummy;
1935 emacs_close (wait_child_setup[1]);
1936 emacs_read (wait_child_setup[0], &dummy, 1);
1937 emacs_close (wait_child_setup[0]);
1939 #endif
1942 /* Now generate the error if vfork failed. */
1943 if (pid < 0)
1944 report_file_error ("Doing vfork", Qnil);
1947 void
1948 create_pty (Lisp_Object process)
1950 int inchannel, outchannel;
1951 int pty_flag = 0;
1953 inchannel = outchannel = -1;
1955 #ifdef HAVE_PTYS
1956 if (!NILP (Vprocess_connection_type))
1957 outchannel = inchannel = allocate_pty ();
1959 if (inchannel >= 0)
1961 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1962 /* On most USG systems it does not work to open the pty's tty here,
1963 then close it and reopen it in the child. */
1964 #ifdef O_NOCTTY
1965 /* Don't let this terminal become our controlling terminal
1966 (in case we don't have one). */
1967 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1968 #else
1969 int forkout = emacs_open (pty_name, O_RDWR, 0);
1970 #endif
1971 if (forkout < 0)
1972 report_file_error ("Opening pty", Qnil);
1973 #if defined (DONT_REOPEN_PTY)
1974 /* In the case that vfork is defined as fork, the parent process
1975 (Emacs) may send some data before the child process completes
1976 tty options setup. So we setup tty before forking. */
1977 child_setup_tty (forkout);
1978 #endif /* DONT_REOPEN_PTY */
1979 #endif /* not USG, or USG_SUBTTY_WORKS */
1980 pty_flag = 1;
1982 #endif /* HAVE_PTYS */
1984 #ifdef O_NONBLOCK
1985 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1986 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1987 #else
1988 #ifdef O_NDELAY
1989 fcntl (inchannel, F_SETFL, O_NDELAY);
1990 fcntl (outchannel, F_SETFL, O_NDELAY);
1991 #endif
1992 #endif
1994 /* Record this as an active process, with its channels.
1995 As a result, child_setup will close Emacs's side of the pipes. */
1996 chan_process[inchannel] = process;
1997 XPROCESS (process)->infd = inchannel;
1998 XPROCESS (process)->outfd = outchannel;
2000 /* Previously we recorded the tty descriptor used in the subprocess.
2001 It was only used for getting the foreground tty process, so now
2002 we just reopen the device (see emacs_get_tty_pgrp) as this is
2003 more portable (see USG_SUBTTY_WORKS above). */
2005 XPROCESS (process)->pty_flag = pty_flag;
2006 pset_status (XPROCESS (process), Qrun);
2007 setup_process_coding_systems (process);
2009 FD_SET (inchannel, &input_wait_mask);
2010 FD_SET (inchannel, &non_keyboard_wait_mask);
2011 if (inchannel > max_process_desc)
2012 max_process_desc = inchannel;
2014 XPROCESS (process)->pid = -2;
2015 #ifdef HAVE_PTYS
2016 if (pty_flag)
2017 pset_tty_name (XPROCESS (process), build_string (pty_name));
2018 else
2019 #endif
2020 pset_tty_name (XPROCESS (process), Qnil);
2024 /* Convert an internal struct sockaddr to a lisp object (vector or string).
2025 The address family of sa is not included in the result. */
2027 static Lisp_Object
2028 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
2030 Lisp_Object address;
2031 int i;
2032 unsigned char *cp;
2033 register struct Lisp_Vector *p;
2035 /* Workaround for a bug in getsockname on BSD: Names bound to
2036 sockets in the UNIX domain are inaccessible; getsockname returns
2037 a zero length name. */
2038 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
2039 return empty_unibyte_string;
2041 switch (sa->sa_family)
2043 case AF_INET:
2045 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2046 len = sizeof (sin->sin_addr) + 1;
2047 address = Fmake_vector (make_number (len), Qnil);
2048 p = XVECTOR (address);
2049 p->contents[--len] = make_number (ntohs (sin->sin_port));
2050 cp = (unsigned char *) &sin->sin_addr;
2051 break;
2053 #ifdef AF_INET6
2054 case AF_INET6:
2056 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2057 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
2058 len = sizeof (sin6->sin6_addr)/2 + 1;
2059 address = Fmake_vector (make_number (len), Qnil);
2060 p = XVECTOR (address);
2061 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2062 for (i = 0; i < len; i++)
2063 p->contents[i] = make_number (ntohs (ip6[i]));
2064 return address;
2066 #endif
2067 #ifdef HAVE_LOCAL_SOCKETS
2068 case AF_LOCAL:
2070 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2071 for (i = 0; i < sizeof (sockun->sun_path); i++)
2072 if (sockun->sun_path[i] == 0)
2073 break;
2074 return make_unibyte_string (sockun->sun_path, i);
2076 #endif
2077 default:
2078 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2079 address = Fcons (make_number (sa->sa_family),
2080 Fmake_vector (make_number (len), Qnil));
2081 p = XVECTOR (XCDR (address));
2082 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2083 break;
2086 i = 0;
2087 while (i < len)
2088 p->contents[i++] = make_number (*cp++);
2090 return address;
2094 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2096 static int
2097 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2099 register struct Lisp_Vector *p;
2101 if (VECTORP (address))
2103 p = XVECTOR (address);
2104 if (p->header.size == 5)
2106 *familyp = AF_INET;
2107 return sizeof (struct sockaddr_in);
2109 #ifdef AF_INET6
2110 else if (p->header.size == 9)
2112 *familyp = AF_INET6;
2113 return sizeof (struct sockaddr_in6);
2115 #endif
2117 #ifdef HAVE_LOCAL_SOCKETS
2118 else if (STRINGP (address))
2120 *familyp = AF_LOCAL;
2121 return sizeof (struct sockaddr_un);
2123 #endif
2124 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2125 && VECTORP (XCDR (address)))
2127 struct sockaddr *sa;
2128 *familyp = XINT (XCAR (address));
2129 p = XVECTOR (XCDR (address));
2130 return p->header.size + sizeof (sa->sa_family);
2132 return 0;
2135 /* Convert an address object (vector or string) to an internal sockaddr.
2137 The address format has been basically validated by
2138 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2139 it could have come from user data. So if FAMILY is not valid,
2140 we return after zeroing *SA. */
2142 static void
2143 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2145 register struct Lisp_Vector *p;
2146 register unsigned char *cp = NULL;
2147 register int i;
2148 EMACS_INT hostport;
2150 memset (sa, 0, len);
2152 if (VECTORP (address))
2154 p = XVECTOR (address);
2155 if (family == AF_INET)
2157 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2158 len = sizeof (sin->sin_addr) + 1;
2159 hostport = XINT (p->contents[--len]);
2160 sin->sin_port = htons (hostport);
2161 cp = (unsigned char *)&sin->sin_addr;
2162 sa->sa_family = family;
2164 #ifdef AF_INET6
2165 else if (family == AF_INET6)
2167 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2168 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2169 len = sizeof (sin6->sin6_addr) + 1;
2170 hostport = XINT (p->contents[--len]);
2171 sin6->sin6_port = htons (hostport);
2172 for (i = 0; i < len; i++)
2173 if (INTEGERP (p->contents[i]))
2175 int j = XFASTINT (p->contents[i]) & 0xffff;
2176 ip6[i] = ntohs (j);
2178 sa->sa_family = family;
2179 return;
2181 #endif
2182 else
2183 return;
2185 else if (STRINGP (address))
2187 #ifdef HAVE_LOCAL_SOCKETS
2188 if (family == AF_LOCAL)
2190 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2191 cp = SDATA (address);
2192 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2193 sockun->sun_path[i] = *cp++;
2194 sa->sa_family = family;
2196 #endif
2197 return;
2199 else
2201 p = XVECTOR (XCDR (address));
2202 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2205 for (i = 0; i < len; i++)
2206 if (INTEGERP (p->contents[i]))
2207 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2210 #ifdef DATAGRAM_SOCKETS
2211 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2212 1, 1, 0,
2213 doc: /* Get the current datagram address associated with PROCESS. */)
2214 (Lisp_Object process)
2216 int channel;
2218 CHECK_PROCESS (process);
2220 if (!DATAGRAM_CONN_P (process))
2221 return Qnil;
2223 channel = XPROCESS (process)->infd;
2224 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2225 datagram_address[channel].len);
2228 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2229 2, 2, 0,
2230 doc: /* Set the datagram address for PROCESS to ADDRESS.
2231 Returns nil upon error setting address, ADDRESS otherwise. */)
2232 (Lisp_Object process, Lisp_Object address)
2234 int channel;
2235 int family, len;
2237 CHECK_PROCESS (process);
2239 if (!DATAGRAM_CONN_P (process))
2240 return Qnil;
2242 channel = XPROCESS (process)->infd;
2244 len = get_lisp_to_sockaddr_size (address, &family);
2245 if (datagram_address[channel].len != len)
2246 return Qnil;
2247 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2248 return address;
2250 #endif
2253 static const struct socket_options {
2254 /* The name of this option. Should be lowercase version of option
2255 name without SO_ prefix. */
2256 const char *name;
2257 /* Option level SOL_... */
2258 int optlevel;
2259 /* Option number SO_... */
2260 int optnum;
2261 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2262 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2263 } socket_options[] =
2265 #ifdef SO_BINDTODEVICE
2266 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2267 #endif
2268 #ifdef SO_BROADCAST
2269 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2270 #endif
2271 #ifdef SO_DONTROUTE
2272 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2273 #endif
2274 #ifdef SO_KEEPALIVE
2275 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2276 #endif
2277 #ifdef SO_LINGER
2278 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2279 #endif
2280 #ifdef SO_OOBINLINE
2281 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2282 #endif
2283 #ifdef SO_PRIORITY
2284 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2285 #endif
2286 #ifdef SO_REUSEADDR
2287 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2288 #endif
2289 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2292 /* Set option OPT to value VAL on socket S.
2294 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2295 Signals an error if setting a known option fails.
2298 static int
2299 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2301 char *name;
2302 const struct socket_options *sopt;
2303 int ret = 0;
2305 CHECK_SYMBOL (opt);
2307 name = SSDATA (SYMBOL_NAME (opt));
2308 for (sopt = socket_options; sopt->name; sopt++)
2309 if (strcmp (name, sopt->name) == 0)
2310 break;
2312 switch (sopt->opttype)
2314 case SOPT_BOOL:
2316 int optval;
2317 optval = NILP (val) ? 0 : 1;
2318 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2319 &optval, sizeof (optval));
2320 break;
2323 case SOPT_INT:
2325 int optval;
2326 if (TYPE_RANGED_INTEGERP (int, val))
2327 optval = XINT (val);
2328 else
2329 error ("Bad option value for %s", name);
2330 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2331 &optval, sizeof (optval));
2332 break;
2335 #ifdef SO_BINDTODEVICE
2336 case SOPT_IFNAME:
2338 char devname[IFNAMSIZ+1];
2340 /* This is broken, at least in the Linux 2.4 kernel.
2341 To unbind, the arg must be a zero integer, not the empty string.
2342 This should work on all systems. KFS. 2003-09-23. */
2343 memset (devname, 0, sizeof devname);
2344 if (STRINGP (val))
2346 char *arg = SSDATA (val);
2347 int len = min (strlen (arg), IFNAMSIZ);
2348 memcpy (devname, arg, len);
2350 else if (!NILP (val))
2351 error ("Bad option value for %s", name);
2352 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2353 devname, IFNAMSIZ);
2354 break;
2356 #endif
2358 #ifdef SO_LINGER
2359 case SOPT_LINGER:
2361 struct linger linger;
2363 linger.l_onoff = 1;
2364 linger.l_linger = 0;
2365 if (TYPE_RANGED_INTEGERP (int, val))
2366 linger.l_linger = XINT (val);
2367 else
2368 linger.l_onoff = NILP (val) ? 0 : 1;
2369 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2370 &linger, sizeof (linger));
2371 break;
2373 #endif
2375 default:
2376 return 0;
2379 if (ret < 0)
2380 report_file_error ("Cannot set network option",
2381 Fcons (opt, Fcons (val, Qnil)));
2382 return (1 << sopt->optbit);
2386 DEFUN ("set-network-process-option",
2387 Fset_network_process_option, Sset_network_process_option,
2388 3, 4, 0,
2389 doc: /* For network process PROCESS set option OPTION to value VALUE.
2390 See `make-network-process' for a list of options and values.
2391 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2392 OPTION is not a supported option, return nil instead; otherwise return t. */)
2393 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2395 int s;
2396 struct Lisp_Process *p;
2398 CHECK_PROCESS (process);
2399 p = XPROCESS (process);
2400 if (!NETCONN1_P (p))
2401 error ("Process is not a network process");
2403 s = p->infd;
2404 if (s < 0)
2405 error ("Process is not running");
2407 if (set_socket_option (s, option, value))
2409 pset_childp (p, Fplist_put (p->childp, option, value));
2410 return Qt;
2413 if (NILP (no_error))
2414 error ("Unknown or unsupported option");
2416 return Qnil;
2420 DEFUN ("serial-process-configure",
2421 Fserial_process_configure,
2422 Sserial_process_configure,
2423 0, MANY, 0,
2424 doc: /* Configure speed, bytesize, etc. of a serial process.
2426 Arguments are specified as keyword/argument pairs. Attributes that
2427 are not given are re-initialized from the process's current
2428 configuration (available via the function `process-contact') or set to
2429 reasonable default values. The following arguments are defined:
2431 :process PROCESS
2432 :name NAME
2433 :buffer BUFFER
2434 :port PORT
2435 -- Any of these arguments can be given to identify the process that is
2436 to be configured. If none of these arguments is given, the current
2437 buffer's process is used.
2439 :speed SPEED -- SPEED is the speed of the serial port in bits per
2440 second, also called baud rate. Any value can be given for SPEED, but
2441 most serial ports work only at a few defined values between 1200 and
2442 115200, with 9600 being the most common value. If SPEED is nil, the
2443 serial port is not configured any further, i.e., all other arguments
2444 are ignored. This may be useful for special serial ports such as
2445 Bluetooth-to-serial converters which can only be configured through AT
2446 commands. A value of nil for SPEED can be used only when passed
2447 through `make-serial-process' or `serial-term'.
2449 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2450 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2452 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2453 `odd' (use odd parity), or the symbol `even' (use even parity). If
2454 PARITY is not given, no parity is used.
2456 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2457 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2458 is not given or nil, 1 stopbit is used.
2460 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2461 flowcontrol to be used, which is either nil (don't use flowcontrol),
2462 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2463 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2464 flowcontrol is used.
2466 `serial-process-configure' is called by `make-serial-process' for the
2467 initial configuration of the serial port.
2469 Examples:
2471 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2473 \(serial-process-configure
2474 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2476 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2478 usage: (serial-process-configure &rest ARGS) */)
2479 (ptrdiff_t nargs, Lisp_Object *args)
2481 struct Lisp_Process *p;
2482 Lisp_Object contact = Qnil;
2483 Lisp_Object proc = Qnil;
2484 struct gcpro gcpro1;
2486 contact = Flist (nargs, args);
2487 GCPRO1 (contact);
2489 proc = Fplist_get (contact, QCprocess);
2490 if (NILP (proc))
2491 proc = Fplist_get (contact, QCname);
2492 if (NILP (proc))
2493 proc = Fplist_get (contact, QCbuffer);
2494 if (NILP (proc))
2495 proc = Fplist_get (contact, QCport);
2496 proc = get_process (proc);
2497 p = XPROCESS (proc);
2498 if (!EQ (p->type, Qserial))
2499 error ("Not a serial process");
2501 if (NILP (Fplist_get (p->childp, QCspeed)))
2503 UNGCPRO;
2504 return Qnil;
2507 serial_configure (p, contact);
2509 UNGCPRO;
2510 return Qnil;
2513 /* Used by make-serial-process to recover from errors. */
2514 static Lisp_Object
2515 make_serial_process_unwind (Lisp_Object proc)
2517 if (!PROCESSP (proc))
2518 emacs_abort ();
2519 remove_process (proc);
2520 return Qnil;
2523 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2524 0, MANY, 0,
2525 doc: /* Create and return a serial port process.
2527 In Emacs, serial port connections are represented by process objects,
2528 so input and output work as for subprocesses, and `delete-process'
2529 closes a serial port connection. However, a serial process has no
2530 process id, it cannot be signaled, and the status codes are different
2531 from normal processes.
2533 `make-serial-process' creates a process and a buffer, on which you
2534 probably want to use `process-send-string'. Try \\[serial-term] for
2535 an interactive terminal. See below for examples.
2537 Arguments are specified as keyword/argument pairs. The following
2538 arguments are defined:
2540 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2541 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2542 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2543 the backslashes in strings).
2545 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2546 which this function calls.
2548 :name NAME -- NAME is the name of the process. If NAME is not given,
2549 the value of PORT is used.
2551 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2552 with the process. Process output goes at the end of that buffer,
2553 unless you specify an output stream or filter function to handle the
2554 output. If BUFFER is not given, the value of NAME is used.
2556 :coding CODING -- If CODING is a symbol, it specifies the coding
2557 system used for both reading and writing for this process. If CODING
2558 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2559 ENCODING is used for writing.
2561 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2562 the process is running. If BOOL is not given, query before exiting.
2564 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2565 In the stopped state, a serial process does not accept incoming data,
2566 but you can send outgoing data. The stopped state is cleared by
2567 `continue-process' and set by `stop-process'.
2569 :filter FILTER -- Install FILTER as the process filter.
2571 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2573 :plist PLIST -- Install PLIST as the initial plist of the process.
2575 :bytesize
2576 :parity
2577 :stopbits
2578 :flowcontrol
2579 -- This function calls `serial-process-configure' to handle these
2580 arguments.
2582 The original argument list, possibly modified by later configuration,
2583 is available via the function `process-contact'.
2585 Examples:
2587 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2589 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2591 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2593 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2595 usage: (make-serial-process &rest ARGS) */)
2596 (ptrdiff_t nargs, Lisp_Object *args)
2598 int fd = -1;
2599 Lisp_Object proc, contact, port;
2600 struct Lisp_Process *p;
2601 struct gcpro gcpro1;
2602 Lisp_Object name, buffer;
2603 Lisp_Object tem, val;
2604 ptrdiff_t specpdl_count = -1;
2606 if (nargs == 0)
2607 return Qnil;
2609 contact = Flist (nargs, args);
2610 GCPRO1 (contact);
2612 port = Fplist_get (contact, QCport);
2613 if (NILP (port))
2614 error ("No port specified");
2615 CHECK_STRING (port);
2617 if (NILP (Fplist_member (contact, QCspeed)))
2618 error (":speed not specified");
2619 if (!NILP (Fplist_get (contact, QCspeed)))
2620 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2622 name = Fplist_get (contact, QCname);
2623 if (NILP (name))
2624 name = port;
2625 CHECK_STRING (name);
2626 proc = make_process (name);
2627 specpdl_count = SPECPDL_INDEX ();
2628 record_unwind_protect (make_serial_process_unwind, proc);
2629 p = XPROCESS (proc);
2631 fd = serial_open (SSDATA (port));
2632 p->infd = fd;
2633 p->outfd = fd;
2634 if (fd > max_process_desc)
2635 max_process_desc = fd;
2636 chan_process[fd] = proc;
2638 buffer = Fplist_get (contact, QCbuffer);
2639 if (NILP (buffer))
2640 buffer = name;
2641 buffer = Fget_buffer_create (buffer);
2642 pset_buffer (p, buffer);
2644 pset_childp (p, contact);
2645 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2646 pset_type (p, Qserial);
2647 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2648 pset_filter (p, Fplist_get (contact, QCfilter));
2649 pset_log (p, Qnil);
2650 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2651 p->kill_without_query = 1;
2652 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2653 pset_command (p, Qt);
2654 p->pty_flag = 0;
2656 if (!EQ (p->command, Qt))
2658 FD_SET (fd, &input_wait_mask);
2659 FD_SET (fd, &non_keyboard_wait_mask);
2662 if (BUFFERP (buffer))
2664 set_marker_both (p->mark, buffer,
2665 BUF_ZV (XBUFFER (buffer)),
2666 BUF_ZV_BYTE (XBUFFER (buffer)));
2669 tem = Fplist_member (contact, QCcoding);
2670 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2671 tem = Qnil;
2673 val = Qnil;
2674 if (!NILP (tem))
2676 val = XCAR (XCDR (tem));
2677 if (CONSP (val))
2678 val = XCAR (val);
2680 else if (!NILP (Vcoding_system_for_read))
2681 val = Vcoding_system_for_read;
2682 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2683 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2684 val = Qnil;
2685 pset_decode_coding_system (p, val);
2687 val = Qnil;
2688 if (!NILP (tem))
2690 val = XCAR (XCDR (tem));
2691 if (CONSP (val))
2692 val = XCDR (val);
2694 else if (!NILP (Vcoding_system_for_write))
2695 val = Vcoding_system_for_write;
2696 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2697 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2698 val = Qnil;
2699 pset_encode_coding_system (p, val);
2701 setup_process_coding_systems (proc);
2702 pset_decoding_buf (p, empty_unibyte_string);
2703 p->decoding_carryover = 0;
2704 pset_encoding_buf (p, empty_unibyte_string);
2705 p->inherit_coding_system_flag
2706 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2708 Fserial_process_configure (nargs, args);
2710 specpdl_ptr = specpdl + specpdl_count;
2712 UNGCPRO;
2713 return proc;
2716 /* Create a network stream/datagram client/server process. Treated
2717 exactly like a normal process when reading and writing. Primary
2718 differences are in status display and process deletion. A network
2719 connection has no PID; you cannot signal it. All you can do is
2720 stop/continue it and deactivate/close it via delete-process */
2722 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2723 0, MANY, 0,
2724 doc: /* Create and return a network server or client process.
2726 In Emacs, network connections are represented by process objects, so
2727 input and output work as for subprocesses and `delete-process' closes
2728 a network connection. However, a network process has no process id,
2729 it cannot be signaled, and the status codes are different from normal
2730 processes.
2732 Arguments are specified as keyword/argument pairs. The following
2733 arguments are defined:
2735 :name NAME -- NAME is name for process. It is modified if necessary
2736 to make it unique.
2738 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2739 with the process. Process output goes at end of that buffer, unless
2740 you specify an output stream or filter function to handle the output.
2741 BUFFER may be also nil, meaning that this process is not associated
2742 with any buffer.
2744 :host HOST -- HOST is name of the host to connect to, or its IP
2745 address. The symbol `local' specifies the local host. If specified
2746 for a server process, it must be a valid name or address for the local
2747 host, and only clients connecting to that address will be accepted.
2749 :service SERVICE -- SERVICE is name of the service desired, or an
2750 integer specifying a port number to connect to. If SERVICE is t,
2751 a random port number is selected for the server. (If Emacs was
2752 compiled with getaddrinfo, a port number can also be specified as a
2753 string, e.g. "80", as well as an integer. This is not portable.)
2755 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2756 stream type connection, `datagram' creates a datagram type connection,
2757 `seqpacket' creates a reliable datagram connection.
2759 :family FAMILY -- FAMILY is the address (and protocol) family for the
2760 service specified by HOST and SERVICE. The default (nil) is to use
2761 whatever address family (IPv4 or IPv6) that is defined for the host
2762 and port number specified by HOST and SERVICE. Other address families
2763 supported are:
2764 local -- for a local (i.e. UNIX) address specified by SERVICE.
2765 ipv4 -- use IPv4 address family only.
2766 ipv6 -- use IPv6 address family only.
2768 :local ADDRESS -- ADDRESS is the local address used for the connection.
2769 This parameter is ignored when opening a client process. When specified
2770 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2772 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2773 connection. This parameter is ignored when opening a stream server
2774 process. For a datagram server process, it specifies the initial
2775 setting of the remote datagram address. When specified for a client
2776 process, the FAMILY, HOST, and SERVICE args are ignored.
2778 The format of ADDRESS depends on the address family:
2779 - An IPv4 address is represented as an vector of integers [A B C D P]
2780 corresponding to numeric IP address A.B.C.D and port number P.
2781 - A local address is represented as a string with the address in the
2782 local address space.
2783 - An "unsupported family" address is represented by a cons (F . AV)
2784 where F is the family number and AV is a vector containing the socket
2785 address data with one element per address data byte. Do not rely on
2786 this format in portable code, as it may depend on implementation
2787 defined constants, data sizes, and data structure alignment.
2789 :coding CODING -- If CODING is a symbol, it specifies the coding
2790 system used for both reading and writing for this process. If CODING
2791 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2792 ENCODING is used for writing.
2794 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2795 return without waiting for the connection to complete; instead, the
2796 sentinel function will be called with second arg matching "open" (if
2797 successful) or "failed" when the connect completes. Default is to use
2798 a blocking connect (i.e. wait) for stream type connections.
2800 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2801 running when Emacs is exited.
2803 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2804 In the stopped state, a server process does not accept new
2805 connections, and a client process does not handle incoming traffic.
2806 The stopped state is cleared by `continue-process' and set by
2807 `stop-process'.
2809 :filter FILTER -- Install FILTER as the process filter.
2811 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2812 process filter are multibyte, otherwise they are unibyte.
2813 If this keyword is not specified, the strings are multibyte if
2814 the default value of `enable-multibyte-characters' is non-nil.
2816 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2818 :log LOG -- Install LOG as the server process log function. This
2819 function is called when the server accepts a network connection from a
2820 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2821 is the server process, CLIENT is the new process for the connection,
2822 and MESSAGE is a string.
2824 :plist PLIST -- Install PLIST as the new process' initial plist.
2826 :server QLEN -- if QLEN is non-nil, create a server process for the
2827 specified FAMILY, SERVICE, and connection type (stream or datagram).
2828 If QLEN is an integer, it is used as the max. length of the server's
2829 pending connection queue (also known as the backlog); the default
2830 queue length is 5. Default is to create a client process.
2832 The following network options can be specified for this connection:
2834 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2835 :dontroute BOOL -- Only send to directly connected hosts.
2836 :keepalive BOOL -- Send keep-alive messages on network stream.
2837 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2838 :oobinline BOOL -- Place out-of-band data in receive data stream.
2839 :priority INT -- Set protocol defined priority for sent packets.
2840 :reuseaddr BOOL -- Allow reusing a recently used local address
2841 (this is allowed by default for a server process).
2842 :bindtodevice NAME -- bind to interface NAME. Using this may require
2843 special privileges on some systems.
2845 Consult the relevant system programmer's manual pages for more
2846 information on using these options.
2849 A server process will listen for and accept connections from clients.
2850 When a client connection is accepted, a new network process is created
2851 for the connection with the following parameters:
2853 - The client's process name is constructed by concatenating the server
2854 process' NAME and a client identification string.
2855 - If the FILTER argument is non-nil, the client process will not get a
2856 separate process buffer; otherwise, the client's process buffer is a newly
2857 created buffer named after the server process' BUFFER name or process
2858 NAME concatenated with the client identification string.
2859 - The connection type and the process filter and sentinel parameters are
2860 inherited from the server process' TYPE, FILTER and SENTINEL.
2861 - The client process' contact info is set according to the client's
2862 addressing information (typically an IP address and a port number).
2863 - The client process' plist is initialized from the server's plist.
2865 Notice that the FILTER and SENTINEL args are never used directly by
2866 the server process. Also, the BUFFER argument is not used directly by
2867 the server process, but via the optional :log function, accepted (and
2868 failed) connections may be logged in the server process' buffer.
2870 The original argument list, modified with the actual connection
2871 information, is available via the `process-contact' function.
2873 usage: (make-network-process &rest ARGS) */)
2874 (ptrdiff_t nargs, Lisp_Object *args)
2876 Lisp_Object proc;
2877 Lisp_Object contact;
2878 struct Lisp_Process *p;
2879 #ifdef HAVE_GETADDRINFO
2880 struct addrinfo ai, *res, *lres;
2881 struct addrinfo hints;
2882 const char *portstring;
2883 char portbuf[128];
2884 #else /* HAVE_GETADDRINFO */
2885 struct _emacs_addrinfo
2887 int ai_family;
2888 int ai_socktype;
2889 int ai_protocol;
2890 int ai_addrlen;
2891 struct sockaddr *ai_addr;
2892 struct _emacs_addrinfo *ai_next;
2893 } ai, *res, *lres;
2894 #endif /* HAVE_GETADDRINFO */
2895 struct sockaddr_in address_in;
2896 #ifdef HAVE_LOCAL_SOCKETS
2897 struct sockaddr_un address_un;
2898 #endif
2899 int port;
2900 int ret = 0;
2901 int xerrno = 0;
2902 int s = -1, outch, inch;
2903 struct gcpro gcpro1;
2904 ptrdiff_t count = SPECPDL_INDEX ();
2905 ptrdiff_t count1;
2906 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2907 Lisp_Object tem;
2908 Lisp_Object name, buffer, host, service, address;
2909 Lisp_Object filter, sentinel;
2910 int is_non_blocking_client = 0;
2911 int is_server = 0, backlog = 5;
2912 int socktype;
2913 int family = -1;
2915 if (nargs == 0)
2916 return Qnil;
2918 /* Save arguments for process-contact and clone-process. */
2919 contact = Flist (nargs, args);
2920 GCPRO1 (contact);
2922 #ifdef WINDOWSNT
2923 /* Ensure socket support is loaded if available. */
2924 init_winsock (TRUE);
2925 #endif
2927 /* :type TYPE (nil: stream, datagram */
2928 tem = Fplist_get (contact, QCtype);
2929 if (NILP (tem))
2930 socktype = SOCK_STREAM;
2931 #ifdef DATAGRAM_SOCKETS
2932 else if (EQ (tem, Qdatagram))
2933 socktype = SOCK_DGRAM;
2934 #endif
2935 #ifdef HAVE_SEQPACKET
2936 else if (EQ (tem, Qseqpacket))
2937 socktype = SOCK_SEQPACKET;
2938 #endif
2939 else
2940 error ("Unsupported connection type");
2942 /* :server BOOL */
2943 tem = Fplist_get (contact, QCserver);
2944 if (!NILP (tem))
2946 /* Don't support network sockets when non-blocking mode is
2947 not available, since a blocked Emacs is not useful. */
2948 #if !defined (O_NONBLOCK) && !defined (O_NDELAY)
2949 error ("Network servers not supported");
2950 #else
2951 is_server = 1;
2952 if (TYPE_RANGED_INTEGERP (int, tem))
2953 backlog = XINT (tem);
2954 #endif
2957 /* Make QCaddress an alias for :local (server) or :remote (client). */
2958 QCaddress = is_server ? QClocal : QCremote;
2960 /* :nowait BOOL */
2961 if (!is_server && socktype != SOCK_DGRAM
2962 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2964 #ifndef NON_BLOCKING_CONNECT
2965 error ("Non-blocking connect not supported");
2966 #else
2967 is_non_blocking_client = 1;
2968 #endif
2971 name = Fplist_get (contact, QCname);
2972 buffer = Fplist_get (contact, QCbuffer);
2973 filter = Fplist_get (contact, QCfilter);
2974 sentinel = Fplist_get (contact, QCsentinel);
2976 CHECK_STRING (name);
2978 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2979 ai.ai_socktype = socktype;
2980 ai.ai_protocol = 0;
2981 ai.ai_next = NULL;
2982 res = &ai;
2984 /* :local ADDRESS or :remote ADDRESS */
2985 address = Fplist_get (contact, QCaddress);
2986 if (!NILP (address))
2988 host = service = Qnil;
2990 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2991 error ("Malformed :address");
2992 ai.ai_family = family;
2993 ai.ai_addr = alloca (ai.ai_addrlen);
2994 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2995 goto open_socket;
2998 /* :family FAMILY -- nil (for Inet), local, or integer. */
2999 tem = Fplist_get (contact, QCfamily);
3000 if (NILP (tem))
3002 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
3003 family = AF_UNSPEC;
3004 #else
3005 family = AF_INET;
3006 #endif
3008 #ifdef HAVE_LOCAL_SOCKETS
3009 else if (EQ (tem, Qlocal))
3010 family = AF_LOCAL;
3011 #endif
3012 #ifdef AF_INET6
3013 else if (EQ (tem, Qipv6))
3014 family = AF_INET6;
3015 #endif
3016 else if (EQ (tem, Qipv4))
3017 family = AF_INET;
3018 else if (TYPE_RANGED_INTEGERP (int, tem))
3019 family = XINT (tem);
3020 else
3021 error ("Unknown address family");
3023 ai.ai_family = family;
3025 /* :service SERVICE -- string, integer (port number), or t (random port). */
3026 service = Fplist_get (contact, QCservice);
3028 /* :host HOST -- hostname, ip address, or 'local for localhost. */
3029 host = Fplist_get (contact, QChost);
3030 if (!NILP (host))
3032 if (EQ (host, Qlocal))
3033 /* Depending on setup, "localhost" may map to different IPv4 and/or
3034 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
3035 host = build_string ("127.0.0.1");
3036 CHECK_STRING (host);
3039 #ifdef HAVE_LOCAL_SOCKETS
3040 if (family == AF_LOCAL)
3042 if (!NILP (host))
3044 message (":family local ignores the :host \"%s\" property",
3045 SDATA (host));
3046 contact = Fplist_put (contact, QChost, Qnil);
3047 host = Qnil;
3049 CHECK_STRING (service);
3050 memset (&address_un, 0, sizeof address_un);
3051 address_un.sun_family = AF_LOCAL;
3052 if (sizeof address_un.sun_path <= SBYTES (service))
3053 error ("Service name too long");
3054 strcpy (address_un.sun_path, SSDATA (service));
3055 ai.ai_addr = (struct sockaddr *) &address_un;
3056 ai.ai_addrlen = sizeof address_un;
3057 goto open_socket;
3059 #endif
3061 /* Slow down polling to every ten seconds.
3062 Some kernels have a bug which causes retrying connect to fail
3063 after a connect. Polling can interfere with gethostbyname too. */
3064 #ifdef POLL_FOR_INPUT
3065 if (socktype != SOCK_DGRAM)
3067 record_unwind_protect (unwind_stop_other_atimers, Qnil);
3068 bind_polling_period (10);
3070 #endif
3072 #ifdef HAVE_GETADDRINFO
3073 /* If we have a host, use getaddrinfo to resolve both host and service.
3074 Otherwise, use getservbyname to lookup the service. */
3075 if (!NILP (host))
3078 /* SERVICE can either be a string or int.
3079 Convert to a C string for later use by getaddrinfo. */
3080 if (EQ (service, Qt))
3081 portstring = "0";
3082 else if (INTEGERP (service))
3084 sprintf (portbuf, "%"pI"d", XINT (service));
3085 portstring = portbuf;
3087 else
3089 CHECK_STRING (service);
3090 portstring = SSDATA (service);
3093 immediate_quit = 1;
3094 QUIT;
3095 memset (&hints, 0, sizeof (hints));
3096 hints.ai_flags = 0;
3097 hints.ai_family = family;
3098 hints.ai_socktype = socktype;
3099 hints.ai_protocol = 0;
3101 #ifdef HAVE_RES_INIT
3102 res_init ();
3103 #endif
3105 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3106 if (ret)
3107 #ifdef HAVE_GAI_STRERROR
3108 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3109 #else
3110 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3111 #endif
3112 immediate_quit = 0;
3114 goto open_socket;
3116 #endif /* HAVE_GETADDRINFO */
3118 /* We end up here if getaddrinfo is not defined, or in case no hostname
3119 has been specified (e.g. for a local server process). */
3121 if (EQ (service, Qt))
3122 port = 0;
3123 else if (INTEGERP (service))
3124 port = htons ((unsigned short) XINT (service));
3125 else
3127 struct servent *svc_info;
3128 CHECK_STRING (service);
3129 svc_info = getservbyname (SSDATA (service),
3130 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3131 if (svc_info == 0)
3132 error ("Unknown service: %s", SDATA (service));
3133 port = svc_info->s_port;
3136 memset (&address_in, 0, sizeof address_in);
3137 address_in.sin_family = family;
3138 address_in.sin_addr.s_addr = INADDR_ANY;
3139 address_in.sin_port = port;
3141 #ifndef HAVE_GETADDRINFO
3142 if (!NILP (host))
3144 struct hostent *host_info_ptr;
3146 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3147 as it may `hang' Emacs for a very long time. */
3148 immediate_quit = 1;
3149 QUIT;
3151 #ifdef HAVE_RES_INIT
3152 res_init ();
3153 #endif
3155 host_info_ptr = gethostbyname (SDATA (host));
3156 immediate_quit = 0;
3158 if (host_info_ptr)
3160 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3161 host_info_ptr->h_length);
3162 family = host_info_ptr->h_addrtype;
3163 address_in.sin_family = family;
3165 else
3166 /* Attempt to interpret host as numeric inet address */
3168 unsigned long numeric_addr;
3169 numeric_addr = inet_addr (SSDATA (host));
3170 if (numeric_addr == -1)
3171 error ("Unknown host \"%s\"", SDATA (host));
3173 memcpy (&address_in.sin_addr, &numeric_addr,
3174 sizeof (address_in.sin_addr));
3178 #endif /* not HAVE_GETADDRINFO */
3180 ai.ai_family = family;
3181 ai.ai_addr = (struct sockaddr *) &address_in;
3182 ai.ai_addrlen = sizeof address_in;
3184 open_socket:
3186 /* Do this in case we never enter the for-loop below. */
3187 count1 = SPECPDL_INDEX ();
3188 s = -1;
3190 for (lres = res; lres; lres = lres->ai_next)
3192 ptrdiff_t optn;
3193 int optbits;
3195 #ifdef WINDOWSNT
3196 retry_connect:
3197 #endif
3199 s = socket (lres->ai_family, lres->ai_socktype, lres->ai_protocol);
3200 if (s < 0)
3202 xerrno = errno;
3203 continue;
3206 #ifdef DATAGRAM_SOCKETS
3207 if (!is_server && socktype == SOCK_DGRAM)
3208 break;
3209 #endif /* DATAGRAM_SOCKETS */
3211 #ifdef NON_BLOCKING_CONNECT
3212 if (is_non_blocking_client)
3214 #ifdef O_NONBLOCK
3215 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3216 #else
3217 ret = fcntl (s, F_SETFL, O_NDELAY);
3218 #endif
3219 if (ret < 0)
3221 xerrno = errno;
3222 emacs_close (s);
3223 s = -1;
3224 continue;
3227 #endif
3229 /* Make us close S if quit. */
3230 record_unwind_protect (close_file_unwind, make_number (s));
3232 /* Parse network options in the arg list.
3233 We simply ignore anything which isn't a known option (including other keywords).
3234 An error is signaled if setting a known option fails. */
3235 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3236 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3238 if (is_server)
3240 /* Configure as a server socket. */
3242 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3243 explicit :reuseaddr key to override this. */
3244 #ifdef HAVE_LOCAL_SOCKETS
3245 if (family != AF_LOCAL)
3246 #endif
3247 if (!(optbits & (1 << OPIX_REUSEADDR)))
3249 int optval = 1;
3250 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3251 report_file_error ("Cannot set reuse option on server socket", Qnil);
3254 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3255 report_file_error ("Cannot bind server socket", Qnil);
3257 #ifdef HAVE_GETSOCKNAME
3258 if (EQ (service, Qt))
3260 struct sockaddr_in sa1;
3261 socklen_t len1 = sizeof (sa1);
3262 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3264 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3265 service = make_number (ntohs (sa1.sin_port));
3266 contact = Fplist_put (contact, QCservice, service);
3269 #endif
3271 if (socktype != SOCK_DGRAM && listen (s, backlog))
3272 report_file_error ("Cannot listen on server socket", Qnil);
3274 break;
3277 immediate_quit = 1;
3278 QUIT;
3280 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3281 xerrno = errno;
3283 if (ret == 0 || xerrno == EISCONN)
3285 /* The unwind-protect will be discarded afterwards.
3286 Likewise for immediate_quit. */
3287 break;
3290 #ifdef NON_BLOCKING_CONNECT
3291 #ifdef EINPROGRESS
3292 if (is_non_blocking_client && xerrno == EINPROGRESS)
3293 break;
3294 #else
3295 #ifdef EWOULDBLOCK
3296 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3297 break;
3298 #endif
3299 #endif
3300 #endif
3302 #ifndef WINDOWSNT
3303 if (xerrno == EINTR)
3305 /* Unlike most other syscalls connect() cannot be called
3306 again. (That would return EALREADY.) The proper way to
3307 wait for completion is pselect(). */
3308 int sc;
3309 socklen_t len;
3310 SELECT_TYPE fdset;
3311 retry_select:
3312 FD_ZERO (&fdset);
3313 FD_SET (s, &fdset);
3314 QUIT;
3315 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3316 if (sc == -1)
3318 if (errno == EINTR)
3319 goto retry_select;
3320 else
3321 report_file_error ("select failed", Qnil);
3323 eassert (sc > 0);
3325 len = sizeof xerrno;
3326 eassert (FD_ISSET (s, &fdset));
3327 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) == -1)
3328 report_file_error ("getsockopt failed", Qnil);
3329 if (xerrno)
3330 errno = xerrno, report_file_error ("error during connect", Qnil);
3331 else
3332 break;
3334 #endif /* !WINDOWSNT */
3336 immediate_quit = 0;
3338 /* Discard the unwind protect closing S. */
3339 specpdl_ptr = specpdl + count1;
3340 emacs_close (s);
3341 s = -1;
3343 #ifdef WINDOWSNT
3344 if (xerrno == EINTR)
3345 goto retry_connect;
3346 #endif
3349 if (s >= 0)
3351 #ifdef DATAGRAM_SOCKETS
3352 if (socktype == SOCK_DGRAM)
3354 if (datagram_address[s].sa)
3355 emacs_abort ();
3356 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3357 datagram_address[s].len = lres->ai_addrlen;
3358 if (is_server)
3360 Lisp_Object remote;
3361 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3362 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3364 int rfamily, rlen;
3365 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3366 if (rfamily == lres->ai_family && rlen == lres->ai_addrlen)
3367 conv_lisp_to_sockaddr (rfamily, remote,
3368 datagram_address[s].sa, rlen);
3371 else
3372 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3374 #endif
3375 contact = Fplist_put (contact, QCaddress,
3376 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3377 #ifdef HAVE_GETSOCKNAME
3378 if (!is_server)
3380 struct sockaddr_in sa1;
3381 socklen_t len1 = sizeof (sa1);
3382 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3383 contact = Fplist_put (contact, QClocal,
3384 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3386 #endif
3389 immediate_quit = 0;
3391 #ifdef HAVE_GETADDRINFO
3392 if (res != &ai)
3394 block_input ();
3395 freeaddrinfo (res);
3396 unblock_input ();
3398 #endif
3400 /* Discard the unwind protect for closing S, if any. */
3401 specpdl_ptr = specpdl + count1;
3403 /* Unwind bind_polling_period and request_sigio. */
3404 unbind_to (count, Qnil);
3406 if (s < 0)
3408 /* If non-blocking got this far - and failed - assume non-blocking is
3409 not supported after all. This is probably a wrong assumption, but
3410 the normal blocking calls to open-network-stream handles this error
3411 better. */
3412 if (is_non_blocking_client)
3413 return Qnil;
3415 errno = xerrno;
3416 if (is_server)
3417 report_file_error ("make server process failed", contact);
3418 else
3419 report_file_error ("make client process failed", contact);
3422 inch = s;
3423 outch = s;
3425 if (!NILP (buffer))
3426 buffer = Fget_buffer_create (buffer);
3427 proc = make_process (name);
3429 chan_process[inch] = proc;
3431 #ifdef O_NONBLOCK
3432 fcntl (inch, F_SETFL, O_NONBLOCK);
3433 #else
3434 #ifdef O_NDELAY
3435 fcntl (inch, F_SETFL, O_NDELAY);
3436 #endif
3437 #endif
3439 p = XPROCESS (proc);
3441 pset_childp (p, contact);
3442 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3443 pset_type (p, Qnetwork);
3445 pset_buffer (p, buffer);
3446 pset_sentinel (p, sentinel);
3447 pset_filter (p, filter);
3448 pset_log (p, Fplist_get (contact, QClog));
3449 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3450 p->kill_without_query = 1;
3451 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3452 pset_command (p, Qt);
3453 p->pid = 0;
3454 p->infd = inch;
3455 p->outfd = outch;
3456 if (is_server && socktype != SOCK_DGRAM)
3457 pset_status (p, Qlisten);
3459 /* Make the process marker point into the process buffer (if any). */
3460 if (BUFFERP (buffer))
3461 set_marker_both (p->mark, buffer,
3462 BUF_ZV (XBUFFER (buffer)),
3463 BUF_ZV_BYTE (XBUFFER (buffer)));
3465 #ifdef NON_BLOCKING_CONNECT
3466 if (is_non_blocking_client)
3468 /* We may get here if connect did succeed immediately. However,
3469 in that case, we still need to signal this like a non-blocking
3470 connection. */
3471 pset_status (p, Qconnect);
3472 if (!FD_ISSET (inch, &connect_wait_mask))
3474 FD_SET (inch, &connect_wait_mask);
3475 FD_SET (inch, &write_mask);
3476 num_pending_connects++;
3479 else
3480 #endif
3481 /* A server may have a client filter setting of Qt, but it must
3482 still listen for incoming connects unless it is stopped. */
3483 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3484 || (EQ (p->status, Qlisten) && NILP (p->command)))
3486 FD_SET (inch, &input_wait_mask);
3487 FD_SET (inch, &non_keyboard_wait_mask);
3490 if (inch > max_process_desc)
3491 max_process_desc = inch;
3493 tem = Fplist_member (contact, QCcoding);
3494 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3495 tem = Qnil; /* No error message (too late!). */
3498 /* Setup coding systems for communicating with the network stream. */
3499 struct gcpro gcpro1;
3500 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3501 Lisp_Object coding_systems = Qt;
3502 Lisp_Object fargs[5], val;
3504 if (!NILP (tem))
3506 val = XCAR (XCDR (tem));
3507 if (CONSP (val))
3508 val = XCAR (val);
3510 else if (!NILP (Vcoding_system_for_read))
3511 val = Vcoding_system_for_read;
3512 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3513 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3514 /* We dare not decode end-of-line format by setting VAL to
3515 Qraw_text, because the existing Emacs Lisp libraries
3516 assume that they receive bare code including a sequence of
3517 CR LF. */
3518 val = Qnil;
3519 else
3521 if (NILP (host) || NILP (service))
3522 coding_systems = Qnil;
3523 else
3525 fargs[0] = Qopen_network_stream, fargs[1] = name,
3526 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3527 GCPRO1 (proc);
3528 coding_systems = Ffind_operation_coding_system (5, fargs);
3529 UNGCPRO;
3531 if (CONSP (coding_systems))
3532 val = XCAR (coding_systems);
3533 else if (CONSP (Vdefault_process_coding_system))
3534 val = XCAR (Vdefault_process_coding_system);
3535 else
3536 val = Qnil;
3538 pset_decode_coding_system (p, val);
3540 if (!NILP (tem))
3542 val = XCAR (XCDR (tem));
3543 if (CONSP (val))
3544 val = XCDR (val);
3546 else if (!NILP (Vcoding_system_for_write))
3547 val = Vcoding_system_for_write;
3548 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3549 val = Qnil;
3550 else
3552 if (EQ (coding_systems, Qt))
3554 if (NILP (host) || NILP (service))
3555 coding_systems = Qnil;
3556 else
3558 fargs[0] = Qopen_network_stream, fargs[1] = name,
3559 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3560 GCPRO1 (proc);
3561 coding_systems = Ffind_operation_coding_system (5, fargs);
3562 UNGCPRO;
3565 if (CONSP (coding_systems))
3566 val = XCDR (coding_systems);
3567 else if (CONSP (Vdefault_process_coding_system))
3568 val = XCDR (Vdefault_process_coding_system);
3569 else
3570 val = Qnil;
3572 pset_encode_coding_system (p, val);
3574 setup_process_coding_systems (proc);
3576 pset_decoding_buf (p, empty_unibyte_string);
3577 p->decoding_carryover = 0;
3578 pset_encoding_buf (p, empty_unibyte_string);
3580 p->inherit_coding_system_flag
3581 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3583 UNGCPRO;
3584 return proc;
3588 #if defined (HAVE_NET_IF_H)
3590 #ifdef SIOCGIFCONF
3591 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3592 doc: /* Return an alist of all network interfaces and their network address.
3593 Each element is a cons, the car of which is a string containing the
3594 interface name, and the cdr is the network address in internal
3595 format; see the description of ADDRESS in `make-network-process'. */)
3596 (void)
3598 struct ifconf ifconf;
3599 struct ifreq *ifreq;
3600 void *buf = NULL;
3601 ptrdiff_t buf_size = 512;
3602 int s, i;
3603 Lisp_Object res;
3605 s = socket (AF_INET, SOCK_STREAM, 0);
3606 if (s < 0)
3607 return Qnil;
3611 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3612 ifconf.ifc_buf = buf;
3613 ifconf.ifc_len = buf_size;
3614 if (ioctl (s, SIOCGIFCONF, &ifconf))
3616 close (s);
3617 xfree (buf);
3618 return Qnil;
3621 while (ifconf.ifc_len == buf_size);
3623 close (s);
3625 res = Qnil;
3626 ifreq = ifconf.ifc_req;
3627 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3629 struct ifreq *ifq = ifreq;
3630 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3631 #define SIZEOF_IFREQ(sif) \
3632 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3633 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3635 int len = SIZEOF_IFREQ (ifq);
3636 #else
3637 int len = sizeof (*ifreq);
3638 #endif
3639 char namebuf[sizeof (ifq->ifr_name) + 1];
3640 i += len;
3641 ifreq = (struct ifreq *) ((char *) ifreq + len);
3643 if (ifq->ifr_addr.sa_family != AF_INET)
3644 continue;
3646 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3647 namebuf[sizeof (ifq->ifr_name)] = 0;
3648 res = Fcons (Fcons (build_string (namebuf),
3649 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3650 sizeof (struct sockaddr))),
3651 res);
3654 xfree (buf);
3655 return res;
3657 #endif /* SIOCGIFCONF */
3659 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3661 struct ifflag_def {
3662 int flag_bit;
3663 const char *flag_sym;
3666 static const struct ifflag_def ifflag_table[] = {
3667 #ifdef IFF_UP
3668 { IFF_UP, "up" },
3669 #endif
3670 #ifdef IFF_BROADCAST
3671 { IFF_BROADCAST, "broadcast" },
3672 #endif
3673 #ifdef IFF_DEBUG
3674 { IFF_DEBUG, "debug" },
3675 #endif
3676 #ifdef IFF_LOOPBACK
3677 { IFF_LOOPBACK, "loopback" },
3678 #endif
3679 #ifdef IFF_POINTOPOINT
3680 { IFF_POINTOPOINT, "pointopoint" },
3681 #endif
3682 #ifdef IFF_RUNNING
3683 { IFF_RUNNING, "running" },
3684 #endif
3685 #ifdef IFF_NOARP
3686 { IFF_NOARP, "noarp" },
3687 #endif
3688 #ifdef IFF_PROMISC
3689 { IFF_PROMISC, "promisc" },
3690 #endif
3691 #ifdef IFF_NOTRAILERS
3692 #ifdef NS_IMPL_COCOA
3693 /* Really means smart, notrailers is obsolete */
3694 { IFF_NOTRAILERS, "smart" },
3695 #else
3696 { IFF_NOTRAILERS, "notrailers" },
3697 #endif
3698 #endif
3699 #ifdef IFF_ALLMULTI
3700 { IFF_ALLMULTI, "allmulti" },
3701 #endif
3702 #ifdef IFF_MASTER
3703 { IFF_MASTER, "master" },
3704 #endif
3705 #ifdef IFF_SLAVE
3706 { IFF_SLAVE, "slave" },
3707 #endif
3708 #ifdef IFF_MULTICAST
3709 { IFF_MULTICAST, "multicast" },
3710 #endif
3711 #ifdef IFF_PORTSEL
3712 { IFF_PORTSEL, "portsel" },
3713 #endif
3714 #ifdef IFF_AUTOMEDIA
3715 { IFF_AUTOMEDIA, "automedia" },
3716 #endif
3717 #ifdef IFF_DYNAMIC
3718 { IFF_DYNAMIC, "dynamic" },
3719 #endif
3720 #ifdef IFF_OACTIVE
3721 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3722 #endif
3723 #ifdef IFF_SIMPLEX
3724 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3725 #endif
3726 #ifdef IFF_LINK0
3727 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3728 #endif
3729 #ifdef IFF_LINK1
3730 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3731 #endif
3732 #ifdef IFF_LINK2
3733 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3734 #endif
3735 { 0, 0 }
3738 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3739 doc: /* Return information about network interface named IFNAME.
3740 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3741 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3742 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
3743 FLAGS is the current flags of the interface. */)
3744 (Lisp_Object ifname)
3746 struct ifreq rq;
3747 Lisp_Object res = Qnil;
3748 Lisp_Object elt;
3749 int s;
3750 int any = 0;
3751 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3752 && defined HAVE_GETIFADDRS && defined LLADDR)
3753 struct ifaddrs *ifap;
3754 #endif
3756 CHECK_STRING (ifname);
3758 if (sizeof rq.ifr_name <= SBYTES (ifname))
3759 error ("interface name too long");
3760 strcpy (rq.ifr_name, SSDATA (ifname));
3762 s = socket (AF_INET, SOCK_STREAM, 0);
3763 if (s < 0)
3764 return Qnil;
3766 elt = Qnil;
3767 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3768 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3770 int flags = rq.ifr_flags;
3771 const struct ifflag_def *fp;
3772 int fnum;
3774 /* If flags is smaller than int (i.e. short) it may have the high bit set
3775 due to IFF_MULTICAST. In that case, sign extending it into
3776 an int is wrong. */
3777 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3778 flags = (unsigned short) rq.ifr_flags;
3780 any = 1;
3781 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3783 if (flags & fp->flag_bit)
3785 elt = Fcons (intern (fp->flag_sym), elt);
3786 flags -= fp->flag_bit;
3789 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3791 if (flags & 1)
3793 elt = Fcons (make_number (fnum), elt);
3797 #endif
3798 res = Fcons (elt, res);
3800 elt = Qnil;
3801 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3802 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3804 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3805 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3806 int n;
3808 any = 1;
3809 for (n = 0; n < 6; n++)
3810 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3811 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3813 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3814 if (getifaddrs (&ifap) != -1)
3816 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3817 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3818 struct ifaddrs *it;
3820 for (it = ifap; it != NULL; it = it->ifa_next)
3822 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3823 unsigned char linkaddr[6];
3824 int n;
3826 if (it->ifa_addr->sa_family != AF_LINK
3827 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3828 || sdl->sdl_alen != 6)
3829 continue;
3831 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3832 for (n = 0; n < 6; n++)
3833 p->contents[n] = make_number (linkaddr[n]);
3835 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3836 break;
3839 #ifdef HAVE_FREEIFADDRS
3840 freeifaddrs (ifap);
3841 #endif
3843 #endif /* HAVE_GETIFADDRS && LLADDR */
3845 res = Fcons (elt, res);
3847 elt = Qnil;
3848 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3849 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3851 any = 1;
3852 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3853 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3854 #else
3855 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3856 #endif
3858 #endif
3859 res = Fcons (elt, res);
3861 elt = Qnil;
3862 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3863 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3865 any = 1;
3866 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3868 #endif
3869 res = Fcons (elt, res);
3871 elt = Qnil;
3872 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3873 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3875 any = 1;
3876 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3878 #endif
3879 res = Fcons (elt, res);
3881 close (s);
3883 return any ? res : Qnil;
3885 #endif
3886 #endif /* defined (HAVE_NET_IF_H) */
3888 /* Turn off input and output for process PROC. */
3890 static void
3891 deactivate_process (Lisp_Object proc)
3893 register int inchannel, outchannel;
3894 register struct Lisp_Process *p = XPROCESS (proc);
3896 #ifdef HAVE_GNUTLS
3897 /* Delete GnuTLS structures in PROC, if any. */
3898 emacs_gnutls_deinit (proc);
3899 #endif /* HAVE_GNUTLS */
3901 inchannel = p->infd;
3902 outchannel = p->outfd;
3904 #ifdef ADAPTIVE_READ_BUFFERING
3905 if (p->read_output_delay > 0)
3907 if (--process_output_delay_count < 0)
3908 process_output_delay_count = 0;
3909 p->read_output_delay = 0;
3910 p->read_output_skip = 0;
3912 #endif
3914 if (inchannel >= 0)
3916 /* Beware SIGCHLD hereabouts. */
3917 flush_pending_output (inchannel);
3918 emacs_close (inchannel);
3919 if (outchannel >= 0 && outchannel != inchannel)
3920 emacs_close (outchannel);
3922 p->infd = -1;
3923 p->outfd = -1;
3924 #ifdef DATAGRAM_SOCKETS
3925 if (DATAGRAM_CHAN_P (inchannel))
3927 xfree (datagram_address[inchannel].sa);
3928 datagram_address[inchannel].sa = 0;
3929 datagram_address[inchannel].len = 0;
3931 #endif
3932 chan_process[inchannel] = Qnil;
3933 FD_CLR (inchannel, &input_wait_mask);
3934 FD_CLR (inchannel, &non_keyboard_wait_mask);
3935 #ifdef NON_BLOCKING_CONNECT
3936 if (FD_ISSET (inchannel, &connect_wait_mask))
3938 FD_CLR (inchannel, &connect_wait_mask);
3939 FD_CLR (inchannel, &write_mask);
3940 if (--num_pending_connects < 0)
3941 emacs_abort ();
3943 #endif
3944 if (inchannel == max_process_desc)
3946 int i;
3947 /* We just closed the highest-numbered process input descriptor,
3948 so recompute the highest-numbered one now. */
3949 max_process_desc = 0;
3950 for (i = 0; i < MAXDESC; i++)
3951 if (!NILP (chan_process[i]))
3952 max_process_desc = i;
3958 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3959 0, 4, 0,
3960 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3961 It is read into the process' buffers or given to their filter functions.
3962 Non-nil arg PROCESS means do not return until some output has been received
3963 from PROCESS.
3965 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3966 and milliseconds to wait; return after that much time whether or not
3967 there is any subprocess output. If SECONDS is a floating point number,
3968 it specifies a fractional number of seconds to wait.
3969 The MILLISEC argument is obsolete and should be avoided.
3971 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3972 from PROCESS, suspending reading output from other processes.
3973 If JUST-THIS-ONE is an integer, don't run any timers either.
3974 Return non-nil if we received any output before the timeout expired. */)
3975 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3977 intmax_t secs;
3978 int nsecs;
3980 if (! NILP (process))
3981 CHECK_PROCESS (process);
3982 else
3983 just_this_one = Qnil;
3985 if (!NILP (millisec))
3986 { /* Obsolete calling convention using integers rather than floats. */
3987 CHECK_NUMBER (millisec);
3988 if (NILP (seconds))
3989 seconds = make_float (XINT (millisec) / 1000.0);
3990 else
3992 CHECK_NUMBER (seconds);
3993 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3997 secs = 0;
3998 nsecs = -1;
4000 if (!NILP (seconds))
4002 if (INTEGERP (seconds))
4004 if (0 < XINT (seconds))
4006 secs = XINT (seconds);
4007 nsecs = 0;
4010 else if (FLOATP (seconds))
4012 if (0 < XFLOAT_DATA (seconds))
4014 EMACS_TIME t = EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (seconds));
4015 secs = min (EMACS_SECS (t), WAIT_READING_MAX);
4016 nsecs = EMACS_NSECS (t);
4019 else
4020 wrong_type_argument (Qnumberp, seconds);
4022 else if (! NILP (process))
4023 nsecs = 0;
4025 return
4026 (wait_reading_process_output (secs, nsecs, 0, 0,
4027 Qnil,
4028 !NILP (process) ? XPROCESS (process) : NULL,
4029 NILP (just_this_one) ? 0 :
4030 !INTEGERP (just_this_one) ? 1 : -1)
4031 ? Qt : Qnil);
4034 /* Accept a connection for server process SERVER on CHANNEL. */
4036 static int connect_counter = 0;
4038 static void
4039 server_accept_connection (Lisp_Object server, int channel)
4041 Lisp_Object proc, caller, name, buffer;
4042 Lisp_Object contact, host, service;
4043 struct Lisp_Process *ps= XPROCESS (server);
4044 struct Lisp_Process *p;
4045 int s;
4046 union u_sockaddr {
4047 struct sockaddr sa;
4048 struct sockaddr_in in;
4049 #ifdef AF_INET6
4050 struct sockaddr_in6 in6;
4051 #endif
4052 #ifdef HAVE_LOCAL_SOCKETS
4053 struct sockaddr_un un;
4054 #endif
4055 } saddr;
4056 socklen_t len = sizeof saddr;
4058 s = accept (channel, &saddr.sa, &len);
4060 if (s < 0)
4062 int code = errno;
4064 if (code == EAGAIN)
4065 return;
4066 #ifdef EWOULDBLOCK
4067 if (code == EWOULDBLOCK)
4068 return;
4069 #endif
4071 if (!NILP (ps->log))
4072 call3 (ps->log, server, Qnil,
4073 concat3 (build_string ("accept failed with code"),
4074 Fnumber_to_string (make_number (code)),
4075 build_string ("\n")));
4076 return;
4079 connect_counter++;
4081 /* Setup a new process to handle the connection. */
4083 /* Generate a unique identification of the caller, and build contact
4084 information for this process. */
4085 host = Qt;
4086 service = Qnil;
4087 switch (saddr.sa.sa_family)
4089 case AF_INET:
4091 Lisp_Object args[5];
4092 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4093 args[0] = build_string ("%d.%d.%d.%d");
4094 args[1] = make_number (*ip++);
4095 args[2] = make_number (*ip++);
4096 args[3] = make_number (*ip++);
4097 args[4] = make_number (*ip++);
4098 host = Fformat (5, args);
4099 service = make_number (ntohs (saddr.in.sin_port));
4101 args[0] = build_string (" <%s:%d>");
4102 args[1] = host;
4103 args[2] = service;
4104 caller = Fformat (3, args);
4106 break;
4108 #ifdef AF_INET6
4109 case AF_INET6:
4111 Lisp_Object args[9];
4112 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4113 int i;
4114 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4115 for (i = 0; i < 8; i++)
4116 args[i+1] = make_number (ntohs (ip6[i]));
4117 host = Fformat (9, args);
4118 service = make_number (ntohs (saddr.in.sin_port));
4120 args[0] = build_string (" <[%s]:%d>");
4121 args[1] = host;
4122 args[2] = service;
4123 caller = Fformat (3, args);
4125 break;
4126 #endif
4128 #ifdef HAVE_LOCAL_SOCKETS
4129 case AF_LOCAL:
4130 #endif
4131 default:
4132 caller = Fnumber_to_string (make_number (connect_counter));
4133 caller = concat3 (build_string (" <"), caller, build_string (">"));
4134 break;
4137 /* Create a new buffer name for this process if it doesn't have a
4138 filter. The new buffer name is based on the buffer name or
4139 process name of the server process concatenated with the caller
4140 identification. */
4142 if (!NILP (ps->filter) && !EQ (ps->filter, Qt))
4143 buffer = Qnil;
4144 else
4146 buffer = ps->buffer;
4147 if (!NILP (buffer))
4148 buffer = Fbuffer_name (buffer);
4149 else
4150 buffer = ps->name;
4151 if (!NILP (buffer))
4153 buffer = concat2 (buffer, caller);
4154 buffer = Fget_buffer_create (buffer);
4158 /* Generate a unique name for the new server process. Combine the
4159 server process name with the caller identification. */
4161 name = concat2 (ps->name, caller);
4162 proc = make_process (name);
4164 chan_process[s] = proc;
4166 #ifdef O_NONBLOCK
4167 fcntl (s, F_SETFL, O_NONBLOCK);
4168 #else
4169 #ifdef O_NDELAY
4170 fcntl (s, F_SETFL, O_NDELAY);
4171 #endif
4172 #endif
4174 p = XPROCESS (proc);
4176 /* Build new contact information for this setup. */
4177 contact = Fcopy_sequence (ps->childp);
4178 contact = Fplist_put (contact, QCserver, Qnil);
4179 contact = Fplist_put (contact, QChost, host);
4180 if (!NILP (service))
4181 contact = Fplist_put (contact, QCservice, service);
4182 contact = Fplist_put (contact, QCremote,
4183 conv_sockaddr_to_lisp (&saddr.sa, len));
4184 #ifdef HAVE_GETSOCKNAME
4185 len = sizeof saddr;
4186 if (getsockname (s, &saddr.sa, &len) == 0)
4187 contact = Fplist_put (contact, QClocal,
4188 conv_sockaddr_to_lisp (&saddr.sa, len));
4189 #endif
4191 pset_childp (p, contact);
4192 pset_plist (p, Fcopy_sequence (ps->plist));
4193 pset_type (p, Qnetwork);
4195 pset_buffer (p, buffer);
4196 pset_sentinel (p, ps->sentinel);
4197 pset_filter (p, ps->filter);
4198 pset_command (p, Qnil);
4199 p->pid = 0;
4200 p->infd = s;
4201 p->outfd = s;
4202 pset_status (p, Qrun);
4204 /* Client processes for accepted connections are not stopped initially. */
4205 if (!EQ (p->filter, Qt))
4207 FD_SET (s, &input_wait_mask);
4208 FD_SET (s, &non_keyboard_wait_mask);
4211 if (s > max_process_desc)
4212 max_process_desc = s;
4214 /* Setup coding system for new process based on server process.
4215 This seems to be the proper thing to do, as the coding system
4216 of the new process should reflect the settings at the time the
4217 server socket was opened; not the current settings. */
4219 pset_decode_coding_system (p, ps->decode_coding_system);
4220 pset_encode_coding_system (p, ps->encode_coding_system);
4221 setup_process_coding_systems (proc);
4223 pset_decoding_buf (p, empty_unibyte_string);
4224 p->decoding_carryover = 0;
4225 pset_encoding_buf (p, empty_unibyte_string);
4227 p->inherit_coding_system_flag
4228 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4230 if (!NILP (ps->log))
4231 call3 (ps->log, server, proc,
4232 concat3 (build_string ("accept from "),
4233 (STRINGP (host) ? host : build_string ("-")),
4234 build_string ("\n")));
4236 if (!NILP (p->sentinel))
4237 exec_sentinel (proc,
4238 concat3 (build_string ("open from "),
4239 (STRINGP (host) ? host : build_string ("-")),
4240 build_string ("\n")));
4243 /* This variable is different from waiting_for_input in keyboard.c.
4244 It is used to communicate to a lisp process-filter/sentinel (via the
4245 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4246 for user-input when that process-filter was called.
4247 waiting_for_input cannot be used as that is by definition 0 when
4248 lisp code is being evalled.
4249 This is also used in record_asynch_buffer_change.
4250 For that purpose, this must be 0
4251 when not inside wait_reading_process_output. */
4252 static int waiting_for_user_input_p;
4254 static Lisp_Object
4255 wait_reading_process_output_unwind (Lisp_Object data)
4257 waiting_for_user_input_p = XINT (data);
4258 return Qnil;
4261 /* This is here so breakpoints can be put on it. */
4262 static void
4263 wait_reading_process_output_1 (void)
4267 /* Read and dispose of subprocess output while waiting for timeout to
4268 elapse and/or keyboard input to be available.
4270 TIME_LIMIT is:
4271 timeout in seconds
4272 If negative, gobble data immediately available but don't wait for any.
4274 NSECS is:
4275 an additional duration to wait, measured in nanoseconds
4276 If TIME_LIMIT is zero, then:
4277 If NSECS == 0, there is no limit.
4278 If NSECS > 0, the timeout consists of NSECS only.
4279 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4281 READ_KBD is:
4282 0 to ignore keyboard input, or
4283 1 to return when input is available, or
4284 -1 meaning caller will actually read the input, so don't throw to
4285 the quit handler, or
4287 DO_DISPLAY means redisplay should be done to show subprocess
4288 output that arrives.
4290 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4291 (and gobble terminal input into the buffer if any arrives).
4293 If WAIT_PROC is specified, wait until something arrives from that
4294 process. The return value is true if we read some input from
4295 that process.
4297 If JUST_WAIT_PROC is non-nil, handle only output from WAIT_PROC
4298 (suspending output from other processes). A negative value
4299 means don't run any timers either.
4301 If WAIT_PROC is specified, then the function returns true if we
4302 received input from that process before the timeout elapsed.
4303 Otherwise, return true if we received input from any process. */
4306 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4307 bool do_display,
4308 Lisp_Object wait_for_cell,
4309 struct Lisp_Process *wait_proc, int just_wait_proc)
4311 register int channel, nfds;
4312 SELECT_TYPE Available;
4313 SELECT_TYPE Writeok;
4314 int check_write;
4315 int check_delay, no_avail;
4316 int xerrno;
4317 Lisp_Object proc;
4318 EMACS_TIME timeout, end_time;
4319 int wait_channel = -1;
4320 int got_some_input = 0;
4321 ptrdiff_t count = SPECPDL_INDEX ();
4323 FD_ZERO (&Available);
4324 FD_ZERO (&Writeok);
4326 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4327 && !(CONSP (wait_proc->status)
4328 && EQ (XCAR (wait_proc->status), Qexit)))
4329 message ("Blocking call to accept-process-output with quit inhibited!!");
4331 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4332 if (wait_proc != NULL)
4333 wait_channel = wait_proc->infd;
4335 record_unwind_protect (wait_reading_process_output_unwind,
4336 make_number (waiting_for_user_input_p));
4337 waiting_for_user_input_p = read_kbd;
4339 if (time_limit < 0)
4341 time_limit = 0;
4342 nsecs = -1;
4344 else if (TYPE_MAXIMUM (time_t) < time_limit)
4345 time_limit = TYPE_MAXIMUM (time_t);
4347 /* Since we may need to wait several times,
4348 compute the absolute time to return at. */
4349 if (time_limit || 0 < nsecs)
4351 timeout = make_emacs_time (time_limit, nsecs);
4352 end_time = add_emacs_time (current_emacs_time (), timeout);
4355 while (1)
4357 int timeout_reduced_for_timers = 0;
4359 /* If calling from keyboard input, do not quit
4360 since we want to return C-g as an input character.
4361 Otherwise, do pending quit if requested. */
4362 if (read_kbd >= 0)
4363 QUIT;
4364 else if (pending_signals)
4365 process_pending_signals ();
4367 /* Exit now if the cell we're waiting for became non-nil. */
4368 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4369 break;
4371 /* Compute time from now till when time limit is up */
4372 /* Exit if already run out */
4373 if (nsecs < 0)
4375 /* A negative timeout means
4376 gobble output available now
4377 but don't wait at all. */
4379 timeout = make_emacs_time (0, 0);
4381 else if (time_limit || 0 < nsecs)
4383 EMACS_TIME now = current_emacs_time ();
4384 if (EMACS_TIME_LE (end_time, now))
4385 break;
4386 timeout = sub_emacs_time (end_time, now);
4388 else
4390 timeout = make_emacs_time (100000, 0);
4393 /* Normally we run timers here.
4394 But not if wait_for_cell; in those cases,
4395 the wait is supposed to be short,
4396 and those callers cannot handle running arbitrary Lisp code here. */
4397 if (NILP (wait_for_cell)
4398 && just_wait_proc >= 0)
4400 EMACS_TIME timer_delay;
4404 unsigned old_timers_run = timers_run;
4405 struct buffer *old_buffer = current_buffer;
4406 Lisp_Object old_window = selected_window;
4408 timer_delay = timer_check ();
4410 /* If a timer has run, this might have changed buffers
4411 an alike. Make read_key_sequence aware of that. */
4412 if (timers_run != old_timers_run
4413 && (old_buffer != current_buffer
4414 || !EQ (old_window, selected_window))
4415 && waiting_for_user_input_p == -1)
4416 record_asynch_buffer_change ();
4418 if (timers_run != old_timers_run && do_display)
4419 /* We must retry, since a timer may have requeued itself
4420 and that could alter the time_delay. */
4421 redisplay_preserve_echo_area (9);
4422 else
4423 break;
4425 while (!detect_input_pending ());
4427 /* If there is unread keyboard input, also return. */
4428 if (read_kbd != 0
4429 && requeued_events_pending_p ())
4430 break;
4432 /* A negative timeout means do not wait at all. */
4433 if (0 <= nsecs)
4435 if (EMACS_TIME_VALID_P (timer_delay))
4437 if (EMACS_TIME_LT (timer_delay, timeout))
4439 timeout = timer_delay;
4440 timeout_reduced_for_timers = 1;
4443 else
4445 /* This is so a breakpoint can be put here. */
4446 wait_reading_process_output_1 ();
4451 /* Cause C-g and alarm signals to take immediate action,
4452 and cause input available signals to zero out timeout.
4454 It is important that we do this before checking for process
4455 activity. If we get a SIGCHLD after the explicit checks for
4456 process activity, timeout is the only way we will know. */
4457 if (read_kbd < 0)
4458 set_waiting_for_input (&timeout);
4460 /* If status of something has changed, and no input is
4461 available, notify the user of the change right away. After
4462 this explicit check, we'll let the SIGCHLD handler zap
4463 timeout to get our attention. */
4464 if (update_tick != process_tick)
4466 SELECT_TYPE Atemp;
4467 SELECT_TYPE Ctemp;
4469 if (kbd_on_hold_p ())
4470 FD_ZERO (&Atemp);
4471 else
4472 Atemp = input_wait_mask;
4473 Ctemp = write_mask;
4475 timeout = make_emacs_time (0, 0);
4476 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4477 &Atemp,
4478 #ifdef NON_BLOCKING_CONNECT
4479 (num_pending_connects > 0 ? &Ctemp : NULL),
4480 #else
4481 NULL,
4482 #endif
4483 NULL, &timeout, NULL)
4484 <= 0))
4486 /* It's okay for us to do this and then continue with
4487 the loop, since timeout has already been zeroed out. */
4488 clear_waiting_for_input ();
4489 status_notify (NULL);
4490 if (do_display) redisplay_preserve_echo_area (13);
4494 /* Don't wait for output from a non-running process. Just
4495 read whatever data has already been received. */
4496 if (wait_proc && wait_proc->raw_status_new)
4497 update_status (wait_proc);
4498 if (wait_proc
4499 && ! EQ (wait_proc->status, Qrun)
4500 && ! EQ (wait_proc->status, Qconnect))
4502 int nread, total_nread = 0;
4504 clear_waiting_for_input ();
4505 XSETPROCESS (proc, wait_proc);
4507 /* Read data from the process, until we exhaust it. */
4508 while (wait_proc->infd >= 0)
4510 nread = read_process_output (proc, wait_proc->infd);
4512 if (nread == 0)
4513 break;
4515 if (0 < nread)
4517 total_nread += nread;
4518 got_some_input = 1;
4520 #ifdef EIO
4521 else if (nread == -1 && EIO == errno)
4522 break;
4523 #endif
4524 #ifdef EAGAIN
4525 else if (nread == -1 && EAGAIN == errno)
4526 break;
4527 #endif
4528 #ifdef EWOULDBLOCK
4529 else if (nread == -1 && EWOULDBLOCK == errno)
4530 break;
4531 #endif
4533 if (total_nread > 0 && do_display)
4534 redisplay_preserve_echo_area (10);
4536 break;
4539 /* Wait till there is something to do */
4541 if (wait_proc && just_wait_proc)
4543 if (wait_proc->infd < 0) /* Terminated */
4544 break;
4545 FD_SET (wait_proc->infd, &Available);
4546 check_delay = 0;
4547 check_write = 0;
4549 else if (!NILP (wait_for_cell))
4551 Available = non_process_wait_mask;
4552 check_delay = 0;
4553 check_write = 0;
4555 else
4557 if (! read_kbd)
4558 Available = non_keyboard_wait_mask;
4559 else
4560 Available = input_wait_mask;
4561 Writeok = write_mask;
4562 #ifdef SELECT_CANT_DO_WRITE_MASK
4563 check_write = 0;
4564 #else
4565 check_write = 1;
4566 #endif
4567 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4570 /* If frame size has changed or the window is newly mapped,
4571 redisplay now, before we start to wait. There is a race
4572 condition here; if a SIGIO arrives between now and the select
4573 and indicates that a frame is trashed, the select may block
4574 displaying a trashed screen. */
4575 if (frame_garbaged && do_display)
4577 clear_waiting_for_input ();
4578 redisplay_preserve_echo_area (11);
4579 if (read_kbd < 0)
4580 set_waiting_for_input (&timeout);
4583 /* Skip the `select' call if input is available and we're
4584 waiting for keyboard input or a cell change (which can be
4585 triggered by processing X events). In the latter case, set
4586 nfds to 1 to avoid breaking the loop. */
4587 no_avail = 0;
4588 if ((read_kbd || !NILP (wait_for_cell))
4589 && detect_input_pending ())
4591 nfds = read_kbd ? 0 : 1;
4592 no_avail = 1;
4595 if (!no_avail)
4598 #ifdef ADAPTIVE_READ_BUFFERING
4599 /* Set the timeout for adaptive read buffering if any
4600 process has non-zero read_output_skip and non-zero
4601 read_output_delay, and we are not reading output for a
4602 specific wait_channel. It is not executed if
4603 Vprocess_adaptive_read_buffering is nil. */
4604 if (process_output_skip && check_delay > 0)
4606 int nsecs = EMACS_NSECS (timeout);
4607 if (EMACS_SECS (timeout) > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4608 nsecs = READ_OUTPUT_DELAY_MAX;
4609 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4611 proc = chan_process[channel];
4612 if (NILP (proc))
4613 continue;
4614 /* Find minimum non-zero read_output_delay among the
4615 processes with non-zero read_output_skip. */
4616 if (XPROCESS (proc)->read_output_delay > 0)
4618 check_delay--;
4619 if (!XPROCESS (proc)->read_output_skip)
4620 continue;
4621 FD_CLR (channel, &Available);
4622 XPROCESS (proc)->read_output_skip = 0;
4623 if (XPROCESS (proc)->read_output_delay < nsecs)
4624 nsecs = XPROCESS (proc)->read_output_delay;
4627 timeout = make_emacs_time (0, nsecs);
4628 process_output_skip = 0;
4630 #endif
4632 #if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
4633 nfds = xg_select
4634 #elif defined (HAVE_NS)
4635 nfds = ns_select
4636 #else
4637 nfds = pselect
4638 #endif
4639 (max (max_process_desc, max_input_desc) + 1,
4640 &Available,
4641 (check_write ? &Writeok : (SELECT_TYPE *)0),
4642 NULL, &timeout, NULL);
4644 #ifdef HAVE_GNUTLS
4645 /* GnuTLS buffers data internally. In lowat mode it leaves
4646 some data in the TCP buffers so that select works, but
4647 with custom pull/push functions we need to check if some
4648 data is available in the buffers manually. */
4649 if (nfds == 0)
4651 if (! wait_proc)
4653 /* We're not waiting on a specific process, so loop
4654 through all the channels and check for data.
4655 This is a workaround needed for some versions of
4656 the gnutls library -- 2.12.14 has been confirmed
4657 to need it. See
4658 http://comments.gmane.org/gmane.emacs.devel/145074 */
4659 for (channel = 0; channel < MAXDESC; ++channel)
4660 if (! NILP (chan_process[channel]))
4662 struct Lisp_Process *p =
4663 XPROCESS (chan_process[channel]);
4664 if (p && p->gnutls_p && p->infd
4665 && ((emacs_gnutls_record_check_pending
4666 (p->gnutls_state))
4667 > 0))
4669 nfds++;
4670 FD_SET (p->infd, &Available);
4674 else
4676 /* Check this specific channel. */
4677 if (wait_proc->gnutls_p /* Check for valid process. */
4678 /* Do we have pending data? */
4679 && ((emacs_gnutls_record_check_pending
4680 (wait_proc->gnutls_state))
4681 > 0))
4683 nfds = 1;
4684 /* Set to Available. */
4685 FD_SET (wait_proc->infd, &Available);
4689 #endif
4692 xerrno = errno;
4694 /* Make C-g and alarm signals set flags again */
4695 clear_waiting_for_input ();
4697 /* If we woke up due to SIGWINCH, actually change size now. */
4698 do_pending_window_change (0);
4700 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4701 /* We waited the full specified time, so return now. */
4702 break;
4703 if (nfds < 0)
4705 if (xerrno == EINTR)
4706 no_avail = 1;
4707 else if (xerrno == EBADF)
4709 #ifdef AIX
4710 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
4711 the child's closure of the pts gives the parent a SIGHUP, and
4712 the ptc file descriptor is automatically closed,
4713 yielding EBADF here or at select() call above.
4714 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
4715 in m/ibmrt-aix.h), and here we just ignore the select error.
4716 Cleanup occurs c/o status_notify after SIGCLD. */
4717 no_avail = 1; /* Cannot depend on values returned */
4718 #else
4719 emacs_abort ();
4720 #endif
4722 else
4723 error ("select error: %s", emacs_strerror (xerrno));
4726 if (no_avail)
4728 FD_ZERO (&Available);
4729 check_write = 0;
4732 /* Check for keyboard input */
4733 /* If there is any, return immediately
4734 to give it higher priority than subprocesses */
4736 if (read_kbd != 0)
4738 unsigned old_timers_run = timers_run;
4739 struct buffer *old_buffer = current_buffer;
4740 Lisp_Object old_window = selected_window;
4741 int leave = 0;
4743 if (detect_input_pending_run_timers (do_display))
4745 swallow_events (do_display);
4746 if (detect_input_pending_run_timers (do_display))
4747 leave = 1;
4750 /* If a timer has run, this might have changed buffers
4751 an alike. Make read_key_sequence aware of that. */
4752 if (timers_run != old_timers_run
4753 && waiting_for_user_input_p == -1
4754 && (old_buffer != current_buffer
4755 || !EQ (old_window, selected_window)))
4756 record_asynch_buffer_change ();
4758 if (leave)
4759 break;
4762 /* If there is unread keyboard input, also return. */
4763 if (read_kbd != 0
4764 && requeued_events_pending_p ())
4765 break;
4767 /* If we are not checking for keyboard input now,
4768 do process events (but don't run any timers).
4769 This is so that X events will be processed.
4770 Otherwise they may have to wait until polling takes place.
4771 That would causes delays in pasting selections, for example.
4773 (We used to do this only if wait_for_cell.) */
4774 if (read_kbd == 0 && detect_input_pending ())
4776 swallow_events (do_display);
4777 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4778 if (detect_input_pending ())
4779 break;
4780 #endif
4783 /* Exit now if the cell we're waiting for became non-nil. */
4784 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4785 break;
4787 #ifdef USABLE_SIGIO
4788 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4789 go read it. This can happen with X on BSD after logging out.
4790 In that case, there really is no input and no SIGIO,
4791 but select says there is input. */
4793 if (read_kbd && interrupt_input
4794 && keyboard_bit_set (&Available) && ! noninteractive)
4795 handle_input_available_signal (SIGIO);
4796 #endif
4798 if (! wait_proc)
4799 got_some_input |= nfds > 0;
4801 /* If checking input just got us a size-change event from X,
4802 obey it now if we should. */
4803 if (read_kbd || ! NILP (wait_for_cell))
4804 do_pending_window_change (0);
4806 /* Check for data from a process. */
4807 if (no_avail || nfds == 0)
4808 continue;
4810 for (channel = 0; channel <= max_input_desc; ++channel)
4812 struct fd_callback_data *d = &fd_callback_info[channel];
4813 if (d->func
4814 && ((d->condition & FOR_READ
4815 && FD_ISSET (channel, &Available))
4816 || (d->condition & FOR_WRITE
4817 && FD_ISSET (channel, &write_mask))))
4818 d->func (channel, d->data);
4821 for (channel = 0; channel <= max_process_desc; channel++)
4823 if (FD_ISSET (channel, &Available)
4824 && FD_ISSET (channel, &non_keyboard_wait_mask)
4825 && !FD_ISSET (channel, &non_process_wait_mask))
4827 int nread;
4829 /* If waiting for this channel, arrange to return as
4830 soon as no more input to be processed. No more
4831 waiting. */
4832 if (wait_channel == channel)
4834 wait_channel = -1;
4835 nsecs = -1;
4836 got_some_input = 1;
4838 proc = chan_process[channel];
4839 if (NILP (proc))
4840 continue;
4842 /* If this is a server stream socket, accept connection. */
4843 if (EQ (XPROCESS (proc)->status, Qlisten))
4845 server_accept_connection (proc, channel);
4846 continue;
4849 /* Read data from the process, starting with our
4850 buffered-ahead character if we have one. */
4852 nread = read_process_output (proc, channel);
4853 if (nread > 0)
4855 /* Since read_process_output can run a filter,
4856 which can call accept-process-output,
4857 don't try to read from any other processes
4858 before doing the select again. */
4859 FD_ZERO (&Available);
4861 if (do_display)
4862 redisplay_preserve_echo_area (12);
4864 #ifdef EWOULDBLOCK
4865 else if (nread == -1 && errno == EWOULDBLOCK)
4867 #endif
4868 /* ISC 4.1 defines both EWOULDBLOCK and O_NONBLOCK,
4869 and Emacs uses O_NONBLOCK, so what we get is EAGAIN. */
4870 #ifdef O_NONBLOCK
4871 else if (nread == -1 && errno == EAGAIN)
4873 #else
4874 #ifdef O_NDELAY
4875 else if (nread == -1 && errno == EAGAIN)
4877 /* Note that we cannot distinguish between no input
4878 available now and a closed pipe.
4879 With luck, a closed pipe will be accompanied by
4880 subprocess termination and SIGCHLD. */
4881 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4883 #endif /* O_NDELAY */
4884 #endif /* O_NONBLOCK */
4885 #ifdef HAVE_PTYS
4886 /* On some OSs with ptys, when the process on one end of
4887 a pty exits, the other end gets an error reading with
4888 errno = EIO instead of getting an EOF (0 bytes read).
4889 Therefore, if we get an error reading and errno =
4890 EIO, just continue, because the child process has
4891 exited and should clean itself up soon (e.g. when we
4892 get a SIGCHLD).
4894 However, it has been known to happen that the SIGCHLD
4895 got lost. So raise the signal again just in case.
4896 It can't hurt. */
4897 else if (nread == -1 && errno == EIO)
4899 struct Lisp_Process *p = XPROCESS (proc);
4901 /* Clear the descriptor now, so we only raise the
4902 signal once. */
4903 FD_CLR (channel, &input_wait_mask);
4904 FD_CLR (channel, &non_keyboard_wait_mask);
4906 if (p->pid == -2)
4908 /* If the EIO occurs on a pty, the SIGCHLD handler's
4909 waitpid call will not find the process object to
4910 delete. Do it here. */
4911 p->tick = ++process_tick;
4912 pset_status (p, Qfailed);
4914 else
4915 handle_child_signal (SIGCHLD);
4917 #endif /* HAVE_PTYS */
4918 /* If we can detect process termination, don't consider the
4919 process gone just because its pipe is closed. */
4920 #ifdef SIGCHLD
4921 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4923 #endif
4924 else
4926 /* Preserve status of processes already terminated. */
4927 XPROCESS (proc)->tick = ++process_tick;
4928 deactivate_process (proc);
4929 if (XPROCESS (proc)->raw_status_new)
4930 update_status (XPROCESS (proc));
4931 if (EQ (XPROCESS (proc)->status, Qrun))
4932 pset_status (XPROCESS (proc),
4933 list2 (Qexit, make_number (256)));
4936 #ifdef NON_BLOCKING_CONNECT
4937 if (FD_ISSET (channel, &Writeok)
4938 && FD_ISSET (channel, &connect_wait_mask))
4940 struct Lisp_Process *p;
4942 FD_CLR (channel, &connect_wait_mask);
4943 FD_CLR (channel, &write_mask);
4944 if (--num_pending_connects < 0)
4945 emacs_abort ();
4947 proc = chan_process[channel];
4948 if (NILP (proc))
4949 continue;
4951 p = XPROCESS (proc);
4953 #ifdef GNU_LINUX
4954 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4955 So only use it on systems where it is known to work. */
4957 socklen_t xlen = sizeof (xerrno);
4958 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4959 xerrno = errno;
4961 #else
4963 struct sockaddr pname;
4964 int pnamelen = sizeof (pname);
4966 /* If connection failed, getpeername will fail. */
4967 xerrno = 0;
4968 if (getpeername (channel, &pname, &pnamelen) < 0)
4970 /* Obtain connect failure code through error slippage. */
4971 char dummy;
4972 xerrno = errno;
4973 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4974 xerrno = errno;
4977 #endif
4978 if (xerrno)
4980 p->tick = ++process_tick;
4981 pset_status (p, list2 (Qfailed, make_number (xerrno)));
4982 deactivate_process (proc);
4984 else
4986 pset_status (p, Qrun);
4987 /* Execute the sentinel here. If we had relied on
4988 status_notify to do it later, it will read input
4989 from the process before calling the sentinel. */
4990 exec_sentinel (proc, build_string ("open\n"));
4991 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
4993 FD_SET (p->infd, &input_wait_mask);
4994 FD_SET (p->infd, &non_keyboard_wait_mask);
4998 #endif /* NON_BLOCKING_CONNECT */
4999 } /* end for each file descriptor */
5000 } /* end while exit conditions not met */
5002 unbind_to (count, Qnil);
5004 /* If calling from keyboard input, do not quit
5005 since we want to return C-g as an input character.
5006 Otherwise, do pending quit if requested. */
5007 if (read_kbd >= 0)
5009 /* Prevent input_pending from remaining set if we quit. */
5010 clear_input_pending ();
5011 QUIT;
5014 return got_some_input;
5017 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
5019 static Lisp_Object
5020 read_process_output_call (Lisp_Object fun_and_args)
5022 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
5025 static Lisp_Object
5026 read_process_output_error_handler (Lisp_Object error_val)
5028 cmd_error_internal (error_val, "error in process filter: ");
5029 Vinhibit_quit = Qt;
5030 update_echo_area ();
5031 Fsleep_for (make_number (2), Qnil);
5032 return Qt;
5035 /* Read pending output from the process channel,
5036 starting with our buffered-ahead character if we have one.
5037 Yield number of decoded characters read.
5039 This function reads at most 4096 characters.
5040 If you want to read all available subprocess output,
5041 you must call it repeatedly until it returns zero.
5043 The characters read are decoded according to PROC's coding-system
5044 for decoding. */
5046 static int
5047 read_process_output (Lisp_Object proc, register int channel)
5049 register ssize_t nbytes;
5050 char *chars;
5051 register Lisp_Object outstream;
5052 register struct Lisp_Process *p = XPROCESS (proc);
5053 register ptrdiff_t opoint;
5054 struct coding_system *coding = proc_decode_coding_system[channel];
5055 int carryover = p->decoding_carryover;
5056 int readmax = 4096;
5057 ptrdiff_t count = SPECPDL_INDEX ();
5058 Lisp_Object odeactivate;
5060 chars = alloca (carryover + readmax);
5061 if (carryover)
5062 /* See the comment above. */
5063 memcpy (chars, SDATA (p->decoding_buf), carryover);
5065 #ifdef DATAGRAM_SOCKETS
5066 /* We have a working select, so proc_buffered_char is always -1. */
5067 if (DATAGRAM_CHAN_P (channel))
5069 socklen_t len = datagram_address[channel].len;
5070 nbytes = recvfrom (channel, chars + carryover, readmax,
5071 0, datagram_address[channel].sa, &len);
5073 else
5074 #endif
5076 int buffered = 0 <= proc_buffered_char[channel];
5077 if (buffered)
5079 chars[carryover] = proc_buffered_char[channel];
5080 proc_buffered_char[channel] = -1;
5082 #ifdef HAVE_GNUTLS
5083 if (p->gnutls_p)
5084 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
5085 readmax - buffered);
5086 else
5087 #endif
5088 nbytes = emacs_read (channel, chars + carryover + buffered,
5089 readmax - buffered);
5090 #ifdef ADAPTIVE_READ_BUFFERING
5091 if (nbytes > 0 && p->adaptive_read_buffering)
5093 int delay = p->read_output_delay;
5094 if (nbytes < 256)
5096 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5098 if (delay == 0)
5099 process_output_delay_count++;
5100 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5103 else if (delay > 0 && nbytes == readmax - buffered)
5105 delay -= READ_OUTPUT_DELAY_INCREMENT;
5106 if (delay == 0)
5107 process_output_delay_count--;
5109 p->read_output_delay = delay;
5110 if (delay)
5112 p->read_output_skip = 1;
5113 process_output_skip = 1;
5116 #endif
5117 nbytes += buffered;
5118 nbytes += buffered && nbytes <= 0;
5121 p->decoding_carryover = 0;
5123 /* At this point, NBYTES holds number of bytes just received
5124 (including the one in proc_buffered_char[channel]). */
5125 if (nbytes <= 0)
5127 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5128 return nbytes;
5129 coding->mode |= CODING_MODE_LAST_BLOCK;
5132 /* Now set NBYTES how many bytes we must decode. */
5133 nbytes += carryover;
5135 odeactivate = Vdeactivate_mark;
5136 /* There's no good reason to let process filters change the current
5137 buffer, and many callers of accept-process-output, sit-for, and
5138 friends don't expect current-buffer to be changed from under them. */
5139 record_unwind_current_buffer ();
5141 /* Read and dispose of the process output. */
5142 outstream = p->filter;
5143 if (!NILP (outstream))
5145 Lisp_Object text;
5146 bool outer_running_asynch_code = running_asynch_code;
5147 int waiting = waiting_for_user_input_p;
5149 /* No need to gcpro these, because all we do with them later
5150 is test them for EQness, and none of them should be a string. */
5151 #if 0
5152 Lisp_Object obuffer, okeymap;
5153 XSETBUFFER (obuffer, current_buffer);
5154 okeymap = BVAR (current_buffer, keymap);
5155 #endif
5157 /* We inhibit quit here instead of just catching it so that
5158 hitting ^G when a filter happens to be running won't screw
5159 it up. */
5160 specbind (Qinhibit_quit, Qt);
5161 specbind (Qlast_nonmenu_event, Qt);
5163 /* In case we get recursively called,
5164 and we already saved the match data nonrecursively,
5165 save the same match data in safely recursive fashion. */
5166 if (outer_running_asynch_code)
5168 Lisp_Object tem;
5169 /* Don't clobber the CURRENT match data, either! */
5170 tem = Fmatch_data (Qnil, Qnil, Qnil);
5171 restore_search_regs ();
5172 record_unwind_save_match_data ();
5173 Fset_match_data (tem, Qt);
5176 /* For speed, if a search happens within this code,
5177 save the match data in a special nonrecursive fashion. */
5178 running_asynch_code = 1;
5180 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5181 text = coding->dst_object;
5182 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5183 /* A new coding system might be found. */
5184 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5186 pset_decode_coding_system (p, Vlast_coding_system_used);
5188 /* Don't call setup_coding_system for
5189 proc_decode_coding_system[channel] here. It is done in
5190 detect_coding called via decode_coding above. */
5192 /* If a coding system for encoding is not yet decided, we set
5193 it as the same as coding-system for decoding.
5195 But, before doing that we must check if
5196 proc_encode_coding_system[p->outfd] surely points to a
5197 valid memory because p->outfd will be changed once EOF is
5198 sent to the process. */
5199 if (NILP (p->encode_coding_system)
5200 && proc_encode_coding_system[p->outfd])
5202 pset_encode_coding_system
5203 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5204 setup_coding_system (p->encode_coding_system,
5205 proc_encode_coding_system[p->outfd]);
5209 if (coding->carryover_bytes > 0)
5211 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5212 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5213 memcpy (SDATA (p->decoding_buf), coding->carryover,
5214 coding->carryover_bytes);
5215 p->decoding_carryover = coding->carryover_bytes;
5217 if (SBYTES (text) > 0)
5218 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5219 sometimes it's simply wrong to wrap (e.g. when called from
5220 accept-process-output). */
5221 internal_condition_case_1 (read_process_output_call,
5222 Fcons (outstream,
5223 Fcons (proc, Fcons (text, Qnil))),
5224 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5225 read_process_output_error_handler);
5227 /* If we saved the match data nonrecursively, restore it now. */
5228 restore_search_regs ();
5229 running_asynch_code = outer_running_asynch_code;
5231 /* Restore waiting_for_user_input_p as it was
5232 when we were called, in case the filter clobbered it. */
5233 waiting_for_user_input_p = waiting;
5235 #if 0 /* Call record_asynch_buffer_change unconditionally,
5236 because we might have changed minor modes or other things
5237 that affect key bindings. */
5238 if (! EQ (Fcurrent_buffer (), obuffer)
5239 || ! EQ (current_buffer->keymap, okeymap))
5240 #endif
5241 /* But do it only if the caller is actually going to read events.
5242 Otherwise there's no need to make him wake up, and it could
5243 cause trouble (for example it would make sit_for return). */
5244 if (waiting_for_user_input_p == -1)
5245 record_asynch_buffer_change ();
5248 /* If no filter, write into buffer if it isn't dead. */
5249 else if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5251 Lisp_Object old_read_only;
5252 ptrdiff_t old_begv, old_zv;
5253 ptrdiff_t old_begv_byte, old_zv_byte;
5254 ptrdiff_t before, before_byte;
5255 ptrdiff_t opoint_byte;
5256 Lisp_Object text;
5257 struct buffer *b;
5259 Fset_buffer (p->buffer);
5260 opoint = PT;
5261 opoint_byte = PT_BYTE;
5262 old_read_only = BVAR (current_buffer, read_only);
5263 old_begv = BEGV;
5264 old_zv = ZV;
5265 old_begv_byte = BEGV_BYTE;
5266 old_zv_byte = ZV_BYTE;
5268 bset_read_only (current_buffer, Qnil);
5270 /* Insert new output into buffer
5271 at the current end-of-output marker,
5272 thus preserving logical ordering of input and output. */
5273 if (XMARKER (p->mark)->buffer)
5274 SET_PT_BOTH (clip_to_bounds (BEGV,
5275 marker_position (p->mark), ZV),
5276 clip_to_bounds (BEGV_BYTE,
5277 marker_byte_position (p->mark),
5278 ZV_BYTE));
5279 else
5280 SET_PT_BOTH (ZV, ZV_BYTE);
5281 before = PT;
5282 before_byte = PT_BYTE;
5284 /* If the output marker is outside of the visible region, save
5285 the restriction and widen. */
5286 if (! (BEGV <= PT && PT <= ZV))
5287 Fwiden ();
5289 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5290 text = coding->dst_object;
5291 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5292 /* A new coding system might be found. See the comment in the
5293 similar code in the previous `if' block. */
5294 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5296 pset_decode_coding_system (p, Vlast_coding_system_used);
5297 if (NILP (p->encode_coding_system)
5298 && proc_encode_coding_system[p->outfd])
5300 pset_encode_coding_system
5301 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5302 setup_coding_system (p->encode_coding_system,
5303 proc_encode_coding_system[p->outfd]);
5306 if (coding->carryover_bytes > 0)
5308 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5309 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5310 memcpy (SDATA (p->decoding_buf), coding->carryover,
5311 coding->carryover_bytes);
5312 p->decoding_carryover = coding->carryover_bytes;
5314 /* Adjust the multibyteness of TEXT to that of the buffer. */
5315 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5316 != ! STRING_MULTIBYTE (text))
5317 text = (STRING_MULTIBYTE (text)
5318 ? Fstring_as_unibyte (text)
5319 : Fstring_to_multibyte (text));
5320 /* Insert before markers in case we are inserting where
5321 the buffer's mark is, and the user's next command is Meta-y. */
5322 insert_from_string_before_markers (text, 0, 0,
5323 SCHARS (text), SBYTES (text), 0);
5325 /* Make sure the process marker's position is valid when the
5326 process buffer is changed in the signal_after_change above.
5327 W3 is known to do that. */
5328 if (BUFFERP (p->buffer)
5329 && (b = XBUFFER (p->buffer), b != current_buffer))
5330 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5331 else
5332 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5334 update_mode_lines++;
5336 /* Make sure opoint and the old restrictions
5337 float ahead of any new text just as point would. */
5338 if (opoint >= before)
5340 opoint += PT - before;
5341 opoint_byte += PT_BYTE - before_byte;
5343 if (old_begv > before)
5345 old_begv += PT - before;
5346 old_begv_byte += PT_BYTE - before_byte;
5348 if (old_zv >= before)
5350 old_zv += PT - before;
5351 old_zv_byte += PT_BYTE - before_byte;
5354 /* If the restriction isn't what it should be, set it. */
5355 if (old_begv != BEGV || old_zv != ZV)
5356 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5359 bset_read_only (current_buffer, old_read_only);
5360 SET_PT_BOTH (opoint, opoint_byte);
5362 /* Handling the process output should not deactivate the mark. */
5363 Vdeactivate_mark = odeactivate;
5365 unbind_to (count, Qnil);
5366 return nbytes;
5369 /* Sending data to subprocess */
5371 /* In send_process, when a write fails temporarily,
5372 wait_reading_process_output is called. It may execute user code,
5373 e.g. timers, that attempts to write new data to the same process.
5374 We must ensure that data is sent in the right order, and not
5375 interspersed half-completed with other writes (Bug#10815). This is
5376 handled by the write_queue element of struct process. It is a list
5377 with each entry having the form
5379 (string . (offset . length))
5381 where STRING is a lisp string, OFFSET is the offset into the
5382 string's byte sequence from which we should begin to send, and
5383 LENGTH is the number of bytes left to send. */
5385 /* Create a new entry in write_queue.
5386 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5387 BUF is a pointer to the string sequence of the input_obj or a C
5388 string in case of Qt or Qnil. */
5390 static void
5391 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5392 const char *buf, ptrdiff_t len, int front)
5394 ptrdiff_t offset;
5395 Lisp_Object entry, obj;
5397 if (STRINGP (input_obj))
5399 offset = buf - SSDATA (input_obj);
5400 obj = input_obj;
5402 else
5404 offset = 0;
5405 obj = make_unibyte_string (buf, len);
5408 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5410 if (front)
5411 pset_write_queue (p, Fcons (entry, p->write_queue));
5412 else
5413 pset_write_queue (p, nconc2 (p->write_queue, Fcons (entry, Qnil)));
5416 /* Remove the first element in the write_queue of process P, put its
5417 contents in OBJ, BUF and LEN, and return non-zero. If the
5418 write_queue is empty, return zero. */
5420 static int
5421 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5422 const char **buf, ptrdiff_t *len)
5424 Lisp_Object entry, offset_length;
5425 ptrdiff_t offset;
5427 if (NILP (p->write_queue))
5428 return 0;
5430 entry = XCAR (p->write_queue);
5431 pset_write_queue (p, XCDR (p->write_queue));
5433 *obj = XCAR (entry);
5434 offset_length = XCDR (entry);
5436 *len = XINT (XCDR (offset_length));
5437 offset = XINT (XCAR (offset_length));
5438 *buf = SSDATA (*obj) + offset;
5440 return 1;
5443 /* Send some data to process PROC.
5444 BUF is the beginning of the data; LEN is the number of characters.
5445 OBJECT is the Lisp object that the data comes from. If OBJECT is
5446 nil or t, it means that the data comes from C string.
5448 If OBJECT is not nil, the data is encoded by PROC's coding-system
5449 for encoding before it is sent.
5451 This function can evaluate Lisp code and can garbage collect. */
5453 static void
5454 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
5455 Lisp_Object object)
5457 struct Lisp_Process *p = XPROCESS (proc);
5458 ssize_t rv;
5459 struct coding_system *coding;
5461 if (p->raw_status_new)
5462 update_status (p);
5463 if (! EQ (p->status, Qrun))
5464 error ("Process %s not running", SDATA (p->name));
5465 if (p->outfd < 0)
5466 error ("Output file descriptor of %s is closed", SDATA (p->name));
5468 coding = proc_encode_coding_system[p->outfd];
5469 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5471 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5472 || (BUFFERP (object)
5473 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5474 || EQ (object, Qt))
5476 pset_encode_coding_system
5477 (p, complement_process_encoding_system (p->encode_coding_system));
5478 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5480 /* The coding system for encoding was changed to raw-text
5481 because we sent a unibyte text previously. Now we are
5482 sending a multibyte text, thus we must encode it by the
5483 original coding system specified for the current process.
5485 Another reason we come here is that the coding system
5486 was just complemented and a new one was returned by
5487 complement_process_encoding_system. */
5488 setup_coding_system (p->encode_coding_system, coding);
5489 Vlast_coding_system_used = p->encode_coding_system;
5491 coding->src_multibyte = 1;
5493 else
5495 coding->src_multibyte = 0;
5496 /* For sending a unibyte text, character code conversion should
5497 not take place but EOL conversion should. So, setup raw-text
5498 or one of the subsidiary if we have not yet done it. */
5499 if (CODING_REQUIRE_ENCODING (coding))
5501 if (CODING_REQUIRE_FLUSHING (coding))
5503 /* But, before changing the coding, we must flush out data. */
5504 coding->mode |= CODING_MODE_LAST_BLOCK;
5505 send_process (proc, "", 0, Qt);
5506 coding->mode &= CODING_MODE_LAST_BLOCK;
5508 setup_coding_system (raw_text_coding_system
5509 (Vlast_coding_system_used),
5510 coding);
5511 coding->src_multibyte = 0;
5514 coding->dst_multibyte = 0;
5516 if (CODING_REQUIRE_ENCODING (coding))
5518 coding->dst_object = Qt;
5519 if (BUFFERP (object))
5521 ptrdiff_t from_byte, from, to;
5522 ptrdiff_t save_pt, save_pt_byte;
5523 struct buffer *cur = current_buffer;
5525 set_buffer_internal (XBUFFER (object));
5526 save_pt = PT, save_pt_byte = PT_BYTE;
5528 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5529 from = BYTE_TO_CHAR (from_byte);
5530 to = BYTE_TO_CHAR (from_byte + len);
5531 TEMP_SET_PT_BOTH (from, from_byte);
5532 encode_coding_object (coding, object, from, from_byte,
5533 to, from_byte + len, Qt);
5534 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5535 set_buffer_internal (cur);
5537 else if (STRINGP (object))
5539 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5540 SBYTES (object), Qt);
5542 else
5544 coding->dst_object = make_unibyte_string (buf, len);
5545 coding->produced = len;
5548 len = coding->produced;
5549 object = coding->dst_object;
5550 buf = SSDATA (object);
5553 if (pty_max_bytes == 0)
5555 #if defined (HAVE_FPATHCONF) && defined (_PC_MAX_CANON)
5556 pty_max_bytes = fpathconf (p->outfd, _PC_MAX_CANON);
5557 if (pty_max_bytes < 0)
5558 pty_max_bytes = 250;
5559 #else
5560 pty_max_bytes = 250;
5561 #endif
5562 /* Deduct one, to leave space for the eof. */
5563 pty_max_bytes--;
5566 /* If there is already data in the write_queue, put the new data
5567 in the back of queue. Otherwise, ignore it. */
5568 if (!NILP (p->write_queue))
5569 write_queue_push (p, object, buf, len, 0);
5571 do /* while !NILP (p->write_queue) */
5573 ptrdiff_t cur_len = -1;
5574 const char *cur_buf;
5575 Lisp_Object cur_object;
5577 /* If write_queue is empty, ignore it. */
5578 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5580 cur_len = len;
5581 cur_buf = buf;
5582 cur_object = object;
5585 while (cur_len > 0)
5587 /* Send this batch, using one or more write calls. */
5588 ptrdiff_t written = 0;
5589 int outfd = p->outfd;
5590 #ifdef DATAGRAM_SOCKETS
5591 if (DATAGRAM_CHAN_P (outfd))
5593 rv = sendto (outfd, cur_buf, cur_len,
5594 0, datagram_address[outfd].sa,
5595 datagram_address[outfd].len);
5596 if (0 <= rv)
5597 written = rv;
5598 else if (errno == EMSGSIZE)
5599 report_file_error ("sending datagram", Fcons (proc, Qnil));
5601 else
5602 #endif
5604 #ifdef HAVE_GNUTLS
5605 if (p->gnutls_p)
5606 written = emacs_gnutls_write (p, cur_buf, cur_len);
5607 else
5608 #endif
5609 written = emacs_write (outfd, cur_buf, cur_len);
5610 rv = (written ? 0 : -1);
5611 #ifdef ADAPTIVE_READ_BUFFERING
5612 if (p->read_output_delay > 0
5613 && p->adaptive_read_buffering == 1)
5615 p->read_output_delay = 0;
5616 process_output_delay_count--;
5617 p->read_output_skip = 0;
5619 #endif
5622 if (rv < 0)
5624 if (0
5625 #ifdef EWOULDBLOCK
5626 || errno == EWOULDBLOCK
5627 #endif
5628 #ifdef EAGAIN
5629 || errno == EAGAIN
5630 #endif
5632 /* Buffer is full. Wait, accepting input;
5633 that may allow the program
5634 to finish doing output and read more. */
5636 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5637 /* A gross hack to work around a bug in FreeBSD.
5638 In the following sequence, read(2) returns
5639 bogus data:
5641 write(2) 1022 bytes
5642 write(2) 954 bytes, get EAGAIN
5643 read(2) 1024 bytes in process_read_output
5644 read(2) 11 bytes in process_read_output
5646 That is, read(2) returns more bytes than have
5647 ever been written successfully. The 1033 bytes
5648 read are the 1022 bytes written successfully
5649 after processing (for example with CRs added if
5650 the terminal is set up that way which it is
5651 here). The same bytes will be seen again in a
5652 later read(2), without the CRs. */
5654 if (errno == EAGAIN)
5656 int flags = FWRITE;
5657 ioctl (p->outfd, TIOCFLUSH, &flags);
5659 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5661 /* Put what we should have written in wait_queue. */
5662 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5663 wait_reading_process_output (0, 20 * 1000 * 1000,
5664 0, 0, Qnil, NULL, 0);
5665 /* Reread queue, to see what is left. */
5666 break;
5668 else if (errno == EPIPE)
5670 p->raw_status_new = 0;
5671 pset_status (p, list2 (Qexit, make_number (256)));
5672 p->tick = ++process_tick;
5673 deactivate_process (proc);
5674 error ("process %s no longer connected to pipe; closed it",
5675 SDATA (p->name));
5677 else
5678 /* This is a real error. */
5679 report_file_error ("writing to process", Fcons (proc, Qnil));
5681 cur_buf += written;
5682 cur_len -= written;
5685 while (!NILP (p->write_queue));
5688 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5689 3, 3, 0,
5690 doc: /* Send current contents of region as input to PROCESS.
5691 PROCESS may be a process, a buffer, the name of a process or buffer, or
5692 nil, indicating the current buffer's process.
5693 Called from program, takes three arguments, PROCESS, START and END.
5694 If the region is more than 500 characters long,
5695 it is sent in several bunches. This may happen even for shorter regions.
5696 Output from processes can arrive in between bunches. */)
5697 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5699 Lisp_Object proc;
5700 ptrdiff_t start1, end1;
5702 proc = get_process (process);
5703 validate_region (&start, &end);
5705 if (XINT (start) < GPT && XINT (end) > GPT)
5706 move_gap (XINT (start));
5708 start1 = CHAR_TO_BYTE (XINT (start));
5709 end1 = CHAR_TO_BYTE (XINT (end));
5710 send_process (proc, (char *) BYTE_POS_ADDR (start1), end1 - start1,
5711 Fcurrent_buffer ());
5713 return Qnil;
5716 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5717 2, 2, 0,
5718 doc: /* Send PROCESS the contents of STRING as input.
5719 PROCESS may be a process, a buffer, the name of a process or buffer, or
5720 nil, indicating the current buffer's process.
5721 If STRING is more than 500 characters long,
5722 it is sent in several bunches. This may happen even for shorter strings.
5723 Output from processes can arrive in between bunches. */)
5724 (Lisp_Object process, Lisp_Object string)
5726 Lisp_Object proc;
5727 CHECK_STRING (string);
5728 proc = get_process (process);
5729 send_process (proc, SSDATA (string),
5730 SBYTES (string), string);
5731 return Qnil;
5734 /* Return the foreground process group for the tty/pty that
5735 the process P uses. */
5736 static pid_t
5737 emacs_get_tty_pgrp (struct Lisp_Process *p)
5739 pid_t gid = -1;
5741 #ifdef TIOCGPGRP
5742 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5744 int fd;
5745 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5746 master side. Try the slave side. */
5747 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5749 if (fd != -1)
5751 ioctl (fd, TIOCGPGRP, &gid);
5752 emacs_close (fd);
5755 #endif /* defined (TIOCGPGRP ) */
5757 return gid;
5760 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5761 Sprocess_running_child_p, 0, 1, 0,
5762 doc: /* Return t if PROCESS has given the terminal to a child.
5763 If the operating system does not make it possible to find out,
5764 return t unconditionally. */)
5765 (Lisp_Object process)
5767 /* Initialize in case ioctl doesn't exist or gives an error,
5768 in a way that will cause returning t. */
5769 pid_t gid;
5770 Lisp_Object proc;
5771 struct Lisp_Process *p;
5773 proc = get_process (process);
5774 p = XPROCESS (proc);
5776 if (!EQ (p->type, Qreal))
5777 error ("Process %s is not a subprocess",
5778 SDATA (p->name));
5779 if (p->infd < 0)
5780 error ("Process %s is not active",
5781 SDATA (p->name));
5783 gid = emacs_get_tty_pgrp (p);
5785 if (gid == p->pid)
5786 return Qnil;
5787 return Qt;
5790 /* send a signal number SIGNO to PROCESS.
5791 If CURRENT_GROUP is t, that means send to the process group
5792 that currently owns the terminal being used to communicate with PROCESS.
5793 This is used for various commands in shell mode.
5794 If CURRENT_GROUP is lambda, that means send to the process group
5795 that currently owns the terminal, but only if it is NOT the shell itself.
5797 If NOMSG is zero, insert signal-announcements into process's buffers
5798 right away.
5800 If we can, we try to signal PROCESS by sending control characters
5801 down the pty. This allows us to signal inferiors who have changed
5802 their uid, for which killpg would return an EPERM error. */
5804 static void
5805 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5806 int nomsg)
5808 Lisp_Object proc;
5809 register struct Lisp_Process *p;
5810 pid_t gid;
5811 int no_pgrp = 0;
5813 proc = get_process (process);
5814 p = XPROCESS (proc);
5816 if (!EQ (p->type, Qreal))
5817 error ("Process %s is not a subprocess",
5818 SDATA (p->name));
5819 if (p->infd < 0)
5820 error ("Process %s is not active",
5821 SDATA (p->name));
5823 if (!p->pty_flag)
5824 current_group = Qnil;
5826 /* If we are using pgrps, get a pgrp number and make it negative. */
5827 if (NILP (current_group))
5828 /* Send the signal to the shell's process group. */
5829 gid = p->pid;
5830 else
5832 #ifdef SIGNALS_VIA_CHARACTERS
5833 /* If possible, send signals to the entire pgrp
5834 by sending an input character to it. */
5836 struct termios t;
5837 cc_t *sig_char = NULL;
5839 tcgetattr (p->infd, &t);
5841 switch (signo)
5843 case SIGINT:
5844 sig_char = &t.c_cc[VINTR];
5845 break;
5847 case SIGQUIT:
5848 sig_char = &t.c_cc[VQUIT];
5849 break;
5851 case SIGTSTP:
5852 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5853 sig_char = &t.c_cc[VSWTCH];
5854 #else
5855 sig_char = &t.c_cc[VSUSP];
5856 #endif
5857 break;
5860 if (sig_char && *sig_char != CDISABLE)
5862 send_process (proc, (char *) sig_char, 1, Qnil);
5863 return;
5865 /* If we can't send the signal with a character,
5866 fall through and send it another way. */
5868 /* The code above may fall through if it can't
5869 handle the signal. */
5870 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5872 #ifdef TIOCGPGRP
5873 /* Get the current pgrp using the tty itself, if we have that.
5874 Otherwise, use the pty to get the pgrp.
5875 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5876 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5877 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5878 His patch indicates that if TIOCGPGRP returns an error, then
5879 we should just assume that p->pid is also the process group id. */
5881 gid = emacs_get_tty_pgrp (p);
5883 if (gid == -1)
5884 /* If we can't get the information, assume
5885 the shell owns the tty. */
5886 gid = p->pid;
5888 /* It is not clear whether anything really can set GID to -1.
5889 Perhaps on some system one of those ioctls can or could do so.
5890 Or perhaps this is vestigial. */
5891 if (gid == -1)
5892 no_pgrp = 1;
5893 #else /* ! defined (TIOCGPGRP ) */
5894 /* Can't select pgrps on this system, so we know that
5895 the child itself heads the pgrp. */
5896 gid = p->pid;
5897 #endif /* ! defined (TIOCGPGRP ) */
5899 /* If current_group is lambda, and the shell owns the terminal,
5900 don't send any signal. */
5901 if (EQ (current_group, Qlambda) && gid == p->pid)
5902 return;
5905 switch (signo)
5907 #ifdef SIGCONT
5908 case SIGCONT:
5909 p->raw_status_new = 0;
5910 pset_status (p, Qrun);
5911 p->tick = ++process_tick;
5912 if (!nomsg)
5914 status_notify (NULL);
5915 redisplay_preserve_echo_area (13);
5917 break;
5918 #endif /* ! defined (SIGCONT) */
5919 case SIGINT:
5920 case SIGQUIT:
5921 case SIGKILL:
5922 flush_pending_output (p->infd);
5923 break;
5926 /* If we don't have process groups, send the signal to the immediate
5927 subprocess. That isn't really right, but it's better than any
5928 obvious alternative. */
5929 if (no_pgrp)
5931 kill (p->pid, signo);
5932 return;
5935 /* gid may be a pid, or minus a pgrp's number */
5936 #ifdef TIOCSIGSEND
5937 if (!NILP (current_group))
5939 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5940 EMACS_KILLPG (gid, signo);
5942 else
5944 gid = - p->pid;
5945 kill (gid, signo);
5947 #else /* ! defined (TIOCSIGSEND) */
5948 EMACS_KILLPG (gid, signo);
5949 #endif /* ! defined (TIOCSIGSEND) */
5952 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5953 doc: /* Interrupt process PROCESS.
5954 PROCESS may be a process, a buffer, or the name of a process or buffer.
5955 No arg or nil means current buffer's process.
5956 Second arg CURRENT-GROUP non-nil means send signal to
5957 the current process-group of the process's controlling terminal
5958 rather than to the process's own process group.
5959 If the process is a shell, this means interrupt current subjob
5960 rather than the shell.
5962 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5963 don't send the signal. */)
5964 (Lisp_Object process, Lisp_Object current_group)
5966 process_send_signal (process, SIGINT, current_group, 0);
5967 return process;
5970 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5971 doc: /* Kill process PROCESS. May be process or name of one.
5972 See function `interrupt-process' for more details on usage. */)
5973 (Lisp_Object process, Lisp_Object current_group)
5975 process_send_signal (process, SIGKILL, current_group, 0);
5976 return process;
5979 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5980 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5981 See function `interrupt-process' for more details on usage. */)
5982 (Lisp_Object process, Lisp_Object current_group)
5984 process_send_signal (process, SIGQUIT, current_group, 0);
5985 return process;
5988 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
5989 doc: /* Stop process PROCESS. May be process or name of one.
5990 See function `interrupt-process' for more details on usage.
5991 If PROCESS is a network or serial process, inhibit handling of incoming
5992 traffic. */)
5993 (Lisp_Object process, Lisp_Object current_group)
5995 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5997 struct Lisp_Process *p;
5999 p = XPROCESS (process);
6000 if (NILP (p->command)
6001 && p->infd >= 0)
6003 FD_CLR (p->infd, &input_wait_mask);
6004 FD_CLR (p->infd, &non_keyboard_wait_mask);
6006 pset_command (p, Qt);
6007 return process;
6009 #ifndef SIGTSTP
6010 error ("No SIGTSTP support");
6011 #else
6012 process_send_signal (process, SIGTSTP, current_group, 0);
6013 #endif
6014 return process;
6017 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
6018 doc: /* Continue process PROCESS. May be process or name of one.
6019 See function `interrupt-process' for more details on usage.
6020 If PROCESS is a network or serial process, resume handling of incoming
6021 traffic. */)
6022 (Lisp_Object process, Lisp_Object current_group)
6024 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
6026 struct Lisp_Process *p;
6028 p = XPROCESS (process);
6029 if (EQ (p->command, Qt)
6030 && p->infd >= 0
6031 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
6033 FD_SET (p->infd, &input_wait_mask);
6034 FD_SET (p->infd, &non_keyboard_wait_mask);
6035 #ifdef WINDOWSNT
6036 if (fd_info[ p->infd ].flags & FILE_SERIAL)
6037 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
6038 #else /* not WINDOWSNT */
6039 tcflush (p->infd, TCIFLUSH);
6040 #endif /* not WINDOWSNT */
6042 pset_command (p, Qnil);
6043 return process;
6045 #ifdef SIGCONT
6046 process_send_signal (process, SIGCONT, current_group, 0);
6047 #else
6048 error ("No SIGCONT support");
6049 #endif
6050 return process;
6053 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
6054 2, 2, "sProcess (name or number): \nnSignal code: ",
6055 doc: /* Send PROCESS the signal with code SIGCODE.
6056 PROCESS may also be a number specifying the process id of the
6057 process to signal; in this case, the process need not be a child of
6058 this Emacs.
6059 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
6060 (Lisp_Object process, Lisp_Object sigcode)
6062 pid_t pid;
6064 if (STRINGP (process))
6066 Lisp_Object tem = Fget_process (process);
6067 if (NILP (tem))
6069 Lisp_Object process_number =
6070 string_to_number (SSDATA (process), 10, 1);
6071 if (INTEGERP (process_number) || FLOATP (process_number))
6072 tem = process_number;
6074 process = tem;
6076 else if (!NUMBERP (process))
6077 process = get_process (process);
6079 if (NILP (process))
6080 return process;
6082 if (NUMBERP (process))
6083 CONS_TO_INTEGER (process, pid_t, pid);
6084 else
6086 CHECK_PROCESS (process);
6087 pid = XPROCESS (process)->pid;
6088 if (pid <= 0)
6089 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
6092 #define parse_signal(NAME, VALUE) \
6093 else if (!xstrcasecmp (name, NAME)) \
6094 XSETINT (sigcode, VALUE)
6096 if (INTEGERP (sigcode))
6097 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
6098 else
6100 char *name;
6102 CHECK_SYMBOL (sigcode);
6103 name = SSDATA (SYMBOL_NAME (sigcode));
6105 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
6106 name += 3;
6108 if (0)
6110 #ifdef SIGUSR1
6111 parse_signal ("usr1", SIGUSR1);
6112 #endif
6113 #ifdef SIGUSR2
6114 parse_signal ("usr2", SIGUSR2);
6115 #endif
6116 parse_signal ("term", SIGTERM);
6117 #ifdef SIGHUP
6118 parse_signal ("hup", SIGHUP);
6119 #endif
6120 parse_signal ("int", SIGINT);
6121 #ifdef SIGQUIT
6122 parse_signal ("quit", SIGQUIT);
6123 #endif
6124 parse_signal ("ill", SIGILL);
6125 parse_signal ("abrt", SIGABRT);
6126 #ifdef SIGEMT
6127 parse_signal ("emt", SIGEMT);
6128 #endif
6129 #ifdef SIGKILL
6130 parse_signal ("kill", SIGKILL);
6131 #endif
6132 parse_signal ("fpe", SIGFPE);
6133 #ifdef SIGBUS
6134 parse_signal ("bus", SIGBUS);
6135 #endif
6136 parse_signal ("segv", SIGSEGV);
6137 #ifdef SIGSYS
6138 parse_signal ("sys", SIGSYS);
6139 #endif
6140 #ifdef SIGPIPE
6141 parse_signal ("pipe", SIGPIPE);
6142 #endif
6143 #ifdef SIGALRM
6144 parse_signal ("alrm", SIGALRM);
6145 #endif
6146 #ifdef SIGURG
6147 parse_signal ("urg", SIGURG);
6148 #endif
6149 #ifdef SIGSTOP
6150 parse_signal ("stop", SIGSTOP);
6151 #endif
6152 #ifdef SIGTSTP
6153 parse_signal ("tstp", SIGTSTP);
6154 #endif
6155 #ifdef SIGCONT
6156 parse_signal ("cont", SIGCONT);
6157 #endif
6158 #ifdef SIGCHLD
6159 parse_signal ("chld", SIGCHLD);
6160 #endif
6161 #ifdef SIGTTIN
6162 parse_signal ("ttin", SIGTTIN);
6163 #endif
6164 #ifdef SIGTTOU
6165 parse_signal ("ttou", SIGTTOU);
6166 #endif
6167 #ifdef SIGIO
6168 parse_signal ("io", SIGIO);
6169 #endif
6170 #ifdef SIGXCPU
6171 parse_signal ("xcpu", SIGXCPU);
6172 #endif
6173 #ifdef SIGXFSZ
6174 parse_signal ("xfsz", SIGXFSZ);
6175 #endif
6176 #ifdef SIGVTALRM
6177 parse_signal ("vtalrm", SIGVTALRM);
6178 #endif
6179 #ifdef SIGPROF
6180 parse_signal ("prof", SIGPROF);
6181 #endif
6182 #ifdef SIGWINCH
6183 parse_signal ("winch", SIGWINCH);
6184 #endif
6185 #ifdef SIGINFO
6186 parse_signal ("info", SIGINFO);
6187 #endif
6188 else
6189 error ("Undefined signal name %s", name);
6192 #undef parse_signal
6194 return make_number (kill (pid, XINT (sigcode)));
6197 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6198 doc: /* Make PROCESS see end-of-file in its input.
6199 EOF comes after any text already sent to it.
6200 PROCESS may be a process, a buffer, the name of a process or buffer, or
6201 nil, indicating the current buffer's process.
6202 If PROCESS is a network connection, or is a process communicating
6203 through a pipe (as opposed to a pty), then you cannot send any more
6204 text to PROCESS after you call this function.
6205 If PROCESS is a serial process, wait until all output written to the
6206 process has been transmitted to the serial port. */)
6207 (Lisp_Object process)
6209 Lisp_Object proc;
6210 struct coding_system *coding;
6212 if (DATAGRAM_CONN_P (process))
6213 return process;
6215 proc = get_process (process);
6216 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6218 /* Make sure the process is really alive. */
6219 if (XPROCESS (proc)->raw_status_new)
6220 update_status (XPROCESS (proc));
6221 if (! EQ (XPROCESS (proc)->status, Qrun))
6222 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6224 if (CODING_REQUIRE_FLUSHING (coding))
6226 coding->mode |= CODING_MODE_LAST_BLOCK;
6227 send_process (proc, "", 0, Qnil);
6230 if (XPROCESS (proc)->pty_flag)
6231 send_process (proc, "\004", 1, Qnil);
6232 else if (EQ (XPROCESS (proc)->type, Qserial))
6234 #ifndef WINDOWSNT
6235 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6236 error ("tcdrain() failed: %s", emacs_strerror (errno));
6237 #endif /* not WINDOWSNT */
6238 /* Do nothing on Windows because writes are blocking. */
6240 else
6242 int old_outfd, new_outfd;
6244 #ifdef HAVE_SHUTDOWN
6245 /* If this is a network connection, or socketpair is used
6246 for communication with the subprocess, call shutdown to cause EOF.
6247 (In some old system, shutdown to socketpair doesn't work.
6248 Then we just can't win.) */
6249 if (EQ (XPROCESS (proc)->type, Qnetwork)
6250 || XPROCESS (proc)->outfd == XPROCESS (proc)->infd)
6251 shutdown (XPROCESS (proc)->outfd, 1);
6252 /* In case of socketpair, outfd == infd, so don't close it. */
6253 if (XPROCESS (proc)->outfd != XPROCESS (proc)->infd)
6254 emacs_close (XPROCESS (proc)->outfd);
6255 #else /* not HAVE_SHUTDOWN */
6256 emacs_close (XPROCESS (proc)->outfd);
6257 #endif /* not HAVE_SHUTDOWN */
6258 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6259 if (new_outfd < 0)
6260 emacs_abort ();
6261 old_outfd = XPROCESS (proc)->outfd;
6263 if (!proc_encode_coding_system[new_outfd])
6264 proc_encode_coding_system[new_outfd]
6265 = xmalloc (sizeof (struct coding_system));
6266 *proc_encode_coding_system[new_outfd]
6267 = *proc_encode_coding_system[old_outfd];
6268 memset (proc_encode_coding_system[old_outfd], 0,
6269 sizeof (struct coding_system));
6271 XPROCESS (proc)->outfd = new_outfd;
6273 return process;
6276 /* On receipt of a signal that a child status has changed, loop asking
6277 about children with changed statuses until the system says there
6278 are no more.
6280 All we do is change the status; we do not run sentinels or print
6281 notifications. That is saved for the next time keyboard input is
6282 done, in order to avoid timing errors.
6284 ** WARNING: this can be called during garbage collection.
6285 Therefore, it must not be fooled by the presence of mark bits in
6286 Lisp objects.
6288 ** USG WARNING: Although it is not obvious from the documentation
6289 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6290 signal() before executing at least one wait(), otherwise the
6291 handler will be called again, resulting in an infinite loop. The
6292 relevant portion of the documentation reads "SIGCLD signals will be
6293 queued and the signal-catching function will be continually
6294 reentered until the queue is empty". Invoking signal() causes the
6295 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6296 Inc.
6298 ** Malloc WARNING: This should never call malloc either directly or
6299 indirectly; if it does, that is a bug */
6301 /* Record the changed status of the child process PID with wait status W. */
6302 void
6303 record_child_status_change (pid_t pid, int w)
6305 #ifdef SIGCHLD
6306 Lisp_Object proc;
6307 struct Lisp_Process *p;
6308 Lisp_Object tail;
6310 /* Find the process that signaled us, and record its status. */
6312 /* The process can have been deleted by Fdelete_process. */
6313 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6315 Lisp_Object xpid = XCAR (tail);
6316 if ((INTEGERP (xpid) && pid == XINT (xpid))
6317 || (FLOATP (xpid) && pid == XFLOAT_DATA (xpid)))
6319 XSETCAR (tail, Qnil);
6320 return;
6324 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6325 p = 0;
6326 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6328 proc = XCDR (XCAR (tail));
6329 p = XPROCESS (proc);
6330 if (EQ (p->type, Qreal) && p->pid == pid)
6331 break;
6332 p = 0;
6335 /* Look for an asynchronous process whose pid hasn't been filled
6336 in yet. */
6337 if (! p)
6338 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6340 proc = XCDR (XCAR (tail));
6341 p = XPROCESS (proc);
6342 if (p->pid == -1)
6343 break;
6344 p = 0;
6347 /* Change the status of the process that was found. */
6348 if (p)
6350 int clear_desc_flag = 0;
6352 p->tick = ++process_tick;
6353 p->raw_status = w;
6354 p->raw_status_new = 1;
6356 /* If process has terminated, stop waiting for its output. */
6357 if ((WIFSIGNALED (w) || WIFEXITED (w))
6358 && p->infd >= 0)
6359 clear_desc_flag = 1;
6361 /* We use clear_desc_flag to avoid a compiler bug in Microsoft C. */
6362 if (clear_desc_flag)
6364 FD_CLR (p->infd, &input_wait_mask);
6365 FD_CLR (p->infd, &non_keyboard_wait_mask);
6368 /* Tell wait_reading_process_output that it needs to wake up and
6369 look around. */
6370 if (input_available_clear_time)
6371 *input_available_clear_time = make_emacs_time (0, 0);
6373 /* There was no asynchronous process found for that pid: we have
6374 a synchronous process. */
6375 else
6377 synch_process_alive = 0;
6379 /* Report the status of the synchronous process. */
6380 if (WIFEXITED (w))
6381 synch_process_retcode = WEXITSTATUS (w);
6382 else if (WIFSIGNALED (w))
6383 synch_process_termsig = WTERMSIG (w);
6385 /* Tell wait_reading_process_output that it needs to wake up and
6386 look around. */
6387 if (input_available_clear_time)
6388 *input_available_clear_time = make_emacs_time (0, 0);
6390 #endif
6393 #ifdef SIGCHLD
6395 /* On some systems, the SIGCHLD handler must return right away. If
6396 any more processes want to signal us, we will get another signal.
6397 Otherwise, loop around to use up all the processes that have
6398 something to tell us. */
6399 #if (defined WINDOWSNT \
6400 || (defined USG && !defined GNU_LINUX \
6401 && !(defined HPUX && defined WNOHANG)))
6402 enum { CAN_HANDLE_MULTIPLE_CHILDREN = 0 };
6403 #else
6404 enum { CAN_HANDLE_MULTIPLE_CHILDREN = 1 };
6405 #endif
6407 static void
6408 handle_child_signal (int sig)
6412 pid_t pid;
6413 int status;
6416 pid = waitpid (-1, &status, WNOHANG | WUNTRACED);
6417 while (pid < 0 && errno == EINTR);
6419 /* PID == 0 means no processes found, PID == -1 means a real failure.
6420 Either way, we have done all our job. */
6421 if (pid <= 0)
6422 break;
6424 record_child_status_change (pid, status);
6426 while (CAN_HANDLE_MULTIPLE_CHILDREN);
6429 static void
6430 deliver_child_signal (int sig)
6432 deliver_process_signal (sig, handle_child_signal);
6435 #endif /* SIGCHLD */
6438 static Lisp_Object
6439 exec_sentinel_unwind (Lisp_Object data)
6441 pset_sentinel (XPROCESS (XCAR (data)), XCDR (data));
6442 return Qnil;
6445 static Lisp_Object
6446 exec_sentinel_error_handler (Lisp_Object error_val)
6448 cmd_error_internal (error_val, "error in process sentinel: ");
6449 Vinhibit_quit = Qt;
6450 update_echo_area ();
6451 Fsleep_for (make_number (2), Qnil);
6452 return Qt;
6455 static void
6456 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6458 Lisp_Object sentinel, odeactivate;
6459 struct Lisp_Process *p = XPROCESS (proc);
6460 ptrdiff_t count = SPECPDL_INDEX ();
6461 bool outer_running_asynch_code = running_asynch_code;
6462 int waiting = waiting_for_user_input_p;
6464 if (inhibit_sentinels)
6465 return;
6467 /* No need to gcpro these, because all we do with them later
6468 is test them for EQness, and none of them should be a string. */
6469 odeactivate = Vdeactivate_mark;
6470 #if 0
6471 Lisp_Object obuffer, okeymap;
6472 XSETBUFFER (obuffer, current_buffer);
6473 okeymap = BVAR (current_buffer, keymap);
6474 #endif
6476 /* There's no good reason to let sentinels change the current
6477 buffer, and many callers of accept-process-output, sit-for, and
6478 friends don't expect current-buffer to be changed from under them. */
6479 record_unwind_current_buffer ();
6481 sentinel = p->sentinel;
6482 if (NILP (sentinel))
6483 return;
6485 /* Zilch the sentinel while it's running, to avoid recursive invocations;
6486 assure that it gets restored no matter how the sentinel exits. */
6487 pset_sentinel (p, Qnil);
6488 record_unwind_protect (exec_sentinel_unwind, Fcons (proc, sentinel));
6489 /* Inhibit quit so that random quits don't screw up a running filter. */
6490 specbind (Qinhibit_quit, Qt);
6491 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6493 /* In case we get recursively called,
6494 and we already saved the match data nonrecursively,
6495 save the same match data in safely recursive fashion. */
6496 if (outer_running_asynch_code)
6498 Lisp_Object tem;
6499 tem = Fmatch_data (Qnil, Qnil, Qnil);
6500 restore_search_regs ();
6501 record_unwind_save_match_data ();
6502 Fset_match_data (tem, Qt);
6505 /* For speed, if a search happens within this code,
6506 save the match data in a special nonrecursive fashion. */
6507 running_asynch_code = 1;
6509 internal_condition_case_1 (read_process_output_call,
6510 Fcons (sentinel,
6511 Fcons (proc, Fcons (reason, Qnil))),
6512 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6513 exec_sentinel_error_handler);
6515 /* If we saved the match data nonrecursively, restore it now. */
6516 restore_search_regs ();
6517 running_asynch_code = outer_running_asynch_code;
6519 Vdeactivate_mark = odeactivate;
6521 /* Restore waiting_for_user_input_p as it was
6522 when we were called, in case the filter clobbered it. */
6523 waiting_for_user_input_p = waiting;
6525 #if 0
6526 if (! EQ (Fcurrent_buffer (), obuffer)
6527 || ! EQ (current_buffer->keymap, okeymap))
6528 #endif
6529 /* But do it only if the caller is actually going to read events.
6530 Otherwise there's no need to make him wake up, and it could
6531 cause trouble (for example it would make sit_for return). */
6532 if (waiting_for_user_input_p == -1)
6533 record_asynch_buffer_change ();
6535 unbind_to (count, Qnil);
6538 /* Report all recent events of a change in process status
6539 (either run the sentinel or output a message).
6540 This is usually done while Emacs is waiting for keyboard input
6541 but can be done at other times. */
6543 static void
6544 status_notify (struct Lisp_Process *deleting_process)
6546 register Lisp_Object proc, buffer;
6547 Lisp_Object tail, msg;
6548 struct gcpro gcpro1, gcpro2;
6550 tail = Qnil;
6551 msg = Qnil;
6552 /* We need to gcpro tail; if read_process_output calls a filter
6553 which deletes a process and removes the cons to which tail points
6554 from Vprocess_alist, and then causes a GC, tail is an unprotected
6555 reference. */
6556 GCPRO2 (tail, msg);
6558 /* Set this now, so that if new processes are created by sentinels
6559 that we run, we get called again to handle their status changes. */
6560 update_tick = process_tick;
6562 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6564 Lisp_Object symbol;
6565 register struct Lisp_Process *p;
6567 proc = Fcdr (XCAR (tail));
6568 p = XPROCESS (proc);
6570 if (p->tick != p->update_tick)
6572 p->update_tick = p->tick;
6574 /* If process is still active, read any output that remains. */
6575 while (! EQ (p->filter, Qt)
6576 && ! EQ (p->status, Qconnect)
6577 && ! EQ (p->status, Qlisten)
6578 /* Network or serial process not stopped: */
6579 && ! EQ (p->command, Qt)
6580 && p->infd >= 0
6581 && p != deleting_process
6582 && read_process_output (proc, p->infd) > 0);
6584 buffer = p->buffer;
6586 /* Get the text to use for the message. */
6587 if (p->raw_status_new)
6588 update_status (p);
6589 msg = status_message (p);
6591 /* If process is terminated, deactivate it or delete it. */
6592 symbol = p->status;
6593 if (CONSP (p->status))
6594 symbol = XCAR (p->status);
6596 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6597 || EQ (symbol, Qclosed))
6599 if (delete_exited_processes)
6600 remove_process (proc);
6601 else
6602 deactivate_process (proc);
6605 /* The actions above may have further incremented p->tick.
6606 So set p->update_tick again
6607 so that an error in the sentinel will not cause
6608 this code to be run again. */
6609 p->update_tick = p->tick;
6610 /* Now output the message suitably. */
6611 if (!NILP (p->sentinel))
6612 exec_sentinel (proc, msg);
6613 /* Don't bother with a message in the buffer
6614 when a process becomes runnable. */
6615 else if (!EQ (symbol, Qrun) && !NILP (buffer))
6617 Lisp_Object tem;
6618 struct buffer *old = current_buffer;
6619 ptrdiff_t opoint, opoint_byte;
6620 ptrdiff_t before, before_byte;
6622 /* Avoid error if buffer is deleted
6623 (probably that's why the process is dead, too) */
6624 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
6625 continue;
6626 Fset_buffer (buffer);
6628 opoint = PT;
6629 opoint_byte = PT_BYTE;
6630 /* Insert new output into buffer
6631 at the current end-of-output marker,
6632 thus preserving logical ordering of input and output. */
6633 if (XMARKER (p->mark)->buffer)
6634 Fgoto_char (p->mark);
6635 else
6636 SET_PT_BOTH (ZV, ZV_BYTE);
6638 before = PT;
6639 before_byte = PT_BYTE;
6641 tem = BVAR (current_buffer, read_only);
6642 bset_read_only (current_buffer, Qnil);
6643 insert_string ("\nProcess ");
6644 { /* FIXME: temporary kludge */
6645 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
6646 insert_string (" ");
6647 Finsert (1, &msg);
6648 bset_read_only (current_buffer, tem);
6649 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6651 if (opoint >= before)
6652 SET_PT_BOTH (opoint + (PT - before),
6653 opoint_byte + (PT_BYTE - before_byte));
6654 else
6655 SET_PT_BOTH (opoint, opoint_byte);
6657 set_buffer_internal (old);
6660 } /* end for */
6662 update_mode_lines++; /* in case buffers use %s in mode-line-format */
6663 UNGCPRO;
6667 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6668 Sset_process_coding_system, 1, 3, 0,
6669 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6670 DECODING will be used to decode subprocess output and ENCODING to
6671 encode subprocess input. */)
6672 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6674 register struct Lisp_Process *p;
6676 CHECK_PROCESS (process);
6677 p = XPROCESS (process);
6678 if (p->infd < 0)
6679 error ("Input file descriptor of %s closed", SDATA (p->name));
6680 if (p->outfd < 0)
6681 error ("Output file descriptor of %s closed", SDATA (p->name));
6682 Fcheck_coding_system (decoding);
6683 Fcheck_coding_system (encoding);
6684 encoding = coding_inherit_eol_type (encoding, Qnil);
6685 pset_decode_coding_system (p, decoding);
6686 pset_encode_coding_system (p, encoding);
6687 setup_process_coding_systems (process);
6689 return Qnil;
6692 DEFUN ("process-coding-system",
6693 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6694 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6695 (register Lisp_Object process)
6697 CHECK_PROCESS (process);
6698 return Fcons (XPROCESS (process)->decode_coding_system,
6699 XPROCESS (process)->encode_coding_system);
6702 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6703 Sset_process_filter_multibyte, 2, 2, 0,
6704 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6705 If FLAG is non-nil, the filter is given multibyte strings.
6706 If FLAG is nil, the filter is given unibyte strings. In this case,
6707 all character code conversion except for end-of-line conversion is
6708 suppressed. */)
6709 (Lisp_Object process, Lisp_Object flag)
6711 register struct Lisp_Process *p;
6713 CHECK_PROCESS (process);
6714 p = XPROCESS (process);
6715 if (NILP (flag))
6716 pset_decode_coding_system
6717 (p, raw_text_coding_system (p->decode_coding_system));
6718 setup_process_coding_systems (process);
6720 return Qnil;
6723 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6724 Sprocess_filter_multibyte_p, 1, 1, 0,
6725 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6726 (Lisp_Object process)
6728 register struct Lisp_Process *p;
6729 struct coding_system *coding;
6731 CHECK_PROCESS (process);
6732 p = XPROCESS (process);
6733 coding = proc_decode_coding_system[p->infd];
6734 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6740 # ifdef HAVE_GPM
6742 void
6743 add_gpm_wait_descriptor (int desc)
6745 add_keyboard_wait_descriptor (desc);
6748 void
6749 delete_gpm_wait_descriptor (int desc)
6751 delete_keyboard_wait_descriptor (desc);
6754 # endif
6756 # ifdef USABLE_SIGIO
6758 /* Return nonzero if *MASK has a bit set
6759 that corresponds to one of the keyboard input descriptors. */
6761 static int
6762 keyboard_bit_set (fd_set *mask)
6764 int fd;
6766 for (fd = 0; fd <= max_input_desc; fd++)
6767 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6768 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6769 return 1;
6771 return 0;
6773 # endif
6775 #else /* not subprocesses */
6777 /* Defined on msdos.c. */
6778 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
6779 EMACS_TIME *, void *);
6781 /* Implementation of wait_reading_process_output, assuming that there
6782 are no subprocesses. Used only by the MS-DOS build.
6784 Wait for timeout to elapse and/or keyboard input to be available.
6786 TIME_LIMIT is:
6787 timeout in seconds
6788 If negative, gobble data immediately available but don't wait for any.
6790 NSECS is:
6791 an additional duration to wait, measured in nanoseconds
6792 If TIME_LIMIT is zero, then:
6793 If NSECS == 0, there is no limit.
6794 If NSECS > 0, the timeout consists of NSECS only.
6795 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6797 READ_KBD is:
6798 0 to ignore keyboard input, or
6799 1 to return when input is available, or
6800 -1 means caller will actually read the input, so don't throw to
6801 the quit handler.
6803 see full version for other parameters. We know that wait_proc will
6804 always be NULL, since `subprocesses' isn't defined.
6806 DO_DISPLAY means redisplay should be done to show subprocess
6807 output that arrives.
6809 Return true if we received input from any process. */
6812 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6813 bool do_display,
6814 Lisp_Object wait_for_cell,
6815 struct Lisp_Process *wait_proc, int just_wait_proc)
6817 register int nfds;
6818 EMACS_TIME end_time, timeout;
6820 if (time_limit < 0)
6822 time_limit = 0;
6823 nsecs = -1;
6825 else if (TYPE_MAXIMUM (time_t) < time_limit)
6826 time_limit = TYPE_MAXIMUM (time_t);
6828 /* What does time_limit really mean? */
6829 if (time_limit || 0 < nsecs)
6831 timeout = make_emacs_time (time_limit, nsecs);
6832 end_time = add_emacs_time (current_emacs_time (), timeout);
6835 /* Turn off periodic alarms (in case they are in use)
6836 and then turn off any other atimers,
6837 because the select emulator uses alarms. */
6838 stop_polling ();
6839 turn_on_atimers (0);
6841 while (1)
6843 int timeout_reduced_for_timers = 0;
6844 SELECT_TYPE waitchannels;
6845 int xerrno;
6847 /* If calling from keyboard input, do not quit
6848 since we want to return C-g as an input character.
6849 Otherwise, do pending quit if requested. */
6850 if (read_kbd >= 0)
6851 QUIT;
6853 /* Exit now if the cell we're waiting for became non-nil. */
6854 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6855 break;
6857 /* Compute time from now till when time limit is up */
6858 /* Exit if already run out */
6859 if (nsecs < 0)
6861 /* A negative timeout means
6862 gobble output available now
6863 but don't wait at all. */
6865 timeout = make_emacs_time (0, 0);
6867 else if (time_limit || 0 < nsecs)
6869 EMACS_TIME now = current_emacs_time ();
6870 if (EMACS_TIME_LE (end_time, now))
6871 break;
6872 timeout = sub_emacs_time (end_time, now);
6874 else
6876 timeout = make_emacs_time (100000, 0);
6879 /* If our caller will not immediately handle keyboard events,
6880 run timer events directly.
6881 (Callers that will immediately read keyboard events
6882 call timer_delay on their own.) */
6883 if (NILP (wait_for_cell))
6885 EMACS_TIME timer_delay;
6889 unsigned old_timers_run = timers_run;
6890 timer_delay = timer_check ();
6891 if (timers_run != old_timers_run && do_display)
6892 /* We must retry, since a timer may have requeued itself
6893 and that could alter the time delay. */
6894 redisplay_preserve_echo_area (14);
6895 else
6896 break;
6898 while (!detect_input_pending ());
6900 /* If there is unread keyboard input, also return. */
6901 if (read_kbd != 0
6902 && requeued_events_pending_p ())
6903 break;
6905 if (EMACS_TIME_VALID_P (timer_delay) && 0 <= nsecs)
6907 if (EMACS_TIME_LT (timer_delay, timeout))
6909 timeout = timer_delay;
6910 timeout_reduced_for_timers = 1;
6915 /* Cause C-g and alarm signals to take immediate action,
6916 and cause input available signals to zero out timeout. */
6917 if (read_kbd < 0)
6918 set_waiting_for_input (&timeout);
6920 /* If a frame has been newly mapped and needs updating,
6921 reprocess its display stuff. */
6922 if (frame_garbaged && do_display)
6924 clear_waiting_for_input ();
6925 redisplay_preserve_echo_area (15);
6926 if (read_kbd < 0)
6927 set_waiting_for_input (&timeout);
6930 /* Wait till there is something to do. */
6931 FD_ZERO (&waitchannels);
6932 if (read_kbd && detect_input_pending ())
6933 nfds = 0;
6934 else
6936 if (read_kbd || !NILP (wait_for_cell))
6937 FD_SET (0, &waitchannels);
6938 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6941 xerrno = errno;
6943 /* Make C-g and alarm signals set flags again */
6944 clear_waiting_for_input ();
6946 /* If we woke up due to SIGWINCH, actually change size now. */
6947 do_pending_window_change (0);
6949 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6950 /* We waited the full specified time, so return now. */
6951 break;
6953 if (nfds == -1)
6955 /* If the system call was interrupted, then go around the
6956 loop again. */
6957 if (xerrno == EINTR)
6958 FD_ZERO (&waitchannels);
6959 else
6960 error ("select error: %s", emacs_strerror (xerrno));
6963 /* Check for keyboard input */
6965 if (read_kbd
6966 && detect_input_pending_run_timers (do_display))
6968 swallow_events (do_display);
6969 if (detect_input_pending_run_timers (do_display))
6970 break;
6973 /* If there is unread keyboard input, also return. */
6974 if (read_kbd
6975 && requeued_events_pending_p ())
6976 break;
6978 /* If wait_for_cell. check for keyboard input
6979 but don't run any timers.
6980 ??? (It seems wrong to me to check for keyboard
6981 input at all when wait_for_cell, but the code
6982 has been this way since July 1994.
6983 Try changing this after version 19.31.) */
6984 if (! NILP (wait_for_cell)
6985 && detect_input_pending ())
6987 swallow_events (do_display);
6988 if (detect_input_pending ())
6989 break;
6992 /* Exit now if the cell we're waiting for became non-nil. */
6993 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6994 break;
6997 start_polling ();
6999 return 0;
7002 #endif /* not subprocesses */
7004 /* The following functions are needed even if async subprocesses are
7005 not supported. Some of them are no-op stubs in that case. */
7007 /* Add DESC to the set of keyboard input descriptors. */
7009 void
7010 add_keyboard_wait_descriptor (int desc)
7012 #ifdef subprocesses /* actually means "not MSDOS" */
7013 FD_SET (desc, &input_wait_mask);
7014 FD_SET (desc, &non_process_wait_mask);
7015 if (desc > max_input_desc)
7016 max_input_desc = desc;
7017 #endif
7020 /* From now on, do not expect DESC to give keyboard input. */
7022 void
7023 delete_keyboard_wait_descriptor (int desc)
7025 #ifdef subprocesses
7026 int fd;
7027 int lim = max_input_desc;
7029 FD_CLR (desc, &input_wait_mask);
7030 FD_CLR (desc, &non_process_wait_mask);
7032 if (desc == max_input_desc)
7033 for (fd = 0; fd < lim; fd++)
7034 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
7035 max_input_desc = fd;
7036 #endif
7039 /* Setup coding systems of PROCESS. */
7041 void
7042 setup_process_coding_systems (Lisp_Object process)
7044 #ifdef subprocesses
7045 struct Lisp_Process *p = XPROCESS (process);
7046 int inch = p->infd;
7047 int outch = p->outfd;
7048 Lisp_Object coding_system;
7050 if (inch < 0 || outch < 0)
7051 return;
7053 if (!proc_decode_coding_system[inch])
7054 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
7055 coding_system = p->decode_coding_system;
7056 if (! NILP (p->filter))
7058 else if (BUFFERP (p->buffer))
7060 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
7061 coding_system = raw_text_coding_system (coding_system);
7063 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
7065 if (!proc_encode_coding_system[outch])
7066 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
7067 setup_coding_system (p->encode_coding_system,
7068 proc_encode_coding_system[outch]);
7069 #endif
7072 /* Close all descriptors currently in use for communication
7073 with subprocess. This is used in a newly-forked subprocess
7074 to get rid of irrelevant descriptors. */
7076 void
7077 close_process_descs (void)
7079 #ifndef DOS_NT
7080 int i;
7081 for (i = 0; i < MAXDESC; i++)
7083 Lisp_Object process;
7084 process = chan_process[i];
7085 if (!NILP (process))
7087 int in = XPROCESS (process)->infd;
7088 int out = XPROCESS (process)->outfd;
7089 if (in >= 0)
7090 emacs_close (in);
7091 if (out >= 0 && in != out)
7092 emacs_close (out);
7095 #endif
7098 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
7099 doc: /* Return the (or a) process associated with BUFFER.
7100 BUFFER may be a buffer or the name of one. */)
7101 (register Lisp_Object buffer)
7103 #ifdef subprocesses
7104 register Lisp_Object buf, tail, proc;
7106 if (NILP (buffer)) return Qnil;
7107 buf = Fget_buffer (buffer);
7108 if (NILP (buf)) return Qnil;
7110 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
7112 proc = Fcdr (XCAR (tail));
7113 if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
7114 return proc;
7116 #endif /* subprocesses */
7117 return Qnil;
7120 DEFUN ("process-inherit-coding-system-flag",
7121 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
7122 1, 1, 0,
7123 doc: /* Return the value of inherit-coding-system flag for PROCESS.
7124 If this flag is t, `buffer-file-coding-system' of the buffer
7125 associated with PROCESS will inherit the coding system used to decode
7126 the process output. */)
7127 (register Lisp_Object process)
7129 #ifdef subprocesses
7130 CHECK_PROCESS (process);
7131 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
7132 #else
7133 /* Ignore the argument and return the value of
7134 inherit-process-coding-system. */
7135 return inherit_process_coding_system ? Qt : Qnil;
7136 #endif
7139 /* Kill all processes associated with `buffer'.
7140 If `buffer' is nil, kill all processes */
7142 void
7143 kill_buffer_processes (Lisp_Object buffer)
7145 #ifdef subprocesses
7146 Lisp_Object tail, proc;
7148 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
7150 proc = XCDR (XCAR (tail));
7151 if (PROCESSP (proc)
7152 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
7154 if (NETCONN_P (proc) || SERIALCONN_P (proc))
7155 Fdelete_process (proc);
7156 else if (XPROCESS (proc)->infd >= 0)
7157 process_send_signal (proc, SIGHUP, Qnil, 1);
7160 #else /* subprocesses */
7161 /* Since we have no subprocesses, this does nothing. */
7162 #endif /* subprocesses */
7165 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
7166 Swaiting_for_user_input_p, 0, 0, 0,
7167 doc: /* Returns non-nil if Emacs is waiting for input from the user.
7168 This is intended for use by asynchronous process output filters and sentinels. */)
7169 (void)
7171 #ifdef subprocesses
7172 return (waiting_for_user_input_p ? Qt : Qnil);
7173 #else
7174 return Qnil;
7175 #endif
7178 /* Stop reading input from keyboard sources. */
7180 void
7181 hold_keyboard_input (void)
7183 kbd_is_on_hold = 1;
7186 /* Resume reading input from keyboard sources. */
7188 void
7189 unhold_keyboard_input (void)
7191 kbd_is_on_hold = 0;
7194 /* Return non-zero if keyboard input is on hold, zero otherwise. */
7197 kbd_on_hold_p (void)
7199 return kbd_is_on_hold;
7203 /* Enumeration of and access to system processes a-la ps(1). */
7205 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
7206 0, 0, 0,
7207 doc: /* Return a list of numerical process IDs of all running processes.
7208 If this functionality is unsupported, return nil.
7210 See `process-attributes' for getting attributes of a process given its ID. */)
7211 (void)
7213 return list_system_processes ();
7216 DEFUN ("process-attributes", Fprocess_attributes,
7217 Sprocess_attributes, 1, 1, 0,
7218 doc: /* Return attributes of the process given by its PID, a number.
7220 Value is an alist where each element is a cons cell of the form
7222 \(KEY . VALUE)
7224 If this functionality is unsupported, the value is nil.
7226 See `list-system-processes' for getting a list of all process IDs.
7228 The KEYs of the attributes that this function may return are listed
7229 below, together with the type of the associated VALUE (in parentheses).
7230 Not all platforms support all of these attributes; unsupported
7231 attributes will not appear in the returned alist.
7232 Unless explicitly indicated otherwise, numbers can have either
7233 integer or floating point values.
7235 euid -- Effective user User ID of the process (number)
7236 user -- User name corresponding to euid (string)
7237 egid -- Effective user Group ID of the process (number)
7238 group -- Group name corresponding to egid (string)
7239 comm -- Command name (executable name only) (string)
7240 state -- Process state code, such as "S", "R", or "T" (string)
7241 ppid -- Parent process ID (number)
7242 pgrp -- Process group ID (number)
7243 sess -- Session ID, i.e. process ID of session leader (number)
7244 ttname -- Controlling tty name (string)
7245 tpgid -- ID of foreground process group on the process's tty (number)
7246 minflt -- number of minor page faults (number)
7247 majflt -- number of major page faults (number)
7248 cminflt -- cumulative number of minor page faults (number)
7249 cmajflt -- cumulative number of major page faults (number)
7250 utime -- user time used by the process, in (current-time) format,
7251 which is a list of integers (HIGH LOW USEC PSEC)
7252 stime -- system time used by the process (current-time)
7253 time -- sum of utime and stime (current-time)
7254 cutime -- user time used by the process and its children (current-time)
7255 cstime -- system time used by the process and its children (current-time)
7256 ctime -- sum of cutime and cstime (current-time)
7257 pri -- priority of the process (number)
7258 nice -- nice value of the process (number)
7259 thcount -- process thread count (number)
7260 start -- time the process started (current-time)
7261 vsize -- virtual memory size of the process in KB's (number)
7262 rss -- resident set size of the process in KB's (number)
7263 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7264 pcpu -- percents of CPU time used by the process (floating-point number)
7265 pmem -- percents of total physical memory used by process's resident set
7266 (floating-point number)
7267 args -- command line which invoked the process (string). */)
7268 ( Lisp_Object pid)
7270 return system_process_attributes (pid);
7274 /* This is not called "init_process" because that is the name of a
7275 Mach system call, so it would cause problems on Darwin systems. */
7276 void
7277 init_process_emacs (void)
7279 #ifdef subprocesses
7280 register int i;
7282 inhibit_sentinels = 0;
7284 #ifdef SIGCHLD
7285 #ifndef CANNOT_DUMP
7286 if (! noninteractive || initialized)
7287 #endif
7289 struct sigaction action;
7290 emacs_sigaction_init (&action, deliver_child_signal);
7291 sigaction (SIGCHLD, &action, 0);
7293 #endif
7295 FD_ZERO (&input_wait_mask);
7296 FD_ZERO (&non_keyboard_wait_mask);
7297 FD_ZERO (&non_process_wait_mask);
7298 FD_ZERO (&write_mask);
7299 max_process_desc = 0;
7300 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7302 #ifdef NON_BLOCKING_CONNECT
7303 FD_ZERO (&connect_wait_mask);
7304 num_pending_connects = 0;
7305 #endif
7307 #ifdef ADAPTIVE_READ_BUFFERING
7308 process_output_delay_count = 0;
7309 process_output_skip = 0;
7310 #endif
7312 /* Don't do this, it caused infinite select loops. The display
7313 method should call add_keyboard_wait_descriptor on stdin if it
7314 needs that. */
7315 #if 0
7316 FD_SET (0, &input_wait_mask);
7317 #endif
7319 Vprocess_alist = Qnil;
7320 #ifdef SIGCHLD
7321 deleted_pid_list = Qnil;
7322 #endif
7323 for (i = 0; i < MAXDESC; i++)
7325 chan_process[i] = Qnil;
7326 proc_buffered_char[i] = -1;
7328 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7329 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7330 #ifdef DATAGRAM_SOCKETS
7331 memset (datagram_address, 0, sizeof datagram_address);
7332 #endif
7335 Lisp_Object subfeatures = Qnil;
7336 const struct socket_options *sopt;
7338 #define ADD_SUBFEATURE(key, val) \
7339 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7341 #ifdef NON_BLOCKING_CONNECT
7342 ADD_SUBFEATURE (QCnowait, Qt);
7343 #endif
7344 #ifdef DATAGRAM_SOCKETS
7345 ADD_SUBFEATURE (QCtype, Qdatagram);
7346 #endif
7347 #ifdef HAVE_SEQPACKET
7348 ADD_SUBFEATURE (QCtype, Qseqpacket);
7349 #endif
7350 #ifdef HAVE_LOCAL_SOCKETS
7351 ADD_SUBFEATURE (QCfamily, Qlocal);
7352 #endif
7353 ADD_SUBFEATURE (QCfamily, Qipv4);
7354 #ifdef AF_INET6
7355 ADD_SUBFEATURE (QCfamily, Qipv6);
7356 #endif
7357 #ifdef HAVE_GETSOCKNAME
7358 ADD_SUBFEATURE (QCservice, Qt);
7359 #endif
7360 #if defined (O_NONBLOCK) || defined (O_NDELAY)
7361 ADD_SUBFEATURE (QCserver, Qt);
7362 #endif
7364 for (sopt = socket_options; sopt->name; sopt++)
7365 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7367 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7370 #if defined (DARWIN_OS)
7371 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7372 processes. As such, we only change the default value. */
7373 if (initialized)
7375 char const *release = (STRINGP (Voperating_system_release)
7376 ? SSDATA (Voperating_system_release)
7377 : 0);
7378 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7379 Vprocess_connection_type = Qnil;
7382 #endif
7383 #endif /* subprocesses */
7384 kbd_is_on_hold = 0;
7387 void
7388 syms_of_process (void)
7390 #ifdef subprocesses
7392 DEFSYM (Qprocessp, "processp");
7393 DEFSYM (Qrun, "run");
7394 DEFSYM (Qstop, "stop");
7395 DEFSYM (Qsignal, "signal");
7397 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7398 here again.
7400 Qexit = intern_c_string ("exit");
7401 staticpro (&Qexit); */
7403 DEFSYM (Qopen, "open");
7404 DEFSYM (Qclosed, "closed");
7405 DEFSYM (Qconnect, "connect");
7406 DEFSYM (Qfailed, "failed");
7407 DEFSYM (Qlisten, "listen");
7408 DEFSYM (Qlocal, "local");
7409 DEFSYM (Qipv4, "ipv4");
7410 #ifdef AF_INET6
7411 DEFSYM (Qipv6, "ipv6");
7412 #endif
7413 DEFSYM (Qdatagram, "datagram");
7414 DEFSYM (Qseqpacket, "seqpacket");
7416 DEFSYM (QCport, ":port");
7417 DEFSYM (QCspeed, ":speed");
7418 DEFSYM (QCprocess, ":process");
7420 DEFSYM (QCbytesize, ":bytesize");
7421 DEFSYM (QCstopbits, ":stopbits");
7422 DEFSYM (QCparity, ":parity");
7423 DEFSYM (Qodd, "odd");
7424 DEFSYM (Qeven, "even");
7425 DEFSYM (QCflowcontrol, ":flowcontrol");
7426 DEFSYM (Qhw, "hw");
7427 DEFSYM (Qsw, "sw");
7428 DEFSYM (QCsummary, ":summary");
7430 DEFSYM (Qreal, "real");
7431 DEFSYM (Qnetwork, "network");
7432 DEFSYM (Qserial, "serial");
7433 DEFSYM (QCbuffer, ":buffer");
7434 DEFSYM (QChost, ":host");
7435 DEFSYM (QCservice, ":service");
7436 DEFSYM (QClocal, ":local");
7437 DEFSYM (QCremote, ":remote");
7438 DEFSYM (QCcoding, ":coding");
7439 DEFSYM (QCserver, ":server");
7440 DEFSYM (QCnowait, ":nowait");
7441 DEFSYM (QCsentinel, ":sentinel");
7442 DEFSYM (QClog, ":log");
7443 DEFSYM (QCnoquery, ":noquery");
7444 DEFSYM (QCstop, ":stop");
7445 DEFSYM (QCoptions, ":options");
7446 DEFSYM (QCplist, ":plist");
7448 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7450 staticpro (&Vprocess_alist);
7451 #ifdef SIGCHLD
7452 staticpro (&deleted_pid_list);
7453 #endif
7455 #endif /* subprocesses */
7457 DEFSYM (QCname, ":name");
7458 DEFSYM (QCtype, ":type");
7460 DEFSYM (Qeuid, "euid");
7461 DEFSYM (Qegid, "egid");
7462 DEFSYM (Quser, "user");
7463 DEFSYM (Qgroup, "group");
7464 DEFSYM (Qcomm, "comm");
7465 DEFSYM (Qstate, "state");
7466 DEFSYM (Qppid, "ppid");
7467 DEFSYM (Qpgrp, "pgrp");
7468 DEFSYM (Qsess, "sess");
7469 DEFSYM (Qttname, "ttname");
7470 DEFSYM (Qtpgid, "tpgid");
7471 DEFSYM (Qminflt, "minflt");
7472 DEFSYM (Qmajflt, "majflt");
7473 DEFSYM (Qcminflt, "cminflt");
7474 DEFSYM (Qcmajflt, "cmajflt");
7475 DEFSYM (Qutime, "utime");
7476 DEFSYM (Qstime, "stime");
7477 DEFSYM (Qtime, "time");
7478 DEFSYM (Qcutime, "cutime");
7479 DEFSYM (Qcstime, "cstime");
7480 DEFSYM (Qctime, "ctime");
7481 DEFSYM (Qpri, "pri");
7482 DEFSYM (Qnice, "nice");
7483 DEFSYM (Qthcount, "thcount");
7484 DEFSYM (Qstart, "start");
7485 DEFSYM (Qvsize, "vsize");
7486 DEFSYM (Qrss, "rss");
7487 DEFSYM (Qetime, "etime");
7488 DEFSYM (Qpcpu, "pcpu");
7489 DEFSYM (Qpmem, "pmem");
7490 DEFSYM (Qargs, "args");
7492 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7493 doc: /* Non-nil means delete processes immediately when they exit.
7494 A value of nil means don't delete them until `list-processes' is run. */);
7496 delete_exited_processes = 1;
7498 #ifdef subprocesses
7499 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7500 doc: /* Control type of device used to communicate with subprocesses.
7501 Values are nil to use a pipe, or t or `pty' to use a pty.
7502 The value has no effect if the system has no ptys or if all ptys are busy:
7503 then a pipe is used in any case.
7504 The value takes effect when `start-process' is called. */);
7505 Vprocess_connection_type = Qt;
7507 #ifdef ADAPTIVE_READ_BUFFERING
7508 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7509 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7510 On some systems, when Emacs reads the output from a subprocess, the output data
7511 is read in very small blocks, potentially resulting in very poor performance.
7512 This behavior can be remedied to some extent by setting this variable to a
7513 non-nil value, as it will automatically delay reading from such processes, to
7514 allow them to produce more output before Emacs tries to read it.
7515 If the value is t, the delay is reset after each write to the process; any other
7516 non-nil value means that the delay is not reset on write.
7517 The variable takes effect when `start-process' is called. */);
7518 Vprocess_adaptive_read_buffering = Qt;
7519 #endif
7521 defsubr (&Sprocessp);
7522 defsubr (&Sget_process);
7523 defsubr (&Sdelete_process);
7524 defsubr (&Sprocess_status);
7525 defsubr (&Sprocess_exit_status);
7526 defsubr (&Sprocess_id);
7527 defsubr (&Sprocess_name);
7528 defsubr (&Sprocess_tty_name);
7529 defsubr (&Sprocess_command);
7530 defsubr (&Sset_process_buffer);
7531 defsubr (&Sprocess_buffer);
7532 defsubr (&Sprocess_mark);
7533 defsubr (&Sset_process_filter);
7534 defsubr (&Sprocess_filter);
7535 defsubr (&Sset_process_sentinel);
7536 defsubr (&Sprocess_sentinel);
7537 defsubr (&Sset_process_window_size);
7538 defsubr (&Sset_process_inherit_coding_system_flag);
7539 defsubr (&Sset_process_query_on_exit_flag);
7540 defsubr (&Sprocess_query_on_exit_flag);
7541 defsubr (&Sprocess_contact);
7542 defsubr (&Sprocess_plist);
7543 defsubr (&Sset_process_plist);
7544 defsubr (&Sprocess_list);
7545 defsubr (&Sstart_process);
7546 defsubr (&Sserial_process_configure);
7547 defsubr (&Smake_serial_process);
7548 defsubr (&Sset_network_process_option);
7549 defsubr (&Smake_network_process);
7550 defsubr (&Sformat_network_address);
7551 #if defined (HAVE_NET_IF_H)
7552 #ifdef SIOCGIFCONF
7553 defsubr (&Snetwork_interface_list);
7554 #endif
7555 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
7556 defsubr (&Snetwork_interface_info);
7557 #endif
7558 #endif /* defined (HAVE_NET_IF_H) */
7559 #ifdef DATAGRAM_SOCKETS
7560 defsubr (&Sprocess_datagram_address);
7561 defsubr (&Sset_process_datagram_address);
7562 #endif
7563 defsubr (&Saccept_process_output);
7564 defsubr (&Sprocess_send_region);
7565 defsubr (&Sprocess_send_string);
7566 defsubr (&Sinterrupt_process);
7567 defsubr (&Skill_process);
7568 defsubr (&Squit_process);
7569 defsubr (&Sstop_process);
7570 defsubr (&Scontinue_process);
7571 defsubr (&Sprocess_running_child_p);
7572 defsubr (&Sprocess_send_eof);
7573 defsubr (&Ssignal_process);
7574 defsubr (&Swaiting_for_user_input_p);
7575 defsubr (&Sprocess_type);
7576 defsubr (&Sset_process_coding_system);
7577 defsubr (&Sprocess_coding_system);
7578 defsubr (&Sset_process_filter_multibyte);
7579 defsubr (&Sprocess_filter_multibyte_p);
7581 #endif /* subprocesses */
7583 defsubr (&Sget_buffer_process);
7584 defsubr (&Sprocess_inherit_coding_system_flag);
7585 defsubr (&Slist_system_processes);
7586 defsubr (&Sprocess_attributes);