* lisp/image-mode.el: Use lexical-binding.
[emacs/old-mirror.git] / src / process.c
blobab215766c07c04df9611e6c6b5a562deeb0a8cbd
1 /* Asynchronous subprocess control for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2012
4 Free Software 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 #ifndef WNOHANG
129 # undef waitpid
130 # define waitpid(pid, status, options) wait (status)
131 #endif
132 #ifndef WUNTRACED
133 # define WUNTRACED 0
134 #endif
136 /* Work around GCC 4.7.0 bug with strict overflow checking; see
137 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
138 These lines can be removed once the GCC bug is fixed. */
139 #if (__GNUC__ == 4 && 3 <= __GNUC_MINOR__) || 4 < __GNUC__
140 # pragma GCC diagnostic ignored "-Wstrict-overflow"
141 #endif
143 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
144 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
145 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
146 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
147 Lisp_Object QCname, QCtype;
149 /* Non-zero if keyboard input is on hold, zero otherwise. */
151 static int kbd_is_on_hold;
153 /* Nonzero means don't run process sentinels. This is used
154 when exiting. */
155 int inhibit_sentinels;
157 #ifdef subprocesses
159 Lisp_Object Qprocessp;
160 static Lisp_Object Qrun, Qstop, Qsignal;
161 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
162 Lisp_Object Qlocal;
163 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
164 static Lisp_Object Qreal, Qnetwork, Qserial;
165 #ifdef AF_INET6
166 static Lisp_Object Qipv6;
167 #endif
168 static Lisp_Object QCport, QCprocess;
169 Lisp_Object QCspeed;
170 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
171 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
172 static Lisp_Object QCbuffer, QChost, QCservice;
173 static Lisp_Object QClocal, QCremote, QCcoding;
174 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
175 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
176 static Lisp_Object Qlast_nonmenu_event;
178 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
179 #define NETCONN1_P(p) (EQ (p->type, Qnetwork))
180 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
181 #define SERIALCONN1_P(p) (EQ (p->type, Qserial))
183 #ifndef HAVE_H_ERRNO
184 extern int h_errno;
185 #endif
187 /* Number of events of change of status of a process. */
188 static EMACS_INT process_tick;
189 /* Number of events for which the user or sentinel has been notified. */
190 static EMACS_INT update_tick;
192 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
194 /* Only W32 has this, it really means that select can't take write mask. */
195 #ifdef BROKEN_NON_BLOCKING_CONNECT
196 #undef NON_BLOCKING_CONNECT
197 #define SELECT_CANT_DO_WRITE_MASK
198 #else
199 #ifndef NON_BLOCKING_CONNECT
200 #ifdef HAVE_SELECT
201 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
202 #if defined (O_NONBLOCK) || defined (O_NDELAY)
203 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
204 #define NON_BLOCKING_CONNECT
205 #endif /* EWOULDBLOCK || EINPROGRESS */
206 #endif /* O_NONBLOCK || O_NDELAY */
207 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
208 #endif /* HAVE_SELECT */
209 #endif /* NON_BLOCKING_CONNECT */
210 #endif /* BROKEN_NON_BLOCKING_CONNECT */
212 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
213 this system. We need to read full packets, so we need a
214 "non-destructive" select. So we require either native select,
215 or emulation of select using FIONREAD. */
217 #ifndef BROKEN_DATAGRAM_SOCKETS
218 # if defined HAVE_SELECT || defined USABLE_FIONREAD
219 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
220 # define DATAGRAM_SOCKETS
221 # endif
222 # endif
223 #endif
225 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
226 # define HAVE_SEQPACKET
227 #endif
229 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
230 #define ADAPTIVE_READ_BUFFERING
231 #endif
233 #ifdef ADAPTIVE_READ_BUFFERING
234 #define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
235 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
236 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
238 /* Number of processes which have a non-zero read_output_delay,
239 and therefore might be delayed for adaptive read buffering. */
241 static int process_output_delay_count;
243 /* Non-zero if any process has non-nil read_output_skip. */
245 static int process_output_skip;
247 #else
248 #define process_output_delay_count 0
249 #endif
251 static void create_process (Lisp_Object, char **, Lisp_Object);
252 #ifdef USABLE_SIGIO
253 static int keyboard_bit_set (SELECT_TYPE *);
254 #endif
255 static void deactivate_process (Lisp_Object);
256 static void status_notify (struct Lisp_Process *);
257 static int read_process_output (Lisp_Object, int);
258 static void handle_child_signal (int);
259 static void create_pty (Lisp_Object);
261 /* If we support a window system, turn on the code to poll periodically
262 to detect C-g. It isn't actually used when doing interrupt input. */
263 #ifdef HAVE_WINDOW_SYSTEM
264 #define POLL_FOR_INPUT
265 #endif
267 static Lisp_Object get_process (register Lisp_Object name);
268 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
270 /* Mask of bits indicating the descriptors that we wait for input on. */
272 static SELECT_TYPE input_wait_mask;
274 /* Mask that excludes keyboard input descriptor(s). */
276 static SELECT_TYPE non_keyboard_wait_mask;
278 /* Mask that excludes process input descriptor(s). */
280 static SELECT_TYPE non_process_wait_mask;
282 /* Mask for selecting for write. */
284 static SELECT_TYPE write_mask;
286 #ifdef NON_BLOCKING_CONNECT
287 /* Mask of bits indicating the descriptors that we wait for connect to
288 complete on. Once they complete, they are removed from this mask
289 and added to the input_wait_mask and non_keyboard_wait_mask. */
291 static SELECT_TYPE connect_wait_mask;
293 /* Number of bits set in connect_wait_mask. */
294 static int num_pending_connects;
295 #endif /* NON_BLOCKING_CONNECT */
297 /* The largest descriptor currently in use for a process object. */
298 static int max_process_desc;
300 /* The largest descriptor currently in use for input. */
301 static int max_input_desc;
303 /* Indexed by descriptor, gives the process (if any) for that descriptor */
304 static Lisp_Object chan_process[MAXDESC];
306 /* Alist of elements (NAME . PROCESS) */
307 static Lisp_Object Vprocess_alist;
309 /* Buffered-ahead input char from process, indexed by channel.
310 -1 means empty (no char is buffered).
311 Used on sys V where the only way to tell if there is any
312 output from the process is to read at least one char.
313 Always -1 on systems that support FIONREAD. */
315 static int proc_buffered_char[MAXDESC];
317 /* Table of `struct coding-system' for each process. */
318 static struct coding_system *proc_decode_coding_system[MAXDESC];
319 static struct coding_system *proc_encode_coding_system[MAXDESC];
321 #ifdef DATAGRAM_SOCKETS
322 /* Table of `partner address' for datagram sockets. */
323 static struct sockaddr_and_len {
324 struct sockaddr *sa;
325 int len;
326 } datagram_address[MAXDESC];
327 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
328 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
329 #else
330 #define DATAGRAM_CHAN_P(chan) (0)
331 #define DATAGRAM_CONN_P(proc) (0)
332 #endif
334 /* Maximum number of bytes to send to a pty without an eof. */
335 static int pty_max_bytes;
337 /* These setters are used only in this file, so they can be private. */
338 static inline void
339 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
341 p->buffer = val;
343 static inline void
344 pset_command (struct Lisp_Process *p, Lisp_Object val)
346 p->command = val;
348 static inline void
349 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
351 p->decode_coding_system = val;
353 static inline void
354 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
356 p->decoding_buf = val;
358 static inline void
359 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
361 p->encode_coding_system = val;
363 static inline void
364 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
366 p->encoding_buf = val;
368 static inline void
369 pset_filter (struct Lisp_Process *p, Lisp_Object val)
371 p->filter = val;
373 static inline void
374 pset_log (struct Lisp_Process *p, Lisp_Object val)
376 p->log = val;
378 static inline void
379 pset_mark (struct Lisp_Process *p, Lisp_Object val)
381 p->mark = val;
383 static inline void
384 pset_name (struct Lisp_Process *p, Lisp_Object val)
386 p->name = val;
388 static inline void
389 pset_plist (struct Lisp_Process *p, Lisp_Object val)
391 p->plist = val;
393 static inline void
394 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
396 p->sentinel = val;
398 static inline void
399 pset_status (struct Lisp_Process *p, Lisp_Object val)
401 p->status = val;
403 static inline void
404 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
406 p->tty_name = val;
408 static inline void
409 pset_type (struct Lisp_Process *p, Lisp_Object val)
411 p->type = val;
413 static inline void
414 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
416 p->write_queue = val;
421 static struct fd_callback_data
423 fd_callback func;
424 void *data;
425 #define FOR_READ 1
426 #define FOR_WRITE 2
427 int condition; /* mask of the defines above. */
428 } fd_callback_info[MAXDESC];
431 /* Add a file descriptor FD to be monitored for when read is possible.
432 When read is possible, call FUNC with argument DATA. */
434 void
435 add_read_fd (int fd, fd_callback func, void *data)
437 eassert (fd < MAXDESC);
438 add_keyboard_wait_descriptor (fd);
440 fd_callback_info[fd].func = func;
441 fd_callback_info[fd].data = data;
442 fd_callback_info[fd].condition |= FOR_READ;
445 /* Stop monitoring file descriptor FD for when read is possible. */
447 void
448 delete_read_fd (int fd)
450 eassert (fd < MAXDESC);
451 delete_keyboard_wait_descriptor (fd);
453 fd_callback_info[fd].condition &= ~FOR_READ;
454 if (fd_callback_info[fd].condition == 0)
456 fd_callback_info[fd].func = 0;
457 fd_callback_info[fd].data = 0;
461 /* Add a file descriptor FD to be monitored for when write is possible.
462 When write is possible, call FUNC with argument DATA. */
464 void
465 add_write_fd (int fd, fd_callback func, void *data)
467 eassert (fd < MAXDESC);
468 FD_SET (fd, &write_mask);
469 if (fd > max_input_desc)
470 max_input_desc = fd;
472 fd_callback_info[fd].func = func;
473 fd_callback_info[fd].data = data;
474 fd_callback_info[fd].condition |= FOR_WRITE;
477 /* Stop monitoring file descriptor FD for when write is possible. */
479 void
480 delete_write_fd (int fd)
482 int lim = max_input_desc;
484 eassert (fd < MAXDESC);
485 FD_CLR (fd, &write_mask);
486 fd_callback_info[fd].condition &= ~FOR_WRITE;
487 if (fd_callback_info[fd].condition == 0)
489 fd_callback_info[fd].func = 0;
490 fd_callback_info[fd].data = 0;
492 if (fd == max_input_desc)
493 for (fd = lim; fd >= 0; fd--)
494 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
496 max_input_desc = fd;
497 break;
504 /* Compute the Lisp form of the process status, p->status, from
505 the numeric status that was returned by `wait'. */
507 static Lisp_Object status_convert (int);
509 static void
510 update_status (struct Lisp_Process *p)
512 eassert (p->raw_status_new);
513 pset_status (p, status_convert (p->raw_status));
514 p->raw_status_new = 0;
517 /* Convert a process status word in Unix format to
518 the list that we use internally. */
520 static Lisp_Object
521 status_convert (int w)
523 if (WIFSTOPPED (w))
524 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
525 else if (WIFEXITED (w))
526 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
527 WCOREDUMP (w) ? Qt : Qnil));
528 else if (WIFSIGNALED (w))
529 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
530 WCOREDUMP (w) ? Qt : Qnil));
531 else
532 return Qrun;
535 /* Given a status-list, extract the three pieces of information
536 and store them individually through the three pointers. */
538 static void
539 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
541 Lisp_Object tem;
543 if (SYMBOLP (l))
545 *symbol = l;
546 *code = 0;
547 *coredump = 0;
549 else
551 *symbol = XCAR (l);
552 tem = XCDR (l);
553 *code = XFASTINT (XCAR (tem));
554 tem = XCDR (tem);
555 *coredump = !NILP (tem);
559 /* Return a string describing a process status list. */
561 static Lisp_Object
562 status_message (struct Lisp_Process *p)
564 Lisp_Object status = p->status;
565 Lisp_Object symbol;
566 int code, coredump;
567 Lisp_Object string, string2;
569 decode_status (status, &symbol, &code, &coredump);
571 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
573 char *signame;
574 synchronize_system_messages_locale ();
575 signame = strsignal (code);
576 if (signame == 0)
577 string = build_string ("unknown");
578 else
580 int c1, c2;
582 string = build_unibyte_string (signame);
583 if (! NILP (Vlocale_coding_system))
584 string = (code_convert_string_norecord
585 (string, Vlocale_coding_system, 0));
586 c1 = STRING_CHAR (SDATA (string));
587 c2 = downcase (c1);
588 if (c1 != c2)
589 Faset (string, make_number (0), make_number (c2));
591 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
592 return concat2 (string, string2);
594 else if (EQ (symbol, Qexit))
596 if (NETCONN1_P (p))
597 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
598 if (code == 0)
599 return build_string ("finished\n");
600 string = Fnumber_to_string (make_number (code));
601 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
602 return concat3 (build_string ("exited abnormally with code "),
603 string, string2);
605 else if (EQ (symbol, Qfailed))
607 string = Fnumber_to_string (make_number (code));
608 string2 = build_string ("\n");
609 return concat3 (build_string ("failed with code "),
610 string, string2);
612 else
613 return Fcopy_sequence (Fsymbol_name (symbol));
616 #ifdef HAVE_PTYS
618 /* The file name of the pty opened by allocate_pty. */
619 static char pty_name[24];
621 /* Open an available pty, returning a file descriptor.
622 Return -1 on failure.
623 The file name of the terminal corresponding to the pty
624 is left in the variable pty_name. */
626 static int
627 allocate_pty (void)
629 int fd;
631 #ifdef PTY_ITERATION
632 PTY_ITERATION
633 #else
634 register int c, i;
635 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
636 for (i = 0; i < 16; i++)
637 #endif
639 #ifdef PTY_NAME_SPRINTF
640 PTY_NAME_SPRINTF
641 #else
642 sprintf (pty_name, "/dev/pty%c%x", c, i);
643 #endif /* no PTY_NAME_SPRINTF */
645 #ifdef PTY_OPEN
646 PTY_OPEN;
647 #else /* no PTY_OPEN */
649 { /* Some systems name their pseudoterminals so that there are gaps in
650 the usual sequence - for example, on HP9000/S700 systems, there
651 are no pseudoterminals with names ending in 'f'. So we wait for
652 three failures in a row before deciding that we've reached the
653 end of the ptys. */
654 int failed_count = 0;
655 struct stat stb;
657 if (stat (pty_name, &stb) < 0)
659 failed_count++;
660 if (failed_count >= 3)
661 return -1;
663 else
664 failed_count = 0;
666 # ifdef O_NONBLOCK
667 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
668 # else
669 fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
670 # endif
672 #endif /* no PTY_OPEN */
674 if (fd >= 0)
676 /* check to make certain that both sides are available
677 this avoids a nasty yet stupid bug in rlogins */
678 #ifdef PTY_TTY_NAME_SPRINTF
679 PTY_TTY_NAME_SPRINTF
680 #else
681 sprintf (pty_name, "/dev/tty%c%x", c, i);
682 #endif /* no PTY_TTY_NAME_SPRINTF */
683 if (access (pty_name, 6) != 0)
685 emacs_close (fd);
686 # ifndef __sgi
687 continue;
688 # else
689 return -1;
690 # endif /* __sgi */
692 setup_pty (fd);
693 return fd;
696 return -1;
698 #endif /* HAVE_PTYS */
700 static Lisp_Object
701 make_process (Lisp_Object name)
703 register Lisp_Object val, tem, name1;
704 register struct Lisp_Process *p;
705 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
706 printmax_t i;
708 p = allocate_process ();
709 /* Initialize Lisp data. Note that allocate_process initializes all
710 Lisp data to nil, so do it only for slots which should not be nil. */
711 pset_status (p, Qrun);
712 pset_mark (p, Fmake_marker ());
714 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
715 non-Lisp data, so do it only for slots which should not be zero. */
716 p->infd = -1;
717 p->outfd = -1;
719 #ifdef HAVE_GNUTLS
720 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
721 #endif
723 /* If name is already in use, modify it until it is unused. */
725 name1 = name;
726 for (i = 1; ; i++)
728 tem = Fget_process (name1);
729 if (NILP (tem)) break;
730 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
732 name = name1;
733 pset_name (p, name);
734 XSETPROCESS (val, p);
735 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
736 return val;
739 static void
740 remove_process (register Lisp_Object proc)
742 register Lisp_Object pair;
744 pair = Frassq (proc, Vprocess_alist);
745 Vprocess_alist = Fdelq (pair, Vprocess_alist);
747 deactivate_process (proc);
751 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
752 doc: /* Return t if OBJECT is a process. */)
753 (Lisp_Object object)
755 return PROCESSP (object) ? Qt : Qnil;
758 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
759 doc: /* Return the process named NAME, or nil if there is none. */)
760 (register Lisp_Object name)
762 if (PROCESSP (name))
763 return name;
764 CHECK_STRING (name);
765 return Fcdr (Fassoc (name, Vprocess_alist));
768 /* This is how commands for the user decode process arguments. It
769 accepts a process, a process name, a buffer, a buffer name, or nil.
770 Buffers denote the first process in the buffer, and nil denotes the
771 current buffer. */
773 static Lisp_Object
774 get_process (register Lisp_Object name)
776 register Lisp_Object proc, obj;
777 if (STRINGP (name))
779 obj = Fget_process (name);
780 if (NILP (obj))
781 obj = Fget_buffer (name);
782 if (NILP (obj))
783 error ("Process %s does not exist", SDATA (name));
785 else if (NILP (name))
786 obj = Fcurrent_buffer ();
787 else
788 obj = name;
790 /* Now obj should be either a buffer object or a process object.
792 if (BUFFERP (obj))
794 proc = Fget_buffer_process (obj);
795 if (NILP (proc))
796 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
798 else
800 CHECK_PROCESS (obj);
801 proc = obj;
803 return proc;
807 #ifdef SIGCHLD
808 /* Fdelete_process promises to immediately forget about the process, but in
809 reality, Emacs needs to remember those processes until they have been
810 treated by the SIGCHLD handler; otherwise this handler would consider the
811 process as being synchronous and say that the synchronous process is
812 dead. */
813 static Lisp_Object deleted_pid_list;
814 #endif
816 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
817 doc: /* Delete PROCESS: kill it and forget about it immediately.
818 PROCESS may be a process, a buffer, the name of a process or buffer, or
819 nil, indicating the current buffer's process. */)
820 (register Lisp_Object process)
822 register struct Lisp_Process *p;
824 process = get_process (process);
825 p = XPROCESS (process);
827 p->raw_status_new = 0;
828 if (NETCONN1_P (p) || SERIALCONN1_P (p))
830 pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
831 p->tick = ++process_tick;
832 status_notify (p);
833 redisplay_preserve_echo_area (13);
835 else if (p->infd >= 0)
837 #ifdef SIGCHLD
838 Lisp_Object symbol;
839 pid_t pid = p->pid;
841 /* No problem storing the pid here, as it is still in Vprocess_alist. */
842 deleted_pid_list = Fcons (make_fixnum_or_float (pid),
843 /* GC treated elements set to nil. */
844 Fdelq (Qnil, deleted_pid_list));
845 /* If the process has already signaled, remove it from the list. */
846 if (p->raw_status_new)
847 update_status (p);
848 symbol = p->status;
849 if (CONSP (p->status))
850 symbol = XCAR (p->status);
851 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
852 deleted_pid_list
853 = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
854 else
855 #endif
857 Fkill_process (process, Qnil);
858 /* Do this now, since remove_process will make the
859 SIGCHLD handler do nothing. */
860 pset_status (p, Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil)));
861 p->tick = ++process_tick;
862 status_notify (p);
863 redisplay_preserve_echo_area (13);
866 remove_process (process);
867 return Qnil;
870 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
871 doc: /* Return the status of PROCESS.
872 The returned value is one of the following symbols:
873 run -- for a process that is running.
874 stop -- for a process stopped but continuable.
875 exit -- for a process that has exited.
876 signal -- for a process that has got a fatal signal.
877 open -- for a network stream connection that is open.
878 listen -- for a network stream server that is listening.
879 closed -- for a network stream connection that is closed.
880 connect -- when waiting for a non-blocking connection to complete.
881 failed -- when a non-blocking connection has failed.
882 nil -- if arg is a process name and no such process exists.
883 PROCESS may be a process, a buffer, the name of a process, or
884 nil, indicating the current buffer's process. */)
885 (register Lisp_Object process)
887 register struct Lisp_Process *p;
888 register Lisp_Object status;
890 if (STRINGP (process))
891 process = Fget_process (process);
892 else
893 process = get_process (process);
895 if (NILP (process))
896 return process;
898 p = XPROCESS (process);
899 if (p->raw_status_new)
900 update_status (p);
901 status = p->status;
902 if (CONSP (status))
903 status = XCAR (status);
904 if (NETCONN1_P (p) || SERIALCONN1_P (p))
906 if (EQ (status, Qexit))
907 status = Qclosed;
908 else if (EQ (p->command, Qt))
909 status = Qstop;
910 else if (EQ (status, Qrun))
911 status = Qopen;
913 return status;
916 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
917 1, 1, 0,
918 doc: /* Return the exit status of PROCESS or the signal number that killed it.
919 If PROCESS has not yet exited or died, return 0. */)
920 (register Lisp_Object process)
922 CHECK_PROCESS (process);
923 if (XPROCESS (process)->raw_status_new)
924 update_status (XPROCESS (process));
925 if (CONSP (XPROCESS (process)->status))
926 return XCAR (XCDR (XPROCESS (process)->status));
927 return make_number (0);
930 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
931 doc: /* Return the process id of PROCESS.
932 This is the pid of the external process which PROCESS uses or talks to.
933 For a network connection, this value is nil. */)
934 (register Lisp_Object process)
936 pid_t pid;
938 CHECK_PROCESS (process);
939 pid = XPROCESS (process)->pid;
940 return (pid ? make_fixnum_or_float (pid) : Qnil);
943 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
944 doc: /* Return the name of PROCESS, as a string.
945 This is the name of the program invoked in PROCESS,
946 possibly modified to make it unique among process names. */)
947 (register Lisp_Object process)
949 CHECK_PROCESS (process);
950 return XPROCESS (process)->name;
953 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
954 doc: /* Return the command that was executed to start PROCESS.
955 This is a list of strings, the first string being the program executed
956 and the rest of the strings being the arguments given to it.
957 For a network or serial process, this is nil (process is running) or t
958 \(process is stopped). */)
959 (register Lisp_Object process)
961 CHECK_PROCESS (process);
962 return XPROCESS (process)->command;
965 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
966 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
967 This is the terminal that the process itself reads and writes on,
968 not the name of the pty that Emacs uses to talk with that terminal. */)
969 (register Lisp_Object process)
971 CHECK_PROCESS (process);
972 return XPROCESS (process)->tty_name;
975 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
976 2, 2, 0,
977 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
978 Return BUFFER. */)
979 (register Lisp_Object process, Lisp_Object buffer)
981 struct Lisp_Process *p;
983 CHECK_PROCESS (process);
984 if (!NILP (buffer))
985 CHECK_BUFFER (buffer);
986 p = XPROCESS (process);
987 pset_buffer (p, buffer);
988 if (NETCONN1_P (p) || SERIALCONN1_P (p))
989 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
990 setup_process_coding_systems (process);
991 return buffer;
994 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
995 1, 1, 0,
996 doc: /* Return the buffer PROCESS is associated with.
997 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
998 (register Lisp_Object process)
1000 CHECK_PROCESS (process);
1001 return XPROCESS (process)->buffer;
1004 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1005 1, 1, 0,
1006 doc: /* Return the marker for the end of the last output from PROCESS. */)
1007 (register Lisp_Object process)
1009 CHECK_PROCESS (process);
1010 return XPROCESS (process)->mark;
1013 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1014 2, 2, 0,
1015 doc: /* Give PROCESS the filter function FILTER; nil means no filter.
1016 A value of t means stop accepting output from the process.
1018 When a process has a filter, its buffer is not used for output.
1019 Instead, each time it does output, the entire string of output is
1020 passed to the filter.
1022 The filter gets two arguments: the process and the string of output.
1023 The string argument is normally a multibyte string, except:
1024 - if the process' input coding system is no-conversion or raw-text,
1025 it is a unibyte string (the non-converted input), or else
1026 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1027 string (the result of converting the decoded input multibyte
1028 string to unibyte with `string-make-unibyte'). */)
1029 (register Lisp_Object process, Lisp_Object filter)
1031 struct Lisp_Process *p;
1033 CHECK_PROCESS (process);
1034 p = XPROCESS (process);
1036 /* Don't signal an error if the process' input file descriptor
1037 is closed. This could make debugging Lisp more difficult,
1038 for example when doing something like
1040 (setq process (start-process ...))
1041 (debug)
1042 (set-process-filter process ...) */
1044 if (p->infd >= 0)
1046 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1048 FD_CLR (p->infd, &input_wait_mask);
1049 FD_CLR (p->infd, &non_keyboard_wait_mask);
1051 else if (EQ (p->filter, Qt)
1052 /* Network or serial process not stopped: */
1053 && !EQ (p->command, Qt))
1055 FD_SET (p->infd, &input_wait_mask);
1056 FD_SET (p->infd, &non_keyboard_wait_mask);
1060 pset_filter (p, filter);
1061 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1062 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1063 setup_process_coding_systems (process);
1064 return filter;
1067 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1068 1, 1, 0,
1069 doc: /* Returns the filter function of PROCESS; nil if none.
1070 See `set-process-filter' for more info on filter functions. */)
1071 (register Lisp_Object process)
1073 CHECK_PROCESS (process);
1074 return XPROCESS (process)->filter;
1077 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1078 2, 2, 0,
1079 doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
1080 The sentinel is called as a function when the process changes state.
1081 It gets two arguments: the process, and a string describing the change. */)
1082 (register Lisp_Object process, Lisp_Object sentinel)
1084 struct Lisp_Process *p;
1086 CHECK_PROCESS (process);
1087 p = XPROCESS (process);
1089 pset_sentinel (p, sentinel);
1090 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1091 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1092 return sentinel;
1095 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1096 1, 1, 0,
1097 doc: /* Return the sentinel of PROCESS; nil if none.
1098 See `set-process-sentinel' for more info on sentinels. */)
1099 (register Lisp_Object process)
1101 CHECK_PROCESS (process);
1102 return XPROCESS (process)->sentinel;
1105 DEFUN ("set-process-window-size", Fset_process_window_size,
1106 Sset_process_window_size, 3, 3, 0,
1107 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1108 (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1110 CHECK_PROCESS (process);
1111 CHECK_RANGED_INTEGER (height, 0, INT_MAX);
1112 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
1114 if (XPROCESS (process)->infd < 0
1115 || set_window_size (XPROCESS (process)->infd,
1116 XINT (height), XINT (width)) <= 0)
1117 return Qnil;
1118 else
1119 return Qt;
1122 DEFUN ("set-process-inherit-coding-system-flag",
1123 Fset_process_inherit_coding_system_flag,
1124 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1125 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1126 If the second argument FLAG is non-nil, then the variable
1127 `buffer-file-coding-system' of the buffer associated with PROCESS
1128 will be bound to the value of the coding system used to decode
1129 the process output.
1131 This is useful when the coding system specified for the process buffer
1132 leaves either the character code conversion or the end-of-line conversion
1133 unspecified, or if the coding system used to decode the process output
1134 is more appropriate for saving the process buffer.
1136 Binding the variable `inherit-process-coding-system' to non-nil before
1137 starting the process is an alternative way of setting the inherit flag
1138 for the process which will run.
1140 This function returns FLAG. */)
1141 (register Lisp_Object process, Lisp_Object flag)
1143 CHECK_PROCESS (process);
1144 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1145 return flag;
1148 DEFUN ("set-process-query-on-exit-flag",
1149 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1150 2, 2, 0,
1151 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1152 If the second argument FLAG is non-nil, Emacs will query the user before
1153 exiting or killing a buffer if PROCESS is running. This function
1154 returns FLAG. */)
1155 (register Lisp_Object process, Lisp_Object flag)
1157 CHECK_PROCESS (process);
1158 XPROCESS (process)->kill_without_query = NILP (flag);
1159 return flag;
1162 DEFUN ("process-query-on-exit-flag",
1163 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1164 1, 1, 0,
1165 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1166 (register Lisp_Object process)
1168 CHECK_PROCESS (process);
1169 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1172 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1173 1, 2, 0,
1174 doc: /* Return the contact info of PROCESS; t for a real child.
1175 For a network or serial connection, the value depends on the optional
1176 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1177 SERVICE) for a network connection or (PORT SPEED) for a serial
1178 connection. If KEY is t, the complete contact information for the
1179 connection is returned, else the specific value for the keyword KEY is
1180 returned. See `make-network-process' or `make-serial-process' for a
1181 list of keywords. */)
1182 (register Lisp_Object process, Lisp_Object key)
1184 Lisp_Object contact;
1186 CHECK_PROCESS (process);
1187 contact = XPROCESS (process)->childp;
1189 #ifdef DATAGRAM_SOCKETS
1190 if (DATAGRAM_CONN_P (process)
1191 && (EQ (key, Qt) || EQ (key, QCremote)))
1192 contact = Fplist_put (contact, QCremote,
1193 Fprocess_datagram_address (process));
1194 #endif
1196 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1197 return contact;
1198 if (NILP (key) && NETCONN_P (process))
1199 return Fcons (Fplist_get (contact, QChost),
1200 Fcons (Fplist_get (contact, QCservice), Qnil));
1201 if (NILP (key) && SERIALCONN_P (process))
1202 return Fcons (Fplist_get (contact, QCport),
1203 Fcons (Fplist_get (contact, QCspeed), Qnil));
1204 return Fplist_get (contact, key);
1207 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1208 1, 1, 0,
1209 doc: /* Return the plist of PROCESS. */)
1210 (register Lisp_Object process)
1212 CHECK_PROCESS (process);
1213 return XPROCESS (process)->plist;
1216 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1217 2, 2, 0,
1218 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1219 (register Lisp_Object process, Lisp_Object plist)
1221 CHECK_PROCESS (process);
1222 CHECK_LIST (plist);
1224 pset_plist (XPROCESS (process), plist);
1225 return plist;
1228 #if 0 /* Turned off because we don't currently record this info
1229 in the process. Perhaps add it. */
1230 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1231 doc: /* Return the connection type of PROCESS.
1232 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1233 a socket connection. */)
1234 (Lisp_Object process)
1236 return XPROCESS (process)->type;
1238 #endif
1240 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1241 doc: /* Return the connection type of PROCESS.
1242 The value is either the symbol `real', `network', or `serial'.
1243 PROCESS may be a process, a buffer, the name of a process or buffer, or
1244 nil, indicating the current buffer's process. */)
1245 (Lisp_Object process)
1247 Lisp_Object proc;
1248 proc = get_process (process);
1249 return XPROCESS (proc)->type;
1252 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1253 1, 2, 0,
1254 doc: /* Convert network ADDRESS from internal format to a string.
1255 A 4 or 5 element vector represents an IPv4 address (with port number).
1256 An 8 or 9 element vector represents an IPv6 address (with port number).
1257 If optional second argument OMIT-PORT is non-nil, don't include a port
1258 number in the string, even when present in ADDRESS.
1259 Returns nil if format of ADDRESS is invalid. */)
1260 (Lisp_Object address, Lisp_Object omit_port)
1262 if (NILP (address))
1263 return Qnil;
1265 if (STRINGP (address)) /* AF_LOCAL */
1266 return address;
1268 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1270 register struct Lisp_Vector *p = XVECTOR (address);
1271 ptrdiff_t size = p->header.size;
1272 Lisp_Object args[10];
1273 int nargs, i;
1275 if (size == 4 || (size == 5 && !NILP (omit_port)))
1277 args[0] = build_string ("%d.%d.%d.%d");
1278 nargs = 4;
1280 else if (size == 5)
1282 args[0] = build_string ("%d.%d.%d.%d:%d");
1283 nargs = 5;
1285 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1287 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1288 nargs = 8;
1290 else if (size == 9)
1292 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1293 nargs = 9;
1295 else
1296 return Qnil;
1298 for (i = 0; i < nargs; i++)
1300 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1301 return Qnil;
1303 if (nargs <= 5 /* IPv4 */
1304 && i < 4 /* host, not port */
1305 && XINT (p->contents[i]) > 255)
1306 return Qnil;
1308 args[i+1] = p->contents[i];
1311 return Fformat (nargs+1, args);
1314 if (CONSP (address))
1316 Lisp_Object args[2];
1317 args[0] = build_string ("<Family %d>");
1318 args[1] = Fcar (address);
1319 return Fformat (2, args);
1322 return Qnil;
1325 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1326 doc: /* Return a list of all processes. */)
1327 (void)
1329 return Fmapcar (Qcdr, Vprocess_alist);
1332 /* Starting asynchronous inferior processes. */
1334 static Lisp_Object start_process_unwind (Lisp_Object proc);
1336 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1337 doc: /* Start a program in a subprocess. Return the process object for it.
1338 NAME is name for process. It is modified if necessary to make it unique.
1339 BUFFER is the buffer (or buffer name) to associate with the process.
1341 Process output (both standard output and standard error streams) goes
1342 at end of BUFFER, unless you specify an output stream or filter
1343 function to handle the output. BUFFER may also be nil, meaning that
1344 this process is not associated with any buffer.
1346 PROGRAM is the program file name. It is searched for in `exec-path'
1347 (which see). If nil, just associate a pty with the buffer. Remaining
1348 arguments are strings to give program as arguments.
1350 If you want to separate standard output from standard error, invoke
1351 the command through a shell and redirect one of them using the shell
1352 syntax.
1354 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1355 (ptrdiff_t nargs, Lisp_Object *args)
1357 Lisp_Object buffer, name, program, proc, current_dir, tem;
1358 register unsigned char **new_argv;
1359 ptrdiff_t i;
1360 ptrdiff_t count = SPECPDL_INDEX ();
1362 buffer = args[1];
1363 if (!NILP (buffer))
1364 buffer = Fget_buffer_create (buffer);
1366 /* Make sure that the child will be able to chdir to the current
1367 buffer's current directory, or its unhandled equivalent. We
1368 can't just have the child check for an error when it does the
1369 chdir, since it's in a vfork.
1371 We have to GCPRO around this because Fexpand_file_name and
1372 Funhandled_file_name_directory might call a file name handling
1373 function. The argument list is protected by the caller, so all
1374 we really have to worry about is buffer. */
1376 struct gcpro gcpro1, gcpro2;
1378 current_dir = BVAR (current_buffer, directory);
1380 GCPRO2 (buffer, current_dir);
1382 current_dir = Funhandled_file_name_directory (current_dir);
1383 if (NILP (current_dir))
1384 /* If the file name handler says that current_dir is unreachable, use
1385 a sensible default. */
1386 current_dir = build_string ("~/");
1387 current_dir = expand_and_dir_to_file (current_dir, Qnil);
1388 if (NILP (Ffile_accessible_directory_p (current_dir)))
1389 report_file_error ("Setting current directory",
1390 Fcons (BVAR (current_buffer, directory), Qnil));
1392 UNGCPRO;
1395 name = args[0];
1396 CHECK_STRING (name);
1398 program = args[2];
1400 if (!NILP (program))
1401 CHECK_STRING (program);
1403 proc = make_process (name);
1404 /* If an error occurs and we can't start the process, we want to
1405 remove it from the process list. This means that each error
1406 check in create_process doesn't need to call remove_process
1407 itself; it's all taken care of here. */
1408 record_unwind_protect (start_process_unwind, proc);
1410 pset_childp (XPROCESS (proc), Qt);
1411 pset_plist (XPROCESS (proc), Qnil);
1412 pset_type (XPROCESS (proc), Qreal);
1413 pset_buffer (XPROCESS (proc), buffer);
1414 pset_sentinel (XPROCESS (proc), Qnil);
1415 pset_filter (XPROCESS (proc), Qnil);
1416 pset_command (XPROCESS (proc), Flist (nargs - 2, args + 2));
1418 #ifdef HAVE_GNUTLS
1419 /* AKA GNUTLS_INITSTAGE(proc). */
1420 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1421 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1422 #endif
1424 #ifdef ADAPTIVE_READ_BUFFERING
1425 XPROCESS (proc)->adaptive_read_buffering
1426 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1427 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1428 #endif
1430 /* Make the process marker point into the process buffer (if any). */
1431 if (BUFFERP (buffer))
1432 set_marker_both (XPROCESS (proc)->mark, buffer,
1433 BUF_ZV (XBUFFER (buffer)),
1434 BUF_ZV_BYTE (XBUFFER (buffer)));
1437 /* Decide coding systems for communicating with the process. Here
1438 we don't setup the structure coding_system nor pay attention to
1439 unibyte mode. They are done in create_process. */
1441 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1442 Lisp_Object coding_systems = Qt;
1443 Lisp_Object val, *args2;
1444 struct gcpro gcpro1, gcpro2;
1446 val = Vcoding_system_for_read;
1447 if (NILP (val))
1449 args2 = alloca ((nargs + 1) * sizeof *args2);
1450 args2[0] = Qstart_process;
1451 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1452 GCPRO2 (proc, current_dir);
1453 if (!NILP (program))
1454 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1455 UNGCPRO;
1456 if (CONSP (coding_systems))
1457 val = XCAR (coding_systems);
1458 else if (CONSP (Vdefault_process_coding_system))
1459 val = XCAR (Vdefault_process_coding_system);
1461 pset_decode_coding_system (XPROCESS (proc), val);
1463 val = Vcoding_system_for_write;
1464 if (NILP (val))
1466 if (EQ (coding_systems, Qt))
1468 args2 = alloca ((nargs + 1) * sizeof *args2);
1469 args2[0] = Qstart_process;
1470 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1471 GCPRO2 (proc, current_dir);
1472 if (!NILP (program))
1473 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1474 UNGCPRO;
1476 if (CONSP (coding_systems))
1477 val = XCDR (coding_systems);
1478 else if (CONSP (Vdefault_process_coding_system))
1479 val = XCDR (Vdefault_process_coding_system);
1481 pset_encode_coding_system (XPROCESS (proc), val);
1482 /* Note: At this moment, the above coding system may leave
1483 text-conversion or eol-conversion unspecified. They will be
1484 decided after we read output from the process and decode it by
1485 some coding system, or just before we actually send a text to
1486 the process. */
1490 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1491 XPROCESS (proc)->decoding_carryover = 0;
1492 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1494 XPROCESS (proc)->inherit_coding_system_flag
1495 = !(NILP (buffer) || !inherit_process_coding_system);
1497 if (!NILP (program))
1499 /* If program file name is not absolute, search our path for it.
1500 Put the name we will really use in TEM. */
1501 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1502 && !(SCHARS (program) > 1
1503 && IS_DEVICE_SEP (SREF (program, 1))))
1505 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1507 tem = Qnil;
1508 GCPRO4 (name, program, buffer, current_dir);
1509 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1510 UNGCPRO;
1511 if (NILP (tem))
1512 report_file_error ("Searching for program", Fcons (program, Qnil));
1513 tem = Fexpand_file_name (tem, Qnil);
1515 else
1517 if (!NILP (Ffile_directory_p (program)))
1518 error ("Specified program for new process is a directory");
1519 tem = program;
1522 /* If program file name starts with /: for quoting a magic name,
1523 discard that. */
1524 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1525 && SREF (tem, 1) == ':')
1526 tem = Fsubstring (tem, make_number (2), Qnil);
1529 Lisp_Object arg_encoding = Qnil;
1530 struct gcpro gcpro1;
1531 GCPRO1 (tem);
1533 /* Encode the file name and put it in NEW_ARGV.
1534 That's where the child will use it to execute the program. */
1535 tem = Fcons (ENCODE_FILE (tem), Qnil);
1537 /* Here we encode arguments by the coding system used for sending
1538 data to the process. We don't support using different coding
1539 systems for encoding arguments and for encoding data sent to the
1540 process. */
1542 for (i = 3; i < nargs; i++)
1544 tem = Fcons (args[i], tem);
1545 CHECK_STRING (XCAR (tem));
1546 if (STRING_MULTIBYTE (XCAR (tem)))
1548 if (NILP (arg_encoding))
1549 arg_encoding = (complement_process_encoding_system
1550 (XPROCESS (proc)->encode_coding_system));
1551 XSETCAR (tem,
1552 code_convert_string_norecord
1553 (XCAR (tem), arg_encoding, 1));
1557 UNGCPRO;
1560 /* Now that everything is encoded we can collect the strings into
1561 NEW_ARGV. */
1562 new_argv = alloca ((nargs - 1) * sizeof *new_argv);
1563 new_argv[nargs - 2] = 0;
1565 for (i = nargs - 2; i-- != 0; )
1567 new_argv[i] = SDATA (XCAR (tem));
1568 tem = XCDR (tem);
1571 create_process (proc, (char **) new_argv, current_dir);
1573 else
1574 create_pty (proc);
1576 return unbind_to (count, proc);
1579 /* This function is the unwind_protect form for Fstart_process. If
1580 PROC doesn't have its pid set, then we know someone has signaled
1581 an error and the process wasn't started successfully, so we should
1582 remove it from the process list. */
1583 static Lisp_Object
1584 start_process_unwind (Lisp_Object proc)
1586 if (!PROCESSP (proc))
1587 emacs_abort ();
1589 /* Was PROC started successfully?
1590 -2 is used for a pty with no process, eg for gdb. */
1591 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1592 remove_process (proc);
1594 return Qnil;
1597 static void
1598 create_process_1 (struct atimer *timer)
1600 /* Nothing to do. */
1604 static void
1605 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1607 int inchannel, outchannel;
1608 pid_t pid;
1609 int sv[2];
1610 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1611 int wait_child_setup[2];
1612 #endif
1613 #ifdef SIGCHLD
1614 sigset_t blocked;
1615 #endif
1616 /* Use volatile to protect variables from being clobbered by vfork. */
1617 volatile int forkin, forkout;
1618 volatile int pty_flag = 0;
1619 volatile Lisp_Object lisp_pty_name = Qnil;
1620 volatile Lisp_Object encoded_current_dir;
1621 #if HAVE_WORKING_VFORK
1622 char **volatile save_environ;
1623 #endif
1625 inchannel = outchannel = -1;
1627 #ifdef HAVE_PTYS
1628 if (!NILP (Vprocess_connection_type))
1629 outchannel = inchannel = allocate_pty ();
1631 if (inchannel >= 0)
1633 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1634 /* On most USG systems it does not work to open the pty's tty here,
1635 then close it and reopen it in the child. */
1636 #ifdef O_NOCTTY
1637 /* Don't let this terminal become our controlling terminal
1638 (in case we don't have one). */
1639 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1640 #else
1641 forkout = forkin = emacs_open (pty_name, O_RDWR, 0);
1642 #endif
1643 if (forkin < 0)
1644 report_file_error ("Opening pty", Qnil);
1645 #else
1646 forkin = forkout = -1;
1647 #endif /* not USG, or USG_SUBTTY_WORKS */
1648 pty_flag = 1;
1649 lisp_pty_name = build_string (pty_name);
1651 else
1652 #endif /* HAVE_PTYS */
1654 int tem;
1655 tem = pipe (sv);
1656 if (tem < 0)
1657 report_file_error ("Creating pipe", Qnil);
1658 inchannel = sv[0];
1659 forkout = sv[1];
1660 tem = pipe (sv);
1661 if (tem < 0)
1663 emacs_close (inchannel);
1664 emacs_close (forkout);
1665 report_file_error ("Creating pipe", Qnil);
1667 outchannel = sv[1];
1668 forkin = sv[0];
1671 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1673 int tem;
1675 tem = pipe (wait_child_setup);
1676 if (tem < 0)
1677 report_file_error ("Creating pipe", Qnil);
1678 tem = fcntl (wait_child_setup[1], F_GETFD, 0);
1679 if (tem >= 0)
1680 tem = fcntl (wait_child_setup[1], F_SETFD, tem | FD_CLOEXEC);
1681 if (tem < 0)
1683 emacs_close (wait_child_setup[0]);
1684 emacs_close (wait_child_setup[1]);
1685 report_file_error ("Setting file descriptor flags", Qnil);
1688 #endif
1690 #ifdef O_NONBLOCK
1691 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1692 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1693 #else
1694 #ifdef O_NDELAY
1695 fcntl (inchannel, F_SETFL, O_NDELAY);
1696 fcntl (outchannel, F_SETFL, O_NDELAY);
1697 #endif
1698 #endif
1700 /* Record this as an active process, with its channels.
1701 As a result, child_setup will close Emacs's side of the pipes. */
1702 chan_process[inchannel] = process;
1703 XPROCESS (process)->infd = inchannel;
1704 XPROCESS (process)->outfd = outchannel;
1706 /* Previously we recorded the tty descriptor used in the subprocess.
1707 It was only used for getting the foreground tty process, so now
1708 we just reopen the device (see emacs_get_tty_pgrp) as this is
1709 more portable (see USG_SUBTTY_WORKS above). */
1711 XPROCESS (process)->pty_flag = pty_flag;
1712 pset_status (XPROCESS (process), Qrun);
1714 FD_SET (inchannel, &input_wait_mask);
1715 FD_SET (inchannel, &non_keyboard_wait_mask);
1716 if (inchannel > max_process_desc)
1717 max_process_desc = inchannel;
1719 /* Until we store the proper pid, enable the SIGCHLD handler
1720 to recognize an unknown pid as standing for this process.
1721 It is very important not to let this `marker' value stay
1722 in the table after this function has returned; if it does
1723 it might cause call-process to hang and subsequent asynchronous
1724 processes to get their return values scrambled. */
1725 XPROCESS (process)->pid = -1;
1727 /* This must be called after the above line because it may signal an
1728 error. */
1729 setup_process_coding_systems (process);
1731 encoded_current_dir = ENCODE_FILE (current_dir);
1733 block_input ();
1735 #ifdef SIGCHLD
1736 /* Block SIGCHLD until we have a chance to store the new fork's
1737 pid in its process structure. */
1738 sigemptyset (&blocked);
1739 sigaddset (&blocked, SIGCHLD);
1740 pthread_sigmask (SIG_BLOCK, &blocked, 0);
1741 #endif
1743 #if HAVE_WORKING_VFORK
1744 /* child_setup must clobber environ on systems with true vfork.
1745 Protect it from permanent change. */
1746 save_environ = environ;
1747 #endif
1749 #ifndef WINDOWSNT
1750 pid = vfork ();
1751 if (pid == 0)
1752 #endif /* not WINDOWSNT */
1754 int xforkin = forkin;
1755 int xforkout = forkout;
1757 /* Make the pty be the controlling terminal of the process. */
1758 #ifdef HAVE_PTYS
1759 /* First, disconnect its current controlling terminal. */
1760 #ifdef HAVE_SETSID
1761 /* We tried doing setsid only if pty_flag, but it caused
1762 process_set_signal to fail on SGI when using a pipe. */
1763 setsid ();
1764 /* Make the pty's terminal the controlling terminal. */
1765 if (pty_flag && xforkin >= 0)
1767 #ifdef TIOCSCTTY
1768 /* We ignore the return value
1769 because faith@cs.unc.edu says that is necessary on Linux. */
1770 ioctl (xforkin, TIOCSCTTY, 0);
1771 #endif
1773 #else /* not HAVE_SETSID */
1774 #ifdef USG
1775 /* It's very important to call setpgrp here and no time
1776 afterwards. Otherwise, we lose our controlling tty which
1777 is set when we open the pty. */
1778 setpgrp ();
1779 #endif /* USG */
1780 #endif /* not HAVE_SETSID */
1781 #if defined (LDISC1)
1782 if (pty_flag && xforkin >= 0)
1784 struct termios t;
1785 tcgetattr (xforkin, &t);
1786 t.c_lflag = LDISC1;
1787 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1788 emacs_write (1, "create_process/tcsetattr LDISC1 failed\n", 39);
1790 #else
1791 #if defined (NTTYDISC) && defined (TIOCSETD)
1792 if (pty_flag && xforkin >= 0)
1794 /* Use new line discipline. */
1795 int ldisc = NTTYDISC;
1796 ioctl (xforkin, TIOCSETD, &ldisc);
1798 #endif
1799 #endif
1800 #ifdef TIOCNOTTY
1801 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1802 can do TIOCSPGRP only to the process's controlling tty. */
1803 if (pty_flag)
1805 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1806 I can't test it since I don't have 4.3. */
1807 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1808 if (j >= 0)
1810 ioctl (j, TIOCNOTTY, 0);
1811 emacs_close (j);
1813 #ifndef USG
1814 /* In order to get a controlling terminal on some versions
1815 of BSD, it is necessary to put the process in pgrp 0
1816 before it opens the terminal. */
1817 #ifdef HAVE_SETPGID
1818 setpgid (0, 0);
1819 #else
1820 setpgrp (0, 0);
1821 #endif
1822 #endif
1824 #endif /* TIOCNOTTY */
1826 #if !defined (DONT_REOPEN_PTY)
1827 /*** There is a suggestion that this ought to be a
1828 conditional on TIOCSPGRP,
1829 or !(defined (HAVE_SETSID) && defined (TIOCSCTTY)).
1830 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1831 that system does seem to need this code, even though
1832 both HAVE_SETSID and TIOCSCTTY are defined. */
1833 /* Now close the pty (if we had it open) and reopen it.
1834 This makes the pty the controlling terminal of the subprocess. */
1835 if (pty_flag)
1838 /* I wonder if emacs_close (emacs_open (pty_name, ...))
1839 would work? */
1840 if (xforkin >= 0)
1841 emacs_close (xforkin);
1842 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
1844 if (xforkin < 0)
1846 emacs_write (1, "Couldn't open the pty terminal ", 31);
1847 emacs_write (1, pty_name, strlen (pty_name));
1848 emacs_write (1, "\n", 1);
1849 _exit (1);
1853 #endif /* not DONT_REOPEN_PTY */
1855 #ifdef SETUP_SLAVE_PTY
1856 if (pty_flag)
1858 SETUP_SLAVE_PTY;
1860 #endif /* SETUP_SLAVE_PTY */
1861 #ifdef AIX
1862 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
1863 Now reenable it in the child, so it will die when we want it to. */
1864 if (pty_flag)
1865 signal (SIGHUP, SIG_DFL);
1866 #endif
1867 #endif /* HAVE_PTYS */
1869 signal (SIGINT, SIG_DFL);
1870 signal (SIGQUIT, SIG_DFL);
1872 /* Emacs ignores SIGPIPE, but the child should not. */
1873 signal (SIGPIPE, SIG_DFL);
1875 #ifdef SIGCHLD
1876 /* Stop blocking signals in the child. */
1877 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
1878 #endif
1880 if (pty_flag)
1881 child_setup_tty (xforkout);
1882 #ifdef WINDOWSNT
1883 pid = child_setup (xforkin, xforkout, xforkout,
1884 new_argv, 1, encoded_current_dir);
1885 #else /* not WINDOWSNT */
1886 #ifdef FD_CLOEXEC
1887 emacs_close (wait_child_setup[0]);
1888 #endif
1889 child_setup (xforkin, xforkout, xforkout,
1890 new_argv, 1, encoded_current_dir);
1891 #endif /* not WINDOWSNT */
1894 /* Back in the parent process. */
1896 #if HAVE_WORKING_VFORK
1897 environ = save_environ;
1898 #endif
1900 XPROCESS (process)->pid = pid;
1902 /* Stop blocking signals in the parent. */
1903 #ifdef SIGCHLD
1904 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
1905 #endif
1906 unblock_input ();
1908 if (pid < 0)
1910 if (forkin >= 0)
1911 emacs_close (forkin);
1912 if (forkin != forkout && forkout >= 0)
1913 emacs_close (forkout);
1915 else
1917 /* vfork succeeded. */
1919 #ifdef WINDOWSNT
1920 register_child (pid, inchannel);
1921 #endif /* WINDOWSNT */
1923 /* If the subfork execv fails, and it exits,
1924 this close hangs. I don't know why.
1925 So have an interrupt jar it loose. */
1927 struct atimer *timer;
1928 EMACS_TIME offset = make_emacs_time (1, 0);
1930 stop_polling ();
1931 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
1933 if (forkin >= 0)
1934 emacs_close (forkin);
1936 cancel_atimer (timer);
1937 start_polling ();
1940 if (forkin != forkout && forkout >= 0)
1941 emacs_close (forkout);
1943 pset_tty_name (XPROCESS (process), lisp_pty_name);
1945 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1946 /* Wait for child_setup to complete in case that vfork is
1947 actually defined as fork. The descriptor wait_child_setup[1]
1948 of a pipe is closed at the child side either by close-on-exec
1949 on successful execvp or the _exit call in child_setup. */
1951 char dummy;
1953 emacs_close (wait_child_setup[1]);
1954 emacs_read (wait_child_setup[0], &dummy, 1);
1955 emacs_close (wait_child_setup[0]);
1957 #endif
1960 /* Now generate the error if vfork failed. */
1961 if (pid < 0)
1962 report_file_error ("Doing vfork", Qnil);
1965 void
1966 create_pty (Lisp_Object process)
1968 int inchannel, outchannel;
1969 int pty_flag = 0;
1971 inchannel = outchannel = -1;
1973 #ifdef HAVE_PTYS
1974 if (!NILP (Vprocess_connection_type))
1975 outchannel = inchannel = allocate_pty ();
1977 if (inchannel >= 0)
1979 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1980 /* On most USG systems it does not work to open the pty's tty here,
1981 then close it and reopen it in the child. */
1982 #ifdef O_NOCTTY
1983 /* Don't let this terminal become our controlling terminal
1984 (in case we don't have one). */
1985 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1986 #else
1987 int forkout = emacs_open (pty_name, O_RDWR, 0);
1988 #endif
1989 if (forkout < 0)
1990 report_file_error ("Opening pty", Qnil);
1991 #if defined (DONT_REOPEN_PTY)
1992 /* In the case that vfork is defined as fork, the parent process
1993 (Emacs) may send some data before the child process completes
1994 tty options setup. So we setup tty before forking. */
1995 child_setup_tty (forkout);
1996 #endif /* DONT_REOPEN_PTY */
1997 #endif /* not USG, or USG_SUBTTY_WORKS */
1998 pty_flag = 1;
2000 #endif /* HAVE_PTYS */
2002 #ifdef O_NONBLOCK
2003 fcntl (inchannel, F_SETFL, O_NONBLOCK);
2004 fcntl (outchannel, F_SETFL, O_NONBLOCK);
2005 #else
2006 #ifdef O_NDELAY
2007 fcntl (inchannel, F_SETFL, O_NDELAY);
2008 fcntl (outchannel, F_SETFL, O_NDELAY);
2009 #endif
2010 #endif
2012 /* Record this as an active process, with its channels.
2013 As a result, child_setup will close Emacs's side of the pipes. */
2014 chan_process[inchannel] = process;
2015 XPROCESS (process)->infd = inchannel;
2016 XPROCESS (process)->outfd = outchannel;
2018 /* Previously we recorded the tty descriptor used in the subprocess.
2019 It was only used for getting the foreground tty process, so now
2020 we just reopen the device (see emacs_get_tty_pgrp) as this is
2021 more portable (see USG_SUBTTY_WORKS above). */
2023 XPROCESS (process)->pty_flag = pty_flag;
2024 pset_status (XPROCESS (process), Qrun);
2025 setup_process_coding_systems (process);
2027 FD_SET (inchannel, &input_wait_mask);
2028 FD_SET (inchannel, &non_keyboard_wait_mask);
2029 if (inchannel > max_process_desc)
2030 max_process_desc = inchannel;
2032 XPROCESS (process)->pid = -2;
2033 #ifdef HAVE_PTYS
2034 if (pty_flag)
2035 pset_tty_name (XPROCESS (process), build_string (pty_name));
2036 else
2037 #endif
2038 pset_tty_name (XPROCESS (process), Qnil);
2042 /* Convert an internal struct sockaddr to a lisp object (vector or string).
2043 The address family of sa is not included in the result. */
2045 static Lisp_Object
2046 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
2048 Lisp_Object address;
2049 int i;
2050 unsigned char *cp;
2051 register struct Lisp_Vector *p;
2053 /* Workaround for a bug in getsockname on BSD: Names bound to
2054 sockets in the UNIX domain are inaccessible; getsockname returns
2055 a zero length name. */
2056 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
2057 return empty_unibyte_string;
2059 switch (sa->sa_family)
2061 case AF_INET:
2063 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2064 len = sizeof (sin->sin_addr) + 1;
2065 address = Fmake_vector (make_number (len), Qnil);
2066 p = XVECTOR (address);
2067 p->contents[--len] = make_number (ntohs (sin->sin_port));
2068 cp = (unsigned char *) &sin->sin_addr;
2069 break;
2071 #ifdef AF_INET6
2072 case AF_INET6:
2074 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2075 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
2076 len = sizeof (sin6->sin6_addr)/2 + 1;
2077 address = Fmake_vector (make_number (len), Qnil);
2078 p = XVECTOR (address);
2079 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2080 for (i = 0; i < len; i++)
2081 p->contents[i] = make_number (ntohs (ip6[i]));
2082 return address;
2084 #endif
2085 #ifdef HAVE_LOCAL_SOCKETS
2086 case AF_LOCAL:
2088 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2089 for (i = 0; i < sizeof (sockun->sun_path); i++)
2090 if (sockun->sun_path[i] == 0)
2091 break;
2092 return make_unibyte_string (sockun->sun_path, i);
2094 #endif
2095 default:
2096 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2097 address = Fcons (make_number (sa->sa_family),
2098 Fmake_vector (make_number (len), Qnil));
2099 p = XVECTOR (XCDR (address));
2100 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2101 break;
2104 i = 0;
2105 while (i < len)
2106 p->contents[i++] = make_number (*cp++);
2108 return address;
2112 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2114 static int
2115 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2117 register struct Lisp_Vector *p;
2119 if (VECTORP (address))
2121 p = XVECTOR (address);
2122 if (p->header.size == 5)
2124 *familyp = AF_INET;
2125 return sizeof (struct sockaddr_in);
2127 #ifdef AF_INET6
2128 else if (p->header.size == 9)
2130 *familyp = AF_INET6;
2131 return sizeof (struct sockaddr_in6);
2133 #endif
2135 #ifdef HAVE_LOCAL_SOCKETS
2136 else if (STRINGP (address))
2138 *familyp = AF_LOCAL;
2139 return sizeof (struct sockaddr_un);
2141 #endif
2142 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2143 && VECTORP (XCDR (address)))
2145 struct sockaddr *sa;
2146 *familyp = XINT (XCAR (address));
2147 p = XVECTOR (XCDR (address));
2148 return p->header.size + sizeof (sa->sa_family);
2150 return 0;
2153 /* Convert an address object (vector or string) to an internal sockaddr.
2155 The address format has been basically validated by
2156 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2157 it could have come from user data. So if FAMILY is not valid,
2158 we return after zeroing *SA. */
2160 static void
2161 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2163 register struct Lisp_Vector *p;
2164 register unsigned char *cp = NULL;
2165 register int i;
2166 EMACS_INT hostport;
2168 memset (sa, 0, len);
2170 if (VECTORP (address))
2172 p = XVECTOR (address);
2173 if (family == AF_INET)
2175 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2176 len = sizeof (sin->sin_addr) + 1;
2177 hostport = XINT (p->contents[--len]);
2178 sin->sin_port = htons (hostport);
2179 cp = (unsigned char *)&sin->sin_addr;
2180 sa->sa_family = family;
2182 #ifdef AF_INET6
2183 else if (family == AF_INET6)
2185 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2186 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2187 len = sizeof (sin6->sin6_addr) + 1;
2188 hostport = XINT (p->contents[--len]);
2189 sin6->sin6_port = htons (hostport);
2190 for (i = 0; i < len; i++)
2191 if (INTEGERP (p->contents[i]))
2193 int j = XFASTINT (p->contents[i]) & 0xffff;
2194 ip6[i] = ntohs (j);
2196 sa->sa_family = family;
2197 return;
2199 #endif
2200 else
2201 return;
2203 else if (STRINGP (address))
2205 #ifdef HAVE_LOCAL_SOCKETS
2206 if (family == AF_LOCAL)
2208 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2209 cp = SDATA (address);
2210 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2211 sockun->sun_path[i] = *cp++;
2212 sa->sa_family = family;
2214 #endif
2215 return;
2217 else
2219 p = XVECTOR (XCDR (address));
2220 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2223 for (i = 0; i < len; i++)
2224 if (INTEGERP (p->contents[i]))
2225 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2228 #ifdef DATAGRAM_SOCKETS
2229 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2230 1, 1, 0,
2231 doc: /* Get the current datagram address associated with PROCESS. */)
2232 (Lisp_Object process)
2234 int channel;
2236 CHECK_PROCESS (process);
2238 if (!DATAGRAM_CONN_P (process))
2239 return Qnil;
2241 channel = XPROCESS (process)->infd;
2242 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2243 datagram_address[channel].len);
2246 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2247 2, 2, 0,
2248 doc: /* Set the datagram address for PROCESS to ADDRESS.
2249 Returns nil upon error setting address, ADDRESS otherwise. */)
2250 (Lisp_Object process, Lisp_Object address)
2252 int channel;
2253 int family, len;
2255 CHECK_PROCESS (process);
2257 if (!DATAGRAM_CONN_P (process))
2258 return Qnil;
2260 channel = XPROCESS (process)->infd;
2262 len = get_lisp_to_sockaddr_size (address, &family);
2263 if (datagram_address[channel].len != len)
2264 return Qnil;
2265 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2266 return address;
2268 #endif
2271 static const struct socket_options {
2272 /* The name of this option. Should be lowercase version of option
2273 name without SO_ prefix. */
2274 const char *name;
2275 /* Option level SOL_... */
2276 int optlevel;
2277 /* Option number SO_... */
2278 int optnum;
2279 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2280 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2281 } socket_options[] =
2283 #ifdef SO_BINDTODEVICE
2284 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2285 #endif
2286 #ifdef SO_BROADCAST
2287 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2288 #endif
2289 #ifdef SO_DONTROUTE
2290 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2291 #endif
2292 #ifdef SO_KEEPALIVE
2293 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2294 #endif
2295 #ifdef SO_LINGER
2296 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2297 #endif
2298 #ifdef SO_OOBINLINE
2299 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2300 #endif
2301 #ifdef SO_PRIORITY
2302 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2303 #endif
2304 #ifdef SO_REUSEADDR
2305 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2306 #endif
2307 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2310 /* Set option OPT to value VAL on socket S.
2312 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2313 Signals an error if setting a known option fails.
2316 static int
2317 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2319 char *name;
2320 const struct socket_options *sopt;
2321 int ret = 0;
2323 CHECK_SYMBOL (opt);
2325 name = SSDATA (SYMBOL_NAME (opt));
2326 for (sopt = socket_options; sopt->name; sopt++)
2327 if (strcmp (name, sopt->name) == 0)
2328 break;
2330 switch (sopt->opttype)
2332 case SOPT_BOOL:
2334 int optval;
2335 optval = NILP (val) ? 0 : 1;
2336 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2337 &optval, sizeof (optval));
2338 break;
2341 case SOPT_INT:
2343 int optval;
2344 if (TYPE_RANGED_INTEGERP (int, val))
2345 optval = XINT (val);
2346 else
2347 error ("Bad option value for %s", name);
2348 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2349 &optval, sizeof (optval));
2350 break;
2353 #ifdef SO_BINDTODEVICE
2354 case SOPT_IFNAME:
2356 char devname[IFNAMSIZ+1];
2358 /* This is broken, at least in the Linux 2.4 kernel.
2359 To unbind, the arg must be a zero integer, not the empty string.
2360 This should work on all systems. KFS. 2003-09-23. */
2361 memset (devname, 0, sizeof devname);
2362 if (STRINGP (val))
2364 char *arg = SSDATA (val);
2365 int len = min (strlen (arg), IFNAMSIZ);
2366 memcpy (devname, arg, len);
2368 else if (!NILP (val))
2369 error ("Bad option value for %s", name);
2370 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2371 devname, IFNAMSIZ);
2372 break;
2374 #endif
2376 #ifdef SO_LINGER
2377 case SOPT_LINGER:
2379 struct linger linger;
2381 linger.l_onoff = 1;
2382 linger.l_linger = 0;
2383 if (TYPE_RANGED_INTEGERP (int, val))
2384 linger.l_linger = XINT (val);
2385 else
2386 linger.l_onoff = NILP (val) ? 0 : 1;
2387 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2388 &linger, sizeof (linger));
2389 break;
2391 #endif
2393 default:
2394 return 0;
2397 if (ret < 0)
2398 report_file_error ("Cannot set network option",
2399 Fcons (opt, Fcons (val, Qnil)));
2400 return (1 << sopt->optbit);
2404 DEFUN ("set-network-process-option",
2405 Fset_network_process_option, Sset_network_process_option,
2406 3, 4, 0,
2407 doc: /* For network process PROCESS set option OPTION to value VALUE.
2408 See `make-network-process' for a list of options and values.
2409 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2410 OPTION is not a supported option, return nil instead; otherwise return t. */)
2411 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2413 int s;
2414 struct Lisp_Process *p;
2416 CHECK_PROCESS (process);
2417 p = XPROCESS (process);
2418 if (!NETCONN1_P (p))
2419 error ("Process is not a network process");
2421 s = p->infd;
2422 if (s < 0)
2423 error ("Process is not running");
2425 if (set_socket_option (s, option, value))
2427 pset_childp (p, Fplist_put (p->childp, option, value));
2428 return Qt;
2431 if (NILP (no_error))
2432 error ("Unknown or unsupported option");
2434 return Qnil;
2438 DEFUN ("serial-process-configure",
2439 Fserial_process_configure,
2440 Sserial_process_configure,
2441 0, MANY, 0,
2442 doc: /* Configure speed, bytesize, etc. of a serial process.
2444 Arguments are specified as keyword/argument pairs. Attributes that
2445 are not given are re-initialized from the process's current
2446 configuration (available via the function `process-contact') or set to
2447 reasonable default values. The following arguments are defined:
2449 :process PROCESS
2450 :name NAME
2451 :buffer BUFFER
2452 :port PORT
2453 -- Any of these arguments can be given to identify the process that is
2454 to be configured. If none of these arguments is given, the current
2455 buffer's process is used.
2457 :speed SPEED -- SPEED is the speed of the serial port in bits per
2458 second, also called baud rate. Any value can be given for SPEED, but
2459 most serial ports work only at a few defined values between 1200 and
2460 115200, with 9600 being the most common value. If SPEED is nil, the
2461 serial port is not configured any further, i.e., all other arguments
2462 are ignored. This may be useful for special serial ports such as
2463 Bluetooth-to-serial converters which can only be configured through AT
2464 commands. A value of nil for SPEED can be used only when passed
2465 through `make-serial-process' or `serial-term'.
2467 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2468 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2470 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2471 `odd' (use odd parity), or the symbol `even' (use even parity). If
2472 PARITY is not given, no parity is used.
2474 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2475 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2476 is not given or nil, 1 stopbit is used.
2478 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2479 flowcontrol to be used, which is either nil (don't use flowcontrol),
2480 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2481 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2482 flowcontrol is used.
2484 `serial-process-configure' is called by `make-serial-process' for the
2485 initial configuration of the serial port.
2487 Examples:
2489 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2491 \(serial-process-configure
2492 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2494 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2496 usage: (serial-process-configure &rest ARGS) */)
2497 (ptrdiff_t nargs, Lisp_Object *args)
2499 struct Lisp_Process *p;
2500 Lisp_Object contact = Qnil;
2501 Lisp_Object proc = Qnil;
2502 struct gcpro gcpro1;
2504 contact = Flist (nargs, args);
2505 GCPRO1 (contact);
2507 proc = Fplist_get (contact, QCprocess);
2508 if (NILP (proc))
2509 proc = Fplist_get (contact, QCname);
2510 if (NILP (proc))
2511 proc = Fplist_get (contact, QCbuffer);
2512 if (NILP (proc))
2513 proc = Fplist_get (contact, QCport);
2514 proc = get_process (proc);
2515 p = XPROCESS (proc);
2516 if (!EQ (p->type, Qserial))
2517 error ("Not a serial process");
2519 if (NILP (Fplist_get (p->childp, QCspeed)))
2521 UNGCPRO;
2522 return Qnil;
2525 serial_configure (p, contact);
2527 UNGCPRO;
2528 return Qnil;
2531 /* Used by make-serial-process to recover from errors. */
2532 static Lisp_Object
2533 make_serial_process_unwind (Lisp_Object proc)
2535 if (!PROCESSP (proc))
2536 emacs_abort ();
2537 remove_process (proc);
2538 return Qnil;
2541 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2542 0, MANY, 0,
2543 doc: /* Create and return a serial port process.
2545 In Emacs, serial port connections are represented by process objects,
2546 so input and output work as for subprocesses, and `delete-process'
2547 closes a serial port connection. However, a serial process has no
2548 process id, it cannot be signaled, and the status codes are different
2549 from normal processes.
2551 `make-serial-process' creates a process and a buffer, on which you
2552 probably want to use `process-send-string'. Try \\[serial-term] for
2553 an interactive terminal. See below for examples.
2555 Arguments are specified as keyword/argument pairs. The following
2556 arguments are defined:
2558 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2559 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2560 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2561 the backslashes in strings).
2563 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2564 which this function calls.
2566 :name NAME -- NAME is the name of the process. If NAME is not given,
2567 the value of PORT is used.
2569 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2570 with the process. Process output goes at the end of that buffer,
2571 unless you specify an output stream or filter function to handle the
2572 output. If BUFFER is not given, the value of NAME is used.
2574 :coding CODING -- If CODING is a symbol, it specifies the coding
2575 system used for both reading and writing for this process. If CODING
2576 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2577 ENCODING is used for writing.
2579 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2580 the process is running. If BOOL is not given, query before exiting.
2582 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2583 In the stopped state, a serial process does not accept incoming data,
2584 but you can send outgoing data. The stopped state is cleared by
2585 `continue-process' and set by `stop-process'.
2587 :filter FILTER -- Install FILTER as the process filter.
2589 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2591 :plist PLIST -- Install PLIST as the initial plist of the process.
2593 :bytesize
2594 :parity
2595 :stopbits
2596 :flowcontrol
2597 -- This function calls `serial-process-configure' to handle these
2598 arguments.
2600 The original argument list, possibly modified by later configuration,
2601 is available via the function `process-contact'.
2603 Examples:
2605 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2607 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2609 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2611 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2613 usage: (make-serial-process &rest ARGS) */)
2614 (ptrdiff_t nargs, Lisp_Object *args)
2616 int fd = -1;
2617 Lisp_Object proc, contact, port;
2618 struct Lisp_Process *p;
2619 struct gcpro gcpro1;
2620 Lisp_Object name, buffer;
2621 Lisp_Object tem, val;
2622 ptrdiff_t specpdl_count = -1;
2624 if (nargs == 0)
2625 return Qnil;
2627 contact = Flist (nargs, args);
2628 GCPRO1 (contact);
2630 port = Fplist_get (contact, QCport);
2631 if (NILP (port))
2632 error ("No port specified");
2633 CHECK_STRING (port);
2635 if (NILP (Fplist_member (contact, QCspeed)))
2636 error (":speed not specified");
2637 if (!NILP (Fplist_get (contact, QCspeed)))
2638 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2640 name = Fplist_get (contact, QCname);
2641 if (NILP (name))
2642 name = port;
2643 CHECK_STRING (name);
2644 proc = make_process (name);
2645 specpdl_count = SPECPDL_INDEX ();
2646 record_unwind_protect (make_serial_process_unwind, proc);
2647 p = XPROCESS (proc);
2649 fd = serial_open (SSDATA (port));
2650 p->infd = fd;
2651 p->outfd = fd;
2652 if (fd > max_process_desc)
2653 max_process_desc = fd;
2654 chan_process[fd] = proc;
2656 buffer = Fplist_get (contact, QCbuffer);
2657 if (NILP (buffer))
2658 buffer = name;
2659 buffer = Fget_buffer_create (buffer);
2660 pset_buffer (p, buffer);
2662 pset_childp (p, contact);
2663 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2664 pset_type (p, Qserial);
2665 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2666 pset_filter (p, Fplist_get (contact, QCfilter));
2667 pset_log (p, Qnil);
2668 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2669 p->kill_without_query = 1;
2670 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2671 pset_command (p, Qt);
2672 p->pty_flag = 0;
2674 if (!EQ (p->command, Qt))
2676 FD_SET (fd, &input_wait_mask);
2677 FD_SET (fd, &non_keyboard_wait_mask);
2680 if (BUFFERP (buffer))
2682 set_marker_both (p->mark, buffer,
2683 BUF_ZV (XBUFFER (buffer)),
2684 BUF_ZV_BYTE (XBUFFER (buffer)));
2687 tem = Fplist_member (contact, QCcoding);
2688 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2689 tem = Qnil;
2691 val = Qnil;
2692 if (!NILP (tem))
2694 val = XCAR (XCDR (tem));
2695 if (CONSP (val))
2696 val = XCAR (val);
2698 else if (!NILP (Vcoding_system_for_read))
2699 val = Vcoding_system_for_read;
2700 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2701 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2702 val = Qnil;
2703 pset_decode_coding_system (p, val);
2705 val = Qnil;
2706 if (!NILP (tem))
2708 val = XCAR (XCDR (tem));
2709 if (CONSP (val))
2710 val = XCDR (val);
2712 else if (!NILP (Vcoding_system_for_write))
2713 val = Vcoding_system_for_write;
2714 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2715 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2716 val = Qnil;
2717 pset_encode_coding_system (p, val);
2719 setup_process_coding_systems (proc);
2720 pset_decoding_buf (p, empty_unibyte_string);
2721 p->decoding_carryover = 0;
2722 pset_encoding_buf (p, empty_unibyte_string);
2723 p->inherit_coding_system_flag
2724 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2726 Fserial_process_configure (nargs, args);
2728 specpdl_ptr = specpdl + specpdl_count;
2730 UNGCPRO;
2731 return proc;
2734 /* Create a network stream/datagram client/server process. Treated
2735 exactly like a normal process when reading and writing. Primary
2736 differences are in status display and process deletion. A network
2737 connection has no PID; you cannot signal it. All you can do is
2738 stop/continue it and deactivate/close it via delete-process */
2740 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2741 0, MANY, 0,
2742 doc: /* Create and return a network server or client process.
2744 In Emacs, network connections are represented by process objects, so
2745 input and output work as for subprocesses and `delete-process' closes
2746 a network connection. However, a network process has no process id,
2747 it cannot be signaled, and the status codes are different from normal
2748 processes.
2750 Arguments are specified as keyword/argument pairs. The following
2751 arguments are defined:
2753 :name NAME -- NAME is name for process. It is modified if necessary
2754 to make it unique.
2756 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2757 with the process. Process output goes at end of that buffer, unless
2758 you specify an output stream or filter function to handle the output.
2759 BUFFER may be also nil, meaning that this process is not associated
2760 with any buffer.
2762 :host HOST -- HOST is name of the host to connect to, or its IP
2763 address. The symbol `local' specifies the local host. If specified
2764 for a server process, it must be a valid name or address for the local
2765 host, and only clients connecting to that address will be accepted.
2767 :service SERVICE -- SERVICE is name of the service desired, or an
2768 integer specifying a port number to connect to. If SERVICE is t,
2769 a random port number is selected for the server. (If Emacs was
2770 compiled with getaddrinfo, a port number can also be specified as a
2771 string, e.g. "80", as well as an integer. This is not portable.)
2773 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2774 stream type connection, `datagram' creates a datagram type connection,
2775 `seqpacket' creates a reliable datagram connection.
2777 :family FAMILY -- FAMILY is the address (and protocol) family for the
2778 service specified by HOST and SERVICE. The default (nil) is to use
2779 whatever address family (IPv4 or IPv6) that is defined for the host
2780 and port number specified by HOST and SERVICE. Other address families
2781 supported are:
2782 local -- for a local (i.e. UNIX) address specified by SERVICE.
2783 ipv4 -- use IPv4 address family only.
2784 ipv6 -- use IPv6 address family only.
2786 :local ADDRESS -- ADDRESS is the local address used for the connection.
2787 This parameter is ignored when opening a client process. When specified
2788 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2790 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2791 connection. This parameter is ignored when opening a stream server
2792 process. For a datagram server process, it specifies the initial
2793 setting of the remote datagram address. When specified for a client
2794 process, the FAMILY, HOST, and SERVICE args are ignored.
2796 The format of ADDRESS depends on the address family:
2797 - An IPv4 address is represented as an vector of integers [A B C D P]
2798 corresponding to numeric IP address A.B.C.D and port number P.
2799 - A local address is represented as a string with the address in the
2800 local address space.
2801 - An "unsupported family" address is represented by a cons (F . AV)
2802 where F is the family number and AV is a vector containing the socket
2803 address data with one element per address data byte. Do not rely on
2804 this format in portable code, as it may depend on implementation
2805 defined constants, data sizes, and data structure alignment.
2807 :coding CODING -- If CODING is a symbol, it specifies the coding
2808 system used for both reading and writing for this process. If CODING
2809 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2810 ENCODING is used for writing.
2812 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2813 return without waiting for the connection to complete; instead, the
2814 sentinel function will be called with second arg matching "open" (if
2815 successful) or "failed" when the connect completes. Default is to use
2816 a blocking connect (i.e. wait) for stream type connections.
2818 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2819 running when Emacs is exited.
2821 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2822 In the stopped state, a server process does not accept new
2823 connections, and a client process does not handle incoming traffic.
2824 The stopped state is cleared by `continue-process' and set by
2825 `stop-process'.
2827 :filter FILTER -- Install FILTER as the process filter.
2829 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2830 process filter are multibyte, otherwise they are unibyte.
2831 If this keyword is not specified, the strings are multibyte if
2832 the default value of `enable-multibyte-characters' is non-nil.
2834 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2836 :log LOG -- Install LOG as the server process log function. This
2837 function is called when the server accepts a network connection from a
2838 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2839 is the server process, CLIENT is the new process for the connection,
2840 and MESSAGE is a string.
2842 :plist PLIST -- Install PLIST as the new process' initial plist.
2844 :server QLEN -- if QLEN is non-nil, create a server process for the
2845 specified FAMILY, SERVICE, and connection type (stream or datagram).
2846 If QLEN is an integer, it is used as the max. length of the server's
2847 pending connection queue (also known as the backlog); the default
2848 queue length is 5. Default is to create a client process.
2850 The following network options can be specified for this connection:
2852 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2853 :dontroute BOOL -- Only send to directly connected hosts.
2854 :keepalive BOOL -- Send keep-alive messages on network stream.
2855 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2856 :oobinline BOOL -- Place out-of-band data in receive data stream.
2857 :priority INT -- Set protocol defined priority for sent packets.
2858 :reuseaddr BOOL -- Allow reusing a recently used local address
2859 (this is allowed by default for a server process).
2860 :bindtodevice NAME -- bind to interface NAME. Using this may require
2861 special privileges on some systems.
2863 Consult the relevant system programmer's manual pages for more
2864 information on using these options.
2867 A server process will listen for and accept connections from clients.
2868 When a client connection is accepted, a new network process is created
2869 for the connection with the following parameters:
2871 - The client's process name is constructed by concatenating the server
2872 process' NAME and a client identification string.
2873 - If the FILTER argument is non-nil, the client process will not get a
2874 separate process buffer; otherwise, the client's process buffer is a newly
2875 created buffer named after the server process' BUFFER name or process
2876 NAME concatenated with the client identification string.
2877 - The connection type and the process filter and sentinel parameters are
2878 inherited from the server process' TYPE, FILTER and SENTINEL.
2879 - The client process' contact info is set according to the client's
2880 addressing information (typically an IP address and a port number).
2881 - The client process' plist is initialized from the server's plist.
2883 Notice that the FILTER and SENTINEL args are never used directly by
2884 the server process. Also, the BUFFER argument is not used directly by
2885 the server process, but via the optional :log function, accepted (and
2886 failed) connections may be logged in the server process' buffer.
2888 The original argument list, modified with the actual connection
2889 information, is available via the `process-contact' function.
2891 usage: (make-network-process &rest ARGS) */)
2892 (ptrdiff_t nargs, Lisp_Object *args)
2894 Lisp_Object proc;
2895 Lisp_Object contact;
2896 struct Lisp_Process *p;
2897 #ifdef HAVE_GETADDRINFO
2898 struct addrinfo ai, *res, *lres;
2899 struct addrinfo hints;
2900 const char *portstring;
2901 char portbuf[128];
2902 #else /* HAVE_GETADDRINFO */
2903 struct _emacs_addrinfo
2905 int ai_family;
2906 int ai_socktype;
2907 int ai_protocol;
2908 int ai_addrlen;
2909 struct sockaddr *ai_addr;
2910 struct _emacs_addrinfo *ai_next;
2911 } ai, *res, *lres;
2912 #endif /* HAVE_GETADDRINFO */
2913 struct sockaddr_in address_in;
2914 #ifdef HAVE_LOCAL_SOCKETS
2915 struct sockaddr_un address_un;
2916 #endif
2917 int port;
2918 int ret = 0;
2919 int xerrno = 0;
2920 int s = -1, outch, inch;
2921 struct gcpro gcpro1;
2922 ptrdiff_t count = SPECPDL_INDEX ();
2923 ptrdiff_t count1;
2924 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2925 Lisp_Object tem;
2926 Lisp_Object name, buffer, host, service, address;
2927 Lisp_Object filter, sentinel;
2928 int is_non_blocking_client = 0;
2929 int is_server = 0, backlog = 5;
2930 int socktype;
2931 int family = -1;
2933 if (nargs == 0)
2934 return Qnil;
2936 /* Save arguments for process-contact and clone-process. */
2937 contact = Flist (nargs, args);
2938 GCPRO1 (contact);
2940 #ifdef WINDOWSNT
2941 /* Ensure socket support is loaded if available. */
2942 init_winsock (TRUE);
2943 #endif
2945 /* :type TYPE (nil: stream, datagram */
2946 tem = Fplist_get (contact, QCtype);
2947 if (NILP (tem))
2948 socktype = SOCK_STREAM;
2949 #ifdef DATAGRAM_SOCKETS
2950 else if (EQ (tem, Qdatagram))
2951 socktype = SOCK_DGRAM;
2952 #endif
2953 #ifdef HAVE_SEQPACKET
2954 else if (EQ (tem, Qseqpacket))
2955 socktype = SOCK_SEQPACKET;
2956 #endif
2957 else
2958 error ("Unsupported connection type");
2960 /* :server BOOL */
2961 tem = Fplist_get (contact, QCserver);
2962 if (!NILP (tem))
2964 /* Don't support network sockets when non-blocking mode is
2965 not available, since a blocked Emacs is not useful. */
2966 #if !defined (O_NONBLOCK) && !defined (O_NDELAY)
2967 error ("Network servers not supported");
2968 #else
2969 is_server = 1;
2970 if (TYPE_RANGED_INTEGERP (int, tem))
2971 backlog = XINT (tem);
2972 #endif
2975 /* Make QCaddress an alias for :local (server) or :remote (client). */
2976 QCaddress = is_server ? QClocal : QCremote;
2978 /* :nowait BOOL */
2979 if (!is_server && socktype != SOCK_DGRAM
2980 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2982 #ifndef NON_BLOCKING_CONNECT
2983 error ("Non-blocking connect not supported");
2984 #else
2985 is_non_blocking_client = 1;
2986 #endif
2989 name = Fplist_get (contact, QCname);
2990 buffer = Fplist_get (contact, QCbuffer);
2991 filter = Fplist_get (contact, QCfilter);
2992 sentinel = Fplist_get (contact, QCsentinel);
2994 CHECK_STRING (name);
2996 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2997 ai.ai_socktype = socktype;
2998 ai.ai_protocol = 0;
2999 ai.ai_next = NULL;
3000 res = &ai;
3002 /* :local ADDRESS or :remote ADDRESS */
3003 address = Fplist_get (contact, QCaddress);
3004 if (!NILP (address))
3006 host = service = Qnil;
3008 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
3009 error ("Malformed :address");
3010 ai.ai_family = family;
3011 ai.ai_addr = alloca (ai.ai_addrlen);
3012 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
3013 goto open_socket;
3016 /* :family FAMILY -- nil (for Inet), local, or integer. */
3017 tem = Fplist_get (contact, QCfamily);
3018 if (NILP (tem))
3020 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
3021 family = AF_UNSPEC;
3022 #else
3023 family = AF_INET;
3024 #endif
3026 #ifdef HAVE_LOCAL_SOCKETS
3027 else if (EQ (tem, Qlocal))
3028 family = AF_LOCAL;
3029 #endif
3030 #ifdef AF_INET6
3031 else if (EQ (tem, Qipv6))
3032 family = AF_INET6;
3033 #endif
3034 else if (EQ (tem, Qipv4))
3035 family = AF_INET;
3036 else if (TYPE_RANGED_INTEGERP (int, tem))
3037 family = XINT (tem);
3038 else
3039 error ("Unknown address family");
3041 ai.ai_family = family;
3043 /* :service SERVICE -- string, integer (port number), or t (random port). */
3044 service = Fplist_get (contact, QCservice);
3046 /* :host HOST -- hostname, ip address, or 'local for localhost. */
3047 host = Fplist_get (contact, QChost);
3048 if (!NILP (host))
3050 if (EQ (host, Qlocal))
3051 /* Depending on setup, "localhost" may map to different IPv4 and/or
3052 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
3053 host = build_string ("127.0.0.1");
3054 CHECK_STRING (host);
3057 #ifdef HAVE_LOCAL_SOCKETS
3058 if (family == AF_LOCAL)
3060 if (!NILP (host))
3062 message (":family local ignores the :host \"%s\" property",
3063 SDATA (host));
3064 contact = Fplist_put (contact, QChost, Qnil);
3065 host = Qnil;
3067 CHECK_STRING (service);
3068 memset (&address_un, 0, sizeof address_un);
3069 address_un.sun_family = AF_LOCAL;
3070 if (sizeof address_un.sun_path <= SBYTES (service))
3071 error ("Service name too long");
3072 strcpy (address_un.sun_path, SSDATA (service));
3073 ai.ai_addr = (struct sockaddr *) &address_un;
3074 ai.ai_addrlen = sizeof address_un;
3075 goto open_socket;
3077 #endif
3079 /* Slow down polling to every ten seconds.
3080 Some kernels have a bug which causes retrying connect to fail
3081 after a connect. Polling can interfere with gethostbyname too. */
3082 #ifdef POLL_FOR_INPUT
3083 if (socktype != SOCK_DGRAM)
3085 record_unwind_protect (unwind_stop_other_atimers, Qnil);
3086 bind_polling_period (10);
3088 #endif
3090 #ifdef HAVE_GETADDRINFO
3091 /* If we have a host, use getaddrinfo to resolve both host and service.
3092 Otherwise, use getservbyname to lookup the service. */
3093 if (!NILP (host))
3096 /* SERVICE can either be a string or int.
3097 Convert to a C string for later use by getaddrinfo. */
3098 if (EQ (service, Qt))
3099 portstring = "0";
3100 else if (INTEGERP (service))
3102 sprintf (portbuf, "%"pI"d", XINT (service));
3103 portstring = portbuf;
3105 else
3107 CHECK_STRING (service);
3108 portstring = SSDATA (service);
3111 immediate_quit = 1;
3112 QUIT;
3113 memset (&hints, 0, sizeof (hints));
3114 hints.ai_flags = 0;
3115 hints.ai_family = family;
3116 hints.ai_socktype = socktype;
3117 hints.ai_protocol = 0;
3119 #ifdef HAVE_RES_INIT
3120 res_init ();
3121 #endif
3123 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3124 if (ret)
3125 #ifdef HAVE_GAI_STRERROR
3126 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3127 #else
3128 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3129 #endif
3130 immediate_quit = 0;
3132 goto open_socket;
3134 #endif /* HAVE_GETADDRINFO */
3136 /* We end up here if getaddrinfo is not defined, or in case no hostname
3137 has been specified (e.g. for a local server process). */
3139 if (EQ (service, Qt))
3140 port = 0;
3141 else if (INTEGERP (service))
3142 port = htons ((unsigned short) XINT (service));
3143 else
3145 struct servent *svc_info;
3146 CHECK_STRING (service);
3147 svc_info = getservbyname (SSDATA (service),
3148 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3149 if (svc_info == 0)
3150 error ("Unknown service: %s", SDATA (service));
3151 port = svc_info->s_port;
3154 memset (&address_in, 0, sizeof address_in);
3155 address_in.sin_family = family;
3156 address_in.sin_addr.s_addr = INADDR_ANY;
3157 address_in.sin_port = port;
3159 #ifndef HAVE_GETADDRINFO
3160 if (!NILP (host))
3162 struct hostent *host_info_ptr;
3164 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3165 as it may `hang' Emacs for a very long time. */
3166 immediate_quit = 1;
3167 QUIT;
3169 #ifdef HAVE_RES_INIT
3170 res_init ();
3171 #endif
3173 host_info_ptr = gethostbyname (SDATA (host));
3174 immediate_quit = 0;
3176 if (host_info_ptr)
3178 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3179 host_info_ptr->h_length);
3180 family = host_info_ptr->h_addrtype;
3181 address_in.sin_family = family;
3183 else
3184 /* Attempt to interpret host as numeric inet address */
3186 unsigned long numeric_addr;
3187 numeric_addr = inet_addr (SSDATA (host));
3188 if (numeric_addr == -1)
3189 error ("Unknown host \"%s\"", SDATA (host));
3191 memcpy (&address_in.sin_addr, &numeric_addr,
3192 sizeof (address_in.sin_addr));
3196 #endif /* not HAVE_GETADDRINFO */
3198 ai.ai_family = family;
3199 ai.ai_addr = (struct sockaddr *) &address_in;
3200 ai.ai_addrlen = sizeof address_in;
3202 open_socket:
3204 /* Do this in case we never enter the for-loop below. */
3205 count1 = SPECPDL_INDEX ();
3206 s = -1;
3208 for (lres = res; lres; lres = lres->ai_next)
3210 ptrdiff_t optn;
3211 int optbits;
3213 #ifdef WINDOWSNT
3214 retry_connect:
3215 #endif
3217 s = socket (lres->ai_family, lres->ai_socktype, lres->ai_protocol);
3218 if (s < 0)
3220 xerrno = errno;
3221 continue;
3224 #ifdef DATAGRAM_SOCKETS
3225 if (!is_server && socktype == SOCK_DGRAM)
3226 break;
3227 #endif /* DATAGRAM_SOCKETS */
3229 #ifdef NON_BLOCKING_CONNECT
3230 if (is_non_blocking_client)
3232 #ifdef O_NONBLOCK
3233 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3234 #else
3235 ret = fcntl (s, F_SETFL, O_NDELAY);
3236 #endif
3237 if (ret < 0)
3239 xerrno = errno;
3240 emacs_close (s);
3241 s = -1;
3242 continue;
3245 #endif
3247 /* Make us close S if quit. */
3248 record_unwind_protect (close_file_unwind, make_number (s));
3250 /* Parse network options in the arg list.
3251 We simply ignore anything which isn't a known option (including other keywords).
3252 An error is signaled if setting a known option fails. */
3253 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3254 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3256 if (is_server)
3258 /* Configure as a server socket. */
3260 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3261 explicit :reuseaddr key to override this. */
3262 #ifdef HAVE_LOCAL_SOCKETS
3263 if (family != AF_LOCAL)
3264 #endif
3265 if (!(optbits & (1 << OPIX_REUSEADDR)))
3267 int optval = 1;
3268 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3269 report_file_error ("Cannot set reuse option on server socket", Qnil);
3272 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3273 report_file_error ("Cannot bind server socket", Qnil);
3275 #ifdef HAVE_GETSOCKNAME
3276 if (EQ (service, Qt))
3278 struct sockaddr_in sa1;
3279 socklen_t len1 = sizeof (sa1);
3280 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3282 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3283 service = make_number (ntohs (sa1.sin_port));
3284 contact = Fplist_put (contact, QCservice, service);
3287 #endif
3289 if (socktype != SOCK_DGRAM && listen (s, backlog))
3290 report_file_error ("Cannot listen on server socket", Qnil);
3292 break;
3295 immediate_quit = 1;
3296 QUIT;
3298 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3299 xerrno = errno;
3301 if (ret == 0 || xerrno == EISCONN)
3303 /* The unwind-protect will be discarded afterwards.
3304 Likewise for immediate_quit. */
3305 break;
3308 #ifdef NON_BLOCKING_CONNECT
3309 #ifdef EINPROGRESS
3310 if (is_non_blocking_client && xerrno == EINPROGRESS)
3311 break;
3312 #else
3313 #ifdef EWOULDBLOCK
3314 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3315 break;
3316 #endif
3317 #endif
3318 #endif
3320 #ifndef WINDOWSNT
3321 if (xerrno == EINTR)
3323 /* Unlike most other syscalls connect() cannot be called
3324 again. (That would return EALREADY.) The proper way to
3325 wait for completion is pselect(). */
3326 int sc;
3327 socklen_t len;
3328 SELECT_TYPE fdset;
3329 retry_select:
3330 FD_ZERO (&fdset);
3331 FD_SET (s, &fdset);
3332 QUIT;
3333 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3334 if (sc == -1)
3336 if (errno == EINTR)
3337 goto retry_select;
3338 else
3339 report_file_error ("select failed", Qnil);
3341 eassert (sc > 0);
3343 len = sizeof xerrno;
3344 eassert (FD_ISSET (s, &fdset));
3345 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) == -1)
3346 report_file_error ("getsockopt failed", Qnil);
3347 if (xerrno)
3348 errno = xerrno, report_file_error ("error during connect", Qnil);
3349 else
3350 break;
3352 #endif /* !WINDOWSNT */
3354 immediate_quit = 0;
3356 /* Discard the unwind protect closing S. */
3357 specpdl_ptr = specpdl + count1;
3358 emacs_close (s);
3359 s = -1;
3361 #ifdef WINDOWSNT
3362 if (xerrno == EINTR)
3363 goto retry_connect;
3364 #endif
3367 if (s >= 0)
3369 #ifdef DATAGRAM_SOCKETS
3370 if (socktype == SOCK_DGRAM)
3372 if (datagram_address[s].sa)
3373 emacs_abort ();
3374 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3375 datagram_address[s].len = lres->ai_addrlen;
3376 if (is_server)
3378 Lisp_Object remote;
3379 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3380 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3382 int rfamily, rlen;
3383 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3384 if (rfamily == lres->ai_family && rlen == lres->ai_addrlen)
3385 conv_lisp_to_sockaddr (rfamily, remote,
3386 datagram_address[s].sa, rlen);
3389 else
3390 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3392 #endif
3393 contact = Fplist_put (contact, QCaddress,
3394 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3395 #ifdef HAVE_GETSOCKNAME
3396 if (!is_server)
3398 struct sockaddr_in sa1;
3399 socklen_t len1 = sizeof (sa1);
3400 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3401 contact = Fplist_put (contact, QClocal,
3402 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3404 #endif
3407 immediate_quit = 0;
3409 #ifdef HAVE_GETADDRINFO
3410 if (res != &ai)
3412 block_input ();
3413 freeaddrinfo (res);
3414 unblock_input ();
3416 #endif
3418 /* Discard the unwind protect for closing S, if any. */
3419 specpdl_ptr = specpdl + count1;
3421 /* Unwind bind_polling_period and request_sigio. */
3422 unbind_to (count, Qnil);
3424 if (s < 0)
3426 /* If non-blocking got this far - and failed - assume non-blocking is
3427 not supported after all. This is probably a wrong assumption, but
3428 the normal blocking calls to open-network-stream handles this error
3429 better. */
3430 if (is_non_blocking_client)
3431 return Qnil;
3433 errno = xerrno;
3434 if (is_server)
3435 report_file_error ("make server process failed", contact);
3436 else
3437 report_file_error ("make client process failed", contact);
3440 inch = s;
3441 outch = s;
3443 if (!NILP (buffer))
3444 buffer = Fget_buffer_create (buffer);
3445 proc = make_process (name);
3447 chan_process[inch] = proc;
3449 #ifdef O_NONBLOCK
3450 fcntl (inch, F_SETFL, O_NONBLOCK);
3451 #else
3452 #ifdef O_NDELAY
3453 fcntl (inch, F_SETFL, O_NDELAY);
3454 #endif
3455 #endif
3457 p = XPROCESS (proc);
3459 pset_childp (p, contact);
3460 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3461 pset_type (p, Qnetwork);
3463 pset_buffer (p, buffer);
3464 pset_sentinel (p, sentinel);
3465 pset_filter (p, filter);
3466 pset_log (p, Fplist_get (contact, QClog));
3467 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3468 p->kill_without_query = 1;
3469 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3470 pset_command (p, Qt);
3471 p->pid = 0;
3472 p->infd = inch;
3473 p->outfd = outch;
3474 if (is_server && socktype != SOCK_DGRAM)
3475 pset_status (p, Qlisten);
3477 /* Make the process marker point into the process buffer (if any). */
3478 if (BUFFERP (buffer))
3479 set_marker_both (p->mark, buffer,
3480 BUF_ZV (XBUFFER (buffer)),
3481 BUF_ZV_BYTE (XBUFFER (buffer)));
3483 #ifdef NON_BLOCKING_CONNECT
3484 if (is_non_blocking_client)
3486 /* We may get here if connect did succeed immediately. However,
3487 in that case, we still need to signal this like a non-blocking
3488 connection. */
3489 pset_status (p, Qconnect);
3490 if (!FD_ISSET (inch, &connect_wait_mask))
3492 FD_SET (inch, &connect_wait_mask);
3493 FD_SET (inch, &write_mask);
3494 num_pending_connects++;
3497 else
3498 #endif
3499 /* A server may have a client filter setting of Qt, but it must
3500 still listen for incoming connects unless it is stopped. */
3501 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3502 || (EQ (p->status, Qlisten) && NILP (p->command)))
3504 FD_SET (inch, &input_wait_mask);
3505 FD_SET (inch, &non_keyboard_wait_mask);
3508 if (inch > max_process_desc)
3509 max_process_desc = inch;
3511 tem = Fplist_member (contact, QCcoding);
3512 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3513 tem = Qnil; /* No error message (too late!). */
3516 /* Setup coding systems for communicating with the network stream. */
3517 struct gcpro gcpro1;
3518 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3519 Lisp_Object coding_systems = Qt;
3520 Lisp_Object fargs[5], val;
3522 if (!NILP (tem))
3524 val = XCAR (XCDR (tem));
3525 if (CONSP (val))
3526 val = XCAR (val);
3528 else if (!NILP (Vcoding_system_for_read))
3529 val = Vcoding_system_for_read;
3530 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3531 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3532 /* We dare not decode end-of-line format by setting VAL to
3533 Qraw_text, because the existing Emacs Lisp libraries
3534 assume that they receive bare code including a sequence of
3535 CR LF. */
3536 val = Qnil;
3537 else
3539 if (NILP (host) || NILP (service))
3540 coding_systems = Qnil;
3541 else
3543 fargs[0] = Qopen_network_stream, fargs[1] = name,
3544 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3545 GCPRO1 (proc);
3546 coding_systems = Ffind_operation_coding_system (5, fargs);
3547 UNGCPRO;
3549 if (CONSP (coding_systems))
3550 val = XCAR (coding_systems);
3551 else if (CONSP (Vdefault_process_coding_system))
3552 val = XCAR (Vdefault_process_coding_system);
3553 else
3554 val = Qnil;
3556 pset_decode_coding_system (p, val);
3558 if (!NILP (tem))
3560 val = XCAR (XCDR (tem));
3561 if (CONSP (val))
3562 val = XCDR (val);
3564 else if (!NILP (Vcoding_system_for_write))
3565 val = Vcoding_system_for_write;
3566 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3567 val = Qnil;
3568 else
3570 if (EQ (coding_systems, Qt))
3572 if (NILP (host) || NILP (service))
3573 coding_systems = Qnil;
3574 else
3576 fargs[0] = Qopen_network_stream, fargs[1] = name,
3577 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3578 GCPRO1 (proc);
3579 coding_systems = Ffind_operation_coding_system (5, fargs);
3580 UNGCPRO;
3583 if (CONSP (coding_systems))
3584 val = XCDR (coding_systems);
3585 else if (CONSP (Vdefault_process_coding_system))
3586 val = XCDR (Vdefault_process_coding_system);
3587 else
3588 val = Qnil;
3590 pset_encode_coding_system (p, val);
3592 setup_process_coding_systems (proc);
3594 pset_decoding_buf (p, empty_unibyte_string);
3595 p->decoding_carryover = 0;
3596 pset_encoding_buf (p, empty_unibyte_string);
3598 p->inherit_coding_system_flag
3599 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3601 UNGCPRO;
3602 return proc;
3606 #if defined (HAVE_NET_IF_H)
3608 #ifdef SIOCGIFCONF
3609 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3610 doc: /* Return an alist of all network interfaces and their network address.
3611 Each element is a cons, the car of which is a string containing the
3612 interface name, and the cdr is the network address in internal
3613 format; see the description of ADDRESS in `make-network-process'. */)
3614 (void)
3616 struct ifconf ifconf;
3617 struct ifreq *ifreq;
3618 void *buf = NULL;
3619 ptrdiff_t buf_size = 512;
3620 int s, i;
3621 Lisp_Object res;
3623 s = socket (AF_INET, SOCK_STREAM, 0);
3624 if (s < 0)
3625 return Qnil;
3629 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3630 ifconf.ifc_buf = buf;
3631 ifconf.ifc_len = buf_size;
3632 if (ioctl (s, SIOCGIFCONF, &ifconf))
3634 close (s);
3635 xfree (buf);
3636 return Qnil;
3639 while (ifconf.ifc_len == buf_size);
3641 close (s);
3643 res = Qnil;
3644 ifreq = ifconf.ifc_req;
3645 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3647 struct ifreq *ifq = ifreq;
3648 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3649 #define SIZEOF_IFREQ(sif) \
3650 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3651 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3653 int len = SIZEOF_IFREQ (ifq);
3654 #else
3655 int len = sizeof (*ifreq);
3656 #endif
3657 char namebuf[sizeof (ifq->ifr_name) + 1];
3658 i += len;
3659 ifreq = (struct ifreq *) ((char *) ifreq + len);
3661 if (ifq->ifr_addr.sa_family != AF_INET)
3662 continue;
3664 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3665 namebuf[sizeof (ifq->ifr_name)] = 0;
3666 res = Fcons (Fcons (build_string (namebuf),
3667 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3668 sizeof (struct sockaddr))),
3669 res);
3672 xfree (buf);
3673 return res;
3675 #endif /* SIOCGIFCONF */
3677 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3679 struct ifflag_def {
3680 int flag_bit;
3681 const char *flag_sym;
3684 static const struct ifflag_def ifflag_table[] = {
3685 #ifdef IFF_UP
3686 { IFF_UP, "up" },
3687 #endif
3688 #ifdef IFF_BROADCAST
3689 { IFF_BROADCAST, "broadcast" },
3690 #endif
3691 #ifdef IFF_DEBUG
3692 { IFF_DEBUG, "debug" },
3693 #endif
3694 #ifdef IFF_LOOPBACK
3695 { IFF_LOOPBACK, "loopback" },
3696 #endif
3697 #ifdef IFF_POINTOPOINT
3698 { IFF_POINTOPOINT, "pointopoint" },
3699 #endif
3700 #ifdef IFF_RUNNING
3701 { IFF_RUNNING, "running" },
3702 #endif
3703 #ifdef IFF_NOARP
3704 { IFF_NOARP, "noarp" },
3705 #endif
3706 #ifdef IFF_PROMISC
3707 { IFF_PROMISC, "promisc" },
3708 #endif
3709 #ifdef IFF_NOTRAILERS
3710 #ifdef NS_IMPL_COCOA
3711 /* Really means smart, notrailers is obsolete */
3712 { IFF_NOTRAILERS, "smart" },
3713 #else
3714 { IFF_NOTRAILERS, "notrailers" },
3715 #endif
3716 #endif
3717 #ifdef IFF_ALLMULTI
3718 { IFF_ALLMULTI, "allmulti" },
3719 #endif
3720 #ifdef IFF_MASTER
3721 { IFF_MASTER, "master" },
3722 #endif
3723 #ifdef IFF_SLAVE
3724 { IFF_SLAVE, "slave" },
3725 #endif
3726 #ifdef IFF_MULTICAST
3727 { IFF_MULTICAST, "multicast" },
3728 #endif
3729 #ifdef IFF_PORTSEL
3730 { IFF_PORTSEL, "portsel" },
3731 #endif
3732 #ifdef IFF_AUTOMEDIA
3733 { IFF_AUTOMEDIA, "automedia" },
3734 #endif
3735 #ifdef IFF_DYNAMIC
3736 { IFF_DYNAMIC, "dynamic" },
3737 #endif
3738 #ifdef IFF_OACTIVE
3739 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3740 #endif
3741 #ifdef IFF_SIMPLEX
3742 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3743 #endif
3744 #ifdef IFF_LINK0
3745 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3746 #endif
3747 #ifdef IFF_LINK1
3748 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3749 #endif
3750 #ifdef IFF_LINK2
3751 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3752 #endif
3753 { 0, 0 }
3756 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3757 doc: /* Return information about network interface named IFNAME.
3758 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3759 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3760 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
3761 FLAGS is the current flags of the interface. */)
3762 (Lisp_Object ifname)
3764 struct ifreq rq;
3765 Lisp_Object res = Qnil;
3766 Lisp_Object elt;
3767 int s;
3768 int any = 0;
3769 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3770 && defined HAVE_GETIFADDRS && defined LLADDR)
3771 struct ifaddrs *ifap;
3772 #endif
3774 CHECK_STRING (ifname);
3776 if (sizeof rq.ifr_name <= SBYTES (ifname))
3777 error ("interface name too long");
3778 strcpy (rq.ifr_name, SSDATA (ifname));
3780 s = socket (AF_INET, SOCK_STREAM, 0);
3781 if (s < 0)
3782 return Qnil;
3784 elt = Qnil;
3785 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3786 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3788 int flags = rq.ifr_flags;
3789 const struct ifflag_def *fp;
3790 int fnum;
3792 /* If flags is smaller than int (i.e. short) it may have the high bit set
3793 due to IFF_MULTICAST. In that case, sign extending it into
3794 an int is wrong. */
3795 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3796 flags = (unsigned short) rq.ifr_flags;
3798 any = 1;
3799 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3801 if (flags & fp->flag_bit)
3803 elt = Fcons (intern (fp->flag_sym), elt);
3804 flags -= fp->flag_bit;
3807 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3809 if (flags & 1)
3811 elt = Fcons (make_number (fnum), elt);
3815 #endif
3816 res = Fcons (elt, res);
3818 elt = Qnil;
3819 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3820 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3822 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3823 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3824 int n;
3826 any = 1;
3827 for (n = 0; n < 6; n++)
3828 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3829 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3831 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3832 if (getifaddrs (&ifap) != -1)
3834 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3835 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3836 struct ifaddrs *it;
3838 for (it = ifap; it != NULL; it = it->ifa_next)
3840 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3841 unsigned char linkaddr[6];
3842 int n;
3844 if (it->ifa_addr->sa_family != AF_LINK
3845 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3846 || sdl->sdl_alen != 6)
3847 continue;
3849 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3850 for (n = 0; n < 6; n++)
3851 p->contents[n] = make_number (linkaddr[n]);
3853 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3854 break;
3857 #ifdef HAVE_FREEIFADDRS
3858 freeifaddrs (ifap);
3859 #endif
3861 #endif /* HAVE_GETIFADDRS && LLADDR */
3863 res = Fcons (elt, res);
3865 elt = Qnil;
3866 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3867 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3869 any = 1;
3870 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3871 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3872 #else
3873 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3874 #endif
3876 #endif
3877 res = Fcons (elt, res);
3879 elt = Qnil;
3880 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3881 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3883 any = 1;
3884 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3886 #endif
3887 res = Fcons (elt, res);
3889 elt = Qnil;
3890 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3891 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3893 any = 1;
3894 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3896 #endif
3897 res = Fcons (elt, res);
3899 close (s);
3901 return any ? res : Qnil;
3903 #endif
3904 #endif /* defined (HAVE_NET_IF_H) */
3906 /* Turn off input and output for process PROC. */
3908 static void
3909 deactivate_process (Lisp_Object proc)
3911 register int inchannel, outchannel;
3912 register struct Lisp_Process *p = XPROCESS (proc);
3914 #ifdef HAVE_GNUTLS
3915 /* Delete GnuTLS structures in PROC, if any. */
3916 emacs_gnutls_deinit (proc);
3917 #endif /* HAVE_GNUTLS */
3919 inchannel = p->infd;
3920 outchannel = p->outfd;
3922 #ifdef ADAPTIVE_READ_BUFFERING
3923 if (p->read_output_delay > 0)
3925 if (--process_output_delay_count < 0)
3926 process_output_delay_count = 0;
3927 p->read_output_delay = 0;
3928 p->read_output_skip = 0;
3930 #endif
3932 if (inchannel >= 0)
3934 /* Beware SIGCHLD hereabouts. */
3935 flush_pending_output (inchannel);
3936 emacs_close (inchannel);
3937 if (outchannel >= 0 && outchannel != inchannel)
3938 emacs_close (outchannel);
3940 p->infd = -1;
3941 p->outfd = -1;
3942 #ifdef DATAGRAM_SOCKETS
3943 if (DATAGRAM_CHAN_P (inchannel))
3945 xfree (datagram_address[inchannel].sa);
3946 datagram_address[inchannel].sa = 0;
3947 datagram_address[inchannel].len = 0;
3949 #endif
3950 chan_process[inchannel] = Qnil;
3951 FD_CLR (inchannel, &input_wait_mask);
3952 FD_CLR (inchannel, &non_keyboard_wait_mask);
3953 #ifdef NON_BLOCKING_CONNECT
3954 if (FD_ISSET (inchannel, &connect_wait_mask))
3956 FD_CLR (inchannel, &connect_wait_mask);
3957 FD_CLR (inchannel, &write_mask);
3958 if (--num_pending_connects < 0)
3959 emacs_abort ();
3961 #endif
3962 if (inchannel == max_process_desc)
3964 int i;
3965 /* We just closed the highest-numbered process input descriptor,
3966 so recompute the highest-numbered one now. */
3967 max_process_desc = 0;
3968 for (i = 0; i < MAXDESC; i++)
3969 if (!NILP (chan_process[i]))
3970 max_process_desc = i;
3976 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3977 0, 4, 0,
3978 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3979 It is read into the process' buffers or given to their filter functions.
3980 Non-nil arg PROCESS means do not return until some output has been received
3981 from PROCESS.
3983 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3984 and milliseconds to wait; return after that much time whether or not
3985 there is any subprocess output. If SECONDS is a floating point number,
3986 it specifies a fractional number of seconds to wait.
3987 The MILLISEC argument is obsolete and should be avoided.
3989 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3990 from PROCESS, suspending reading output from other processes.
3991 If JUST-THIS-ONE is an integer, don't run any timers either.
3992 Return non-nil if we received any output before the timeout expired. */)
3993 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3995 intmax_t secs;
3996 int nsecs;
3998 if (! NILP (process))
3999 CHECK_PROCESS (process);
4000 else
4001 just_this_one = Qnil;
4003 if (!NILP (millisec))
4004 { /* Obsolete calling convention using integers rather than floats. */
4005 CHECK_NUMBER (millisec);
4006 if (NILP (seconds))
4007 seconds = make_float (XINT (millisec) / 1000.0);
4008 else
4010 CHECK_NUMBER (seconds);
4011 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
4015 secs = 0;
4016 nsecs = -1;
4018 if (!NILP (seconds))
4020 if (INTEGERP (seconds))
4022 if (0 < XINT (seconds))
4024 secs = XINT (seconds);
4025 nsecs = 0;
4028 else if (FLOATP (seconds))
4030 if (0 < XFLOAT_DATA (seconds))
4032 EMACS_TIME t = EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (seconds));
4033 secs = min (EMACS_SECS (t), WAIT_READING_MAX);
4034 nsecs = EMACS_NSECS (t);
4037 else
4038 wrong_type_argument (Qnumberp, seconds);
4040 else if (! NILP (process))
4041 nsecs = 0;
4043 return
4044 (wait_reading_process_output (secs, nsecs, 0, 0,
4045 Qnil,
4046 !NILP (process) ? XPROCESS (process) : NULL,
4047 NILP (just_this_one) ? 0 :
4048 !INTEGERP (just_this_one) ? 1 : -1)
4049 ? Qt : Qnil);
4052 /* Accept a connection for server process SERVER on CHANNEL. */
4054 static int connect_counter = 0;
4056 static void
4057 server_accept_connection (Lisp_Object server, int channel)
4059 Lisp_Object proc, caller, name, buffer;
4060 Lisp_Object contact, host, service;
4061 struct Lisp_Process *ps= XPROCESS (server);
4062 struct Lisp_Process *p;
4063 int s;
4064 union u_sockaddr {
4065 struct sockaddr sa;
4066 struct sockaddr_in in;
4067 #ifdef AF_INET6
4068 struct sockaddr_in6 in6;
4069 #endif
4070 #ifdef HAVE_LOCAL_SOCKETS
4071 struct sockaddr_un un;
4072 #endif
4073 } saddr;
4074 socklen_t len = sizeof saddr;
4076 s = accept (channel, &saddr.sa, &len);
4078 if (s < 0)
4080 int code = errno;
4082 if (code == EAGAIN)
4083 return;
4084 #ifdef EWOULDBLOCK
4085 if (code == EWOULDBLOCK)
4086 return;
4087 #endif
4089 if (!NILP (ps->log))
4090 call3 (ps->log, server, Qnil,
4091 concat3 (build_string ("accept failed with code"),
4092 Fnumber_to_string (make_number (code)),
4093 build_string ("\n")));
4094 return;
4097 connect_counter++;
4099 /* Setup a new process to handle the connection. */
4101 /* Generate a unique identification of the caller, and build contact
4102 information for this process. */
4103 host = Qt;
4104 service = Qnil;
4105 switch (saddr.sa.sa_family)
4107 case AF_INET:
4109 Lisp_Object args[5];
4110 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4111 args[0] = build_string ("%d.%d.%d.%d");
4112 args[1] = make_number (*ip++);
4113 args[2] = make_number (*ip++);
4114 args[3] = make_number (*ip++);
4115 args[4] = make_number (*ip++);
4116 host = Fformat (5, args);
4117 service = make_number (ntohs (saddr.in.sin_port));
4119 args[0] = build_string (" <%s:%d>");
4120 args[1] = host;
4121 args[2] = service;
4122 caller = Fformat (3, args);
4124 break;
4126 #ifdef AF_INET6
4127 case AF_INET6:
4129 Lisp_Object args[9];
4130 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4131 int i;
4132 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4133 for (i = 0; i < 8; i++)
4134 args[i+1] = make_number (ntohs (ip6[i]));
4135 host = Fformat (9, args);
4136 service = make_number (ntohs (saddr.in.sin_port));
4138 args[0] = build_string (" <[%s]:%d>");
4139 args[1] = host;
4140 args[2] = service;
4141 caller = Fformat (3, args);
4143 break;
4144 #endif
4146 #ifdef HAVE_LOCAL_SOCKETS
4147 case AF_LOCAL:
4148 #endif
4149 default:
4150 caller = Fnumber_to_string (make_number (connect_counter));
4151 caller = concat3 (build_string (" <"), caller, build_string (">"));
4152 break;
4155 /* Create a new buffer name for this process if it doesn't have a
4156 filter. The new buffer name is based on the buffer name or
4157 process name of the server process concatenated with the caller
4158 identification. */
4160 if (!NILP (ps->filter) && !EQ (ps->filter, Qt))
4161 buffer = Qnil;
4162 else
4164 buffer = ps->buffer;
4165 if (!NILP (buffer))
4166 buffer = Fbuffer_name (buffer);
4167 else
4168 buffer = ps->name;
4169 if (!NILP (buffer))
4171 buffer = concat2 (buffer, caller);
4172 buffer = Fget_buffer_create (buffer);
4176 /* Generate a unique name for the new server process. Combine the
4177 server process name with the caller identification. */
4179 name = concat2 (ps->name, caller);
4180 proc = make_process (name);
4182 chan_process[s] = proc;
4184 #ifdef O_NONBLOCK
4185 fcntl (s, F_SETFL, O_NONBLOCK);
4186 #else
4187 #ifdef O_NDELAY
4188 fcntl (s, F_SETFL, O_NDELAY);
4189 #endif
4190 #endif
4192 p = XPROCESS (proc);
4194 /* Build new contact information for this setup. */
4195 contact = Fcopy_sequence (ps->childp);
4196 contact = Fplist_put (contact, QCserver, Qnil);
4197 contact = Fplist_put (contact, QChost, host);
4198 if (!NILP (service))
4199 contact = Fplist_put (contact, QCservice, service);
4200 contact = Fplist_put (contact, QCremote,
4201 conv_sockaddr_to_lisp (&saddr.sa, len));
4202 #ifdef HAVE_GETSOCKNAME
4203 len = sizeof saddr;
4204 if (getsockname (s, &saddr.sa, &len) == 0)
4205 contact = Fplist_put (contact, QClocal,
4206 conv_sockaddr_to_lisp (&saddr.sa, len));
4207 #endif
4209 pset_childp (p, contact);
4210 pset_plist (p, Fcopy_sequence (ps->plist));
4211 pset_type (p, Qnetwork);
4213 pset_buffer (p, buffer);
4214 pset_sentinel (p, ps->sentinel);
4215 pset_filter (p, ps->filter);
4216 pset_command (p, Qnil);
4217 p->pid = 0;
4218 p->infd = s;
4219 p->outfd = s;
4220 pset_status (p, Qrun);
4222 /* Client processes for accepted connections are not stopped initially. */
4223 if (!EQ (p->filter, Qt))
4225 FD_SET (s, &input_wait_mask);
4226 FD_SET (s, &non_keyboard_wait_mask);
4229 if (s > max_process_desc)
4230 max_process_desc = s;
4232 /* Setup coding system for new process based on server process.
4233 This seems to be the proper thing to do, as the coding system
4234 of the new process should reflect the settings at the time the
4235 server socket was opened; not the current settings. */
4237 pset_decode_coding_system (p, ps->decode_coding_system);
4238 pset_encode_coding_system (p, ps->encode_coding_system);
4239 setup_process_coding_systems (proc);
4241 pset_decoding_buf (p, empty_unibyte_string);
4242 p->decoding_carryover = 0;
4243 pset_encoding_buf (p, empty_unibyte_string);
4245 p->inherit_coding_system_flag
4246 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4248 if (!NILP (ps->log))
4249 call3 (ps->log, server, proc,
4250 concat3 (build_string ("accept from "),
4251 (STRINGP (host) ? host : build_string ("-")),
4252 build_string ("\n")));
4254 if (!NILP (p->sentinel))
4255 exec_sentinel (proc,
4256 concat3 (build_string ("open from "),
4257 (STRINGP (host) ? host : build_string ("-")),
4258 build_string ("\n")));
4261 /* This variable is different from waiting_for_input in keyboard.c.
4262 It is used to communicate to a lisp process-filter/sentinel (via the
4263 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4264 for user-input when that process-filter was called.
4265 waiting_for_input cannot be used as that is by definition 0 when
4266 lisp code is being evalled.
4267 This is also used in record_asynch_buffer_change.
4268 For that purpose, this must be 0
4269 when not inside wait_reading_process_output. */
4270 static int waiting_for_user_input_p;
4272 static Lisp_Object
4273 wait_reading_process_output_unwind (Lisp_Object data)
4275 waiting_for_user_input_p = XINT (data);
4276 return Qnil;
4279 /* This is here so breakpoints can be put on it. */
4280 static void
4281 wait_reading_process_output_1 (void)
4285 /* Read and dispose of subprocess output while waiting for timeout to
4286 elapse and/or keyboard input to be available.
4288 TIME_LIMIT is:
4289 timeout in seconds
4290 If negative, gobble data immediately available but don't wait for any.
4292 NSECS is:
4293 an additional duration to wait, measured in nanoseconds
4294 If TIME_LIMIT is zero, then:
4295 If NSECS == 0, there is no limit.
4296 If NSECS > 0, the timeout consists of NSECS only.
4297 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4299 READ_KBD is:
4300 0 to ignore keyboard input, or
4301 1 to return when input is available, or
4302 -1 meaning caller will actually read the input, so don't throw to
4303 the quit handler, or
4305 DO_DISPLAY != 0 means redisplay should be done to show subprocess
4306 output that arrives.
4308 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4309 (and gobble terminal input into the buffer if any arrives).
4311 If WAIT_PROC is specified, wait until something arrives from that
4312 process. The return value is true if we read some input from
4313 that process.
4315 If JUST_WAIT_PROC is non-nil, handle only output from WAIT_PROC
4316 (suspending output from other processes). A negative value
4317 means don't run any timers either.
4319 If WAIT_PROC is specified, then the function returns true if we
4320 received input from that process before the timeout elapsed.
4321 Otherwise, return true if we received input from any process. */
4324 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4325 int do_display,
4326 Lisp_Object wait_for_cell,
4327 struct Lisp_Process *wait_proc, int just_wait_proc)
4329 register int channel, nfds;
4330 SELECT_TYPE Available;
4331 SELECT_TYPE Writeok;
4332 int check_write;
4333 int check_delay, no_avail;
4334 int xerrno;
4335 Lisp_Object proc;
4336 EMACS_TIME timeout, end_time;
4337 int wait_channel = -1;
4338 int got_some_input = 0;
4339 ptrdiff_t count = SPECPDL_INDEX ();
4341 FD_ZERO (&Available);
4342 FD_ZERO (&Writeok);
4344 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4345 && !(CONSP (wait_proc->status)
4346 && EQ (XCAR (wait_proc->status), Qexit)))
4347 message ("Blocking call to accept-process-output with quit inhibited!!");
4349 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4350 if (wait_proc != NULL)
4351 wait_channel = wait_proc->infd;
4353 record_unwind_protect (wait_reading_process_output_unwind,
4354 make_number (waiting_for_user_input_p));
4355 waiting_for_user_input_p = read_kbd;
4357 if (time_limit < 0)
4359 time_limit = 0;
4360 nsecs = -1;
4362 else if (TYPE_MAXIMUM (time_t) < time_limit)
4363 time_limit = TYPE_MAXIMUM (time_t);
4365 /* Since we may need to wait several times,
4366 compute the absolute time to return at. */
4367 if (time_limit || 0 < nsecs)
4369 timeout = make_emacs_time (time_limit, nsecs);
4370 end_time = add_emacs_time (current_emacs_time (), timeout);
4373 while (1)
4375 int timeout_reduced_for_timers = 0;
4377 /* If calling from keyboard input, do not quit
4378 since we want to return C-g as an input character.
4379 Otherwise, do pending quit if requested. */
4380 if (read_kbd >= 0)
4381 QUIT;
4382 else if (pending_signals)
4383 process_pending_signals ();
4385 /* Exit now if the cell we're waiting for became non-nil. */
4386 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4387 break;
4389 /* Compute time from now till when time limit is up */
4390 /* Exit if already run out */
4391 if (nsecs < 0)
4393 /* A negative timeout means
4394 gobble output available now
4395 but don't wait at all. */
4397 timeout = make_emacs_time (0, 0);
4399 else if (time_limit || 0 < nsecs)
4401 EMACS_TIME now = current_emacs_time ();
4402 if (EMACS_TIME_LE (end_time, now))
4403 break;
4404 timeout = sub_emacs_time (end_time, now);
4406 else
4408 timeout = make_emacs_time (100000, 0);
4411 /* Normally we run timers here.
4412 But not if wait_for_cell; in those cases,
4413 the wait is supposed to be short,
4414 and those callers cannot handle running arbitrary Lisp code here. */
4415 if (NILP (wait_for_cell)
4416 && just_wait_proc >= 0)
4418 EMACS_TIME timer_delay;
4422 int old_timers_run = timers_run;
4423 struct buffer *old_buffer = current_buffer;
4424 Lisp_Object old_window = selected_window;
4426 timer_delay = timer_check ();
4428 /* If a timer has run, this might have changed buffers
4429 an alike. Make read_key_sequence aware of that. */
4430 if (timers_run != old_timers_run
4431 && (old_buffer != current_buffer
4432 || !EQ (old_window, selected_window))
4433 && waiting_for_user_input_p == -1)
4434 record_asynch_buffer_change ();
4436 if (timers_run != old_timers_run && do_display)
4437 /* We must retry, since a timer may have requeued itself
4438 and that could alter the time_delay. */
4439 redisplay_preserve_echo_area (9);
4440 else
4441 break;
4443 while (!detect_input_pending ());
4445 /* If there is unread keyboard input, also return. */
4446 if (read_kbd != 0
4447 && requeued_events_pending_p ())
4448 break;
4450 /* A negative timeout means do not wait at all. */
4451 if (0 <= nsecs)
4453 if (EMACS_TIME_VALID_P (timer_delay))
4455 if (EMACS_TIME_LT (timer_delay, timeout))
4457 timeout = timer_delay;
4458 timeout_reduced_for_timers = 1;
4461 else
4463 /* This is so a breakpoint can be put here. */
4464 wait_reading_process_output_1 ();
4469 /* Cause C-g and alarm signals to take immediate action,
4470 and cause input available signals to zero out timeout.
4472 It is important that we do this before checking for process
4473 activity. If we get a SIGCHLD after the explicit checks for
4474 process activity, timeout is the only way we will know. */
4475 if (read_kbd < 0)
4476 set_waiting_for_input (&timeout);
4478 /* If status of something has changed, and no input is
4479 available, notify the user of the change right away. After
4480 this explicit check, we'll let the SIGCHLD handler zap
4481 timeout to get our attention. */
4482 if (update_tick != process_tick)
4484 SELECT_TYPE Atemp;
4485 SELECT_TYPE Ctemp;
4487 if (kbd_on_hold_p ())
4488 FD_ZERO (&Atemp);
4489 else
4490 Atemp = input_wait_mask;
4491 Ctemp = write_mask;
4493 timeout = make_emacs_time (0, 0);
4494 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4495 &Atemp,
4496 #ifdef NON_BLOCKING_CONNECT
4497 (num_pending_connects > 0 ? &Ctemp : NULL),
4498 #else
4499 NULL,
4500 #endif
4501 NULL, &timeout, NULL)
4502 <= 0))
4504 /* It's okay for us to do this and then continue with
4505 the loop, since timeout has already been zeroed out. */
4506 clear_waiting_for_input ();
4507 status_notify (NULL);
4508 if (do_display) redisplay_preserve_echo_area (13);
4512 /* Don't wait for output from a non-running process. Just
4513 read whatever data has already been received. */
4514 if (wait_proc && wait_proc->raw_status_new)
4515 update_status (wait_proc);
4516 if (wait_proc
4517 && ! EQ (wait_proc->status, Qrun)
4518 && ! EQ (wait_proc->status, Qconnect))
4520 int nread, total_nread = 0;
4522 clear_waiting_for_input ();
4523 XSETPROCESS (proc, wait_proc);
4525 /* Read data from the process, until we exhaust it. */
4526 while (wait_proc->infd >= 0)
4528 nread = read_process_output (proc, wait_proc->infd);
4530 if (nread == 0)
4531 break;
4533 if (0 < nread)
4535 total_nread += nread;
4536 got_some_input = 1;
4538 #ifdef EIO
4539 else if (nread == -1 && EIO == errno)
4540 break;
4541 #endif
4542 #ifdef EAGAIN
4543 else if (nread == -1 && EAGAIN == errno)
4544 break;
4545 #endif
4546 #ifdef EWOULDBLOCK
4547 else if (nread == -1 && EWOULDBLOCK == errno)
4548 break;
4549 #endif
4551 if (total_nread > 0 && do_display)
4552 redisplay_preserve_echo_area (10);
4554 break;
4557 /* Wait till there is something to do */
4559 if (wait_proc && just_wait_proc)
4561 if (wait_proc->infd < 0) /* Terminated */
4562 break;
4563 FD_SET (wait_proc->infd, &Available);
4564 check_delay = 0;
4565 check_write = 0;
4567 else if (!NILP (wait_for_cell))
4569 Available = non_process_wait_mask;
4570 check_delay = 0;
4571 check_write = 0;
4573 else
4575 if (! read_kbd)
4576 Available = non_keyboard_wait_mask;
4577 else
4578 Available = input_wait_mask;
4579 Writeok = write_mask;
4580 #ifdef SELECT_CANT_DO_WRITE_MASK
4581 check_write = 0;
4582 #else
4583 check_write = 1;
4584 #endif
4585 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4588 /* If frame size has changed or the window is newly mapped,
4589 redisplay now, before we start to wait. There is a race
4590 condition here; if a SIGIO arrives between now and the select
4591 and indicates that a frame is trashed, the select may block
4592 displaying a trashed screen. */
4593 if (frame_garbaged && do_display)
4595 clear_waiting_for_input ();
4596 redisplay_preserve_echo_area (11);
4597 if (read_kbd < 0)
4598 set_waiting_for_input (&timeout);
4601 /* Skip the `select' call if input is available and we're
4602 waiting for keyboard input or a cell change (which can be
4603 triggered by processing X events). In the latter case, set
4604 nfds to 1 to avoid breaking the loop. */
4605 no_avail = 0;
4606 if ((read_kbd || !NILP (wait_for_cell))
4607 && detect_input_pending ())
4609 nfds = read_kbd ? 0 : 1;
4610 no_avail = 1;
4613 if (!no_avail)
4616 #ifdef ADAPTIVE_READ_BUFFERING
4617 /* Set the timeout for adaptive read buffering if any
4618 process has non-zero read_output_skip and non-zero
4619 read_output_delay, and we are not reading output for a
4620 specific wait_channel. It is not executed if
4621 Vprocess_adaptive_read_buffering is nil. */
4622 if (process_output_skip && check_delay > 0)
4624 int nsecs = EMACS_NSECS (timeout);
4625 if (EMACS_SECS (timeout) > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4626 nsecs = READ_OUTPUT_DELAY_MAX;
4627 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4629 proc = chan_process[channel];
4630 if (NILP (proc))
4631 continue;
4632 /* Find minimum non-zero read_output_delay among the
4633 processes with non-zero read_output_skip. */
4634 if (XPROCESS (proc)->read_output_delay > 0)
4636 check_delay--;
4637 if (!XPROCESS (proc)->read_output_skip)
4638 continue;
4639 FD_CLR (channel, &Available);
4640 XPROCESS (proc)->read_output_skip = 0;
4641 if (XPROCESS (proc)->read_output_delay < nsecs)
4642 nsecs = XPROCESS (proc)->read_output_delay;
4645 timeout = make_emacs_time (0, nsecs);
4646 process_output_skip = 0;
4648 #endif
4649 #if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
4650 nfds = xg_select
4651 #elif defined (HAVE_NS)
4652 nfds = ns_select
4653 #else
4654 nfds = pselect
4655 #endif
4656 (max (max_process_desc, max_input_desc) + 1,
4657 &Available,
4658 (check_write ? &Writeok : (SELECT_TYPE *)0),
4659 NULL, &timeout, NULL);
4661 #ifdef HAVE_GNUTLS
4662 /* GnuTLS buffers data internally. In lowat mode it leaves
4663 some data in the TCP buffers so that select works, but
4664 with custom pull/push functions we need to check if some
4665 data is available in the buffers manually. */
4666 if (nfds == 0)
4668 if (! wait_proc)
4670 /* We're not waiting on a specific process, so loop
4671 through all the channels and check for data.
4672 This is a workaround needed for some versions of
4673 the gnutls library -- 2.12.14 has been confirmed
4674 to need it. See
4675 http://comments.gmane.org/gmane.emacs.devel/145074 */
4676 for (channel = 0; channel < MAXDESC; ++channel)
4677 if (! NILP (chan_process[channel]))
4679 struct Lisp_Process *p =
4680 XPROCESS (chan_process[channel]);
4681 if (p && p->gnutls_p && p->infd
4682 && ((emacs_gnutls_record_check_pending
4683 (p->gnutls_state))
4684 > 0))
4686 nfds++;
4687 FD_SET (p->infd, &Available);
4691 else
4693 /* Check this specific channel. */
4694 if (wait_proc->gnutls_p /* Check for valid process. */
4695 /* Do we have pending data? */
4696 && ((emacs_gnutls_record_check_pending
4697 (wait_proc->gnutls_state))
4698 > 0))
4700 nfds = 1;
4701 /* Set to Available. */
4702 FD_SET (wait_proc->infd, &Available);
4706 #endif
4709 xerrno = errno;
4711 /* Make C-g and alarm signals set flags again */
4712 clear_waiting_for_input ();
4714 /* If we woke up due to SIGWINCH, actually change size now. */
4715 do_pending_window_change (0);
4717 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4718 /* We waited the full specified time, so return now. */
4719 break;
4720 if (nfds < 0)
4722 if (xerrno == EINTR)
4723 no_avail = 1;
4724 else if (xerrno == EBADF)
4726 #ifdef AIX
4727 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
4728 the child's closure of the pts gives the parent a SIGHUP, and
4729 the ptc file descriptor is automatically closed,
4730 yielding EBADF here or at select() call above.
4731 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
4732 in m/ibmrt-aix.h), and here we just ignore the select error.
4733 Cleanup occurs c/o status_notify after SIGCLD. */
4734 no_avail = 1; /* Cannot depend on values returned */
4735 #else
4736 emacs_abort ();
4737 #endif
4739 else
4740 error ("select error: %s", emacs_strerror (xerrno));
4743 if (no_avail)
4745 FD_ZERO (&Available);
4746 check_write = 0;
4749 /* Check for keyboard input */
4750 /* If there is any, return immediately
4751 to give it higher priority than subprocesses */
4753 if (read_kbd != 0)
4755 int old_timers_run = timers_run;
4756 struct buffer *old_buffer = current_buffer;
4757 Lisp_Object old_window = selected_window;
4758 int leave = 0;
4760 if (detect_input_pending_run_timers (do_display))
4762 swallow_events (do_display);
4763 if (detect_input_pending_run_timers (do_display))
4764 leave = 1;
4767 /* If a timer has run, this might have changed buffers
4768 an alike. Make read_key_sequence aware of that. */
4769 if (timers_run != old_timers_run
4770 && waiting_for_user_input_p == -1
4771 && (old_buffer != current_buffer
4772 || !EQ (old_window, selected_window)))
4773 record_asynch_buffer_change ();
4775 if (leave)
4776 break;
4779 /* If there is unread keyboard input, also return. */
4780 if (read_kbd != 0
4781 && requeued_events_pending_p ())
4782 break;
4784 /* If we are not checking for keyboard input now,
4785 do process events (but don't run any timers).
4786 This is so that X events will be processed.
4787 Otherwise they may have to wait until polling takes place.
4788 That would causes delays in pasting selections, for example.
4790 (We used to do this only if wait_for_cell.) */
4791 if (read_kbd == 0 && detect_input_pending ())
4793 swallow_events (do_display);
4794 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4795 if (detect_input_pending ())
4796 break;
4797 #endif
4800 /* Exit now if the cell we're waiting for became non-nil. */
4801 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4802 break;
4804 #ifdef USABLE_SIGIO
4805 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4806 go read it. This can happen with X on BSD after logging out.
4807 In that case, there really is no input and no SIGIO,
4808 but select says there is input. */
4810 if (read_kbd && interrupt_input
4811 && keyboard_bit_set (&Available) && ! noninteractive)
4812 handle_input_available_signal (SIGIO);
4813 #endif
4815 if (! wait_proc)
4816 got_some_input |= nfds > 0;
4818 /* If checking input just got us a size-change event from X,
4819 obey it now if we should. */
4820 if (read_kbd || ! NILP (wait_for_cell))
4821 do_pending_window_change (0);
4823 /* Check for data from a process. */
4824 if (no_avail || nfds == 0)
4825 continue;
4827 for (channel = 0; channel <= max_input_desc; ++channel)
4829 struct fd_callback_data *d = &fd_callback_info[channel];
4830 if (d->func
4831 && ((d->condition & FOR_READ
4832 && FD_ISSET (channel, &Available))
4833 || (d->condition & FOR_WRITE
4834 && FD_ISSET (channel, &write_mask))))
4835 d->func (channel, d->data);
4838 for (channel = 0; channel <= max_process_desc; channel++)
4840 if (FD_ISSET (channel, &Available)
4841 && FD_ISSET (channel, &non_keyboard_wait_mask)
4842 && !FD_ISSET (channel, &non_process_wait_mask))
4844 int nread;
4846 /* If waiting for this channel, arrange to return as
4847 soon as no more input to be processed. No more
4848 waiting. */
4849 if (wait_channel == channel)
4851 wait_channel = -1;
4852 nsecs = -1;
4853 got_some_input = 1;
4855 proc = chan_process[channel];
4856 if (NILP (proc))
4857 continue;
4859 /* If this is a server stream socket, accept connection. */
4860 if (EQ (XPROCESS (proc)->status, Qlisten))
4862 server_accept_connection (proc, channel);
4863 continue;
4866 /* Read data from the process, starting with our
4867 buffered-ahead character if we have one. */
4869 nread = read_process_output (proc, channel);
4870 if (nread > 0)
4872 /* Since read_process_output can run a filter,
4873 which can call accept-process-output,
4874 don't try to read from any other processes
4875 before doing the select again. */
4876 FD_ZERO (&Available);
4878 if (do_display)
4879 redisplay_preserve_echo_area (12);
4881 #ifdef EWOULDBLOCK
4882 else if (nread == -1 && errno == EWOULDBLOCK)
4884 #endif
4885 /* ISC 4.1 defines both EWOULDBLOCK and O_NONBLOCK,
4886 and Emacs uses O_NONBLOCK, so what we get is EAGAIN. */
4887 #ifdef O_NONBLOCK
4888 else if (nread == -1 && errno == EAGAIN)
4890 #else
4891 #ifdef O_NDELAY
4892 else if (nread == -1 && errno == EAGAIN)
4894 /* Note that we cannot distinguish between no input
4895 available now and a closed pipe.
4896 With luck, a closed pipe will be accompanied by
4897 subprocess termination and SIGCHLD. */
4898 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4900 #endif /* O_NDELAY */
4901 #endif /* O_NONBLOCK */
4902 #ifdef HAVE_PTYS
4903 /* On some OSs with ptys, when the process on one end of
4904 a pty exits, the other end gets an error reading with
4905 errno = EIO instead of getting an EOF (0 bytes read).
4906 Therefore, if we get an error reading and errno =
4907 EIO, just continue, because the child process has
4908 exited and should clean itself up soon (e.g. when we
4909 get a SIGCHLD).
4911 However, it has been known to happen that the SIGCHLD
4912 got lost. So raise the signal again just in case.
4913 It can't hurt. */
4914 else if (nread == -1 && errno == EIO)
4916 struct Lisp_Process *p = XPROCESS (proc);
4918 /* Clear the descriptor now, so we only raise the
4919 signal once. */
4920 FD_CLR (channel, &input_wait_mask);
4921 FD_CLR (channel, &non_keyboard_wait_mask);
4923 if (p->pid == -2)
4925 /* If the EIO occurs on a pty, the SIGCHLD handler's
4926 waitpid call will not find the process object to
4927 delete. Do it here. */
4928 p->tick = ++process_tick;
4929 pset_status (p, Qfailed);
4931 else
4932 handle_child_signal (SIGCHLD);
4934 #endif /* HAVE_PTYS */
4935 /* If we can detect process termination, don't consider the
4936 process gone just because its pipe is closed. */
4937 #ifdef SIGCHLD
4938 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4940 #endif
4941 else
4943 /* Preserve status of processes already terminated. */
4944 XPROCESS (proc)->tick = ++process_tick;
4945 deactivate_process (proc);
4946 if (XPROCESS (proc)->raw_status_new)
4947 update_status (XPROCESS (proc));
4948 if (EQ (XPROCESS (proc)->status, Qrun))
4949 pset_status (XPROCESS (proc),
4950 list2 (Qexit, make_number (256)));
4953 #ifdef NON_BLOCKING_CONNECT
4954 if (FD_ISSET (channel, &Writeok)
4955 && FD_ISSET (channel, &connect_wait_mask))
4957 struct Lisp_Process *p;
4959 FD_CLR (channel, &connect_wait_mask);
4960 FD_CLR (channel, &write_mask);
4961 if (--num_pending_connects < 0)
4962 emacs_abort ();
4964 proc = chan_process[channel];
4965 if (NILP (proc))
4966 continue;
4968 p = XPROCESS (proc);
4970 #ifdef GNU_LINUX
4971 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4972 So only use it on systems where it is known to work. */
4974 socklen_t xlen = sizeof (xerrno);
4975 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4976 xerrno = errno;
4978 #else
4980 struct sockaddr pname;
4981 int pnamelen = sizeof (pname);
4983 /* If connection failed, getpeername will fail. */
4984 xerrno = 0;
4985 if (getpeername (channel, &pname, &pnamelen) < 0)
4987 /* Obtain connect failure code through error slippage. */
4988 char dummy;
4989 xerrno = errno;
4990 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4991 xerrno = errno;
4994 #endif
4995 if (xerrno)
4997 p->tick = ++process_tick;
4998 pset_status (p, list2 (Qfailed, make_number (xerrno)));
4999 deactivate_process (proc);
5001 else
5003 pset_status (p, Qrun);
5004 /* Execute the sentinel here. If we had relied on
5005 status_notify to do it later, it will read input
5006 from the process before calling the sentinel. */
5007 exec_sentinel (proc, build_string ("open\n"));
5008 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
5010 FD_SET (p->infd, &input_wait_mask);
5011 FD_SET (p->infd, &non_keyboard_wait_mask);
5015 #endif /* NON_BLOCKING_CONNECT */
5016 } /* end for each file descriptor */
5017 } /* end while exit conditions not met */
5019 unbind_to (count, Qnil);
5021 /* If calling from keyboard input, do not quit
5022 since we want to return C-g as an input character.
5023 Otherwise, do pending quit if requested. */
5024 if (read_kbd >= 0)
5026 /* Prevent input_pending from remaining set if we quit. */
5027 clear_input_pending ();
5028 QUIT;
5031 return got_some_input;
5034 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
5036 static Lisp_Object
5037 read_process_output_call (Lisp_Object fun_and_args)
5039 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
5042 static Lisp_Object
5043 read_process_output_error_handler (Lisp_Object error_val)
5045 cmd_error_internal (error_val, "error in process filter: ");
5046 Vinhibit_quit = Qt;
5047 update_echo_area ();
5048 Fsleep_for (make_number (2), Qnil);
5049 return Qt;
5052 /* Read pending output from the process channel,
5053 starting with our buffered-ahead character if we have one.
5054 Yield number of decoded characters read.
5056 This function reads at most 4096 characters.
5057 If you want to read all available subprocess output,
5058 you must call it repeatedly until it returns zero.
5060 The characters read are decoded according to PROC's coding-system
5061 for decoding. */
5063 static int
5064 read_process_output (Lisp_Object proc, register int channel)
5066 register ssize_t nbytes;
5067 char *chars;
5068 register Lisp_Object outstream;
5069 register struct Lisp_Process *p = XPROCESS (proc);
5070 register ptrdiff_t opoint;
5071 struct coding_system *coding = proc_decode_coding_system[channel];
5072 int carryover = p->decoding_carryover;
5073 int readmax = 4096;
5074 ptrdiff_t count = SPECPDL_INDEX ();
5075 Lisp_Object odeactivate;
5077 chars = alloca (carryover + readmax);
5078 if (carryover)
5079 /* See the comment above. */
5080 memcpy (chars, SDATA (p->decoding_buf), carryover);
5082 #ifdef DATAGRAM_SOCKETS
5083 /* We have a working select, so proc_buffered_char is always -1. */
5084 if (DATAGRAM_CHAN_P (channel))
5086 socklen_t len = datagram_address[channel].len;
5087 nbytes = recvfrom (channel, chars + carryover, readmax,
5088 0, datagram_address[channel].sa, &len);
5090 else
5091 #endif
5093 int buffered = 0 <= proc_buffered_char[channel];
5094 if (buffered)
5096 chars[carryover] = proc_buffered_char[channel];
5097 proc_buffered_char[channel] = -1;
5099 #ifdef HAVE_GNUTLS
5100 if (p->gnutls_p)
5101 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
5102 readmax - buffered);
5103 else
5104 #endif
5105 nbytes = emacs_read (channel, chars + carryover + buffered,
5106 readmax - buffered);
5107 #ifdef ADAPTIVE_READ_BUFFERING
5108 if (nbytes > 0 && p->adaptive_read_buffering)
5110 int delay = p->read_output_delay;
5111 if (nbytes < 256)
5113 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5115 if (delay == 0)
5116 process_output_delay_count++;
5117 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5120 else if (delay > 0 && nbytes == readmax - buffered)
5122 delay -= READ_OUTPUT_DELAY_INCREMENT;
5123 if (delay == 0)
5124 process_output_delay_count--;
5126 p->read_output_delay = delay;
5127 if (delay)
5129 p->read_output_skip = 1;
5130 process_output_skip = 1;
5133 #endif
5134 nbytes += buffered;
5135 nbytes += buffered && nbytes <= 0;
5138 p->decoding_carryover = 0;
5140 /* At this point, NBYTES holds number of bytes just received
5141 (including the one in proc_buffered_char[channel]). */
5142 if (nbytes <= 0)
5144 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5145 return nbytes;
5146 coding->mode |= CODING_MODE_LAST_BLOCK;
5149 /* Now set NBYTES how many bytes we must decode. */
5150 nbytes += carryover;
5152 odeactivate = Vdeactivate_mark;
5153 /* There's no good reason to let process filters change the current
5154 buffer, and many callers of accept-process-output, sit-for, and
5155 friends don't expect current-buffer to be changed from under them. */
5156 record_unwind_current_buffer ();
5158 /* Read and dispose of the process output. */
5159 outstream = p->filter;
5160 if (!NILP (outstream))
5162 Lisp_Object text;
5163 bool outer_running_asynch_code = running_asynch_code;
5164 int waiting = waiting_for_user_input_p;
5166 /* No need to gcpro these, because all we do with them later
5167 is test them for EQness, and none of them should be a string. */
5168 #if 0
5169 Lisp_Object obuffer, okeymap;
5170 XSETBUFFER (obuffer, current_buffer);
5171 okeymap = BVAR (current_buffer, keymap);
5172 #endif
5174 /* We inhibit quit here instead of just catching it so that
5175 hitting ^G when a filter happens to be running won't screw
5176 it up. */
5177 specbind (Qinhibit_quit, Qt);
5178 specbind (Qlast_nonmenu_event, Qt);
5180 /* In case we get recursively called,
5181 and we already saved the match data nonrecursively,
5182 save the same match data in safely recursive fashion. */
5183 if (outer_running_asynch_code)
5185 Lisp_Object tem;
5186 /* Don't clobber the CURRENT match data, either! */
5187 tem = Fmatch_data (Qnil, Qnil, Qnil);
5188 restore_search_regs ();
5189 record_unwind_save_match_data ();
5190 Fset_match_data (tem, Qt);
5193 /* For speed, if a search happens within this code,
5194 save the match data in a special nonrecursive fashion. */
5195 running_asynch_code = 1;
5197 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5198 text = coding->dst_object;
5199 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5200 /* A new coding system might be found. */
5201 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5203 pset_decode_coding_system (p, Vlast_coding_system_used);
5205 /* Don't call setup_coding_system for
5206 proc_decode_coding_system[channel] here. It is done in
5207 detect_coding called via decode_coding above. */
5209 /* If a coding system for encoding is not yet decided, we set
5210 it as the same as coding-system for decoding.
5212 But, before doing that we must check if
5213 proc_encode_coding_system[p->outfd] surely points to a
5214 valid memory because p->outfd will be changed once EOF is
5215 sent to the process. */
5216 if (NILP (p->encode_coding_system)
5217 && proc_encode_coding_system[p->outfd])
5219 pset_encode_coding_system
5220 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5221 setup_coding_system (p->encode_coding_system,
5222 proc_encode_coding_system[p->outfd]);
5226 if (coding->carryover_bytes > 0)
5228 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5229 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5230 memcpy (SDATA (p->decoding_buf), coding->carryover,
5231 coding->carryover_bytes);
5232 p->decoding_carryover = coding->carryover_bytes;
5234 if (SBYTES (text) > 0)
5235 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5236 sometimes it's simply wrong to wrap (e.g. when called from
5237 accept-process-output). */
5238 internal_condition_case_1 (read_process_output_call,
5239 Fcons (outstream,
5240 Fcons (proc, Fcons (text, Qnil))),
5241 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5242 read_process_output_error_handler);
5244 /* If we saved the match data nonrecursively, restore it now. */
5245 restore_search_regs ();
5246 running_asynch_code = outer_running_asynch_code;
5248 /* Restore waiting_for_user_input_p as it was
5249 when we were called, in case the filter clobbered it. */
5250 waiting_for_user_input_p = waiting;
5252 #if 0 /* Call record_asynch_buffer_change unconditionally,
5253 because we might have changed minor modes or other things
5254 that affect key bindings. */
5255 if (! EQ (Fcurrent_buffer (), obuffer)
5256 || ! EQ (current_buffer->keymap, okeymap))
5257 #endif
5258 /* But do it only if the caller is actually going to read events.
5259 Otherwise there's no need to make him wake up, and it could
5260 cause trouble (for example it would make sit_for return). */
5261 if (waiting_for_user_input_p == -1)
5262 record_asynch_buffer_change ();
5265 /* If no filter, write into buffer if it isn't dead. */
5266 else if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5268 Lisp_Object old_read_only;
5269 ptrdiff_t old_begv, old_zv;
5270 ptrdiff_t old_begv_byte, old_zv_byte;
5271 ptrdiff_t before, before_byte;
5272 ptrdiff_t opoint_byte;
5273 Lisp_Object text;
5274 struct buffer *b;
5276 Fset_buffer (p->buffer);
5277 opoint = PT;
5278 opoint_byte = PT_BYTE;
5279 old_read_only = BVAR (current_buffer, read_only);
5280 old_begv = BEGV;
5281 old_zv = ZV;
5282 old_begv_byte = BEGV_BYTE;
5283 old_zv_byte = ZV_BYTE;
5285 bset_read_only (current_buffer, Qnil);
5287 /* Insert new output into buffer
5288 at the current end-of-output marker,
5289 thus preserving logical ordering of input and output. */
5290 if (XMARKER (p->mark)->buffer)
5291 SET_PT_BOTH (clip_to_bounds (BEGV,
5292 marker_position (p->mark), ZV),
5293 clip_to_bounds (BEGV_BYTE,
5294 marker_byte_position (p->mark),
5295 ZV_BYTE));
5296 else
5297 SET_PT_BOTH (ZV, ZV_BYTE);
5298 before = PT;
5299 before_byte = PT_BYTE;
5301 /* If the output marker is outside of the visible region, save
5302 the restriction and widen. */
5303 if (! (BEGV <= PT && PT <= ZV))
5304 Fwiden ();
5306 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5307 text = coding->dst_object;
5308 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5309 /* A new coding system might be found. See the comment in the
5310 similar code in the previous `if' block. */
5311 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5313 pset_decode_coding_system (p, Vlast_coding_system_used);
5314 if (NILP (p->encode_coding_system)
5315 && proc_encode_coding_system[p->outfd])
5317 pset_encode_coding_system
5318 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5319 setup_coding_system (p->encode_coding_system,
5320 proc_encode_coding_system[p->outfd]);
5323 if (coding->carryover_bytes > 0)
5325 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5326 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5327 memcpy (SDATA (p->decoding_buf), coding->carryover,
5328 coding->carryover_bytes);
5329 p->decoding_carryover = coding->carryover_bytes;
5331 /* Adjust the multibyteness of TEXT to that of the buffer. */
5332 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5333 != ! STRING_MULTIBYTE (text))
5334 text = (STRING_MULTIBYTE (text)
5335 ? Fstring_as_unibyte (text)
5336 : Fstring_to_multibyte (text));
5337 /* Insert before markers in case we are inserting where
5338 the buffer's mark is, and the user's next command is Meta-y. */
5339 insert_from_string_before_markers (text, 0, 0,
5340 SCHARS (text), SBYTES (text), 0);
5342 /* Make sure the process marker's position is valid when the
5343 process buffer is changed in the signal_after_change above.
5344 W3 is known to do that. */
5345 if (BUFFERP (p->buffer)
5346 && (b = XBUFFER (p->buffer), b != current_buffer))
5347 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5348 else
5349 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5351 update_mode_lines++;
5353 /* Make sure opoint and the old restrictions
5354 float ahead of any new text just as point would. */
5355 if (opoint >= before)
5357 opoint += PT - before;
5358 opoint_byte += PT_BYTE - before_byte;
5360 if (old_begv > before)
5362 old_begv += PT - before;
5363 old_begv_byte += PT_BYTE - before_byte;
5365 if (old_zv >= before)
5367 old_zv += PT - before;
5368 old_zv_byte += PT_BYTE - before_byte;
5371 /* If the restriction isn't what it should be, set it. */
5372 if (old_begv != BEGV || old_zv != ZV)
5373 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5376 bset_read_only (current_buffer, old_read_only);
5377 SET_PT_BOTH (opoint, opoint_byte);
5379 /* Handling the process output should not deactivate the mark. */
5380 Vdeactivate_mark = odeactivate;
5382 unbind_to (count, Qnil);
5383 return nbytes;
5386 /* Sending data to subprocess */
5388 /* In send_process, when a write fails temporarily,
5389 wait_reading_process_output is called. It may execute user code,
5390 e.g. timers, that attempts to write new data to the same process.
5391 We must ensure that data is sent in the right order, and not
5392 interspersed half-completed with other writes (Bug#10815). This is
5393 handled by the write_queue element of struct process. It is a list
5394 with each entry having the form
5396 (string . (offset . length))
5398 where STRING is a lisp string, OFFSET is the offset into the
5399 string's byte sequence from which we should begin to send, and
5400 LENGTH is the number of bytes left to send. */
5402 /* Create a new entry in write_queue.
5403 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5404 BUF is a pointer to the string sequence of the input_obj or a C
5405 string in case of Qt or Qnil. */
5407 static void
5408 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5409 const char *buf, ptrdiff_t len, int front)
5411 ptrdiff_t offset;
5412 Lisp_Object entry, obj;
5414 if (STRINGP (input_obj))
5416 offset = buf - SSDATA (input_obj);
5417 obj = input_obj;
5419 else
5421 offset = 0;
5422 obj = make_unibyte_string (buf, len);
5425 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5427 if (front)
5428 pset_write_queue (p, Fcons (entry, p->write_queue));
5429 else
5430 pset_write_queue (p, nconc2 (p->write_queue, Fcons (entry, Qnil)));
5433 /* Remove the first element in the write_queue of process P, put its
5434 contents in OBJ, BUF and LEN, and return non-zero. If the
5435 write_queue is empty, return zero. */
5437 static int
5438 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5439 const char **buf, ptrdiff_t *len)
5441 Lisp_Object entry, offset_length;
5442 ptrdiff_t offset;
5444 if (NILP (p->write_queue))
5445 return 0;
5447 entry = XCAR (p->write_queue);
5448 pset_write_queue (p, XCDR (p->write_queue));
5450 *obj = XCAR (entry);
5451 offset_length = XCDR (entry);
5453 *len = XINT (XCDR (offset_length));
5454 offset = XINT (XCAR (offset_length));
5455 *buf = SSDATA (*obj) + offset;
5457 return 1;
5460 /* Send some data to process PROC.
5461 BUF is the beginning of the data; LEN is the number of characters.
5462 OBJECT is the Lisp object that the data comes from. If OBJECT is
5463 nil or t, it means that the data comes from C string.
5465 If OBJECT is not nil, the data is encoded by PROC's coding-system
5466 for encoding before it is sent.
5468 This function can evaluate Lisp code and can garbage collect. */
5470 static void
5471 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
5472 Lisp_Object object)
5474 struct Lisp_Process *p = XPROCESS (proc);
5475 ssize_t rv;
5476 struct coding_system *coding;
5478 if (p->raw_status_new)
5479 update_status (p);
5480 if (! EQ (p->status, Qrun))
5481 error ("Process %s not running", SDATA (p->name));
5482 if (p->outfd < 0)
5483 error ("Output file descriptor of %s is closed", SDATA (p->name));
5485 coding = proc_encode_coding_system[p->outfd];
5486 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5488 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5489 || (BUFFERP (object)
5490 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5491 || EQ (object, Qt))
5493 pset_encode_coding_system
5494 (p, complement_process_encoding_system (p->encode_coding_system));
5495 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5497 /* The coding system for encoding was changed to raw-text
5498 because we sent a unibyte text previously. Now we are
5499 sending a multibyte text, thus we must encode it by the
5500 original coding system specified for the current process.
5502 Another reason we come here is that the coding system
5503 was just complemented and a new one was returned by
5504 complement_process_encoding_system. */
5505 setup_coding_system (p->encode_coding_system, coding);
5506 Vlast_coding_system_used = p->encode_coding_system;
5508 coding->src_multibyte = 1;
5510 else
5512 coding->src_multibyte = 0;
5513 /* For sending a unibyte text, character code conversion should
5514 not take place but EOL conversion should. So, setup raw-text
5515 or one of the subsidiary if we have not yet done it. */
5516 if (CODING_REQUIRE_ENCODING (coding))
5518 if (CODING_REQUIRE_FLUSHING (coding))
5520 /* But, before changing the coding, we must flush out data. */
5521 coding->mode |= CODING_MODE_LAST_BLOCK;
5522 send_process (proc, "", 0, Qt);
5523 coding->mode &= CODING_MODE_LAST_BLOCK;
5525 setup_coding_system (raw_text_coding_system
5526 (Vlast_coding_system_used),
5527 coding);
5528 coding->src_multibyte = 0;
5531 coding->dst_multibyte = 0;
5533 if (CODING_REQUIRE_ENCODING (coding))
5535 coding->dst_object = Qt;
5536 if (BUFFERP (object))
5538 ptrdiff_t from_byte, from, to;
5539 ptrdiff_t save_pt, save_pt_byte;
5540 struct buffer *cur = current_buffer;
5542 set_buffer_internal (XBUFFER (object));
5543 save_pt = PT, save_pt_byte = PT_BYTE;
5545 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5546 from = BYTE_TO_CHAR (from_byte);
5547 to = BYTE_TO_CHAR (from_byte + len);
5548 TEMP_SET_PT_BOTH (from, from_byte);
5549 encode_coding_object (coding, object, from, from_byte,
5550 to, from_byte + len, Qt);
5551 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5552 set_buffer_internal (cur);
5554 else if (STRINGP (object))
5556 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5557 SBYTES (object), Qt);
5559 else
5561 coding->dst_object = make_unibyte_string (buf, len);
5562 coding->produced = len;
5565 len = coding->produced;
5566 object = coding->dst_object;
5567 buf = SSDATA (object);
5570 if (pty_max_bytes == 0)
5572 #if defined (HAVE_FPATHCONF) && defined (_PC_MAX_CANON)
5573 pty_max_bytes = fpathconf (p->outfd, _PC_MAX_CANON);
5574 if (pty_max_bytes < 0)
5575 pty_max_bytes = 250;
5576 #else
5577 pty_max_bytes = 250;
5578 #endif
5579 /* Deduct one, to leave space for the eof. */
5580 pty_max_bytes--;
5583 /* If there is already data in the write_queue, put the new data
5584 in the back of queue. Otherwise, ignore it. */
5585 if (!NILP (p->write_queue))
5586 write_queue_push (p, object, buf, len, 0);
5588 do /* while !NILP (p->write_queue) */
5590 ptrdiff_t cur_len = -1;
5591 const char *cur_buf;
5592 Lisp_Object cur_object;
5594 /* If write_queue is empty, ignore it. */
5595 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5597 cur_len = len;
5598 cur_buf = buf;
5599 cur_object = object;
5602 while (cur_len > 0)
5604 /* Send this batch, using one or more write calls. */
5605 ptrdiff_t written = 0;
5606 int outfd = p->outfd;
5607 #ifdef DATAGRAM_SOCKETS
5608 if (DATAGRAM_CHAN_P (outfd))
5610 rv = sendto (outfd, cur_buf, cur_len,
5611 0, datagram_address[outfd].sa,
5612 datagram_address[outfd].len);
5613 if (0 <= rv)
5614 written = rv;
5615 else if (errno == EMSGSIZE)
5616 report_file_error ("sending datagram", Fcons (proc, Qnil));
5618 else
5619 #endif
5621 #ifdef HAVE_GNUTLS
5622 if (p->gnutls_p)
5623 written = emacs_gnutls_write (p, cur_buf, cur_len);
5624 else
5625 #endif
5626 written = emacs_write (outfd, cur_buf, cur_len);
5627 rv = (written ? 0 : -1);
5628 #ifdef ADAPTIVE_READ_BUFFERING
5629 if (p->read_output_delay > 0
5630 && p->adaptive_read_buffering == 1)
5632 p->read_output_delay = 0;
5633 process_output_delay_count--;
5634 p->read_output_skip = 0;
5636 #endif
5639 if (rv < 0)
5641 if (0
5642 #ifdef EWOULDBLOCK
5643 || errno == EWOULDBLOCK
5644 #endif
5645 #ifdef EAGAIN
5646 || errno == EAGAIN
5647 #endif
5649 /* Buffer is full. Wait, accepting input;
5650 that may allow the program
5651 to finish doing output and read more. */
5653 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5654 /* A gross hack to work around a bug in FreeBSD.
5655 In the following sequence, read(2) returns
5656 bogus data:
5658 write(2) 1022 bytes
5659 write(2) 954 bytes, get EAGAIN
5660 read(2) 1024 bytes in process_read_output
5661 read(2) 11 bytes in process_read_output
5663 That is, read(2) returns more bytes than have
5664 ever been written successfully. The 1033 bytes
5665 read are the 1022 bytes written successfully
5666 after processing (for example with CRs added if
5667 the terminal is set up that way which it is
5668 here). The same bytes will be seen again in a
5669 later read(2), without the CRs. */
5671 if (errno == EAGAIN)
5673 int flags = FWRITE;
5674 ioctl (p->outfd, TIOCFLUSH, &flags);
5676 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5678 /* Put what we should have written in wait_queue. */
5679 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5680 wait_reading_process_output (0, 20 * 1000 * 1000,
5681 0, 0, Qnil, NULL, 0);
5682 /* Reread queue, to see what is left. */
5683 break;
5685 else if (errno == EPIPE)
5687 p->raw_status_new = 0;
5688 pset_status (p, list2 (Qexit, make_number (256)));
5689 p->tick = ++process_tick;
5690 deactivate_process (proc);
5691 error ("process %s no longer connected to pipe; closed it",
5692 SDATA (p->name));
5694 else
5695 /* This is a real error. */
5696 report_file_error ("writing to process", Fcons (proc, Qnil));
5698 cur_buf += written;
5699 cur_len -= written;
5702 while (!NILP (p->write_queue));
5705 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5706 3, 3, 0,
5707 doc: /* Send current contents of region as input to PROCESS.
5708 PROCESS may be a process, a buffer, the name of a process or buffer, or
5709 nil, indicating the current buffer's process.
5710 Called from program, takes three arguments, PROCESS, START and END.
5711 If the region is more than 500 characters long,
5712 it is sent in several bunches. This may happen even for shorter regions.
5713 Output from processes can arrive in between bunches. */)
5714 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5716 Lisp_Object proc;
5717 ptrdiff_t start1, end1;
5719 proc = get_process (process);
5720 validate_region (&start, &end);
5722 if (XINT (start) < GPT && XINT (end) > GPT)
5723 move_gap (XINT (start));
5725 start1 = CHAR_TO_BYTE (XINT (start));
5726 end1 = CHAR_TO_BYTE (XINT (end));
5727 send_process (proc, (char *) BYTE_POS_ADDR (start1), end1 - start1,
5728 Fcurrent_buffer ());
5730 return Qnil;
5733 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5734 2, 2, 0,
5735 doc: /* Send PROCESS the contents of STRING as input.
5736 PROCESS may be a process, a buffer, the name of a process or buffer, or
5737 nil, indicating the current buffer's process.
5738 If STRING is more than 500 characters long,
5739 it is sent in several bunches. This may happen even for shorter strings.
5740 Output from processes can arrive in between bunches. */)
5741 (Lisp_Object process, Lisp_Object string)
5743 Lisp_Object proc;
5744 CHECK_STRING (string);
5745 proc = get_process (process);
5746 send_process (proc, SSDATA (string),
5747 SBYTES (string), string);
5748 return Qnil;
5751 /* Return the foreground process group for the tty/pty that
5752 the process P uses. */
5753 static pid_t
5754 emacs_get_tty_pgrp (struct Lisp_Process *p)
5756 pid_t gid = -1;
5758 #ifdef TIOCGPGRP
5759 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5761 int fd;
5762 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5763 master side. Try the slave side. */
5764 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5766 if (fd != -1)
5768 ioctl (fd, TIOCGPGRP, &gid);
5769 emacs_close (fd);
5772 #endif /* defined (TIOCGPGRP ) */
5774 return gid;
5777 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5778 Sprocess_running_child_p, 0, 1, 0,
5779 doc: /* Return t if PROCESS has given the terminal to a child.
5780 If the operating system does not make it possible to find out,
5781 return t unconditionally. */)
5782 (Lisp_Object process)
5784 /* Initialize in case ioctl doesn't exist or gives an error,
5785 in a way that will cause returning t. */
5786 pid_t gid;
5787 Lisp_Object proc;
5788 struct Lisp_Process *p;
5790 proc = get_process (process);
5791 p = XPROCESS (proc);
5793 if (!EQ (p->type, Qreal))
5794 error ("Process %s is not a subprocess",
5795 SDATA (p->name));
5796 if (p->infd < 0)
5797 error ("Process %s is not active",
5798 SDATA (p->name));
5800 gid = emacs_get_tty_pgrp (p);
5802 if (gid == p->pid)
5803 return Qnil;
5804 return Qt;
5807 /* send a signal number SIGNO to PROCESS.
5808 If CURRENT_GROUP is t, that means send to the process group
5809 that currently owns the terminal being used to communicate with PROCESS.
5810 This is used for various commands in shell mode.
5811 If CURRENT_GROUP is lambda, that means send to the process group
5812 that currently owns the terminal, but only if it is NOT the shell itself.
5814 If NOMSG is zero, insert signal-announcements into process's buffers
5815 right away.
5817 If we can, we try to signal PROCESS by sending control characters
5818 down the pty. This allows us to signal inferiors who have changed
5819 their uid, for which killpg would return an EPERM error. */
5821 static void
5822 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5823 int nomsg)
5825 Lisp_Object proc;
5826 register struct Lisp_Process *p;
5827 pid_t gid;
5828 int no_pgrp = 0;
5830 proc = get_process (process);
5831 p = XPROCESS (proc);
5833 if (!EQ (p->type, Qreal))
5834 error ("Process %s is not a subprocess",
5835 SDATA (p->name));
5836 if (p->infd < 0)
5837 error ("Process %s is not active",
5838 SDATA (p->name));
5840 if (!p->pty_flag)
5841 current_group = Qnil;
5843 /* If we are using pgrps, get a pgrp number and make it negative. */
5844 if (NILP (current_group))
5845 /* Send the signal to the shell's process group. */
5846 gid = p->pid;
5847 else
5849 #ifdef SIGNALS_VIA_CHARACTERS
5850 /* If possible, send signals to the entire pgrp
5851 by sending an input character to it. */
5853 struct termios t;
5854 cc_t *sig_char = NULL;
5856 tcgetattr (p->infd, &t);
5858 switch (signo)
5860 case SIGINT:
5861 sig_char = &t.c_cc[VINTR];
5862 break;
5864 case SIGQUIT:
5865 sig_char = &t.c_cc[VQUIT];
5866 break;
5868 case SIGTSTP:
5869 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5870 sig_char = &t.c_cc[VSWTCH];
5871 #else
5872 sig_char = &t.c_cc[VSUSP];
5873 #endif
5874 break;
5877 if (sig_char && *sig_char != CDISABLE)
5879 send_process (proc, (char *) sig_char, 1, Qnil);
5880 return;
5882 /* If we can't send the signal with a character,
5883 fall through and send it another way. */
5885 /* The code above may fall through if it can't
5886 handle the signal. */
5887 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5889 #ifdef TIOCGPGRP
5890 /* Get the current pgrp using the tty itself, if we have that.
5891 Otherwise, use the pty to get the pgrp.
5892 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5893 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5894 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5895 His patch indicates that if TIOCGPGRP returns an error, then
5896 we should just assume that p->pid is also the process group id. */
5898 gid = emacs_get_tty_pgrp (p);
5900 if (gid == -1)
5901 /* If we can't get the information, assume
5902 the shell owns the tty. */
5903 gid = p->pid;
5905 /* It is not clear whether anything really can set GID to -1.
5906 Perhaps on some system one of those ioctls can or could do so.
5907 Or perhaps this is vestigial. */
5908 if (gid == -1)
5909 no_pgrp = 1;
5910 #else /* ! defined (TIOCGPGRP ) */
5911 /* Can't select pgrps on this system, so we know that
5912 the child itself heads the pgrp. */
5913 gid = p->pid;
5914 #endif /* ! defined (TIOCGPGRP ) */
5916 /* If current_group is lambda, and the shell owns the terminal,
5917 don't send any signal. */
5918 if (EQ (current_group, Qlambda) && gid == p->pid)
5919 return;
5922 switch (signo)
5924 #ifdef SIGCONT
5925 case SIGCONT:
5926 p->raw_status_new = 0;
5927 pset_status (p, Qrun);
5928 p->tick = ++process_tick;
5929 if (!nomsg)
5931 status_notify (NULL);
5932 redisplay_preserve_echo_area (13);
5934 break;
5935 #endif /* ! defined (SIGCONT) */
5936 case SIGINT:
5937 case SIGQUIT:
5938 case SIGKILL:
5939 flush_pending_output (p->infd);
5940 break;
5943 /* If we don't have process groups, send the signal to the immediate
5944 subprocess. That isn't really right, but it's better than any
5945 obvious alternative. */
5946 if (no_pgrp)
5948 kill (p->pid, signo);
5949 return;
5952 /* gid may be a pid, or minus a pgrp's number */
5953 #ifdef TIOCSIGSEND
5954 if (!NILP (current_group))
5956 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5957 EMACS_KILLPG (gid, signo);
5959 else
5961 gid = - p->pid;
5962 kill (gid, signo);
5964 #else /* ! defined (TIOCSIGSEND) */
5965 EMACS_KILLPG (gid, signo);
5966 #endif /* ! defined (TIOCSIGSEND) */
5969 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5970 doc: /* Interrupt process PROCESS.
5971 PROCESS may be a process, a buffer, or the name of a process or buffer.
5972 No arg or nil means current buffer's process.
5973 Second arg CURRENT-GROUP non-nil means send signal to
5974 the current process-group of the process's controlling terminal
5975 rather than to the process's own process group.
5976 If the process is a shell, this means interrupt current subjob
5977 rather than the shell.
5979 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5980 don't send the signal. */)
5981 (Lisp_Object process, Lisp_Object current_group)
5983 process_send_signal (process, SIGINT, current_group, 0);
5984 return process;
5987 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5988 doc: /* Kill process PROCESS. May be process or name of one.
5989 See function `interrupt-process' for more details on usage. */)
5990 (Lisp_Object process, Lisp_Object current_group)
5992 process_send_signal (process, SIGKILL, current_group, 0);
5993 return process;
5996 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5997 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5998 See function `interrupt-process' for more details on usage. */)
5999 (Lisp_Object process, Lisp_Object current_group)
6001 process_send_signal (process, SIGQUIT, current_group, 0);
6002 return process;
6005 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
6006 doc: /* Stop process PROCESS. May be process or name of one.
6007 See function `interrupt-process' for more details on usage.
6008 If PROCESS is a network or serial process, inhibit handling of incoming
6009 traffic. */)
6010 (Lisp_Object process, Lisp_Object current_group)
6012 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
6014 struct Lisp_Process *p;
6016 p = XPROCESS (process);
6017 if (NILP (p->command)
6018 && p->infd >= 0)
6020 FD_CLR (p->infd, &input_wait_mask);
6021 FD_CLR (p->infd, &non_keyboard_wait_mask);
6023 pset_command (p, Qt);
6024 return process;
6026 #ifndef SIGTSTP
6027 error ("No SIGTSTP support");
6028 #else
6029 process_send_signal (process, SIGTSTP, current_group, 0);
6030 #endif
6031 return process;
6034 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
6035 doc: /* Continue process PROCESS. May be process or name of one.
6036 See function `interrupt-process' for more details on usage.
6037 If PROCESS is a network or serial process, resume handling of incoming
6038 traffic. */)
6039 (Lisp_Object process, Lisp_Object current_group)
6041 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
6043 struct Lisp_Process *p;
6045 p = XPROCESS (process);
6046 if (EQ (p->command, Qt)
6047 && p->infd >= 0
6048 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
6050 FD_SET (p->infd, &input_wait_mask);
6051 FD_SET (p->infd, &non_keyboard_wait_mask);
6052 #ifdef WINDOWSNT
6053 if (fd_info[ p->infd ].flags & FILE_SERIAL)
6054 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
6055 #else /* not WINDOWSNT */
6056 tcflush (p->infd, TCIFLUSH);
6057 #endif /* not WINDOWSNT */
6059 pset_command (p, Qnil);
6060 return process;
6062 #ifdef SIGCONT
6063 process_send_signal (process, SIGCONT, current_group, 0);
6064 #else
6065 error ("No SIGCONT support");
6066 #endif
6067 return process;
6070 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
6071 2, 2, "sProcess (name or number): \nnSignal code: ",
6072 doc: /* Send PROCESS the signal with code SIGCODE.
6073 PROCESS may also be a number specifying the process id of the
6074 process to signal; in this case, the process need not be a child of
6075 this Emacs.
6076 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
6077 (Lisp_Object process, Lisp_Object sigcode)
6079 pid_t pid;
6081 if (STRINGP (process))
6083 Lisp_Object tem = Fget_process (process);
6084 if (NILP (tem))
6086 Lisp_Object process_number =
6087 string_to_number (SSDATA (process), 10, 1);
6088 if (INTEGERP (process_number) || FLOATP (process_number))
6089 tem = process_number;
6091 process = tem;
6093 else if (!NUMBERP (process))
6094 process = get_process (process);
6096 if (NILP (process))
6097 return process;
6099 if (NUMBERP (process))
6100 CONS_TO_INTEGER (process, pid_t, pid);
6101 else
6103 CHECK_PROCESS (process);
6104 pid = XPROCESS (process)->pid;
6105 if (pid <= 0)
6106 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
6109 #define parse_signal(NAME, VALUE) \
6110 else if (!xstrcasecmp (name, NAME)) \
6111 XSETINT (sigcode, VALUE)
6113 if (INTEGERP (sigcode))
6114 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
6115 else
6117 char *name;
6119 CHECK_SYMBOL (sigcode);
6120 name = SSDATA (SYMBOL_NAME (sigcode));
6122 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
6123 name += 3;
6125 if (0)
6127 #ifdef SIGUSR1
6128 parse_signal ("usr1", SIGUSR1);
6129 #endif
6130 #ifdef SIGUSR2
6131 parse_signal ("usr2", SIGUSR2);
6132 #endif
6133 parse_signal ("term", SIGTERM);
6134 #ifdef SIGHUP
6135 parse_signal ("hup", SIGHUP);
6136 #endif
6137 parse_signal ("int", SIGINT);
6138 #ifdef SIGQUIT
6139 parse_signal ("quit", SIGQUIT);
6140 #endif
6141 parse_signal ("ill", SIGILL);
6142 parse_signal ("abrt", SIGABRT);
6143 #ifdef SIGEMT
6144 parse_signal ("emt", SIGEMT);
6145 #endif
6146 #ifdef SIGKILL
6147 parse_signal ("kill", SIGKILL);
6148 #endif
6149 parse_signal ("fpe", SIGFPE);
6150 #ifdef SIGBUS
6151 parse_signal ("bus", SIGBUS);
6152 #endif
6153 parse_signal ("segv", SIGSEGV);
6154 #ifdef SIGSYS
6155 parse_signal ("sys", SIGSYS);
6156 #endif
6157 #ifdef SIGPIPE
6158 parse_signal ("pipe", SIGPIPE);
6159 #endif
6160 #ifdef SIGALRM
6161 parse_signal ("alrm", SIGALRM);
6162 #endif
6163 #ifdef SIGURG
6164 parse_signal ("urg", SIGURG);
6165 #endif
6166 #ifdef SIGSTOP
6167 parse_signal ("stop", SIGSTOP);
6168 #endif
6169 #ifdef SIGTSTP
6170 parse_signal ("tstp", SIGTSTP);
6171 #endif
6172 #ifdef SIGCONT
6173 parse_signal ("cont", SIGCONT);
6174 #endif
6175 #ifdef SIGCHLD
6176 parse_signal ("chld", SIGCHLD);
6177 #endif
6178 #ifdef SIGTTIN
6179 parse_signal ("ttin", SIGTTIN);
6180 #endif
6181 #ifdef SIGTTOU
6182 parse_signal ("ttou", SIGTTOU);
6183 #endif
6184 #ifdef SIGIO
6185 parse_signal ("io", SIGIO);
6186 #endif
6187 #ifdef SIGXCPU
6188 parse_signal ("xcpu", SIGXCPU);
6189 #endif
6190 #ifdef SIGXFSZ
6191 parse_signal ("xfsz", SIGXFSZ);
6192 #endif
6193 #ifdef SIGVTALRM
6194 parse_signal ("vtalrm", SIGVTALRM);
6195 #endif
6196 #ifdef SIGPROF
6197 parse_signal ("prof", SIGPROF);
6198 #endif
6199 #ifdef SIGWINCH
6200 parse_signal ("winch", SIGWINCH);
6201 #endif
6202 #ifdef SIGINFO
6203 parse_signal ("info", SIGINFO);
6204 #endif
6205 else
6206 error ("Undefined signal name %s", name);
6209 #undef parse_signal
6211 return make_number (kill (pid, XINT (sigcode)));
6214 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6215 doc: /* Make PROCESS see end-of-file in its input.
6216 EOF comes after any text already sent to it.
6217 PROCESS may be a process, a buffer, the name of a process or buffer, or
6218 nil, indicating the current buffer's process.
6219 If PROCESS is a network connection, or is a process communicating
6220 through a pipe (as opposed to a pty), then you cannot send any more
6221 text to PROCESS after you call this function.
6222 If PROCESS is a serial process, wait until all output written to the
6223 process has been transmitted to the serial port. */)
6224 (Lisp_Object process)
6226 Lisp_Object proc;
6227 struct coding_system *coding;
6229 if (DATAGRAM_CONN_P (process))
6230 return process;
6232 proc = get_process (process);
6233 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6235 /* Make sure the process is really alive. */
6236 if (XPROCESS (proc)->raw_status_new)
6237 update_status (XPROCESS (proc));
6238 if (! EQ (XPROCESS (proc)->status, Qrun))
6239 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6241 if (CODING_REQUIRE_FLUSHING (coding))
6243 coding->mode |= CODING_MODE_LAST_BLOCK;
6244 send_process (proc, "", 0, Qnil);
6247 if (XPROCESS (proc)->pty_flag)
6248 send_process (proc, "\004", 1, Qnil);
6249 else if (EQ (XPROCESS (proc)->type, Qserial))
6251 #ifndef WINDOWSNT
6252 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6253 error ("tcdrain() failed: %s", emacs_strerror (errno));
6254 #endif /* not WINDOWSNT */
6255 /* Do nothing on Windows because writes are blocking. */
6257 else
6259 int old_outfd, new_outfd;
6261 #ifdef HAVE_SHUTDOWN
6262 /* If this is a network connection, or socketpair is used
6263 for communication with the subprocess, call shutdown to cause EOF.
6264 (In some old system, shutdown to socketpair doesn't work.
6265 Then we just can't win.) */
6266 if (EQ (XPROCESS (proc)->type, Qnetwork)
6267 || XPROCESS (proc)->outfd == XPROCESS (proc)->infd)
6268 shutdown (XPROCESS (proc)->outfd, 1);
6269 /* In case of socketpair, outfd == infd, so don't close it. */
6270 if (XPROCESS (proc)->outfd != XPROCESS (proc)->infd)
6271 emacs_close (XPROCESS (proc)->outfd);
6272 #else /* not HAVE_SHUTDOWN */
6273 emacs_close (XPROCESS (proc)->outfd);
6274 #endif /* not HAVE_SHUTDOWN */
6275 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6276 if (new_outfd < 0)
6277 emacs_abort ();
6278 old_outfd = XPROCESS (proc)->outfd;
6280 if (!proc_encode_coding_system[new_outfd])
6281 proc_encode_coding_system[new_outfd]
6282 = xmalloc (sizeof (struct coding_system));
6283 *proc_encode_coding_system[new_outfd]
6284 = *proc_encode_coding_system[old_outfd];
6285 memset (proc_encode_coding_system[old_outfd], 0,
6286 sizeof (struct coding_system));
6288 XPROCESS (proc)->outfd = new_outfd;
6290 return process;
6293 /* On receipt of a signal that a child status has changed, loop asking
6294 about children with changed statuses until the system says there
6295 are no more.
6297 All we do is change the status; we do not run sentinels or print
6298 notifications. That is saved for the next time keyboard input is
6299 done, in order to avoid timing errors.
6301 ** WARNING: this can be called during garbage collection.
6302 Therefore, it must not be fooled by the presence of mark bits in
6303 Lisp objects.
6305 ** USG WARNING: Although it is not obvious from the documentation
6306 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6307 signal() before executing at least one wait(), otherwise the
6308 handler will be called again, resulting in an infinite loop. The
6309 relevant portion of the documentation reads "SIGCLD signals will be
6310 queued and the signal-catching function will be continually
6311 reentered until the queue is empty". Invoking signal() causes the
6312 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6313 Inc.
6315 ** Malloc WARNING: This should never call malloc either directly or
6316 indirectly; if it does, that is a bug */
6318 /* Record the changed status of the child process PID with wait status W. */
6319 void
6320 record_child_status_change (pid_t pid, int w)
6322 #ifdef SIGCHLD
6323 Lisp_Object proc;
6324 struct Lisp_Process *p;
6325 Lisp_Object tail;
6327 /* Find the process that signaled us, and record its status. */
6329 /* The process can have been deleted by Fdelete_process. */
6330 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6332 Lisp_Object xpid = XCAR (tail);
6333 if ((INTEGERP (xpid) && pid == XINT (xpid))
6334 || (FLOATP (xpid) && pid == XFLOAT_DATA (xpid)))
6336 XSETCAR (tail, Qnil);
6337 return;
6341 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6342 p = 0;
6343 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6345 proc = XCDR (XCAR (tail));
6346 p = XPROCESS (proc);
6347 if (EQ (p->type, Qreal) && p->pid == pid)
6348 break;
6349 p = 0;
6352 /* Look for an asynchronous process whose pid hasn't been filled
6353 in yet. */
6354 if (! p)
6355 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6357 proc = XCDR (XCAR (tail));
6358 p = XPROCESS (proc);
6359 if (p->pid == -1)
6360 break;
6361 p = 0;
6364 /* Change the status of the process that was found. */
6365 if (p)
6367 int clear_desc_flag = 0;
6369 p->tick = ++process_tick;
6370 p->raw_status = w;
6371 p->raw_status_new = 1;
6373 /* If process has terminated, stop waiting for its output. */
6374 if ((WIFSIGNALED (w) || WIFEXITED (w))
6375 && p->infd >= 0)
6376 clear_desc_flag = 1;
6378 /* We use clear_desc_flag to avoid a compiler bug in Microsoft C. */
6379 if (clear_desc_flag)
6381 FD_CLR (p->infd, &input_wait_mask);
6382 FD_CLR (p->infd, &non_keyboard_wait_mask);
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 /* There was no asynchronous process found for that pid: we have
6391 a synchronous process. */
6392 else
6394 synch_process_alive = 0;
6396 /* Report the status of the synchronous process. */
6397 if (WIFEXITED (w))
6398 synch_process_retcode = WEXITSTATUS (w);
6399 else if (WIFSIGNALED (w))
6400 synch_process_termsig = WTERMSIG (w);
6402 /* Tell wait_reading_process_output that it needs to wake up and
6403 look around. */
6404 if (input_available_clear_time)
6405 *input_available_clear_time = make_emacs_time (0, 0);
6407 #endif
6410 #ifdef SIGCHLD
6412 /* On some systems, the SIGCHLD handler must return right away. If
6413 any more processes want to signal us, we will get another signal.
6414 Otherwise, loop around to use up all the processes that have
6415 something to tell us. */
6416 #if (defined WINDOWSNT \
6417 || (defined USG && !defined GNU_LINUX \
6418 && !(defined HPUX && defined WNOHANG)))
6419 enum { CAN_HANDLE_MULTIPLE_CHILDREN = 0 };
6420 #else
6421 enum { CAN_HANDLE_MULTIPLE_CHILDREN = 1 };
6422 #endif
6424 static void
6425 handle_child_signal (int sig)
6429 pid_t pid;
6430 int status;
6433 pid = waitpid (-1, &status, WNOHANG | WUNTRACED);
6434 while (pid < 0 && errno == EINTR);
6436 /* PID == 0 means no processes found, PID == -1 means a real failure.
6437 Either way, we have done all our job. */
6438 if (pid <= 0)
6439 break;
6441 record_child_status_change (pid, status);
6443 while (CAN_HANDLE_MULTIPLE_CHILDREN);
6446 static void
6447 deliver_child_signal (int sig)
6449 deliver_process_signal (sig, handle_child_signal);
6452 #endif /* SIGCHLD */
6455 static Lisp_Object
6456 exec_sentinel_unwind (Lisp_Object data)
6458 pset_sentinel (XPROCESS (XCAR (data)), XCDR (data));
6459 return Qnil;
6462 static Lisp_Object
6463 exec_sentinel_error_handler (Lisp_Object error_val)
6465 cmd_error_internal (error_val, "error in process sentinel: ");
6466 Vinhibit_quit = Qt;
6467 update_echo_area ();
6468 Fsleep_for (make_number (2), Qnil);
6469 return Qt;
6472 static void
6473 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6475 Lisp_Object sentinel, odeactivate;
6476 struct Lisp_Process *p = XPROCESS (proc);
6477 ptrdiff_t count = SPECPDL_INDEX ();
6478 bool outer_running_asynch_code = running_asynch_code;
6479 int waiting = waiting_for_user_input_p;
6481 if (inhibit_sentinels)
6482 return;
6484 /* No need to gcpro these, because all we do with them later
6485 is test them for EQness, and none of them should be a string. */
6486 odeactivate = Vdeactivate_mark;
6487 #if 0
6488 Lisp_Object obuffer, okeymap;
6489 XSETBUFFER (obuffer, current_buffer);
6490 okeymap = BVAR (current_buffer, keymap);
6491 #endif
6493 /* There's no good reason to let sentinels change the current
6494 buffer, and many callers of accept-process-output, sit-for, and
6495 friends don't expect current-buffer to be changed from under them. */
6496 record_unwind_current_buffer ();
6498 sentinel = p->sentinel;
6499 if (NILP (sentinel))
6500 return;
6502 /* Zilch the sentinel while it's running, to avoid recursive invocations;
6503 assure that it gets restored no matter how the sentinel exits. */
6504 pset_sentinel (p, Qnil);
6505 record_unwind_protect (exec_sentinel_unwind, Fcons (proc, sentinel));
6506 /* Inhibit quit so that random quits don't screw up a running filter. */
6507 specbind (Qinhibit_quit, Qt);
6508 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6510 /* In case we get recursively called,
6511 and we already saved the match data nonrecursively,
6512 save the same match data in safely recursive fashion. */
6513 if (outer_running_asynch_code)
6515 Lisp_Object tem;
6516 tem = Fmatch_data (Qnil, Qnil, Qnil);
6517 restore_search_regs ();
6518 record_unwind_save_match_data ();
6519 Fset_match_data (tem, Qt);
6522 /* For speed, if a search happens within this code,
6523 save the match data in a special nonrecursive fashion. */
6524 running_asynch_code = 1;
6526 internal_condition_case_1 (read_process_output_call,
6527 Fcons (sentinel,
6528 Fcons (proc, Fcons (reason, Qnil))),
6529 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6530 exec_sentinel_error_handler);
6532 /* If we saved the match data nonrecursively, restore it now. */
6533 restore_search_regs ();
6534 running_asynch_code = outer_running_asynch_code;
6536 Vdeactivate_mark = odeactivate;
6538 /* Restore waiting_for_user_input_p as it was
6539 when we were called, in case the filter clobbered it. */
6540 waiting_for_user_input_p = waiting;
6542 #if 0
6543 if (! EQ (Fcurrent_buffer (), obuffer)
6544 || ! EQ (current_buffer->keymap, okeymap))
6545 #endif
6546 /* But do it only if the caller is actually going to read events.
6547 Otherwise there's no need to make him wake up, and it could
6548 cause trouble (for example it would make sit_for return). */
6549 if (waiting_for_user_input_p == -1)
6550 record_asynch_buffer_change ();
6552 unbind_to (count, Qnil);
6555 /* Report all recent events of a change in process status
6556 (either run the sentinel or output a message).
6557 This is usually done while Emacs is waiting for keyboard input
6558 but can be done at other times. */
6560 static void
6561 status_notify (struct Lisp_Process *deleting_process)
6563 register Lisp_Object proc, buffer;
6564 Lisp_Object tail, msg;
6565 struct gcpro gcpro1, gcpro2;
6567 tail = Qnil;
6568 msg = Qnil;
6569 /* We need to gcpro tail; if read_process_output calls a filter
6570 which deletes a process and removes the cons to which tail points
6571 from Vprocess_alist, and then causes a GC, tail is an unprotected
6572 reference. */
6573 GCPRO2 (tail, msg);
6575 /* Set this now, so that if new processes are created by sentinels
6576 that we run, we get called again to handle their status changes. */
6577 update_tick = process_tick;
6579 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6581 Lisp_Object symbol;
6582 register struct Lisp_Process *p;
6584 proc = Fcdr (XCAR (tail));
6585 p = XPROCESS (proc);
6587 if (p->tick != p->update_tick)
6589 p->update_tick = p->tick;
6591 /* If process is still active, read any output that remains. */
6592 while (! EQ (p->filter, Qt)
6593 && ! EQ (p->status, Qconnect)
6594 && ! EQ (p->status, Qlisten)
6595 /* Network or serial process not stopped: */
6596 && ! EQ (p->command, Qt)
6597 && p->infd >= 0
6598 && p != deleting_process
6599 && read_process_output (proc, p->infd) > 0);
6601 buffer = p->buffer;
6603 /* Get the text to use for the message. */
6604 if (p->raw_status_new)
6605 update_status (p);
6606 msg = status_message (p);
6608 /* If process is terminated, deactivate it or delete it. */
6609 symbol = p->status;
6610 if (CONSP (p->status))
6611 symbol = XCAR (p->status);
6613 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6614 || EQ (symbol, Qclosed))
6616 if (delete_exited_processes)
6617 remove_process (proc);
6618 else
6619 deactivate_process (proc);
6622 /* The actions above may have further incremented p->tick.
6623 So set p->update_tick again
6624 so that an error in the sentinel will not cause
6625 this code to be run again. */
6626 p->update_tick = p->tick;
6627 /* Now output the message suitably. */
6628 if (!NILP (p->sentinel))
6629 exec_sentinel (proc, msg);
6630 /* Don't bother with a message in the buffer
6631 when a process becomes runnable. */
6632 else if (!EQ (symbol, Qrun) && !NILP (buffer))
6634 Lisp_Object tem;
6635 struct buffer *old = current_buffer;
6636 ptrdiff_t opoint, opoint_byte;
6637 ptrdiff_t before, before_byte;
6639 /* Avoid error if buffer is deleted
6640 (probably that's why the process is dead, too) */
6641 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
6642 continue;
6643 Fset_buffer (buffer);
6645 opoint = PT;
6646 opoint_byte = PT_BYTE;
6647 /* Insert new output into buffer
6648 at the current end-of-output marker,
6649 thus preserving logical ordering of input and output. */
6650 if (XMARKER (p->mark)->buffer)
6651 Fgoto_char (p->mark);
6652 else
6653 SET_PT_BOTH (ZV, ZV_BYTE);
6655 before = PT;
6656 before_byte = PT_BYTE;
6658 tem = BVAR (current_buffer, read_only);
6659 bset_read_only (current_buffer, Qnil);
6660 insert_string ("\nProcess ");
6661 { /* FIXME: temporary kludge */
6662 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
6663 insert_string (" ");
6664 Finsert (1, &msg);
6665 bset_read_only (current_buffer, tem);
6666 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6668 if (opoint >= before)
6669 SET_PT_BOTH (opoint + (PT - before),
6670 opoint_byte + (PT_BYTE - before_byte));
6671 else
6672 SET_PT_BOTH (opoint, opoint_byte);
6674 set_buffer_internal (old);
6677 } /* end for */
6679 update_mode_lines++; /* in case buffers use %s in mode-line-format */
6680 UNGCPRO;
6684 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6685 Sset_process_coding_system, 1, 3, 0,
6686 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6687 DECODING will be used to decode subprocess output and ENCODING to
6688 encode subprocess input. */)
6689 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6691 register struct Lisp_Process *p;
6693 CHECK_PROCESS (process);
6694 p = XPROCESS (process);
6695 if (p->infd < 0)
6696 error ("Input file descriptor of %s closed", SDATA (p->name));
6697 if (p->outfd < 0)
6698 error ("Output file descriptor of %s closed", SDATA (p->name));
6699 Fcheck_coding_system (decoding);
6700 Fcheck_coding_system (encoding);
6701 encoding = coding_inherit_eol_type (encoding, Qnil);
6702 pset_decode_coding_system (p, decoding);
6703 pset_encode_coding_system (p, encoding);
6704 setup_process_coding_systems (process);
6706 return Qnil;
6709 DEFUN ("process-coding-system",
6710 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6711 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6712 (register Lisp_Object process)
6714 CHECK_PROCESS (process);
6715 return Fcons (XPROCESS (process)->decode_coding_system,
6716 XPROCESS (process)->encode_coding_system);
6719 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6720 Sset_process_filter_multibyte, 2, 2, 0,
6721 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6722 If FLAG is non-nil, the filter is given multibyte strings.
6723 If FLAG is nil, the filter is given unibyte strings. In this case,
6724 all character code conversion except for end-of-line conversion is
6725 suppressed. */)
6726 (Lisp_Object process, Lisp_Object flag)
6728 register struct Lisp_Process *p;
6730 CHECK_PROCESS (process);
6731 p = XPROCESS (process);
6732 if (NILP (flag))
6733 pset_decode_coding_system
6734 (p, raw_text_coding_system (p->decode_coding_system));
6735 setup_process_coding_systems (process);
6737 return Qnil;
6740 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6741 Sprocess_filter_multibyte_p, 1, 1, 0,
6742 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6743 (Lisp_Object process)
6745 register struct Lisp_Process *p;
6746 struct coding_system *coding;
6748 CHECK_PROCESS (process);
6749 p = XPROCESS (process);
6750 coding = proc_decode_coding_system[p->infd];
6751 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6757 # ifdef HAVE_GPM
6759 void
6760 add_gpm_wait_descriptor (int desc)
6762 add_keyboard_wait_descriptor (desc);
6765 void
6766 delete_gpm_wait_descriptor (int desc)
6768 delete_keyboard_wait_descriptor (desc);
6771 # endif
6773 # ifdef USABLE_SIGIO
6775 /* Return nonzero if *MASK has a bit set
6776 that corresponds to one of the keyboard input descriptors. */
6778 static int
6779 keyboard_bit_set (fd_set *mask)
6781 int fd;
6783 for (fd = 0; fd <= max_input_desc; fd++)
6784 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6785 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6786 return 1;
6788 return 0;
6790 # endif
6792 #else /* not subprocesses */
6794 /* Defined on msdos.c. */
6795 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
6796 EMACS_TIME *, void *);
6798 /* Implementation of wait_reading_process_output, assuming that there
6799 are no subprocesses. Used only by the MS-DOS build.
6801 Wait for timeout to elapse and/or keyboard input to be available.
6803 TIME_LIMIT is:
6804 timeout in seconds
6805 If negative, gobble data immediately available but don't wait for any.
6807 NSECS is:
6808 an additional duration to wait, measured in nanoseconds
6809 If TIME_LIMIT is zero, then:
6810 If NSECS == 0, there is no limit.
6811 If NSECS > 0, the timeout consists of NSECS only.
6812 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6814 READ_KBD is:
6815 0 to ignore keyboard input, or
6816 1 to return when input is available, or
6817 -1 means caller will actually read the input, so don't throw to
6818 the quit handler.
6820 see full version for other parameters. We know that wait_proc will
6821 always be NULL, since `subprocesses' isn't defined.
6823 DO_DISPLAY != 0 means redisplay should be done to show subprocess
6824 output that arrives.
6826 Return true if we received input from any process. */
6829 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6830 int do_display,
6831 Lisp_Object wait_for_cell,
6832 struct Lisp_Process *wait_proc, int just_wait_proc)
6834 register int nfds;
6835 EMACS_TIME end_time, timeout;
6837 if (time_limit < 0)
6839 time_limit = 0;
6840 nsecs = -1;
6842 else if (TYPE_MAXIMUM (time_t) < time_limit)
6843 time_limit = TYPE_MAXIMUM (time_t);
6845 /* What does time_limit really mean? */
6846 if (time_limit || 0 < nsecs)
6848 timeout = make_emacs_time (time_limit, nsecs);
6849 end_time = add_emacs_time (current_emacs_time (), timeout);
6852 /* Turn off periodic alarms (in case they are in use)
6853 and then turn off any other atimers,
6854 because the select emulator uses alarms. */
6855 stop_polling ();
6856 turn_on_atimers (0);
6858 while (1)
6860 int timeout_reduced_for_timers = 0;
6861 SELECT_TYPE waitchannels;
6862 int xerrno;
6864 /* If calling from keyboard input, do not quit
6865 since we want to return C-g as an input character.
6866 Otherwise, do pending quit if requested. */
6867 if (read_kbd >= 0)
6868 QUIT;
6870 /* Exit now if the cell we're waiting for became non-nil. */
6871 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6872 break;
6874 /* Compute time from now till when time limit is up */
6875 /* Exit if already run out */
6876 if (nsecs < 0)
6878 /* A negative timeout means
6879 gobble output available now
6880 but don't wait at all. */
6882 timeout = make_emacs_time (0, 0);
6884 else if (time_limit || 0 < nsecs)
6886 EMACS_TIME now = current_emacs_time ();
6887 if (EMACS_TIME_LE (end_time, now))
6888 break;
6889 timeout = sub_emacs_time (end_time, now);
6891 else
6893 timeout = make_emacs_time (100000, 0);
6896 /* If our caller will not immediately handle keyboard events,
6897 run timer events directly.
6898 (Callers that will immediately read keyboard events
6899 call timer_delay on their own.) */
6900 if (NILP (wait_for_cell))
6902 EMACS_TIME timer_delay;
6906 int old_timers_run = timers_run;
6907 timer_delay = timer_check ();
6908 if (timers_run != old_timers_run && do_display)
6909 /* We must retry, since a timer may have requeued itself
6910 and that could alter the time delay. */
6911 redisplay_preserve_echo_area (14);
6912 else
6913 break;
6915 while (!detect_input_pending ());
6917 /* If there is unread keyboard input, also return. */
6918 if (read_kbd != 0
6919 && requeued_events_pending_p ())
6920 break;
6922 if (EMACS_TIME_VALID_P (timer_delay) && 0 <= nsecs)
6924 if (EMACS_TIME_LT (timer_delay, timeout))
6926 timeout = timer_delay;
6927 timeout_reduced_for_timers = 1;
6932 /* Cause C-g and alarm signals to take immediate action,
6933 and cause input available signals to zero out timeout. */
6934 if (read_kbd < 0)
6935 set_waiting_for_input (&timeout);
6937 /* If a frame has been newly mapped and needs updating,
6938 reprocess its display stuff. */
6939 if (frame_garbaged && do_display)
6941 clear_waiting_for_input ();
6942 redisplay_preserve_echo_area (15);
6943 if (read_kbd < 0)
6944 set_waiting_for_input (&timeout);
6947 /* Wait till there is something to do. */
6948 FD_ZERO (&waitchannels);
6949 if (read_kbd && detect_input_pending ())
6950 nfds = 0;
6951 else
6953 if (read_kbd || !NILP (wait_for_cell))
6954 FD_SET (0, &waitchannels);
6955 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6958 xerrno = errno;
6960 /* Make C-g and alarm signals set flags again */
6961 clear_waiting_for_input ();
6963 /* If we woke up due to SIGWINCH, actually change size now. */
6964 do_pending_window_change (0);
6966 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6967 /* We waited the full specified time, so return now. */
6968 break;
6970 if (nfds == -1)
6972 /* If the system call was interrupted, then go around the
6973 loop again. */
6974 if (xerrno == EINTR)
6975 FD_ZERO (&waitchannels);
6976 else
6977 error ("select error: %s", emacs_strerror (xerrno));
6980 /* Check for keyboard input */
6982 if (read_kbd
6983 && detect_input_pending_run_timers (do_display))
6985 swallow_events (do_display);
6986 if (detect_input_pending_run_timers (do_display))
6987 break;
6990 /* If there is unread keyboard input, also return. */
6991 if (read_kbd
6992 && requeued_events_pending_p ())
6993 break;
6995 /* If wait_for_cell. check for keyboard input
6996 but don't run any timers.
6997 ??? (It seems wrong to me to check for keyboard
6998 input at all when wait_for_cell, but the code
6999 has been this way since July 1994.
7000 Try changing this after version 19.31.) */
7001 if (! NILP (wait_for_cell)
7002 && detect_input_pending ())
7004 swallow_events (do_display);
7005 if (detect_input_pending ())
7006 break;
7009 /* Exit now if the cell we're waiting for became non-nil. */
7010 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
7011 break;
7014 start_polling ();
7016 return 0;
7019 #endif /* not subprocesses */
7021 /* The following functions are needed even if async subprocesses are
7022 not supported. Some of them are no-op stubs in that case. */
7024 /* Add DESC to the set of keyboard input descriptors. */
7026 void
7027 add_keyboard_wait_descriptor (int desc)
7029 #ifdef subprocesses /* actually means "not MSDOS" */
7030 FD_SET (desc, &input_wait_mask);
7031 FD_SET (desc, &non_process_wait_mask);
7032 if (desc > max_input_desc)
7033 max_input_desc = desc;
7034 #endif
7037 /* From now on, do not expect DESC to give keyboard input. */
7039 void
7040 delete_keyboard_wait_descriptor (int desc)
7042 #ifdef subprocesses
7043 int fd;
7044 int lim = max_input_desc;
7046 FD_CLR (desc, &input_wait_mask);
7047 FD_CLR (desc, &non_process_wait_mask);
7049 if (desc == max_input_desc)
7050 for (fd = 0; fd < lim; fd++)
7051 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
7052 max_input_desc = fd;
7053 #endif
7056 /* Setup coding systems of PROCESS. */
7058 void
7059 setup_process_coding_systems (Lisp_Object process)
7061 #ifdef subprocesses
7062 struct Lisp_Process *p = XPROCESS (process);
7063 int inch = p->infd;
7064 int outch = p->outfd;
7065 Lisp_Object coding_system;
7067 if (inch < 0 || outch < 0)
7068 return;
7070 if (!proc_decode_coding_system[inch])
7071 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
7072 coding_system = p->decode_coding_system;
7073 if (! NILP (p->filter))
7075 else if (BUFFERP (p->buffer))
7077 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
7078 coding_system = raw_text_coding_system (coding_system);
7080 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
7082 if (!proc_encode_coding_system[outch])
7083 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
7084 setup_coding_system (p->encode_coding_system,
7085 proc_encode_coding_system[outch]);
7086 #endif
7089 /* Close all descriptors currently in use for communication
7090 with subprocess. This is used in a newly-forked subprocess
7091 to get rid of irrelevant descriptors. */
7093 void
7094 close_process_descs (void)
7096 #ifndef DOS_NT
7097 int i;
7098 for (i = 0; i < MAXDESC; i++)
7100 Lisp_Object process;
7101 process = chan_process[i];
7102 if (!NILP (process))
7104 int in = XPROCESS (process)->infd;
7105 int out = XPROCESS (process)->outfd;
7106 if (in >= 0)
7107 emacs_close (in);
7108 if (out >= 0 && in != out)
7109 emacs_close (out);
7112 #endif
7115 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
7116 doc: /* Return the (or a) process associated with BUFFER.
7117 BUFFER may be a buffer or the name of one. */)
7118 (register Lisp_Object buffer)
7120 #ifdef subprocesses
7121 register Lisp_Object buf, tail, proc;
7123 if (NILP (buffer)) return Qnil;
7124 buf = Fget_buffer (buffer);
7125 if (NILP (buf)) return Qnil;
7127 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
7129 proc = Fcdr (XCAR (tail));
7130 if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
7131 return proc;
7133 #endif /* subprocesses */
7134 return Qnil;
7137 DEFUN ("process-inherit-coding-system-flag",
7138 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
7139 1, 1, 0,
7140 doc: /* Return the value of inherit-coding-system flag for PROCESS.
7141 If this flag is t, `buffer-file-coding-system' of the buffer
7142 associated with PROCESS will inherit the coding system used to decode
7143 the process output. */)
7144 (register Lisp_Object process)
7146 #ifdef subprocesses
7147 CHECK_PROCESS (process);
7148 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
7149 #else
7150 /* Ignore the argument and return the value of
7151 inherit-process-coding-system. */
7152 return inherit_process_coding_system ? Qt : Qnil;
7153 #endif
7156 /* Kill all processes associated with `buffer'.
7157 If `buffer' is nil, kill all processes */
7159 void
7160 kill_buffer_processes (Lisp_Object buffer)
7162 #ifdef subprocesses
7163 Lisp_Object tail, proc;
7165 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
7167 proc = XCDR (XCAR (tail));
7168 if (PROCESSP (proc)
7169 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
7171 if (NETCONN_P (proc) || SERIALCONN_P (proc))
7172 Fdelete_process (proc);
7173 else if (XPROCESS (proc)->infd >= 0)
7174 process_send_signal (proc, SIGHUP, Qnil, 1);
7177 #else /* subprocesses */
7178 /* Since we have no subprocesses, this does nothing. */
7179 #endif /* subprocesses */
7182 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
7183 Swaiting_for_user_input_p, 0, 0, 0,
7184 doc: /* Returns non-nil if Emacs is waiting for input from the user.
7185 This is intended for use by asynchronous process output filters and sentinels. */)
7186 (void)
7188 #ifdef subprocesses
7189 return (waiting_for_user_input_p ? Qt : Qnil);
7190 #else
7191 return Qnil;
7192 #endif
7195 /* Stop reading input from keyboard sources. */
7197 void
7198 hold_keyboard_input (void)
7200 kbd_is_on_hold = 1;
7203 /* Resume reading input from keyboard sources. */
7205 void
7206 unhold_keyboard_input (void)
7208 kbd_is_on_hold = 0;
7211 /* Return non-zero if keyboard input is on hold, zero otherwise. */
7214 kbd_on_hold_p (void)
7216 return kbd_is_on_hold;
7220 /* Enumeration of and access to system processes a-la ps(1). */
7222 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
7223 0, 0, 0,
7224 doc: /* Return a list of numerical process IDs of all running processes.
7225 If this functionality is unsupported, return nil.
7227 See `process-attributes' for getting attributes of a process given its ID. */)
7228 (void)
7230 return list_system_processes ();
7233 DEFUN ("process-attributes", Fprocess_attributes,
7234 Sprocess_attributes, 1, 1, 0,
7235 doc: /* Return attributes of the process given by its PID, a number.
7237 Value is an alist where each element is a cons cell of the form
7239 \(KEY . VALUE)
7241 If this functionality is unsupported, the value is nil.
7243 See `list-system-processes' for getting a list of all process IDs.
7245 The KEYs of the attributes that this function may return are listed
7246 below, together with the type of the associated VALUE (in parentheses).
7247 Not all platforms support all of these attributes; unsupported
7248 attributes will not appear in the returned alist.
7249 Unless explicitly indicated otherwise, numbers can have either
7250 integer or floating point values.
7252 euid -- Effective user User ID of the process (number)
7253 user -- User name corresponding to euid (string)
7254 egid -- Effective user Group ID of the process (number)
7255 group -- Group name corresponding to egid (string)
7256 comm -- Command name (executable name only) (string)
7257 state -- Process state code, such as "S", "R", or "T" (string)
7258 ppid -- Parent process ID (number)
7259 pgrp -- Process group ID (number)
7260 sess -- Session ID, i.e. process ID of session leader (number)
7261 ttname -- Controlling tty name (string)
7262 tpgid -- ID of foreground process group on the process's tty (number)
7263 minflt -- number of minor page faults (number)
7264 majflt -- number of major page faults (number)
7265 cminflt -- cumulative number of minor page faults (number)
7266 cmajflt -- cumulative number of major page faults (number)
7267 utime -- user time used by the process, in (current-time) format,
7268 which is a list of integers (HIGH LOW USEC PSEC)
7269 stime -- system time used by the process (current-time)
7270 time -- sum of utime and stime (current-time)
7271 cutime -- user time used by the process and its children (current-time)
7272 cstime -- system time used by the process and its children (current-time)
7273 ctime -- sum of cutime and cstime (current-time)
7274 pri -- priority of the process (number)
7275 nice -- nice value of the process (number)
7276 thcount -- process thread count (number)
7277 start -- time the process started (current-time)
7278 vsize -- virtual memory size of the process in KB's (number)
7279 rss -- resident set size of the process in KB's (number)
7280 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7281 pcpu -- percents of CPU time used by the process (floating-point number)
7282 pmem -- percents of total physical memory used by process's resident set
7283 (floating-point number)
7284 args -- command line which invoked the process (string). */)
7285 ( Lisp_Object pid)
7287 return system_process_attributes (pid);
7291 /* This is not called "init_process" because that is the name of a
7292 Mach system call, so it would cause problems on Darwin systems. */
7293 void
7294 init_process_emacs (void)
7296 #ifdef subprocesses
7297 register int i;
7299 inhibit_sentinels = 0;
7301 #ifdef SIGCHLD
7302 #ifndef CANNOT_DUMP
7303 if (! noninteractive || initialized)
7304 #endif
7306 struct sigaction action;
7307 emacs_sigaction_init (&action, deliver_child_signal);
7308 sigaction (SIGCHLD, &action, 0);
7310 #endif
7312 FD_ZERO (&input_wait_mask);
7313 FD_ZERO (&non_keyboard_wait_mask);
7314 FD_ZERO (&non_process_wait_mask);
7315 FD_ZERO (&write_mask);
7316 max_process_desc = 0;
7317 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7319 #ifdef NON_BLOCKING_CONNECT
7320 FD_ZERO (&connect_wait_mask);
7321 num_pending_connects = 0;
7322 #endif
7324 #ifdef ADAPTIVE_READ_BUFFERING
7325 process_output_delay_count = 0;
7326 process_output_skip = 0;
7327 #endif
7329 /* Don't do this, it caused infinite select loops. The display
7330 method should call add_keyboard_wait_descriptor on stdin if it
7331 needs that. */
7332 #if 0
7333 FD_SET (0, &input_wait_mask);
7334 #endif
7336 Vprocess_alist = Qnil;
7337 #ifdef SIGCHLD
7338 deleted_pid_list = Qnil;
7339 #endif
7340 for (i = 0; i < MAXDESC; i++)
7342 chan_process[i] = Qnil;
7343 proc_buffered_char[i] = -1;
7345 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7346 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7347 #ifdef DATAGRAM_SOCKETS
7348 memset (datagram_address, 0, sizeof datagram_address);
7349 #endif
7352 Lisp_Object subfeatures = Qnil;
7353 const struct socket_options *sopt;
7355 #define ADD_SUBFEATURE(key, val) \
7356 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7358 #ifdef NON_BLOCKING_CONNECT
7359 ADD_SUBFEATURE (QCnowait, Qt);
7360 #endif
7361 #ifdef DATAGRAM_SOCKETS
7362 ADD_SUBFEATURE (QCtype, Qdatagram);
7363 #endif
7364 #ifdef HAVE_SEQPACKET
7365 ADD_SUBFEATURE (QCtype, Qseqpacket);
7366 #endif
7367 #ifdef HAVE_LOCAL_SOCKETS
7368 ADD_SUBFEATURE (QCfamily, Qlocal);
7369 #endif
7370 ADD_SUBFEATURE (QCfamily, Qipv4);
7371 #ifdef AF_INET6
7372 ADD_SUBFEATURE (QCfamily, Qipv6);
7373 #endif
7374 #ifdef HAVE_GETSOCKNAME
7375 ADD_SUBFEATURE (QCservice, Qt);
7376 #endif
7377 #if defined (O_NONBLOCK) || defined (O_NDELAY)
7378 ADD_SUBFEATURE (QCserver, Qt);
7379 #endif
7381 for (sopt = socket_options; sopt->name; sopt++)
7382 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7384 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7387 #if defined (DARWIN_OS)
7388 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7389 processes. As such, we only change the default value. */
7390 if (initialized)
7392 char const *release = (STRINGP (Voperating_system_release)
7393 ? SSDATA (Voperating_system_release)
7394 : 0);
7395 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7396 Vprocess_connection_type = Qnil;
7399 #endif
7400 #endif /* subprocesses */
7401 kbd_is_on_hold = 0;
7404 void
7405 syms_of_process (void)
7407 #ifdef subprocesses
7409 DEFSYM (Qprocessp, "processp");
7410 DEFSYM (Qrun, "run");
7411 DEFSYM (Qstop, "stop");
7412 DEFSYM (Qsignal, "signal");
7414 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7415 here again.
7417 Qexit = intern_c_string ("exit");
7418 staticpro (&Qexit); */
7420 DEFSYM (Qopen, "open");
7421 DEFSYM (Qclosed, "closed");
7422 DEFSYM (Qconnect, "connect");
7423 DEFSYM (Qfailed, "failed");
7424 DEFSYM (Qlisten, "listen");
7425 DEFSYM (Qlocal, "local");
7426 DEFSYM (Qipv4, "ipv4");
7427 #ifdef AF_INET6
7428 DEFSYM (Qipv6, "ipv6");
7429 #endif
7430 DEFSYM (Qdatagram, "datagram");
7431 DEFSYM (Qseqpacket, "seqpacket");
7433 DEFSYM (QCport, ":port");
7434 DEFSYM (QCspeed, ":speed");
7435 DEFSYM (QCprocess, ":process");
7437 DEFSYM (QCbytesize, ":bytesize");
7438 DEFSYM (QCstopbits, ":stopbits");
7439 DEFSYM (QCparity, ":parity");
7440 DEFSYM (Qodd, "odd");
7441 DEFSYM (Qeven, "even");
7442 DEFSYM (QCflowcontrol, ":flowcontrol");
7443 DEFSYM (Qhw, "hw");
7444 DEFSYM (Qsw, "sw");
7445 DEFSYM (QCsummary, ":summary");
7447 DEFSYM (Qreal, "real");
7448 DEFSYM (Qnetwork, "network");
7449 DEFSYM (Qserial, "serial");
7450 DEFSYM (QCbuffer, ":buffer");
7451 DEFSYM (QChost, ":host");
7452 DEFSYM (QCservice, ":service");
7453 DEFSYM (QClocal, ":local");
7454 DEFSYM (QCremote, ":remote");
7455 DEFSYM (QCcoding, ":coding");
7456 DEFSYM (QCserver, ":server");
7457 DEFSYM (QCnowait, ":nowait");
7458 DEFSYM (QCsentinel, ":sentinel");
7459 DEFSYM (QClog, ":log");
7460 DEFSYM (QCnoquery, ":noquery");
7461 DEFSYM (QCstop, ":stop");
7462 DEFSYM (QCoptions, ":options");
7463 DEFSYM (QCplist, ":plist");
7465 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7467 staticpro (&Vprocess_alist);
7468 #ifdef SIGCHLD
7469 staticpro (&deleted_pid_list);
7470 #endif
7472 #endif /* subprocesses */
7474 DEFSYM (QCname, ":name");
7475 DEFSYM (QCtype, ":type");
7477 DEFSYM (Qeuid, "euid");
7478 DEFSYM (Qegid, "egid");
7479 DEFSYM (Quser, "user");
7480 DEFSYM (Qgroup, "group");
7481 DEFSYM (Qcomm, "comm");
7482 DEFSYM (Qstate, "state");
7483 DEFSYM (Qppid, "ppid");
7484 DEFSYM (Qpgrp, "pgrp");
7485 DEFSYM (Qsess, "sess");
7486 DEFSYM (Qttname, "ttname");
7487 DEFSYM (Qtpgid, "tpgid");
7488 DEFSYM (Qminflt, "minflt");
7489 DEFSYM (Qmajflt, "majflt");
7490 DEFSYM (Qcminflt, "cminflt");
7491 DEFSYM (Qcmajflt, "cmajflt");
7492 DEFSYM (Qutime, "utime");
7493 DEFSYM (Qstime, "stime");
7494 DEFSYM (Qtime, "time");
7495 DEFSYM (Qcutime, "cutime");
7496 DEFSYM (Qcstime, "cstime");
7497 DEFSYM (Qctime, "ctime");
7498 DEFSYM (Qpri, "pri");
7499 DEFSYM (Qnice, "nice");
7500 DEFSYM (Qthcount, "thcount");
7501 DEFSYM (Qstart, "start");
7502 DEFSYM (Qvsize, "vsize");
7503 DEFSYM (Qrss, "rss");
7504 DEFSYM (Qetime, "etime");
7505 DEFSYM (Qpcpu, "pcpu");
7506 DEFSYM (Qpmem, "pmem");
7507 DEFSYM (Qargs, "args");
7509 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7510 doc: /* Non-nil means delete processes immediately when they exit.
7511 A value of nil means don't delete them until `list-processes' is run. */);
7513 delete_exited_processes = 1;
7515 #ifdef subprocesses
7516 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7517 doc: /* Control type of device used to communicate with subprocesses.
7518 Values are nil to use a pipe, or t or `pty' to use a pty.
7519 The value has no effect if the system has no ptys or if all ptys are busy:
7520 then a pipe is used in any case.
7521 The value takes effect when `start-process' is called. */);
7522 Vprocess_connection_type = Qt;
7524 #ifdef ADAPTIVE_READ_BUFFERING
7525 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7526 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7527 On some systems, when Emacs reads the output from a subprocess, the output data
7528 is read in very small blocks, potentially resulting in very poor performance.
7529 This behavior can be remedied to some extent by setting this variable to a
7530 non-nil value, as it will automatically delay reading from such processes, to
7531 allow them to produce more output before Emacs tries to read it.
7532 If the value is t, the delay is reset after each write to the process; any other
7533 non-nil value means that the delay is not reset on write.
7534 The variable takes effect when `start-process' is called. */);
7535 Vprocess_adaptive_read_buffering = Qt;
7536 #endif
7538 defsubr (&Sprocessp);
7539 defsubr (&Sget_process);
7540 defsubr (&Sdelete_process);
7541 defsubr (&Sprocess_status);
7542 defsubr (&Sprocess_exit_status);
7543 defsubr (&Sprocess_id);
7544 defsubr (&Sprocess_name);
7545 defsubr (&Sprocess_tty_name);
7546 defsubr (&Sprocess_command);
7547 defsubr (&Sset_process_buffer);
7548 defsubr (&Sprocess_buffer);
7549 defsubr (&Sprocess_mark);
7550 defsubr (&Sset_process_filter);
7551 defsubr (&Sprocess_filter);
7552 defsubr (&Sset_process_sentinel);
7553 defsubr (&Sprocess_sentinel);
7554 defsubr (&Sset_process_window_size);
7555 defsubr (&Sset_process_inherit_coding_system_flag);
7556 defsubr (&Sset_process_query_on_exit_flag);
7557 defsubr (&Sprocess_query_on_exit_flag);
7558 defsubr (&Sprocess_contact);
7559 defsubr (&Sprocess_plist);
7560 defsubr (&Sset_process_plist);
7561 defsubr (&Sprocess_list);
7562 defsubr (&Sstart_process);
7563 defsubr (&Sserial_process_configure);
7564 defsubr (&Smake_serial_process);
7565 defsubr (&Sset_network_process_option);
7566 defsubr (&Smake_network_process);
7567 defsubr (&Sformat_network_address);
7568 #if defined (HAVE_NET_IF_H)
7569 #ifdef SIOCGIFCONF
7570 defsubr (&Snetwork_interface_list);
7571 #endif
7572 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
7573 defsubr (&Snetwork_interface_info);
7574 #endif
7575 #endif /* defined (HAVE_NET_IF_H) */
7576 #ifdef DATAGRAM_SOCKETS
7577 defsubr (&Sprocess_datagram_address);
7578 defsubr (&Sset_process_datagram_address);
7579 #endif
7580 defsubr (&Saccept_process_output);
7581 defsubr (&Sprocess_send_region);
7582 defsubr (&Sprocess_send_string);
7583 defsubr (&Sinterrupt_process);
7584 defsubr (&Skill_process);
7585 defsubr (&Squit_process);
7586 defsubr (&Sstop_process);
7587 defsubr (&Scontinue_process);
7588 defsubr (&Sprocess_running_child_p);
7589 defsubr (&Sprocess_send_eof);
7590 defsubr (&Ssignal_process);
7591 defsubr (&Swaiting_for_user_input_p);
7592 defsubr (&Sprocess_type);
7593 defsubr (&Sset_process_coding_system);
7594 defsubr (&Sprocess_coding_system);
7595 defsubr (&Sset_process_filter_multibyte);
7596 defsubr (&Sprocess_filter_multibyte_p);
7598 #endif /* subprocesses */
7600 defsubr (&Sget_buffer_process);
7601 defsubr (&Sprocess_inherit_coding_system_flag);
7602 defsubr (&Slist_system_processes);
7603 defsubr (&Sprocess_attributes);