* lisp/emacs-lisp/bytecomp.el (byte-compile): Fix handling of closures.
[emacs.git] / src / process.c
blob0036ce595f5356e18e2223324599fd7aaa5896c9
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 #ifdef WINDOWSNT
129 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
130 EMACS_TIME *, void *);
131 #endif
133 /* Work around GCC 4.7.0 bug with strict overflow checking; see
134 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
135 These lines can be removed once the GCC bug is fixed. */
136 #if (__GNUC__ == 4 && 3 <= __GNUC_MINOR__) || 4 < __GNUC__
137 # pragma GCC diagnostic ignored "-Wstrict-overflow"
138 #endif
140 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
141 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
142 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
143 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
144 Lisp_Object QCname, QCtype;
146 /* Non-zero if keyboard input is on hold, zero otherwise. */
148 static int kbd_is_on_hold;
150 /* Nonzero means don't run process sentinels. This is used
151 when exiting. */
152 int inhibit_sentinels;
154 #ifdef subprocesses
156 Lisp_Object Qprocessp;
157 static Lisp_Object Qrun, Qstop, Qsignal;
158 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
159 Lisp_Object Qlocal;
160 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
161 static Lisp_Object Qreal, Qnetwork, Qserial;
162 #ifdef AF_INET6
163 static Lisp_Object Qipv6;
164 #endif
165 static Lisp_Object QCport, QCprocess;
166 Lisp_Object QCspeed;
167 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
168 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
169 static Lisp_Object QCbuffer, QChost, QCservice;
170 static Lisp_Object QClocal, QCremote, QCcoding;
171 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
172 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
173 static Lisp_Object Qlast_nonmenu_event;
175 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
176 #define NETCONN1_P(p) (EQ (p->type, Qnetwork))
177 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
178 #define SERIALCONN1_P(p) (EQ (p->type, Qserial))
180 #ifndef HAVE_H_ERRNO
181 extern int h_errno;
182 #endif
184 /* Number of events of change of status of a process. */
185 static EMACS_INT process_tick;
186 /* Number of events for which the user or sentinel has been notified. */
187 static EMACS_INT update_tick;
189 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
191 /* Only W32 has this, it really means that select can't take write mask. */
192 #ifdef BROKEN_NON_BLOCKING_CONNECT
193 #undef NON_BLOCKING_CONNECT
194 #define SELECT_CANT_DO_WRITE_MASK
195 #else
196 #ifndef NON_BLOCKING_CONNECT
197 #ifdef HAVE_SELECT
198 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
199 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
200 #define NON_BLOCKING_CONNECT
201 #endif /* EWOULDBLOCK || EINPROGRESS */
202 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
203 #endif /* HAVE_SELECT */
204 #endif /* NON_BLOCKING_CONNECT */
205 #endif /* BROKEN_NON_BLOCKING_CONNECT */
207 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
208 this system. We need to read full packets, so we need a
209 "non-destructive" select. So we require either native select,
210 or emulation of select using FIONREAD. */
212 #ifndef BROKEN_DATAGRAM_SOCKETS
213 # if defined HAVE_SELECT || defined USABLE_FIONREAD
214 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
215 # define DATAGRAM_SOCKETS
216 # endif
217 # endif
218 #endif
220 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
221 # define HAVE_SEQPACKET
222 #endif
224 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
225 #define ADAPTIVE_READ_BUFFERING
226 #endif
228 #ifdef ADAPTIVE_READ_BUFFERING
229 #define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
230 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
231 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
233 /* Number of processes which have a non-zero read_output_delay,
234 and therefore might be delayed for adaptive read buffering. */
236 static int process_output_delay_count;
238 /* Non-zero if any process has non-nil read_output_skip. */
240 static int process_output_skip;
242 #else
243 #define process_output_delay_count 0
244 #endif
246 static void create_process (Lisp_Object, char **, Lisp_Object);
247 #ifdef USABLE_SIGIO
248 static int keyboard_bit_set (SELECT_TYPE *);
249 #endif
250 static void deactivate_process (Lisp_Object);
251 static void status_notify (struct Lisp_Process *);
252 static int read_process_output (Lisp_Object, int);
253 static void handle_child_signal (int);
254 static void create_pty (Lisp_Object);
256 /* If we support a window system, turn on the code to poll periodically
257 to detect C-g. It isn't actually used when doing interrupt input. */
258 #ifdef HAVE_WINDOW_SYSTEM
259 #define POLL_FOR_INPUT
260 #endif
262 static Lisp_Object get_process (register Lisp_Object name);
263 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
265 /* Mask of bits indicating the descriptors that we wait for input on. */
267 static SELECT_TYPE input_wait_mask;
269 /* Mask that excludes keyboard input descriptor(s). */
271 static SELECT_TYPE non_keyboard_wait_mask;
273 /* Mask that excludes process input descriptor(s). */
275 static SELECT_TYPE non_process_wait_mask;
277 /* Mask for selecting for write. */
279 static SELECT_TYPE write_mask;
281 #ifdef NON_BLOCKING_CONNECT
282 /* Mask of bits indicating the descriptors that we wait for connect to
283 complete on. Once they complete, they are removed from this mask
284 and added to the input_wait_mask and non_keyboard_wait_mask. */
286 static SELECT_TYPE connect_wait_mask;
288 /* Number of bits set in connect_wait_mask. */
289 static int num_pending_connects;
290 #endif /* NON_BLOCKING_CONNECT */
292 /* The largest descriptor currently in use for a process object. */
293 static int max_process_desc;
295 /* The largest descriptor currently in use for input. */
296 static int max_input_desc;
298 /* Indexed by descriptor, gives the process (if any) for that descriptor */
299 static Lisp_Object chan_process[MAXDESC];
301 /* Alist of elements (NAME . PROCESS) */
302 static Lisp_Object Vprocess_alist;
304 /* Buffered-ahead input char from process, indexed by channel.
305 -1 means empty (no char is buffered).
306 Used on sys V where the only way to tell if there is any
307 output from the process is to read at least one char.
308 Always -1 on systems that support FIONREAD. */
310 static int proc_buffered_char[MAXDESC];
312 /* Table of `struct coding-system' for each process. */
313 static struct coding_system *proc_decode_coding_system[MAXDESC];
314 static struct coding_system *proc_encode_coding_system[MAXDESC];
316 #ifdef DATAGRAM_SOCKETS
317 /* Table of `partner address' for datagram sockets. */
318 static struct sockaddr_and_len {
319 struct sockaddr *sa;
320 int len;
321 } datagram_address[MAXDESC];
322 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
323 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
324 #else
325 #define DATAGRAM_CHAN_P(chan) (0)
326 #define DATAGRAM_CONN_P(proc) (0)
327 #endif
329 /* These setters are used only in this file, so they can be private. */
330 static void
331 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
333 p->buffer = val;
335 static void
336 pset_command (struct Lisp_Process *p, Lisp_Object val)
338 p->command = val;
340 static void
341 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
343 p->decode_coding_system = val;
345 static void
346 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
348 p->decoding_buf = val;
350 static void
351 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
353 p->encode_coding_system = val;
355 static void
356 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
358 p->encoding_buf = val;
360 static void
361 pset_filter (struct Lisp_Process *p, Lisp_Object val)
363 p->filter = val;
365 static void
366 pset_log (struct Lisp_Process *p, Lisp_Object val)
368 p->log = val;
370 static void
371 pset_mark (struct Lisp_Process *p, Lisp_Object val)
373 p->mark = val;
375 static void
376 pset_name (struct Lisp_Process *p, Lisp_Object val)
378 p->name = val;
380 static void
381 pset_plist (struct Lisp_Process *p, Lisp_Object val)
383 p->plist = val;
385 static void
386 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
388 p->sentinel = val;
390 static void
391 pset_status (struct Lisp_Process *p, Lisp_Object val)
393 p->status = val;
395 static void
396 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
398 p->tty_name = val;
400 static void
401 pset_type (struct Lisp_Process *p, Lisp_Object val)
403 p->type = val;
405 static void
406 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
408 p->write_queue = val;
413 static struct fd_callback_data
415 fd_callback func;
416 void *data;
417 #define FOR_READ 1
418 #define FOR_WRITE 2
419 int condition; /* mask of the defines above. */
420 } fd_callback_info[MAXDESC];
423 /* Add a file descriptor FD to be monitored for when read is possible.
424 When read is possible, call FUNC with argument DATA. */
426 void
427 add_read_fd (int fd, fd_callback func, void *data)
429 eassert (fd < MAXDESC);
430 add_keyboard_wait_descriptor (fd);
432 fd_callback_info[fd].func = func;
433 fd_callback_info[fd].data = data;
434 fd_callback_info[fd].condition |= FOR_READ;
437 /* Stop monitoring file descriptor FD for when read is possible. */
439 void
440 delete_read_fd (int fd)
442 eassert (fd < MAXDESC);
443 delete_keyboard_wait_descriptor (fd);
445 fd_callback_info[fd].condition &= ~FOR_READ;
446 if (fd_callback_info[fd].condition == 0)
448 fd_callback_info[fd].func = 0;
449 fd_callback_info[fd].data = 0;
453 /* Add a file descriptor FD to be monitored for when write is possible.
454 When write is possible, call FUNC with argument DATA. */
456 void
457 add_write_fd (int fd, fd_callback func, void *data)
459 eassert (fd < MAXDESC);
460 FD_SET (fd, &write_mask);
461 if (fd > max_input_desc)
462 max_input_desc = fd;
464 fd_callback_info[fd].func = func;
465 fd_callback_info[fd].data = data;
466 fd_callback_info[fd].condition |= FOR_WRITE;
469 /* Stop monitoring file descriptor FD for when write is possible. */
471 void
472 delete_write_fd (int fd)
474 int lim = max_input_desc;
476 eassert (fd < MAXDESC);
477 FD_CLR (fd, &write_mask);
478 fd_callback_info[fd].condition &= ~FOR_WRITE;
479 if (fd_callback_info[fd].condition == 0)
481 fd_callback_info[fd].func = 0;
482 fd_callback_info[fd].data = 0;
484 if (fd == max_input_desc)
485 for (fd = lim; fd >= 0; fd--)
486 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
488 max_input_desc = fd;
489 break;
496 /* Compute the Lisp form of the process status, p->status, from
497 the numeric status that was returned by `wait'. */
499 static Lisp_Object status_convert (int);
501 static void
502 update_status (struct Lisp_Process *p)
504 eassert (p->raw_status_new);
505 pset_status (p, status_convert (p->raw_status));
506 p->raw_status_new = 0;
509 /* Convert a process status word in Unix format to
510 the list that we use internally. */
512 static Lisp_Object
513 status_convert (int w)
515 if (WIFSTOPPED (w))
516 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
517 else if (WIFEXITED (w))
518 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
519 WCOREDUMP (w) ? Qt : Qnil));
520 else if (WIFSIGNALED (w))
521 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
522 WCOREDUMP (w) ? Qt : Qnil));
523 else
524 return Qrun;
527 /* Given a status-list, extract the three pieces of information
528 and store them individually through the three pointers. */
530 static void
531 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
533 Lisp_Object tem;
535 if (SYMBOLP (l))
537 *symbol = l;
538 *code = 0;
539 *coredump = 0;
541 else
543 *symbol = XCAR (l);
544 tem = XCDR (l);
545 *code = XFASTINT (XCAR (tem));
546 tem = XCDR (tem);
547 *coredump = !NILP (tem);
551 /* Return a string describing a process status list. */
553 static Lisp_Object
554 status_message (struct Lisp_Process *p)
556 Lisp_Object status = p->status;
557 Lisp_Object symbol;
558 int code, coredump;
559 Lisp_Object string, string2;
561 decode_status (status, &symbol, &code, &coredump);
563 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
565 char const *signame;
566 synchronize_system_messages_locale ();
567 signame = strsignal (code);
568 if (signame == 0)
569 string = build_string ("unknown");
570 else
572 int c1, c2;
574 string = build_unibyte_string (signame);
575 if (! NILP (Vlocale_coding_system))
576 string = (code_convert_string_norecord
577 (string, Vlocale_coding_system, 0));
578 c1 = STRING_CHAR (SDATA (string));
579 c2 = downcase (c1);
580 if (c1 != c2)
581 Faset (string, make_number (0), make_number (c2));
583 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
584 return concat2 (string, string2);
586 else if (EQ (symbol, Qexit))
588 if (NETCONN1_P (p))
589 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
590 if (code == 0)
591 return build_string ("finished\n");
592 string = Fnumber_to_string (make_number (code));
593 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
594 return concat3 (build_string ("exited abnormally with code "),
595 string, string2);
597 else if (EQ (symbol, Qfailed))
599 string = Fnumber_to_string (make_number (code));
600 string2 = build_string ("\n");
601 return concat3 (build_string ("failed with code "),
602 string, string2);
604 else
605 return Fcopy_sequence (Fsymbol_name (symbol));
608 #ifdef HAVE_PTYS
610 /* The file name of the pty opened by allocate_pty. */
611 static char pty_name[24];
613 /* Open an available pty, returning a file descriptor.
614 Return -1 on failure.
615 The file name of the terminal corresponding to the pty
616 is left in the variable pty_name. */
618 static int
619 allocate_pty (void)
621 int fd;
623 #ifdef PTY_ITERATION
624 PTY_ITERATION
625 #else
626 register int c, i;
627 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
628 for (i = 0; i < 16; i++)
629 #endif
631 #ifdef PTY_NAME_SPRINTF
632 PTY_NAME_SPRINTF
633 #else
634 sprintf (pty_name, "/dev/pty%c%x", c, i);
635 #endif /* no PTY_NAME_SPRINTF */
637 #ifdef PTY_OPEN
638 PTY_OPEN;
639 #else /* no PTY_OPEN */
640 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
641 #endif /* no PTY_OPEN */
643 if (fd >= 0)
645 /* check to make certain that both sides are available
646 this avoids a nasty yet stupid bug in rlogins */
647 #ifdef PTY_TTY_NAME_SPRINTF
648 PTY_TTY_NAME_SPRINTF
649 #else
650 sprintf (pty_name, "/dev/tty%c%x", c, i);
651 #endif /* no PTY_TTY_NAME_SPRINTF */
652 if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
654 emacs_close (fd);
655 # ifndef __sgi
656 continue;
657 # else
658 return -1;
659 # endif /* __sgi */
661 setup_pty (fd);
662 return fd;
665 return -1;
667 #endif /* HAVE_PTYS */
669 static Lisp_Object
670 make_process (Lisp_Object name)
672 register Lisp_Object val, tem, name1;
673 register struct Lisp_Process *p;
674 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
675 printmax_t i;
677 p = allocate_process ();
678 /* Initialize Lisp data. Note that allocate_process initializes all
679 Lisp data to nil, so do it only for slots which should not be nil. */
680 pset_status (p, Qrun);
681 pset_mark (p, Fmake_marker ());
683 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
684 non-Lisp data, so do it only for slots which should not be zero. */
685 p->infd = -1;
686 p->outfd = -1;
688 #ifdef HAVE_GNUTLS
689 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
690 #endif
692 /* If name is already in use, modify it until it is unused. */
694 name1 = name;
695 for (i = 1; ; i++)
697 tem = Fget_process (name1);
698 if (NILP (tem)) break;
699 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
701 name = name1;
702 pset_name (p, name);
703 XSETPROCESS (val, p);
704 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
705 return val;
708 static void
709 remove_process (register Lisp_Object proc)
711 register Lisp_Object pair;
713 pair = Frassq (proc, Vprocess_alist);
714 Vprocess_alist = Fdelq (pair, Vprocess_alist);
716 deactivate_process (proc);
720 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
721 doc: /* Return t if OBJECT is a process. */)
722 (Lisp_Object object)
724 return PROCESSP (object) ? Qt : Qnil;
727 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
728 doc: /* Return the process named NAME, or nil if there is none. */)
729 (register Lisp_Object name)
731 if (PROCESSP (name))
732 return name;
733 CHECK_STRING (name);
734 return Fcdr (Fassoc (name, Vprocess_alist));
737 /* This is how commands for the user decode process arguments. It
738 accepts a process, a process name, a buffer, a buffer name, or nil.
739 Buffers denote the first process in the buffer, and nil denotes the
740 current buffer. */
742 static Lisp_Object
743 get_process (register Lisp_Object name)
745 register Lisp_Object proc, obj;
746 if (STRINGP (name))
748 obj = Fget_process (name);
749 if (NILP (obj))
750 obj = Fget_buffer (name);
751 if (NILP (obj))
752 error ("Process %s does not exist", SDATA (name));
754 else if (NILP (name))
755 obj = Fcurrent_buffer ();
756 else
757 obj = name;
759 /* Now obj should be either a buffer object or a process object.
761 if (BUFFERP (obj))
763 proc = Fget_buffer_process (obj);
764 if (NILP (proc))
765 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
767 else
769 CHECK_PROCESS (obj);
770 proc = obj;
772 return proc;
776 #ifdef SIGCHLD
777 /* Fdelete_process promises to immediately forget about the process, but in
778 reality, Emacs needs to remember those processes until they have been
779 treated by the SIGCHLD handler and waitpid has been invoked on them;
780 otherwise they might fill up the kernel's process table. */
781 static Lisp_Object deleted_pid_list;
782 #endif
784 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
785 doc: /* Delete PROCESS: kill it and forget about it immediately.
786 PROCESS may be a process, a buffer, the name of a process or buffer, or
787 nil, indicating the current buffer's process. */)
788 (register Lisp_Object process)
790 register struct Lisp_Process *p;
792 process = get_process (process);
793 p = XPROCESS (process);
795 p->raw_status_new = 0;
796 if (NETCONN1_P (p) || SERIALCONN1_P (p))
798 pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
799 p->tick = ++process_tick;
800 status_notify (p);
801 redisplay_preserve_echo_area (13);
803 else if (p->infd >= 0)
805 #ifdef SIGCHLD
806 Lisp_Object symbol;
807 pid_t pid = p->pid;
809 /* No problem storing the pid here, as it is still in Vprocess_alist. */
810 deleted_pid_list = Fcons (make_fixnum_or_float (pid),
811 /* GC treated elements set to nil. */
812 Fdelq (Qnil, deleted_pid_list));
813 /* If the process has already signaled, remove it from the list. */
814 if (p->raw_status_new)
815 update_status (p);
816 symbol = p->status;
817 if (CONSP (p->status))
818 symbol = XCAR (p->status);
819 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
820 deleted_pid_list
821 = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
822 else
823 #endif
825 Fkill_process (process, Qnil);
826 /* Do this now, since remove_process will make the
827 SIGCHLD handler do nothing. */
828 pset_status (p, Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil)));
829 p->tick = ++process_tick;
830 status_notify (p);
831 redisplay_preserve_echo_area (13);
834 remove_process (process);
835 return Qnil;
838 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
839 doc: /* Return the status of PROCESS.
840 The returned value is one of the following symbols:
841 run -- for a process that is running.
842 stop -- for a process stopped but continuable.
843 exit -- for a process that has exited.
844 signal -- for a process that has got a fatal signal.
845 open -- for a network stream connection that is open.
846 listen -- for a network stream server that is listening.
847 closed -- for a network stream connection that is closed.
848 connect -- when waiting for a non-blocking connection to complete.
849 failed -- when a non-blocking connection has failed.
850 nil -- if arg is a process name and no such process exists.
851 PROCESS may be a process, a buffer, the name of a process, or
852 nil, indicating the current buffer's process. */)
853 (register Lisp_Object process)
855 register struct Lisp_Process *p;
856 register Lisp_Object status;
858 if (STRINGP (process))
859 process = Fget_process (process);
860 else
861 process = get_process (process);
863 if (NILP (process))
864 return process;
866 p = XPROCESS (process);
867 if (p->raw_status_new)
868 update_status (p);
869 status = p->status;
870 if (CONSP (status))
871 status = XCAR (status);
872 if (NETCONN1_P (p) || SERIALCONN1_P (p))
874 if (EQ (status, Qexit))
875 status = Qclosed;
876 else if (EQ (p->command, Qt))
877 status = Qstop;
878 else if (EQ (status, Qrun))
879 status = Qopen;
881 return status;
884 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
885 1, 1, 0,
886 doc: /* Return the exit status of PROCESS or the signal number that killed it.
887 If PROCESS has not yet exited or died, return 0. */)
888 (register Lisp_Object process)
890 CHECK_PROCESS (process);
891 if (XPROCESS (process)->raw_status_new)
892 update_status (XPROCESS (process));
893 if (CONSP (XPROCESS (process)->status))
894 return XCAR (XCDR (XPROCESS (process)->status));
895 return make_number (0);
898 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
899 doc: /* Return the process id of PROCESS.
900 This is the pid of the external process which PROCESS uses or talks to.
901 For a network connection, this value is nil. */)
902 (register Lisp_Object process)
904 pid_t pid;
906 CHECK_PROCESS (process);
907 pid = XPROCESS (process)->pid;
908 return (pid ? make_fixnum_or_float (pid) : Qnil);
911 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
912 doc: /* Return the name of PROCESS, as a string.
913 This is the name of the program invoked in PROCESS,
914 possibly modified to make it unique among process names. */)
915 (register Lisp_Object process)
917 CHECK_PROCESS (process);
918 return XPROCESS (process)->name;
921 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
922 doc: /* Return the command that was executed to start PROCESS.
923 This is a list of strings, the first string being the program executed
924 and the rest of the strings being the arguments given to it.
925 For a network or serial process, this is nil (process is running) or t
926 \(process is stopped). */)
927 (register Lisp_Object process)
929 CHECK_PROCESS (process);
930 return XPROCESS (process)->command;
933 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
934 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
935 This is the terminal that the process itself reads and writes on,
936 not the name of the pty that Emacs uses to talk with that terminal. */)
937 (register Lisp_Object process)
939 CHECK_PROCESS (process);
940 return XPROCESS (process)->tty_name;
943 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
944 2, 2, 0,
945 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
946 Return BUFFER. */)
947 (register Lisp_Object process, Lisp_Object buffer)
949 struct Lisp_Process *p;
951 CHECK_PROCESS (process);
952 if (!NILP (buffer))
953 CHECK_BUFFER (buffer);
954 p = XPROCESS (process);
955 pset_buffer (p, buffer);
956 if (NETCONN1_P (p) || SERIALCONN1_P (p))
957 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
958 setup_process_coding_systems (process);
959 return buffer;
962 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
963 1, 1, 0,
964 doc: /* Return the buffer PROCESS is associated with.
965 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
966 (register Lisp_Object process)
968 CHECK_PROCESS (process);
969 return XPROCESS (process)->buffer;
972 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
973 1, 1, 0,
974 doc: /* Return the marker for the end of the last output from PROCESS. */)
975 (register Lisp_Object process)
977 CHECK_PROCESS (process);
978 return XPROCESS (process)->mark;
981 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
982 2, 2, 0,
983 doc: /* Give PROCESS the filter function FILTER; nil means no filter.
984 A value of t means stop accepting output from the process.
986 When a process has a filter, its buffer is not used for output.
987 Instead, each time it does output, the entire string of output is
988 passed to the filter.
990 The filter gets two arguments: the process and the string of output.
991 The string argument is normally a multibyte string, except:
992 - if the process' input coding system is no-conversion or raw-text,
993 it is a unibyte string (the non-converted input), or else
994 - if `default-enable-multibyte-characters' is nil, it is a unibyte
995 string (the result of converting the decoded input multibyte
996 string to unibyte with `string-make-unibyte'). */)
997 (register Lisp_Object process, Lisp_Object filter)
999 struct Lisp_Process *p;
1001 CHECK_PROCESS (process);
1002 p = XPROCESS (process);
1004 /* Don't signal an error if the process' input file descriptor
1005 is closed. This could make debugging Lisp more difficult,
1006 for example when doing something like
1008 (setq process (start-process ...))
1009 (debug)
1010 (set-process-filter process ...) */
1012 if (p->infd >= 0)
1014 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1016 FD_CLR (p->infd, &input_wait_mask);
1017 FD_CLR (p->infd, &non_keyboard_wait_mask);
1019 else if (EQ (p->filter, Qt)
1020 /* Network or serial process not stopped: */
1021 && !EQ (p->command, Qt))
1023 FD_SET (p->infd, &input_wait_mask);
1024 FD_SET (p->infd, &non_keyboard_wait_mask);
1028 pset_filter (p, filter);
1029 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1030 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1031 setup_process_coding_systems (process);
1032 return filter;
1035 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1036 1, 1, 0,
1037 doc: /* Returns the filter function of PROCESS; nil if none.
1038 See `set-process-filter' for more info on filter functions. */)
1039 (register Lisp_Object process)
1041 CHECK_PROCESS (process);
1042 return XPROCESS (process)->filter;
1045 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1046 2, 2, 0,
1047 doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
1048 The sentinel is called as a function when the process changes state.
1049 It gets two arguments: the process, and a string describing the change. */)
1050 (register Lisp_Object process, Lisp_Object sentinel)
1052 struct Lisp_Process *p;
1054 CHECK_PROCESS (process);
1055 p = XPROCESS (process);
1057 pset_sentinel (p, sentinel);
1058 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1059 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1060 return sentinel;
1063 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1064 1, 1, 0,
1065 doc: /* Return the sentinel of PROCESS; nil if none.
1066 See `set-process-sentinel' for more info on sentinels. */)
1067 (register Lisp_Object process)
1069 CHECK_PROCESS (process);
1070 return XPROCESS (process)->sentinel;
1073 DEFUN ("set-process-window-size", Fset_process_window_size,
1074 Sset_process_window_size, 3, 3, 0,
1075 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1076 (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1078 CHECK_PROCESS (process);
1079 CHECK_RANGED_INTEGER (height, 0, INT_MAX);
1080 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
1082 if (XPROCESS (process)->infd < 0
1083 || set_window_size (XPROCESS (process)->infd,
1084 XINT (height), XINT (width)) <= 0)
1085 return Qnil;
1086 else
1087 return Qt;
1090 DEFUN ("set-process-inherit-coding-system-flag",
1091 Fset_process_inherit_coding_system_flag,
1092 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1093 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1094 If the second argument FLAG is non-nil, then the variable
1095 `buffer-file-coding-system' of the buffer associated with PROCESS
1096 will be bound to the value of the coding system used to decode
1097 the process output.
1099 This is useful when the coding system specified for the process buffer
1100 leaves either the character code conversion or the end-of-line conversion
1101 unspecified, or if the coding system used to decode the process output
1102 is more appropriate for saving the process buffer.
1104 Binding the variable `inherit-process-coding-system' to non-nil before
1105 starting the process is an alternative way of setting the inherit flag
1106 for the process which will run.
1108 This function returns FLAG. */)
1109 (register Lisp_Object process, Lisp_Object flag)
1111 CHECK_PROCESS (process);
1112 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1113 return flag;
1116 DEFUN ("set-process-query-on-exit-flag",
1117 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1118 2, 2, 0,
1119 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1120 If the second argument FLAG is non-nil, Emacs will query the user before
1121 exiting or killing a buffer if PROCESS is running. This function
1122 returns FLAG. */)
1123 (register Lisp_Object process, Lisp_Object flag)
1125 CHECK_PROCESS (process);
1126 XPROCESS (process)->kill_without_query = NILP (flag);
1127 return flag;
1130 DEFUN ("process-query-on-exit-flag",
1131 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1132 1, 1, 0,
1133 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1134 (register Lisp_Object process)
1136 CHECK_PROCESS (process);
1137 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1140 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1141 1, 2, 0,
1142 doc: /* Return the contact info of PROCESS; t for a real child.
1143 For a network or serial connection, the value depends on the optional
1144 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1145 SERVICE) for a network connection or (PORT SPEED) for a serial
1146 connection. If KEY is t, the complete contact information for the
1147 connection is returned, else the specific value for the keyword KEY is
1148 returned. See `make-network-process' or `make-serial-process' for a
1149 list of keywords. */)
1150 (register Lisp_Object process, Lisp_Object key)
1152 Lisp_Object contact;
1154 CHECK_PROCESS (process);
1155 contact = XPROCESS (process)->childp;
1157 #ifdef DATAGRAM_SOCKETS
1158 if (DATAGRAM_CONN_P (process)
1159 && (EQ (key, Qt) || EQ (key, QCremote)))
1160 contact = Fplist_put (contact, QCremote,
1161 Fprocess_datagram_address (process));
1162 #endif
1164 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1165 return contact;
1166 if (NILP (key) && NETCONN_P (process))
1167 return Fcons (Fplist_get (contact, QChost),
1168 Fcons (Fplist_get (contact, QCservice), Qnil));
1169 if (NILP (key) && SERIALCONN_P (process))
1170 return Fcons (Fplist_get (contact, QCport),
1171 Fcons (Fplist_get (contact, QCspeed), Qnil));
1172 return Fplist_get (contact, key);
1175 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1176 1, 1, 0,
1177 doc: /* Return the plist of PROCESS. */)
1178 (register Lisp_Object process)
1180 CHECK_PROCESS (process);
1181 return XPROCESS (process)->plist;
1184 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1185 2, 2, 0,
1186 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1187 (register Lisp_Object process, Lisp_Object plist)
1189 CHECK_PROCESS (process);
1190 CHECK_LIST (plist);
1192 pset_plist (XPROCESS (process), plist);
1193 return plist;
1196 #if 0 /* Turned off because we don't currently record this info
1197 in the process. Perhaps add it. */
1198 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1199 doc: /* Return the connection type of PROCESS.
1200 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1201 a socket connection. */)
1202 (Lisp_Object process)
1204 return XPROCESS (process)->type;
1206 #endif
1208 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1209 doc: /* Return the connection type of PROCESS.
1210 The value is either the symbol `real', `network', or `serial'.
1211 PROCESS may be a process, a buffer, the name of a process or buffer, or
1212 nil, indicating the current buffer's process. */)
1213 (Lisp_Object process)
1215 Lisp_Object proc;
1216 proc = get_process (process);
1217 return XPROCESS (proc)->type;
1220 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1221 1, 2, 0,
1222 doc: /* Convert network ADDRESS from internal format to a string.
1223 A 4 or 5 element vector represents an IPv4 address (with port number).
1224 An 8 or 9 element vector represents an IPv6 address (with port number).
1225 If optional second argument OMIT-PORT is non-nil, don't include a port
1226 number in the string, even when present in ADDRESS.
1227 Returns nil if format of ADDRESS is invalid. */)
1228 (Lisp_Object address, Lisp_Object omit_port)
1230 if (NILP (address))
1231 return Qnil;
1233 if (STRINGP (address)) /* AF_LOCAL */
1234 return address;
1236 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1238 register struct Lisp_Vector *p = XVECTOR (address);
1239 ptrdiff_t size = p->header.size;
1240 Lisp_Object args[10];
1241 int nargs, i;
1243 if (size == 4 || (size == 5 && !NILP (omit_port)))
1245 args[0] = build_string ("%d.%d.%d.%d");
1246 nargs = 4;
1248 else if (size == 5)
1250 args[0] = build_string ("%d.%d.%d.%d:%d");
1251 nargs = 5;
1253 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1255 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1256 nargs = 8;
1258 else if (size == 9)
1260 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1261 nargs = 9;
1263 else
1264 return Qnil;
1266 for (i = 0; i < nargs; i++)
1268 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1269 return Qnil;
1271 if (nargs <= 5 /* IPv4 */
1272 && i < 4 /* host, not port */
1273 && XINT (p->contents[i]) > 255)
1274 return Qnil;
1276 args[i+1] = p->contents[i];
1279 return Fformat (nargs+1, args);
1282 if (CONSP (address))
1284 Lisp_Object args[2];
1285 args[0] = build_string ("<Family %d>");
1286 args[1] = Fcar (address);
1287 return Fformat (2, args);
1290 return Qnil;
1293 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1294 doc: /* Return a list of all processes. */)
1295 (void)
1297 return Fmapcar (Qcdr, Vprocess_alist);
1300 /* Starting asynchronous inferior processes. */
1302 static Lisp_Object start_process_unwind (Lisp_Object proc);
1304 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1305 doc: /* Start a program in a subprocess. Return the process object for it.
1306 NAME is name for process. It is modified if necessary to make it unique.
1307 BUFFER is the buffer (or buffer name) to associate with the process.
1309 Process output (both standard output and standard error streams) goes
1310 at end of BUFFER, unless you specify an output stream or filter
1311 function to handle the output. BUFFER may also be nil, meaning that
1312 this process is not associated with any buffer.
1314 PROGRAM is the program file name. It is searched for in `exec-path'
1315 (which see). If nil, just associate a pty with the buffer. Remaining
1316 arguments are strings to give program as arguments.
1318 If you want to separate standard output from standard error, invoke
1319 the command through a shell and redirect one of them using the shell
1320 syntax.
1322 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1323 (ptrdiff_t nargs, Lisp_Object *args)
1325 Lisp_Object buffer, name, program, proc, current_dir, tem;
1326 register unsigned char **new_argv;
1327 ptrdiff_t i;
1328 ptrdiff_t count = SPECPDL_INDEX ();
1330 buffer = args[1];
1331 if (!NILP (buffer))
1332 buffer = Fget_buffer_create (buffer);
1334 /* Make sure that the child will be able to chdir to the current
1335 buffer's current directory, or its unhandled equivalent. We
1336 can't just have the child check for an error when it does the
1337 chdir, since it's in a vfork.
1339 We have to GCPRO around this because Fexpand_file_name and
1340 Funhandled_file_name_directory might call a file name handling
1341 function. The argument list is protected by the caller, so all
1342 we really have to worry about is buffer. */
1344 struct gcpro gcpro1, gcpro2;
1346 current_dir = BVAR (current_buffer, directory);
1348 GCPRO2 (buffer, current_dir);
1350 current_dir = Funhandled_file_name_directory (current_dir);
1351 if (NILP (current_dir))
1352 /* If the file name handler says that current_dir is unreachable, use
1353 a sensible default. */
1354 current_dir = build_string ("~/");
1355 current_dir = expand_and_dir_to_file (current_dir, Qnil);
1356 if (NILP (Ffile_accessible_directory_p (current_dir)))
1357 report_file_error ("Setting current directory",
1358 Fcons (BVAR (current_buffer, directory), Qnil));
1360 UNGCPRO;
1363 name = args[0];
1364 CHECK_STRING (name);
1366 program = args[2];
1368 if (!NILP (program))
1369 CHECK_STRING (program);
1371 proc = make_process (name);
1372 /* If an error occurs and we can't start the process, we want to
1373 remove it from the process list. This means that each error
1374 check in create_process doesn't need to call remove_process
1375 itself; it's all taken care of here. */
1376 record_unwind_protect (start_process_unwind, proc);
1378 pset_childp (XPROCESS (proc), Qt);
1379 pset_plist (XPROCESS (proc), Qnil);
1380 pset_type (XPROCESS (proc), Qreal);
1381 pset_buffer (XPROCESS (proc), buffer);
1382 pset_sentinel (XPROCESS (proc), Qnil);
1383 pset_filter (XPROCESS (proc), Qnil);
1384 pset_command (XPROCESS (proc), Flist (nargs - 2, args + 2));
1386 #ifdef HAVE_GNUTLS
1387 /* AKA GNUTLS_INITSTAGE(proc). */
1388 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1389 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1390 #endif
1392 #ifdef ADAPTIVE_READ_BUFFERING
1393 XPROCESS (proc)->adaptive_read_buffering
1394 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1395 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1396 #endif
1398 /* Make the process marker point into the process buffer (if any). */
1399 if (BUFFERP (buffer))
1400 set_marker_both (XPROCESS (proc)->mark, buffer,
1401 BUF_ZV (XBUFFER (buffer)),
1402 BUF_ZV_BYTE (XBUFFER (buffer)));
1405 /* Decide coding systems for communicating with the process. Here
1406 we don't setup the structure coding_system nor pay attention to
1407 unibyte mode. They are done in create_process. */
1409 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1410 Lisp_Object coding_systems = Qt;
1411 Lisp_Object val, *args2;
1412 struct gcpro gcpro1, gcpro2;
1414 val = Vcoding_system_for_read;
1415 if (NILP (val))
1417 args2 = alloca ((nargs + 1) * sizeof *args2);
1418 args2[0] = Qstart_process;
1419 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1420 GCPRO2 (proc, current_dir);
1421 if (!NILP (program))
1422 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1423 UNGCPRO;
1424 if (CONSP (coding_systems))
1425 val = XCAR (coding_systems);
1426 else if (CONSP (Vdefault_process_coding_system))
1427 val = XCAR (Vdefault_process_coding_system);
1429 pset_decode_coding_system (XPROCESS (proc), val);
1431 val = Vcoding_system_for_write;
1432 if (NILP (val))
1434 if (EQ (coding_systems, Qt))
1436 args2 = alloca ((nargs + 1) * sizeof *args2);
1437 args2[0] = Qstart_process;
1438 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1439 GCPRO2 (proc, current_dir);
1440 if (!NILP (program))
1441 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1442 UNGCPRO;
1444 if (CONSP (coding_systems))
1445 val = XCDR (coding_systems);
1446 else if (CONSP (Vdefault_process_coding_system))
1447 val = XCDR (Vdefault_process_coding_system);
1449 pset_encode_coding_system (XPROCESS (proc), val);
1450 /* Note: At this moment, the above coding system may leave
1451 text-conversion or eol-conversion unspecified. They will be
1452 decided after we read output from the process and decode it by
1453 some coding system, or just before we actually send a text to
1454 the process. */
1458 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1459 XPROCESS (proc)->decoding_carryover = 0;
1460 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1462 XPROCESS (proc)->inherit_coding_system_flag
1463 = !(NILP (buffer) || !inherit_process_coding_system);
1465 if (!NILP (program))
1467 /* If program file name is not absolute, search our path for it.
1468 Put the name we will really use in TEM. */
1469 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1470 && !(SCHARS (program) > 1
1471 && IS_DEVICE_SEP (SREF (program, 1))))
1473 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1475 tem = Qnil;
1476 GCPRO4 (name, program, buffer, current_dir);
1477 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1478 UNGCPRO;
1479 if (NILP (tem))
1480 report_file_error ("Searching for program", Fcons (program, Qnil));
1481 tem = Fexpand_file_name (tem, Qnil);
1483 else
1485 if (!NILP (Ffile_directory_p (program)))
1486 error ("Specified program for new process is a directory");
1487 tem = program;
1490 /* If program file name starts with /: for quoting a magic name,
1491 discard that. */
1492 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1493 && SREF (tem, 1) == ':')
1494 tem = Fsubstring (tem, make_number (2), Qnil);
1497 Lisp_Object arg_encoding = Qnil;
1498 struct gcpro gcpro1;
1499 GCPRO1 (tem);
1501 /* Encode the file name and put it in NEW_ARGV.
1502 That's where the child will use it to execute the program. */
1503 tem = Fcons (ENCODE_FILE (tem), Qnil);
1505 /* Here we encode arguments by the coding system used for sending
1506 data to the process. We don't support using different coding
1507 systems for encoding arguments and for encoding data sent to the
1508 process. */
1510 for (i = 3; i < nargs; i++)
1512 tem = Fcons (args[i], tem);
1513 CHECK_STRING (XCAR (tem));
1514 if (STRING_MULTIBYTE (XCAR (tem)))
1516 if (NILP (arg_encoding))
1517 arg_encoding = (complement_process_encoding_system
1518 (XPROCESS (proc)->encode_coding_system));
1519 XSETCAR (tem,
1520 code_convert_string_norecord
1521 (XCAR (tem), arg_encoding, 1));
1525 UNGCPRO;
1528 /* Now that everything is encoded we can collect the strings into
1529 NEW_ARGV. */
1530 new_argv = alloca ((nargs - 1) * sizeof *new_argv);
1531 new_argv[nargs - 2] = 0;
1533 for (i = nargs - 2; i-- != 0; )
1535 new_argv[i] = SDATA (XCAR (tem));
1536 tem = XCDR (tem);
1539 create_process (proc, (char **) new_argv, current_dir);
1541 else
1542 create_pty (proc);
1544 return unbind_to (count, proc);
1547 /* This function is the unwind_protect form for Fstart_process. If
1548 PROC doesn't have its pid set, then we know someone has signaled
1549 an error and the process wasn't started successfully, so we should
1550 remove it from the process list. */
1551 static Lisp_Object
1552 start_process_unwind (Lisp_Object proc)
1554 if (!PROCESSP (proc))
1555 emacs_abort ();
1557 /* Was PROC started successfully?
1558 -2 is used for a pty with no process, eg for gdb. */
1559 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1560 remove_process (proc);
1562 return Qnil;
1565 static void
1566 create_process_1 (struct atimer *timer)
1568 /* Nothing to do. */
1572 static void
1573 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1575 int inchannel, outchannel;
1576 pid_t pid;
1577 int sv[2];
1578 #ifndef WINDOWSNT
1579 int wait_child_setup[2];
1580 #endif
1581 #ifdef SIGCHLD
1582 sigset_t blocked;
1583 #endif
1584 /* Use volatile to protect variables from being clobbered by vfork. */
1585 volatile int forkin, forkout;
1586 volatile int pty_flag = 0;
1587 volatile Lisp_Object lisp_pty_name = Qnil;
1588 volatile Lisp_Object encoded_current_dir;
1589 #if HAVE_WORKING_VFORK
1590 char **volatile save_environ;
1591 #endif
1593 inchannel = outchannel = -1;
1595 #ifdef HAVE_PTYS
1596 if (!NILP (Vprocess_connection_type))
1597 outchannel = inchannel = allocate_pty ();
1599 if (inchannel >= 0)
1601 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1602 /* On most USG systems it does not work to open the pty's tty here,
1603 then close it and reopen it in the child. */
1604 /* Don't let this terminal become our controlling terminal
1605 (in case we don't have one). */
1606 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1607 if (forkin < 0)
1608 report_file_error ("Opening pty", Qnil);
1609 #else
1610 forkin = forkout = -1;
1611 #endif /* not USG, or USG_SUBTTY_WORKS */
1612 pty_flag = 1;
1613 lisp_pty_name = build_string (pty_name);
1615 else
1616 #endif /* HAVE_PTYS */
1618 int tem;
1619 tem = pipe (sv);
1620 if (tem < 0)
1621 report_file_error ("Creating pipe", Qnil);
1622 inchannel = sv[0];
1623 forkout = sv[1];
1624 tem = pipe (sv);
1625 if (tem < 0)
1627 emacs_close (inchannel);
1628 emacs_close (forkout);
1629 report_file_error ("Creating pipe", Qnil);
1631 outchannel = sv[1];
1632 forkin = sv[0];
1635 #ifndef WINDOWSNT
1637 int tem;
1639 tem = pipe (wait_child_setup);
1640 if (tem < 0)
1641 report_file_error ("Creating pipe", Qnil);
1642 tem = fcntl (wait_child_setup[1], F_GETFD, 0);
1643 if (tem >= 0)
1644 tem = fcntl (wait_child_setup[1], F_SETFD, tem | FD_CLOEXEC);
1645 if (tem < 0)
1647 emacs_close (wait_child_setup[0]);
1648 emacs_close (wait_child_setup[1]);
1649 report_file_error ("Setting file descriptor flags", Qnil);
1652 #endif
1654 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1655 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1657 /* Record this as an active process, with its channels.
1658 As a result, child_setup will close Emacs's side of the pipes. */
1659 chan_process[inchannel] = process;
1660 XPROCESS (process)->infd = inchannel;
1661 XPROCESS (process)->outfd = outchannel;
1663 /* Previously we recorded the tty descriptor used in the subprocess.
1664 It was only used for getting the foreground tty process, so now
1665 we just reopen the device (see emacs_get_tty_pgrp) as this is
1666 more portable (see USG_SUBTTY_WORKS above). */
1668 XPROCESS (process)->pty_flag = pty_flag;
1669 pset_status (XPROCESS (process), Qrun);
1671 FD_SET (inchannel, &input_wait_mask);
1672 FD_SET (inchannel, &non_keyboard_wait_mask);
1673 if (inchannel > max_process_desc)
1674 max_process_desc = inchannel;
1676 /* This may signal an error. */
1677 setup_process_coding_systems (process);
1679 encoded_current_dir = ENCODE_FILE (current_dir);
1681 block_input ();
1683 #ifdef SIGCHLD
1684 /* Block SIGCHLD until we have a chance to store the new fork's
1685 pid in its process structure. */
1686 sigemptyset (&blocked);
1687 sigaddset (&blocked, SIGCHLD);
1688 pthread_sigmask (SIG_BLOCK, &blocked, 0);
1689 #endif
1691 #if HAVE_WORKING_VFORK
1692 /* child_setup must clobber environ on systems with true vfork.
1693 Protect it from permanent change. */
1694 save_environ = environ;
1695 #endif
1697 #ifndef WINDOWSNT
1698 pid = vfork ();
1699 if (pid == 0)
1700 #endif /* not WINDOWSNT */
1702 int xforkin = forkin;
1703 int xforkout = forkout;
1705 /* Make the pty be the controlling terminal of the process. */
1706 #ifdef HAVE_PTYS
1707 /* First, disconnect its current controlling terminal. */
1708 /* We tried doing setsid only if pty_flag, but it caused
1709 process_set_signal to fail on SGI when using a pipe. */
1710 setsid ();
1711 /* Make the pty's terminal the controlling terminal. */
1712 if (pty_flag && xforkin >= 0)
1714 #ifdef TIOCSCTTY
1715 /* We ignore the return value
1716 because faith@cs.unc.edu says that is necessary on Linux. */
1717 ioctl (xforkin, TIOCSCTTY, 0);
1718 #endif
1720 #if defined (LDISC1)
1721 if (pty_flag && xforkin >= 0)
1723 struct termios t;
1724 tcgetattr (xforkin, &t);
1725 t.c_lflag = LDISC1;
1726 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1727 emacs_write (1, "create_process/tcsetattr LDISC1 failed\n", 39);
1729 #else
1730 #if defined (NTTYDISC) && defined (TIOCSETD)
1731 if (pty_flag && xforkin >= 0)
1733 /* Use new line discipline. */
1734 int ldisc = NTTYDISC;
1735 ioctl (xforkin, TIOCSETD, &ldisc);
1737 #endif
1738 #endif
1739 #ifdef TIOCNOTTY
1740 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1741 can do TIOCSPGRP only to the process's controlling tty. */
1742 if (pty_flag)
1744 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1745 I can't test it since I don't have 4.3. */
1746 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1747 if (j >= 0)
1749 ioctl (j, TIOCNOTTY, 0);
1750 emacs_close (j);
1753 #endif /* TIOCNOTTY */
1755 #if !defined (DONT_REOPEN_PTY)
1756 /*** There is a suggestion that this ought to be a
1757 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
1758 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1759 that system does seem to need this code, even though
1760 both TIOCSCTTY is defined. */
1761 /* Now close the pty (if we had it open) and reopen it.
1762 This makes the pty the controlling terminal of the subprocess. */
1763 if (pty_flag)
1766 /* I wonder if emacs_close (emacs_open (pty_name, ...))
1767 would work? */
1768 if (xforkin >= 0)
1769 emacs_close (xforkin);
1770 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
1772 if (xforkin < 0)
1774 emacs_write (1, "Couldn't open the pty terminal ", 31);
1775 emacs_write (1, pty_name, strlen (pty_name));
1776 emacs_write (1, "\n", 1);
1777 _exit (1);
1781 #endif /* not DONT_REOPEN_PTY */
1783 #ifdef SETUP_SLAVE_PTY
1784 if (pty_flag)
1786 SETUP_SLAVE_PTY;
1788 #endif /* SETUP_SLAVE_PTY */
1789 #ifdef AIX
1790 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
1791 Now reenable it in the child, so it will die when we want it to. */
1792 if (pty_flag)
1793 signal (SIGHUP, SIG_DFL);
1794 #endif
1795 #endif /* HAVE_PTYS */
1797 signal (SIGINT, SIG_DFL);
1798 signal (SIGQUIT, SIG_DFL);
1800 /* Emacs ignores SIGPIPE, but the child should not. */
1801 signal (SIGPIPE, SIG_DFL);
1803 #ifdef SIGCHLD
1804 /* Stop blocking signals in the child. */
1805 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
1806 #endif
1808 if (pty_flag)
1809 child_setup_tty (xforkout);
1810 #ifdef WINDOWSNT
1811 pid = child_setup (xforkin, xforkout, xforkout,
1812 new_argv, 1, encoded_current_dir);
1813 #else /* not WINDOWSNT */
1814 emacs_close (wait_child_setup[0]);
1815 child_setup (xforkin, xforkout, xforkout,
1816 new_argv, 1, encoded_current_dir);
1817 #endif /* not WINDOWSNT */
1820 /* Back in the parent process. */
1822 #if HAVE_WORKING_VFORK
1823 environ = save_environ;
1824 #endif
1826 XPROCESS (process)->pid = pid;
1827 if (0 <= pid)
1828 XPROCESS (process)->alive = 1;
1830 /* Stop blocking signals in the parent. */
1831 #ifdef SIGCHLD
1832 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
1833 #endif
1834 unblock_input ();
1836 if (pid < 0)
1838 if (forkin >= 0)
1839 emacs_close (forkin);
1840 if (forkin != forkout && forkout >= 0)
1841 emacs_close (forkout);
1843 else
1845 /* vfork succeeded. */
1847 #ifdef WINDOWSNT
1848 register_child (pid, inchannel);
1849 #endif /* WINDOWSNT */
1851 /* If the subfork execv fails, and it exits,
1852 this close hangs. I don't know why.
1853 So have an interrupt jar it loose. */
1855 struct atimer *timer;
1856 EMACS_TIME offset = make_emacs_time (1, 0);
1858 stop_polling ();
1859 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
1861 if (forkin >= 0)
1862 emacs_close (forkin);
1864 cancel_atimer (timer);
1865 start_polling ();
1868 if (forkin != forkout && forkout >= 0)
1869 emacs_close (forkout);
1871 pset_tty_name (XPROCESS (process), lisp_pty_name);
1873 #ifndef WINDOWSNT
1874 /* Wait for child_setup to complete in case that vfork is
1875 actually defined as fork. The descriptor wait_child_setup[1]
1876 of a pipe is closed at the child side either by close-on-exec
1877 on successful execvp or the _exit call in child_setup. */
1879 char dummy;
1881 emacs_close (wait_child_setup[1]);
1882 emacs_read (wait_child_setup[0], &dummy, 1);
1883 emacs_close (wait_child_setup[0]);
1885 #endif
1888 /* Now generate the error if vfork failed. */
1889 if (pid < 0)
1890 report_file_error ("Doing vfork", Qnil);
1893 void
1894 create_pty (Lisp_Object process)
1896 int inchannel, outchannel;
1897 int pty_flag = 0;
1899 inchannel = outchannel = -1;
1901 #ifdef HAVE_PTYS
1902 if (!NILP (Vprocess_connection_type))
1903 outchannel = inchannel = allocate_pty ();
1905 if (inchannel >= 0)
1907 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1908 /* On most USG systems it does not work to open the pty's tty here,
1909 then close it and reopen it in the child. */
1910 /* Don't let this terminal become our controlling terminal
1911 (in case we don't have one). */
1912 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1913 if (forkout < 0)
1914 report_file_error ("Opening pty", Qnil);
1915 #if defined (DONT_REOPEN_PTY)
1916 /* In the case that vfork is defined as fork, the parent process
1917 (Emacs) may send some data before the child process completes
1918 tty options setup. So we setup tty before forking. */
1919 child_setup_tty (forkout);
1920 #endif /* DONT_REOPEN_PTY */
1921 #endif /* not USG, or USG_SUBTTY_WORKS */
1922 pty_flag = 1;
1924 #endif /* HAVE_PTYS */
1926 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1927 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1929 /* Record this as an active process, with its channels.
1930 As a result, child_setup will close Emacs's side of the pipes. */
1931 chan_process[inchannel] = process;
1932 XPROCESS (process)->infd = inchannel;
1933 XPROCESS (process)->outfd = outchannel;
1935 /* Previously we recorded the tty descriptor used in the subprocess.
1936 It was only used for getting the foreground tty process, so now
1937 we just reopen the device (see emacs_get_tty_pgrp) as this is
1938 more portable (see USG_SUBTTY_WORKS above). */
1940 XPROCESS (process)->pty_flag = pty_flag;
1941 pset_status (XPROCESS (process), Qrun);
1942 setup_process_coding_systems (process);
1944 FD_SET (inchannel, &input_wait_mask);
1945 FD_SET (inchannel, &non_keyboard_wait_mask);
1946 if (inchannel > max_process_desc)
1947 max_process_desc = inchannel;
1949 XPROCESS (process)->pid = -2;
1950 #ifdef HAVE_PTYS
1951 if (pty_flag)
1952 pset_tty_name (XPROCESS (process), build_string (pty_name));
1953 else
1954 #endif
1955 pset_tty_name (XPROCESS (process), Qnil);
1959 /* Convert an internal struct sockaddr to a lisp object (vector or string).
1960 The address family of sa is not included in the result. */
1962 static Lisp_Object
1963 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
1965 Lisp_Object address;
1966 int i;
1967 unsigned char *cp;
1968 register struct Lisp_Vector *p;
1970 /* Workaround for a bug in getsockname on BSD: Names bound to
1971 sockets in the UNIX domain are inaccessible; getsockname returns
1972 a zero length name. */
1973 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
1974 return empty_unibyte_string;
1976 switch (sa->sa_family)
1978 case AF_INET:
1980 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
1981 len = sizeof (sin->sin_addr) + 1;
1982 address = Fmake_vector (make_number (len), Qnil);
1983 p = XVECTOR (address);
1984 p->contents[--len] = make_number (ntohs (sin->sin_port));
1985 cp = (unsigned char *) &sin->sin_addr;
1986 break;
1988 #ifdef AF_INET6
1989 case AF_INET6:
1991 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
1992 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
1993 len = sizeof (sin6->sin6_addr)/2 + 1;
1994 address = Fmake_vector (make_number (len), Qnil);
1995 p = XVECTOR (address);
1996 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
1997 for (i = 0; i < len; i++)
1998 p->contents[i] = make_number (ntohs (ip6[i]));
1999 return address;
2001 #endif
2002 #ifdef HAVE_LOCAL_SOCKETS
2003 case AF_LOCAL:
2005 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2006 for (i = 0; i < sizeof (sockun->sun_path); i++)
2007 if (sockun->sun_path[i] == 0)
2008 break;
2009 return make_unibyte_string (sockun->sun_path, i);
2011 #endif
2012 default:
2013 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2014 address = Fcons (make_number (sa->sa_family),
2015 Fmake_vector (make_number (len), Qnil));
2016 p = XVECTOR (XCDR (address));
2017 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2018 break;
2021 i = 0;
2022 while (i < len)
2023 p->contents[i++] = make_number (*cp++);
2025 return address;
2029 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2031 static int
2032 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2034 register struct Lisp_Vector *p;
2036 if (VECTORP (address))
2038 p = XVECTOR (address);
2039 if (p->header.size == 5)
2041 *familyp = AF_INET;
2042 return sizeof (struct sockaddr_in);
2044 #ifdef AF_INET6
2045 else if (p->header.size == 9)
2047 *familyp = AF_INET6;
2048 return sizeof (struct sockaddr_in6);
2050 #endif
2052 #ifdef HAVE_LOCAL_SOCKETS
2053 else if (STRINGP (address))
2055 *familyp = AF_LOCAL;
2056 return sizeof (struct sockaddr_un);
2058 #endif
2059 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2060 && VECTORP (XCDR (address)))
2062 struct sockaddr *sa;
2063 *familyp = XINT (XCAR (address));
2064 p = XVECTOR (XCDR (address));
2065 return p->header.size + sizeof (sa->sa_family);
2067 return 0;
2070 /* Convert an address object (vector or string) to an internal sockaddr.
2072 The address format has been basically validated by
2073 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2074 it could have come from user data. So if FAMILY is not valid,
2075 we return after zeroing *SA. */
2077 static void
2078 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2080 register struct Lisp_Vector *p;
2081 register unsigned char *cp = NULL;
2082 register int i;
2083 EMACS_INT hostport;
2085 memset (sa, 0, len);
2087 if (VECTORP (address))
2089 p = XVECTOR (address);
2090 if (family == AF_INET)
2092 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2093 len = sizeof (sin->sin_addr) + 1;
2094 hostport = XINT (p->contents[--len]);
2095 sin->sin_port = htons (hostport);
2096 cp = (unsigned char *)&sin->sin_addr;
2097 sa->sa_family = family;
2099 #ifdef AF_INET6
2100 else if (family == AF_INET6)
2102 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2103 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2104 len = sizeof (sin6->sin6_addr) + 1;
2105 hostport = XINT (p->contents[--len]);
2106 sin6->sin6_port = htons (hostport);
2107 for (i = 0; i < len; i++)
2108 if (INTEGERP (p->contents[i]))
2110 int j = XFASTINT (p->contents[i]) & 0xffff;
2111 ip6[i] = ntohs (j);
2113 sa->sa_family = family;
2114 return;
2116 #endif
2117 else
2118 return;
2120 else if (STRINGP (address))
2122 #ifdef HAVE_LOCAL_SOCKETS
2123 if (family == AF_LOCAL)
2125 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2126 cp = SDATA (address);
2127 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2128 sockun->sun_path[i] = *cp++;
2129 sa->sa_family = family;
2131 #endif
2132 return;
2134 else
2136 p = XVECTOR (XCDR (address));
2137 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2140 for (i = 0; i < len; i++)
2141 if (INTEGERP (p->contents[i]))
2142 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2145 #ifdef DATAGRAM_SOCKETS
2146 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2147 1, 1, 0,
2148 doc: /* Get the current datagram address associated with PROCESS. */)
2149 (Lisp_Object process)
2151 int channel;
2153 CHECK_PROCESS (process);
2155 if (!DATAGRAM_CONN_P (process))
2156 return Qnil;
2158 channel = XPROCESS (process)->infd;
2159 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2160 datagram_address[channel].len);
2163 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2164 2, 2, 0,
2165 doc: /* Set the datagram address for PROCESS to ADDRESS.
2166 Returns nil upon error setting address, ADDRESS otherwise. */)
2167 (Lisp_Object process, Lisp_Object address)
2169 int channel;
2170 int family, len;
2172 CHECK_PROCESS (process);
2174 if (!DATAGRAM_CONN_P (process))
2175 return Qnil;
2177 channel = XPROCESS (process)->infd;
2179 len = get_lisp_to_sockaddr_size (address, &family);
2180 if (datagram_address[channel].len != len)
2181 return Qnil;
2182 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2183 return address;
2185 #endif
2188 static const struct socket_options {
2189 /* The name of this option. Should be lowercase version of option
2190 name without SO_ prefix. */
2191 const char *name;
2192 /* Option level SOL_... */
2193 int optlevel;
2194 /* Option number SO_... */
2195 int optnum;
2196 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2197 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2198 } socket_options[] =
2200 #ifdef SO_BINDTODEVICE
2201 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2202 #endif
2203 #ifdef SO_BROADCAST
2204 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2205 #endif
2206 #ifdef SO_DONTROUTE
2207 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2208 #endif
2209 #ifdef SO_KEEPALIVE
2210 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2211 #endif
2212 #ifdef SO_LINGER
2213 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2214 #endif
2215 #ifdef SO_OOBINLINE
2216 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2217 #endif
2218 #ifdef SO_PRIORITY
2219 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2220 #endif
2221 #ifdef SO_REUSEADDR
2222 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2223 #endif
2224 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2227 /* Set option OPT to value VAL on socket S.
2229 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2230 Signals an error if setting a known option fails.
2233 static int
2234 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2236 char *name;
2237 const struct socket_options *sopt;
2238 int ret = 0;
2240 CHECK_SYMBOL (opt);
2242 name = SSDATA (SYMBOL_NAME (opt));
2243 for (sopt = socket_options; sopt->name; sopt++)
2244 if (strcmp (name, sopt->name) == 0)
2245 break;
2247 switch (sopt->opttype)
2249 case SOPT_BOOL:
2251 int optval;
2252 optval = NILP (val) ? 0 : 1;
2253 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2254 &optval, sizeof (optval));
2255 break;
2258 case SOPT_INT:
2260 int optval;
2261 if (TYPE_RANGED_INTEGERP (int, val))
2262 optval = XINT (val);
2263 else
2264 error ("Bad option value for %s", name);
2265 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2266 &optval, sizeof (optval));
2267 break;
2270 #ifdef SO_BINDTODEVICE
2271 case SOPT_IFNAME:
2273 char devname[IFNAMSIZ+1];
2275 /* This is broken, at least in the Linux 2.4 kernel.
2276 To unbind, the arg must be a zero integer, not the empty string.
2277 This should work on all systems. KFS. 2003-09-23. */
2278 memset (devname, 0, sizeof devname);
2279 if (STRINGP (val))
2281 char *arg = SSDATA (val);
2282 int len = min (strlen (arg), IFNAMSIZ);
2283 memcpy (devname, arg, len);
2285 else if (!NILP (val))
2286 error ("Bad option value for %s", name);
2287 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2288 devname, IFNAMSIZ);
2289 break;
2291 #endif
2293 #ifdef SO_LINGER
2294 case SOPT_LINGER:
2296 struct linger linger;
2298 linger.l_onoff = 1;
2299 linger.l_linger = 0;
2300 if (TYPE_RANGED_INTEGERP (int, val))
2301 linger.l_linger = XINT (val);
2302 else
2303 linger.l_onoff = NILP (val) ? 0 : 1;
2304 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2305 &linger, sizeof (linger));
2306 break;
2308 #endif
2310 default:
2311 return 0;
2314 if (ret < 0)
2315 report_file_error ("Cannot set network option",
2316 Fcons (opt, Fcons (val, Qnil)));
2317 return (1 << sopt->optbit);
2321 DEFUN ("set-network-process-option",
2322 Fset_network_process_option, Sset_network_process_option,
2323 3, 4, 0,
2324 doc: /* For network process PROCESS set option OPTION to value VALUE.
2325 See `make-network-process' for a list of options and values.
2326 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2327 OPTION is not a supported option, return nil instead; otherwise return t. */)
2328 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2330 int s;
2331 struct Lisp_Process *p;
2333 CHECK_PROCESS (process);
2334 p = XPROCESS (process);
2335 if (!NETCONN1_P (p))
2336 error ("Process is not a network process");
2338 s = p->infd;
2339 if (s < 0)
2340 error ("Process is not running");
2342 if (set_socket_option (s, option, value))
2344 pset_childp (p, Fplist_put (p->childp, option, value));
2345 return Qt;
2348 if (NILP (no_error))
2349 error ("Unknown or unsupported option");
2351 return Qnil;
2355 DEFUN ("serial-process-configure",
2356 Fserial_process_configure,
2357 Sserial_process_configure,
2358 0, MANY, 0,
2359 doc: /* Configure speed, bytesize, etc. of a serial process.
2361 Arguments are specified as keyword/argument pairs. Attributes that
2362 are not given are re-initialized from the process's current
2363 configuration (available via the function `process-contact') or set to
2364 reasonable default values. The following arguments are defined:
2366 :process PROCESS
2367 :name NAME
2368 :buffer BUFFER
2369 :port PORT
2370 -- Any of these arguments can be given to identify the process that is
2371 to be configured. If none of these arguments is given, the current
2372 buffer's process is used.
2374 :speed SPEED -- SPEED is the speed of the serial port in bits per
2375 second, also called baud rate. Any value can be given for SPEED, but
2376 most serial ports work only at a few defined values between 1200 and
2377 115200, with 9600 being the most common value. If SPEED is nil, the
2378 serial port is not configured any further, i.e., all other arguments
2379 are ignored. This may be useful for special serial ports such as
2380 Bluetooth-to-serial converters which can only be configured through AT
2381 commands. A value of nil for SPEED can be used only when passed
2382 through `make-serial-process' or `serial-term'.
2384 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2385 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2387 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2388 `odd' (use odd parity), or the symbol `even' (use even parity). If
2389 PARITY is not given, no parity is used.
2391 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2392 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2393 is not given or nil, 1 stopbit is used.
2395 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2396 flowcontrol to be used, which is either nil (don't use flowcontrol),
2397 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2398 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2399 flowcontrol is used.
2401 `serial-process-configure' is called by `make-serial-process' for the
2402 initial configuration of the serial port.
2404 Examples:
2406 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2408 \(serial-process-configure
2409 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2411 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2413 usage: (serial-process-configure &rest ARGS) */)
2414 (ptrdiff_t nargs, Lisp_Object *args)
2416 struct Lisp_Process *p;
2417 Lisp_Object contact = Qnil;
2418 Lisp_Object proc = Qnil;
2419 struct gcpro gcpro1;
2421 contact = Flist (nargs, args);
2422 GCPRO1 (contact);
2424 proc = Fplist_get (contact, QCprocess);
2425 if (NILP (proc))
2426 proc = Fplist_get (contact, QCname);
2427 if (NILP (proc))
2428 proc = Fplist_get (contact, QCbuffer);
2429 if (NILP (proc))
2430 proc = Fplist_get (contact, QCport);
2431 proc = get_process (proc);
2432 p = XPROCESS (proc);
2433 if (!EQ (p->type, Qserial))
2434 error ("Not a serial process");
2436 if (NILP (Fplist_get (p->childp, QCspeed)))
2438 UNGCPRO;
2439 return Qnil;
2442 serial_configure (p, contact);
2444 UNGCPRO;
2445 return Qnil;
2448 /* Used by make-serial-process to recover from errors. */
2449 static Lisp_Object
2450 make_serial_process_unwind (Lisp_Object proc)
2452 if (!PROCESSP (proc))
2453 emacs_abort ();
2454 remove_process (proc);
2455 return Qnil;
2458 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2459 0, MANY, 0,
2460 doc: /* Create and return a serial port process.
2462 In Emacs, serial port connections are represented by process objects,
2463 so input and output work as for subprocesses, and `delete-process'
2464 closes a serial port connection. However, a serial process has no
2465 process id, it cannot be signaled, and the status codes are different
2466 from normal processes.
2468 `make-serial-process' creates a process and a buffer, on which you
2469 probably want to use `process-send-string'. Try \\[serial-term] for
2470 an interactive terminal. See below for examples.
2472 Arguments are specified as keyword/argument pairs. The following
2473 arguments are defined:
2475 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2476 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2477 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2478 the backslashes in strings).
2480 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2481 which this function calls.
2483 :name NAME -- NAME is the name of the process. If NAME is not given,
2484 the value of PORT is used.
2486 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2487 with the process. Process output goes at the end of that buffer,
2488 unless you specify an output stream or filter function to handle the
2489 output. If BUFFER is not given, the value of NAME is used.
2491 :coding CODING -- If CODING is a symbol, it specifies the coding
2492 system used for both reading and writing for this process. If CODING
2493 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2494 ENCODING is used for writing.
2496 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2497 the process is running. If BOOL is not given, query before exiting.
2499 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2500 In the stopped state, a serial process does not accept incoming data,
2501 but you can send outgoing data. The stopped state is cleared by
2502 `continue-process' and set by `stop-process'.
2504 :filter FILTER -- Install FILTER as the process filter.
2506 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2508 :plist PLIST -- Install PLIST as the initial plist of the process.
2510 :bytesize
2511 :parity
2512 :stopbits
2513 :flowcontrol
2514 -- This function calls `serial-process-configure' to handle these
2515 arguments.
2517 The original argument list, possibly modified by later configuration,
2518 is available via the function `process-contact'.
2520 Examples:
2522 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2524 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2526 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2528 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2530 usage: (make-serial-process &rest ARGS) */)
2531 (ptrdiff_t nargs, Lisp_Object *args)
2533 int fd = -1;
2534 Lisp_Object proc, contact, port;
2535 struct Lisp_Process *p;
2536 struct gcpro gcpro1;
2537 Lisp_Object name, buffer;
2538 Lisp_Object tem, val;
2539 ptrdiff_t specpdl_count = -1;
2541 if (nargs == 0)
2542 return Qnil;
2544 contact = Flist (nargs, args);
2545 GCPRO1 (contact);
2547 port = Fplist_get (contact, QCport);
2548 if (NILP (port))
2549 error ("No port specified");
2550 CHECK_STRING (port);
2552 if (NILP (Fplist_member (contact, QCspeed)))
2553 error (":speed not specified");
2554 if (!NILP (Fplist_get (contact, QCspeed)))
2555 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2557 name = Fplist_get (contact, QCname);
2558 if (NILP (name))
2559 name = port;
2560 CHECK_STRING (name);
2561 proc = make_process (name);
2562 specpdl_count = SPECPDL_INDEX ();
2563 record_unwind_protect (make_serial_process_unwind, proc);
2564 p = XPROCESS (proc);
2566 fd = serial_open (SSDATA (port));
2567 p->infd = fd;
2568 p->outfd = fd;
2569 if (fd > max_process_desc)
2570 max_process_desc = fd;
2571 chan_process[fd] = proc;
2573 buffer = Fplist_get (contact, QCbuffer);
2574 if (NILP (buffer))
2575 buffer = name;
2576 buffer = Fget_buffer_create (buffer);
2577 pset_buffer (p, buffer);
2579 pset_childp (p, contact);
2580 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2581 pset_type (p, Qserial);
2582 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2583 pset_filter (p, Fplist_get (contact, QCfilter));
2584 pset_log (p, Qnil);
2585 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2586 p->kill_without_query = 1;
2587 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2588 pset_command (p, Qt);
2589 p->pty_flag = 0;
2591 if (!EQ (p->command, Qt))
2593 FD_SET (fd, &input_wait_mask);
2594 FD_SET (fd, &non_keyboard_wait_mask);
2597 if (BUFFERP (buffer))
2599 set_marker_both (p->mark, buffer,
2600 BUF_ZV (XBUFFER (buffer)),
2601 BUF_ZV_BYTE (XBUFFER (buffer)));
2604 tem = Fplist_member (contact, QCcoding);
2605 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2606 tem = Qnil;
2608 val = Qnil;
2609 if (!NILP (tem))
2611 val = XCAR (XCDR (tem));
2612 if (CONSP (val))
2613 val = XCAR (val);
2615 else if (!NILP (Vcoding_system_for_read))
2616 val = Vcoding_system_for_read;
2617 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2618 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2619 val = Qnil;
2620 pset_decode_coding_system (p, val);
2622 val = Qnil;
2623 if (!NILP (tem))
2625 val = XCAR (XCDR (tem));
2626 if (CONSP (val))
2627 val = XCDR (val);
2629 else if (!NILP (Vcoding_system_for_write))
2630 val = Vcoding_system_for_write;
2631 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2632 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2633 val = Qnil;
2634 pset_encode_coding_system (p, val);
2636 setup_process_coding_systems (proc);
2637 pset_decoding_buf (p, empty_unibyte_string);
2638 p->decoding_carryover = 0;
2639 pset_encoding_buf (p, empty_unibyte_string);
2640 p->inherit_coding_system_flag
2641 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2643 Fserial_process_configure (nargs, args);
2645 specpdl_ptr = specpdl + specpdl_count;
2647 UNGCPRO;
2648 return proc;
2651 /* Create a network stream/datagram client/server process. Treated
2652 exactly like a normal process when reading and writing. Primary
2653 differences are in status display and process deletion. A network
2654 connection has no PID; you cannot signal it. All you can do is
2655 stop/continue it and deactivate/close it via delete-process */
2657 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2658 0, MANY, 0,
2659 doc: /* Create and return a network server or client process.
2661 In Emacs, network connections are represented by process objects, so
2662 input and output work as for subprocesses and `delete-process' closes
2663 a network connection. However, a network process has no process id,
2664 it cannot be signaled, and the status codes are different from normal
2665 processes.
2667 Arguments are specified as keyword/argument pairs. The following
2668 arguments are defined:
2670 :name NAME -- NAME is name for process. It is modified if necessary
2671 to make it unique.
2673 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2674 with the process. Process output goes at end of that buffer, unless
2675 you specify an output stream or filter function to handle the output.
2676 BUFFER may be also nil, meaning that this process is not associated
2677 with any buffer.
2679 :host HOST -- HOST is name of the host to connect to, or its IP
2680 address. The symbol `local' specifies the local host. If specified
2681 for a server process, it must be a valid name or address for the local
2682 host, and only clients connecting to that address will be accepted.
2684 :service SERVICE -- SERVICE is name of the service desired, or an
2685 integer specifying a port number to connect to. If SERVICE is t,
2686 a random port number is selected for the server. (If Emacs was
2687 compiled with getaddrinfo, a port number can also be specified as a
2688 string, e.g. "80", as well as an integer. This is not portable.)
2690 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2691 stream type connection, `datagram' creates a datagram type connection,
2692 `seqpacket' creates a reliable datagram connection.
2694 :family FAMILY -- FAMILY is the address (and protocol) family for the
2695 service specified by HOST and SERVICE. The default (nil) is to use
2696 whatever address family (IPv4 or IPv6) that is defined for the host
2697 and port number specified by HOST and SERVICE. Other address families
2698 supported are:
2699 local -- for a local (i.e. UNIX) address specified by SERVICE.
2700 ipv4 -- use IPv4 address family only.
2701 ipv6 -- use IPv6 address family only.
2703 :local ADDRESS -- ADDRESS is the local address used for the connection.
2704 This parameter is ignored when opening a client process. When specified
2705 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2707 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2708 connection. This parameter is ignored when opening a stream server
2709 process. For a datagram server process, it specifies the initial
2710 setting of the remote datagram address. When specified for a client
2711 process, the FAMILY, HOST, and SERVICE args are ignored.
2713 The format of ADDRESS depends on the address family:
2714 - An IPv4 address is represented as an vector of integers [A B C D P]
2715 corresponding to numeric IP address A.B.C.D and port number P.
2716 - A local address is represented as a string with the address in the
2717 local address space.
2718 - An "unsupported family" address is represented by a cons (F . AV)
2719 where F is the family number and AV is a vector containing the socket
2720 address data with one element per address data byte. Do not rely on
2721 this format in portable code, as it may depend on implementation
2722 defined constants, data sizes, and data structure alignment.
2724 :coding CODING -- If CODING is a symbol, it specifies the coding
2725 system used for both reading and writing for this process. If CODING
2726 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2727 ENCODING is used for writing.
2729 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2730 return without waiting for the connection to complete; instead, the
2731 sentinel function will be called with second arg matching "open" (if
2732 successful) or "failed" when the connect completes. Default is to use
2733 a blocking connect (i.e. wait) for stream type connections.
2735 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2736 running when Emacs is exited.
2738 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2739 In the stopped state, a server process does not accept new
2740 connections, and a client process does not handle incoming traffic.
2741 The stopped state is cleared by `continue-process' and set by
2742 `stop-process'.
2744 :filter FILTER -- Install FILTER as the process filter.
2746 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2747 process filter are multibyte, otherwise they are unibyte.
2748 If this keyword is not specified, the strings are multibyte if
2749 the default value of `enable-multibyte-characters' is non-nil.
2751 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2753 :log LOG -- Install LOG as the server process log function. This
2754 function is called when the server accepts a network connection from a
2755 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2756 is the server process, CLIENT is the new process for the connection,
2757 and MESSAGE is a string.
2759 :plist PLIST -- Install PLIST as the new process' initial plist.
2761 :server QLEN -- if QLEN is non-nil, create a server process for the
2762 specified FAMILY, SERVICE, and connection type (stream or datagram).
2763 If QLEN is an integer, it is used as the max. length of the server's
2764 pending connection queue (also known as the backlog); the default
2765 queue length is 5. Default is to create a client process.
2767 The following network options can be specified for this connection:
2769 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2770 :dontroute BOOL -- Only send to directly connected hosts.
2771 :keepalive BOOL -- Send keep-alive messages on network stream.
2772 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2773 :oobinline BOOL -- Place out-of-band data in receive data stream.
2774 :priority INT -- Set protocol defined priority for sent packets.
2775 :reuseaddr BOOL -- Allow reusing a recently used local address
2776 (this is allowed by default for a server process).
2777 :bindtodevice NAME -- bind to interface NAME. Using this may require
2778 special privileges on some systems.
2780 Consult the relevant system programmer's manual pages for more
2781 information on using these options.
2784 A server process will listen for and accept connections from clients.
2785 When a client connection is accepted, a new network process is created
2786 for the connection with the following parameters:
2788 - The client's process name is constructed by concatenating the server
2789 process' NAME and a client identification string.
2790 - If the FILTER argument is non-nil, the client process will not get a
2791 separate process buffer; otherwise, the client's process buffer is a newly
2792 created buffer named after the server process' BUFFER name or process
2793 NAME concatenated with the client identification string.
2794 - The connection type and the process filter and sentinel parameters are
2795 inherited from the server process' TYPE, FILTER and SENTINEL.
2796 - The client process' contact info is set according to the client's
2797 addressing information (typically an IP address and a port number).
2798 - The client process' plist is initialized from the server's plist.
2800 Notice that the FILTER and SENTINEL args are never used directly by
2801 the server process. Also, the BUFFER argument is not used directly by
2802 the server process, but via the optional :log function, accepted (and
2803 failed) connections may be logged in the server process' buffer.
2805 The original argument list, modified with the actual connection
2806 information, is available via the `process-contact' function.
2808 usage: (make-network-process &rest ARGS) */)
2809 (ptrdiff_t nargs, Lisp_Object *args)
2811 Lisp_Object proc;
2812 Lisp_Object contact;
2813 struct Lisp_Process *p;
2814 #ifdef HAVE_GETADDRINFO
2815 struct addrinfo ai, *res, *lres;
2816 struct addrinfo hints;
2817 const char *portstring;
2818 char portbuf[128];
2819 #else /* HAVE_GETADDRINFO */
2820 struct _emacs_addrinfo
2822 int ai_family;
2823 int ai_socktype;
2824 int ai_protocol;
2825 int ai_addrlen;
2826 struct sockaddr *ai_addr;
2827 struct _emacs_addrinfo *ai_next;
2828 } ai, *res, *lres;
2829 #endif /* HAVE_GETADDRINFO */
2830 struct sockaddr_in address_in;
2831 #ifdef HAVE_LOCAL_SOCKETS
2832 struct sockaddr_un address_un;
2833 #endif
2834 int port;
2835 int ret = 0;
2836 int xerrno = 0;
2837 int s = -1, outch, inch;
2838 struct gcpro gcpro1;
2839 ptrdiff_t count = SPECPDL_INDEX ();
2840 ptrdiff_t count1;
2841 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2842 Lisp_Object tem;
2843 Lisp_Object name, buffer, host, service, address;
2844 Lisp_Object filter, sentinel;
2845 int is_non_blocking_client = 0;
2846 int is_server = 0, backlog = 5;
2847 int socktype;
2848 int family = -1;
2850 if (nargs == 0)
2851 return Qnil;
2853 /* Save arguments for process-contact and clone-process. */
2854 contact = Flist (nargs, args);
2855 GCPRO1 (contact);
2857 #ifdef WINDOWSNT
2858 /* Ensure socket support is loaded if available. */
2859 init_winsock (TRUE);
2860 #endif
2862 /* :type TYPE (nil: stream, datagram */
2863 tem = Fplist_get (contact, QCtype);
2864 if (NILP (tem))
2865 socktype = SOCK_STREAM;
2866 #ifdef DATAGRAM_SOCKETS
2867 else if (EQ (tem, Qdatagram))
2868 socktype = SOCK_DGRAM;
2869 #endif
2870 #ifdef HAVE_SEQPACKET
2871 else if (EQ (tem, Qseqpacket))
2872 socktype = SOCK_SEQPACKET;
2873 #endif
2874 else
2875 error ("Unsupported connection type");
2877 /* :server BOOL */
2878 tem = Fplist_get (contact, QCserver);
2879 if (!NILP (tem))
2881 /* Don't support network sockets when non-blocking mode is
2882 not available, since a blocked Emacs is not useful. */
2883 is_server = 1;
2884 if (TYPE_RANGED_INTEGERP (int, tem))
2885 backlog = XINT (tem);
2888 /* Make QCaddress an alias for :local (server) or :remote (client). */
2889 QCaddress = is_server ? QClocal : QCremote;
2891 /* :nowait BOOL */
2892 if (!is_server && socktype != SOCK_DGRAM
2893 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2895 #ifndef NON_BLOCKING_CONNECT
2896 error ("Non-blocking connect not supported");
2897 #else
2898 is_non_blocking_client = 1;
2899 #endif
2902 name = Fplist_get (contact, QCname);
2903 buffer = Fplist_get (contact, QCbuffer);
2904 filter = Fplist_get (contact, QCfilter);
2905 sentinel = Fplist_get (contact, QCsentinel);
2907 CHECK_STRING (name);
2909 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2910 ai.ai_socktype = socktype;
2911 ai.ai_protocol = 0;
2912 ai.ai_next = NULL;
2913 res = &ai;
2915 /* :local ADDRESS or :remote ADDRESS */
2916 address = Fplist_get (contact, QCaddress);
2917 if (!NILP (address))
2919 host = service = Qnil;
2921 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2922 error ("Malformed :address");
2923 ai.ai_family = family;
2924 ai.ai_addr = alloca (ai.ai_addrlen);
2925 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2926 goto open_socket;
2929 /* :family FAMILY -- nil (for Inet), local, or integer. */
2930 tem = Fplist_get (contact, QCfamily);
2931 if (NILP (tem))
2933 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
2934 family = AF_UNSPEC;
2935 #else
2936 family = AF_INET;
2937 #endif
2939 #ifdef HAVE_LOCAL_SOCKETS
2940 else if (EQ (tem, Qlocal))
2941 family = AF_LOCAL;
2942 #endif
2943 #ifdef AF_INET6
2944 else if (EQ (tem, Qipv6))
2945 family = AF_INET6;
2946 #endif
2947 else if (EQ (tem, Qipv4))
2948 family = AF_INET;
2949 else if (TYPE_RANGED_INTEGERP (int, tem))
2950 family = XINT (tem);
2951 else
2952 error ("Unknown address family");
2954 ai.ai_family = family;
2956 /* :service SERVICE -- string, integer (port number), or t (random port). */
2957 service = Fplist_get (contact, QCservice);
2959 /* :host HOST -- hostname, ip address, or 'local for localhost. */
2960 host = Fplist_get (contact, QChost);
2961 if (!NILP (host))
2963 if (EQ (host, Qlocal))
2964 /* Depending on setup, "localhost" may map to different IPv4 and/or
2965 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
2966 host = build_string ("127.0.0.1");
2967 CHECK_STRING (host);
2970 #ifdef HAVE_LOCAL_SOCKETS
2971 if (family == AF_LOCAL)
2973 if (!NILP (host))
2975 message (":family local ignores the :host \"%s\" property",
2976 SDATA (host));
2977 contact = Fplist_put (contact, QChost, Qnil);
2978 host = Qnil;
2980 CHECK_STRING (service);
2981 memset (&address_un, 0, sizeof address_un);
2982 address_un.sun_family = AF_LOCAL;
2983 if (sizeof address_un.sun_path <= SBYTES (service))
2984 error ("Service name too long");
2985 strcpy (address_un.sun_path, SSDATA (service));
2986 ai.ai_addr = (struct sockaddr *) &address_un;
2987 ai.ai_addrlen = sizeof address_un;
2988 goto open_socket;
2990 #endif
2992 /* Slow down polling to every ten seconds.
2993 Some kernels have a bug which causes retrying connect to fail
2994 after a connect. Polling can interfere with gethostbyname too. */
2995 #ifdef POLL_FOR_INPUT
2996 if (socktype != SOCK_DGRAM)
2998 record_unwind_protect (unwind_stop_other_atimers, Qnil);
2999 bind_polling_period (10);
3001 #endif
3003 #ifdef HAVE_GETADDRINFO
3004 /* If we have a host, use getaddrinfo to resolve both host and service.
3005 Otherwise, use getservbyname to lookup the service. */
3006 if (!NILP (host))
3009 /* SERVICE can either be a string or int.
3010 Convert to a C string for later use by getaddrinfo. */
3011 if (EQ (service, Qt))
3012 portstring = "0";
3013 else if (INTEGERP (service))
3015 sprintf (portbuf, "%"pI"d", XINT (service));
3016 portstring = portbuf;
3018 else
3020 CHECK_STRING (service);
3021 portstring = SSDATA (service);
3024 immediate_quit = 1;
3025 QUIT;
3026 memset (&hints, 0, sizeof (hints));
3027 hints.ai_flags = 0;
3028 hints.ai_family = family;
3029 hints.ai_socktype = socktype;
3030 hints.ai_protocol = 0;
3032 #ifdef HAVE_RES_INIT
3033 res_init ();
3034 #endif
3036 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3037 if (ret)
3038 #ifdef HAVE_GAI_STRERROR
3039 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3040 #else
3041 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3042 #endif
3043 immediate_quit = 0;
3045 goto open_socket;
3047 #endif /* HAVE_GETADDRINFO */
3049 /* We end up here if getaddrinfo is not defined, or in case no hostname
3050 has been specified (e.g. for a local server process). */
3052 if (EQ (service, Qt))
3053 port = 0;
3054 else if (INTEGERP (service))
3055 port = htons ((unsigned short) XINT (service));
3056 else
3058 struct servent *svc_info;
3059 CHECK_STRING (service);
3060 svc_info = getservbyname (SSDATA (service),
3061 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3062 if (svc_info == 0)
3063 error ("Unknown service: %s", SDATA (service));
3064 port = svc_info->s_port;
3067 memset (&address_in, 0, sizeof address_in);
3068 address_in.sin_family = family;
3069 address_in.sin_addr.s_addr = INADDR_ANY;
3070 address_in.sin_port = port;
3072 #ifndef HAVE_GETADDRINFO
3073 if (!NILP (host))
3075 struct hostent *host_info_ptr;
3077 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3078 as it may `hang' Emacs for a very long time. */
3079 immediate_quit = 1;
3080 QUIT;
3082 #ifdef HAVE_RES_INIT
3083 res_init ();
3084 #endif
3086 host_info_ptr = gethostbyname (SDATA (host));
3087 immediate_quit = 0;
3089 if (host_info_ptr)
3091 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3092 host_info_ptr->h_length);
3093 family = host_info_ptr->h_addrtype;
3094 address_in.sin_family = family;
3096 else
3097 /* Attempt to interpret host as numeric inet address */
3099 unsigned long numeric_addr;
3100 numeric_addr = inet_addr (SSDATA (host));
3101 if (numeric_addr == -1)
3102 error ("Unknown host \"%s\"", SDATA (host));
3104 memcpy (&address_in.sin_addr, &numeric_addr,
3105 sizeof (address_in.sin_addr));
3109 #endif /* not HAVE_GETADDRINFO */
3111 ai.ai_family = family;
3112 ai.ai_addr = (struct sockaddr *) &address_in;
3113 ai.ai_addrlen = sizeof address_in;
3115 open_socket:
3117 /* Do this in case we never enter the for-loop below. */
3118 count1 = SPECPDL_INDEX ();
3119 s = -1;
3121 for (lres = res; lres; lres = lres->ai_next)
3123 ptrdiff_t optn;
3124 int optbits;
3126 #ifdef WINDOWSNT
3127 retry_connect:
3128 #endif
3130 s = socket (lres->ai_family, lres->ai_socktype, lres->ai_protocol);
3131 if (s < 0)
3133 xerrno = errno;
3134 continue;
3137 #ifdef DATAGRAM_SOCKETS
3138 if (!is_server && socktype == SOCK_DGRAM)
3139 break;
3140 #endif /* DATAGRAM_SOCKETS */
3142 #ifdef NON_BLOCKING_CONNECT
3143 if (is_non_blocking_client)
3145 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3146 if (ret < 0)
3148 xerrno = errno;
3149 emacs_close (s);
3150 s = -1;
3151 continue;
3154 #endif
3156 /* Make us close S if quit. */
3157 record_unwind_protect (close_file_unwind, make_number (s));
3159 /* Parse network options in the arg list.
3160 We simply ignore anything which isn't a known option (including other keywords).
3161 An error is signaled if setting a known option fails. */
3162 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3163 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3165 if (is_server)
3167 /* Configure as a server socket. */
3169 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3170 explicit :reuseaddr key to override this. */
3171 #ifdef HAVE_LOCAL_SOCKETS
3172 if (family != AF_LOCAL)
3173 #endif
3174 if (!(optbits & (1 << OPIX_REUSEADDR)))
3176 int optval = 1;
3177 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3178 report_file_error ("Cannot set reuse option on server socket", Qnil);
3181 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3182 report_file_error ("Cannot bind server socket", Qnil);
3184 #ifdef HAVE_GETSOCKNAME
3185 if (EQ (service, Qt))
3187 struct sockaddr_in sa1;
3188 socklen_t len1 = sizeof (sa1);
3189 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3191 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3192 service = make_number (ntohs (sa1.sin_port));
3193 contact = Fplist_put (contact, QCservice, service);
3196 #endif
3198 if (socktype != SOCK_DGRAM && listen (s, backlog))
3199 report_file_error ("Cannot listen on server socket", Qnil);
3201 break;
3204 immediate_quit = 1;
3205 QUIT;
3207 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3208 xerrno = errno;
3210 if (ret == 0 || xerrno == EISCONN)
3212 /* The unwind-protect will be discarded afterwards.
3213 Likewise for immediate_quit. */
3214 break;
3217 #ifdef NON_BLOCKING_CONNECT
3218 #ifdef EINPROGRESS
3219 if (is_non_blocking_client && xerrno == EINPROGRESS)
3220 break;
3221 #else
3222 #ifdef EWOULDBLOCK
3223 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3224 break;
3225 #endif
3226 #endif
3227 #endif
3229 #ifndef WINDOWSNT
3230 if (xerrno == EINTR)
3232 /* Unlike most other syscalls connect() cannot be called
3233 again. (That would return EALREADY.) The proper way to
3234 wait for completion is pselect(). */
3235 int sc;
3236 socklen_t len;
3237 SELECT_TYPE fdset;
3238 retry_select:
3239 FD_ZERO (&fdset);
3240 FD_SET (s, &fdset);
3241 QUIT;
3242 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3243 if (sc == -1)
3245 if (errno == EINTR)
3246 goto retry_select;
3247 else
3248 report_file_error ("select failed", Qnil);
3250 eassert (sc > 0);
3252 len = sizeof xerrno;
3253 eassert (FD_ISSET (s, &fdset));
3254 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) == -1)
3255 report_file_error ("getsockopt failed", Qnil);
3256 if (xerrno)
3257 errno = xerrno, report_file_error ("error during connect", Qnil);
3258 else
3259 break;
3261 #endif /* !WINDOWSNT */
3263 immediate_quit = 0;
3265 /* Discard the unwind protect closing S. */
3266 specpdl_ptr = specpdl + count1;
3267 emacs_close (s);
3268 s = -1;
3270 #ifdef WINDOWSNT
3271 if (xerrno == EINTR)
3272 goto retry_connect;
3273 #endif
3276 if (s >= 0)
3278 #ifdef DATAGRAM_SOCKETS
3279 if (socktype == SOCK_DGRAM)
3281 if (datagram_address[s].sa)
3282 emacs_abort ();
3283 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3284 datagram_address[s].len = lres->ai_addrlen;
3285 if (is_server)
3287 Lisp_Object remote;
3288 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3289 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3291 int rfamily, rlen;
3292 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3293 if (rfamily == lres->ai_family && rlen == lres->ai_addrlen)
3294 conv_lisp_to_sockaddr (rfamily, remote,
3295 datagram_address[s].sa, rlen);
3298 else
3299 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3301 #endif
3302 contact = Fplist_put (contact, QCaddress,
3303 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3304 #ifdef HAVE_GETSOCKNAME
3305 if (!is_server)
3307 struct sockaddr_in sa1;
3308 socklen_t len1 = sizeof (sa1);
3309 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3310 contact = Fplist_put (contact, QClocal,
3311 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3313 #endif
3316 immediate_quit = 0;
3318 #ifdef HAVE_GETADDRINFO
3319 if (res != &ai)
3321 block_input ();
3322 freeaddrinfo (res);
3323 unblock_input ();
3325 #endif
3327 /* Discard the unwind protect for closing S, if any. */
3328 specpdl_ptr = specpdl + count1;
3330 /* Unwind bind_polling_period and request_sigio. */
3331 unbind_to (count, Qnil);
3333 if (s < 0)
3335 /* If non-blocking got this far - and failed - assume non-blocking is
3336 not supported after all. This is probably a wrong assumption, but
3337 the normal blocking calls to open-network-stream handles this error
3338 better. */
3339 if (is_non_blocking_client)
3340 return Qnil;
3342 errno = xerrno;
3343 if (is_server)
3344 report_file_error ("make server process failed", contact);
3345 else
3346 report_file_error ("make client process failed", contact);
3349 inch = s;
3350 outch = s;
3352 if (!NILP (buffer))
3353 buffer = Fget_buffer_create (buffer);
3354 proc = make_process (name);
3356 chan_process[inch] = proc;
3358 fcntl (inch, F_SETFL, O_NONBLOCK);
3360 p = XPROCESS (proc);
3362 pset_childp (p, contact);
3363 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3364 pset_type (p, Qnetwork);
3366 pset_buffer (p, buffer);
3367 pset_sentinel (p, sentinel);
3368 pset_filter (p, filter);
3369 pset_log (p, Fplist_get (contact, QClog));
3370 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3371 p->kill_without_query = 1;
3372 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3373 pset_command (p, Qt);
3374 p->pid = 0;
3375 p->infd = inch;
3376 p->outfd = outch;
3377 if (is_server && socktype != SOCK_DGRAM)
3378 pset_status (p, Qlisten);
3380 /* Make the process marker point into the process buffer (if any). */
3381 if (BUFFERP (buffer))
3382 set_marker_both (p->mark, buffer,
3383 BUF_ZV (XBUFFER (buffer)),
3384 BUF_ZV_BYTE (XBUFFER (buffer)));
3386 #ifdef NON_BLOCKING_CONNECT
3387 if (is_non_blocking_client)
3389 /* We may get here if connect did succeed immediately. However,
3390 in that case, we still need to signal this like a non-blocking
3391 connection. */
3392 pset_status (p, Qconnect);
3393 if (!FD_ISSET (inch, &connect_wait_mask))
3395 FD_SET (inch, &connect_wait_mask);
3396 FD_SET (inch, &write_mask);
3397 num_pending_connects++;
3400 else
3401 #endif
3402 /* A server may have a client filter setting of Qt, but it must
3403 still listen for incoming connects unless it is stopped. */
3404 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3405 || (EQ (p->status, Qlisten) && NILP (p->command)))
3407 FD_SET (inch, &input_wait_mask);
3408 FD_SET (inch, &non_keyboard_wait_mask);
3411 if (inch > max_process_desc)
3412 max_process_desc = inch;
3414 tem = Fplist_member (contact, QCcoding);
3415 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3416 tem = Qnil; /* No error message (too late!). */
3419 /* Setup coding systems for communicating with the network stream. */
3420 struct gcpro gcpro1;
3421 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3422 Lisp_Object coding_systems = Qt;
3423 Lisp_Object fargs[5], val;
3425 if (!NILP (tem))
3427 val = XCAR (XCDR (tem));
3428 if (CONSP (val))
3429 val = XCAR (val);
3431 else if (!NILP (Vcoding_system_for_read))
3432 val = Vcoding_system_for_read;
3433 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3434 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3435 /* We dare not decode end-of-line format by setting VAL to
3436 Qraw_text, because the existing Emacs Lisp libraries
3437 assume that they receive bare code including a sequence of
3438 CR LF. */
3439 val = Qnil;
3440 else
3442 if (NILP (host) || NILP (service))
3443 coding_systems = Qnil;
3444 else
3446 fargs[0] = Qopen_network_stream, fargs[1] = name,
3447 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3448 GCPRO1 (proc);
3449 coding_systems = Ffind_operation_coding_system (5, fargs);
3450 UNGCPRO;
3452 if (CONSP (coding_systems))
3453 val = XCAR (coding_systems);
3454 else if (CONSP (Vdefault_process_coding_system))
3455 val = XCAR (Vdefault_process_coding_system);
3456 else
3457 val = Qnil;
3459 pset_decode_coding_system (p, val);
3461 if (!NILP (tem))
3463 val = XCAR (XCDR (tem));
3464 if (CONSP (val))
3465 val = XCDR (val);
3467 else if (!NILP (Vcoding_system_for_write))
3468 val = Vcoding_system_for_write;
3469 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3470 val = Qnil;
3471 else
3473 if (EQ (coding_systems, Qt))
3475 if (NILP (host) || NILP (service))
3476 coding_systems = Qnil;
3477 else
3479 fargs[0] = Qopen_network_stream, fargs[1] = name,
3480 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3481 GCPRO1 (proc);
3482 coding_systems = Ffind_operation_coding_system (5, fargs);
3483 UNGCPRO;
3486 if (CONSP (coding_systems))
3487 val = XCDR (coding_systems);
3488 else if (CONSP (Vdefault_process_coding_system))
3489 val = XCDR (Vdefault_process_coding_system);
3490 else
3491 val = Qnil;
3493 pset_encode_coding_system (p, val);
3495 setup_process_coding_systems (proc);
3497 pset_decoding_buf (p, empty_unibyte_string);
3498 p->decoding_carryover = 0;
3499 pset_encoding_buf (p, empty_unibyte_string);
3501 p->inherit_coding_system_flag
3502 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3504 UNGCPRO;
3505 return proc;
3509 #if defined (HAVE_NET_IF_H)
3511 #ifdef SIOCGIFCONF
3512 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3513 doc: /* Return an alist of all network interfaces and their network address.
3514 Each element is a cons, the car of which is a string containing the
3515 interface name, and the cdr is the network address in internal
3516 format; see the description of ADDRESS in `make-network-process'. */)
3517 (void)
3519 struct ifconf ifconf;
3520 struct ifreq *ifreq;
3521 void *buf = NULL;
3522 ptrdiff_t buf_size = 512;
3523 int s, i;
3524 Lisp_Object res;
3526 s = socket (AF_INET, SOCK_STREAM, 0);
3527 if (s < 0)
3528 return Qnil;
3532 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3533 ifconf.ifc_buf = buf;
3534 ifconf.ifc_len = buf_size;
3535 if (ioctl (s, SIOCGIFCONF, &ifconf))
3537 close (s);
3538 xfree (buf);
3539 return Qnil;
3542 while (ifconf.ifc_len == buf_size);
3544 close (s);
3546 res = Qnil;
3547 ifreq = ifconf.ifc_req;
3548 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3550 struct ifreq *ifq = ifreq;
3551 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3552 #define SIZEOF_IFREQ(sif) \
3553 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3554 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3556 int len = SIZEOF_IFREQ (ifq);
3557 #else
3558 int len = sizeof (*ifreq);
3559 #endif
3560 char namebuf[sizeof (ifq->ifr_name) + 1];
3561 i += len;
3562 ifreq = (struct ifreq *) ((char *) ifreq + len);
3564 if (ifq->ifr_addr.sa_family != AF_INET)
3565 continue;
3567 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3568 namebuf[sizeof (ifq->ifr_name)] = 0;
3569 res = Fcons (Fcons (build_string (namebuf),
3570 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3571 sizeof (struct sockaddr))),
3572 res);
3575 xfree (buf);
3576 return res;
3578 #endif /* SIOCGIFCONF */
3580 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3582 struct ifflag_def {
3583 int flag_bit;
3584 const char *flag_sym;
3587 static const struct ifflag_def ifflag_table[] = {
3588 #ifdef IFF_UP
3589 { IFF_UP, "up" },
3590 #endif
3591 #ifdef IFF_BROADCAST
3592 { IFF_BROADCAST, "broadcast" },
3593 #endif
3594 #ifdef IFF_DEBUG
3595 { IFF_DEBUG, "debug" },
3596 #endif
3597 #ifdef IFF_LOOPBACK
3598 { IFF_LOOPBACK, "loopback" },
3599 #endif
3600 #ifdef IFF_POINTOPOINT
3601 { IFF_POINTOPOINT, "pointopoint" },
3602 #endif
3603 #ifdef IFF_RUNNING
3604 { IFF_RUNNING, "running" },
3605 #endif
3606 #ifdef IFF_NOARP
3607 { IFF_NOARP, "noarp" },
3608 #endif
3609 #ifdef IFF_PROMISC
3610 { IFF_PROMISC, "promisc" },
3611 #endif
3612 #ifdef IFF_NOTRAILERS
3613 #ifdef NS_IMPL_COCOA
3614 /* Really means smart, notrailers is obsolete */
3615 { IFF_NOTRAILERS, "smart" },
3616 #else
3617 { IFF_NOTRAILERS, "notrailers" },
3618 #endif
3619 #endif
3620 #ifdef IFF_ALLMULTI
3621 { IFF_ALLMULTI, "allmulti" },
3622 #endif
3623 #ifdef IFF_MASTER
3624 { IFF_MASTER, "master" },
3625 #endif
3626 #ifdef IFF_SLAVE
3627 { IFF_SLAVE, "slave" },
3628 #endif
3629 #ifdef IFF_MULTICAST
3630 { IFF_MULTICAST, "multicast" },
3631 #endif
3632 #ifdef IFF_PORTSEL
3633 { IFF_PORTSEL, "portsel" },
3634 #endif
3635 #ifdef IFF_AUTOMEDIA
3636 { IFF_AUTOMEDIA, "automedia" },
3637 #endif
3638 #ifdef IFF_DYNAMIC
3639 { IFF_DYNAMIC, "dynamic" },
3640 #endif
3641 #ifdef IFF_OACTIVE
3642 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3643 #endif
3644 #ifdef IFF_SIMPLEX
3645 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3646 #endif
3647 #ifdef IFF_LINK0
3648 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3649 #endif
3650 #ifdef IFF_LINK1
3651 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3652 #endif
3653 #ifdef IFF_LINK2
3654 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3655 #endif
3656 { 0, 0 }
3659 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3660 doc: /* Return information about network interface named IFNAME.
3661 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3662 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3663 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
3664 FLAGS is the current flags of the interface. */)
3665 (Lisp_Object ifname)
3667 struct ifreq rq;
3668 Lisp_Object res = Qnil;
3669 Lisp_Object elt;
3670 int s;
3671 int any = 0;
3672 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3673 && defined HAVE_GETIFADDRS && defined LLADDR)
3674 struct ifaddrs *ifap;
3675 #endif
3677 CHECK_STRING (ifname);
3679 if (sizeof rq.ifr_name <= SBYTES (ifname))
3680 error ("interface name too long");
3681 strcpy (rq.ifr_name, SSDATA (ifname));
3683 s = socket (AF_INET, SOCK_STREAM, 0);
3684 if (s < 0)
3685 return Qnil;
3687 elt = Qnil;
3688 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3689 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3691 int flags = rq.ifr_flags;
3692 const struct ifflag_def *fp;
3693 int fnum;
3695 /* If flags is smaller than int (i.e. short) it may have the high bit set
3696 due to IFF_MULTICAST. In that case, sign extending it into
3697 an int is wrong. */
3698 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3699 flags = (unsigned short) rq.ifr_flags;
3701 any = 1;
3702 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3704 if (flags & fp->flag_bit)
3706 elt = Fcons (intern (fp->flag_sym), elt);
3707 flags -= fp->flag_bit;
3710 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3712 if (flags & 1)
3714 elt = Fcons (make_number (fnum), elt);
3718 #endif
3719 res = Fcons (elt, res);
3721 elt = Qnil;
3722 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3723 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3725 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3726 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3727 int n;
3729 any = 1;
3730 for (n = 0; n < 6; n++)
3731 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3732 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3734 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3735 if (getifaddrs (&ifap) != -1)
3737 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3738 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3739 struct ifaddrs *it;
3741 for (it = ifap; it != NULL; it = it->ifa_next)
3743 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3744 unsigned char linkaddr[6];
3745 int n;
3747 if (it->ifa_addr->sa_family != AF_LINK
3748 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3749 || sdl->sdl_alen != 6)
3750 continue;
3752 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3753 for (n = 0; n < 6; n++)
3754 p->contents[n] = make_number (linkaddr[n]);
3756 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3757 break;
3760 #ifdef HAVE_FREEIFADDRS
3761 freeifaddrs (ifap);
3762 #endif
3764 #endif /* HAVE_GETIFADDRS && LLADDR */
3766 res = Fcons (elt, res);
3768 elt = Qnil;
3769 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3770 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3772 any = 1;
3773 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3774 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3775 #else
3776 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3777 #endif
3779 #endif
3780 res = Fcons (elt, res);
3782 elt = Qnil;
3783 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3784 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3786 any = 1;
3787 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3789 #endif
3790 res = Fcons (elt, res);
3792 elt = Qnil;
3793 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3794 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3796 any = 1;
3797 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3799 #endif
3800 res = Fcons (elt, res);
3802 close (s);
3804 return any ? res : Qnil;
3806 #endif
3807 #endif /* defined (HAVE_NET_IF_H) */
3809 /* Turn off input and output for process PROC. */
3811 static void
3812 deactivate_process (Lisp_Object proc)
3814 register int inchannel, outchannel;
3815 register struct Lisp_Process *p = XPROCESS (proc);
3817 #ifdef HAVE_GNUTLS
3818 /* Delete GnuTLS structures in PROC, if any. */
3819 emacs_gnutls_deinit (proc);
3820 #endif /* HAVE_GNUTLS */
3822 inchannel = p->infd;
3823 outchannel = p->outfd;
3825 #ifdef ADAPTIVE_READ_BUFFERING
3826 if (p->read_output_delay > 0)
3828 if (--process_output_delay_count < 0)
3829 process_output_delay_count = 0;
3830 p->read_output_delay = 0;
3831 p->read_output_skip = 0;
3833 #endif
3835 if (inchannel >= 0)
3837 /* Beware SIGCHLD hereabouts. */
3838 flush_pending_output (inchannel);
3839 emacs_close (inchannel);
3840 if (outchannel >= 0 && outchannel != inchannel)
3841 emacs_close (outchannel);
3843 p->infd = -1;
3844 p->outfd = -1;
3845 #ifdef DATAGRAM_SOCKETS
3846 if (DATAGRAM_CHAN_P (inchannel))
3848 xfree (datagram_address[inchannel].sa);
3849 datagram_address[inchannel].sa = 0;
3850 datagram_address[inchannel].len = 0;
3852 #endif
3853 chan_process[inchannel] = Qnil;
3854 FD_CLR (inchannel, &input_wait_mask);
3855 FD_CLR (inchannel, &non_keyboard_wait_mask);
3856 #ifdef NON_BLOCKING_CONNECT
3857 if (FD_ISSET (inchannel, &connect_wait_mask))
3859 FD_CLR (inchannel, &connect_wait_mask);
3860 FD_CLR (inchannel, &write_mask);
3861 if (--num_pending_connects < 0)
3862 emacs_abort ();
3864 #endif
3865 if (inchannel == max_process_desc)
3867 int i;
3868 /* We just closed the highest-numbered process input descriptor,
3869 so recompute the highest-numbered one now. */
3870 max_process_desc = 0;
3871 for (i = 0; i < MAXDESC; i++)
3872 if (!NILP (chan_process[i]))
3873 max_process_desc = i;
3879 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3880 0, 4, 0,
3881 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3882 It is read into the process' buffers or given to their filter functions.
3883 Non-nil arg PROCESS means do not return until some output has been received
3884 from PROCESS.
3886 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3887 and milliseconds to wait; return after that much time whether or not
3888 there is any subprocess output. If SECONDS is a floating point number,
3889 it specifies a fractional number of seconds to wait.
3890 The MILLISEC argument is obsolete and should be avoided.
3892 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3893 from PROCESS, suspending reading output from other processes.
3894 If JUST-THIS-ONE is an integer, don't run any timers either.
3895 Return non-nil if we received any output before the timeout expired. */)
3896 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3898 intmax_t secs;
3899 int nsecs;
3901 if (! NILP (process))
3902 CHECK_PROCESS (process);
3903 else
3904 just_this_one = Qnil;
3906 if (!NILP (millisec))
3907 { /* Obsolete calling convention using integers rather than floats. */
3908 CHECK_NUMBER (millisec);
3909 if (NILP (seconds))
3910 seconds = make_float (XINT (millisec) / 1000.0);
3911 else
3913 CHECK_NUMBER (seconds);
3914 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3918 secs = 0;
3919 nsecs = -1;
3921 if (!NILP (seconds))
3923 if (INTEGERP (seconds))
3925 if (0 < XINT (seconds))
3927 secs = XINT (seconds);
3928 nsecs = 0;
3931 else if (FLOATP (seconds))
3933 if (0 < XFLOAT_DATA (seconds))
3935 EMACS_TIME t = EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (seconds));
3936 secs = min (EMACS_SECS (t), WAIT_READING_MAX);
3937 nsecs = EMACS_NSECS (t);
3940 else
3941 wrong_type_argument (Qnumberp, seconds);
3943 else if (! NILP (process))
3944 nsecs = 0;
3946 return
3947 (wait_reading_process_output (secs, nsecs, 0, 0,
3948 Qnil,
3949 !NILP (process) ? XPROCESS (process) : NULL,
3950 NILP (just_this_one) ? 0 :
3951 !INTEGERP (just_this_one) ? 1 : -1)
3952 ? Qt : Qnil);
3955 /* Accept a connection for server process SERVER on CHANNEL. */
3957 static int connect_counter = 0;
3959 static void
3960 server_accept_connection (Lisp_Object server, int channel)
3962 Lisp_Object proc, caller, name, buffer;
3963 Lisp_Object contact, host, service;
3964 struct Lisp_Process *ps= XPROCESS (server);
3965 struct Lisp_Process *p;
3966 int s;
3967 union u_sockaddr {
3968 struct sockaddr sa;
3969 struct sockaddr_in in;
3970 #ifdef AF_INET6
3971 struct sockaddr_in6 in6;
3972 #endif
3973 #ifdef HAVE_LOCAL_SOCKETS
3974 struct sockaddr_un un;
3975 #endif
3976 } saddr;
3977 socklen_t len = sizeof saddr;
3979 s = accept (channel, &saddr.sa, &len);
3981 if (s < 0)
3983 int code = errno;
3985 if (code == EAGAIN)
3986 return;
3987 #ifdef EWOULDBLOCK
3988 if (code == EWOULDBLOCK)
3989 return;
3990 #endif
3992 if (!NILP (ps->log))
3993 call3 (ps->log, server, Qnil,
3994 concat3 (build_string ("accept failed with code"),
3995 Fnumber_to_string (make_number (code)),
3996 build_string ("\n")));
3997 return;
4000 connect_counter++;
4002 /* Setup a new process to handle the connection. */
4004 /* Generate a unique identification of the caller, and build contact
4005 information for this process. */
4006 host = Qt;
4007 service = Qnil;
4008 switch (saddr.sa.sa_family)
4010 case AF_INET:
4012 Lisp_Object args[5];
4013 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4014 args[0] = build_string ("%d.%d.%d.%d");
4015 args[1] = make_number (*ip++);
4016 args[2] = make_number (*ip++);
4017 args[3] = make_number (*ip++);
4018 args[4] = make_number (*ip++);
4019 host = Fformat (5, args);
4020 service = make_number (ntohs (saddr.in.sin_port));
4022 args[0] = build_string (" <%s:%d>");
4023 args[1] = host;
4024 args[2] = service;
4025 caller = Fformat (3, args);
4027 break;
4029 #ifdef AF_INET6
4030 case AF_INET6:
4032 Lisp_Object args[9];
4033 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4034 int i;
4035 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4036 for (i = 0; i < 8; i++)
4037 args[i+1] = make_number (ntohs (ip6[i]));
4038 host = Fformat (9, args);
4039 service = make_number (ntohs (saddr.in.sin_port));
4041 args[0] = build_string (" <[%s]:%d>");
4042 args[1] = host;
4043 args[2] = service;
4044 caller = Fformat (3, args);
4046 break;
4047 #endif
4049 #ifdef HAVE_LOCAL_SOCKETS
4050 case AF_LOCAL:
4051 #endif
4052 default:
4053 caller = Fnumber_to_string (make_number (connect_counter));
4054 caller = concat3 (build_string (" <"), caller, build_string (">"));
4055 break;
4058 /* Create a new buffer name for this process if it doesn't have a
4059 filter. The new buffer name is based on the buffer name or
4060 process name of the server process concatenated with the caller
4061 identification. */
4063 if (!NILP (ps->filter) && !EQ (ps->filter, Qt))
4064 buffer = Qnil;
4065 else
4067 buffer = ps->buffer;
4068 if (!NILP (buffer))
4069 buffer = Fbuffer_name (buffer);
4070 else
4071 buffer = ps->name;
4072 if (!NILP (buffer))
4074 buffer = concat2 (buffer, caller);
4075 buffer = Fget_buffer_create (buffer);
4079 /* Generate a unique name for the new server process. Combine the
4080 server process name with the caller identification. */
4082 name = concat2 (ps->name, caller);
4083 proc = make_process (name);
4085 chan_process[s] = proc;
4087 fcntl (s, F_SETFL, O_NONBLOCK);
4089 p = XPROCESS (proc);
4091 /* Build new contact information for this setup. */
4092 contact = Fcopy_sequence (ps->childp);
4093 contact = Fplist_put (contact, QCserver, Qnil);
4094 contact = Fplist_put (contact, QChost, host);
4095 if (!NILP (service))
4096 contact = Fplist_put (contact, QCservice, service);
4097 contact = Fplist_put (contact, QCremote,
4098 conv_sockaddr_to_lisp (&saddr.sa, len));
4099 #ifdef HAVE_GETSOCKNAME
4100 len = sizeof saddr;
4101 if (getsockname (s, &saddr.sa, &len) == 0)
4102 contact = Fplist_put (contact, QClocal,
4103 conv_sockaddr_to_lisp (&saddr.sa, len));
4104 #endif
4106 pset_childp (p, contact);
4107 pset_plist (p, Fcopy_sequence (ps->plist));
4108 pset_type (p, Qnetwork);
4110 pset_buffer (p, buffer);
4111 pset_sentinel (p, ps->sentinel);
4112 pset_filter (p, ps->filter);
4113 pset_command (p, Qnil);
4114 p->pid = 0;
4115 p->infd = s;
4116 p->outfd = s;
4117 pset_status (p, Qrun);
4119 /* Client processes for accepted connections are not stopped initially. */
4120 if (!EQ (p->filter, Qt))
4122 FD_SET (s, &input_wait_mask);
4123 FD_SET (s, &non_keyboard_wait_mask);
4126 if (s > max_process_desc)
4127 max_process_desc = s;
4129 /* Setup coding system for new process based on server process.
4130 This seems to be the proper thing to do, as the coding system
4131 of the new process should reflect the settings at the time the
4132 server socket was opened; not the current settings. */
4134 pset_decode_coding_system (p, ps->decode_coding_system);
4135 pset_encode_coding_system (p, ps->encode_coding_system);
4136 setup_process_coding_systems (proc);
4138 pset_decoding_buf (p, empty_unibyte_string);
4139 p->decoding_carryover = 0;
4140 pset_encoding_buf (p, empty_unibyte_string);
4142 p->inherit_coding_system_flag
4143 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4145 if (!NILP (ps->log))
4146 call3 (ps->log, server, proc,
4147 concat3 (build_string ("accept from "),
4148 (STRINGP (host) ? host : build_string ("-")),
4149 build_string ("\n")));
4151 if (!NILP (p->sentinel))
4152 exec_sentinel (proc,
4153 concat3 (build_string ("open from "),
4154 (STRINGP (host) ? host : build_string ("-")),
4155 build_string ("\n")));
4158 /* This variable is different from waiting_for_input in keyboard.c.
4159 It is used to communicate to a lisp process-filter/sentinel (via the
4160 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4161 for user-input when that process-filter was called.
4162 waiting_for_input cannot be used as that is by definition 0 when
4163 lisp code is being evalled.
4164 This is also used in record_asynch_buffer_change.
4165 For that purpose, this must be 0
4166 when not inside wait_reading_process_output. */
4167 static int waiting_for_user_input_p;
4169 static Lisp_Object
4170 wait_reading_process_output_unwind (Lisp_Object data)
4172 waiting_for_user_input_p = XINT (data);
4173 return Qnil;
4176 /* This is here so breakpoints can be put on it. */
4177 static void
4178 wait_reading_process_output_1 (void)
4182 /* Read and dispose of subprocess output while waiting for timeout to
4183 elapse and/or keyboard input to be available.
4185 TIME_LIMIT is:
4186 timeout in seconds
4187 If negative, gobble data immediately available but don't wait for any.
4189 NSECS is:
4190 an additional duration to wait, measured in nanoseconds
4191 If TIME_LIMIT is zero, then:
4192 If NSECS == 0, there is no limit.
4193 If NSECS > 0, the timeout consists of NSECS only.
4194 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4196 READ_KBD is:
4197 0 to ignore keyboard input, or
4198 1 to return when input is available, or
4199 -1 meaning caller will actually read the input, so don't throw to
4200 the quit handler, or
4202 DO_DISPLAY means redisplay should be done to show subprocess
4203 output that arrives.
4205 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4206 (and gobble terminal input into the buffer if any arrives).
4208 If WAIT_PROC is specified, wait until something arrives from that
4209 process. The return value is true if we read some input from
4210 that process.
4212 If JUST_WAIT_PROC is non-nil, handle only output from WAIT_PROC
4213 (suspending output from other processes). A negative value
4214 means don't run any timers either.
4216 If WAIT_PROC is specified, then the function returns true if we
4217 received input from that process before the timeout elapsed.
4218 Otherwise, return true if we received input from any process. */
4221 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4222 bool do_display,
4223 Lisp_Object wait_for_cell,
4224 struct Lisp_Process *wait_proc, int just_wait_proc)
4226 register int channel, nfds;
4227 SELECT_TYPE Available;
4228 SELECT_TYPE Writeok;
4229 int check_write;
4230 int check_delay, no_avail;
4231 int xerrno;
4232 Lisp_Object proc;
4233 EMACS_TIME timeout, end_time;
4234 int wait_channel = -1;
4235 int got_some_input = 0;
4236 ptrdiff_t count = SPECPDL_INDEX ();
4238 FD_ZERO (&Available);
4239 FD_ZERO (&Writeok);
4241 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4242 && !(CONSP (wait_proc->status)
4243 && EQ (XCAR (wait_proc->status), Qexit)))
4244 message ("Blocking call to accept-process-output with quit inhibited!!");
4246 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4247 if (wait_proc != NULL)
4248 wait_channel = wait_proc->infd;
4250 record_unwind_protect (wait_reading_process_output_unwind,
4251 make_number (waiting_for_user_input_p));
4252 waiting_for_user_input_p = read_kbd;
4254 if (time_limit < 0)
4256 time_limit = 0;
4257 nsecs = -1;
4259 else if (TYPE_MAXIMUM (time_t) < time_limit)
4260 time_limit = TYPE_MAXIMUM (time_t);
4262 /* Since we may need to wait several times,
4263 compute the absolute time to return at. */
4264 if (time_limit || 0 < nsecs)
4266 timeout = make_emacs_time (time_limit, nsecs);
4267 end_time = add_emacs_time (current_emacs_time (), timeout);
4270 while (1)
4272 int timeout_reduced_for_timers = 0;
4274 /* If calling from keyboard input, do not quit
4275 since we want to return C-g as an input character.
4276 Otherwise, do pending quit if requested. */
4277 if (read_kbd >= 0)
4278 QUIT;
4279 else if (pending_signals)
4280 process_pending_signals ();
4282 /* Exit now if the cell we're waiting for became non-nil. */
4283 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4284 break;
4286 /* Compute time from now till when time limit is up */
4287 /* Exit if already run out */
4288 if (nsecs < 0)
4290 /* A negative timeout means
4291 gobble output available now
4292 but don't wait at all. */
4294 timeout = make_emacs_time (0, 0);
4296 else if (time_limit || 0 < nsecs)
4298 EMACS_TIME now = current_emacs_time ();
4299 if (EMACS_TIME_LE (end_time, now))
4300 break;
4301 timeout = sub_emacs_time (end_time, now);
4303 else
4305 timeout = make_emacs_time (100000, 0);
4308 /* Normally we run timers here.
4309 But not if wait_for_cell; in those cases,
4310 the wait is supposed to be short,
4311 and those callers cannot handle running arbitrary Lisp code here. */
4312 if (NILP (wait_for_cell)
4313 && just_wait_proc >= 0)
4315 EMACS_TIME timer_delay;
4319 unsigned old_timers_run = timers_run;
4320 struct buffer *old_buffer = current_buffer;
4321 Lisp_Object old_window = selected_window;
4323 timer_delay = timer_check ();
4325 /* If a timer has run, this might have changed buffers
4326 an alike. Make read_key_sequence aware of that. */
4327 if (timers_run != old_timers_run
4328 && (old_buffer != current_buffer
4329 || !EQ (old_window, selected_window))
4330 && waiting_for_user_input_p == -1)
4331 record_asynch_buffer_change ();
4333 if (timers_run != old_timers_run && do_display)
4334 /* We must retry, since a timer may have requeued itself
4335 and that could alter the time_delay. */
4336 redisplay_preserve_echo_area (9);
4337 else
4338 break;
4340 while (!detect_input_pending ());
4342 /* If there is unread keyboard input, also return. */
4343 if (read_kbd != 0
4344 && requeued_events_pending_p ())
4345 break;
4347 /* A negative timeout means do not wait at all. */
4348 if (0 <= nsecs)
4350 if (EMACS_TIME_VALID_P (timer_delay))
4352 if (EMACS_TIME_LT (timer_delay, timeout))
4354 timeout = timer_delay;
4355 timeout_reduced_for_timers = 1;
4358 else
4360 /* This is so a breakpoint can be put here. */
4361 wait_reading_process_output_1 ();
4366 /* Cause C-g and alarm signals to take immediate action,
4367 and cause input available signals to zero out timeout.
4369 It is important that we do this before checking for process
4370 activity. If we get a SIGCHLD after the explicit checks for
4371 process activity, timeout is the only way we will know. */
4372 if (read_kbd < 0)
4373 set_waiting_for_input (&timeout);
4375 /* If status of something has changed, and no input is
4376 available, notify the user of the change right away. After
4377 this explicit check, we'll let the SIGCHLD handler zap
4378 timeout to get our attention. */
4379 if (update_tick != process_tick)
4381 SELECT_TYPE Atemp;
4382 SELECT_TYPE Ctemp;
4384 if (kbd_on_hold_p ())
4385 FD_ZERO (&Atemp);
4386 else
4387 Atemp = input_wait_mask;
4388 Ctemp = write_mask;
4390 timeout = make_emacs_time (0, 0);
4391 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4392 &Atemp,
4393 #ifdef NON_BLOCKING_CONNECT
4394 (num_pending_connects > 0 ? &Ctemp : NULL),
4395 #else
4396 NULL,
4397 #endif
4398 NULL, &timeout, NULL)
4399 <= 0))
4401 /* It's okay for us to do this and then continue with
4402 the loop, since timeout has already been zeroed out. */
4403 clear_waiting_for_input ();
4404 status_notify (NULL);
4405 if (do_display) redisplay_preserve_echo_area (13);
4409 /* Don't wait for output from a non-running process. Just
4410 read whatever data has already been received. */
4411 if (wait_proc && wait_proc->raw_status_new)
4412 update_status (wait_proc);
4413 if (wait_proc
4414 && ! EQ (wait_proc->status, Qrun)
4415 && ! EQ (wait_proc->status, Qconnect))
4417 int nread, total_nread = 0;
4419 clear_waiting_for_input ();
4420 XSETPROCESS (proc, wait_proc);
4422 /* Read data from the process, until we exhaust it. */
4423 while (wait_proc->infd >= 0)
4425 nread = read_process_output (proc, wait_proc->infd);
4427 if (nread == 0)
4428 break;
4430 if (0 < nread)
4432 total_nread += nread;
4433 got_some_input = 1;
4435 #ifdef EIO
4436 else if (nread == -1 && EIO == errno)
4437 break;
4438 #endif
4439 #ifdef EAGAIN
4440 else if (nread == -1 && EAGAIN == errno)
4441 break;
4442 #endif
4443 #ifdef EWOULDBLOCK
4444 else if (nread == -1 && EWOULDBLOCK == errno)
4445 break;
4446 #endif
4448 if (total_nread > 0 && do_display)
4449 redisplay_preserve_echo_area (10);
4451 break;
4454 /* Wait till there is something to do */
4456 if (wait_proc && just_wait_proc)
4458 if (wait_proc->infd < 0) /* Terminated */
4459 break;
4460 FD_SET (wait_proc->infd, &Available);
4461 check_delay = 0;
4462 check_write = 0;
4464 else if (!NILP (wait_for_cell))
4466 Available = non_process_wait_mask;
4467 check_delay = 0;
4468 check_write = 0;
4470 else
4472 if (! read_kbd)
4473 Available = non_keyboard_wait_mask;
4474 else
4475 Available = input_wait_mask;
4476 Writeok = write_mask;
4477 #ifdef SELECT_CANT_DO_WRITE_MASK
4478 check_write = 0;
4479 #else
4480 check_write = 1;
4481 #endif
4482 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4485 /* If frame size has changed or the window is newly mapped,
4486 redisplay now, before we start to wait. There is a race
4487 condition here; if a SIGIO arrives between now and the select
4488 and indicates that a frame is trashed, the select may block
4489 displaying a trashed screen. */
4490 if (frame_garbaged && do_display)
4492 clear_waiting_for_input ();
4493 redisplay_preserve_echo_area (11);
4494 if (read_kbd < 0)
4495 set_waiting_for_input (&timeout);
4498 /* Skip the `select' call if input is available and we're
4499 waiting for keyboard input or a cell change (which can be
4500 triggered by processing X events). In the latter case, set
4501 nfds to 1 to avoid breaking the loop. */
4502 no_avail = 0;
4503 if ((read_kbd || !NILP (wait_for_cell))
4504 && detect_input_pending ())
4506 nfds = read_kbd ? 0 : 1;
4507 no_avail = 1;
4510 if (!no_avail)
4513 #ifdef ADAPTIVE_READ_BUFFERING
4514 /* Set the timeout for adaptive read buffering if any
4515 process has non-zero read_output_skip and non-zero
4516 read_output_delay, and we are not reading output for a
4517 specific wait_channel. It is not executed if
4518 Vprocess_adaptive_read_buffering is nil. */
4519 if (process_output_skip && check_delay > 0)
4521 int nsecs = EMACS_NSECS (timeout);
4522 if (EMACS_SECS (timeout) > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4523 nsecs = READ_OUTPUT_DELAY_MAX;
4524 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4526 proc = chan_process[channel];
4527 if (NILP (proc))
4528 continue;
4529 /* Find minimum non-zero read_output_delay among the
4530 processes with non-zero read_output_skip. */
4531 if (XPROCESS (proc)->read_output_delay > 0)
4533 check_delay--;
4534 if (!XPROCESS (proc)->read_output_skip)
4535 continue;
4536 FD_CLR (channel, &Available);
4537 XPROCESS (proc)->read_output_skip = 0;
4538 if (XPROCESS (proc)->read_output_delay < nsecs)
4539 nsecs = XPROCESS (proc)->read_output_delay;
4542 timeout = make_emacs_time (0, nsecs);
4543 process_output_skip = 0;
4545 #endif
4547 #if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
4548 nfds = xg_select
4549 #elif defined (HAVE_NS)
4550 nfds = ns_select
4551 #else
4552 nfds = pselect
4553 #endif
4554 (max (max_process_desc, max_input_desc) + 1,
4555 &Available,
4556 (check_write ? &Writeok : (SELECT_TYPE *)0),
4557 NULL, &timeout, NULL);
4559 #ifdef HAVE_GNUTLS
4560 /* GnuTLS buffers data internally. In lowat mode it leaves
4561 some data in the TCP buffers so that select works, but
4562 with custom pull/push functions we need to check if some
4563 data is available in the buffers manually. */
4564 if (nfds == 0)
4566 if (! wait_proc)
4568 /* We're not waiting on a specific process, so loop
4569 through all the channels and check for data.
4570 This is a workaround needed for some versions of
4571 the gnutls library -- 2.12.14 has been confirmed
4572 to need it. See
4573 http://comments.gmane.org/gmane.emacs.devel/145074 */
4574 for (channel = 0; channel < MAXDESC; ++channel)
4575 if (! NILP (chan_process[channel]))
4577 struct Lisp_Process *p =
4578 XPROCESS (chan_process[channel]);
4579 if (p && p->gnutls_p && p->infd
4580 && ((emacs_gnutls_record_check_pending
4581 (p->gnutls_state))
4582 > 0))
4584 nfds++;
4585 FD_SET (p->infd, &Available);
4589 else
4591 /* Check this specific channel. */
4592 if (wait_proc->gnutls_p /* Check for valid process. */
4593 /* Do we have pending data? */
4594 && ((emacs_gnutls_record_check_pending
4595 (wait_proc->gnutls_state))
4596 > 0))
4598 nfds = 1;
4599 /* Set to Available. */
4600 FD_SET (wait_proc->infd, &Available);
4604 #endif
4607 xerrno = errno;
4609 /* Make C-g and alarm signals set flags again */
4610 clear_waiting_for_input ();
4612 /* If we woke up due to SIGWINCH, actually change size now. */
4613 do_pending_window_change (0);
4615 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4616 /* We waited the full specified time, so return now. */
4617 break;
4618 if (nfds < 0)
4620 if (xerrno == EINTR)
4621 no_avail = 1;
4622 else if (xerrno == EBADF)
4624 #ifdef AIX
4625 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
4626 the child's closure of the pts gives the parent a SIGHUP, and
4627 the ptc file descriptor is automatically closed,
4628 yielding EBADF here or at select() call above.
4629 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
4630 in m/ibmrt-aix.h), and here we just ignore the select error.
4631 Cleanup occurs c/o status_notify after SIGCLD. */
4632 no_avail = 1; /* Cannot depend on values returned */
4633 #else
4634 emacs_abort ();
4635 #endif
4637 else
4638 error ("select error: %s", emacs_strerror (xerrno));
4641 if (no_avail)
4643 FD_ZERO (&Available);
4644 check_write = 0;
4647 /* Check for keyboard input */
4648 /* If there is any, return immediately
4649 to give it higher priority than subprocesses */
4651 if (read_kbd != 0)
4653 unsigned old_timers_run = timers_run;
4654 struct buffer *old_buffer = current_buffer;
4655 Lisp_Object old_window = selected_window;
4656 int leave = 0;
4658 if (detect_input_pending_run_timers (do_display))
4660 swallow_events (do_display);
4661 if (detect_input_pending_run_timers (do_display))
4662 leave = 1;
4665 /* If a timer has run, this might have changed buffers
4666 an alike. Make read_key_sequence aware of that. */
4667 if (timers_run != old_timers_run
4668 && waiting_for_user_input_p == -1
4669 && (old_buffer != current_buffer
4670 || !EQ (old_window, selected_window)))
4671 record_asynch_buffer_change ();
4673 if (leave)
4674 break;
4677 /* If there is unread keyboard input, also return. */
4678 if (read_kbd != 0
4679 && requeued_events_pending_p ())
4680 break;
4682 /* If we are not checking for keyboard input now,
4683 do process events (but don't run any timers).
4684 This is so that X events will be processed.
4685 Otherwise they may have to wait until polling takes place.
4686 That would causes delays in pasting selections, for example.
4688 (We used to do this only if wait_for_cell.) */
4689 if (read_kbd == 0 && detect_input_pending ())
4691 swallow_events (do_display);
4692 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4693 if (detect_input_pending ())
4694 break;
4695 #endif
4698 /* Exit now if the cell we're waiting for became non-nil. */
4699 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4700 break;
4702 #ifdef USABLE_SIGIO
4703 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4704 go read it. This can happen with X on BSD after logging out.
4705 In that case, there really is no input and no SIGIO,
4706 but select says there is input. */
4708 if (read_kbd && interrupt_input
4709 && keyboard_bit_set (&Available) && ! noninteractive)
4710 handle_input_available_signal (SIGIO);
4711 #endif
4713 if (! wait_proc)
4714 got_some_input |= nfds > 0;
4716 /* If checking input just got us a size-change event from X,
4717 obey it now if we should. */
4718 if (read_kbd || ! NILP (wait_for_cell))
4719 do_pending_window_change (0);
4721 /* Check for data from a process. */
4722 if (no_avail || nfds == 0)
4723 continue;
4725 for (channel = 0; channel <= max_input_desc; ++channel)
4727 struct fd_callback_data *d = &fd_callback_info[channel];
4728 if (d->func
4729 && ((d->condition & FOR_READ
4730 && FD_ISSET (channel, &Available))
4731 || (d->condition & FOR_WRITE
4732 && FD_ISSET (channel, &write_mask))))
4733 d->func (channel, d->data);
4736 for (channel = 0; channel <= max_process_desc; channel++)
4738 if (FD_ISSET (channel, &Available)
4739 && FD_ISSET (channel, &non_keyboard_wait_mask)
4740 && !FD_ISSET (channel, &non_process_wait_mask))
4742 int nread;
4744 /* If waiting for this channel, arrange to return as
4745 soon as no more input to be processed. No more
4746 waiting. */
4747 if (wait_channel == channel)
4749 wait_channel = -1;
4750 nsecs = -1;
4751 got_some_input = 1;
4753 proc = chan_process[channel];
4754 if (NILP (proc))
4755 continue;
4757 /* If this is a server stream socket, accept connection. */
4758 if (EQ (XPROCESS (proc)->status, Qlisten))
4760 server_accept_connection (proc, channel);
4761 continue;
4764 /* Read data from the process, starting with our
4765 buffered-ahead character if we have one. */
4767 nread = read_process_output (proc, channel);
4768 if (nread > 0)
4770 /* Since read_process_output can run a filter,
4771 which can call accept-process-output,
4772 don't try to read from any other processes
4773 before doing the select again. */
4774 FD_ZERO (&Available);
4776 if (do_display)
4777 redisplay_preserve_echo_area (12);
4779 #ifdef EWOULDBLOCK
4780 else if (nread == -1 && errno == EWOULDBLOCK)
4782 #endif
4783 else if (nread == -1 && errno == EAGAIN)
4785 #ifdef WINDOWSNT
4786 /* FIXME: Is this special case still needed? */
4787 /* Note that we cannot distinguish between no input
4788 available now and a closed pipe.
4789 With luck, a closed pipe will be accompanied by
4790 subprocess termination and SIGCHLD. */
4791 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4793 #endif
4794 #ifdef HAVE_PTYS
4795 /* On some OSs with ptys, when the process on one end of
4796 a pty exits, the other end gets an error reading with
4797 errno = EIO instead of getting an EOF (0 bytes read).
4798 Therefore, if we get an error reading and errno =
4799 EIO, just continue, because the child process has
4800 exited and should clean itself up soon (e.g. when we
4801 get a SIGCHLD).
4803 However, it has been known to happen that the SIGCHLD
4804 got lost. So raise the signal again just in case.
4805 It can't hurt. */
4806 else if (nread == -1 && errno == EIO)
4808 struct Lisp_Process *p = XPROCESS (proc);
4810 /* Clear the descriptor now, so we only raise the
4811 signal once. */
4812 FD_CLR (channel, &input_wait_mask);
4813 FD_CLR (channel, &non_keyboard_wait_mask);
4815 if (p->pid == -2)
4817 /* If the EIO occurs on a pty, the SIGCHLD handler's
4818 waitpid call will not find the process object to
4819 delete. Do it here. */
4820 p->tick = ++process_tick;
4821 pset_status (p, Qfailed);
4823 else
4824 handle_child_signal (SIGCHLD);
4826 #endif /* HAVE_PTYS */
4827 /* If we can detect process termination, don't consider the
4828 process gone just because its pipe is closed. */
4829 #ifdef SIGCHLD
4830 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4832 #endif
4833 else
4835 /* Preserve status of processes already terminated. */
4836 XPROCESS (proc)->tick = ++process_tick;
4837 deactivate_process (proc);
4838 if (XPROCESS (proc)->raw_status_new)
4839 update_status (XPROCESS (proc));
4840 if (EQ (XPROCESS (proc)->status, Qrun))
4841 pset_status (XPROCESS (proc),
4842 list2 (Qexit, make_number (256)));
4845 #ifdef NON_BLOCKING_CONNECT
4846 if (FD_ISSET (channel, &Writeok)
4847 && FD_ISSET (channel, &connect_wait_mask))
4849 struct Lisp_Process *p;
4851 FD_CLR (channel, &connect_wait_mask);
4852 FD_CLR (channel, &write_mask);
4853 if (--num_pending_connects < 0)
4854 emacs_abort ();
4856 proc = chan_process[channel];
4857 if (NILP (proc))
4858 continue;
4860 p = XPROCESS (proc);
4862 #ifdef GNU_LINUX
4863 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4864 So only use it on systems where it is known to work. */
4866 socklen_t xlen = sizeof (xerrno);
4867 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4868 xerrno = errno;
4870 #else
4872 struct sockaddr pname;
4873 int pnamelen = sizeof (pname);
4875 /* If connection failed, getpeername will fail. */
4876 xerrno = 0;
4877 if (getpeername (channel, &pname, &pnamelen) < 0)
4879 /* Obtain connect failure code through error slippage. */
4880 char dummy;
4881 xerrno = errno;
4882 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4883 xerrno = errno;
4886 #endif
4887 if (xerrno)
4889 p->tick = ++process_tick;
4890 pset_status (p, list2 (Qfailed, make_number (xerrno)));
4891 deactivate_process (proc);
4893 else
4895 pset_status (p, Qrun);
4896 /* Execute the sentinel here. If we had relied on
4897 status_notify to do it later, it will read input
4898 from the process before calling the sentinel. */
4899 exec_sentinel (proc, build_string ("open\n"));
4900 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
4902 FD_SET (p->infd, &input_wait_mask);
4903 FD_SET (p->infd, &non_keyboard_wait_mask);
4907 #endif /* NON_BLOCKING_CONNECT */
4908 } /* end for each file descriptor */
4909 } /* end while exit conditions not met */
4911 unbind_to (count, Qnil);
4913 /* If calling from keyboard input, do not quit
4914 since we want to return C-g as an input character.
4915 Otherwise, do pending quit if requested. */
4916 if (read_kbd >= 0)
4918 /* Prevent input_pending from remaining set if we quit. */
4919 clear_input_pending ();
4920 QUIT;
4923 return got_some_input;
4926 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
4928 static Lisp_Object
4929 read_process_output_call (Lisp_Object fun_and_args)
4931 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
4934 static Lisp_Object
4935 read_process_output_error_handler (Lisp_Object error_val)
4937 cmd_error_internal (error_val, "error in process filter: ");
4938 Vinhibit_quit = Qt;
4939 update_echo_area ();
4940 Fsleep_for (make_number (2), Qnil);
4941 return Qt;
4944 /* Read pending output from the process channel,
4945 starting with our buffered-ahead character if we have one.
4946 Yield number of decoded characters read.
4948 This function reads at most 4096 characters.
4949 If you want to read all available subprocess output,
4950 you must call it repeatedly until it returns zero.
4952 The characters read are decoded according to PROC's coding-system
4953 for decoding. */
4955 static int
4956 read_process_output (Lisp_Object proc, register int channel)
4958 register ssize_t nbytes;
4959 char *chars;
4960 register Lisp_Object outstream;
4961 register struct Lisp_Process *p = XPROCESS (proc);
4962 register ptrdiff_t opoint;
4963 struct coding_system *coding = proc_decode_coding_system[channel];
4964 int carryover = p->decoding_carryover;
4965 int readmax = 4096;
4966 ptrdiff_t count = SPECPDL_INDEX ();
4967 Lisp_Object odeactivate;
4969 chars = alloca (carryover + readmax);
4970 if (carryover)
4971 /* See the comment above. */
4972 memcpy (chars, SDATA (p->decoding_buf), carryover);
4974 #ifdef DATAGRAM_SOCKETS
4975 /* We have a working select, so proc_buffered_char is always -1. */
4976 if (DATAGRAM_CHAN_P (channel))
4978 socklen_t len = datagram_address[channel].len;
4979 nbytes = recvfrom (channel, chars + carryover, readmax,
4980 0, datagram_address[channel].sa, &len);
4982 else
4983 #endif
4985 int buffered = 0 <= proc_buffered_char[channel];
4986 if (buffered)
4988 chars[carryover] = proc_buffered_char[channel];
4989 proc_buffered_char[channel] = -1;
4991 #ifdef HAVE_GNUTLS
4992 if (p->gnutls_p)
4993 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
4994 readmax - buffered);
4995 else
4996 #endif
4997 nbytes = emacs_read (channel, chars + carryover + buffered,
4998 readmax - buffered);
4999 #ifdef ADAPTIVE_READ_BUFFERING
5000 if (nbytes > 0 && p->adaptive_read_buffering)
5002 int delay = p->read_output_delay;
5003 if (nbytes < 256)
5005 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5007 if (delay == 0)
5008 process_output_delay_count++;
5009 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5012 else if (delay > 0 && nbytes == readmax - buffered)
5014 delay -= READ_OUTPUT_DELAY_INCREMENT;
5015 if (delay == 0)
5016 process_output_delay_count--;
5018 p->read_output_delay = delay;
5019 if (delay)
5021 p->read_output_skip = 1;
5022 process_output_skip = 1;
5025 #endif
5026 nbytes += buffered;
5027 nbytes += buffered && nbytes <= 0;
5030 p->decoding_carryover = 0;
5032 /* At this point, NBYTES holds number of bytes just received
5033 (including the one in proc_buffered_char[channel]). */
5034 if (nbytes <= 0)
5036 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5037 return nbytes;
5038 coding->mode |= CODING_MODE_LAST_BLOCK;
5041 /* Now set NBYTES how many bytes we must decode. */
5042 nbytes += carryover;
5044 odeactivate = Vdeactivate_mark;
5045 /* There's no good reason to let process filters change the current
5046 buffer, and many callers of accept-process-output, sit-for, and
5047 friends don't expect current-buffer to be changed from under them. */
5048 record_unwind_current_buffer ();
5050 /* Read and dispose of the process output. */
5051 outstream = p->filter;
5052 if (!NILP (outstream))
5054 Lisp_Object text;
5055 bool outer_running_asynch_code = running_asynch_code;
5056 int waiting = waiting_for_user_input_p;
5058 /* No need to gcpro these, because all we do with them later
5059 is test them for EQness, and none of them should be a string. */
5060 #if 0
5061 Lisp_Object obuffer, okeymap;
5062 XSETBUFFER (obuffer, current_buffer);
5063 okeymap = BVAR (current_buffer, keymap);
5064 #endif
5066 /* We inhibit quit here instead of just catching it so that
5067 hitting ^G when a filter happens to be running won't screw
5068 it up. */
5069 specbind (Qinhibit_quit, Qt);
5070 specbind (Qlast_nonmenu_event, Qt);
5072 /* In case we get recursively called,
5073 and we already saved the match data nonrecursively,
5074 save the same match data in safely recursive fashion. */
5075 if (outer_running_asynch_code)
5077 Lisp_Object tem;
5078 /* Don't clobber the CURRENT match data, either! */
5079 tem = Fmatch_data (Qnil, Qnil, Qnil);
5080 restore_search_regs ();
5081 record_unwind_save_match_data ();
5082 Fset_match_data (tem, Qt);
5085 /* For speed, if a search happens within this code,
5086 save the match data in a special nonrecursive fashion. */
5087 running_asynch_code = 1;
5089 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5090 text = coding->dst_object;
5091 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5092 /* A new coding system might be found. */
5093 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5095 pset_decode_coding_system (p, Vlast_coding_system_used);
5097 /* Don't call setup_coding_system for
5098 proc_decode_coding_system[channel] here. It is done in
5099 detect_coding called via decode_coding above. */
5101 /* If a coding system for encoding is not yet decided, we set
5102 it as the same as coding-system for decoding.
5104 But, before doing that we must check if
5105 proc_encode_coding_system[p->outfd] surely points to a
5106 valid memory because p->outfd will be changed once EOF is
5107 sent to the process. */
5108 if (NILP (p->encode_coding_system)
5109 && proc_encode_coding_system[p->outfd])
5111 pset_encode_coding_system
5112 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5113 setup_coding_system (p->encode_coding_system,
5114 proc_encode_coding_system[p->outfd]);
5118 if (coding->carryover_bytes > 0)
5120 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5121 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5122 memcpy (SDATA (p->decoding_buf), coding->carryover,
5123 coding->carryover_bytes);
5124 p->decoding_carryover = coding->carryover_bytes;
5126 if (SBYTES (text) > 0)
5127 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5128 sometimes it's simply wrong to wrap (e.g. when called from
5129 accept-process-output). */
5130 internal_condition_case_1 (read_process_output_call,
5131 Fcons (outstream,
5132 Fcons (proc, Fcons (text, Qnil))),
5133 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5134 read_process_output_error_handler);
5136 /* If we saved the match data nonrecursively, restore it now. */
5137 restore_search_regs ();
5138 running_asynch_code = outer_running_asynch_code;
5140 /* Restore waiting_for_user_input_p as it was
5141 when we were called, in case the filter clobbered it. */
5142 waiting_for_user_input_p = waiting;
5144 #if 0 /* Call record_asynch_buffer_change unconditionally,
5145 because we might have changed minor modes or other things
5146 that affect key bindings. */
5147 if (! EQ (Fcurrent_buffer (), obuffer)
5148 || ! EQ (current_buffer->keymap, okeymap))
5149 #endif
5150 /* But do it only if the caller is actually going to read events.
5151 Otherwise there's no need to make him wake up, and it could
5152 cause trouble (for example it would make sit_for return). */
5153 if (waiting_for_user_input_p == -1)
5154 record_asynch_buffer_change ();
5157 /* If no filter, write into buffer if it isn't dead. */
5158 else if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5160 Lisp_Object old_read_only;
5161 ptrdiff_t old_begv, old_zv;
5162 ptrdiff_t old_begv_byte, old_zv_byte;
5163 ptrdiff_t before, before_byte;
5164 ptrdiff_t opoint_byte;
5165 Lisp_Object text;
5166 struct buffer *b;
5168 Fset_buffer (p->buffer);
5169 opoint = PT;
5170 opoint_byte = PT_BYTE;
5171 old_read_only = BVAR (current_buffer, read_only);
5172 old_begv = BEGV;
5173 old_zv = ZV;
5174 old_begv_byte = BEGV_BYTE;
5175 old_zv_byte = ZV_BYTE;
5177 bset_read_only (current_buffer, Qnil);
5179 /* Insert new output into buffer
5180 at the current end-of-output marker,
5181 thus preserving logical ordering of input and output. */
5182 if (XMARKER (p->mark)->buffer)
5183 SET_PT_BOTH (clip_to_bounds (BEGV,
5184 marker_position (p->mark), ZV),
5185 clip_to_bounds (BEGV_BYTE,
5186 marker_byte_position (p->mark),
5187 ZV_BYTE));
5188 else
5189 SET_PT_BOTH (ZV, ZV_BYTE);
5190 before = PT;
5191 before_byte = PT_BYTE;
5193 /* If the output marker is outside of the visible region, save
5194 the restriction and widen. */
5195 if (! (BEGV <= PT && PT <= ZV))
5196 Fwiden ();
5198 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5199 text = coding->dst_object;
5200 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5201 /* A new coding system might be found. See the comment in the
5202 similar code in the previous `if' block. */
5203 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5205 pset_decode_coding_system (p, Vlast_coding_system_used);
5206 if (NILP (p->encode_coding_system)
5207 && proc_encode_coding_system[p->outfd])
5209 pset_encode_coding_system
5210 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5211 setup_coding_system (p->encode_coding_system,
5212 proc_encode_coding_system[p->outfd]);
5215 if (coding->carryover_bytes > 0)
5217 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5218 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5219 memcpy (SDATA (p->decoding_buf), coding->carryover,
5220 coding->carryover_bytes);
5221 p->decoding_carryover = coding->carryover_bytes;
5223 /* Adjust the multibyteness of TEXT to that of the buffer. */
5224 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5225 != ! STRING_MULTIBYTE (text))
5226 text = (STRING_MULTIBYTE (text)
5227 ? Fstring_as_unibyte (text)
5228 : Fstring_to_multibyte (text));
5229 /* Insert before markers in case we are inserting where
5230 the buffer's mark is, and the user's next command is Meta-y. */
5231 insert_from_string_before_markers (text, 0, 0,
5232 SCHARS (text), SBYTES (text), 0);
5234 /* Make sure the process marker's position is valid when the
5235 process buffer is changed in the signal_after_change above.
5236 W3 is known to do that. */
5237 if (BUFFERP (p->buffer)
5238 && (b = XBUFFER (p->buffer), b != current_buffer))
5239 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5240 else
5241 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5243 update_mode_lines++;
5245 /* Make sure opoint and the old restrictions
5246 float ahead of any new text just as point would. */
5247 if (opoint >= before)
5249 opoint += PT - before;
5250 opoint_byte += PT_BYTE - before_byte;
5252 if (old_begv > before)
5254 old_begv += PT - before;
5255 old_begv_byte += PT_BYTE - before_byte;
5257 if (old_zv >= before)
5259 old_zv += PT - before;
5260 old_zv_byte += PT_BYTE - before_byte;
5263 /* If the restriction isn't what it should be, set it. */
5264 if (old_begv != BEGV || old_zv != ZV)
5265 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5268 bset_read_only (current_buffer, old_read_only);
5269 SET_PT_BOTH (opoint, opoint_byte);
5271 /* Handling the process output should not deactivate the mark. */
5272 Vdeactivate_mark = odeactivate;
5274 unbind_to (count, Qnil);
5275 return nbytes;
5278 /* Sending data to subprocess */
5280 /* In send_process, when a write fails temporarily,
5281 wait_reading_process_output is called. It may execute user code,
5282 e.g. timers, that attempts to write new data to the same process.
5283 We must ensure that data is sent in the right order, and not
5284 interspersed half-completed with other writes (Bug#10815). This is
5285 handled by the write_queue element of struct process. It is a list
5286 with each entry having the form
5288 (string . (offset . length))
5290 where STRING is a lisp string, OFFSET is the offset into the
5291 string's byte sequence from which we should begin to send, and
5292 LENGTH is the number of bytes left to send. */
5294 /* Create a new entry in write_queue.
5295 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5296 BUF is a pointer to the string sequence of the input_obj or a C
5297 string in case of Qt or Qnil. */
5299 static void
5300 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5301 const char *buf, ptrdiff_t len, int front)
5303 ptrdiff_t offset;
5304 Lisp_Object entry, obj;
5306 if (STRINGP (input_obj))
5308 offset = buf - SSDATA (input_obj);
5309 obj = input_obj;
5311 else
5313 offset = 0;
5314 obj = make_unibyte_string (buf, len);
5317 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5319 if (front)
5320 pset_write_queue (p, Fcons (entry, p->write_queue));
5321 else
5322 pset_write_queue (p, nconc2 (p->write_queue, Fcons (entry, Qnil)));
5325 /* Remove the first element in the write_queue of process P, put its
5326 contents in OBJ, BUF and LEN, and return non-zero. If the
5327 write_queue is empty, return zero. */
5329 static int
5330 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5331 const char **buf, ptrdiff_t *len)
5333 Lisp_Object entry, offset_length;
5334 ptrdiff_t offset;
5336 if (NILP (p->write_queue))
5337 return 0;
5339 entry = XCAR (p->write_queue);
5340 pset_write_queue (p, XCDR (p->write_queue));
5342 *obj = XCAR (entry);
5343 offset_length = XCDR (entry);
5345 *len = XINT (XCDR (offset_length));
5346 offset = XINT (XCAR (offset_length));
5347 *buf = SSDATA (*obj) + offset;
5349 return 1;
5352 /* Send some data to process PROC.
5353 BUF is the beginning of the data; LEN is the number of characters.
5354 OBJECT is the Lisp object that the data comes from. If OBJECT is
5355 nil or t, it means that the data comes from C string.
5357 If OBJECT is not nil, the data is encoded by PROC's coding-system
5358 for encoding before it is sent.
5360 This function can evaluate Lisp code and can garbage collect. */
5362 static void
5363 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
5364 Lisp_Object object)
5366 struct Lisp_Process *p = XPROCESS (proc);
5367 ssize_t rv;
5368 struct coding_system *coding;
5370 if (p->raw_status_new)
5371 update_status (p);
5372 if (! EQ (p->status, Qrun))
5373 error ("Process %s not running", SDATA (p->name));
5374 if (p->outfd < 0)
5375 error ("Output file descriptor of %s is closed", SDATA (p->name));
5377 coding = proc_encode_coding_system[p->outfd];
5378 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5380 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5381 || (BUFFERP (object)
5382 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5383 || EQ (object, Qt))
5385 pset_encode_coding_system
5386 (p, complement_process_encoding_system (p->encode_coding_system));
5387 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5389 /* The coding system for encoding was changed to raw-text
5390 because we sent a unibyte text previously. Now we are
5391 sending a multibyte text, thus we must encode it by the
5392 original coding system specified for the current process.
5394 Another reason we come here is that the coding system
5395 was just complemented and a new one was returned by
5396 complement_process_encoding_system. */
5397 setup_coding_system (p->encode_coding_system, coding);
5398 Vlast_coding_system_used = p->encode_coding_system;
5400 coding->src_multibyte = 1;
5402 else
5404 coding->src_multibyte = 0;
5405 /* For sending a unibyte text, character code conversion should
5406 not take place but EOL conversion should. So, setup raw-text
5407 or one of the subsidiary if we have not yet done it. */
5408 if (CODING_REQUIRE_ENCODING (coding))
5410 if (CODING_REQUIRE_FLUSHING (coding))
5412 /* But, before changing the coding, we must flush out data. */
5413 coding->mode |= CODING_MODE_LAST_BLOCK;
5414 send_process (proc, "", 0, Qt);
5415 coding->mode &= CODING_MODE_LAST_BLOCK;
5417 setup_coding_system (raw_text_coding_system
5418 (Vlast_coding_system_used),
5419 coding);
5420 coding->src_multibyte = 0;
5423 coding->dst_multibyte = 0;
5425 if (CODING_REQUIRE_ENCODING (coding))
5427 coding->dst_object = Qt;
5428 if (BUFFERP (object))
5430 ptrdiff_t from_byte, from, to;
5431 ptrdiff_t save_pt, save_pt_byte;
5432 struct buffer *cur = current_buffer;
5434 set_buffer_internal (XBUFFER (object));
5435 save_pt = PT, save_pt_byte = PT_BYTE;
5437 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5438 from = BYTE_TO_CHAR (from_byte);
5439 to = BYTE_TO_CHAR (from_byte + len);
5440 TEMP_SET_PT_BOTH (from, from_byte);
5441 encode_coding_object (coding, object, from, from_byte,
5442 to, from_byte + len, Qt);
5443 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5444 set_buffer_internal (cur);
5446 else if (STRINGP (object))
5448 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5449 SBYTES (object), Qt);
5451 else
5453 coding->dst_object = make_unibyte_string (buf, len);
5454 coding->produced = len;
5457 len = coding->produced;
5458 object = coding->dst_object;
5459 buf = SSDATA (object);
5462 /* If there is already data in the write_queue, put the new data
5463 in the back of queue. Otherwise, ignore it. */
5464 if (!NILP (p->write_queue))
5465 write_queue_push (p, object, buf, len, 0);
5467 do /* while !NILP (p->write_queue) */
5469 ptrdiff_t cur_len = -1;
5470 const char *cur_buf;
5471 Lisp_Object cur_object;
5473 /* If write_queue is empty, ignore it. */
5474 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5476 cur_len = len;
5477 cur_buf = buf;
5478 cur_object = object;
5481 while (cur_len > 0)
5483 /* Send this batch, using one or more write calls. */
5484 ptrdiff_t written = 0;
5485 int outfd = p->outfd;
5486 #ifdef DATAGRAM_SOCKETS
5487 if (DATAGRAM_CHAN_P (outfd))
5489 rv = sendto (outfd, cur_buf, cur_len,
5490 0, datagram_address[outfd].sa,
5491 datagram_address[outfd].len);
5492 if (0 <= rv)
5493 written = rv;
5494 else if (errno == EMSGSIZE)
5495 report_file_error ("sending datagram", Fcons (proc, Qnil));
5497 else
5498 #endif
5500 #ifdef HAVE_GNUTLS
5501 if (p->gnutls_p)
5502 written = emacs_gnutls_write (p, cur_buf, cur_len);
5503 else
5504 #endif
5505 written = emacs_write (outfd, cur_buf, cur_len);
5506 rv = (written ? 0 : -1);
5507 #ifdef ADAPTIVE_READ_BUFFERING
5508 if (p->read_output_delay > 0
5509 && p->adaptive_read_buffering == 1)
5511 p->read_output_delay = 0;
5512 process_output_delay_count--;
5513 p->read_output_skip = 0;
5515 #endif
5518 if (rv < 0)
5520 if (0
5521 #ifdef EWOULDBLOCK
5522 || errno == EWOULDBLOCK
5523 #endif
5524 #ifdef EAGAIN
5525 || errno == EAGAIN
5526 #endif
5528 /* Buffer is full. Wait, accepting input;
5529 that may allow the program
5530 to finish doing output and read more. */
5532 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5533 /* A gross hack to work around a bug in FreeBSD.
5534 In the following sequence, read(2) returns
5535 bogus data:
5537 write(2) 1022 bytes
5538 write(2) 954 bytes, get EAGAIN
5539 read(2) 1024 bytes in process_read_output
5540 read(2) 11 bytes in process_read_output
5542 That is, read(2) returns more bytes than have
5543 ever been written successfully. The 1033 bytes
5544 read are the 1022 bytes written successfully
5545 after processing (for example with CRs added if
5546 the terminal is set up that way which it is
5547 here). The same bytes will be seen again in a
5548 later read(2), without the CRs. */
5550 if (errno == EAGAIN)
5552 int flags = FWRITE;
5553 ioctl (p->outfd, TIOCFLUSH, &flags);
5555 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5557 /* Put what we should have written in wait_queue. */
5558 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5559 wait_reading_process_output (0, 20 * 1000 * 1000,
5560 0, 0, Qnil, NULL, 0);
5561 /* Reread queue, to see what is left. */
5562 break;
5564 else if (errno == EPIPE)
5566 p->raw_status_new = 0;
5567 pset_status (p, list2 (Qexit, make_number (256)));
5568 p->tick = ++process_tick;
5569 deactivate_process (proc);
5570 error ("process %s no longer connected to pipe; closed it",
5571 SDATA (p->name));
5573 else
5574 /* This is a real error. */
5575 report_file_error ("writing to process", Fcons (proc, Qnil));
5577 cur_buf += written;
5578 cur_len -= written;
5581 while (!NILP (p->write_queue));
5584 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5585 3, 3, 0,
5586 doc: /* Send current contents of region as input to PROCESS.
5587 PROCESS may be a process, a buffer, the name of a process or buffer, or
5588 nil, indicating the current buffer's process.
5589 Called from program, takes three arguments, PROCESS, START and END.
5590 If the region is more than 500 characters long,
5591 it is sent in several bunches. This may happen even for shorter regions.
5592 Output from processes can arrive in between bunches. */)
5593 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5595 Lisp_Object proc;
5596 ptrdiff_t start1, end1;
5598 proc = get_process (process);
5599 validate_region (&start, &end);
5601 if (XINT (start) < GPT && XINT (end) > GPT)
5602 move_gap (XINT (start));
5604 start1 = CHAR_TO_BYTE (XINT (start));
5605 end1 = CHAR_TO_BYTE (XINT (end));
5606 send_process (proc, (char *) BYTE_POS_ADDR (start1), end1 - start1,
5607 Fcurrent_buffer ());
5609 return Qnil;
5612 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5613 2, 2, 0,
5614 doc: /* Send PROCESS the contents of STRING as input.
5615 PROCESS may be a process, a buffer, the name of a process or buffer, or
5616 nil, indicating the current buffer's process.
5617 If STRING is more than 500 characters long,
5618 it is sent in several bunches. This may happen even for shorter strings.
5619 Output from processes can arrive in between bunches. */)
5620 (Lisp_Object process, Lisp_Object string)
5622 Lisp_Object proc;
5623 CHECK_STRING (string);
5624 proc = get_process (process);
5625 send_process (proc, SSDATA (string),
5626 SBYTES (string), string);
5627 return Qnil;
5630 /* Return the foreground process group for the tty/pty that
5631 the process P uses. */
5632 static pid_t
5633 emacs_get_tty_pgrp (struct Lisp_Process *p)
5635 pid_t gid = -1;
5637 #ifdef TIOCGPGRP
5638 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5640 int fd;
5641 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5642 master side. Try the slave side. */
5643 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5645 if (fd != -1)
5647 ioctl (fd, TIOCGPGRP, &gid);
5648 emacs_close (fd);
5651 #endif /* defined (TIOCGPGRP ) */
5653 return gid;
5656 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5657 Sprocess_running_child_p, 0, 1, 0,
5658 doc: /* Return t if PROCESS has given the terminal to a child.
5659 If the operating system does not make it possible to find out,
5660 return t unconditionally. */)
5661 (Lisp_Object process)
5663 /* Initialize in case ioctl doesn't exist or gives an error,
5664 in a way that will cause returning t. */
5665 pid_t gid;
5666 Lisp_Object proc;
5667 struct Lisp_Process *p;
5669 proc = get_process (process);
5670 p = XPROCESS (proc);
5672 if (!EQ (p->type, Qreal))
5673 error ("Process %s is not a subprocess",
5674 SDATA (p->name));
5675 if (p->infd < 0)
5676 error ("Process %s is not active",
5677 SDATA (p->name));
5679 gid = emacs_get_tty_pgrp (p);
5681 if (gid == p->pid)
5682 return Qnil;
5683 return Qt;
5686 /* send a signal number SIGNO to PROCESS.
5687 If CURRENT_GROUP is t, that means send to the process group
5688 that currently owns the terminal being used to communicate with PROCESS.
5689 This is used for various commands in shell mode.
5690 If CURRENT_GROUP is lambda, that means send to the process group
5691 that currently owns the terminal, but only if it is NOT the shell itself.
5693 If NOMSG is zero, insert signal-announcements into process's buffers
5694 right away.
5696 If we can, we try to signal PROCESS by sending control characters
5697 down the pty. This allows us to signal inferiors who have changed
5698 their uid, for which killpg would return an EPERM error. */
5700 static void
5701 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5702 int nomsg)
5704 Lisp_Object proc;
5705 register struct Lisp_Process *p;
5706 pid_t gid;
5707 int no_pgrp = 0;
5709 proc = get_process (process);
5710 p = XPROCESS (proc);
5712 if (!EQ (p->type, Qreal))
5713 error ("Process %s is not a subprocess",
5714 SDATA (p->name));
5715 if (p->infd < 0)
5716 error ("Process %s is not active",
5717 SDATA (p->name));
5719 if (!p->pty_flag)
5720 current_group = Qnil;
5722 /* If we are using pgrps, get a pgrp number and make it negative. */
5723 if (NILP (current_group))
5724 /* Send the signal to the shell's process group. */
5725 gid = p->pid;
5726 else
5728 #ifdef SIGNALS_VIA_CHARACTERS
5729 /* If possible, send signals to the entire pgrp
5730 by sending an input character to it. */
5732 struct termios t;
5733 cc_t *sig_char = NULL;
5735 tcgetattr (p->infd, &t);
5737 switch (signo)
5739 case SIGINT:
5740 sig_char = &t.c_cc[VINTR];
5741 break;
5743 case SIGQUIT:
5744 sig_char = &t.c_cc[VQUIT];
5745 break;
5747 case SIGTSTP:
5748 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5749 sig_char = &t.c_cc[VSWTCH];
5750 #else
5751 sig_char = &t.c_cc[VSUSP];
5752 #endif
5753 break;
5756 if (sig_char && *sig_char != CDISABLE)
5758 send_process (proc, (char *) sig_char, 1, Qnil);
5759 return;
5761 /* If we can't send the signal with a character,
5762 fall through and send it another way. */
5764 /* The code above may fall through if it can't
5765 handle the signal. */
5766 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5768 #ifdef TIOCGPGRP
5769 /* Get the current pgrp using the tty itself, if we have that.
5770 Otherwise, use the pty to get the pgrp.
5771 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5772 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5773 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5774 His patch indicates that if TIOCGPGRP returns an error, then
5775 we should just assume that p->pid is also the process group id. */
5777 gid = emacs_get_tty_pgrp (p);
5779 if (gid == -1)
5780 /* If we can't get the information, assume
5781 the shell owns the tty. */
5782 gid = p->pid;
5784 /* It is not clear whether anything really can set GID to -1.
5785 Perhaps on some system one of those ioctls can or could do so.
5786 Or perhaps this is vestigial. */
5787 if (gid == -1)
5788 no_pgrp = 1;
5789 #else /* ! defined (TIOCGPGRP ) */
5790 /* Can't select pgrps on this system, so we know that
5791 the child itself heads the pgrp. */
5792 gid = p->pid;
5793 #endif /* ! defined (TIOCGPGRP ) */
5795 /* If current_group is lambda, and the shell owns the terminal,
5796 don't send any signal. */
5797 if (EQ (current_group, Qlambda) && gid == p->pid)
5798 return;
5801 switch (signo)
5803 #ifdef SIGCONT
5804 case SIGCONT:
5805 p->raw_status_new = 0;
5806 pset_status (p, Qrun);
5807 p->tick = ++process_tick;
5808 if (!nomsg)
5810 status_notify (NULL);
5811 redisplay_preserve_echo_area (13);
5813 break;
5814 #endif /* ! defined (SIGCONT) */
5815 case SIGINT:
5816 case SIGQUIT:
5817 case SIGKILL:
5818 flush_pending_output (p->infd);
5819 break;
5822 /* If we don't have process groups, send the signal to the immediate
5823 subprocess. That isn't really right, but it's better than any
5824 obvious alternative. */
5825 if (no_pgrp)
5827 kill (p->pid, signo);
5828 return;
5831 /* gid may be a pid, or minus a pgrp's number */
5832 #ifdef TIOCSIGSEND
5833 if (!NILP (current_group))
5835 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5836 EMACS_KILLPG (gid, signo);
5838 else
5840 gid = - p->pid;
5841 kill (gid, signo);
5843 #else /* ! defined (TIOCSIGSEND) */
5844 EMACS_KILLPG (gid, signo);
5845 #endif /* ! defined (TIOCSIGSEND) */
5848 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5849 doc: /* Interrupt process PROCESS.
5850 PROCESS may be a process, a buffer, or the name of a process or buffer.
5851 No arg or nil means current buffer's process.
5852 Second arg CURRENT-GROUP non-nil means send signal to
5853 the current process-group of the process's controlling terminal
5854 rather than to the process's own process group.
5855 If the process is a shell, this means interrupt current subjob
5856 rather than the shell.
5858 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5859 don't send the signal. */)
5860 (Lisp_Object process, Lisp_Object current_group)
5862 process_send_signal (process, SIGINT, current_group, 0);
5863 return process;
5866 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5867 doc: /* Kill process PROCESS. May be process or name of one.
5868 See function `interrupt-process' for more details on usage. */)
5869 (Lisp_Object process, Lisp_Object current_group)
5871 process_send_signal (process, SIGKILL, current_group, 0);
5872 return process;
5875 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5876 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5877 See function `interrupt-process' for more details on usage. */)
5878 (Lisp_Object process, Lisp_Object current_group)
5880 process_send_signal (process, SIGQUIT, current_group, 0);
5881 return process;
5884 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
5885 doc: /* Stop process PROCESS. May be process or name of one.
5886 See function `interrupt-process' for more details on usage.
5887 If PROCESS is a network or serial process, inhibit handling of incoming
5888 traffic. */)
5889 (Lisp_Object process, Lisp_Object current_group)
5891 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5893 struct Lisp_Process *p;
5895 p = XPROCESS (process);
5896 if (NILP (p->command)
5897 && p->infd >= 0)
5899 FD_CLR (p->infd, &input_wait_mask);
5900 FD_CLR (p->infd, &non_keyboard_wait_mask);
5902 pset_command (p, Qt);
5903 return process;
5905 #ifndef SIGTSTP
5906 error ("No SIGTSTP support");
5907 #else
5908 process_send_signal (process, SIGTSTP, current_group, 0);
5909 #endif
5910 return process;
5913 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
5914 doc: /* Continue process PROCESS. May be process or name of one.
5915 See function `interrupt-process' for more details on usage.
5916 If PROCESS is a network or serial process, resume handling of incoming
5917 traffic. */)
5918 (Lisp_Object process, Lisp_Object current_group)
5920 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5922 struct Lisp_Process *p;
5924 p = XPROCESS (process);
5925 if (EQ (p->command, Qt)
5926 && p->infd >= 0
5927 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
5929 FD_SET (p->infd, &input_wait_mask);
5930 FD_SET (p->infd, &non_keyboard_wait_mask);
5931 #ifdef WINDOWSNT
5932 if (fd_info[ p->infd ].flags & FILE_SERIAL)
5933 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
5934 #else /* not WINDOWSNT */
5935 tcflush (p->infd, TCIFLUSH);
5936 #endif /* not WINDOWSNT */
5938 pset_command (p, Qnil);
5939 return process;
5941 #ifdef SIGCONT
5942 process_send_signal (process, SIGCONT, current_group, 0);
5943 #else
5944 error ("No SIGCONT support");
5945 #endif
5946 return process;
5949 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
5950 2, 2, "sProcess (name or number): \nnSignal code: ",
5951 doc: /* Send PROCESS the signal with code SIGCODE.
5952 PROCESS may also be a number specifying the process id of the
5953 process to signal; in this case, the process need not be a child of
5954 this Emacs.
5955 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
5956 (Lisp_Object process, Lisp_Object sigcode)
5958 pid_t pid;
5960 if (STRINGP (process))
5962 Lisp_Object tem = Fget_process (process);
5963 if (NILP (tem))
5965 Lisp_Object process_number =
5966 string_to_number (SSDATA (process), 10, 1);
5967 if (INTEGERP (process_number) || FLOATP (process_number))
5968 tem = process_number;
5970 process = tem;
5972 else if (!NUMBERP (process))
5973 process = get_process (process);
5975 if (NILP (process))
5976 return process;
5978 if (NUMBERP (process))
5979 CONS_TO_INTEGER (process, pid_t, pid);
5980 else
5982 CHECK_PROCESS (process);
5983 pid = XPROCESS (process)->pid;
5984 if (pid <= 0)
5985 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
5988 #define parse_signal(NAME, VALUE) \
5989 else if (!xstrcasecmp (name, NAME)) \
5990 XSETINT (sigcode, VALUE)
5992 if (INTEGERP (sigcode))
5993 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
5994 else
5996 char *name;
5998 CHECK_SYMBOL (sigcode);
5999 name = SSDATA (SYMBOL_NAME (sigcode));
6001 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
6002 name += 3;
6004 if (0)
6006 #ifdef SIGUSR1
6007 parse_signal ("usr1", SIGUSR1);
6008 #endif
6009 #ifdef SIGUSR2
6010 parse_signal ("usr2", SIGUSR2);
6011 #endif
6012 parse_signal ("term", SIGTERM);
6013 #ifdef SIGHUP
6014 parse_signal ("hup", SIGHUP);
6015 #endif
6016 parse_signal ("int", SIGINT);
6017 #ifdef SIGQUIT
6018 parse_signal ("quit", SIGQUIT);
6019 #endif
6020 parse_signal ("ill", SIGILL);
6021 parse_signal ("abrt", SIGABRT);
6022 #ifdef SIGEMT
6023 parse_signal ("emt", SIGEMT);
6024 #endif
6025 #ifdef SIGKILL
6026 parse_signal ("kill", SIGKILL);
6027 #endif
6028 parse_signal ("fpe", SIGFPE);
6029 #ifdef SIGBUS
6030 parse_signal ("bus", SIGBUS);
6031 #endif
6032 parse_signal ("segv", SIGSEGV);
6033 #ifdef SIGSYS
6034 parse_signal ("sys", SIGSYS);
6035 #endif
6036 #ifdef SIGPIPE
6037 parse_signal ("pipe", SIGPIPE);
6038 #endif
6039 #ifdef SIGALRM
6040 parse_signal ("alrm", SIGALRM);
6041 #endif
6042 #ifdef SIGURG
6043 parse_signal ("urg", SIGURG);
6044 #endif
6045 #ifdef SIGSTOP
6046 parse_signal ("stop", SIGSTOP);
6047 #endif
6048 #ifdef SIGTSTP
6049 parse_signal ("tstp", SIGTSTP);
6050 #endif
6051 #ifdef SIGCONT
6052 parse_signal ("cont", SIGCONT);
6053 #endif
6054 #ifdef SIGCHLD
6055 parse_signal ("chld", SIGCHLD);
6056 #endif
6057 #ifdef SIGTTIN
6058 parse_signal ("ttin", SIGTTIN);
6059 #endif
6060 #ifdef SIGTTOU
6061 parse_signal ("ttou", SIGTTOU);
6062 #endif
6063 #ifdef SIGIO
6064 parse_signal ("io", SIGIO);
6065 #endif
6066 #ifdef SIGXCPU
6067 parse_signal ("xcpu", SIGXCPU);
6068 #endif
6069 #ifdef SIGXFSZ
6070 parse_signal ("xfsz", SIGXFSZ);
6071 #endif
6072 #ifdef SIGVTALRM
6073 parse_signal ("vtalrm", SIGVTALRM);
6074 #endif
6075 #ifdef SIGPROF
6076 parse_signal ("prof", SIGPROF);
6077 #endif
6078 #ifdef SIGWINCH
6079 parse_signal ("winch", SIGWINCH);
6080 #endif
6081 #ifdef SIGINFO
6082 parse_signal ("info", SIGINFO);
6083 #endif
6084 else
6085 error ("Undefined signal name %s", name);
6088 #undef parse_signal
6090 return make_number (kill (pid, XINT (sigcode)));
6093 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6094 doc: /* Make PROCESS see end-of-file in its input.
6095 EOF comes after any text already sent to it.
6096 PROCESS may be a process, a buffer, the name of a process or buffer, or
6097 nil, indicating the current buffer's process.
6098 If PROCESS is a network connection, or is a process communicating
6099 through a pipe (as opposed to a pty), then you cannot send any more
6100 text to PROCESS after you call this function.
6101 If PROCESS is a serial process, wait until all output written to the
6102 process has been transmitted to the serial port. */)
6103 (Lisp_Object process)
6105 Lisp_Object proc;
6106 struct coding_system *coding;
6108 if (DATAGRAM_CONN_P (process))
6109 return process;
6111 proc = get_process (process);
6112 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6114 /* Make sure the process is really alive. */
6115 if (XPROCESS (proc)->raw_status_new)
6116 update_status (XPROCESS (proc));
6117 if (! EQ (XPROCESS (proc)->status, Qrun))
6118 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6120 if (CODING_REQUIRE_FLUSHING (coding))
6122 coding->mode |= CODING_MODE_LAST_BLOCK;
6123 send_process (proc, "", 0, Qnil);
6126 if (XPROCESS (proc)->pty_flag)
6127 send_process (proc, "\004", 1, Qnil);
6128 else if (EQ (XPROCESS (proc)->type, Qserial))
6130 #ifndef WINDOWSNT
6131 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6132 error ("tcdrain() failed: %s", emacs_strerror (errno));
6133 #endif /* not WINDOWSNT */
6134 /* Do nothing on Windows because writes are blocking. */
6136 else
6138 int old_outfd, new_outfd;
6140 #ifdef HAVE_SHUTDOWN
6141 /* If this is a network connection, or socketpair is used
6142 for communication with the subprocess, call shutdown to cause EOF.
6143 (In some old system, shutdown to socketpair doesn't work.
6144 Then we just can't win.) */
6145 if (EQ (XPROCESS (proc)->type, Qnetwork)
6146 || XPROCESS (proc)->outfd == XPROCESS (proc)->infd)
6147 shutdown (XPROCESS (proc)->outfd, 1);
6148 /* In case of socketpair, outfd == infd, so don't close it. */
6149 if (XPROCESS (proc)->outfd != XPROCESS (proc)->infd)
6150 emacs_close (XPROCESS (proc)->outfd);
6151 #else /* not HAVE_SHUTDOWN */
6152 emacs_close (XPROCESS (proc)->outfd);
6153 #endif /* not HAVE_SHUTDOWN */
6154 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6155 if (new_outfd < 0)
6156 emacs_abort ();
6157 old_outfd = XPROCESS (proc)->outfd;
6159 if (!proc_encode_coding_system[new_outfd])
6160 proc_encode_coding_system[new_outfd]
6161 = xmalloc (sizeof (struct coding_system));
6162 *proc_encode_coding_system[new_outfd]
6163 = *proc_encode_coding_system[old_outfd];
6164 memset (proc_encode_coding_system[old_outfd], 0,
6165 sizeof (struct coding_system));
6167 XPROCESS (proc)->outfd = new_outfd;
6169 return process;
6172 /* If the status of the process DESIRED has changed, return true and
6173 set *STATUS to its exit status; otherwise, return false.
6174 If HAVE is nonnegative, assume that HAVE = waitpid (HAVE, STATUS, ...)
6175 has already been invoked, and do not invoke waitpid again. */
6177 static bool
6178 process_status_retrieved (pid_t desired, pid_t have, int *status)
6180 if (have < 0)
6182 /* Invoke waitpid only with a known process ID; do not invoke
6183 waitpid with a nonpositive argument. Otherwise, Emacs might
6184 reap an unwanted process by mistake. For example, invoking
6185 waitpid (-1, ...) can mess up glib by reaping glib's subprocesses,
6186 so that another thread running glib won't find them. */
6188 have = waitpid (desired, status, WNOHANG | WUNTRACED);
6189 while (have < 0 && errno == EINTR);
6192 return have == desired;
6195 /* If PID is nonnegative, the child process PID with wait status W has
6196 changed its status; record this and return true.
6198 If PID is negative, ignore W, and look for known child processes
6199 of Emacs whose status have changed. For each one found, record its new
6200 status.
6202 All we do is change the status; we do not run sentinels or print
6203 notifications. That is saved for the next time keyboard input is
6204 done, in order to avoid timing errors.
6206 ** WARNING: this can be called during garbage collection.
6207 Therefore, it must not be fooled by the presence of mark bits in
6208 Lisp objects.
6210 ** USG WARNING: Although it is not obvious from the documentation
6211 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6212 signal() before executing at least one wait(), otherwise the
6213 handler will be called again, resulting in an infinite loop. The
6214 relevant portion of the documentation reads "SIGCLD signals will be
6215 queued and the signal-catching function will be continually
6216 reentered until the queue is empty". Invoking signal() causes the
6217 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6218 Inc.
6220 ** Malloc WARNING: This should never call malloc either directly or
6221 indirectly; if it does, that is a bug */
6223 void
6224 record_child_status_change (pid_t pid, int w)
6226 #ifdef SIGCHLD
6228 /* Record at most one child only if we already know one child that
6229 has exited. */
6230 bool record_at_most_one_child = 0 <= pid;
6232 Lisp_Object tail;
6234 /* Find the process that signaled us, and record its status. */
6236 /* The process can have been deleted by Fdelete_process. */
6237 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6239 bool all_pids_are_fixnums
6240 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
6241 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
6242 Lisp_Object xpid = XCAR (tail);
6243 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
6245 pid_t deleted_pid;
6246 if (INTEGERP (xpid))
6247 deleted_pid = XINT (xpid);
6248 else
6249 deleted_pid = XFLOAT_DATA (xpid);
6250 if (process_status_retrieved (deleted_pid, pid, &w))
6252 XSETCAR (tail, Qnil);
6253 if (record_at_most_one_child)
6254 return;
6259 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6260 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6262 Lisp_Object proc = XCDR (XCAR (tail));
6263 struct Lisp_Process *p = XPROCESS (proc);
6264 if (p->alive && process_status_retrieved (p->pid, pid, &w))
6266 /* Change the status of the process that was found. */
6267 p->tick = ++process_tick;
6268 p->raw_status = w;
6269 p->raw_status_new = 1;
6271 /* If process has terminated, stop waiting for its output. */
6272 if (WIFSIGNALED (w) || WIFEXITED (w))
6274 int clear_desc_flag = 0;
6275 p->alive = 0;
6276 if (p->infd >= 0)
6277 clear_desc_flag = 1;
6279 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
6280 if (clear_desc_flag)
6282 FD_CLR (p->infd, &input_wait_mask);
6283 FD_CLR (p->infd, &non_keyboard_wait_mask);
6287 /* Tell wait_reading_process_output that it needs to wake up and
6288 look around. */
6289 if (input_available_clear_time)
6290 *input_available_clear_time = make_emacs_time (0, 0);
6292 if (record_at_most_one_child)
6293 return;
6297 if (0 <= pid)
6299 /* The caller successfully waited for a pid but no asynchronous
6300 process was found for it, so this is a synchronous process. */
6302 synch_process_alive = 0;
6304 /* Report the status of the synchronous process. */
6305 if (WIFEXITED (w))
6306 synch_process_retcode = WEXITSTATUS (w);
6307 else if (WIFSIGNALED (w))
6308 synch_process_termsig = WTERMSIG (w);
6310 /* Tell wait_reading_process_output that it needs to wake up and
6311 look around. */
6312 if (input_available_clear_time)
6313 *input_available_clear_time = make_emacs_time (0, 0);
6315 #endif
6318 #ifdef SIGCHLD
6320 static void
6321 handle_child_signal (int sig)
6323 record_child_status_change (-1, 0);
6326 static void
6327 deliver_child_signal (int sig)
6329 deliver_process_signal (sig, handle_child_signal);
6332 #endif /* SIGCHLD */
6335 static Lisp_Object
6336 exec_sentinel_unwind (Lisp_Object data)
6338 pset_sentinel (XPROCESS (XCAR (data)), XCDR (data));
6339 return Qnil;
6342 static Lisp_Object
6343 exec_sentinel_error_handler (Lisp_Object error_val)
6345 cmd_error_internal (error_val, "error in process sentinel: ");
6346 Vinhibit_quit = Qt;
6347 update_echo_area ();
6348 Fsleep_for (make_number (2), Qnil);
6349 return Qt;
6352 static void
6353 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6355 Lisp_Object sentinel, odeactivate;
6356 struct Lisp_Process *p = XPROCESS (proc);
6357 ptrdiff_t count = SPECPDL_INDEX ();
6358 bool outer_running_asynch_code = running_asynch_code;
6359 int waiting = waiting_for_user_input_p;
6361 if (inhibit_sentinels)
6362 return;
6364 /* No need to gcpro these, because all we do with them later
6365 is test them for EQness, and none of them should be a string. */
6366 odeactivate = Vdeactivate_mark;
6367 #if 0
6368 Lisp_Object obuffer, okeymap;
6369 XSETBUFFER (obuffer, current_buffer);
6370 okeymap = BVAR (current_buffer, keymap);
6371 #endif
6373 /* There's no good reason to let sentinels change the current
6374 buffer, and many callers of accept-process-output, sit-for, and
6375 friends don't expect current-buffer to be changed from under them. */
6376 record_unwind_current_buffer ();
6378 sentinel = p->sentinel;
6379 if (NILP (sentinel))
6380 return;
6382 /* Zilch the sentinel while it's running, to avoid recursive invocations;
6383 assure that it gets restored no matter how the sentinel exits. */
6384 pset_sentinel (p, Qnil);
6385 record_unwind_protect (exec_sentinel_unwind, Fcons (proc, sentinel));
6386 /* Inhibit quit so that random quits don't screw up a running filter. */
6387 specbind (Qinhibit_quit, Qt);
6388 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6390 /* In case we get recursively called,
6391 and we already saved the match data nonrecursively,
6392 save the same match data in safely recursive fashion. */
6393 if (outer_running_asynch_code)
6395 Lisp_Object tem;
6396 tem = Fmatch_data (Qnil, Qnil, Qnil);
6397 restore_search_regs ();
6398 record_unwind_save_match_data ();
6399 Fset_match_data (tem, Qt);
6402 /* For speed, if a search happens within this code,
6403 save the match data in a special nonrecursive fashion. */
6404 running_asynch_code = 1;
6406 internal_condition_case_1 (read_process_output_call,
6407 Fcons (sentinel,
6408 Fcons (proc, Fcons (reason, Qnil))),
6409 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6410 exec_sentinel_error_handler);
6412 /* If we saved the match data nonrecursively, restore it now. */
6413 restore_search_regs ();
6414 running_asynch_code = outer_running_asynch_code;
6416 Vdeactivate_mark = odeactivate;
6418 /* Restore waiting_for_user_input_p as it was
6419 when we were called, in case the filter clobbered it. */
6420 waiting_for_user_input_p = waiting;
6422 #if 0
6423 if (! EQ (Fcurrent_buffer (), obuffer)
6424 || ! EQ (current_buffer->keymap, okeymap))
6425 #endif
6426 /* But do it only if the caller is actually going to read events.
6427 Otherwise there's no need to make him wake up, and it could
6428 cause trouble (for example it would make sit_for return). */
6429 if (waiting_for_user_input_p == -1)
6430 record_asynch_buffer_change ();
6432 unbind_to (count, Qnil);
6435 /* Report all recent events of a change in process status
6436 (either run the sentinel or output a message).
6437 This is usually done while Emacs is waiting for keyboard input
6438 but can be done at other times. */
6440 static void
6441 status_notify (struct Lisp_Process *deleting_process)
6443 register Lisp_Object proc, buffer;
6444 Lisp_Object tail, msg;
6445 struct gcpro gcpro1, gcpro2;
6447 tail = Qnil;
6448 msg = Qnil;
6449 /* We need to gcpro tail; if read_process_output calls a filter
6450 which deletes a process and removes the cons to which tail points
6451 from Vprocess_alist, and then causes a GC, tail is an unprotected
6452 reference. */
6453 GCPRO2 (tail, msg);
6455 /* Set this now, so that if new processes are created by sentinels
6456 that we run, we get called again to handle their status changes. */
6457 update_tick = process_tick;
6459 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6461 Lisp_Object symbol;
6462 register struct Lisp_Process *p;
6464 proc = Fcdr (XCAR (tail));
6465 p = XPROCESS (proc);
6467 if (p->tick != p->update_tick)
6469 p->update_tick = p->tick;
6471 /* If process is still active, read any output that remains. */
6472 while (! EQ (p->filter, Qt)
6473 && ! EQ (p->status, Qconnect)
6474 && ! EQ (p->status, Qlisten)
6475 /* Network or serial process not stopped: */
6476 && ! EQ (p->command, Qt)
6477 && p->infd >= 0
6478 && p != deleting_process
6479 && read_process_output (proc, p->infd) > 0);
6481 buffer = p->buffer;
6483 /* Get the text to use for the message. */
6484 if (p->raw_status_new)
6485 update_status (p);
6486 msg = status_message (p);
6488 /* If process is terminated, deactivate it or delete it. */
6489 symbol = p->status;
6490 if (CONSP (p->status))
6491 symbol = XCAR (p->status);
6493 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6494 || EQ (symbol, Qclosed))
6496 if (delete_exited_processes)
6497 remove_process (proc);
6498 else
6499 deactivate_process (proc);
6502 /* The actions above may have further incremented p->tick.
6503 So set p->update_tick again
6504 so that an error in the sentinel will not cause
6505 this code to be run again. */
6506 p->update_tick = p->tick;
6507 /* Now output the message suitably. */
6508 if (!NILP (p->sentinel))
6509 exec_sentinel (proc, msg);
6510 /* Don't bother with a message in the buffer
6511 when a process becomes runnable. */
6512 else if (!EQ (symbol, Qrun) && !NILP (buffer))
6514 Lisp_Object tem;
6515 struct buffer *old = current_buffer;
6516 ptrdiff_t opoint, opoint_byte;
6517 ptrdiff_t before, before_byte;
6519 /* Avoid error if buffer is deleted
6520 (probably that's why the process is dead, too) */
6521 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
6522 continue;
6523 Fset_buffer (buffer);
6525 opoint = PT;
6526 opoint_byte = PT_BYTE;
6527 /* Insert new output into buffer
6528 at the current end-of-output marker,
6529 thus preserving logical ordering of input and output. */
6530 if (XMARKER (p->mark)->buffer)
6531 Fgoto_char (p->mark);
6532 else
6533 SET_PT_BOTH (ZV, ZV_BYTE);
6535 before = PT;
6536 before_byte = PT_BYTE;
6538 tem = BVAR (current_buffer, read_only);
6539 bset_read_only (current_buffer, Qnil);
6540 insert_string ("\nProcess ");
6541 { /* FIXME: temporary kludge */
6542 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
6543 insert_string (" ");
6544 Finsert (1, &msg);
6545 bset_read_only (current_buffer, tem);
6546 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6548 if (opoint >= before)
6549 SET_PT_BOTH (opoint + (PT - before),
6550 opoint_byte + (PT_BYTE - before_byte));
6551 else
6552 SET_PT_BOTH (opoint, opoint_byte);
6554 set_buffer_internal (old);
6557 } /* end for */
6559 update_mode_lines++; /* in case buffers use %s in mode-line-format */
6560 UNGCPRO;
6564 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6565 Sset_process_coding_system, 1, 3, 0,
6566 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6567 DECODING will be used to decode subprocess output and ENCODING to
6568 encode subprocess input. */)
6569 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6571 register struct Lisp_Process *p;
6573 CHECK_PROCESS (process);
6574 p = XPROCESS (process);
6575 if (p->infd < 0)
6576 error ("Input file descriptor of %s closed", SDATA (p->name));
6577 if (p->outfd < 0)
6578 error ("Output file descriptor of %s closed", SDATA (p->name));
6579 Fcheck_coding_system (decoding);
6580 Fcheck_coding_system (encoding);
6581 encoding = coding_inherit_eol_type (encoding, Qnil);
6582 pset_decode_coding_system (p, decoding);
6583 pset_encode_coding_system (p, encoding);
6584 setup_process_coding_systems (process);
6586 return Qnil;
6589 DEFUN ("process-coding-system",
6590 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6591 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6592 (register Lisp_Object process)
6594 CHECK_PROCESS (process);
6595 return Fcons (XPROCESS (process)->decode_coding_system,
6596 XPROCESS (process)->encode_coding_system);
6599 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6600 Sset_process_filter_multibyte, 2, 2, 0,
6601 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6602 If FLAG is non-nil, the filter is given multibyte strings.
6603 If FLAG is nil, the filter is given unibyte strings. In this case,
6604 all character code conversion except for end-of-line conversion is
6605 suppressed. */)
6606 (Lisp_Object process, Lisp_Object flag)
6608 register struct Lisp_Process *p;
6610 CHECK_PROCESS (process);
6611 p = XPROCESS (process);
6612 if (NILP (flag))
6613 pset_decode_coding_system
6614 (p, raw_text_coding_system (p->decode_coding_system));
6615 setup_process_coding_systems (process);
6617 return Qnil;
6620 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6621 Sprocess_filter_multibyte_p, 1, 1, 0,
6622 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6623 (Lisp_Object process)
6625 register struct Lisp_Process *p;
6626 struct coding_system *coding;
6628 CHECK_PROCESS (process);
6629 p = XPROCESS (process);
6630 coding = proc_decode_coding_system[p->infd];
6631 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6637 # ifdef HAVE_GPM
6639 void
6640 add_gpm_wait_descriptor (int desc)
6642 add_keyboard_wait_descriptor (desc);
6645 void
6646 delete_gpm_wait_descriptor (int desc)
6648 delete_keyboard_wait_descriptor (desc);
6651 # endif
6653 # ifdef USABLE_SIGIO
6655 /* Return nonzero if *MASK has a bit set
6656 that corresponds to one of the keyboard input descriptors. */
6658 static int
6659 keyboard_bit_set (fd_set *mask)
6661 int fd;
6663 for (fd = 0; fd <= max_input_desc; fd++)
6664 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6665 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6666 return 1;
6668 return 0;
6670 # endif
6672 #else /* not subprocesses */
6674 /* Defined on msdos.c. */
6675 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
6676 EMACS_TIME *, void *);
6678 /* Implementation of wait_reading_process_output, assuming that there
6679 are no subprocesses. Used only by the MS-DOS build.
6681 Wait for timeout to elapse and/or keyboard input to be available.
6683 TIME_LIMIT is:
6684 timeout in seconds
6685 If negative, gobble data immediately available but don't wait for any.
6687 NSECS is:
6688 an additional duration to wait, measured in nanoseconds
6689 If TIME_LIMIT is zero, then:
6690 If NSECS == 0, there is no limit.
6691 If NSECS > 0, the timeout consists of NSECS only.
6692 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6694 READ_KBD is:
6695 0 to ignore keyboard input, or
6696 1 to return when input is available, or
6697 -1 means caller will actually read the input, so don't throw to
6698 the quit handler.
6700 see full version for other parameters. We know that wait_proc will
6701 always be NULL, since `subprocesses' isn't defined.
6703 DO_DISPLAY means redisplay should be done to show subprocess
6704 output that arrives.
6706 Return true if we received input from any process. */
6709 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6710 bool do_display,
6711 Lisp_Object wait_for_cell,
6712 struct Lisp_Process *wait_proc, int just_wait_proc)
6714 register int nfds;
6715 EMACS_TIME end_time, timeout;
6717 if (time_limit < 0)
6719 time_limit = 0;
6720 nsecs = -1;
6722 else if (TYPE_MAXIMUM (time_t) < time_limit)
6723 time_limit = TYPE_MAXIMUM (time_t);
6725 /* What does time_limit really mean? */
6726 if (time_limit || 0 < nsecs)
6728 timeout = make_emacs_time (time_limit, nsecs);
6729 end_time = add_emacs_time (current_emacs_time (), timeout);
6732 /* Turn off periodic alarms (in case they are in use)
6733 and then turn off any other atimers,
6734 because the select emulator uses alarms. */
6735 stop_polling ();
6736 turn_on_atimers (0);
6738 while (1)
6740 int timeout_reduced_for_timers = 0;
6741 SELECT_TYPE waitchannels;
6742 int xerrno;
6744 /* If calling from keyboard input, do not quit
6745 since we want to return C-g as an input character.
6746 Otherwise, do pending quit if requested. */
6747 if (read_kbd >= 0)
6748 QUIT;
6750 /* Exit now if the cell we're waiting for became non-nil. */
6751 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6752 break;
6754 /* Compute time from now till when time limit is up */
6755 /* Exit if already run out */
6756 if (nsecs < 0)
6758 /* A negative timeout means
6759 gobble output available now
6760 but don't wait at all. */
6762 timeout = make_emacs_time (0, 0);
6764 else if (time_limit || 0 < nsecs)
6766 EMACS_TIME now = current_emacs_time ();
6767 if (EMACS_TIME_LE (end_time, now))
6768 break;
6769 timeout = sub_emacs_time (end_time, now);
6771 else
6773 timeout = make_emacs_time (100000, 0);
6776 /* If our caller will not immediately handle keyboard events,
6777 run timer events directly.
6778 (Callers that will immediately read keyboard events
6779 call timer_delay on their own.) */
6780 if (NILP (wait_for_cell))
6782 EMACS_TIME timer_delay;
6786 unsigned old_timers_run = timers_run;
6787 timer_delay = timer_check ();
6788 if (timers_run != old_timers_run && do_display)
6789 /* We must retry, since a timer may have requeued itself
6790 and that could alter the time delay. */
6791 redisplay_preserve_echo_area (14);
6792 else
6793 break;
6795 while (!detect_input_pending ());
6797 /* If there is unread keyboard input, also return. */
6798 if (read_kbd != 0
6799 && requeued_events_pending_p ())
6800 break;
6802 if (EMACS_TIME_VALID_P (timer_delay) && 0 <= nsecs)
6804 if (EMACS_TIME_LT (timer_delay, timeout))
6806 timeout = timer_delay;
6807 timeout_reduced_for_timers = 1;
6812 /* Cause C-g and alarm signals to take immediate action,
6813 and cause input available signals to zero out timeout. */
6814 if (read_kbd < 0)
6815 set_waiting_for_input (&timeout);
6817 /* If a frame has been newly mapped and needs updating,
6818 reprocess its display stuff. */
6819 if (frame_garbaged && do_display)
6821 clear_waiting_for_input ();
6822 redisplay_preserve_echo_area (15);
6823 if (read_kbd < 0)
6824 set_waiting_for_input (&timeout);
6827 /* Wait till there is something to do. */
6828 FD_ZERO (&waitchannels);
6829 if (read_kbd && detect_input_pending ())
6830 nfds = 0;
6831 else
6833 if (read_kbd || !NILP (wait_for_cell))
6834 FD_SET (0, &waitchannels);
6835 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6838 xerrno = errno;
6840 /* Make C-g and alarm signals set flags again */
6841 clear_waiting_for_input ();
6843 /* If we woke up due to SIGWINCH, actually change size now. */
6844 do_pending_window_change (0);
6846 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6847 /* We waited the full specified time, so return now. */
6848 break;
6850 if (nfds == -1)
6852 /* If the system call was interrupted, then go around the
6853 loop again. */
6854 if (xerrno == EINTR)
6855 FD_ZERO (&waitchannels);
6856 else
6857 error ("select error: %s", emacs_strerror (xerrno));
6860 /* Check for keyboard input */
6862 if (read_kbd
6863 && detect_input_pending_run_timers (do_display))
6865 swallow_events (do_display);
6866 if (detect_input_pending_run_timers (do_display))
6867 break;
6870 /* If there is unread keyboard input, also return. */
6871 if (read_kbd
6872 && requeued_events_pending_p ())
6873 break;
6875 /* If wait_for_cell. check for keyboard input
6876 but don't run any timers.
6877 ??? (It seems wrong to me to check for keyboard
6878 input at all when wait_for_cell, but the code
6879 has been this way since July 1994.
6880 Try changing this after version 19.31.) */
6881 if (! NILP (wait_for_cell)
6882 && detect_input_pending ())
6884 swallow_events (do_display);
6885 if (detect_input_pending ())
6886 break;
6889 /* Exit now if the cell we're waiting for became non-nil. */
6890 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6891 break;
6894 start_polling ();
6896 return 0;
6899 #endif /* not subprocesses */
6901 /* The following functions are needed even if async subprocesses are
6902 not supported. Some of them are no-op stubs in that case. */
6904 /* Add DESC to the set of keyboard input descriptors. */
6906 void
6907 add_keyboard_wait_descriptor (int desc)
6909 #ifdef subprocesses /* actually means "not MSDOS" */
6910 FD_SET (desc, &input_wait_mask);
6911 FD_SET (desc, &non_process_wait_mask);
6912 if (desc > max_input_desc)
6913 max_input_desc = desc;
6914 #endif
6917 /* From now on, do not expect DESC to give keyboard input. */
6919 void
6920 delete_keyboard_wait_descriptor (int desc)
6922 #ifdef subprocesses
6923 int fd;
6924 int lim = max_input_desc;
6926 FD_CLR (desc, &input_wait_mask);
6927 FD_CLR (desc, &non_process_wait_mask);
6929 if (desc == max_input_desc)
6930 for (fd = 0; fd < lim; fd++)
6931 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
6932 max_input_desc = fd;
6933 #endif
6936 /* Setup coding systems of PROCESS. */
6938 void
6939 setup_process_coding_systems (Lisp_Object process)
6941 #ifdef subprocesses
6942 struct Lisp_Process *p = XPROCESS (process);
6943 int inch = p->infd;
6944 int outch = p->outfd;
6945 Lisp_Object coding_system;
6947 if (inch < 0 || outch < 0)
6948 return;
6950 if (!proc_decode_coding_system[inch])
6951 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
6952 coding_system = p->decode_coding_system;
6953 if (! NILP (p->filter))
6955 else if (BUFFERP (p->buffer))
6957 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
6958 coding_system = raw_text_coding_system (coding_system);
6960 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
6962 if (!proc_encode_coding_system[outch])
6963 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
6964 setup_coding_system (p->encode_coding_system,
6965 proc_encode_coding_system[outch]);
6966 #endif
6969 /* Close all descriptors currently in use for communication
6970 with subprocess. This is used in a newly-forked subprocess
6971 to get rid of irrelevant descriptors. */
6973 void
6974 close_process_descs (void)
6976 #ifndef DOS_NT
6977 int i;
6978 for (i = 0; i < MAXDESC; i++)
6980 Lisp_Object process;
6981 process = chan_process[i];
6982 if (!NILP (process))
6984 int in = XPROCESS (process)->infd;
6985 int out = XPROCESS (process)->outfd;
6986 if (in >= 0)
6987 emacs_close (in);
6988 if (out >= 0 && in != out)
6989 emacs_close (out);
6992 #endif
6995 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
6996 doc: /* Return the (or a) process associated with BUFFER.
6997 BUFFER may be a buffer or the name of one. */)
6998 (register Lisp_Object buffer)
7000 #ifdef subprocesses
7001 register Lisp_Object buf, tail, proc;
7003 if (NILP (buffer)) return Qnil;
7004 buf = Fget_buffer (buffer);
7005 if (NILP (buf)) return Qnil;
7007 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
7009 proc = Fcdr (XCAR (tail));
7010 if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
7011 return proc;
7013 #endif /* subprocesses */
7014 return Qnil;
7017 DEFUN ("process-inherit-coding-system-flag",
7018 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
7019 1, 1, 0,
7020 doc: /* Return the value of inherit-coding-system flag for PROCESS.
7021 If this flag is t, `buffer-file-coding-system' of the buffer
7022 associated with PROCESS will inherit the coding system used to decode
7023 the process output. */)
7024 (register Lisp_Object process)
7026 #ifdef subprocesses
7027 CHECK_PROCESS (process);
7028 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
7029 #else
7030 /* Ignore the argument and return the value of
7031 inherit-process-coding-system. */
7032 return inherit_process_coding_system ? Qt : Qnil;
7033 #endif
7036 /* Kill all processes associated with `buffer'.
7037 If `buffer' is nil, kill all processes */
7039 void
7040 kill_buffer_processes (Lisp_Object buffer)
7042 #ifdef subprocesses
7043 Lisp_Object tail, proc;
7045 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
7047 proc = XCDR (XCAR (tail));
7048 if (PROCESSP (proc)
7049 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
7051 if (NETCONN_P (proc) || SERIALCONN_P (proc))
7052 Fdelete_process (proc);
7053 else if (XPROCESS (proc)->infd >= 0)
7054 process_send_signal (proc, SIGHUP, Qnil, 1);
7057 #else /* subprocesses */
7058 /* Since we have no subprocesses, this does nothing. */
7059 #endif /* subprocesses */
7062 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
7063 Swaiting_for_user_input_p, 0, 0, 0,
7064 doc: /* Returns non-nil if Emacs is waiting for input from the user.
7065 This is intended for use by asynchronous process output filters and sentinels. */)
7066 (void)
7068 #ifdef subprocesses
7069 return (waiting_for_user_input_p ? Qt : Qnil);
7070 #else
7071 return Qnil;
7072 #endif
7075 /* Stop reading input from keyboard sources. */
7077 void
7078 hold_keyboard_input (void)
7080 kbd_is_on_hold = 1;
7083 /* Resume reading input from keyboard sources. */
7085 void
7086 unhold_keyboard_input (void)
7088 kbd_is_on_hold = 0;
7091 /* Return non-zero if keyboard input is on hold, zero otherwise. */
7094 kbd_on_hold_p (void)
7096 return kbd_is_on_hold;
7100 /* Enumeration of and access to system processes a-la ps(1). */
7102 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
7103 0, 0, 0,
7104 doc: /* Return a list of numerical process IDs of all running processes.
7105 If this functionality is unsupported, return nil.
7107 See `process-attributes' for getting attributes of a process given its ID. */)
7108 (void)
7110 return list_system_processes ();
7113 DEFUN ("process-attributes", Fprocess_attributes,
7114 Sprocess_attributes, 1, 1, 0,
7115 doc: /* Return attributes of the process given by its PID, a number.
7117 Value is an alist where each element is a cons cell of the form
7119 \(KEY . VALUE)
7121 If this functionality is unsupported, the value is nil.
7123 See `list-system-processes' for getting a list of all process IDs.
7125 The KEYs of the attributes that this function may return are listed
7126 below, together with the type of the associated VALUE (in parentheses).
7127 Not all platforms support all of these attributes; unsupported
7128 attributes will not appear in the returned alist.
7129 Unless explicitly indicated otherwise, numbers can have either
7130 integer or floating point values.
7132 euid -- Effective user User ID of the process (number)
7133 user -- User name corresponding to euid (string)
7134 egid -- Effective user Group ID of the process (number)
7135 group -- Group name corresponding to egid (string)
7136 comm -- Command name (executable name only) (string)
7137 state -- Process state code, such as "S", "R", or "T" (string)
7138 ppid -- Parent process ID (number)
7139 pgrp -- Process group ID (number)
7140 sess -- Session ID, i.e. process ID of session leader (number)
7141 ttname -- Controlling tty name (string)
7142 tpgid -- ID of foreground process group on the process's tty (number)
7143 minflt -- number of minor page faults (number)
7144 majflt -- number of major page faults (number)
7145 cminflt -- cumulative number of minor page faults (number)
7146 cmajflt -- cumulative number of major page faults (number)
7147 utime -- user time used by the process, in (current-time) format,
7148 which is a list of integers (HIGH LOW USEC PSEC)
7149 stime -- system time used by the process (current-time)
7150 time -- sum of utime and stime (current-time)
7151 cutime -- user time used by the process and its children (current-time)
7152 cstime -- system time used by the process and its children (current-time)
7153 ctime -- sum of cutime and cstime (current-time)
7154 pri -- priority of the process (number)
7155 nice -- nice value of the process (number)
7156 thcount -- process thread count (number)
7157 start -- time the process started (current-time)
7158 vsize -- virtual memory size of the process in KB's (number)
7159 rss -- resident set size of the process in KB's (number)
7160 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7161 pcpu -- percents of CPU time used by the process (floating-point number)
7162 pmem -- percents of total physical memory used by process's resident set
7163 (floating-point number)
7164 args -- command line which invoked the process (string). */)
7165 ( Lisp_Object pid)
7167 return system_process_attributes (pid);
7171 /* This is not called "init_process" because that is the name of a
7172 Mach system call, so it would cause problems on Darwin systems. */
7173 void
7174 init_process_emacs (void)
7176 #ifdef subprocesses
7177 register int i;
7179 inhibit_sentinels = 0;
7181 #ifdef SIGCHLD
7182 #ifndef CANNOT_DUMP
7183 if (! noninteractive || initialized)
7184 #endif
7186 struct sigaction action;
7187 emacs_sigaction_init (&action, deliver_child_signal);
7188 sigaction (SIGCHLD, &action, 0);
7190 #endif
7192 FD_ZERO (&input_wait_mask);
7193 FD_ZERO (&non_keyboard_wait_mask);
7194 FD_ZERO (&non_process_wait_mask);
7195 FD_ZERO (&write_mask);
7196 max_process_desc = 0;
7197 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7199 #ifdef NON_BLOCKING_CONNECT
7200 FD_ZERO (&connect_wait_mask);
7201 num_pending_connects = 0;
7202 #endif
7204 #ifdef ADAPTIVE_READ_BUFFERING
7205 process_output_delay_count = 0;
7206 process_output_skip = 0;
7207 #endif
7209 /* Don't do this, it caused infinite select loops. The display
7210 method should call add_keyboard_wait_descriptor on stdin if it
7211 needs that. */
7212 #if 0
7213 FD_SET (0, &input_wait_mask);
7214 #endif
7216 Vprocess_alist = Qnil;
7217 #ifdef SIGCHLD
7218 deleted_pid_list = Qnil;
7219 #endif
7220 for (i = 0; i < MAXDESC; i++)
7222 chan_process[i] = Qnil;
7223 proc_buffered_char[i] = -1;
7225 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7226 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7227 #ifdef DATAGRAM_SOCKETS
7228 memset (datagram_address, 0, sizeof datagram_address);
7229 #endif
7232 Lisp_Object subfeatures = Qnil;
7233 const struct socket_options *sopt;
7235 #define ADD_SUBFEATURE(key, val) \
7236 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7238 #ifdef NON_BLOCKING_CONNECT
7239 ADD_SUBFEATURE (QCnowait, Qt);
7240 #endif
7241 #ifdef DATAGRAM_SOCKETS
7242 ADD_SUBFEATURE (QCtype, Qdatagram);
7243 #endif
7244 #ifdef HAVE_SEQPACKET
7245 ADD_SUBFEATURE (QCtype, Qseqpacket);
7246 #endif
7247 #ifdef HAVE_LOCAL_SOCKETS
7248 ADD_SUBFEATURE (QCfamily, Qlocal);
7249 #endif
7250 ADD_SUBFEATURE (QCfamily, Qipv4);
7251 #ifdef AF_INET6
7252 ADD_SUBFEATURE (QCfamily, Qipv6);
7253 #endif
7254 #ifdef HAVE_GETSOCKNAME
7255 ADD_SUBFEATURE (QCservice, Qt);
7256 #endif
7257 ADD_SUBFEATURE (QCserver, Qt);
7259 for (sopt = socket_options; sopt->name; sopt++)
7260 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7262 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7265 #if defined (DARWIN_OS)
7266 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7267 processes. As such, we only change the default value. */
7268 if (initialized)
7270 char const *release = (STRINGP (Voperating_system_release)
7271 ? SSDATA (Voperating_system_release)
7272 : 0);
7273 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7274 Vprocess_connection_type = Qnil;
7277 #endif
7278 #endif /* subprocesses */
7279 kbd_is_on_hold = 0;
7282 void
7283 syms_of_process (void)
7285 #ifdef subprocesses
7287 DEFSYM (Qprocessp, "processp");
7288 DEFSYM (Qrun, "run");
7289 DEFSYM (Qstop, "stop");
7290 DEFSYM (Qsignal, "signal");
7292 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7293 here again.
7295 Qexit = intern_c_string ("exit");
7296 staticpro (&Qexit); */
7298 DEFSYM (Qopen, "open");
7299 DEFSYM (Qclosed, "closed");
7300 DEFSYM (Qconnect, "connect");
7301 DEFSYM (Qfailed, "failed");
7302 DEFSYM (Qlisten, "listen");
7303 DEFSYM (Qlocal, "local");
7304 DEFSYM (Qipv4, "ipv4");
7305 #ifdef AF_INET6
7306 DEFSYM (Qipv6, "ipv6");
7307 #endif
7308 DEFSYM (Qdatagram, "datagram");
7309 DEFSYM (Qseqpacket, "seqpacket");
7311 DEFSYM (QCport, ":port");
7312 DEFSYM (QCspeed, ":speed");
7313 DEFSYM (QCprocess, ":process");
7315 DEFSYM (QCbytesize, ":bytesize");
7316 DEFSYM (QCstopbits, ":stopbits");
7317 DEFSYM (QCparity, ":parity");
7318 DEFSYM (Qodd, "odd");
7319 DEFSYM (Qeven, "even");
7320 DEFSYM (QCflowcontrol, ":flowcontrol");
7321 DEFSYM (Qhw, "hw");
7322 DEFSYM (Qsw, "sw");
7323 DEFSYM (QCsummary, ":summary");
7325 DEFSYM (Qreal, "real");
7326 DEFSYM (Qnetwork, "network");
7327 DEFSYM (Qserial, "serial");
7328 DEFSYM (QCbuffer, ":buffer");
7329 DEFSYM (QChost, ":host");
7330 DEFSYM (QCservice, ":service");
7331 DEFSYM (QClocal, ":local");
7332 DEFSYM (QCremote, ":remote");
7333 DEFSYM (QCcoding, ":coding");
7334 DEFSYM (QCserver, ":server");
7335 DEFSYM (QCnowait, ":nowait");
7336 DEFSYM (QCsentinel, ":sentinel");
7337 DEFSYM (QClog, ":log");
7338 DEFSYM (QCnoquery, ":noquery");
7339 DEFSYM (QCstop, ":stop");
7340 DEFSYM (QCoptions, ":options");
7341 DEFSYM (QCplist, ":plist");
7343 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7345 staticpro (&Vprocess_alist);
7346 #ifdef SIGCHLD
7347 staticpro (&deleted_pid_list);
7348 #endif
7350 #endif /* subprocesses */
7352 DEFSYM (QCname, ":name");
7353 DEFSYM (QCtype, ":type");
7355 DEFSYM (Qeuid, "euid");
7356 DEFSYM (Qegid, "egid");
7357 DEFSYM (Quser, "user");
7358 DEFSYM (Qgroup, "group");
7359 DEFSYM (Qcomm, "comm");
7360 DEFSYM (Qstate, "state");
7361 DEFSYM (Qppid, "ppid");
7362 DEFSYM (Qpgrp, "pgrp");
7363 DEFSYM (Qsess, "sess");
7364 DEFSYM (Qttname, "ttname");
7365 DEFSYM (Qtpgid, "tpgid");
7366 DEFSYM (Qminflt, "minflt");
7367 DEFSYM (Qmajflt, "majflt");
7368 DEFSYM (Qcminflt, "cminflt");
7369 DEFSYM (Qcmajflt, "cmajflt");
7370 DEFSYM (Qutime, "utime");
7371 DEFSYM (Qstime, "stime");
7372 DEFSYM (Qtime, "time");
7373 DEFSYM (Qcutime, "cutime");
7374 DEFSYM (Qcstime, "cstime");
7375 DEFSYM (Qctime, "ctime");
7376 DEFSYM (Qpri, "pri");
7377 DEFSYM (Qnice, "nice");
7378 DEFSYM (Qthcount, "thcount");
7379 DEFSYM (Qstart, "start");
7380 DEFSYM (Qvsize, "vsize");
7381 DEFSYM (Qrss, "rss");
7382 DEFSYM (Qetime, "etime");
7383 DEFSYM (Qpcpu, "pcpu");
7384 DEFSYM (Qpmem, "pmem");
7385 DEFSYM (Qargs, "args");
7387 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7388 doc: /* Non-nil means delete processes immediately when they exit.
7389 A value of nil means don't delete them until `list-processes' is run. */);
7391 delete_exited_processes = 1;
7393 #ifdef subprocesses
7394 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7395 doc: /* Control type of device used to communicate with subprocesses.
7396 Values are nil to use a pipe, or t or `pty' to use a pty.
7397 The value has no effect if the system has no ptys or if all ptys are busy:
7398 then a pipe is used in any case.
7399 The value takes effect when `start-process' is called. */);
7400 Vprocess_connection_type = Qt;
7402 #ifdef ADAPTIVE_READ_BUFFERING
7403 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7404 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7405 On some systems, when Emacs reads the output from a subprocess, the output data
7406 is read in very small blocks, potentially resulting in very poor performance.
7407 This behavior can be remedied to some extent by setting this variable to a
7408 non-nil value, as it will automatically delay reading from such processes, to
7409 allow them to produce more output before Emacs tries to read it.
7410 If the value is t, the delay is reset after each write to the process; any other
7411 non-nil value means that the delay is not reset on write.
7412 The variable takes effect when `start-process' is called. */);
7413 Vprocess_adaptive_read_buffering = Qt;
7414 #endif
7416 defsubr (&Sprocessp);
7417 defsubr (&Sget_process);
7418 defsubr (&Sdelete_process);
7419 defsubr (&Sprocess_status);
7420 defsubr (&Sprocess_exit_status);
7421 defsubr (&Sprocess_id);
7422 defsubr (&Sprocess_name);
7423 defsubr (&Sprocess_tty_name);
7424 defsubr (&Sprocess_command);
7425 defsubr (&Sset_process_buffer);
7426 defsubr (&Sprocess_buffer);
7427 defsubr (&Sprocess_mark);
7428 defsubr (&Sset_process_filter);
7429 defsubr (&Sprocess_filter);
7430 defsubr (&Sset_process_sentinel);
7431 defsubr (&Sprocess_sentinel);
7432 defsubr (&Sset_process_window_size);
7433 defsubr (&Sset_process_inherit_coding_system_flag);
7434 defsubr (&Sset_process_query_on_exit_flag);
7435 defsubr (&Sprocess_query_on_exit_flag);
7436 defsubr (&Sprocess_contact);
7437 defsubr (&Sprocess_plist);
7438 defsubr (&Sset_process_plist);
7439 defsubr (&Sprocess_list);
7440 defsubr (&Sstart_process);
7441 defsubr (&Sserial_process_configure);
7442 defsubr (&Smake_serial_process);
7443 defsubr (&Sset_network_process_option);
7444 defsubr (&Smake_network_process);
7445 defsubr (&Sformat_network_address);
7446 #if defined (HAVE_NET_IF_H)
7447 #ifdef SIOCGIFCONF
7448 defsubr (&Snetwork_interface_list);
7449 #endif
7450 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
7451 defsubr (&Snetwork_interface_info);
7452 #endif
7453 #endif /* defined (HAVE_NET_IF_H) */
7454 #ifdef DATAGRAM_SOCKETS
7455 defsubr (&Sprocess_datagram_address);
7456 defsubr (&Sset_process_datagram_address);
7457 #endif
7458 defsubr (&Saccept_process_output);
7459 defsubr (&Sprocess_send_region);
7460 defsubr (&Sprocess_send_string);
7461 defsubr (&Sinterrupt_process);
7462 defsubr (&Skill_process);
7463 defsubr (&Squit_process);
7464 defsubr (&Sstop_process);
7465 defsubr (&Scontinue_process);
7466 defsubr (&Sprocess_running_child_p);
7467 defsubr (&Sprocess_send_eof);
7468 defsubr (&Ssignal_process);
7469 defsubr (&Swaiting_for_user_input_p);
7470 defsubr (&Sprocess_type);
7471 defsubr (&Sset_process_coding_system);
7472 defsubr (&Sprocess_coding_system);
7473 defsubr (&Sset_process_filter_multibyte);
7474 defsubr (&Sprocess_filter_multibyte_p);
7476 #endif /* subprocesses */
7478 defsubr (&Sget_buffer_process);
7479 defsubr (&Sprocess_inherit_coding_system_flag);
7480 defsubr (&Slist_system_processes);
7481 defsubr (&Sprocess_attributes);