Merge from trunk.
[emacs.git] / src / process.c
blob0040d14a0f6af17b33d3109a130911f182b0c551
1 /* Asynchronous subprocess control for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2011
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>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <errno.h>
26 #include <setjmp.h>
27 #include <sys/types.h> /* Some typedefs are used in sys/file.h. */
28 #include <sys/file.h>
29 #include <sys/stat.h>
30 #include <setjmp.h>
32 #include <unistd.h>
33 #include <fcntl.h>
35 #include "lisp.h"
37 /* Only MS-DOS does not define `subprocesses'. */
38 #ifdef subprocesses
40 #include <sys/socket.h>
41 #include <netdb.h>
42 #include <netinet/in.h>
43 #include <arpa/inet.h>
45 /* Are local (unix) sockets supported? */
46 #if defined (HAVE_SYS_UN_H)
47 #if !defined (AF_LOCAL) && defined (AF_UNIX)
48 #define AF_LOCAL AF_UNIX
49 #endif
50 #ifdef AF_LOCAL
51 #define HAVE_LOCAL_SOCKETS
52 #include <sys/un.h>
53 #endif
54 #endif
56 #include <sys/ioctl.h>
57 #if defined(HAVE_NET_IF_H)
58 #include <net/if.h>
59 #endif /* HAVE_NET_IF_H */
61 #ifdef NEED_BSDTTY
62 #include <bsdtty.h>
63 #endif
65 #ifdef HAVE_RES_INIT
66 #include <netinet/in.h>
67 #include <arpa/nameser.h>
68 #include <resolv.h>
69 #endif
71 #ifdef HAVE_UTIL_H
72 #include <util.h>
73 #endif
75 #ifdef HAVE_PTY_H
76 #include <pty.h>
77 #endif
79 #endif /* subprocesses */
81 #include "systime.h"
82 #include "systty.h"
84 #include "window.h"
85 #include "buffer.h"
86 #include "character.h"
87 #include "coding.h"
88 #include "process.h"
89 #include "frame.h"
90 #include "termhooks.h"
91 #include "termopts.h"
92 #include "commands.h"
93 #include "keyboard.h"
94 #include "blockinput.h"
95 #include "dispextern.h"
96 #include "composite.h"
97 #include "atimer.h"
98 #include "sysselect.h"
99 #include "syssignal.h"
100 #include "syswait.h"
101 #ifdef HAVE_GNUTLS
102 #include "gnutls.h"
103 #endif
105 #if defined (USE_GTK) || defined (HAVE_GCONF)
106 #include "xgselect.h"
107 #endif /* defined (USE_GTK) || defined (HAVE_GCONF) */
108 #ifdef HAVE_NS
109 #include "nsterm.h"
110 #endif
112 Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
113 Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
114 Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
115 Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
116 Lisp_Object QCname, QCtype;
118 /* Non-zero if keyboard input is on hold, zero otherwise. */
120 static int kbd_is_on_hold;
122 /* Nonzero means don't run process sentinels. This is used
123 when exiting. */
124 int inhibit_sentinels;
126 #ifdef subprocesses
128 Lisp_Object Qprocessp;
129 static Lisp_Object Qrun, Qstop, Qsignal;
130 static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
131 Lisp_Object Qlocal;
132 static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
133 static Lisp_Object Qreal, Qnetwork, Qserial;
134 #ifdef AF_INET6
135 static Lisp_Object Qipv6;
136 #endif
137 static Lisp_Object QCport, QCprocess;
138 Lisp_Object QCspeed;
139 Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
140 Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
141 static Lisp_Object QCbuffer, QChost, QCservice;
142 static Lisp_Object QClocal, QCremote, QCcoding;
143 static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
144 static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
145 static Lisp_Object Qlast_nonmenu_event;
146 /* QCfamily is declared and initialized in xfaces.c,
147 QCfilter in keyboard.c. */
148 extern Lisp_Object QCfamily, QCfilter;
150 /* Qexit is declared and initialized in eval.c. */
152 /* QCfamily is defined in xfaces.c. */
153 extern Lisp_Object QCfamily;
154 /* QCfilter is defined in keyboard.c. */
155 extern Lisp_Object QCfilter;
157 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
158 #define NETCONN1_P(p) (EQ ((p)->type, Qnetwork))
159 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
160 #define SERIALCONN1_P(p) (EQ ((p)->type, Qserial))
162 #ifndef HAVE_H_ERRNO
163 extern int h_errno;
164 #endif
166 /* Number of events of change of status of a process. */
167 static int process_tick;
168 /* Number of events for which the user or sentinel has been notified. */
169 static int update_tick;
171 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
173 /* Only W32 has this, it really means that select can't take write mask. */
174 #ifdef BROKEN_NON_BLOCKING_CONNECT
175 #undef NON_BLOCKING_CONNECT
176 #define SELECT_CANT_DO_WRITE_MASK
177 #else
178 #ifndef NON_BLOCKING_CONNECT
179 #ifdef HAVE_SELECT
180 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
181 #if defined (O_NONBLOCK) || defined (O_NDELAY)
182 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
183 #define NON_BLOCKING_CONNECT
184 #endif /* EWOULDBLOCK || EINPROGRESS */
185 #endif /* O_NONBLOCK || O_NDELAY */
186 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
187 #endif /* HAVE_SELECT */
188 #endif /* NON_BLOCKING_CONNECT */
189 #endif /* BROKEN_NON_BLOCKING_CONNECT */
191 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
192 this system. We need to read full packets, so we need a
193 "non-destructive" select. So we require either native select,
194 or emulation of select using FIONREAD. */
196 #ifdef BROKEN_DATAGRAM_SOCKETS
197 #undef DATAGRAM_SOCKETS
198 #else
199 #ifndef DATAGRAM_SOCKETS
200 #if defined (HAVE_SELECT) || defined (FIONREAD)
201 #if defined (HAVE_SENDTO) && defined (HAVE_RECVFROM) && defined (EMSGSIZE)
202 #define DATAGRAM_SOCKETS
203 #endif /* HAVE_SENDTO && HAVE_RECVFROM && EMSGSIZE */
204 #endif /* HAVE_SELECT || FIONREAD */
205 #endif /* DATAGRAM_SOCKETS */
206 #endif /* BROKEN_DATAGRAM_SOCKETS */
208 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
209 # define HAVE_SEQPACKET
210 #endif
212 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
213 #ifdef EMACS_HAS_USECS
214 #define ADAPTIVE_READ_BUFFERING
215 #endif
216 #endif
218 #ifdef ADAPTIVE_READ_BUFFERING
219 #define READ_OUTPUT_DELAY_INCREMENT 10000
220 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
221 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
223 /* Number of processes which have a non-zero read_output_delay,
224 and therefore might be delayed for adaptive read buffering. */
226 static int process_output_delay_count;
228 /* Non-zero if any process has non-nil read_output_skip. */
230 static int process_output_skip;
232 #else
233 #define process_output_delay_count 0
234 #endif
236 static Lisp_Object Fget_process (Lisp_Object);
237 static void create_process (Lisp_Object, char **, Lisp_Object);
238 #ifdef SIGIO
239 static int keyboard_bit_set (SELECT_TYPE *);
240 #endif
241 static void deactivate_process (Lisp_Object);
242 static void status_notify (struct Lisp_Process *);
243 static int read_process_output (Lisp_Object, int);
244 static void create_pty (Lisp_Object);
246 /* If we support a window system, turn on the code to poll periodically
247 to detect C-g. It isn't actually used when doing interrupt input. */
248 #ifdef HAVE_WINDOW_SYSTEM
249 #define POLL_FOR_INPUT
250 #endif
252 static Lisp_Object get_process (register Lisp_Object name);
253 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
255 /* Mask of bits indicating the descriptors that we wait for input on. */
257 static SELECT_TYPE input_wait_mask;
259 /* Mask that excludes keyboard input descriptor(s). */
261 static SELECT_TYPE non_keyboard_wait_mask;
263 /* Mask that excludes process input descriptor(s). */
265 static SELECT_TYPE non_process_wait_mask;
267 /* Mask for selecting for write. */
269 static SELECT_TYPE write_mask;
271 #ifdef NON_BLOCKING_CONNECT
272 /* Mask of bits indicating the descriptors that we wait for connect to
273 complete on. Once they complete, they are removed from this mask
274 and added to the input_wait_mask and non_keyboard_wait_mask. */
276 static SELECT_TYPE connect_wait_mask;
278 /* Number of bits set in connect_wait_mask. */
279 static int num_pending_connects;
280 #endif /* NON_BLOCKING_CONNECT */
282 /* The largest descriptor currently in use for a process object. */
283 static int max_process_desc;
285 /* The largest descriptor currently in use for input. */
286 static int max_input_desc;
288 /* Indexed by descriptor, gives the process (if any) for that descriptor */
289 static Lisp_Object chan_process[MAXDESC];
291 /* Alist of elements (NAME . PROCESS) */
292 static Lisp_Object Vprocess_alist;
294 /* Buffered-ahead input char from process, indexed by channel.
295 -1 means empty (no char is buffered).
296 Used on sys V where the only way to tell if there is any
297 output from the process is to read at least one char.
298 Always -1 on systems that support FIONREAD. */
300 static int proc_buffered_char[MAXDESC];
302 /* Table of `struct coding-system' for each process. */
303 static struct coding_system *proc_decode_coding_system[MAXDESC];
304 static struct coding_system *proc_encode_coding_system[MAXDESC];
306 #ifdef DATAGRAM_SOCKETS
307 /* Table of `partner address' for datagram sockets. */
308 static struct sockaddr_and_len {
309 struct sockaddr *sa;
310 int len;
311 } datagram_address[MAXDESC];
312 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
313 #define DATAGRAM_CONN_P(proc) (PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
314 #else
315 #define DATAGRAM_CHAN_P(chan) (0)
316 #define DATAGRAM_CONN_P(proc) (0)
317 #endif
319 /* Maximum number of bytes to send to a pty without an eof. */
320 static int pty_max_bytes;
324 static struct fd_callback_data
326 fd_callback func;
327 void *data;
328 #define FOR_READ 1
329 #define FOR_WRITE 2
330 int condition; /* mask of the defines above. */
331 } fd_callback_info[MAXDESC];
334 /* Add a file descriptor FD to be monitored for when read is possible.
335 When read is possible, call FUNC with argument DATA. */
337 void
338 add_read_fd (int fd, fd_callback func, void *data)
340 xassert (fd < MAXDESC);
341 add_keyboard_wait_descriptor (fd);
343 fd_callback_info[fd].func = func;
344 fd_callback_info[fd].data = data;
345 fd_callback_info[fd].condition |= FOR_READ;
348 /* Stop monitoring file descriptor FD for when read is possible. */
350 void
351 delete_read_fd (int fd)
353 xassert (fd < MAXDESC);
354 delete_keyboard_wait_descriptor (fd);
356 fd_callback_info[fd].condition &= ~FOR_READ;
357 if (fd_callback_info[fd].condition == 0)
359 fd_callback_info[fd].func = 0;
360 fd_callback_info[fd].data = 0;
364 /* Add a file descriptor FD to be monitored for when write is possible.
365 When write is possible, call FUNC with argument DATA. */
367 void
368 add_write_fd (int fd, fd_callback func, void *data)
370 xassert (fd < MAXDESC);
371 FD_SET (fd, &write_mask);
372 if (fd > max_input_desc)
373 max_input_desc = fd;
375 fd_callback_info[fd].func = func;
376 fd_callback_info[fd].data = data;
377 fd_callback_info[fd].condition |= FOR_WRITE;
380 /* Stop monitoring file descriptor FD for when write is possible. */
382 void
383 delete_write_fd (int fd)
385 int lim = max_input_desc;
387 xassert (fd < MAXDESC);
388 FD_CLR (fd, &write_mask);
389 fd_callback_info[fd].condition &= ~FOR_WRITE;
390 if (fd_callback_info[fd].condition == 0)
392 fd_callback_info[fd].func = 0;
393 fd_callback_info[fd].data = 0;
395 if (fd == max_input_desc)
396 for (fd = lim; fd >= 0; fd--)
397 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
399 max_input_desc = fd;
400 break;
407 /* Compute the Lisp form of the process status, p->status, from
408 the numeric status that was returned by `wait'. */
410 static Lisp_Object status_convert (int);
412 static void
413 update_status (struct Lisp_Process *p)
415 eassert (p->raw_status_new);
416 p->status = status_convert (p->raw_status);
417 p->raw_status_new = 0;
420 /* Convert a process status word in Unix format to
421 the list that we use internally. */
423 static Lisp_Object
424 status_convert (int w)
426 if (WIFSTOPPED (w))
427 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
428 else if (WIFEXITED (w))
429 return Fcons (Qexit, Fcons (make_number (WRETCODE (w)),
430 WCOREDUMP (w) ? Qt : Qnil));
431 else if (WIFSIGNALED (w))
432 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
433 WCOREDUMP (w) ? Qt : Qnil));
434 else
435 return Qrun;
438 /* Given a status-list, extract the three pieces of information
439 and store them individually through the three pointers. */
441 static void
442 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
444 Lisp_Object tem;
446 if (SYMBOLP (l))
448 *symbol = l;
449 *code = 0;
450 *coredump = 0;
452 else
454 *symbol = XCAR (l);
455 tem = XCDR (l);
456 *code = XFASTINT (XCAR (tem));
457 tem = XCDR (tem);
458 *coredump = !NILP (tem);
462 /* Return a string describing a process status list. */
464 static Lisp_Object
465 status_message (struct Lisp_Process *p)
467 Lisp_Object status = p->status;
468 Lisp_Object symbol;
469 int code, coredump;
470 Lisp_Object string, string2;
472 decode_status (status, &symbol, &code, &coredump);
474 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
476 char *signame;
477 synchronize_system_messages_locale ();
478 signame = strsignal (code);
479 if (signame == 0)
480 string = build_string ("unknown");
481 else
483 int c1, c2;
485 string = make_unibyte_string (signame, strlen (signame));
486 if (! NILP (Vlocale_coding_system))
487 string = (code_convert_string_norecord
488 (string, Vlocale_coding_system, 0));
489 c1 = STRING_CHAR (SDATA (string));
490 c2 = downcase (c1);
491 if (c1 != c2)
492 Faset (string, make_number (0), make_number (c2));
494 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
495 return concat2 (string, string2);
497 else if (EQ (symbol, Qexit))
499 if (NETCONN1_P (p))
500 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
501 if (code == 0)
502 return build_string ("finished\n");
503 string = Fnumber_to_string (make_number (code));
504 string2 = build_string (coredump ? " (core dumped)\n" : "\n");
505 return concat3 (build_string ("exited abnormally with code "),
506 string, string2);
508 else if (EQ (symbol, Qfailed))
510 string = Fnumber_to_string (make_number (code));
511 string2 = build_string ("\n");
512 return concat3 (build_string ("failed with code "),
513 string, string2);
515 else
516 return Fcopy_sequence (Fsymbol_name (symbol));
519 #ifdef HAVE_PTYS
521 /* The file name of the pty opened by allocate_pty. */
522 static char pty_name[24];
524 /* Open an available pty, returning a file descriptor.
525 Return -1 on failure.
526 The file name of the terminal corresponding to the pty
527 is left in the variable pty_name. */
529 static int
530 allocate_pty (void)
532 int fd;
534 #ifdef PTY_ITERATION
535 PTY_ITERATION
536 #else
537 register int c, i;
538 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
539 for (i = 0; i < 16; i++)
540 #endif
542 #ifdef PTY_NAME_SPRINTF
543 PTY_NAME_SPRINTF
544 #else
545 sprintf (pty_name, "/dev/pty%c%x", c, i);
546 #endif /* no PTY_NAME_SPRINTF */
548 #ifdef PTY_OPEN
549 PTY_OPEN;
550 #else /* no PTY_OPEN */
552 { /* Some systems name their pseudoterminals so that there are gaps in
553 the usual sequence - for example, on HP9000/S700 systems, there
554 are no pseudoterminals with names ending in 'f'. So we wait for
555 three failures in a row before deciding that we've reached the
556 end of the ptys. */
557 int failed_count = 0;
558 struct stat stb;
560 if (stat (pty_name, &stb) < 0)
562 failed_count++;
563 if (failed_count >= 3)
564 return -1;
566 else
567 failed_count = 0;
569 # ifdef O_NONBLOCK
570 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
571 # else
572 fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
573 # endif
575 #endif /* no PTY_OPEN */
577 if (fd >= 0)
579 /* check to make certain that both sides are available
580 this avoids a nasty yet stupid bug in rlogins */
581 #ifdef PTY_TTY_NAME_SPRINTF
582 PTY_TTY_NAME_SPRINTF
583 #else
584 sprintf (pty_name, "/dev/tty%c%x", c, i);
585 #endif /* no PTY_TTY_NAME_SPRINTF */
586 if (access (pty_name, 6) != 0)
588 emacs_close (fd);
589 # ifndef __sgi
590 continue;
591 # else
592 return -1;
593 # endif /* __sgi */
595 setup_pty (fd);
596 return fd;
599 return -1;
601 #endif /* HAVE_PTYS */
603 static Lisp_Object
604 make_process (Lisp_Object name)
606 register Lisp_Object val, tem, name1;
607 register struct Lisp_Process *p;
608 char suffix[10];
609 register int i;
611 p = allocate_process ();
613 p->infd = -1;
614 p->outfd = -1;
615 p->tick = 0;
616 p->update_tick = 0;
617 p->pid = 0;
618 p->pty_flag = 0;
619 p->raw_status_new = 0;
620 p->status = Qrun;
621 p->mark = Fmake_marker ();
622 p->kill_without_query = 0;
624 #ifdef ADAPTIVE_READ_BUFFERING
625 p->adaptive_read_buffering = 0;
626 p->read_output_delay = 0;
627 p->read_output_skip = 0;
628 #endif
630 #ifdef HAVE_GNUTLS
631 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
632 p->gnutls_log_level = 0;
633 p->gnutls_p = 0;
634 #endif
636 /* If name is already in use, modify it until it is unused. */
638 name1 = name;
639 for (i = 1; ; i++)
641 tem = Fget_process (name1);
642 if (NILP (tem)) break;
643 sprintf (suffix, "<%d>", i);
644 name1 = concat2 (name, build_string (suffix));
646 name = name1;
647 p->name = name;
648 XSETPROCESS (val, p);
649 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
650 return val;
653 static void
654 remove_process (register Lisp_Object proc)
656 register Lisp_Object pair;
658 pair = Frassq (proc, Vprocess_alist);
659 Vprocess_alist = Fdelq (pair, Vprocess_alist);
661 deactivate_process (proc);
665 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
666 doc: /* Return t if OBJECT is a process. */)
667 (Lisp_Object object)
669 return PROCESSP (object) ? Qt : Qnil;
672 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
673 doc: /* Return the process named NAME, or nil if there is none. */)
674 (register Lisp_Object name)
676 if (PROCESSP (name))
677 return name;
678 CHECK_STRING (name);
679 return Fcdr (Fassoc (name, Vprocess_alist));
682 /* This is how commands for the user decode process arguments. It
683 accepts a process, a process name, a buffer, a buffer name, or nil.
684 Buffers denote the first process in the buffer, and nil denotes the
685 current buffer. */
687 static Lisp_Object
688 get_process (register Lisp_Object name)
690 register Lisp_Object proc, obj;
691 if (STRINGP (name))
693 obj = Fget_process (name);
694 if (NILP (obj))
695 obj = Fget_buffer (name);
696 if (NILP (obj))
697 error ("Process %s does not exist", SDATA (name));
699 else if (NILP (name))
700 obj = Fcurrent_buffer ();
701 else
702 obj = name;
704 /* Now obj should be either a buffer object or a process object.
706 if (BUFFERP (obj))
708 proc = Fget_buffer_process (obj);
709 if (NILP (proc))
710 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
712 else
714 CHECK_PROCESS (obj);
715 proc = obj;
717 return proc;
721 #ifdef SIGCHLD
722 /* Fdelete_process promises to immediately forget about the process, but in
723 reality, Emacs needs to remember those processes until they have been
724 treated by sigchld_handler; otherwise this handler would consider the
725 process as being synchronous and say that the synchronous process is
726 dead. */
727 static Lisp_Object deleted_pid_list;
728 #endif
730 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
731 doc: /* Delete PROCESS: kill it and forget about it immediately.
732 PROCESS may be a process, a buffer, the name of a process or buffer, or
733 nil, indicating the current buffer's process. */)
734 (register Lisp_Object process)
736 register struct Lisp_Process *p;
738 process = get_process (process);
739 p = XPROCESS (process);
741 p->raw_status_new = 0;
742 if (NETCONN1_P (p) || SERIALCONN1_P (p))
744 p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
745 p->tick = ++process_tick;
746 status_notify (p);
747 redisplay_preserve_echo_area (13);
749 else if (p->infd >= 0)
751 #ifdef SIGCHLD
752 Lisp_Object symbol;
753 /* Assignment to EMACS_INT stops GCC whining about limited range
754 of data type. */
755 EMACS_INT pid = p->pid;
757 /* No problem storing the pid here, as it is still in Vprocess_alist. */
758 deleted_pid_list = Fcons (make_fixnum_or_float (pid),
759 /* GC treated elements set to nil. */
760 Fdelq (Qnil, deleted_pid_list));
761 /* If the process has already signaled, remove it from the list. */
762 if (p->raw_status_new)
763 update_status (p);
764 symbol = p->status;
765 if (CONSP (p->status))
766 symbol = XCAR (p->status);
767 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
768 deleted_pid_list
769 = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
770 else
771 #endif
773 Fkill_process (process, Qnil);
774 /* Do this now, since remove_process will make sigchld_handler do nothing. */
775 p->status
776 = Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
777 p->tick = ++process_tick;
778 status_notify (p);
779 redisplay_preserve_echo_area (13);
782 remove_process (process);
783 return Qnil;
786 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
787 doc: /* Return the status of PROCESS.
788 The returned value is one of the following symbols:
789 run -- for a process that is running.
790 stop -- for a process stopped but continuable.
791 exit -- for a process that has exited.
792 signal -- for a process that has got a fatal signal.
793 open -- for a network stream connection that is open.
794 listen -- for a network stream server that is listening.
795 closed -- for a network stream connection that is closed.
796 connect -- when waiting for a non-blocking connection to complete.
797 failed -- when a non-blocking connection has failed.
798 nil -- if arg is a process name and no such process exists.
799 PROCESS may be a process, a buffer, the name of a process, or
800 nil, indicating the current buffer's process. */)
801 (register Lisp_Object process)
803 register struct Lisp_Process *p;
804 register Lisp_Object status;
806 if (STRINGP (process))
807 process = Fget_process (process);
808 else
809 process = get_process (process);
811 if (NILP (process))
812 return process;
814 p = XPROCESS (process);
815 if (p->raw_status_new)
816 update_status (p);
817 status = p->status;
818 if (CONSP (status))
819 status = XCAR (status);
820 if (NETCONN1_P (p) || SERIALCONN1_P (p))
822 if (EQ (status, Qexit))
823 status = Qclosed;
824 else if (EQ (p->command, Qt))
825 status = Qstop;
826 else if (EQ (status, Qrun))
827 status = Qopen;
829 return status;
832 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
833 1, 1, 0,
834 doc: /* Return the exit status of PROCESS or the signal number that killed it.
835 If PROCESS has not yet exited or died, return 0. */)
836 (register Lisp_Object process)
838 CHECK_PROCESS (process);
839 if (XPROCESS (process)->raw_status_new)
840 update_status (XPROCESS (process));
841 if (CONSP (XPROCESS (process)->status))
842 return XCAR (XCDR (XPROCESS (process)->status));
843 return make_number (0);
846 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
847 doc: /* Return the process id of PROCESS.
848 This is the pid of the external process which PROCESS uses or talks to.
849 For a network connection, this value is nil. */)
850 (register Lisp_Object process)
852 /* Assignment to EMACS_INT stops GCC whining about limited range of
853 data type. */
854 EMACS_INT pid;
856 CHECK_PROCESS (process);
857 pid = XPROCESS (process)->pid;
858 return (pid ? make_fixnum_or_float (pid) : Qnil);
861 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
862 doc: /* Return the name of PROCESS, as a string.
863 This is the name of the program invoked in PROCESS,
864 possibly modified to make it unique among process names. */)
865 (register Lisp_Object process)
867 CHECK_PROCESS (process);
868 return XPROCESS (process)->name;
871 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
872 doc: /* Return the command that was executed to start PROCESS.
873 This is a list of strings, the first string being the program executed
874 and the rest of the strings being the arguments given to it.
875 For a network or serial process, this is nil (process is running) or t
876 \(process is stopped). */)
877 (register Lisp_Object process)
879 CHECK_PROCESS (process);
880 return XPROCESS (process)->command;
883 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
884 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
885 This is the terminal that the process itself reads and writes on,
886 not the name of the pty that Emacs uses to talk with that terminal. */)
887 (register Lisp_Object process)
889 CHECK_PROCESS (process);
890 return XPROCESS (process)->tty_name;
893 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
894 2, 2, 0,
895 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
896 Return BUFFER. */)
897 (register Lisp_Object process, Lisp_Object buffer)
899 struct Lisp_Process *p;
901 CHECK_PROCESS (process);
902 if (!NILP (buffer))
903 CHECK_BUFFER (buffer);
904 p = XPROCESS (process);
905 p->buffer = buffer;
906 if (NETCONN1_P (p) || SERIALCONN1_P (p))
907 p->childp = Fplist_put (p->childp, QCbuffer, buffer);
908 setup_process_coding_systems (process);
909 return buffer;
912 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
913 1, 1, 0,
914 doc: /* Return the buffer PROCESS is associated with.
915 Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */)
916 (register Lisp_Object process)
918 CHECK_PROCESS (process);
919 return XPROCESS (process)->buffer;
922 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
923 1, 1, 0,
924 doc: /* Return the marker for the end of the last output from PROCESS. */)
925 (register Lisp_Object process)
927 CHECK_PROCESS (process);
928 return XPROCESS (process)->mark;
931 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
932 2, 2, 0,
933 doc: /* Give PROCESS the filter function FILTER; nil means no filter.
934 A value of t means stop accepting output from the process.
936 When a process has a filter, its buffer is not used for output.
937 Instead, each time it does output, the entire string of output is
938 passed to the filter.
940 The filter gets two arguments: the process and the string of output.
941 The string argument is normally a multibyte string, except:
942 - if the process' input coding system is no-conversion or raw-text,
943 it is a unibyte string (the non-converted input), or else
944 - if `default-enable-multibyte-characters' is nil, it is a unibyte
945 string (the result of converting the decoded input multibyte
946 string to unibyte with `string-make-unibyte'). */)
947 (register Lisp_Object process, Lisp_Object filter)
949 struct Lisp_Process *p;
951 CHECK_PROCESS (process);
952 p = XPROCESS (process);
954 /* Don't signal an error if the process' input file descriptor
955 is closed. This could make debugging Lisp more difficult,
956 for example when doing something like
958 (setq process (start-process ...))
959 (debug)
960 (set-process-filter process ...) */
962 if (p->infd >= 0)
964 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
966 FD_CLR (p->infd, &input_wait_mask);
967 FD_CLR (p->infd, &non_keyboard_wait_mask);
969 else if (EQ (p->filter, Qt)
970 /* Network or serial process not stopped: */
971 && !EQ (p->command, Qt))
973 FD_SET (p->infd, &input_wait_mask);
974 FD_SET (p->infd, &non_keyboard_wait_mask);
978 p->filter = filter;
979 if (NETCONN1_P (p) || SERIALCONN1_P (p))
980 p->childp = Fplist_put (p->childp, QCfilter, filter);
981 setup_process_coding_systems (process);
982 return filter;
985 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
986 1, 1, 0,
987 doc: /* Returns the filter function of PROCESS; nil if none.
988 See `set-process-filter' for more info on filter functions. */)
989 (register Lisp_Object process)
991 CHECK_PROCESS (process);
992 return XPROCESS (process)->filter;
995 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
996 2, 2, 0,
997 doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
998 The sentinel is called as a function when the process changes state.
999 It gets two arguments: the process, and a string describing the change. */)
1000 (register Lisp_Object process, Lisp_Object sentinel)
1002 struct Lisp_Process *p;
1004 CHECK_PROCESS (process);
1005 p = XPROCESS (process);
1007 p->sentinel = sentinel;
1008 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1009 p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
1010 return sentinel;
1013 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1014 1, 1, 0,
1015 doc: /* Return the sentinel of PROCESS; nil if none.
1016 See `set-process-sentinel' for more info on sentinels. */)
1017 (register Lisp_Object process)
1019 CHECK_PROCESS (process);
1020 return XPROCESS (process)->sentinel;
1023 DEFUN ("set-process-window-size", Fset_process_window_size,
1024 Sset_process_window_size, 3, 3, 0,
1025 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1026 (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1028 CHECK_PROCESS (process);
1029 CHECK_NATNUM (height);
1030 CHECK_NATNUM (width);
1032 if (XPROCESS (process)->infd < 0
1033 || set_window_size (XPROCESS (process)->infd,
1034 XINT (height), XINT (width)) <= 0)
1035 return Qnil;
1036 else
1037 return Qt;
1040 DEFUN ("set-process-inherit-coding-system-flag",
1041 Fset_process_inherit_coding_system_flag,
1042 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1043 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1044 If the second argument FLAG is non-nil, then the variable
1045 `buffer-file-coding-system' of the buffer associated with PROCESS
1046 will be bound to the value of the coding system used to decode
1047 the process output.
1049 This is useful when the coding system specified for the process buffer
1050 leaves either the character code conversion or the end-of-line conversion
1051 unspecified, or if the coding system used to decode the process output
1052 is more appropriate for saving the process buffer.
1054 Binding the variable `inherit-process-coding-system' to non-nil before
1055 starting the process is an alternative way of setting the inherit flag
1056 for the process which will run. */)
1057 (register Lisp_Object process, Lisp_Object flag)
1059 CHECK_PROCESS (process);
1060 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1061 return flag;
1064 DEFUN ("set-process-query-on-exit-flag",
1065 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1066 2, 2, 0,
1067 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1068 If the second argument FLAG is non-nil, Emacs will query the user before
1069 exiting or killing a buffer if PROCESS is running. */)
1070 (register Lisp_Object process, Lisp_Object flag)
1072 CHECK_PROCESS (process);
1073 XPROCESS (process)->kill_without_query = NILP (flag);
1074 return flag;
1077 DEFUN ("process-query-on-exit-flag",
1078 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1079 1, 1, 0,
1080 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1081 (register Lisp_Object process)
1083 CHECK_PROCESS (process);
1084 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1087 #ifdef DATAGRAM_SOCKETS
1088 static Lisp_Object Fprocess_datagram_address (Lisp_Object);
1089 #endif
1091 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1092 1, 2, 0,
1093 doc: /* Return the contact info of PROCESS; t for a real child.
1094 For a network or serial connection, the value depends on the optional
1095 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1096 SERVICE) for a network connection or (PORT SPEED) for a serial
1097 connection. If KEY is t, the complete contact information for the
1098 connection is returned, else the specific value for the keyword KEY is
1099 returned. See `make-network-process' or `make-serial-process' for a
1100 list of keywords. */)
1101 (register Lisp_Object process, Lisp_Object key)
1103 Lisp_Object contact;
1105 CHECK_PROCESS (process);
1106 contact = XPROCESS (process)->childp;
1108 #ifdef DATAGRAM_SOCKETS
1109 if (DATAGRAM_CONN_P (process)
1110 && (EQ (key, Qt) || EQ (key, QCremote)))
1111 contact = Fplist_put (contact, QCremote,
1112 Fprocess_datagram_address (process));
1113 #endif
1115 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1116 return contact;
1117 if (NILP (key) && NETCONN_P (process))
1118 return Fcons (Fplist_get (contact, QChost),
1119 Fcons (Fplist_get (contact, QCservice), Qnil));
1120 if (NILP (key) && SERIALCONN_P (process))
1121 return Fcons (Fplist_get (contact, QCport),
1122 Fcons (Fplist_get (contact, QCspeed), Qnil));
1123 return Fplist_get (contact, key);
1126 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1127 1, 1, 0,
1128 doc: /* Return the plist of PROCESS. */)
1129 (register Lisp_Object process)
1131 CHECK_PROCESS (process);
1132 return XPROCESS (process)->plist;
1135 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1136 2, 2, 0,
1137 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1138 (register Lisp_Object process, Lisp_Object plist)
1140 CHECK_PROCESS (process);
1141 CHECK_LIST (plist);
1143 XPROCESS (process)->plist = plist;
1144 return plist;
1147 #if 0 /* Turned off because we don't currently record this info
1148 in the process. Perhaps add it. */
1149 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1150 doc: /* Return the connection type of PROCESS.
1151 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1152 a socket connection. */)
1153 (Lisp_Object process)
1155 return XPROCESS (process)->type;
1157 #endif
1159 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1160 doc: /* Return the connection type of PROCESS.
1161 The value is either the symbol `real', `network', or `serial'.
1162 PROCESS may be a process, a buffer, the name of a process or buffer, or
1163 nil, indicating the current buffer's process. */)
1164 (Lisp_Object process)
1166 Lisp_Object proc;
1167 proc = get_process (process);
1168 return XPROCESS (proc)->type;
1171 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1172 1, 2, 0,
1173 doc: /* Convert network ADDRESS from internal format to a string.
1174 A 4 or 5 element vector represents an IPv4 address (with port number).
1175 An 8 or 9 element vector represents an IPv6 address (with port number).
1176 If optional second argument OMIT-PORT is non-nil, don't include a port
1177 number in the string, even when present in ADDRESS.
1178 Returns nil if format of ADDRESS is invalid. */)
1179 (Lisp_Object address, Lisp_Object omit_port)
1181 if (NILP (address))
1182 return Qnil;
1184 if (STRINGP (address)) /* AF_LOCAL */
1185 return address;
1187 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1189 register struct Lisp_Vector *p = XVECTOR (address);
1190 EMACS_INT size = p->header.size;
1191 Lisp_Object args[10];
1192 int nargs, i;
1194 if (size == 4 || (size == 5 && !NILP (omit_port)))
1196 args[0] = build_string ("%d.%d.%d.%d");
1197 nargs = 4;
1199 else if (size == 5)
1201 args[0] = build_string ("%d.%d.%d.%d:%d");
1202 nargs = 5;
1204 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1206 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
1207 nargs = 8;
1209 else if (size == 9)
1211 args[0] = build_string ("[%x:%x:%x:%x:%x:%x:%x:%x]:%d");
1212 nargs = 9;
1214 else
1215 return Qnil;
1217 for (i = 0; i < nargs; i++)
1219 EMACS_INT element = XINT (p->contents[i]);
1221 if (element < 0 || element > 65535)
1222 return Qnil;
1224 if (nargs <= 5 /* IPv4 */
1225 && i < 4 /* host, not port */
1226 && element > 255)
1227 return Qnil;
1229 args[i+1] = p->contents[i];
1232 return Fformat (nargs+1, args);
1235 if (CONSP (address))
1237 Lisp_Object args[2];
1238 args[0] = build_string ("<Family %d>");
1239 args[1] = Fcar (address);
1240 return Fformat (2, args);
1243 return Qnil;
1246 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1247 doc: /* Return a list of all processes. */)
1248 (void)
1250 return Fmapcar (Qcdr, Vprocess_alist);
1253 /* Starting asynchronous inferior processes. */
1255 static Lisp_Object start_process_unwind (Lisp_Object proc);
1257 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1258 doc: /* Start a program in a subprocess. Return the process object for it.
1259 NAME is name for process. It is modified if necessary to make it unique.
1260 BUFFER is the buffer (or buffer name) to associate with the process.
1262 Process output (both standard output and standard error streams) goes
1263 at end of BUFFER, unless you specify an output stream or filter
1264 function to handle the output. BUFFER may also be nil, meaning that
1265 this process is not associated with any buffer.
1267 PROGRAM is the program file name. It is searched for in `exec-path'
1268 (which see). If nil, just associate a pty with the buffer. Remaining
1269 arguments are strings to give program as arguments.
1271 If you want to separate standard output from standard error, invoke
1272 the command through a shell and redirect one of them using the shell
1273 syntax.
1275 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1276 (ptrdiff_t nargs, Lisp_Object *args)
1278 Lisp_Object buffer, name, program, proc, current_dir, tem;
1279 register unsigned char **new_argv;
1280 ptrdiff_t i;
1281 int count = SPECPDL_INDEX ();
1283 buffer = args[1];
1284 if (!NILP (buffer))
1285 buffer = Fget_buffer_create (buffer);
1287 /* Make sure that the child will be able to chdir to the current
1288 buffer's current directory, or its unhandled equivalent. We
1289 can't just have the child check for an error when it does the
1290 chdir, since it's in a vfork.
1292 We have to GCPRO around this because Fexpand_file_name and
1293 Funhandled_file_name_directory might call a file name handling
1294 function. The argument list is protected by the caller, so all
1295 we really have to worry about is buffer. */
1297 struct gcpro gcpro1, gcpro2;
1299 current_dir = BVAR (current_buffer, directory);
1301 GCPRO2 (buffer, current_dir);
1303 current_dir = Funhandled_file_name_directory (current_dir);
1304 if (NILP (current_dir))
1305 /* If the file name handler says that current_dir is unreachable, use
1306 a sensible default. */
1307 current_dir = build_string ("~/");
1308 current_dir = expand_and_dir_to_file (current_dir, Qnil);
1309 if (NILP (Ffile_accessible_directory_p (current_dir)))
1310 report_file_error ("Setting current directory",
1311 Fcons (BVAR (current_buffer, directory), Qnil));
1313 UNGCPRO;
1316 name = args[0];
1317 CHECK_STRING (name);
1319 program = args[2];
1321 if (!NILP (program))
1322 CHECK_STRING (program);
1324 proc = make_process (name);
1325 /* If an error occurs and we can't start the process, we want to
1326 remove it from the process list. This means that each error
1327 check in create_process doesn't need to call remove_process
1328 itself; it's all taken care of here. */
1329 record_unwind_protect (start_process_unwind, proc);
1331 XPROCESS (proc)->childp = Qt;
1332 XPROCESS (proc)->plist = Qnil;
1333 XPROCESS (proc)->type = Qreal;
1334 XPROCESS (proc)->buffer = buffer;
1335 XPROCESS (proc)->sentinel = Qnil;
1336 XPROCESS (proc)->filter = Qnil;
1337 XPROCESS (proc)->command = Flist (nargs - 2, args + 2);
1339 #ifdef HAVE_GNUTLS
1340 /* AKA GNUTLS_INITSTAGE(proc). */
1341 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1342 XPROCESS (proc)->gnutls_cred_type = Qnil;
1343 #endif
1345 #ifdef ADAPTIVE_READ_BUFFERING
1346 XPROCESS (proc)->adaptive_read_buffering
1347 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1348 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1349 #endif
1351 /* Make the process marker point into the process buffer (if any). */
1352 if (BUFFERP (buffer))
1353 set_marker_both (XPROCESS (proc)->mark, buffer,
1354 BUF_ZV (XBUFFER (buffer)),
1355 BUF_ZV_BYTE (XBUFFER (buffer)));
1358 /* Decide coding systems for communicating with the process. Here
1359 we don't setup the structure coding_system nor pay attention to
1360 unibyte mode. They are done in create_process. */
1362 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1363 Lisp_Object coding_systems = Qt;
1364 Lisp_Object val, *args2;
1365 struct gcpro gcpro1, gcpro2;
1367 val = Vcoding_system_for_read;
1368 if (NILP (val))
1370 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
1371 args2[0] = Qstart_process;
1372 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1373 GCPRO2 (proc, current_dir);
1374 if (!NILP (program))
1375 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1376 UNGCPRO;
1377 if (CONSP (coding_systems))
1378 val = XCAR (coding_systems);
1379 else if (CONSP (Vdefault_process_coding_system))
1380 val = XCAR (Vdefault_process_coding_system);
1382 XPROCESS (proc)->decode_coding_system = val;
1384 val = Vcoding_system_for_write;
1385 if (NILP (val))
1387 if (EQ (coding_systems, Qt))
1389 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
1390 args2[0] = Qstart_process;
1391 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1392 GCPRO2 (proc, current_dir);
1393 if (!NILP (program))
1394 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1395 UNGCPRO;
1397 if (CONSP (coding_systems))
1398 val = XCDR (coding_systems);
1399 else if (CONSP (Vdefault_process_coding_system))
1400 val = XCDR (Vdefault_process_coding_system);
1402 XPROCESS (proc)->encode_coding_system = val;
1403 /* Note: At this momemnt, the above coding system may leave
1404 text-conversion or eol-conversion unspecified. They will be
1405 decided after we read output from the process and decode it by
1406 some coding system, or just before we actually send a text to
1407 the process. */
1411 XPROCESS (proc)->decoding_buf = empty_unibyte_string;
1412 XPROCESS (proc)->decoding_carryover = 0;
1413 XPROCESS (proc)->encoding_buf = empty_unibyte_string;
1415 XPROCESS (proc)->inherit_coding_system_flag
1416 = !(NILP (buffer) || !inherit_process_coding_system);
1418 if (!NILP (program))
1420 /* If program file name is not absolute, search our path for it.
1421 Put the name we will really use in TEM. */
1422 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1423 && !(SCHARS (program) > 1
1424 && IS_DEVICE_SEP (SREF (program, 1))))
1426 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1428 tem = Qnil;
1429 GCPRO4 (name, program, buffer, current_dir);
1430 openp (Vexec_path, program, Vexec_suffixes, &tem, make_number (X_OK));
1431 UNGCPRO;
1432 if (NILP (tem))
1433 report_file_error ("Searching for program", Fcons (program, Qnil));
1434 tem = Fexpand_file_name (tem, Qnil);
1436 else
1438 if (!NILP (Ffile_directory_p (program)))
1439 error ("Specified program for new process is a directory");
1440 tem = program;
1443 /* If program file name starts with /: for quoting a magic name,
1444 discard that. */
1445 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1446 && SREF (tem, 1) == ':')
1447 tem = Fsubstring (tem, make_number (2), Qnil);
1450 Lisp_Object arg_encoding = Qnil;
1451 struct gcpro gcpro1;
1452 GCPRO1 (tem);
1454 /* Encode the file name and put it in NEW_ARGV.
1455 That's where the child will use it to execute the program. */
1456 tem = Fcons (ENCODE_FILE (tem), Qnil);
1458 /* Here we encode arguments by the coding system used for sending
1459 data to the process. We don't support using different coding
1460 systems for encoding arguments and for encoding data sent to the
1461 process. */
1463 for (i = 3; i < nargs; i++)
1465 tem = Fcons (args[i], tem);
1466 CHECK_STRING (XCAR (tem));
1467 if (STRING_MULTIBYTE (XCAR (tem)))
1469 if (NILP (arg_encoding))
1470 arg_encoding = (complement_process_encoding_system
1471 (XPROCESS (proc)->encode_coding_system));
1472 XSETCAR (tem,
1473 code_convert_string_norecord
1474 (XCAR (tem), arg_encoding, 1));
1478 UNGCPRO;
1481 /* Now that everything is encoded we can collect the strings into
1482 NEW_ARGV. */
1483 new_argv = (unsigned char **) alloca ((nargs - 1) * sizeof (char *));
1484 new_argv[nargs - 2] = 0;
1486 for (i = nargs - 2; i-- != 0; )
1488 new_argv[i] = SDATA (XCAR (tem));
1489 tem = XCDR (tem);
1492 create_process (proc, (char **) new_argv, current_dir);
1494 else
1495 create_pty (proc);
1497 return unbind_to (count, proc);
1500 /* This function is the unwind_protect form for Fstart_process. If
1501 PROC doesn't have its pid set, then we know someone has signaled
1502 an error and the process wasn't started successfully, so we should
1503 remove it from the process list. */
1504 static Lisp_Object
1505 start_process_unwind (Lisp_Object proc)
1507 if (!PROCESSP (proc))
1508 abort ();
1510 /* Was PROC started successfully? */
1511 if (XPROCESS (proc)->pid == -1)
1512 remove_process (proc);
1514 return Qnil;
1517 static void
1518 create_process_1 (struct atimer *timer)
1520 /* Nothing to do. */
1524 static void
1525 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1527 int inchannel, outchannel;
1528 pid_t pid;
1529 int sv[2];
1530 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1531 int wait_child_setup[2];
1532 #endif
1533 sigset_t procmask;
1534 sigset_t blocked;
1535 struct sigaction sigint_action;
1536 struct sigaction sigquit_action;
1537 struct sigaction sigpipe_action;
1538 #ifdef AIX
1539 struct sigaction sighup_action;
1540 #endif
1541 /* Use volatile to protect variables from being clobbered by longjmp. */
1542 volatile int forkin, forkout;
1543 volatile int pty_flag = 0;
1544 #ifndef USE_CRT_DLL
1545 extern char **environ;
1546 #endif
1548 inchannel = outchannel = -1;
1550 #ifdef HAVE_PTYS
1551 if (!NILP (Vprocess_connection_type))
1552 outchannel = inchannel = allocate_pty ();
1554 if (inchannel >= 0)
1556 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1557 /* On most USG systems it does not work to open the pty's tty here,
1558 then close it and reopen it in the child. */
1559 #ifdef O_NOCTTY
1560 /* Don't let this terminal become our controlling terminal
1561 (in case we don't have one). */
1562 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1563 #else
1564 forkout = forkin = emacs_open (pty_name, O_RDWR, 0);
1565 #endif
1566 if (forkin < 0)
1567 report_file_error ("Opening pty", Qnil);
1568 #else
1569 forkin = forkout = -1;
1570 #endif /* not USG, or USG_SUBTTY_WORKS */
1571 pty_flag = 1;
1573 else
1574 #endif /* HAVE_PTYS */
1576 int tem;
1577 tem = pipe (sv);
1578 if (tem < 0)
1579 report_file_error ("Creating pipe", Qnil);
1580 inchannel = sv[0];
1581 forkout = sv[1];
1582 tem = pipe (sv);
1583 if (tem < 0)
1585 emacs_close (inchannel);
1586 emacs_close (forkout);
1587 report_file_error ("Creating pipe", Qnil);
1589 outchannel = sv[1];
1590 forkin = sv[0];
1593 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1595 int tem;
1597 tem = pipe (wait_child_setup);
1598 if (tem < 0)
1599 report_file_error ("Creating pipe", Qnil);
1600 tem = fcntl (wait_child_setup[1], F_GETFD, 0);
1601 if (tem >= 0)
1602 tem = fcntl (wait_child_setup[1], F_SETFD, tem | FD_CLOEXEC);
1603 if (tem < 0)
1605 emacs_close (wait_child_setup[0]);
1606 emacs_close (wait_child_setup[1]);
1607 report_file_error ("Setting file descriptor flags", Qnil);
1610 #endif
1612 #ifdef O_NONBLOCK
1613 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1614 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1615 #else
1616 #ifdef O_NDELAY
1617 fcntl (inchannel, F_SETFL, O_NDELAY);
1618 fcntl (outchannel, F_SETFL, O_NDELAY);
1619 #endif
1620 #endif
1622 /* Record this as an active process, with its channels.
1623 As a result, child_setup will close Emacs's side of the pipes. */
1624 chan_process[inchannel] = process;
1625 XPROCESS (process)->infd = inchannel;
1626 XPROCESS (process)->outfd = outchannel;
1628 /* Previously we recorded the tty descriptor used in the subprocess.
1629 It was only used for getting the foreground tty process, so now
1630 we just reopen the device (see emacs_get_tty_pgrp) as this is
1631 more portable (see USG_SUBTTY_WORKS above). */
1633 XPROCESS (process)->pty_flag = pty_flag;
1634 XPROCESS (process)->status = Qrun;
1635 setup_process_coding_systems (process);
1637 /* Delay interrupts until we have a chance to store
1638 the new fork's pid in its process structure */
1639 sigemptyset (&blocked);
1640 #ifdef SIGCHLD
1641 sigaddset (&blocked, SIGCHLD);
1642 #endif
1643 #ifdef HAVE_WORKING_VFORK
1644 /* On many hosts (e.g. Solaris 2.4), if a vforked child calls `signal',
1645 this sets the parent's signal handlers as well as the child's.
1646 So delay all interrupts whose handlers the child might munge,
1647 and record the current handlers so they can be restored later. */
1648 sigaddset (&blocked, SIGINT ); sigaction (SIGINT , 0, &sigint_action );
1649 sigaddset (&blocked, SIGQUIT); sigaction (SIGQUIT, 0, &sigquit_action);
1650 sigaddset (&blocked, SIGPIPE); sigaction (SIGPIPE, 0, &sigpipe_action);
1651 #ifdef AIX
1652 sigaddset (&blocked, SIGHUP ); sigaction (SIGHUP , 0, &sighup_action );
1653 #endif
1654 #endif /* HAVE_WORKING_VFORK */
1655 sigprocmask (SIG_BLOCK, &blocked, &procmask);
1657 FD_SET (inchannel, &input_wait_mask);
1658 FD_SET (inchannel, &non_keyboard_wait_mask);
1659 if (inchannel > max_process_desc)
1660 max_process_desc = inchannel;
1662 /* Until we store the proper pid, enable sigchld_handler
1663 to recognize an unknown pid as standing for this process.
1664 It is very important not to let this `marker' value stay
1665 in the table after this function has returned; if it does
1666 it might cause call-process to hang and subsequent asynchronous
1667 processes to get their return values scrambled. */
1668 XPROCESS (process)->pid = -1;
1670 BLOCK_INPUT;
1673 /* child_setup must clobber environ on systems with true vfork.
1674 Protect it from permanent change. */
1675 char **save_environ = environ;
1676 volatile Lisp_Object encoded_current_dir = ENCODE_FILE (current_dir);
1678 #ifndef WINDOWSNT
1679 pid = vfork ();
1680 if (pid == 0)
1681 #endif /* not WINDOWSNT */
1683 int xforkin = forkin;
1684 int xforkout = forkout;
1686 #if 0 /* This was probably a mistake--it duplicates code later on,
1687 but fails to handle all the cases. */
1688 /* Make sure SIGCHLD is not blocked in the child. */
1689 sigsetmask (SIGEMPTYMASK);
1690 #endif
1692 /* Make the pty be the controlling terminal of the process. */
1693 #ifdef HAVE_PTYS
1694 /* First, disconnect its current controlling terminal. */
1695 #ifdef HAVE_SETSID
1696 /* We tried doing setsid only if pty_flag, but it caused
1697 process_set_signal to fail on SGI when using a pipe. */
1698 setsid ();
1699 /* Make the pty's terminal the controlling terminal. */
1700 if (pty_flag && xforkin >= 0)
1702 #ifdef TIOCSCTTY
1703 /* We ignore the return value
1704 because faith@cs.unc.edu says that is necessary on Linux. */
1705 ioctl (xforkin, TIOCSCTTY, 0);
1706 #endif
1708 #else /* not HAVE_SETSID */
1709 #ifdef USG
1710 /* It's very important to call setpgrp here and no time
1711 afterwards. Otherwise, we lose our controlling tty which
1712 is set when we open the pty. */
1713 setpgrp ();
1714 #endif /* USG */
1715 #endif /* not HAVE_SETSID */
1716 #if defined (LDISC1)
1717 if (pty_flag && xforkin >= 0)
1719 struct termios t;
1720 tcgetattr (xforkin, &t);
1721 t.c_lflag = LDISC1;
1722 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1723 emacs_write (1, "create_process/tcsetattr LDISC1 failed\n", 39);
1725 #else
1726 #if defined (NTTYDISC) && defined (TIOCSETD)
1727 if (pty_flag && xforkin >= 0)
1729 /* Use new line discipline. */
1730 int ldisc = NTTYDISC;
1731 ioctl (xforkin, TIOCSETD, &ldisc);
1733 #endif
1734 #endif
1735 #ifdef TIOCNOTTY
1736 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1737 can do TIOCSPGRP only to the process's controlling tty. */
1738 if (pty_flag)
1740 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1741 I can't test it since I don't have 4.3. */
1742 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1743 if (j >= 0)
1745 ioctl (j, TIOCNOTTY, 0);
1746 emacs_close (j);
1748 #ifndef USG
1749 /* In order to get a controlling terminal on some versions
1750 of BSD, it is necessary to put the process in pgrp 0
1751 before it opens the terminal. */
1752 #ifdef HAVE_SETPGID
1753 setpgid (0, 0);
1754 #else
1755 setpgrp (0, 0);
1756 #endif
1757 #endif
1759 #endif /* TIOCNOTTY */
1761 #if !defined (DONT_REOPEN_PTY)
1762 /*** There is a suggestion that this ought to be a
1763 conditional on TIOCSPGRP,
1764 or !(defined (HAVE_SETSID) && defined (TIOCSCTTY)).
1765 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1766 that system does seem to need this code, even though
1767 both HAVE_SETSID and TIOCSCTTY are defined. */
1768 /* Now close the pty (if we had it open) and reopen it.
1769 This makes the pty the controlling terminal of the subprocess. */
1770 if (pty_flag)
1773 /* I wonder if emacs_close (emacs_open (pty_name, ...))
1774 would work? */
1775 if (xforkin >= 0)
1776 emacs_close (xforkin);
1777 xforkout = xforkin = emacs_open (pty_name, O_RDWR, 0);
1779 if (xforkin < 0)
1781 emacs_write (1, "Couldn't open the pty terminal ", 31);
1782 emacs_write (1, pty_name, strlen (pty_name));
1783 emacs_write (1, "\n", 1);
1784 _exit (1);
1788 #endif /* not DONT_REOPEN_PTY */
1790 #ifdef SETUP_SLAVE_PTY
1791 if (pty_flag)
1793 SETUP_SLAVE_PTY;
1795 #endif /* SETUP_SLAVE_PTY */
1796 #ifdef AIX
1797 /* On AIX, we've disabled SIGHUP above once we start a child on a pty.
1798 Now reenable it in the child, so it will die when we want it to. */
1799 if (pty_flag)
1800 signal (SIGHUP, SIG_DFL);
1801 #endif
1802 #endif /* HAVE_PTYS */
1804 signal (SIGINT, SIG_DFL);
1805 signal (SIGQUIT, SIG_DFL);
1806 /* GConf causes us to ignore SIGPIPE, make sure it is restored
1807 in the child. */
1808 signal (SIGPIPE, SIG_DFL);
1810 /* Stop blocking signals in the child. */
1811 sigprocmask (SIG_SETMASK, &procmask, 0);
1813 if (pty_flag)
1814 child_setup_tty (xforkout);
1815 #ifdef WINDOWSNT
1816 pid = child_setup (xforkin, xforkout, xforkout,
1817 new_argv, 1, encoded_current_dir);
1818 #else /* not WINDOWSNT */
1819 #ifdef FD_CLOEXEC
1820 emacs_close (wait_child_setup[0]);
1821 #endif
1822 child_setup (xforkin, xforkout, xforkout,
1823 new_argv, 1, encoded_current_dir);
1824 #endif /* not WINDOWSNT */
1826 environ = save_environ;
1829 UNBLOCK_INPUT;
1831 /* This runs in the Emacs process. */
1832 if (pid < 0)
1834 if (forkin >= 0)
1835 emacs_close (forkin);
1836 if (forkin != forkout && forkout >= 0)
1837 emacs_close (forkout);
1839 else
1841 /* vfork succeeded. */
1842 XPROCESS (process)->pid = pid;
1844 #ifdef WINDOWSNT
1845 register_child (pid, inchannel);
1846 #endif /* WINDOWSNT */
1848 /* If the subfork execv fails, and it exits,
1849 this close hangs. I don't know why.
1850 So have an interrupt jar it loose. */
1852 struct atimer *timer;
1853 EMACS_TIME offset;
1855 stop_polling ();
1856 EMACS_SET_SECS_USECS (offset, 1, 0);
1857 timer = start_atimer (ATIMER_RELATIVE, offset, create_process_1, 0);
1859 if (forkin >= 0)
1860 emacs_close (forkin);
1862 cancel_atimer (timer);
1863 start_polling ();
1866 if (forkin != forkout && forkout >= 0)
1867 emacs_close (forkout);
1869 #ifdef HAVE_PTYS
1870 if (pty_flag)
1871 XPROCESS (process)->tty_name = build_string (pty_name);
1872 else
1873 #endif
1874 XPROCESS (process)->tty_name = Qnil;
1876 #if !defined (WINDOWSNT) && defined (FD_CLOEXEC)
1877 /* Wait for child_setup to complete in case that vfork is
1878 actually defined as fork. The descriptor wait_child_setup[1]
1879 of a pipe is closed at the child side either by close-on-exec
1880 on successful execvp or the _exit call in child_setup. */
1882 char dummy;
1884 emacs_close (wait_child_setup[1]);
1885 emacs_read (wait_child_setup[0], &dummy, 1);
1886 emacs_close (wait_child_setup[0]);
1888 #endif
1891 /* Restore the signal state whether vfork succeeded or not.
1892 (We will signal an error, below, if it failed.) */
1893 #ifdef HAVE_WORKING_VFORK
1894 /* Restore the parent's signal handlers. */
1895 sigaction (SIGINT, &sigint_action, 0);
1896 sigaction (SIGQUIT, &sigquit_action, 0);
1897 sigaction (SIGPIPE, &sigpipe_action, 0);
1898 #ifdef AIX
1899 sigaction (SIGHUP, &sighup_action, 0);
1900 #endif
1901 #endif /* HAVE_WORKING_VFORK */
1902 /* Stop blocking signals in the parent. */
1903 sigprocmask (SIG_SETMASK, &procmask, 0);
1905 /* Now generate the error if vfork failed. */
1906 if (pid < 0)
1907 report_file_error ("Doing vfork", Qnil);
1910 void
1911 create_pty (Lisp_Object process)
1913 int inchannel, outchannel;
1914 int pty_flag = 0;
1916 inchannel = outchannel = -1;
1918 #ifdef HAVE_PTYS
1919 if (!NILP (Vprocess_connection_type))
1920 outchannel = inchannel = allocate_pty ();
1922 if (inchannel >= 0)
1924 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1925 /* On most USG systems it does not work to open the pty's tty here,
1926 then close it and reopen it in the child. */
1927 #ifdef O_NOCTTY
1928 /* Don't let this terminal become our controlling terminal
1929 (in case we don't have one). */
1930 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1931 #else
1932 int forkout = emacs_open (pty_name, O_RDWR, 0);
1933 #endif
1934 if (forkout < 0)
1935 report_file_error ("Opening pty", Qnil);
1936 #if defined (DONT_REOPEN_PTY)
1937 /* In the case that vfork is defined as fork, the parent process
1938 (Emacs) may send some data before the child process completes
1939 tty options setup. So we setup tty before forking. */
1940 child_setup_tty (forkout);
1941 #endif /* DONT_REOPEN_PTY */
1942 #endif /* not USG, or USG_SUBTTY_WORKS */
1943 pty_flag = 1;
1945 #endif /* HAVE_PTYS */
1947 #ifdef O_NONBLOCK
1948 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1949 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1950 #else
1951 #ifdef O_NDELAY
1952 fcntl (inchannel, F_SETFL, O_NDELAY);
1953 fcntl (outchannel, F_SETFL, O_NDELAY);
1954 #endif
1955 #endif
1957 /* Record this as an active process, with its channels.
1958 As a result, child_setup will close Emacs's side of the pipes. */
1959 chan_process[inchannel] = process;
1960 XPROCESS (process)->infd = inchannel;
1961 XPROCESS (process)->outfd = outchannel;
1963 /* Previously we recorded the tty descriptor used in the subprocess.
1964 It was only used for getting the foreground tty process, so now
1965 we just reopen the device (see emacs_get_tty_pgrp) as this is
1966 more portable (see USG_SUBTTY_WORKS above). */
1968 XPROCESS (process)->pty_flag = pty_flag;
1969 XPROCESS (process)->status = Qrun;
1970 setup_process_coding_systems (process);
1972 FD_SET (inchannel, &input_wait_mask);
1973 FD_SET (inchannel, &non_keyboard_wait_mask);
1974 if (inchannel > max_process_desc)
1975 max_process_desc = inchannel;
1977 XPROCESS (process)->pid = -2;
1978 #ifdef HAVE_PTYS
1979 if (pty_flag)
1980 XPROCESS (process)->tty_name = build_string (pty_name);
1981 else
1982 #endif
1983 XPROCESS (process)->tty_name = Qnil;
1987 /* Convert an internal struct sockaddr to a lisp object (vector or string).
1988 The address family of sa is not included in the result. */
1990 static Lisp_Object
1991 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
1993 Lisp_Object address;
1994 int i;
1995 unsigned char *cp;
1996 register struct Lisp_Vector *p;
1998 /* Workaround for a bug in getsockname on BSD: Names bound to
1999 sockets in the UNIX domain are inaccessible; getsockname returns
2000 a zero length name. */
2001 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
2002 return empty_unibyte_string;
2004 switch (sa->sa_family)
2006 case AF_INET:
2008 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2009 len = sizeof (sin->sin_addr) + 1;
2010 address = Fmake_vector (make_number (len), Qnil);
2011 p = XVECTOR (address);
2012 p->contents[--len] = make_number (ntohs (sin->sin_port));
2013 cp = (unsigned char *) &sin->sin_addr;
2014 break;
2016 #ifdef AF_INET6
2017 case AF_INET6:
2019 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2020 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
2021 len = sizeof (sin6->sin6_addr)/2 + 1;
2022 address = Fmake_vector (make_number (len), Qnil);
2023 p = XVECTOR (address);
2024 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
2025 for (i = 0; i < len; i++)
2026 p->contents[i] = make_number (ntohs (ip6[i]));
2027 return address;
2029 #endif
2030 #ifdef HAVE_LOCAL_SOCKETS
2031 case AF_LOCAL:
2033 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2034 for (i = 0; i < sizeof (sockun->sun_path); i++)
2035 if (sockun->sun_path[i] == 0)
2036 break;
2037 return make_unibyte_string (sockun->sun_path, i);
2039 #endif
2040 default:
2041 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2042 address = Fcons (make_number (sa->sa_family),
2043 Fmake_vector (make_number (len), Qnil));
2044 p = XVECTOR (XCDR (address));
2045 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2046 break;
2049 i = 0;
2050 while (i < len)
2051 p->contents[i++] = make_number (*cp++);
2053 return address;
2057 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2059 static int
2060 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2062 register struct Lisp_Vector *p;
2064 if (VECTORP (address))
2066 p = XVECTOR (address);
2067 if (p->header.size == 5)
2069 *familyp = AF_INET;
2070 return sizeof (struct sockaddr_in);
2072 #ifdef AF_INET6
2073 else if (p->header.size == 9)
2075 *familyp = AF_INET6;
2076 return sizeof (struct sockaddr_in6);
2078 #endif
2080 #ifdef HAVE_LOCAL_SOCKETS
2081 else if (STRINGP (address))
2083 *familyp = AF_LOCAL;
2084 return sizeof (struct sockaddr_un);
2086 #endif
2087 else if (CONSP (address) && INTEGERP (XCAR (address)) && VECTORP (XCDR (address)))
2089 struct sockaddr *sa;
2090 *familyp = XINT (XCAR (address));
2091 p = XVECTOR (XCDR (address));
2092 return p->header.size + sizeof (sa->sa_family);
2094 return 0;
2097 /* Convert an address object (vector or string) to an internal sockaddr.
2099 The address format has been basically validated by
2100 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2101 it could have come from user data. So if FAMILY is not valid,
2102 we return after zeroing *SA. */
2104 static void
2105 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2107 register struct Lisp_Vector *p;
2108 register unsigned char *cp = NULL;
2109 register int i;
2111 memset (sa, 0, len);
2113 if (VECTORP (address))
2115 p = XVECTOR (address);
2116 if (family == AF_INET)
2118 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2119 len = sizeof (sin->sin_addr) + 1;
2120 i = XINT (p->contents[--len]);
2121 sin->sin_port = htons (i);
2122 cp = (unsigned char *)&sin->sin_addr;
2123 sa->sa_family = family;
2125 #ifdef AF_INET6
2126 else if (family == AF_INET6)
2128 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2129 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2130 len = sizeof (sin6->sin6_addr) + 1;
2131 i = XINT (p->contents[--len]);
2132 sin6->sin6_port = htons (i);
2133 for (i = 0; i < len; i++)
2134 if (INTEGERP (p->contents[i]))
2136 int j = XFASTINT (p->contents[i]) & 0xffff;
2137 ip6[i] = ntohs (j);
2139 sa->sa_family = family;
2140 return;
2142 #endif
2143 else
2144 return;
2146 else if (STRINGP (address))
2148 #ifdef HAVE_LOCAL_SOCKETS
2149 if (family == AF_LOCAL)
2151 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2152 cp = SDATA (address);
2153 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2154 sockun->sun_path[i] = *cp++;
2155 sa->sa_family = family;
2157 #endif
2158 return;
2160 else
2162 p = XVECTOR (XCDR (address));
2163 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2166 for (i = 0; i < len; i++)
2167 if (INTEGERP (p->contents[i]))
2168 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2171 #ifdef DATAGRAM_SOCKETS
2172 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2173 1, 1, 0,
2174 doc: /* Get the current datagram address associated with PROCESS. */)
2175 (Lisp_Object process)
2177 int channel;
2179 CHECK_PROCESS (process);
2181 if (!DATAGRAM_CONN_P (process))
2182 return Qnil;
2184 channel = XPROCESS (process)->infd;
2185 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2186 datagram_address[channel].len);
2189 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2190 2, 2, 0,
2191 doc: /* Set the datagram address for PROCESS to ADDRESS.
2192 Returns nil upon error setting address, ADDRESS otherwise. */)
2193 (Lisp_Object process, Lisp_Object address)
2195 int channel;
2196 int family, len;
2198 CHECK_PROCESS (process);
2200 if (!DATAGRAM_CONN_P (process))
2201 return Qnil;
2203 channel = XPROCESS (process)->infd;
2205 len = get_lisp_to_sockaddr_size (address, &family);
2206 if (datagram_address[channel].len != len)
2207 return Qnil;
2208 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2209 return address;
2211 #endif
2214 static const struct socket_options {
2215 /* The name of this option. Should be lowercase version of option
2216 name without SO_ prefix. */
2217 const char *name;
2218 /* Option level SOL_... */
2219 int optlevel;
2220 /* Option number SO_... */
2221 int optnum;
2222 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2223 enum { OPIX_NONE=0, OPIX_MISC=1, OPIX_REUSEADDR=2 } optbit;
2224 } socket_options[] =
2226 #ifdef SO_BINDTODEVICE
2227 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2228 #endif
2229 #ifdef SO_BROADCAST
2230 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2231 #endif
2232 #ifdef SO_DONTROUTE
2233 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2234 #endif
2235 #ifdef SO_KEEPALIVE
2236 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2237 #endif
2238 #ifdef SO_LINGER
2239 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2240 #endif
2241 #ifdef SO_OOBINLINE
2242 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2243 #endif
2244 #ifdef SO_PRIORITY
2245 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2246 #endif
2247 #ifdef SO_REUSEADDR
2248 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2249 #endif
2250 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2253 /* Set option OPT to value VAL on socket S.
2255 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2256 Signals an error if setting a known option fails.
2259 static int
2260 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2262 char *name;
2263 const struct socket_options *sopt;
2264 int ret = 0;
2266 CHECK_SYMBOL (opt);
2268 name = SSDATA (SYMBOL_NAME (opt));
2269 for (sopt = socket_options; sopt->name; sopt++)
2270 if (strcmp (name, sopt->name) == 0)
2271 break;
2273 switch (sopt->opttype)
2275 case SOPT_BOOL:
2277 int optval;
2278 optval = NILP (val) ? 0 : 1;
2279 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2280 &optval, sizeof (optval));
2281 break;
2284 case SOPT_INT:
2286 int optval;
2287 if (INTEGERP (val))
2288 optval = XINT (val);
2289 else
2290 error ("Bad option value for %s", name);
2291 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2292 &optval, sizeof (optval));
2293 break;
2296 #ifdef SO_BINDTODEVICE
2297 case SOPT_IFNAME:
2299 char devname[IFNAMSIZ+1];
2301 /* This is broken, at least in the Linux 2.4 kernel.
2302 To unbind, the arg must be a zero integer, not the empty string.
2303 This should work on all systems. KFS. 2003-09-23. */
2304 memset (devname, 0, sizeof devname);
2305 if (STRINGP (val))
2307 char *arg = SSDATA (val);
2308 int len = min (strlen (arg), IFNAMSIZ);
2309 memcpy (devname, arg, len);
2311 else if (!NILP (val))
2312 error ("Bad option value for %s", name);
2313 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2314 devname, IFNAMSIZ);
2315 break;
2317 #endif
2319 #ifdef SO_LINGER
2320 case SOPT_LINGER:
2322 struct linger linger;
2324 linger.l_onoff = 1;
2325 linger.l_linger = 0;
2326 if (INTEGERP (val))
2327 linger.l_linger = XINT (val);
2328 else
2329 linger.l_onoff = NILP (val) ? 0 : 1;
2330 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2331 &linger, sizeof (linger));
2332 break;
2334 #endif
2336 default:
2337 return 0;
2340 if (ret < 0)
2341 report_file_error ("Cannot set network option",
2342 Fcons (opt, Fcons (val, Qnil)));
2343 return (1 << sopt->optbit);
2347 DEFUN ("set-network-process-option",
2348 Fset_network_process_option, Sset_network_process_option,
2349 3, 4, 0,
2350 doc: /* For network process PROCESS set option OPTION to value VALUE.
2351 See `make-network-process' for a list of options and values.
2352 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2353 OPTION is not a supported option, return nil instead; otherwise return t. */)
2354 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2356 int s;
2357 struct Lisp_Process *p;
2359 CHECK_PROCESS (process);
2360 p = XPROCESS (process);
2361 if (!NETCONN1_P (p))
2362 error ("Process is not a network process");
2364 s = p->infd;
2365 if (s < 0)
2366 error ("Process is not running");
2368 if (set_socket_option (s, option, value))
2370 p->childp = Fplist_put (p->childp, option, value);
2371 return Qt;
2374 if (NILP (no_error))
2375 error ("Unknown or unsupported option");
2377 return Qnil;
2381 DEFUN ("serial-process-configure",
2382 Fserial_process_configure,
2383 Sserial_process_configure,
2384 0, MANY, 0,
2385 doc: /* Configure speed, bytesize, etc. of a serial process.
2387 Arguments are specified as keyword/argument pairs. Attributes that
2388 are not given are re-initialized from the process's current
2389 configuration (available via the function `process-contact') or set to
2390 reasonable default values. The following arguments are defined:
2392 :process PROCESS
2393 :name NAME
2394 :buffer BUFFER
2395 :port PORT
2396 -- Any of these arguments can be given to identify the process that is
2397 to be configured. If none of these arguments is given, the current
2398 buffer's process is used.
2400 :speed SPEED -- SPEED is the speed of the serial port in bits per
2401 second, also called baud rate. Any value can be given for SPEED, but
2402 most serial ports work only at a few defined values between 1200 and
2403 115200, with 9600 being the most common value. If SPEED is nil, the
2404 serial port is not configured any further, i.e., all other arguments
2405 are ignored. This may be useful for special serial ports such as
2406 Bluetooth-to-serial converters which can only be configured through AT
2407 commands. A value of nil for SPEED can be used only when passed
2408 through `make-serial-process' or `serial-term'.
2410 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2411 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2413 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2414 `odd' (use odd parity), or the symbol `even' (use even parity). If
2415 PARITY is not given, no parity is used.
2417 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2418 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2419 is not given or nil, 1 stopbit is used.
2421 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2422 flowcontrol to be used, which is either nil (don't use flowcontrol),
2423 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2424 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2425 flowcontrol is used.
2427 `serial-process-configure' is called by `make-serial-process' for the
2428 initial configuration of the serial port.
2430 Examples:
2432 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2434 \(serial-process-configure
2435 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2437 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2439 usage: (serial-process-configure &rest ARGS) */)
2440 (ptrdiff_t nargs, Lisp_Object *args)
2442 struct Lisp_Process *p;
2443 Lisp_Object contact = Qnil;
2444 Lisp_Object proc = Qnil;
2445 struct gcpro gcpro1;
2447 contact = Flist (nargs, args);
2448 GCPRO1 (contact);
2450 proc = Fplist_get (contact, QCprocess);
2451 if (NILP (proc))
2452 proc = Fplist_get (contact, QCname);
2453 if (NILP (proc))
2454 proc = Fplist_get (contact, QCbuffer);
2455 if (NILP (proc))
2456 proc = Fplist_get (contact, QCport);
2457 proc = get_process (proc);
2458 p = XPROCESS (proc);
2459 if (!EQ (p->type, Qserial))
2460 error ("Not a serial process");
2462 if (NILP (Fplist_get (p->childp, QCspeed)))
2464 UNGCPRO;
2465 return Qnil;
2468 serial_configure (p, contact);
2470 UNGCPRO;
2471 return Qnil;
2474 /* Used by make-serial-process to recover from errors. */
2475 static Lisp_Object
2476 make_serial_process_unwind (Lisp_Object proc)
2478 if (!PROCESSP (proc))
2479 abort ();
2480 remove_process (proc);
2481 return Qnil;
2484 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2485 0, MANY, 0,
2486 doc: /* Create and return a serial port process.
2488 In Emacs, serial port connections are represented by process objects,
2489 so input and output work as for subprocesses, and `delete-process'
2490 closes a serial port connection. However, a serial process has no
2491 process id, it cannot be signaled, and the status codes are different
2492 from normal processes.
2494 `make-serial-process' creates a process and a buffer, on which you
2495 probably want to use `process-send-string'. Try \\[serial-term] for
2496 an interactive terminal. See below for examples.
2498 Arguments are specified as keyword/argument pairs. The following
2499 arguments are defined:
2501 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2502 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2503 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2504 the backslashes in strings).
2506 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2507 which is called by `make-serial-process'.
2509 :name NAME -- NAME is the name of the process. If NAME is not given,
2510 the value of PORT is used.
2512 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2513 with the process. Process output goes at the end of that buffer,
2514 unless you specify an output stream or filter function to handle the
2515 output. If BUFFER is not given, the value of NAME is used.
2517 :coding CODING -- If CODING is a symbol, it specifies the coding
2518 system used for both reading and writing for this process. If CODING
2519 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2520 ENCODING is used for writing.
2522 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2523 the process is running. If BOOL is not given, query before exiting.
2525 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2526 In the stopped state, a serial process does not accept incoming data,
2527 but you can send outgoing data. The stopped state is cleared by
2528 `continue-process' and set by `stop-process'.
2530 :filter FILTER -- Install FILTER as the process filter.
2532 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2534 :plist PLIST -- Install PLIST as the initial plist of the process.
2536 :speed
2537 :bytesize
2538 :parity
2539 :stopbits
2540 :flowcontrol
2541 -- These arguments are handled by `serial-process-configure', which is
2542 called by `make-serial-process'.
2544 The original argument list, possibly modified by later configuration,
2545 is available via the function `process-contact'.
2547 Examples:
2549 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2551 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2553 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2555 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2557 usage: (make-serial-process &rest ARGS) */)
2558 (ptrdiff_t nargs, Lisp_Object *args)
2560 int fd = -1;
2561 Lisp_Object proc, contact, port;
2562 struct Lisp_Process *p;
2563 struct gcpro gcpro1;
2564 Lisp_Object name, buffer;
2565 Lisp_Object tem, val;
2566 int specpdl_count = -1;
2568 if (nargs == 0)
2569 return Qnil;
2571 contact = Flist (nargs, args);
2572 GCPRO1 (contact);
2574 port = Fplist_get (contact, QCport);
2575 if (NILP (port))
2576 error ("No port specified");
2577 CHECK_STRING (port);
2579 if (NILP (Fplist_member (contact, QCspeed)))
2580 error (":speed not specified");
2581 if (!NILP (Fplist_get (contact, QCspeed)))
2582 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2584 name = Fplist_get (contact, QCname);
2585 if (NILP (name))
2586 name = port;
2587 CHECK_STRING (name);
2588 proc = make_process (name);
2589 specpdl_count = SPECPDL_INDEX ();
2590 record_unwind_protect (make_serial_process_unwind, proc);
2591 p = XPROCESS (proc);
2593 fd = serial_open (SSDATA (port));
2594 p->infd = fd;
2595 p->outfd = fd;
2596 if (fd > max_process_desc)
2597 max_process_desc = fd;
2598 chan_process[fd] = proc;
2600 buffer = Fplist_get (contact, QCbuffer);
2601 if (NILP (buffer))
2602 buffer = name;
2603 buffer = Fget_buffer_create (buffer);
2604 p->buffer = buffer;
2606 p->childp = contact;
2607 p->plist = Fcopy_sequence (Fplist_get (contact, QCplist));
2608 p->type = Qserial;
2609 p->sentinel = Fplist_get (contact, QCsentinel);
2610 p->filter = Fplist_get (contact, QCfilter);
2611 p->log = Qnil;
2612 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2613 p->kill_without_query = 1;
2614 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2615 p->command = Qt;
2616 p->pty_flag = 0;
2618 if (!EQ (p->command, Qt))
2620 FD_SET (fd, &input_wait_mask);
2621 FD_SET (fd, &non_keyboard_wait_mask);
2624 if (BUFFERP (buffer))
2626 set_marker_both (p->mark, buffer,
2627 BUF_ZV (XBUFFER (buffer)),
2628 BUF_ZV_BYTE (XBUFFER (buffer)));
2631 tem = Fplist_member (contact, QCcoding);
2632 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2633 tem = Qnil;
2635 val = Qnil;
2636 if (!NILP (tem))
2638 val = XCAR (XCDR (tem));
2639 if (CONSP (val))
2640 val = XCAR (val);
2642 else if (!NILP (Vcoding_system_for_read))
2643 val = Vcoding_system_for_read;
2644 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2645 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2646 val = Qnil;
2647 p->decode_coding_system = val;
2649 val = Qnil;
2650 if (!NILP (tem))
2652 val = XCAR (XCDR (tem));
2653 if (CONSP (val))
2654 val = XCDR (val);
2656 else if (!NILP (Vcoding_system_for_write))
2657 val = Vcoding_system_for_write;
2658 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2659 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2660 val = Qnil;
2661 p->encode_coding_system = val;
2663 setup_process_coding_systems (proc);
2664 p->decoding_buf = empty_unibyte_string;
2665 p->decoding_carryover = 0;
2666 p->encoding_buf = empty_unibyte_string;
2667 p->inherit_coding_system_flag
2668 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2670 Fserial_process_configure (nargs, args);
2672 specpdl_ptr = specpdl + specpdl_count;
2674 UNGCPRO;
2675 return proc;
2678 /* Create a network stream/datagram client/server process. Treated
2679 exactly like a normal process when reading and writing. Primary
2680 differences are in status display and process deletion. A network
2681 connection has no PID; you cannot signal it. All you can do is
2682 stop/continue it and deactivate/close it via delete-process */
2684 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2685 0, MANY, 0,
2686 doc: /* Create and return a network server or client process.
2688 In Emacs, network connections are represented by process objects, so
2689 input and output work as for subprocesses and `delete-process' closes
2690 a network connection. However, a network process has no process id,
2691 it cannot be signaled, and the status codes are different from normal
2692 processes.
2694 Arguments are specified as keyword/argument pairs. The following
2695 arguments are defined:
2697 :name NAME -- NAME is name for process. It is modified if necessary
2698 to make it unique.
2700 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2701 with the process. Process output goes at end of that buffer, unless
2702 you specify an output stream or filter function to handle the output.
2703 BUFFER may be also nil, meaning that this process is not associated
2704 with any buffer.
2706 :host HOST -- HOST is name of the host to connect to, or its IP
2707 address. The symbol `local' specifies the local host. If specified
2708 for a server process, it must be a valid name or address for the local
2709 host, and only clients connecting to that address will be accepted.
2711 :service SERVICE -- SERVICE is name of the service desired, or an
2712 integer specifying a port number to connect to. If SERVICE is t,
2713 a random port number is selected for the server. (If Emacs was
2714 compiled with getaddrinfo, a port number can also be specified as a
2715 string, e.g. "80", as well as an integer. This is not portable.)
2717 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2718 stream type connection, `datagram' creates a datagram type connection,
2719 `seqpacket' creates a reliable datagram connection.
2721 :family FAMILY -- FAMILY is the address (and protocol) family for the
2722 service specified by HOST and SERVICE. The default (nil) is to use
2723 whatever address family (IPv4 or IPv6) that is defined for the host
2724 and port number specified by HOST and SERVICE. Other address families
2725 supported are:
2726 local -- for a local (i.e. UNIX) address specified by SERVICE.
2727 ipv4 -- use IPv4 address family only.
2728 ipv6 -- use IPv6 address family only.
2730 :local ADDRESS -- ADDRESS is the local address used for the connection.
2731 This parameter is ignored when opening a client process. When specified
2732 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2734 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2735 connection. This parameter is ignored when opening a stream server
2736 process. For a datagram server process, it specifies the initial
2737 setting of the remote datagram address. When specified for a client
2738 process, the FAMILY, HOST, and SERVICE args are ignored.
2740 The format of ADDRESS depends on the address family:
2741 - An IPv4 address is represented as an vector of integers [A B C D P]
2742 corresponding to numeric IP address A.B.C.D and port number P.
2743 - A local address is represented as a string with the address in the
2744 local address space.
2745 - An "unsupported family" address is represented by a cons (F . AV)
2746 where F is the family number and AV is a vector containing the socket
2747 address data with one element per address data byte. Do not rely on
2748 this format in portable code, as it may depend on implementation
2749 defined constants, data sizes, and data structure alignment.
2751 :coding CODING -- If CODING is a symbol, it specifies the coding
2752 system used for both reading and writing for this process. If CODING
2753 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2754 ENCODING is used for writing.
2756 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2757 return without waiting for the connection to complete; instead, the
2758 sentinel function will be called with second arg matching "open" (if
2759 successful) or "failed" when the connect completes. Default is to use
2760 a blocking connect (i.e. wait) for stream type connections.
2762 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2763 running when Emacs is exited.
2765 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2766 In the stopped state, a server process does not accept new
2767 connections, and a client process does not handle incoming traffic.
2768 The stopped state is cleared by `continue-process' and set by
2769 `stop-process'.
2771 :filter FILTER -- Install FILTER as the process filter.
2773 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2774 process filter are multibyte, otherwise they are unibyte.
2775 If this keyword is not specified, the strings are multibyte if
2776 `default-enable-multibyte-characters' is non-nil.
2778 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2780 :log LOG -- Install LOG as the server process log function. This
2781 function is called when the server accepts a network connection from a
2782 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2783 is the server process, CLIENT is the new process for the connection,
2784 and MESSAGE is a string.
2786 :plist PLIST -- Install PLIST as the new process' initial plist.
2788 :server QLEN -- if QLEN is non-nil, create a server process for the
2789 specified FAMILY, SERVICE, and connection type (stream or datagram).
2790 If QLEN is an integer, it is used as the max. length of the server's
2791 pending connection queue (also known as the backlog); the default
2792 queue length is 5. Default is to create a client process.
2794 The following network options can be specified for this connection:
2796 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2797 :dontroute BOOL -- Only send to directly connected hosts.
2798 :keepalive BOOL -- Send keep-alive messages on network stream.
2799 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2800 :oobinline BOOL -- Place out-of-band data in receive data stream.
2801 :priority INT -- Set protocol defined priority for sent packets.
2802 :reuseaddr BOOL -- Allow reusing a recently used local address
2803 (this is allowed by default for a server process).
2804 :bindtodevice NAME -- bind to interface NAME. Using this may require
2805 special privileges on some systems.
2807 Consult the relevant system programmer's manual pages for more
2808 information on using these options.
2811 A server process will listen for and accept connections from clients.
2812 When a client connection is accepted, a new network process is created
2813 for the connection with the following parameters:
2815 - The client's process name is constructed by concatenating the server
2816 process' NAME and a client identification string.
2817 - If the FILTER argument is non-nil, the client process will not get a
2818 separate process buffer; otherwise, the client's process buffer is a newly
2819 created buffer named after the server process' BUFFER name or process
2820 NAME concatenated with the client identification string.
2821 - The connection type and the process filter and sentinel parameters are
2822 inherited from the server process' TYPE, FILTER and SENTINEL.
2823 - The client process' contact info is set according to the client's
2824 addressing information (typically an IP address and a port number).
2825 - The client process' plist is initialized from the server's plist.
2827 Notice that the FILTER and SENTINEL args are never used directly by
2828 the server process. Also, the BUFFER argument is not used directly by
2829 the server process, but via the optional :log function, accepted (and
2830 failed) connections may be logged in the server process' buffer.
2832 The original argument list, modified with the actual connection
2833 information, is available via the `process-contact' function.
2835 usage: (make-network-process &rest ARGS) */)
2836 (ptrdiff_t nargs, Lisp_Object *args)
2838 Lisp_Object proc;
2839 Lisp_Object contact;
2840 struct Lisp_Process *p;
2841 #ifdef HAVE_GETADDRINFO
2842 struct addrinfo ai, *res, *lres;
2843 struct addrinfo hints;
2844 const char *portstring;
2845 char portbuf[128];
2846 #else /* HAVE_GETADDRINFO */
2847 struct _emacs_addrinfo
2849 int ai_family;
2850 int ai_socktype;
2851 int ai_protocol;
2852 int ai_addrlen;
2853 struct sockaddr *ai_addr;
2854 struct _emacs_addrinfo *ai_next;
2855 } ai, *res, *lres;
2856 #endif /* HAVE_GETADDRINFO */
2857 struct sockaddr_in address_in;
2858 #ifdef HAVE_LOCAL_SOCKETS
2859 struct sockaddr_un address_un;
2860 #endif
2861 int port;
2862 int ret = 0;
2863 int xerrno = 0;
2864 int s = -1, outch, inch;
2865 struct gcpro gcpro1;
2866 int count = SPECPDL_INDEX ();
2867 int count1;
2868 Lisp_Object QCaddress; /* one of QClocal or QCremote */
2869 Lisp_Object tem;
2870 Lisp_Object name, buffer, host, service, address;
2871 Lisp_Object filter, sentinel;
2872 int is_non_blocking_client = 0;
2873 int is_server = 0, backlog = 5;
2874 int socktype;
2875 int family = -1;
2877 if (nargs == 0)
2878 return Qnil;
2880 /* Save arguments for process-contact and clone-process. */
2881 contact = Flist (nargs, args);
2882 GCPRO1 (contact);
2884 #ifdef WINDOWSNT
2885 /* Ensure socket support is loaded if available. */
2886 init_winsock (TRUE);
2887 #endif
2889 /* :type TYPE (nil: stream, datagram */
2890 tem = Fplist_get (contact, QCtype);
2891 if (NILP (tem))
2892 socktype = SOCK_STREAM;
2893 #ifdef DATAGRAM_SOCKETS
2894 else if (EQ (tem, Qdatagram))
2895 socktype = SOCK_DGRAM;
2896 #endif
2897 #ifdef HAVE_SEQPACKET
2898 else if (EQ (tem, Qseqpacket))
2899 socktype = SOCK_SEQPACKET;
2900 #endif
2901 else
2902 error ("Unsupported connection type");
2904 /* :server BOOL */
2905 tem = Fplist_get (contact, QCserver);
2906 if (!NILP (tem))
2908 /* Don't support network sockets when non-blocking mode is
2909 not available, since a blocked Emacs is not useful. */
2910 #if !defined(O_NONBLOCK) && !defined(O_NDELAY)
2911 error ("Network servers not supported");
2912 #else
2913 is_server = 1;
2914 if (INTEGERP (tem))
2915 backlog = XINT (tem);
2916 #endif
2919 /* Make QCaddress an alias for :local (server) or :remote (client). */
2920 QCaddress = is_server ? QClocal : QCremote;
2922 /* :nowait BOOL */
2923 if (!is_server && socktype != SOCK_DGRAM
2924 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2926 #ifndef NON_BLOCKING_CONNECT
2927 error ("Non-blocking connect not supported");
2928 #else
2929 is_non_blocking_client = 1;
2930 #endif
2933 name = Fplist_get (contact, QCname);
2934 buffer = Fplist_get (contact, QCbuffer);
2935 filter = Fplist_get (contact, QCfilter);
2936 sentinel = Fplist_get (contact, QCsentinel);
2938 CHECK_STRING (name);
2940 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2941 ai.ai_socktype = socktype;
2942 ai.ai_protocol = 0;
2943 ai.ai_next = NULL;
2944 res = &ai;
2946 /* :local ADDRESS or :remote ADDRESS */
2947 address = Fplist_get (contact, QCaddress);
2948 if (!NILP (address))
2950 host = service = Qnil;
2952 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2953 error ("Malformed :address");
2954 ai.ai_family = family;
2955 ai.ai_addr = alloca (ai.ai_addrlen);
2956 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2957 goto open_socket;
2960 /* :family FAMILY -- nil (for Inet), local, or integer. */
2961 tem = Fplist_get (contact, QCfamily);
2962 if (NILP (tem))
2964 #if defined(HAVE_GETADDRINFO) && defined(AF_INET6)
2965 family = AF_UNSPEC;
2966 #else
2967 family = AF_INET;
2968 #endif
2970 #ifdef HAVE_LOCAL_SOCKETS
2971 else if (EQ (tem, Qlocal))
2972 family = AF_LOCAL;
2973 #endif
2974 #ifdef AF_INET6
2975 else if (EQ (tem, Qipv6))
2976 family = AF_INET6;
2977 #endif
2978 else if (EQ (tem, Qipv4))
2979 family = AF_INET;
2980 else if (INTEGERP (tem))
2981 family = XINT (tem);
2982 else
2983 error ("Unknown address family");
2985 ai.ai_family = family;
2987 /* :service SERVICE -- string, integer (port number), or t (random port). */
2988 service = Fplist_get (contact, QCservice);
2990 /* :host HOST -- hostname, ip address, or 'local for localhost. */
2991 host = Fplist_get (contact, QChost);
2992 if (!NILP (host))
2994 if (EQ (host, Qlocal))
2995 /* Depending on setup, "localhost" may map to different IPv4 and/or
2996 IPv6 addresses, so it's better to be explicit. (Bug#6781) */
2997 host = build_string ("127.0.0.1");
2998 CHECK_STRING (host);
3001 #ifdef HAVE_LOCAL_SOCKETS
3002 if (family == AF_LOCAL)
3004 if (!NILP (host))
3006 message (":family local ignores the :host \"%s\" property",
3007 SDATA (host));
3008 contact = Fplist_put (contact, QChost, Qnil);
3009 host = Qnil;
3011 CHECK_STRING (service);
3012 memset (&address_un, 0, sizeof address_un);
3013 address_un.sun_family = AF_LOCAL;
3014 strncpy (address_un.sun_path, SSDATA (service), sizeof address_un.sun_path);
3015 ai.ai_addr = (struct sockaddr *) &address_un;
3016 ai.ai_addrlen = sizeof address_un;
3017 goto open_socket;
3019 #endif
3021 /* Slow down polling to every ten seconds.
3022 Some kernels have a bug which causes retrying connect to fail
3023 after a connect. Polling can interfere with gethostbyname too. */
3024 #ifdef POLL_FOR_INPUT
3025 if (socktype != SOCK_DGRAM)
3027 record_unwind_protect (unwind_stop_other_atimers, Qnil);
3028 bind_polling_period (10);
3030 #endif
3032 #ifdef HAVE_GETADDRINFO
3033 /* If we have a host, use getaddrinfo to resolve both host and service.
3034 Otherwise, use getservbyname to lookup the service. */
3035 if (!NILP (host))
3038 /* SERVICE can either be a string or int.
3039 Convert to a C string for later use by getaddrinfo. */
3040 if (EQ (service, Qt))
3041 portstring = "0";
3042 else if (INTEGERP (service))
3044 sprintf (portbuf, "%"pI"d", XINT (service));
3045 portstring = portbuf;
3047 else
3049 CHECK_STRING (service);
3050 portstring = SSDATA (service);
3053 immediate_quit = 1;
3054 QUIT;
3055 memset (&hints, 0, sizeof (hints));
3056 hints.ai_flags = 0;
3057 hints.ai_family = family;
3058 hints.ai_socktype = socktype;
3059 hints.ai_protocol = 0;
3061 #ifdef HAVE_RES_INIT
3062 res_init ();
3063 #endif
3065 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3066 if (ret)
3067 #ifdef HAVE_GAI_STRERROR
3068 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3069 #else
3070 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3071 #endif
3072 immediate_quit = 0;
3074 goto open_socket;
3076 #endif /* HAVE_GETADDRINFO */
3078 /* We end up here if getaddrinfo is not defined, or in case no hostname
3079 has been specified (e.g. for a local server process). */
3081 if (EQ (service, Qt))
3082 port = 0;
3083 else if (INTEGERP (service))
3084 port = htons ((unsigned short) XINT (service));
3085 else
3087 struct servent *svc_info;
3088 CHECK_STRING (service);
3089 svc_info = getservbyname (SSDATA (service),
3090 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3091 if (svc_info == 0)
3092 error ("Unknown service: %s", SDATA (service));
3093 port = svc_info->s_port;
3096 memset (&address_in, 0, sizeof address_in);
3097 address_in.sin_family = family;
3098 address_in.sin_addr.s_addr = INADDR_ANY;
3099 address_in.sin_port = port;
3101 #ifndef HAVE_GETADDRINFO
3102 if (!NILP (host))
3104 struct hostent *host_info_ptr;
3106 /* gethostbyname may fail with TRY_AGAIN, but we don't honour that,
3107 as it may `hang' Emacs for a very long time. */
3108 immediate_quit = 1;
3109 QUIT;
3111 #ifdef HAVE_RES_INIT
3112 res_init ();
3113 #endif
3115 host_info_ptr = gethostbyname (SDATA (host));
3116 immediate_quit = 0;
3118 if (host_info_ptr)
3120 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3121 host_info_ptr->h_length);
3122 family = host_info_ptr->h_addrtype;
3123 address_in.sin_family = family;
3125 else
3126 /* Attempt to interpret host as numeric inet address */
3128 unsigned long numeric_addr;
3129 numeric_addr = inet_addr (SSDATA (host));
3130 if (numeric_addr == -1)
3131 error ("Unknown host \"%s\"", SDATA (host));
3133 memcpy (&address_in.sin_addr, &numeric_addr,
3134 sizeof (address_in.sin_addr));
3138 #endif /* not HAVE_GETADDRINFO */
3140 ai.ai_family = family;
3141 ai.ai_addr = (struct sockaddr *) &address_in;
3142 ai.ai_addrlen = sizeof address_in;
3144 open_socket:
3146 /* Do this in case we never enter the for-loop below. */
3147 count1 = SPECPDL_INDEX ();
3148 s = -1;
3150 for (lres = res; lres; lres = lres->ai_next)
3152 ptrdiff_t optn;
3153 int optbits;
3155 #ifdef WINDOWSNT
3156 retry_connect:
3157 #endif
3159 s = socket (lres->ai_family, lres->ai_socktype, lres->ai_protocol);
3160 if (s < 0)
3162 xerrno = errno;
3163 continue;
3166 #ifdef DATAGRAM_SOCKETS
3167 if (!is_server && socktype == SOCK_DGRAM)
3168 break;
3169 #endif /* DATAGRAM_SOCKETS */
3171 #ifdef NON_BLOCKING_CONNECT
3172 if (is_non_blocking_client)
3174 #ifdef O_NONBLOCK
3175 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3176 #else
3177 ret = fcntl (s, F_SETFL, O_NDELAY);
3178 #endif
3179 if (ret < 0)
3181 xerrno = errno;
3182 emacs_close (s);
3183 s = -1;
3184 continue;
3187 #endif
3189 /* Make us close S if quit. */
3190 record_unwind_protect (close_file_unwind, make_number (s));
3192 /* Parse network options in the arg list.
3193 We simply ignore anything which isn't a known option (including other keywords).
3194 An error is signaled if setting a known option fails. */
3195 for (optn = optbits = 0; optn < nargs-1; optn += 2)
3196 optbits |= set_socket_option (s, args[optn], args[optn+1]);
3198 if (is_server)
3200 /* Configure as a server socket. */
3202 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3203 explicit :reuseaddr key to override this. */
3204 #ifdef HAVE_LOCAL_SOCKETS
3205 if (family != AF_LOCAL)
3206 #endif
3207 if (!(optbits & (1 << OPIX_REUSEADDR)))
3209 int optval = 1;
3210 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3211 report_file_error ("Cannot set reuse option on server socket", Qnil);
3214 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3215 report_file_error ("Cannot bind server socket", Qnil);
3217 #ifdef HAVE_GETSOCKNAME
3218 if (EQ (service, Qt))
3220 struct sockaddr_in sa1;
3221 socklen_t len1 = sizeof (sa1);
3222 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3224 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3225 service = make_number (ntohs (sa1.sin_port));
3226 contact = Fplist_put (contact, QCservice, service);
3229 #endif
3231 if (socktype != SOCK_DGRAM && listen (s, backlog))
3232 report_file_error ("Cannot listen on server socket", Qnil);
3234 break;
3237 immediate_quit = 1;
3238 QUIT;
3240 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3241 xerrno = errno;
3243 if (ret == 0 || xerrno == EISCONN)
3245 /* The unwind-protect will be discarded afterwards.
3246 Likewise for immediate_quit. */
3247 break;
3250 #ifdef NON_BLOCKING_CONNECT
3251 #ifdef EINPROGRESS
3252 if (is_non_blocking_client && xerrno == EINPROGRESS)
3253 break;
3254 #else
3255 #ifdef EWOULDBLOCK
3256 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3257 break;
3258 #endif
3259 #endif
3260 #endif
3262 #ifndef WINDOWSNT
3263 if (xerrno == EINTR)
3265 /* Unlike most other syscalls connect() cannot be called
3266 again. (That would return EALREADY.) The proper way to
3267 wait for completion is select(). */
3268 int sc;
3269 socklen_t len;
3270 SELECT_TYPE fdset;
3271 retry_select:
3272 FD_ZERO (&fdset);
3273 FD_SET (s, &fdset);
3274 QUIT;
3275 sc = select (s + 1, (SELECT_TYPE *)0, &fdset, (SELECT_TYPE *)0,
3276 (EMACS_TIME *)0);
3277 if (sc == -1)
3279 if (errno == EINTR)
3280 goto retry_select;
3281 else
3282 report_file_error ("select failed", Qnil);
3284 eassert (sc > 0);
3286 len = sizeof xerrno;
3287 eassert (FD_ISSET (s, &fdset));
3288 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) == -1)
3289 report_file_error ("getsockopt failed", Qnil);
3290 if (xerrno)
3291 errno = xerrno, report_file_error ("error during connect", Qnil);
3292 else
3293 break;
3295 #endif /* !WINDOWSNT */
3297 immediate_quit = 0;
3299 /* Discard the unwind protect closing S. */
3300 specpdl_ptr = specpdl + count1;
3301 emacs_close (s);
3302 s = -1;
3304 #ifdef WINDOWSNT
3305 if (xerrno == EINTR)
3306 goto retry_connect;
3307 #endif
3310 if (s >= 0)
3312 #ifdef DATAGRAM_SOCKETS
3313 if (socktype == SOCK_DGRAM)
3315 if (datagram_address[s].sa)
3316 abort ();
3317 datagram_address[s].sa = (struct sockaddr *) xmalloc (lres->ai_addrlen);
3318 datagram_address[s].len = lres->ai_addrlen;
3319 if (is_server)
3321 Lisp_Object remote;
3322 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3323 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3325 int rfamily, rlen;
3326 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3327 if (rfamily == lres->ai_family && rlen == lres->ai_addrlen)
3328 conv_lisp_to_sockaddr (rfamily, remote,
3329 datagram_address[s].sa, rlen);
3332 else
3333 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3335 #endif
3336 contact = Fplist_put (contact, QCaddress,
3337 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3338 #ifdef HAVE_GETSOCKNAME
3339 if (!is_server)
3341 struct sockaddr_in sa1;
3342 socklen_t len1 = sizeof (sa1);
3343 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3344 contact = Fplist_put (contact, QClocal,
3345 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3347 #endif
3350 immediate_quit = 0;
3352 #ifdef HAVE_GETADDRINFO
3353 if (res != &ai)
3355 BLOCK_INPUT;
3356 freeaddrinfo (res);
3357 UNBLOCK_INPUT;
3359 #endif
3361 /* Discard the unwind protect for closing S, if any. */
3362 specpdl_ptr = specpdl + count1;
3364 /* Unwind bind_polling_period and request_sigio. */
3365 unbind_to (count, Qnil);
3367 if (s < 0)
3369 /* If non-blocking got this far - and failed - assume non-blocking is
3370 not supported after all. This is probably a wrong assumption, but
3371 the normal blocking calls to open-network-stream handles this error
3372 better. */
3373 if (is_non_blocking_client)
3374 return Qnil;
3376 errno = xerrno;
3377 if (is_server)
3378 report_file_error ("make server process failed", contact);
3379 else
3380 report_file_error ("make client process failed", contact);
3383 inch = s;
3384 outch = s;
3386 if (!NILP (buffer))
3387 buffer = Fget_buffer_create (buffer);
3388 proc = make_process (name);
3390 chan_process[inch] = proc;
3392 #ifdef O_NONBLOCK
3393 fcntl (inch, F_SETFL, O_NONBLOCK);
3394 #else
3395 #ifdef O_NDELAY
3396 fcntl (inch, F_SETFL, O_NDELAY);
3397 #endif
3398 #endif
3400 p = XPROCESS (proc);
3402 p->childp = contact;
3403 p->plist = Fcopy_sequence (Fplist_get (contact, QCplist));
3404 p->type = Qnetwork;
3406 p->buffer = buffer;
3407 p->sentinel = sentinel;
3408 p->filter = filter;
3409 p->log = Fplist_get (contact, QClog);
3410 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3411 p->kill_without_query = 1;
3412 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3413 p->command = Qt;
3414 p->pid = 0;
3415 p->infd = inch;
3416 p->outfd = outch;
3417 if (is_server && socktype != SOCK_DGRAM)
3418 p->status = Qlisten;
3420 /* Make the process marker point into the process buffer (if any). */
3421 if (BUFFERP (buffer))
3422 set_marker_both (p->mark, buffer,
3423 BUF_ZV (XBUFFER (buffer)),
3424 BUF_ZV_BYTE (XBUFFER (buffer)));
3426 #ifdef NON_BLOCKING_CONNECT
3427 if (is_non_blocking_client)
3429 /* We may get here if connect did succeed immediately. However,
3430 in that case, we still need to signal this like a non-blocking
3431 connection. */
3432 p->status = Qconnect;
3433 if (!FD_ISSET (inch, &connect_wait_mask))
3435 FD_SET (inch, &connect_wait_mask);
3436 FD_SET (inch, &write_mask);
3437 num_pending_connects++;
3440 else
3441 #endif
3442 /* A server may have a client filter setting of Qt, but it must
3443 still listen for incoming connects unless it is stopped. */
3444 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3445 || (EQ (p->status, Qlisten) && NILP (p->command)))
3447 FD_SET (inch, &input_wait_mask);
3448 FD_SET (inch, &non_keyboard_wait_mask);
3451 if (inch > max_process_desc)
3452 max_process_desc = inch;
3454 tem = Fplist_member (contact, QCcoding);
3455 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3456 tem = Qnil; /* No error message (too late!). */
3459 /* Setup coding systems for communicating with the network stream. */
3460 struct gcpro inner_gcpro1;
3461 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3462 Lisp_Object coding_systems = Qt;
3463 Lisp_Object fargs[5], val;
3465 if (!NILP (tem))
3467 val = XCAR (XCDR (tem));
3468 if (CONSP (val))
3469 val = XCAR (val);
3471 else if (!NILP (Vcoding_system_for_read))
3472 val = Vcoding_system_for_read;
3473 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3474 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3475 /* We dare not decode end-of-line format by setting VAL to
3476 Qraw_text, because the existing Emacs Lisp libraries
3477 assume that they receive bare code including a sequene of
3478 CR LF. */
3479 val = Qnil;
3480 else
3482 if (NILP (host) || NILP (service))
3483 coding_systems = Qnil;
3484 else
3486 fargs[0] = Qopen_network_stream, fargs[1] = name,
3487 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3488 GCPRO1_VAR (proc, inner_gcpro);
3489 coding_systems = Ffind_operation_coding_system (5, fargs);
3490 UNGCPRO_VAR (inner_gcpro);
3492 if (CONSP (coding_systems))
3493 val = XCAR (coding_systems);
3494 else if (CONSP (Vdefault_process_coding_system))
3495 val = XCAR (Vdefault_process_coding_system);
3496 else
3497 val = Qnil;
3499 p->decode_coding_system = val;
3501 if (!NILP (tem))
3503 val = XCAR (XCDR (tem));
3504 if (CONSP (val))
3505 val = XCDR (val);
3507 else if (!NILP (Vcoding_system_for_write))
3508 val = Vcoding_system_for_write;
3509 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3510 val = Qnil;
3511 else
3513 if (EQ (coding_systems, Qt))
3515 if (NILP (host) || NILP (service))
3516 coding_systems = Qnil;
3517 else
3519 fargs[0] = Qopen_network_stream, fargs[1] = name,
3520 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3521 GCPRO1_VAR (proc, inner_gcpro);
3522 coding_systems = Ffind_operation_coding_system (5, fargs);
3523 UNGCPRO_VAR (inner_gcpro);
3526 if (CONSP (coding_systems))
3527 val = XCDR (coding_systems);
3528 else if (CONSP (Vdefault_process_coding_system))
3529 val = XCDR (Vdefault_process_coding_system);
3530 else
3531 val = Qnil;
3533 p->encode_coding_system = val;
3535 setup_process_coding_systems (proc);
3537 p->decoding_buf = empty_unibyte_string;
3538 p->decoding_carryover = 0;
3539 p->encoding_buf = empty_unibyte_string;
3541 p->inherit_coding_system_flag
3542 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3544 UNGCPRO;
3545 return proc;
3549 #if defined(HAVE_NET_IF_H)
3551 #ifdef SIOCGIFCONF
3552 DEFUN ("network-interface-list", Fnetwork_interface_list, Snetwork_interface_list, 0, 0, 0,
3553 doc: /* Return an alist of all network interfaces and their network address.
3554 Each element is a cons, the car of which is a string containing the
3555 interface name, and the cdr is the network address in internal
3556 format; see the description of ADDRESS in `make-network-process'. */)
3557 (void)
3559 struct ifconf ifconf;
3560 struct ifreq *ifreqs = NULL;
3561 int ifaces = 0;
3562 int buf_size, s;
3563 Lisp_Object res;
3565 s = socket (AF_INET, SOCK_STREAM, 0);
3566 if (s < 0)
3567 return Qnil;
3569 again:
3570 ifaces += 25;
3571 buf_size = ifaces * sizeof (ifreqs[0]);
3572 ifreqs = (struct ifreq *)xrealloc(ifreqs, buf_size);
3573 if (!ifreqs)
3575 close (s);
3576 return Qnil;
3579 ifconf.ifc_len = buf_size;
3580 ifconf.ifc_req = ifreqs;
3581 if (ioctl (s, SIOCGIFCONF, &ifconf))
3583 close (s);
3584 return Qnil;
3587 if (ifconf.ifc_len == buf_size)
3588 goto again;
3590 close (s);
3591 ifaces = ifconf.ifc_len / sizeof (ifreqs[0]);
3593 res = Qnil;
3594 while (--ifaces >= 0)
3596 struct ifreq *ifq = &ifreqs[ifaces];
3597 char namebuf[sizeof (ifq->ifr_name) + 1];
3598 if (ifq->ifr_addr.sa_family != AF_INET)
3599 continue;
3600 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3601 namebuf[sizeof (ifq->ifr_name)] = 0;
3602 res = Fcons (Fcons (build_string (namebuf),
3603 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3604 sizeof (struct sockaddr))),
3605 res);
3608 return res;
3610 #endif /* SIOCGIFCONF */
3612 #if defined(SIOCGIFADDR) || defined(SIOCGIFHWADDR) || defined(SIOCGIFFLAGS)
3614 struct ifflag_def {
3615 int flag_bit;
3616 const char *flag_sym;
3619 static const struct ifflag_def ifflag_table[] = {
3620 #ifdef IFF_UP
3621 { IFF_UP, "up" },
3622 #endif
3623 #ifdef IFF_BROADCAST
3624 { IFF_BROADCAST, "broadcast" },
3625 #endif
3626 #ifdef IFF_DEBUG
3627 { IFF_DEBUG, "debug" },
3628 #endif
3629 #ifdef IFF_LOOPBACK
3630 { IFF_LOOPBACK, "loopback" },
3631 #endif
3632 #ifdef IFF_POINTOPOINT
3633 { IFF_POINTOPOINT, "pointopoint" },
3634 #endif
3635 #ifdef IFF_RUNNING
3636 { IFF_RUNNING, "running" },
3637 #endif
3638 #ifdef IFF_NOARP
3639 { IFF_NOARP, "noarp" },
3640 #endif
3641 #ifdef IFF_PROMISC
3642 { IFF_PROMISC, "promisc" },
3643 #endif
3644 #ifdef IFF_NOTRAILERS
3645 { IFF_NOTRAILERS, "notrailers" },
3646 #endif
3647 #ifdef IFF_ALLMULTI
3648 { IFF_ALLMULTI, "allmulti" },
3649 #endif
3650 #ifdef IFF_MASTER
3651 { IFF_MASTER, "master" },
3652 #endif
3653 #ifdef IFF_SLAVE
3654 { IFF_SLAVE, "slave" },
3655 #endif
3656 #ifdef IFF_MULTICAST
3657 { IFF_MULTICAST, "multicast" },
3658 #endif
3659 #ifdef IFF_PORTSEL
3660 { IFF_PORTSEL, "portsel" },
3661 #endif
3662 #ifdef IFF_AUTOMEDIA
3663 { IFF_AUTOMEDIA, "automedia" },
3664 #endif
3665 #ifdef IFF_DYNAMIC
3666 { IFF_DYNAMIC, "dynamic" },
3667 #endif
3668 #ifdef IFF_OACTIVE
3669 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress */
3670 #endif
3671 #ifdef IFF_SIMPLEX
3672 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions */
3673 #endif
3674 #ifdef IFF_LINK0
3675 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit */
3676 #endif
3677 #ifdef IFF_LINK1
3678 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit */
3679 #endif
3680 #ifdef IFF_LINK2
3681 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit */
3682 #endif
3683 { 0, 0 }
3686 DEFUN ("network-interface-info", Fnetwork_interface_info, Snetwork_interface_info, 1, 1, 0,
3687 doc: /* Return information about network interface named IFNAME.
3688 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3689 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3690 NETMASK is the layer 3 network mask, HWADDR is the layer 2 addres, and
3691 FLAGS is the current flags of the interface. */)
3692 (Lisp_Object ifname)
3694 struct ifreq rq;
3695 Lisp_Object res = Qnil;
3696 Lisp_Object elt;
3697 int s;
3698 int any = 0;
3700 CHECK_STRING (ifname);
3702 memset (rq.ifr_name, 0, sizeof rq.ifr_name);
3703 strncpy (rq.ifr_name, SSDATA (ifname), sizeof (rq.ifr_name));
3705 s = socket (AF_INET, SOCK_STREAM, 0);
3706 if (s < 0)
3707 return Qnil;
3709 elt = Qnil;
3710 #if defined(SIOCGIFFLAGS) && defined(HAVE_STRUCT_IFREQ_IFR_FLAGS)
3711 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3713 int flags = rq.ifr_flags;
3714 const struct ifflag_def *fp;
3715 int fnum;
3717 any = 1;
3718 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3720 if (flags & fp->flag_bit)
3722 elt = Fcons (intern (fp->flag_sym), elt);
3723 flags -= fp->flag_bit;
3726 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3728 if (flags & 1)
3730 elt = Fcons (make_number (fnum), elt);
3734 #endif
3735 res = Fcons (elt, res);
3737 elt = Qnil;
3738 #if defined(SIOCGIFHWADDR) && defined(HAVE_STRUCT_IFREQ_IFR_HWADDR)
3739 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3741 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3742 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3743 int n;
3745 any = 1;
3746 for (n = 0; n < 6; n++)
3747 p->contents[n] = make_number (((unsigned char *)&rq.ifr_hwaddr.sa_data[0])[n]);
3748 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3750 #endif
3751 res = Fcons (elt, res);
3753 elt = Qnil;
3754 #if defined(SIOCGIFNETMASK) && (defined(HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined(HAVE_STRUCT_IFREQ_IFR_ADDR))
3755 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3757 any = 1;
3758 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3759 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3760 #else
3761 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3762 #endif
3764 #endif
3765 res = Fcons (elt, res);
3767 elt = Qnil;
3768 #if defined(SIOCGIFBRDADDR) && defined(HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3769 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3771 any = 1;
3772 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3774 #endif
3775 res = Fcons (elt, res);
3777 elt = Qnil;
3778 #if defined(SIOCGIFADDR) && defined(HAVE_STRUCT_IFREQ_IFR_ADDR)
3779 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3781 any = 1;
3782 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3784 #endif
3785 res = Fcons (elt, res);
3787 close (s);
3789 return any ? res : Qnil;
3791 #endif
3792 #endif /* defined(HAVE_NET_IF_H) */
3794 /* Turn off input and output for process PROC. */
3796 static void
3797 deactivate_process (Lisp_Object proc)
3799 register int inchannel, outchannel;
3800 register struct Lisp_Process *p = XPROCESS (proc);
3802 inchannel = p->infd;
3803 outchannel = p->outfd;
3805 #ifdef ADAPTIVE_READ_BUFFERING
3806 if (p->read_output_delay > 0)
3808 if (--process_output_delay_count < 0)
3809 process_output_delay_count = 0;
3810 p->read_output_delay = 0;
3811 p->read_output_skip = 0;
3813 #endif
3815 if (inchannel >= 0)
3817 /* Beware SIGCHLD hereabouts. */
3818 flush_pending_output (inchannel);
3819 emacs_close (inchannel);
3820 if (outchannel >= 0 && outchannel != inchannel)
3821 emacs_close (outchannel);
3823 p->infd = -1;
3824 p->outfd = -1;
3825 #ifdef DATAGRAM_SOCKETS
3826 if (DATAGRAM_CHAN_P (inchannel))
3828 xfree (datagram_address[inchannel].sa);
3829 datagram_address[inchannel].sa = 0;
3830 datagram_address[inchannel].len = 0;
3832 #endif
3833 chan_process[inchannel] = Qnil;
3834 FD_CLR (inchannel, &input_wait_mask);
3835 FD_CLR (inchannel, &non_keyboard_wait_mask);
3836 #ifdef NON_BLOCKING_CONNECT
3837 if (FD_ISSET (inchannel, &connect_wait_mask))
3839 FD_CLR (inchannel, &connect_wait_mask);
3840 FD_CLR (inchannel, &write_mask);
3841 if (--num_pending_connects < 0)
3842 abort ();
3844 #endif
3845 if (inchannel == max_process_desc)
3847 int i;
3848 /* We just closed the highest-numbered process input descriptor,
3849 so recompute the highest-numbered one now. */
3850 max_process_desc = 0;
3851 for (i = 0; i < MAXDESC; i++)
3852 if (!NILP (chan_process[i]))
3853 max_process_desc = i;
3859 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3860 0, 4, 0,
3861 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3862 It is read into the process' buffers or given to their filter functions.
3863 Non-nil arg PROCESS means do not return until some output has been received
3864 from PROCESS.
3866 Non-nil second arg SECONDS and third arg MILLISEC are number of seconds
3867 and milliseconds to wait; return after that much time whether or not
3868 there is any subprocess output. If SECONDS is a floating point number,
3869 it specifies a fractional number of seconds to wait.
3870 The MILLISEC argument is obsolete and should be avoided.
3872 If optional fourth arg JUST-THIS-ONE is non-nil, only accept output
3873 from PROCESS, suspending reading output from other processes.
3874 If JUST-THIS-ONE is an integer, don't run any timers either.
3875 Return non-nil if we received any output before the timeout expired. */)
3876 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3878 int secs, usecs = 0;
3880 if (! NILP (process))
3881 CHECK_PROCESS (process);
3882 else
3883 just_this_one = Qnil;
3885 if (!NILP (millisec))
3886 { /* Obsolete calling convention using integers rather than floats. */
3887 CHECK_NUMBER (millisec);
3888 if (NILP (seconds))
3889 seconds = make_float (XINT (millisec) / 1000.0);
3890 else
3892 CHECK_NUMBER (seconds);
3893 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3897 if (!NILP (seconds))
3899 if (INTEGERP (seconds))
3900 secs = XINT (seconds);
3901 else if (FLOATP (seconds))
3903 double timeout = XFLOAT_DATA (seconds);
3904 secs = (int) timeout;
3905 usecs = (int) ((timeout - (double) secs) * 1000000);
3907 else
3908 wrong_type_argument (Qnumberp, seconds);
3910 if (secs < 0 || (secs == 0 && usecs == 0))
3911 secs = -1, usecs = 0;
3913 else
3914 secs = NILP (process) ? -1 : 0;
3916 return
3917 (wait_reading_process_output (secs, usecs, 0, 0,
3918 Qnil,
3919 !NILP (process) ? XPROCESS (process) : NULL,
3920 NILP (just_this_one) ? 0 :
3921 !INTEGERP (just_this_one) ? 1 : -1)
3922 ? Qt : Qnil);
3925 /* Accept a connection for server process SERVER on CHANNEL. */
3927 static int connect_counter = 0;
3929 static void
3930 server_accept_connection (Lisp_Object server, int channel)
3932 Lisp_Object proc, caller, name, buffer;
3933 Lisp_Object contact, host, service;
3934 struct Lisp_Process *ps= XPROCESS (server);
3935 struct Lisp_Process *p;
3936 int s;
3937 union u_sockaddr {
3938 struct sockaddr sa;
3939 struct sockaddr_in in;
3940 #ifdef AF_INET6
3941 struct sockaddr_in6 in6;
3942 #endif
3943 #ifdef HAVE_LOCAL_SOCKETS
3944 struct sockaddr_un un;
3945 #endif
3946 } saddr;
3947 socklen_t len = sizeof saddr;
3949 s = accept (channel, &saddr.sa, &len);
3951 if (s < 0)
3953 int code = errno;
3955 if (code == EAGAIN)
3956 return;
3957 #ifdef EWOULDBLOCK
3958 if (code == EWOULDBLOCK)
3959 return;
3960 #endif
3962 if (!NILP (ps->log))
3963 call3 (ps->log, server, Qnil,
3964 concat3 (build_string ("accept failed with code"),
3965 Fnumber_to_string (make_number (code)),
3966 build_string ("\n")));
3967 return;
3970 connect_counter++;
3972 /* Setup a new process to handle the connection. */
3974 /* Generate a unique identification of the caller, and build contact
3975 information for this process. */
3976 host = Qt;
3977 service = Qnil;
3978 switch (saddr.sa.sa_family)
3980 case AF_INET:
3982 Lisp_Object args[5];
3983 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
3984 args[0] = build_string ("%d.%d.%d.%d");
3985 args[1] = make_number (*ip++);
3986 args[2] = make_number (*ip++);
3987 args[3] = make_number (*ip++);
3988 args[4] = make_number (*ip++);
3989 host = Fformat (5, args);
3990 service = make_number (ntohs (saddr.in.sin_port));
3992 args[0] = build_string (" <%s:%d>");
3993 args[1] = host;
3994 args[2] = service;
3995 caller = Fformat (3, args);
3997 break;
3999 #ifdef AF_INET6
4000 case AF_INET6:
4002 Lisp_Object args[9];
4003 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4004 int i;
4005 args[0] = build_string ("%x:%x:%x:%x:%x:%x:%x:%x");
4006 for (i = 0; i < 8; i++)
4007 args[i+1] = make_number (ntohs (ip6[i]));
4008 host = Fformat (9, args);
4009 service = make_number (ntohs (saddr.in.sin_port));
4011 args[0] = build_string (" <[%s]:%d>");
4012 args[1] = host;
4013 args[2] = service;
4014 caller = Fformat (3, args);
4016 break;
4017 #endif
4019 #ifdef HAVE_LOCAL_SOCKETS
4020 case AF_LOCAL:
4021 #endif
4022 default:
4023 caller = Fnumber_to_string (make_number (connect_counter));
4024 caller = concat3 (build_string (" <"), caller, build_string (">"));
4025 break;
4028 /* Create a new buffer name for this process if it doesn't have a
4029 filter. The new buffer name is based on the buffer name or
4030 process name of the server process concatenated with the caller
4031 identification. */
4033 if (!NILP (ps->filter) && !EQ (ps->filter, Qt))
4034 buffer = Qnil;
4035 else
4037 buffer = ps->buffer;
4038 if (!NILP (buffer))
4039 buffer = Fbuffer_name (buffer);
4040 else
4041 buffer = ps->name;
4042 if (!NILP (buffer))
4044 buffer = concat2 (buffer, caller);
4045 buffer = Fget_buffer_create (buffer);
4049 /* Generate a unique name for the new server process. Combine the
4050 server process name with the caller identification. */
4052 name = concat2 (ps->name, caller);
4053 proc = make_process (name);
4055 chan_process[s] = proc;
4057 #ifdef O_NONBLOCK
4058 fcntl (s, F_SETFL, O_NONBLOCK);
4059 #else
4060 #ifdef O_NDELAY
4061 fcntl (s, F_SETFL, O_NDELAY);
4062 #endif
4063 #endif
4065 p = XPROCESS (proc);
4067 /* Build new contact information for this setup. */
4068 contact = Fcopy_sequence (ps->childp);
4069 contact = Fplist_put (contact, QCserver, Qnil);
4070 contact = Fplist_put (contact, QChost, host);
4071 if (!NILP (service))
4072 contact = Fplist_put (contact, QCservice, service);
4073 contact = Fplist_put (contact, QCremote,
4074 conv_sockaddr_to_lisp (&saddr.sa, len));
4075 #ifdef HAVE_GETSOCKNAME
4076 len = sizeof saddr;
4077 if (getsockname (s, &saddr.sa, &len) == 0)
4078 contact = Fplist_put (contact, QClocal,
4079 conv_sockaddr_to_lisp (&saddr.sa, len));
4080 #endif
4082 p->childp = contact;
4083 p->plist = Fcopy_sequence (ps->plist);
4084 p->type = Qnetwork;
4086 p->buffer = buffer;
4087 p->sentinel = ps->sentinel;
4088 p->filter = ps->filter;
4089 p->command = Qnil;
4090 p->pid = 0;
4091 p->infd = s;
4092 p->outfd = s;
4093 p->status = Qrun;
4095 /* Client processes for accepted connections are not stopped initially. */
4096 if (!EQ (p->filter, Qt))
4098 FD_SET (s, &input_wait_mask);
4099 FD_SET (s, &non_keyboard_wait_mask);
4102 if (s > max_process_desc)
4103 max_process_desc = s;
4105 /* Setup coding system for new process based on server process.
4106 This seems to be the proper thing to do, as the coding system
4107 of the new process should reflect the settings at the time the
4108 server socket was opened; not the current settings. */
4110 p->decode_coding_system = ps->decode_coding_system;
4111 p->encode_coding_system = ps->encode_coding_system;
4112 setup_process_coding_systems (proc);
4114 p->decoding_buf = empty_unibyte_string;
4115 p->decoding_carryover = 0;
4116 p->encoding_buf = empty_unibyte_string;
4118 p->inherit_coding_system_flag
4119 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4121 if (!NILP (ps->log))
4122 call3 (ps->log, server, proc,
4123 concat3 (build_string ("accept from "),
4124 (STRINGP (host) ? host : build_string ("-")),
4125 build_string ("\n")));
4127 if (!NILP (p->sentinel))
4128 exec_sentinel (proc,
4129 concat3 (build_string ("open from "),
4130 (STRINGP (host) ? host : build_string ("-")),
4131 build_string ("\n")));
4134 /* This variable is different from waiting_for_input in keyboard.c.
4135 It is used to communicate to a lisp process-filter/sentinel (via the
4136 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4137 for user-input when that process-filter was called.
4138 waiting_for_input cannot be used as that is by definition 0 when
4139 lisp code is being evalled.
4140 This is also used in record_asynch_buffer_change.
4141 For that purpose, this must be 0
4142 when not inside wait_reading_process_output. */
4143 static int waiting_for_user_input_p;
4145 static Lisp_Object
4146 wait_reading_process_output_unwind (Lisp_Object data)
4148 waiting_for_user_input_p = XINT (data);
4149 return Qnil;
4152 /* This is here so breakpoints can be put on it. */
4153 static void
4154 wait_reading_process_output_1 (void)
4158 /* Use a wrapper around select to work around a bug in gdb 5.3.
4159 Normally, the wrapper is optimized away by inlining.
4161 If emacs is stopped inside select, the gdb backtrace doesn't
4162 show the function which called select, so it is practically
4163 impossible to step through wait_reading_process_output. */
4165 #ifndef select
4166 static inline int
4167 select_wrapper (int n, fd_set *rfd, fd_set *wfd, fd_set *xfd, struct timeval *tmo)
4169 return select (n, rfd, wfd, xfd, tmo);
4171 #define select select_wrapper
4172 #endif
4174 /* Read and dispose of subprocess output while waiting for timeout to
4175 elapse and/or keyboard input to be available.
4177 TIME_LIMIT is:
4178 timeout in seconds, or
4179 zero for no limit, or
4180 -1 means gobble data immediately available but don't wait for any.
4182 MICROSECS is:
4183 an additional duration to wait, measured in microseconds.
4184 If this is nonzero and time_limit is 0, then the timeout
4185 consists of MICROSECS only.
4187 READ_KBD is a lisp value:
4188 0 to ignore keyboard input, or
4189 1 to return when input is available, or
4190 -1 meaning caller will actually read the input, so don't throw to
4191 the quit handler, or
4193 DO_DISPLAY != 0 means redisplay should be done to show subprocess
4194 output that arrives.
4196 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4197 (and gobble terminal input into the buffer if any arrives).
4199 If WAIT_PROC is specified, wait until something arrives from that
4200 process. The return value is true if we read some input from
4201 that process.
4203 If JUST_WAIT_PROC is non-nil, handle only output from WAIT_PROC
4204 (suspending output from other processes). A negative value
4205 means don't run any timers either.
4207 If WAIT_PROC is specified, then the function returns true if we
4208 received input from that process before the timeout elapsed.
4209 Otherwise, return true if we received input from any process. */
4212 wait_reading_process_output (int time_limit, int microsecs, int read_kbd,
4213 int do_display,
4214 Lisp_Object wait_for_cell,
4215 struct Lisp_Process *wait_proc, int just_wait_proc)
4217 register int channel, nfds;
4218 SELECT_TYPE Available;
4219 SELECT_TYPE Writeok;
4220 int check_write;
4221 int check_delay, no_avail;
4222 int xerrno;
4223 Lisp_Object proc;
4224 EMACS_TIME timeout, end_time;
4225 int wait_channel = -1;
4226 int got_some_input = 0;
4227 int count = SPECPDL_INDEX ();
4229 FD_ZERO (&Available);
4230 FD_ZERO (&Writeok);
4232 if (time_limit == 0 && microsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4233 && !(CONSP (wait_proc->status) && EQ (XCAR (wait_proc->status), Qexit)))
4234 message ("Blocking call to accept-process-output with quit inhibited!!");
4236 /* If wait_proc is a process to watch, set wait_channel accordingly. */
4237 if (wait_proc != NULL)
4238 wait_channel = wait_proc->infd;
4240 record_unwind_protect (wait_reading_process_output_unwind,
4241 make_number (waiting_for_user_input_p));
4242 waiting_for_user_input_p = read_kbd;
4244 /* Since we may need to wait several times,
4245 compute the absolute time to return at. */
4246 if (time_limit || microsecs)
4248 EMACS_GET_TIME (end_time);
4249 EMACS_SET_SECS_USECS (timeout, time_limit, microsecs);
4250 EMACS_ADD_TIME (end_time, end_time, timeout);
4253 while (1)
4255 int timeout_reduced_for_timers = 0;
4257 /* If calling from keyboard input, do not quit
4258 since we want to return C-g as an input character.
4259 Otherwise, do pending quit if requested. */
4260 if (read_kbd >= 0)
4261 QUIT;
4262 #ifdef SYNC_INPUT
4263 else
4264 process_pending_signals ();
4265 #endif
4267 /* Exit now if the cell we're waiting for became non-nil. */
4268 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4269 break;
4271 /* Compute time from now till when time limit is up */
4272 /* Exit if already run out */
4273 if (time_limit == -1)
4275 /* -1 specified for timeout means
4276 gobble output available now
4277 but don't wait at all. */
4279 EMACS_SET_SECS_USECS (timeout, 0, 0);
4281 else if (time_limit || microsecs)
4283 EMACS_GET_TIME (timeout);
4284 EMACS_SUB_TIME (timeout, end_time, timeout);
4285 if (EMACS_TIME_NEG_P (timeout))
4286 break;
4288 else
4290 EMACS_SET_SECS_USECS (timeout, 100000, 0);
4293 /* Normally we run timers here.
4294 But not if wait_for_cell; in those cases,
4295 the wait is supposed to be short,
4296 and those callers cannot handle running arbitrary Lisp code here. */
4297 if (NILP (wait_for_cell)
4298 && just_wait_proc >= 0)
4300 EMACS_TIME timer_delay;
4304 int old_timers_run = timers_run;
4305 struct buffer *old_buffer = current_buffer;
4306 Lisp_Object old_window = selected_window;
4308 timer_delay = timer_check ();
4310 /* If a timer has run, this might have changed buffers
4311 an alike. Make read_key_sequence aware of that. */
4312 if (timers_run != old_timers_run
4313 && (old_buffer != current_buffer
4314 || !EQ (old_window, selected_window))
4315 && waiting_for_user_input_p == -1)
4316 record_asynch_buffer_change ();
4318 if (timers_run != old_timers_run && do_display)
4319 /* We must retry, since a timer may have requeued itself
4320 and that could alter the time_delay. */
4321 redisplay_preserve_echo_area (9);
4322 else
4323 break;
4325 while (!detect_input_pending ());
4327 /* If there is unread keyboard input, also return. */
4328 if (read_kbd != 0
4329 && requeued_events_pending_p ())
4330 break;
4332 if (! EMACS_TIME_NEG_P (timer_delay) && time_limit != -1)
4334 EMACS_TIME difference;
4335 EMACS_SUB_TIME (difference, timer_delay, timeout);
4336 if (EMACS_TIME_NEG_P (difference))
4338 timeout = timer_delay;
4339 timeout_reduced_for_timers = 1;
4342 /* If time_limit is -1, we are not going to wait at all. */
4343 else if (time_limit != -1)
4345 /* This is so a breakpoint can be put here. */
4346 wait_reading_process_output_1 ();
4350 /* Cause C-g and alarm signals to take immediate action,
4351 and cause input available signals to zero out timeout.
4353 It is important that we do this before checking for process
4354 activity. If we get a SIGCHLD after the explicit checks for
4355 process activity, timeout is the only way we will know. */
4356 if (read_kbd < 0)
4357 set_waiting_for_input (&timeout);
4359 /* If status of something has changed, and no input is
4360 available, notify the user of the change right away. After
4361 this explicit check, we'll let the SIGCHLD handler zap
4362 timeout to get our attention. */
4363 if (update_tick != process_tick)
4365 SELECT_TYPE Atemp;
4366 SELECT_TYPE Ctemp;
4368 if (kbd_on_hold_p ())
4369 FD_ZERO (&Atemp);
4370 else
4371 Atemp = input_wait_mask;
4372 Ctemp = write_mask;
4374 EMACS_SET_SECS_USECS (timeout, 0, 0);
4375 if ((select (max (max_process_desc, max_input_desc) + 1,
4376 &Atemp,
4377 #ifdef NON_BLOCKING_CONNECT
4378 (num_pending_connects > 0 ? &Ctemp : (SELECT_TYPE *)0),
4379 #else
4380 (SELECT_TYPE *)0,
4381 #endif
4382 (SELECT_TYPE *)0, &timeout)
4383 <= 0))
4385 /* It's okay for us to do this and then continue with
4386 the loop, since timeout has already been zeroed out. */
4387 clear_waiting_for_input ();
4388 status_notify (NULL);
4389 if (do_display) redisplay_preserve_echo_area (13);
4393 /* Don't wait for output from a non-running process. Just
4394 read whatever data has already been received. */
4395 if (wait_proc && wait_proc->raw_status_new)
4396 update_status (wait_proc);
4397 if (wait_proc
4398 && ! EQ (wait_proc->status, Qrun)
4399 && ! EQ (wait_proc->status, Qconnect))
4401 int nread, total_nread = 0;
4403 clear_waiting_for_input ();
4404 XSETPROCESS (proc, wait_proc);
4406 /* Read data from the process, until we exhaust it. */
4407 while (wait_proc->infd >= 0)
4409 nread = read_process_output (proc, wait_proc->infd);
4411 if (nread == 0)
4412 break;
4414 if (0 < nread)
4416 total_nread += nread;
4417 got_some_input = 1;
4419 #ifdef EIO
4420 else if (nread == -1 && EIO == errno)
4421 break;
4422 #endif
4423 #ifdef EAGAIN
4424 else if (nread == -1 && EAGAIN == errno)
4425 break;
4426 #endif
4427 #ifdef EWOULDBLOCK
4428 else if (nread == -1 && EWOULDBLOCK == errno)
4429 break;
4430 #endif
4432 if (total_nread > 0 && do_display)
4433 redisplay_preserve_echo_area (10);
4435 break;
4438 /* Wait till there is something to do */
4440 if (wait_proc && just_wait_proc)
4442 if (wait_proc->infd < 0) /* Terminated */
4443 break;
4444 FD_SET (wait_proc->infd, &Available);
4445 check_delay = 0;
4446 check_write = 0;
4448 else if (!NILP (wait_for_cell))
4450 Available = non_process_wait_mask;
4451 check_delay = 0;
4452 check_write = 0;
4454 else
4456 if (! read_kbd)
4457 Available = non_keyboard_wait_mask;
4458 else
4459 Available = input_wait_mask;
4460 Writeok = write_mask;
4461 #ifdef SELECT_CANT_DO_WRITE_MASK
4462 check_write = 0;
4463 #else
4464 check_write = 1;
4465 #endif
4466 check_delay = wait_channel >= 0 ? 0 : process_output_delay_count;
4469 /* If frame size has changed or the window is newly mapped,
4470 redisplay now, before we start to wait. There is a race
4471 condition here; if a SIGIO arrives between now and the select
4472 and indicates that a frame is trashed, the select may block
4473 displaying a trashed screen. */
4474 if (frame_garbaged && do_display)
4476 clear_waiting_for_input ();
4477 redisplay_preserve_echo_area (11);
4478 if (read_kbd < 0)
4479 set_waiting_for_input (&timeout);
4482 no_avail = 0;
4483 if (read_kbd && detect_input_pending ())
4485 nfds = 0;
4486 no_avail = 1;
4488 else
4491 #ifdef ADAPTIVE_READ_BUFFERING
4492 /* Set the timeout for adaptive read buffering if any
4493 process has non-zero read_output_skip and non-zero
4494 read_output_delay, and we are not reading output for a
4495 specific wait_channel. It is not executed if
4496 Vprocess_adaptive_read_buffering is nil. */
4497 if (process_output_skip && check_delay > 0)
4499 int usecs = EMACS_USECS (timeout);
4500 if (EMACS_SECS (timeout) > 0 || usecs > READ_OUTPUT_DELAY_MAX)
4501 usecs = READ_OUTPUT_DELAY_MAX;
4502 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4504 proc = chan_process[channel];
4505 if (NILP (proc))
4506 continue;
4507 /* Find minimum non-zero read_output_delay among the
4508 processes with non-zero read_output_skip. */
4509 if (XPROCESS (proc)->read_output_delay > 0)
4511 check_delay--;
4512 if (!XPROCESS (proc)->read_output_skip)
4513 continue;
4514 FD_CLR (channel, &Available);
4515 XPROCESS (proc)->read_output_skip = 0;
4516 if (XPROCESS (proc)->read_output_delay < usecs)
4517 usecs = XPROCESS (proc)->read_output_delay;
4520 EMACS_SET_SECS_USECS (timeout, 0, usecs);
4521 process_output_skip = 0;
4523 #endif
4524 #if defined (USE_GTK) || defined (HAVE_GCONF)
4525 nfds = xg_select
4526 #elif defined (HAVE_NS)
4527 nfds = ns_select
4528 #else
4529 nfds = select
4530 #endif
4531 (max (max_process_desc, max_input_desc) + 1,
4532 &Available,
4533 (check_write ? &Writeok : (SELECT_TYPE *)0),
4534 (SELECT_TYPE *)0, &timeout);
4536 #ifdef HAVE_GNUTLS
4537 /* GnuTLS buffers data internally. In lowat mode it leaves
4538 some data in the TCP buffers so that select works, but
4539 with custom pull/push functions we need to check if some
4540 data is available in the buffers manually. */
4541 if (nfds == 0 &&
4542 wait_proc && wait_proc->gnutls_p /* Check for valid process. */
4543 /* Do we have pending data? */
4544 && emacs_gnutls_record_check_pending (wait_proc->gnutls_state) > 0)
4546 nfds = 1;
4547 /* Set to Available. */
4548 FD_SET (wait_proc->infd, &Available);
4550 #endif
4553 xerrno = errno;
4555 /* Make C-g and alarm signals set flags again */
4556 clear_waiting_for_input ();
4558 /* If we woke up due to SIGWINCH, actually change size now. */
4559 do_pending_window_change (0);
4561 if (time_limit && nfds == 0 && ! timeout_reduced_for_timers)
4562 /* We wanted the full specified time, so return now. */
4563 break;
4564 if (nfds < 0)
4566 if (xerrno == EINTR)
4567 no_avail = 1;
4568 else if (xerrno == EBADF)
4570 #ifdef AIX
4571 /* AIX doesn't handle PTY closure the same way BSD does. On AIX,
4572 the child's closure of the pts gives the parent a SIGHUP, and
4573 the ptc file descriptor is automatically closed,
4574 yielding EBADF here or at select() call above.
4575 So, SIGHUP is ignored (see def of PTY_TTY_NAME_SPRINTF
4576 in m/ibmrt-aix.h), and here we just ignore the select error.
4577 Cleanup occurs c/o status_notify after SIGCLD. */
4578 no_avail = 1; /* Cannot depend on values returned */
4579 #else
4580 abort ();
4581 #endif
4583 else
4584 error ("select error: %s", emacs_strerror (xerrno));
4587 if (no_avail)
4589 FD_ZERO (&Available);
4590 check_write = 0;
4593 #if 0 /* When polling is used, interrupt_input is 0,
4594 so get_input_pending should read the input.
4595 So this should not be needed. */
4596 /* If we are using polling for input,
4597 and we see input available, make it get read now.
4598 Otherwise it might not actually get read for a second.
4599 And on hpux, since we turn off polling in wait_reading_process_output,
4600 it might never get read at all if we don't spend much time
4601 outside of wait_reading_process_output. */
4602 if (read_kbd && interrupt_input
4603 && keyboard_bit_set (&Available)
4604 && input_polling_used ())
4605 kill (getpid (), SIGALRM);
4606 #endif
4608 /* Check for keyboard input */
4609 /* If there is any, return immediately
4610 to give it higher priority than subprocesses */
4612 if (read_kbd != 0)
4614 int old_timers_run = timers_run;
4615 struct buffer *old_buffer = current_buffer;
4616 Lisp_Object old_window = selected_window;
4617 int leave = 0;
4619 if (detect_input_pending_run_timers (do_display))
4621 swallow_events (do_display);
4622 if (detect_input_pending_run_timers (do_display))
4623 leave = 1;
4626 /* If a timer has run, this might have changed buffers
4627 an alike. Make read_key_sequence aware of that. */
4628 if (timers_run != old_timers_run
4629 && waiting_for_user_input_p == -1
4630 && (old_buffer != current_buffer
4631 || !EQ (old_window, selected_window)))
4632 record_asynch_buffer_change ();
4634 if (leave)
4635 break;
4638 /* If there is unread keyboard input, also return. */
4639 if (read_kbd != 0
4640 && requeued_events_pending_p ())
4641 break;
4643 /* If we are not checking for keyboard input now,
4644 do process events (but don't run any timers).
4645 This is so that X events will be processed.
4646 Otherwise they may have to wait until polling takes place.
4647 That would causes delays in pasting selections, for example.
4649 (We used to do this only if wait_for_cell.) */
4650 if (read_kbd == 0 && detect_input_pending ())
4652 swallow_events (do_display);
4653 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4654 if (detect_input_pending ())
4655 break;
4656 #endif
4659 /* Exit now if the cell we're waiting for became non-nil. */
4660 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4661 break;
4663 #ifdef SIGIO
4664 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4665 go read it. This can happen with X on BSD after logging out.
4666 In that case, there really is no input and no SIGIO,
4667 but select says there is input. */
4669 if (read_kbd && interrupt_input
4670 && keyboard_bit_set (&Available) && ! noninteractive)
4671 kill (getpid (), SIGIO);
4672 #endif
4674 if (! wait_proc)
4675 got_some_input |= nfds > 0;
4677 /* If checking input just got us a size-change event from X,
4678 obey it now if we should. */
4679 if (read_kbd || ! NILP (wait_for_cell))
4680 do_pending_window_change (0);
4682 /* Check for data from a process. */
4683 if (no_avail || nfds == 0)
4684 continue;
4686 for (channel = 0; channel <= max_input_desc; ++channel)
4688 struct fd_callback_data *d = &fd_callback_info[channel];
4689 if (FD_ISSET (channel, &Available)
4690 && d->func != 0
4691 && (d->condition & FOR_READ) != 0)
4692 d->func (channel, d->data, 1);
4693 if (FD_ISSET (channel, &write_mask)
4694 && d->func != 0
4695 && (d->condition & FOR_WRITE) != 0)
4696 d->func (channel, d->data, 0);
4699 for (channel = 0; channel <= max_process_desc; channel++)
4701 if (FD_ISSET (channel, &Available)
4702 && FD_ISSET (channel, &non_keyboard_wait_mask)
4703 && !FD_ISSET (channel, &non_process_wait_mask))
4705 int nread;
4707 /* If waiting for this channel, arrange to return as
4708 soon as no more input to be processed. No more
4709 waiting. */
4710 if (wait_channel == channel)
4712 wait_channel = -1;
4713 time_limit = -1;
4714 got_some_input = 1;
4716 proc = chan_process[channel];
4717 if (NILP (proc))
4718 continue;
4720 /* If this is a server stream socket, accept connection. */
4721 if (EQ (XPROCESS (proc)->status, Qlisten))
4723 server_accept_connection (proc, channel);
4724 continue;
4727 /* Read data from the process, starting with our
4728 buffered-ahead character if we have one. */
4730 nread = read_process_output (proc, channel);
4731 if (nread > 0)
4733 /* Since read_process_output can run a filter,
4734 which can call accept-process-output,
4735 don't try to read from any other processes
4736 before doing the select again. */
4737 FD_ZERO (&Available);
4739 if (do_display)
4740 redisplay_preserve_echo_area (12);
4742 #ifdef EWOULDBLOCK
4743 else if (nread == -1 && errno == EWOULDBLOCK)
4745 #endif
4746 /* ISC 4.1 defines both EWOULDBLOCK and O_NONBLOCK,
4747 and Emacs uses O_NONBLOCK, so what we get is EAGAIN. */
4748 #ifdef O_NONBLOCK
4749 else if (nread == -1 && errno == EAGAIN)
4751 #else
4752 #ifdef O_NDELAY
4753 else if (nread == -1 && errno == EAGAIN)
4755 /* Note that we cannot distinguish between no input
4756 available now and a closed pipe.
4757 With luck, a closed pipe will be accompanied by
4758 subprocess termination and SIGCHLD. */
4759 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4761 #endif /* O_NDELAY */
4762 #endif /* O_NONBLOCK */
4763 #ifdef HAVE_PTYS
4764 /* On some OSs with ptys, when the process on one end of
4765 a pty exits, the other end gets an error reading with
4766 errno = EIO instead of getting an EOF (0 bytes read).
4767 Therefore, if we get an error reading and errno =
4768 EIO, just continue, because the child process has
4769 exited and should clean itself up soon (e.g. when we
4770 get a SIGCHLD).
4772 However, it has been known to happen that the SIGCHLD
4773 got lost. So raise the signal again just in case.
4774 It can't hurt. */
4775 else if (nread == -1 && errno == EIO)
4777 /* Clear the descriptor now, so we only raise the
4778 signal once. Don't do this if `process' is only
4779 a pty. */
4780 if (XPROCESS (proc)->pid != -2)
4782 FD_CLR (channel, &input_wait_mask);
4783 FD_CLR (channel, &non_keyboard_wait_mask);
4785 kill (getpid (), SIGCHLD);
4788 #endif /* HAVE_PTYS */
4789 /* If we can detect process termination, don't consider the process
4790 gone just because its pipe is closed. */
4791 #ifdef SIGCHLD
4792 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4794 #endif
4795 else
4797 /* Preserve status of processes already terminated. */
4798 XPROCESS (proc)->tick = ++process_tick;
4799 deactivate_process (proc);
4800 if (XPROCESS (proc)->raw_status_new)
4801 update_status (XPROCESS (proc));
4802 if (EQ (XPROCESS (proc)->status, Qrun))
4803 XPROCESS (proc)->status
4804 = Fcons (Qexit, Fcons (make_number (256), Qnil));
4807 #ifdef NON_BLOCKING_CONNECT
4808 if (FD_ISSET (channel, &Writeok)
4809 && FD_ISSET (channel, &connect_wait_mask))
4811 struct Lisp_Process *p;
4813 FD_CLR (channel, &connect_wait_mask);
4814 FD_CLR (channel, &write_mask);
4815 if (--num_pending_connects < 0)
4816 abort ();
4818 proc = chan_process[channel];
4819 if (NILP (proc))
4820 continue;
4822 p = XPROCESS (proc);
4824 #ifdef GNU_LINUX
4825 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4826 So only use it on systems where it is known to work. */
4828 socklen_t xlen = sizeof (xerrno);
4829 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4830 xerrno = errno;
4832 #else
4834 struct sockaddr pname;
4835 int pnamelen = sizeof (pname);
4837 /* If connection failed, getpeername will fail. */
4838 xerrno = 0;
4839 if (getpeername (channel, &pname, &pnamelen) < 0)
4841 /* Obtain connect failure code through error slippage. */
4842 char dummy;
4843 xerrno = errno;
4844 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4845 xerrno = errno;
4848 #endif
4849 if (xerrno)
4851 p->tick = ++process_tick;
4852 p->status = Fcons (Qfailed, Fcons (make_number (xerrno), Qnil));
4853 deactivate_process (proc);
4855 else
4857 p->status = Qrun;
4858 /* Execute the sentinel here. If we had relied on
4859 status_notify to do it later, it will read input
4860 from the process before calling the sentinel. */
4861 exec_sentinel (proc, build_string ("open\n"));
4862 if (!EQ (p->filter, Qt) && !EQ (p->command, Qt))
4864 FD_SET (p->infd, &input_wait_mask);
4865 FD_SET (p->infd, &non_keyboard_wait_mask);
4869 #endif /* NON_BLOCKING_CONNECT */
4870 } /* end for each file descriptor */
4871 } /* end while exit conditions not met */
4873 unbind_to (count, Qnil);
4875 /* If calling from keyboard input, do not quit
4876 since we want to return C-g as an input character.
4877 Otherwise, do pending quit if requested. */
4878 if (read_kbd >= 0)
4880 /* Prevent input_pending from remaining set if we quit. */
4881 clear_input_pending ();
4882 QUIT;
4885 return got_some_input;
4888 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
4890 static Lisp_Object
4891 read_process_output_call (Lisp_Object fun_and_args)
4893 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
4896 static Lisp_Object
4897 read_process_output_error_handler (Lisp_Object error_val)
4899 cmd_error_internal (error_val, "error in process filter: ");
4900 Vinhibit_quit = Qt;
4901 update_echo_area ();
4902 Fsleep_for (make_number (2), Qnil);
4903 return Qt;
4906 /* Read pending output from the process channel,
4907 starting with our buffered-ahead character if we have one.
4908 Yield number of decoded characters read.
4910 This function reads at most 4096 characters.
4911 If you want to read all available subprocess output,
4912 you must call it repeatedly until it returns zero.
4914 The characters read are decoded according to PROC's coding-system
4915 for decoding. */
4917 static int
4918 read_process_output (Lisp_Object proc, register int channel)
4920 register ssize_t nbytes;
4921 char *chars;
4922 register Lisp_Object outstream;
4923 register struct Lisp_Process *p = XPROCESS (proc);
4924 register EMACS_INT opoint;
4925 struct coding_system *coding = proc_decode_coding_system[channel];
4926 int carryover = p->decoding_carryover;
4927 int readmax = 4096;
4928 int count = SPECPDL_INDEX ();
4929 Lisp_Object odeactivate;
4931 chars = (char *) alloca (carryover + readmax);
4932 if (carryover)
4933 /* See the comment above. */
4934 memcpy (chars, SDATA (p->decoding_buf), carryover);
4936 #ifdef DATAGRAM_SOCKETS
4937 /* We have a working select, so proc_buffered_char is always -1. */
4938 if (DATAGRAM_CHAN_P (channel))
4940 socklen_t len = datagram_address[channel].len;
4941 nbytes = recvfrom (channel, chars + carryover, readmax,
4942 0, datagram_address[channel].sa, &len);
4944 else
4945 #endif
4947 int buffered = 0 <= proc_buffered_char[channel];
4948 if (buffered)
4950 chars[carryover] = proc_buffered_char[channel];
4951 proc_buffered_char[channel] = -1;
4953 #ifdef HAVE_GNUTLS
4954 if (XPROCESS (proc)->gnutls_p)
4955 nbytes = emacs_gnutls_read (XPROCESS (proc),
4956 chars + carryover + buffered,
4957 readmax - buffered);
4958 else
4959 #endif
4960 nbytes = emacs_read (channel, chars + carryover + buffered,
4961 readmax - buffered);
4962 #ifdef ADAPTIVE_READ_BUFFERING
4963 if (nbytes > 0 && p->adaptive_read_buffering)
4965 int delay = p->read_output_delay;
4966 if (nbytes < 256)
4968 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
4970 if (delay == 0)
4971 process_output_delay_count++;
4972 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
4975 else if (delay > 0 && nbytes == readmax - buffered)
4977 delay -= READ_OUTPUT_DELAY_INCREMENT;
4978 if (delay == 0)
4979 process_output_delay_count--;
4981 p->read_output_delay = delay;
4982 if (delay)
4984 p->read_output_skip = 1;
4985 process_output_skip = 1;
4988 #endif
4989 nbytes += buffered;
4990 nbytes += buffered && nbytes <= 0;
4993 p->decoding_carryover = 0;
4995 /* At this point, NBYTES holds number of bytes just received
4996 (including the one in proc_buffered_char[channel]). */
4997 if (nbytes <= 0)
4999 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5000 return nbytes;
5001 coding->mode |= CODING_MODE_LAST_BLOCK;
5004 /* Now set NBYTES how many bytes we must decode. */
5005 nbytes += carryover;
5007 odeactivate = Vdeactivate_mark;
5008 /* There's no good reason to let process filters change the current
5009 buffer, and many callers of accept-process-output, sit-for, and
5010 friends don't expect current-buffer to be changed from under them. */
5011 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
5013 /* Read and dispose of the process output. */
5014 outstream = p->filter;
5015 if (!NILP (outstream))
5017 Lisp_Object text;
5018 int outer_running_asynch_code = running_asynch_code;
5019 int waiting = waiting_for_user_input_p;
5021 /* No need to gcpro these, because all we do with them later
5022 is test them for EQness, and none of them should be a string. */
5023 #if 0
5024 Lisp_Object obuffer, okeymap;
5025 XSETBUFFER (obuffer, current_buffer);
5026 okeymap = BVAR (current_buffer, keymap);
5027 #endif
5029 /* We inhibit quit here instead of just catching it so that
5030 hitting ^G when a filter happens to be running won't screw
5031 it up. */
5032 specbind (Qinhibit_quit, Qt);
5033 specbind (Qlast_nonmenu_event, Qt);
5035 /* In case we get recursively called,
5036 and we already saved the match data nonrecursively,
5037 save the same match data in safely recursive fashion. */
5038 if (outer_running_asynch_code)
5040 Lisp_Object tem;
5041 /* Don't clobber the CURRENT match data, either! */
5042 tem = Fmatch_data (Qnil, Qnil, Qnil);
5043 restore_search_regs ();
5044 record_unwind_save_match_data ();
5045 Fset_match_data (tem, Qt);
5048 /* For speed, if a search happens within this code,
5049 save the match data in a special nonrecursive fashion. */
5050 running_asynch_code = 1;
5052 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5053 text = coding->dst_object;
5054 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5055 /* A new coding system might be found. */
5056 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5058 p->decode_coding_system = Vlast_coding_system_used;
5060 /* Don't call setup_coding_system for
5061 proc_decode_coding_system[channel] here. It is done in
5062 detect_coding called via decode_coding above. */
5064 /* If a coding system for encoding is not yet decided, we set
5065 it as the same as coding-system for decoding.
5067 But, before doing that we must check if
5068 proc_encode_coding_system[p->outfd] surely points to a
5069 valid memory because p->outfd will be changed once EOF is
5070 sent to the process. */
5071 if (NILP (p->encode_coding_system)
5072 && proc_encode_coding_system[p->outfd])
5074 p->encode_coding_system
5075 = coding_inherit_eol_type (Vlast_coding_system_used, Qnil);
5076 setup_coding_system (p->encode_coding_system,
5077 proc_encode_coding_system[p->outfd]);
5081 if (coding->carryover_bytes > 0)
5083 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5084 p->decoding_buf = make_uninit_string (coding->carryover_bytes);
5085 memcpy (SDATA (p->decoding_buf), coding->carryover,
5086 coding->carryover_bytes);
5087 p->decoding_carryover = coding->carryover_bytes;
5089 if (SBYTES (text) > 0)
5090 internal_condition_case_1 (read_process_output_call,
5091 Fcons (outstream,
5092 Fcons (proc, Fcons (text, Qnil))),
5093 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5094 read_process_output_error_handler);
5096 /* If we saved the match data nonrecursively, restore it now. */
5097 restore_search_regs ();
5098 running_asynch_code = outer_running_asynch_code;
5100 /* Restore waiting_for_user_input_p as it was
5101 when we were called, in case the filter clobbered it. */
5102 waiting_for_user_input_p = waiting;
5104 #if 0 /* Call record_asynch_buffer_change unconditionally,
5105 because we might have changed minor modes or other things
5106 that affect key bindings. */
5107 if (! EQ (Fcurrent_buffer (), obuffer)
5108 || ! EQ (current_buffer->keymap, okeymap))
5109 #endif
5110 /* But do it only if the caller is actually going to read events.
5111 Otherwise there's no need to make him wake up, and it could
5112 cause trouble (for example it would make sit_for return). */
5113 if (waiting_for_user_input_p == -1)
5114 record_asynch_buffer_change ();
5117 /* If no filter, write into buffer if it isn't dead. */
5118 else if (!NILP (p->buffer) && !NILP (BVAR (XBUFFER (p->buffer), name)))
5120 Lisp_Object old_read_only;
5121 EMACS_INT old_begv, old_zv;
5122 EMACS_INT old_begv_byte, old_zv_byte;
5123 EMACS_INT before, before_byte;
5124 EMACS_INT opoint_byte;
5125 Lisp_Object text;
5126 struct buffer *b;
5128 Fset_buffer (p->buffer);
5129 opoint = PT;
5130 opoint_byte = PT_BYTE;
5131 old_read_only = BVAR (current_buffer, read_only);
5132 old_begv = BEGV;
5133 old_zv = ZV;
5134 old_begv_byte = BEGV_BYTE;
5135 old_zv_byte = ZV_BYTE;
5137 BVAR (current_buffer, read_only) = Qnil;
5139 /* Insert new output into buffer
5140 at the current end-of-output marker,
5141 thus preserving logical ordering of input and output. */
5142 if (XMARKER (p->mark)->buffer)
5143 SET_PT_BOTH (clip_to_bounds (BEGV, marker_position (p->mark), ZV),
5144 clip_to_bounds (BEGV_BYTE, marker_byte_position (p->mark),
5145 ZV_BYTE));
5146 else
5147 SET_PT_BOTH (ZV, ZV_BYTE);
5148 before = PT;
5149 before_byte = PT_BYTE;
5151 /* If the output marker is outside of the visible region, save
5152 the restriction and widen. */
5153 if (! (BEGV <= PT && PT <= ZV))
5154 Fwiden ();
5156 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5157 text = coding->dst_object;
5158 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5159 /* A new coding system might be found. See the comment in the
5160 similar code in the previous `if' block. */
5161 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5163 p->decode_coding_system = Vlast_coding_system_used;
5164 if (NILP (p->encode_coding_system)
5165 && proc_encode_coding_system[p->outfd])
5167 p->encode_coding_system
5168 = coding_inherit_eol_type (Vlast_coding_system_used, Qnil);
5169 setup_coding_system (p->encode_coding_system,
5170 proc_encode_coding_system[p->outfd]);
5173 if (coding->carryover_bytes > 0)
5175 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5176 p->decoding_buf = make_uninit_string (coding->carryover_bytes);
5177 memcpy (SDATA (p->decoding_buf), coding->carryover,
5178 coding->carryover_bytes);
5179 p->decoding_carryover = coding->carryover_bytes;
5181 /* Adjust the multibyteness of TEXT to that of the buffer. */
5182 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5183 != ! STRING_MULTIBYTE (text))
5184 text = (STRING_MULTIBYTE (text)
5185 ? Fstring_as_unibyte (text)
5186 : Fstring_to_multibyte (text));
5187 /* Insert before markers in case we are inserting where
5188 the buffer's mark is, and the user's next command is Meta-y. */
5189 insert_from_string_before_markers (text, 0, 0,
5190 SCHARS (text), SBYTES (text), 0);
5192 /* Make sure the process marker's position is valid when the
5193 process buffer is changed in the signal_after_change above.
5194 W3 is known to do that. */
5195 if (BUFFERP (p->buffer)
5196 && (b = XBUFFER (p->buffer), b != current_buffer))
5197 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5198 else
5199 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5201 update_mode_lines++;
5203 /* Make sure opoint and the old restrictions
5204 float ahead of any new text just as point would. */
5205 if (opoint >= before)
5207 opoint += PT - before;
5208 opoint_byte += PT_BYTE - before_byte;
5210 if (old_begv > before)
5212 old_begv += PT - before;
5213 old_begv_byte += PT_BYTE - before_byte;
5215 if (old_zv >= before)
5217 old_zv += PT - before;
5218 old_zv_byte += PT_BYTE - before_byte;
5221 /* If the restriction isn't what it should be, set it. */
5222 if (old_begv != BEGV || old_zv != ZV)
5223 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5226 BVAR (current_buffer, read_only) = old_read_only;
5227 SET_PT_BOTH (opoint, opoint_byte);
5229 /* Handling the process output should not deactivate the mark. */
5230 Vdeactivate_mark = odeactivate;
5232 unbind_to (count, Qnil);
5233 return nbytes;
5236 /* Sending data to subprocess */
5238 static jmp_buf send_process_frame;
5239 static Lisp_Object process_sent_to;
5241 #ifndef FORWARD_SIGNAL_TO_MAIN_THREAD
5242 static void send_process_trap (int) NO_RETURN;
5243 #endif
5245 static void
5246 send_process_trap (int ignore)
5248 SIGNAL_THREAD_CHECK (SIGPIPE);
5249 sigunblock (sigmask (SIGPIPE));
5250 longjmp (send_process_frame, 1);
5253 /* Send some data to process PROC.
5254 BUF is the beginning of the data; LEN is the number of characters.
5255 OBJECT is the Lisp object that the data comes from. If OBJECT is
5256 nil or t, it means that the data comes from C string.
5258 If OBJECT is not nil, the data is encoded by PROC's coding-system
5259 for encoding before it is sent.
5261 This function can evaluate Lisp code and can garbage collect. */
5263 static void
5264 send_process (volatile Lisp_Object proc, const char *volatile buf,
5265 volatile EMACS_INT len, volatile Lisp_Object object)
5267 /* Use volatile to protect variables from being clobbered by longjmp. */
5268 struct Lisp_Process *p = XPROCESS (proc);
5269 ssize_t rv;
5270 struct coding_system *coding;
5271 struct gcpro gcpro1;
5272 void (*volatile old_sigpipe) (int);
5274 GCPRO1 (object);
5276 if (p->raw_status_new)
5277 update_status (p);
5278 if (! EQ (p->status, Qrun))
5279 error ("Process %s not running", SDATA (p->name));
5280 if (p->outfd < 0)
5281 error ("Output file descriptor of %s is closed", SDATA (p->name));
5283 coding = proc_encode_coding_system[p->outfd];
5284 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5286 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5287 || (BUFFERP (object)
5288 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5289 || EQ (object, Qt))
5291 p->encode_coding_system
5292 = complement_process_encoding_system (p->encode_coding_system);
5293 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5295 /* The coding system for encoding was changed to raw-text
5296 because we sent a unibyte text previously. Now we are
5297 sending a multibyte text, thus we must encode it by the
5298 original coding system specified for the current process.
5300 Another reason we comming here is that the coding system
5301 was just complemented and new one was returned by
5302 complement_process_encoding_system. */
5303 setup_coding_system (p->encode_coding_system, coding);
5304 Vlast_coding_system_used = p->encode_coding_system;
5306 coding->src_multibyte = 1;
5308 else
5310 /* For sending a unibyte text, character code conversion should
5311 not take place but EOL conversion should. So, setup raw-text
5312 or one of the subsidiary if we have not yet done it. */
5313 if (CODING_REQUIRE_ENCODING (coding))
5315 if (CODING_REQUIRE_FLUSHING (coding))
5317 /* But, before changing the coding, we must flush out data. */
5318 coding->mode |= CODING_MODE_LAST_BLOCK;
5319 send_process (proc, "", 0, Qt);
5320 coding->mode &= CODING_MODE_LAST_BLOCK;
5322 setup_coding_system (raw_text_coding_system
5323 (Vlast_coding_system_used),
5324 coding);
5325 coding->src_multibyte = 0;
5328 coding->dst_multibyte = 0;
5330 if (CODING_REQUIRE_ENCODING (coding))
5332 coding->dst_object = Qt;
5333 if (BUFFERP (object))
5335 EMACS_INT from_byte, from, to;
5336 EMACS_INT save_pt, save_pt_byte;
5337 struct buffer *cur = current_buffer;
5339 set_buffer_internal (XBUFFER (object));
5340 save_pt = PT, save_pt_byte = PT_BYTE;
5342 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5343 from = BYTE_TO_CHAR (from_byte);
5344 to = BYTE_TO_CHAR (from_byte + len);
5345 TEMP_SET_PT_BOTH (from, from_byte);
5346 encode_coding_object (coding, object, from, from_byte,
5347 to, from_byte + len, Qt);
5348 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5349 set_buffer_internal (cur);
5351 else if (STRINGP (object))
5353 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5354 SBYTES (object), Qt);
5356 else
5358 coding->dst_object = make_unibyte_string (buf, len);
5359 coding->produced = len;
5362 len = coding->produced;
5363 object = coding->dst_object;
5364 buf = SSDATA (object);
5367 if (pty_max_bytes == 0)
5369 #if defined (HAVE_FPATHCONF) && defined (_PC_MAX_CANON)
5370 pty_max_bytes = fpathconf (p->outfd, _PC_MAX_CANON);
5371 if (pty_max_bytes < 0)
5372 pty_max_bytes = 250;
5373 #else
5374 pty_max_bytes = 250;
5375 #endif
5376 /* Deduct one, to leave space for the eof. */
5377 pty_max_bytes--;
5380 /* 2000-09-21: Emacs 20.7, sparc-sun-solaris-2.6, GCC 2.95.2,
5381 CFLAGS="-g -O": The value of the parameter `proc' is clobbered
5382 when returning with longjmp despite being declared volatile. */
5383 if (!setjmp (send_process_frame))
5385 p = XPROCESS (proc); /* Repair any setjmp clobbering. */
5387 process_sent_to = proc;
5388 while (len > 0)
5390 EMACS_INT this = len;
5392 /* Send this batch, using one or more write calls. */
5393 while (this > 0)
5395 EMACS_INT written = 0;
5396 int outfd = p->outfd;
5397 old_sigpipe = (void (*) (int)) signal (SIGPIPE, send_process_trap);
5398 #ifdef DATAGRAM_SOCKETS
5399 if (DATAGRAM_CHAN_P (outfd))
5401 rv = sendto (outfd, buf, this,
5402 0, datagram_address[outfd].sa,
5403 datagram_address[outfd].len);
5404 if (0 <= rv)
5405 written = rv;
5406 else if (errno == EMSGSIZE)
5408 signal (SIGPIPE, old_sigpipe);
5409 report_file_error ("sending datagram",
5410 Fcons (proc, Qnil));
5413 else
5414 #endif
5416 #ifdef HAVE_GNUTLS
5417 if (XPROCESS (proc)->gnutls_p)
5418 written = emacs_gnutls_write (XPROCESS (proc),
5419 buf, this);
5420 else
5421 #endif
5422 written = emacs_write (outfd, buf, this);
5423 rv = (written ? 0 : -1);
5424 #ifdef ADAPTIVE_READ_BUFFERING
5425 if (p->read_output_delay > 0
5426 && p->adaptive_read_buffering == 1)
5428 p->read_output_delay = 0;
5429 process_output_delay_count--;
5430 p->read_output_skip = 0;
5432 #endif
5434 signal (SIGPIPE, old_sigpipe);
5436 if (rv < 0)
5438 if (0
5439 #ifdef EWOULDBLOCK
5440 || errno == EWOULDBLOCK
5441 #endif
5442 #ifdef EAGAIN
5443 || errno == EAGAIN
5444 #endif
5446 /* Buffer is full. Wait, accepting input;
5447 that may allow the program
5448 to finish doing output and read more. */
5450 EMACS_INT offset = 0;
5452 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5453 /* A gross hack to work around a bug in FreeBSD.
5454 In the following sequence, read(2) returns
5455 bogus data:
5457 write(2) 1022 bytes
5458 write(2) 954 bytes, get EAGAIN
5459 read(2) 1024 bytes in process_read_output
5460 read(2) 11 bytes in process_read_output
5462 That is, read(2) returns more bytes than have
5463 ever been written successfully. The 1033 bytes
5464 read are the 1022 bytes written successfully
5465 after processing (for example with CRs added if
5466 the terminal is set up that way which it is
5467 here). The same bytes will be seen again in a
5468 later read(2), without the CRs. */
5470 if (errno == EAGAIN)
5472 int flags = FWRITE;
5473 ioctl (p->outfd, TIOCFLUSH, &flags);
5475 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5477 /* Running filters might relocate buffers or strings.
5478 Arrange to relocate BUF. */
5479 if (BUFFERP (object))
5480 offset = BUF_PTR_BYTE_POS (XBUFFER (object),
5481 (unsigned char *) buf);
5482 else if (STRINGP (object))
5483 offset = buf - SSDATA (object);
5485 #ifdef EMACS_HAS_USECS
5486 wait_reading_process_output (0, 20000, 0, 0, Qnil, NULL, 0);
5487 #else
5488 wait_reading_process_output (1, 0, 0, 0, Qnil, NULL, 0);
5489 #endif
5491 if (BUFFERP (object))
5492 buf = (char *) BUF_BYTE_ADDRESS (XBUFFER (object),
5493 offset);
5494 else if (STRINGP (object))
5495 buf = offset + SSDATA (object);
5497 else
5498 /* This is a real error. */
5499 report_file_error ("writing to process", Fcons (proc, Qnil));
5501 buf += written;
5502 len -= written;
5503 this -= written;
5507 else
5509 signal (SIGPIPE, old_sigpipe);
5510 proc = process_sent_to;
5511 p = XPROCESS (proc);
5512 p->raw_status_new = 0;
5513 p->status = Fcons (Qexit, Fcons (make_number (256), Qnil));
5514 p->tick = ++process_tick;
5515 deactivate_process (proc);
5516 error ("SIGPIPE raised on process %s; closed it", SDATA (p->name));
5519 UNGCPRO;
5522 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5523 3, 3, 0,
5524 doc: /* Send current contents of region as input to PROCESS.
5525 PROCESS may be a process, a buffer, the name of a process or buffer, or
5526 nil, indicating the current buffer's process.
5527 Called from program, takes three arguments, PROCESS, START and END.
5528 If the region is more than 500 characters long,
5529 it is sent in several bunches. This may happen even for shorter regions.
5530 Output from processes can arrive in between bunches. */)
5531 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5533 Lisp_Object proc;
5534 EMACS_INT start1, end1;
5536 proc = get_process (process);
5537 validate_region (&start, &end);
5539 if (XINT (start) < GPT && XINT (end) > GPT)
5540 move_gap (XINT (start));
5542 start1 = CHAR_TO_BYTE (XINT (start));
5543 end1 = CHAR_TO_BYTE (XINT (end));
5544 send_process (proc, (char *) BYTE_POS_ADDR (start1), end1 - start1,
5545 Fcurrent_buffer ());
5547 return Qnil;
5550 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5551 2, 2, 0,
5552 doc: /* Send PROCESS the contents of STRING as input.
5553 PROCESS may be a process, a buffer, the name of a process or buffer, or
5554 nil, indicating the current buffer's process.
5555 If STRING is more than 500 characters long,
5556 it is sent in several bunches. This may happen even for shorter strings.
5557 Output from processes can arrive in between bunches. */)
5558 (Lisp_Object process, Lisp_Object string)
5560 Lisp_Object proc;
5561 CHECK_STRING (string);
5562 proc = get_process (process);
5563 send_process (proc, SSDATA (string),
5564 SBYTES (string), string);
5565 return Qnil;
5568 /* Return the foreground process group for the tty/pty that
5569 the process P uses. */
5570 static int
5571 emacs_get_tty_pgrp (struct Lisp_Process *p)
5573 int gid = -1;
5575 #ifdef TIOCGPGRP
5576 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5578 int fd;
5579 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5580 master side. Try the slave side. */
5581 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5583 if (fd != -1)
5585 ioctl (fd, TIOCGPGRP, &gid);
5586 emacs_close (fd);
5589 #endif /* defined (TIOCGPGRP ) */
5591 return gid;
5594 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5595 Sprocess_running_child_p, 0, 1, 0,
5596 doc: /* Return t if PROCESS has given the terminal to a child.
5597 If the operating system does not make it possible to find out,
5598 return t unconditionally. */)
5599 (Lisp_Object process)
5601 /* Initialize in case ioctl doesn't exist or gives an error,
5602 in a way that will cause returning t. */
5603 int gid;
5604 Lisp_Object proc;
5605 struct Lisp_Process *p;
5607 proc = get_process (process);
5608 p = XPROCESS (proc);
5610 if (!EQ (p->type, Qreal))
5611 error ("Process %s is not a subprocess",
5612 SDATA (p->name));
5613 if (p->infd < 0)
5614 error ("Process %s is not active",
5615 SDATA (p->name));
5617 gid = emacs_get_tty_pgrp (p);
5619 if (gid == p->pid)
5620 return Qnil;
5621 return Qt;
5624 /* send a signal number SIGNO to PROCESS.
5625 If CURRENT_GROUP is t, that means send to the process group
5626 that currently owns the terminal being used to communicate with PROCESS.
5627 This is used for various commands in shell mode.
5628 If CURRENT_GROUP is lambda, that means send to the process group
5629 that currently owns the terminal, but only if it is NOT the shell itself.
5631 If NOMSG is zero, insert signal-announcements into process's buffers
5632 right away.
5634 If we can, we try to signal PROCESS by sending control characters
5635 down the pty. This allows us to signal inferiors who have changed
5636 their uid, for which killpg would return an EPERM error. */
5638 static void
5639 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5640 int nomsg)
5642 Lisp_Object proc;
5643 register struct Lisp_Process *p;
5644 int gid;
5645 int no_pgrp = 0;
5647 proc = get_process (process);
5648 p = XPROCESS (proc);
5650 if (!EQ (p->type, Qreal))
5651 error ("Process %s is not a subprocess",
5652 SDATA (p->name));
5653 if (p->infd < 0)
5654 error ("Process %s is not active",
5655 SDATA (p->name));
5657 if (!p->pty_flag)
5658 current_group = Qnil;
5660 /* If we are using pgrps, get a pgrp number and make it negative. */
5661 if (NILP (current_group))
5662 /* Send the signal to the shell's process group. */
5663 gid = p->pid;
5664 else
5666 #ifdef SIGNALS_VIA_CHARACTERS
5667 /* If possible, send signals to the entire pgrp
5668 by sending an input character to it. */
5670 struct termios t;
5671 cc_t *sig_char = NULL;
5673 tcgetattr (p->infd, &t);
5675 switch (signo)
5677 case SIGINT:
5678 sig_char = &t.c_cc[VINTR];
5679 break;
5681 case SIGQUIT:
5682 sig_char = &t.c_cc[VQUIT];
5683 break;
5685 case SIGTSTP:
5686 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5687 sig_char = &t.c_cc[VSWTCH];
5688 #else
5689 sig_char = &t.c_cc[VSUSP];
5690 #endif
5691 break;
5694 if (sig_char && *sig_char != CDISABLE)
5696 send_process (proc, (char *) sig_char, 1, Qnil);
5697 return;
5699 /* If we can't send the signal with a character,
5700 fall through and send it another way. */
5702 /* The code above may fall through if it can't
5703 handle the signal. */
5704 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5706 #ifdef TIOCGPGRP
5707 /* Get the current pgrp using the tty itself, if we have that.
5708 Otherwise, use the pty to get the pgrp.
5709 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5710 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5711 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5712 His patch indicates that if TIOCGPGRP returns an error, then
5713 we should just assume that p->pid is also the process group id. */
5715 gid = emacs_get_tty_pgrp (p);
5717 if (gid == -1)
5718 /* If we can't get the information, assume
5719 the shell owns the tty. */
5720 gid = p->pid;
5722 /* It is not clear whether anything really can set GID to -1.
5723 Perhaps on some system one of those ioctls can or could do so.
5724 Or perhaps this is vestigial. */
5725 if (gid == -1)
5726 no_pgrp = 1;
5727 #else /* ! defined (TIOCGPGRP ) */
5728 /* Can't select pgrps on this system, so we know that
5729 the child itself heads the pgrp. */
5730 gid = p->pid;
5731 #endif /* ! defined (TIOCGPGRP ) */
5733 /* If current_group is lambda, and the shell owns the terminal,
5734 don't send any signal. */
5735 if (EQ (current_group, Qlambda) && gid == p->pid)
5736 return;
5739 switch (signo)
5741 #ifdef SIGCONT
5742 case SIGCONT:
5743 p->raw_status_new = 0;
5744 p->status = Qrun;
5745 p->tick = ++process_tick;
5746 if (!nomsg)
5748 status_notify (NULL);
5749 redisplay_preserve_echo_area (13);
5751 break;
5752 #endif /* ! defined (SIGCONT) */
5753 case SIGINT:
5754 case SIGQUIT:
5755 case SIGKILL:
5756 flush_pending_output (p->infd);
5757 break;
5760 /* If we don't have process groups, send the signal to the immediate
5761 subprocess. That isn't really right, but it's better than any
5762 obvious alternative. */
5763 if (no_pgrp)
5765 kill (p->pid, signo);
5766 return;
5769 /* gid may be a pid, or minus a pgrp's number */
5770 #ifdef TIOCSIGSEND
5771 if (!NILP (current_group))
5773 if (ioctl (p->infd, TIOCSIGSEND, signo) == -1)
5774 EMACS_KILLPG (gid, signo);
5776 else
5778 gid = - p->pid;
5779 kill (gid, signo);
5781 #else /* ! defined (TIOCSIGSEND) */
5782 EMACS_KILLPG (gid, signo);
5783 #endif /* ! defined (TIOCSIGSEND) */
5786 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5787 doc: /* Interrupt process PROCESS.
5788 PROCESS may be a process, a buffer, or the name of a process or buffer.
5789 No arg or nil means current buffer's process.
5790 Second arg CURRENT-GROUP non-nil means send signal to
5791 the current process-group of the process's controlling terminal
5792 rather than to the process's own process group.
5793 If the process is a shell, this means interrupt current subjob
5794 rather than the shell.
5796 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5797 don't send the signal. */)
5798 (Lisp_Object process, Lisp_Object current_group)
5800 process_send_signal (process, SIGINT, current_group, 0);
5801 return process;
5804 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5805 doc: /* Kill process PROCESS. May be process or name of one.
5806 See function `interrupt-process' for more details on usage. */)
5807 (Lisp_Object process, Lisp_Object current_group)
5809 process_send_signal (process, SIGKILL, current_group, 0);
5810 return process;
5813 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5814 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5815 See function `interrupt-process' for more details on usage. */)
5816 (Lisp_Object process, Lisp_Object current_group)
5818 process_send_signal (process, SIGQUIT, current_group, 0);
5819 return process;
5822 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
5823 doc: /* Stop process PROCESS. May be process or name of one.
5824 See function `interrupt-process' for more details on usage.
5825 If PROCESS is a network or serial process, inhibit handling of incoming
5826 traffic. */)
5827 (Lisp_Object process, Lisp_Object current_group)
5829 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5831 struct Lisp_Process *p;
5833 p = XPROCESS (process);
5834 if (NILP (p->command)
5835 && p->infd >= 0)
5837 FD_CLR (p->infd, &input_wait_mask);
5838 FD_CLR (p->infd, &non_keyboard_wait_mask);
5840 p->command = Qt;
5841 return process;
5843 #ifndef SIGTSTP
5844 error ("No SIGTSTP support");
5845 #else
5846 process_send_signal (process, SIGTSTP, current_group, 0);
5847 #endif
5848 return process;
5851 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
5852 doc: /* Continue process PROCESS. May be process or name of one.
5853 See function `interrupt-process' for more details on usage.
5854 If PROCESS is a network or serial process, resume handling of incoming
5855 traffic. */)
5856 (Lisp_Object process, Lisp_Object current_group)
5858 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5860 struct Lisp_Process *p;
5862 p = XPROCESS (process);
5863 if (EQ (p->command, Qt)
5864 && p->infd >= 0
5865 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
5867 FD_SET (p->infd, &input_wait_mask);
5868 FD_SET (p->infd, &non_keyboard_wait_mask);
5869 #ifdef WINDOWSNT
5870 if (fd_info[ p->infd ].flags & FILE_SERIAL)
5871 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
5872 #else /* not WINDOWSNT */
5873 tcflush (p->infd, TCIFLUSH);
5874 #endif /* not WINDOWSNT */
5876 p->command = Qnil;
5877 return process;
5879 #ifdef SIGCONT
5880 process_send_signal (process, SIGCONT, current_group, 0);
5881 #else
5882 error ("No SIGCONT support");
5883 #endif
5884 return process;
5887 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
5888 2, 2, "sProcess (name or number): \nnSignal code: ",
5889 doc: /* Send PROCESS the signal with code SIGCODE.
5890 PROCESS may also be a number specifying the process id of the
5891 process to signal; in this case, the process need not be a child of
5892 this Emacs.
5893 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
5894 (Lisp_Object process, Lisp_Object sigcode)
5896 pid_t pid;
5898 if (INTEGERP (process))
5900 pid = XINT (process);
5901 goto got_it;
5904 if (FLOATP (process))
5906 pid = (pid_t) XFLOAT_DATA (process);
5907 goto got_it;
5910 if (STRINGP (process))
5912 Lisp_Object tem;
5913 if (tem = Fget_process (process), NILP (tem))
5915 pid = XINT (Fstring_to_number (process, make_number (10)));
5916 if (pid > 0)
5917 goto got_it;
5919 process = tem;
5921 else
5922 process = get_process (process);
5924 if (NILP (process))
5925 return process;
5927 CHECK_PROCESS (process);
5928 pid = XPROCESS (process)->pid;
5929 if (pid <= 0)
5930 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
5932 got_it:
5934 #define parse_signal(NAME, VALUE) \
5935 else if (!xstrcasecmp (name, NAME)) \
5936 XSETINT (sigcode, VALUE)
5938 if (INTEGERP (sigcode))
5940 else
5942 char *name;
5944 CHECK_SYMBOL (sigcode);
5945 name = SSDATA (SYMBOL_NAME (sigcode));
5947 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
5948 name += 3;
5950 if (0)
5952 #ifdef SIGUSR1
5953 parse_signal ("usr1", SIGUSR1);
5954 #endif
5955 #ifdef SIGUSR2
5956 parse_signal ("usr2", SIGUSR2);
5957 #endif
5958 #ifdef SIGTERM
5959 parse_signal ("term", SIGTERM);
5960 #endif
5961 #ifdef SIGHUP
5962 parse_signal ("hup", SIGHUP);
5963 #endif
5964 #ifdef SIGINT
5965 parse_signal ("int", SIGINT);
5966 #endif
5967 #ifdef SIGQUIT
5968 parse_signal ("quit", SIGQUIT);
5969 #endif
5970 #ifdef SIGILL
5971 parse_signal ("ill", SIGILL);
5972 #endif
5973 #ifdef SIGABRT
5974 parse_signal ("abrt", SIGABRT);
5975 #endif
5976 #ifdef SIGEMT
5977 parse_signal ("emt", SIGEMT);
5978 #endif
5979 #ifdef SIGKILL
5980 parse_signal ("kill", SIGKILL);
5981 #endif
5982 #ifdef SIGFPE
5983 parse_signal ("fpe", SIGFPE);
5984 #endif
5985 #ifdef SIGBUS
5986 parse_signal ("bus", SIGBUS);
5987 #endif
5988 #ifdef SIGSEGV
5989 parse_signal ("segv", SIGSEGV);
5990 #endif
5991 #ifdef SIGSYS
5992 parse_signal ("sys", SIGSYS);
5993 #endif
5994 #ifdef SIGPIPE
5995 parse_signal ("pipe", SIGPIPE);
5996 #endif
5997 #ifdef SIGALRM
5998 parse_signal ("alrm", SIGALRM);
5999 #endif
6000 #ifdef SIGURG
6001 parse_signal ("urg", SIGURG);
6002 #endif
6003 #ifdef SIGSTOP
6004 parse_signal ("stop", SIGSTOP);
6005 #endif
6006 #ifdef SIGTSTP
6007 parse_signal ("tstp", SIGTSTP);
6008 #endif
6009 #ifdef SIGCONT
6010 parse_signal ("cont", SIGCONT);
6011 #endif
6012 #ifdef SIGCHLD
6013 parse_signal ("chld", SIGCHLD);
6014 #endif
6015 #ifdef SIGTTIN
6016 parse_signal ("ttin", SIGTTIN);
6017 #endif
6018 #ifdef SIGTTOU
6019 parse_signal ("ttou", SIGTTOU);
6020 #endif
6021 #ifdef SIGIO
6022 parse_signal ("io", SIGIO);
6023 #endif
6024 #ifdef SIGXCPU
6025 parse_signal ("xcpu", SIGXCPU);
6026 #endif
6027 #ifdef SIGXFSZ
6028 parse_signal ("xfsz", SIGXFSZ);
6029 #endif
6030 #ifdef SIGVTALRM
6031 parse_signal ("vtalrm", SIGVTALRM);
6032 #endif
6033 #ifdef SIGPROF
6034 parse_signal ("prof", SIGPROF);
6035 #endif
6036 #ifdef SIGWINCH
6037 parse_signal ("winch", SIGWINCH);
6038 #endif
6039 #ifdef SIGINFO
6040 parse_signal ("info", SIGINFO);
6041 #endif
6042 else
6043 error ("Undefined signal name %s", name);
6046 #undef parse_signal
6048 return make_number (kill (pid, XINT (sigcode)));
6051 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6052 doc: /* Make PROCESS see end-of-file in its input.
6053 EOF comes after any text already sent to it.
6054 PROCESS may be a process, a buffer, the name of a process or buffer, or
6055 nil, indicating the current buffer's process.
6056 If PROCESS is a network connection, or is a process communicating
6057 through a pipe (as opposed to a pty), then you cannot send any more
6058 text to PROCESS after you call this function.
6059 If PROCESS is a serial process, wait until all output written to the
6060 process has been transmitted to the serial port. */)
6061 (Lisp_Object process)
6063 Lisp_Object proc;
6064 struct coding_system *coding;
6066 if (DATAGRAM_CONN_P (process))
6067 return process;
6069 proc = get_process (process);
6070 coding = proc_encode_coding_system[XPROCESS (proc)->outfd];
6072 /* Make sure the process is really alive. */
6073 if (XPROCESS (proc)->raw_status_new)
6074 update_status (XPROCESS (proc));
6075 if (! EQ (XPROCESS (proc)->status, Qrun))
6076 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6078 if (CODING_REQUIRE_FLUSHING (coding))
6080 coding->mode |= CODING_MODE_LAST_BLOCK;
6081 send_process (proc, "", 0, Qnil);
6084 if (XPROCESS (proc)->pty_flag)
6085 send_process (proc, "\004", 1, Qnil);
6086 else if (EQ (XPROCESS (proc)->type, Qserial))
6088 #ifndef WINDOWSNT
6089 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6090 error ("tcdrain() failed: %s", emacs_strerror (errno));
6091 #endif /* not WINDOWSNT */
6092 /* Do nothing on Windows because writes are blocking. */
6094 else
6096 int old_outfd, new_outfd;
6098 #ifdef HAVE_SHUTDOWN
6099 /* If this is a network connection, or socketpair is used
6100 for communication with the subprocess, call shutdown to cause EOF.
6101 (In some old system, shutdown to socketpair doesn't work.
6102 Then we just can't win.) */
6103 if (EQ (XPROCESS (proc)->type, Qnetwork)
6104 || XPROCESS (proc)->outfd == XPROCESS (proc)->infd)
6105 shutdown (XPROCESS (proc)->outfd, 1);
6106 /* In case of socketpair, outfd == infd, so don't close it. */
6107 if (XPROCESS (proc)->outfd != XPROCESS (proc)->infd)
6108 emacs_close (XPROCESS (proc)->outfd);
6109 #else /* not HAVE_SHUTDOWN */
6110 emacs_close (XPROCESS (proc)->outfd);
6111 #endif /* not HAVE_SHUTDOWN */
6112 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6113 if (new_outfd < 0)
6114 abort ();
6115 old_outfd = XPROCESS (proc)->outfd;
6117 if (!proc_encode_coding_system[new_outfd])
6118 proc_encode_coding_system[new_outfd]
6119 = (struct coding_system *) xmalloc (sizeof (struct coding_system));
6120 memcpy (proc_encode_coding_system[new_outfd],
6121 proc_encode_coding_system[old_outfd],
6122 sizeof (struct coding_system));
6123 memset (proc_encode_coding_system[old_outfd], 0,
6124 sizeof (struct coding_system));
6126 XPROCESS (proc)->outfd = new_outfd;
6128 return process;
6131 /* On receipt of a signal that a child status has changed, loop asking
6132 about children with changed statuses until the system says there
6133 are no more.
6135 All we do is change the status; we do not run sentinels or print
6136 notifications. That is saved for the next time keyboard input is
6137 done, in order to avoid timing errors.
6139 ** WARNING: this can be called during garbage collection.
6140 Therefore, it must not be fooled by the presence of mark bits in
6141 Lisp objects.
6143 ** USG WARNING: Although it is not obvious from the documentation
6144 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6145 signal() before executing at least one wait(), otherwise the
6146 handler will be called again, resulting in an infinite loop. The
6147 relevant portion of the documentation reads "SIGCLD signals will be
6148 queued and the signal-catching function will be continually
6149 reentered until the queue is empty". Invoking signal() causes the
6150 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6151 Inc.
6153 ** Malloc WARNING: This should never call malloc either directly or
6154 indirectly; if it does, that is a bug */
6156 #ifdef SIGCHLD
6157 static void
6158 sigchld_handler (int signo)
6160 int old_errno = errno;
6161 Lisp_Object proc;
6162 struct Lisp_Process *p;
6164 SIGNAL_THREAD_CHECK (signo);
6166 while (1)
6168 pid_t pid;
6169 int w;
6170 Lisp_Object tail;
6172 #ifdef WNOHANG
6173 #ifndef WUNTRACED
6174 #define WUNTRACED 0
6175 #endif /* no WUNTRACED */
6176 /* Keep trying to get a status until we get a definitive result. */
6179 errno = 0;
6180 pid = wait3 (&w, WNOHANG | WUNTRACED, 0);
6182 while (pid < 0 && errno == EINTR);
6184 if (pid <= 0)
6186 /* PID == 0 means no processes found, PID == -1 means a real
6187 failure. We have done all our job, so return. */
6189 errno = old_errno;
6190 return;
6192 #else
6193 pid = wait (&w);
6194 #endif /* no WNOHANG */
6196 /* Find the process that signaled us, and record its status. */
6198 /* The process can have been deleted by Fdelete_process. */
6199 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6201 Lisp_Object xpid = XCAR (tail);
6202 if ((INTEGERP (xpid) && pid == (pid_t) XINT (xpid))
6203 || (FLOATP (xpid) && pid == (pid_t) XFLOAT_DATA (xpid)))
6205 XSETCAR (tail, Qnil);
6206 goto sigchld_end_of_loop;
6210 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6211 p = 0;
6212 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6214 proc = XCDR (XCAR (tail));
6215 p = XPROCESS (proc);
6216 if (EQ (p->type, Qreal) && p->pid == pid)
6217 break;
6218 p = 0;
6221 /* Look for an asynchronous process whose pid hasn't been filled
6222 in yet. */
6223 if (p == 0)
6224 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6226 proc = XCDR (XCAR (tail));
6227 p = XPROCESS (proc);
6228 if (p->pid == -1)
6229 break;
6230 p = 0;
6233 /* Change the status of the process that was found. */
6234 if (p != 0)
6236 int clear_desc_flag = 0;
6238 p->tick = ++process_tick;
6239 p->raw_status = w;
6240 p->raw_status_new = 1;
6242 /* If process has terminated, stop waiting for its output. */
6243 if ((WIFSIGNALED (w) || WIFEXITED (w))
6244 && p->infd >= 0)
6245 clear_desc_flag = 1;
6247 /* We use clear_desc_flag to avoid a compiler bug in Microsoft C. */
6248 if (clear_desc_flag)
6250 FD_CLR (p->infd, &input_wait_mask);
6251 FD_CLR (p->infd, &non_keyboard_wait_mask);
6254 /* Tell wait_reading_process_output that it needs to wake up and
6255 look around. */
6256 if (input_available_clear_time)
6257 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
6260 /* There was no asynchronous process found for that pid: we have
6261 a synchronous process. */
6262 else
6264 synch_process_alive = 0;
6266 /* Report the status of the synchronous process. */
6267 if (WIFEXITED (w))
6268 synch_process_retcode = WRETCODE (w);
6269 else if (WIFSIGNALED (w))
6270 synch_process_termsig = WTERMSIG (w);
6272 /* Tell wait_reading_process_output that it needs to wake up and
6273 look around. */
6274 if (input_available_clear_time)
6275 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
6278 sigchld_end_of_loop:
6281 /* On some systems, we must return right away.
6282 If any more processes want to signal us, we will
6283 get another signal.
6284 Otherwise (on systems that have WNOHANG), loop around
6285 to use up all the processes that have something to tell us. */
6286 #if (defined WINDOWSNT \
6287 || (defined USG && !defined GNU_LINUX \
6288 && !(defined HPUX && defined WNOHANG)))
6289 errno = old_errno;
6290 return;
6291 #endif /* USG, but not HPUX with WNOHANG */
6294 #endif /* SIGCHLD */
6297 static Lisp_Object
6298 exec_sentinel_unwind (Lisp_Object data)
6300 XPROCESS (XCAR (data))->sentinel = XCDR (data);
6301 return Qnil;
6304 static Lisp_Object
6305 exec_sentinel_error_handler (Lisp_Object error_val)
6307 cmd_error_internal (error_val, "error in process sentinel: ");
6308 Vinhibit_quit = Qt;
6309 update_echo_area ();
6310 Fsleep_for (make_number (2), Qnil);
6311 return Qt;
6314 static void
6315 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6317 Lisp_Object sentinel, odeactivate;
6318 register struct Lisp_Process *p = XPROCESS (proc);
6319 int count = SPECPDL_INDEX ();
6320 int outer_running_asynch_code = running_asynch_code;
6321 int waiting = waiting_for_user_input_p;
6323 if (inhibit_sentinels)
6324 return;
6326 /* No need to gcpro these, because all we do with them later
6327 is test them for EQness, and none of them should be a string. */
6328 odeactivate = Vdeactivate_mark;
6329 #if 0
6330 Lisp_Object obuffer, okeymap;
6331 XSETBUFFER (obuffer, current_buffer);
6332 okeymap = BVAR (current_buffer, keymap);
6333 #endif
6335 /* There's no good reason to let sentinels change the current
6336 buffer, and many callers of accept-process-output, sit-for, and
6337 friends don't expect current-buffer to be changed from under them. */
6338 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
6340 sentinel = p->sentinel;
6341 if (NILP (sentinel))
6342 return;
6344 /* Zilch the sentinel while it's running, to avoid recursive invocations;
6345 assure that it gets restored no matter how the sentinel exits. */
6346 p->sentinel = Qnil;
6347 record_unwind_protect (exec_sentinel_unwind, Fcons (proc, sentinel));
6348 /* Inhibit quit so that random quits don't screw up a running filter. */
6349 specbind (Qinhibit_quit, Qt);
6350 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6352 /* In case we get recursively called,
6353 and we already saved the match data nonrecursively,
6354 save the same match data in safely recursive fashion. */
6355 if (outer_running_asynch_code)
6357 Lisp_Object tem;
6358 tem = Fmatch_data (Qnil, Qnil, Qnil);
6359 restore_search_regs ();
6360 record_unwind_save_match_data ();
6361 Fset_match_data (tem, Qt);
6364 /* For speed, if a search happens within this code,
6365 save the match data in a special nonrecursive fashion. */
6366 running_asynch_code = 1;
6368 internal_condition_case_1 (read_process_output_call,
6369 Fcons (sentinel,
6370 Fcons (proc, Fcons (reason, Qnil))),
6371 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6372 exec_sentinel_error_handler);
6374 /* If we saved the match data nonrecursively, restore it now. */
6375 restore_search_regs ();
6376 running_asynch_code = outer_running_asynch_code;
6378 Vdeactivate_mark = odeactivate;
6380 /* Restore waiting_for_user_input_p as it was
6381 when we were called, in case the filter clobbered it. */
6382 waiting_for_user_input_p = waiting;
6384 #if 0
6385 if (! EQ (Fcurrent_buffer (), obuffer)
6386 || ! EQ (current_buffer->keymap, okeymap))
6387 #endif
6388 /* But do it only if the caller is actually going to read events.
6389 Otherwise there's no need to make him wake up, and it could
6390 cause trouble (for example it would make sit_for return). */
6391 if (waiting_for_user_input_p == -1)
6392 record_asynch_buffer_change ();
6394 unbind_to (count, Qnil);
6397 /* Report all recent events of a change in process status
6398 (either run the sentinel or output a message).
6399 This is usually done while Emacs is waiting for keyboard input
6400 but can be done at other times. */
6402 static void
6403 status_notify (struct Lisp_Process *deleting_process)
6405 register Lisp_Object proc, buffer;
6406 Lisp_Object tail, msg;
6407 struct gcpro gcpro1, gcpro2;
6409 tail = Qnil;
6410 msg = Qnil;
6411 /* We need to gcpro tail; if read_process_output calls a filter
6412 which deletes a process and removes the cons to which tail points
6413 from Vprocess_alist, and then causes a GC, tail is an unprotected
6414 reference. */
6415 GCPRO2 (tail, msg);
6417 /* Set this now, so that if new processes are created by sentinels
6418 that we run, we get called again to handle their status changes. */
6419 update_tick = process_tick;
6421 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6423 Lisp_Object symbol;
6424 register struct Lisp_Process *p;
6426 proc = Fcdr (XCAR (tail));
6427 p = XPROCESS (proc);
6429 if (p->tick != p->update_tick)
6431 p->update_tick = p->tick;
6433 /* If process is still active, read any output that remains. */
6434 while (! EQ (p->filter, Qt)
6435 && ! EQ (p->status, Qconnect)
6436 && ! EQ (p->status, Qlisten)
6437 /* Network or serial process not stopped: */
6438 && ! EQ (p->command, Qt)
6439 && p->infd >= 0
6440 && p != deleting_process
6441 && read_process_output (proc, p->infd) > 0);
6443 buffer = p->buffer;
6445 /* Get the text to use for the message. */
6446 if (p->raw_status_new)
6447 update_status (p);
6448 msg = status_message (p);
6450 /* If process is terminated, deactivate it or delete it. */
6451 symbol = p->status;
6452 if (CONSP (p->status))
6453 symbol = XCAR (p->status);
6455 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6456 || EQ (symbol, Qclosed))
6458 if (delete_exited_processes)
6459 remove_process (proc);
6460 else
6461 deactivate_process (proc);
6464 /* The actions above may have further incremented p->tick.
6465 So set p->update_tick again
6466 so that an error in the sentinel will not cause
6467 this code to be run again. */
6468 p->update_tick = p->tick;
6469 /* Now output the message suitably. */
6470 if (!NILP (p->sentinel))
6471 exec_sentinel (proc, msg);
6472 /* Don't bother with a message in the buffer
6473 when a process becomes runnable. */
6474 else if (!EQ (symbol, Qrun) && !NILP (buffer))
6476 Lisp_Object tem;
6477 struct buffer *old = current_buffer;
6478 EMACS_INT opoint, opoint_byte;
6479 EMACS_INT before, before_byte;
6481 /* Avoid error if buffer is deleted
6482 (probably that's why the process is dead, too) */
6483 if (NILP (BVAR (XBUFFER (buffer), name)))
6484 continue;
6485 Fset_buffer (buffer);
6487 opoint = PT;
6488 opoint_byte = PT_BYTE;
6489 /* Insert new output into buffer
6490 at the current end-of-output marker,
6491 thus preserving logical ordering of input and output. */
6492 if (XMARKER (p->mark)->buffer)
6493 Fgoto_char (p->mark);
6494 else
6495 SET_PT_BOTH (ZV, ZV_BYTE);
6497 before = PT;
6498 before_byte = PT_BYTE;
6500 tem = BVAR (current_buffer, read_only);
6501 BVAR (current_buffer, read_only) = Qnil;
6502 insert_string ("\nProcess ");
6503 Finsert (1, &p->name);
6504 insert_string (" ");
6505 Finsert (1, &msg);
6506 BVAR (current_buffer, read_only) = tem;
6507 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6509 if (opoint >= before)
6510 SET_PT_BOTH (opoint + (PT - before),
6511 opoint_byte + (PT_BYTE - before_byte));
6512 else
6513 SET_PT_BOTH (opoint, opoint_byte);
6515 set_buffer_internal (old);
6518 } /* end for */
6520 update_mode_lines++; /* in case buffers use %s in mode-line-format */
6521 UNGCPRO;
6525 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6526 Sset_process_coding_system, 1, 3, 0,
6527 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6528 DECODING will be used to decode subprocess output and ENCODING to
6529 encode subprocess input. */)
6530 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6532 register struct Lisp_Process *p;
6534 CHECK_PROCESS (process);
6535 p = XPROCESS (process);
6536 if (p->infd < 0)
6537 error ("Input file descriptor of %s closed", SDATA (p->name));
6538 if (p->outfd < 0)
6539 error ("Output file descriptor of %s closed", SDATA (p->name));
6540 Fcheck_coding_system (decoding);
6541 Fcheck_coding_system (encoding);
6542 encoding = coding_inherit_eol_type (encoding, Qnil);
6543 p->decode_coding_system = decoding;
6544 p->encode_coding_system = encoding;
6545 setup_process_coding_systems (process);
6547 return Qnil;
6550 DEFUN ("process-coding-system",
6551 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6552 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6553 (register Lisp_Object process)
6555 CHECK_PROCESS (process);
6556 return Fcons (XPROCESS (process)->decode_coding_system,
6557 XPROCESS (process)->encode_coding_system);
6560 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6561 Sset_process_filter_multibyte, 2, 2, 0,
6562 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6563 If FLAG is non-nil, the filter is given multibyte strings.
6564 If FLAG is nil, the filter is given unibyte strings. In this case,
6565 all character code conversion except for end-of-line conversion is
6566 suppressed. */)
6567 (Lisp_Object process, Lisp_Object flag)
6569 register struct Lisp_Process *p;
6571 CHECK_PROCESS (process);
6572 p = XPROCESS (process);
6573 if (NILP (flag))
6574 p->decode_coding_system = raw_text_coding_system (p->decode_coding_system);
6575 setup_process_coding_systems (process);
6577 return Qnil;
6580 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6581 Sprocess_filter_multibyte_p, 1, 1, 0,
6582 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6583 (Lisp_Object process)
6585 register struct Lisp_Process *p;
6586 struct coding_system *coding;
6588 CHECK_PROCESS (process);
6589 p = XPROCESS (process);
6590 coding = proc_decode_coding_system[p->infd];
6591 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6597 # ifdef HAVE_GPM
6599 void
6600 add_gpm_wait_descriptor (int desc)
6602 add_keyboard_wait_descriptor (desc);
6605 void
6606 delete_gpm_wait_descriptor (int desc)
6608 delete_keyboard_wait_descriptor (desc);
6611 # endif
6613 # ifdef SIGIO
6615 /* Return nonzero if *MASK has a bit set
6616 that corresponds to one of the keyboard input descriptors. */
6618 static int
6619 keyboard_bit_set (fd_set *mask)
6621 int fd;
6623 for (fd = 0; fd <= max_input_desc; fd++)
6624 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6625 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6626 return 1;
6628 return 0;
6630 # endif
6632 #else /* not subprocesses */
6634 /* Defined on msdos.c. */
6635 extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
6636 EMACS_TIME *);
6638 /* Implementation of wait_reading_process_output, assuming that there
6639 are no subprocesses. Used only by the MS-DOS build.
6641 Wait for timeout to elapse and/or keyboard input to be available.
6643 time_limit is:
6644 timeout in seconds, or
6645 zero for no limit, or
6646 -1 means gobble data immediately available but don't wait for any.
6648 read_kbd is a Lisp_Object:
6649 0 to ignore keyboard input, or
6650 1 to return when input is available, or
6651 -1 means caller will actually read the input, so don't throw to
6652 the quit handler.
6654 see full version for other parameters. We know that wait_proc will
6655 always be NULL, since `subprocesses' isn't defined.
6657 do_display != 0 means redisplay should be done to show subprocess
6658 output that arrives.
6660 Return true if we received input from any process. */
6663 wait_reading_process_output (int time_limit, int microsecs, int read_kbd,
6664 int do_display,
6665 Lisp_Object wait_for_cell,
6666 struct Lisp_Process *wait_proc, int just_wait_proc)
6668 register int nfds;
6669 EMACS_TIME end_time, timeout;
6670 SELECT_TYPE waitchannels;
6671 int xerrno;
6673 /* What does time_limit really mean? */
6674 if (time_limit || microsecs)
6676 EMACS_GET_TIME (end_time);
6677 EMACS_SET_SECS_USECS (timeout, time_limit, microsecs);
6678 EMACS_ADD_TIME (end_time, end_time, timeout);
6681 /* Turn off periodic alarms (in case they are in use)
6682 and then turn off any other atimers,
6683 because the select emulator uses alarms. */
6684 stop_polling ();
6685 turn_on_atimers (0);
6687 while (1)
6689 int timeout_reduced_for_timers = 0;
6691 /* If calling from keyboard input, do not quit
6692 since we want to return C-g as an input character.
6693 Otherwise, do pending quit if requested. */
6694 if (read_kbd >= 0)
6695 QUIT;
6697 /* Exit now if the cell we're waiting for became non-nil. */
6698 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6699 break;
6701 /* Compute time from now till when time limit is up */
6702 /* Exit if already run out */
6703 if (time_limit == -1)
6705 /* -1 specified for timeout means
6706 gobble output available now
6707 but don't wait at all. */
6709 EMACS_SET_SECS_USECS (timeout, 0, 0);
6711 else if (time_limit || microsecs)
6713 EMACS_GET_TIME (timeout);
6714 EMACS_SUB_TIME (timeout, end_time, timeout);
6715 if (EMACS_TIME_NEG_P (timeout))
6716 break;
6718 else
6720 EMACS_SET_SECS_USECS (timeout, 100000, 0);
6723 /* If our caller will not immediately handle keyboard events,
6724 run timer events directly.
6725 (Callers that will immediately read keyboard events
6726 call timer_delay on their own.) */
6727 if (NILP (wait_for_cell))
6729 EMACS_TIME timer_delay;
6733 int old_timers_run = timers_run;
6734 timer_delay = timer_check ();
6735 if (timers_run != old_timers_run && do_display)
6736 /* We must retry, since a timer may have requeued itself
6737 and that could alter the time delay. */
6738 redisplay_preserve_echo_area (14);
6739 else
6740 break;
6742 while (!detect_input_pending ());
6744 /* If there is unread keyboard input, also return. */
6745 if (read_kbd != 0
6746 && requeued_events_pending_p ())
6747 break;
6749 if (! EMACS_TIME_NEG_P (timer_delay) && time_limit != -1)
6751 EMACS_TIME difference;
6752 EMACS_SUB_TIME (difference, timer_delay, timeout);
6753 if (EMACS_TIME_NEG_P (difference))
6755 timeout = timer_delay;
6756 timeout_reduced_for_timers = 1;
6761 /* Cause C-g and alarm signals to take immediate action,
6762 and cause input available signals to zero out timeout. */
6763 if (read_kbd < 0)
6764 set_waiting_for_input (&timeout);
6766 /* Wait till there is something to do. */
6768 if (! read_kbd && NILP (wait_for_cell))
6769 FD_ZERO (&waitchannels);
6770 else
6771 FD_SET (0, &waitchannels);
6773 /* If a frame has been newly mapped and needs updating,
6774 reprocess its display stuff. */
6775 if (frame_garbaged && do_display)
6777 clear_waiting_for_input ();
6778 redisplay_preserve_echo_area (15);
6779 if (read_kbd < 0)
6780 set_waiting_for_input (&timeout);
6783 if (read_kbd && detect_input_pending ())
6785 nfds = 0;
6786 FD_ZERO (&waitchannels);
6788 else
6789 nfds = select (1, &waitchannels, (SELECT_TYPE *)0, (SELECT_TYPE *)0,
6790 &timeout);
6792 xerrno = errno;
6794 /* Make C-g and alarm signals set flags again */
6795 clear_waiting_for_input ();
6797 /* If we woke up due to SIGWINCH, actually change size now. */
6798 do_pending_window_change (0);
6800 if (time_limit && nfds == 0 && ! timeout_reduced_for_timers)
6801 /* We waited the full specified time, so return now. */
6802 break;
6804 if (nfds == -1)
6806 /* If the system call was interrupted, then go around the
6807 loop again. */
6808 if (xerrno == EINTR)
6809 FD_ZERO (&waitchannels);
6810 else
6811 error ("select error: %s", emacs_strerror (xerrno));
6814 /* Check for keyboard input */
6816 if (read_kbd
6817 && detect_input_pending_run_timers (do_display))
6819 swallow_events (do_display);
6820 if (detect_input_pending_run_timers (do_display))
6821 break;
6824 /* If there is unread keyboard input, also return. */
6825 if (read_kbd
6826 && requeued_events_pending_p ())
6827 break;
6829 /* If wait_for_cell. check for keyboard input
6830 but don't run any timers.
6831 ??? (It seems wrong to me to check for keyboard
6832 input at all when wait_for_cell, but the code
6833 has been this way since July 1994.
6834 Try changing this after version 19.31.) */
6835 if (! NILP (wait_for_cell)
6836 && detect_input_pending ())
6838 swallow_events (do_display);
6839 if (detect_input_pending ())
6840 break;
6843 /* Exit now if the cell we're waiting for became non-nil. */
6844 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6845 break;
6848 start_polling ();
6850 return 0;
6853 #endif /* not subprocesses */
6855 /* The following functions are needed even if async subprocesses are
6856 not supported. Some of them are no-op stubs in that case. */
6858 /* Add DESC to the set of keyboard input descriptors. */
6860 void
6861 add_keyboard_wait_descriptor (int desc)
6863 #ifdef subprocesses /* actually means "not MSDOS" */
6864 FD_SET (desc, &input_wait_mask);
6865 FD_SET (desc, &non_process_wait_mask);
6866 if (desc > max_input_desc)
6867 max_input_desc = desc;
6868 #endif
6871 /* From now on, do not expect DESC to give keyboard input. */
6873 void
6874 delete_keyboard_wait_descriptor (int desc)
6876 #ifdef subprocesses
6877 int fd;
6878 int lim = max_input_desc;
6880 FD_CLR (desc, &input_wait_mask);
6881 FD_CLR (desc, &non_process_wait_mask);
6883 if (desc == max_input_desc)
6884 for (fd = 0; fd < lim; fd++)
6885 if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
6886 max_input_desc = fd;
6887 #endif
6890 /* Setup coding systems of PROCESS. */
6892 void
6893 setup_process_coding_systems (Lisp_Object process)
6895 #ifdef subprocesses
6896 struct Lisp_Process *p = XPROCESS (process);
6897 int inch = p->infd;
6898 int outch = p->outfd;
6899 Lisp_Object coding_system;
6901 if (inch < 0 || outch < 0)
6902 return;
6904 if (!proc_decode_coding_system[inch])
6905 proc_decode_coding_system[inch]
6906 = (struct coding_system *) xmalloc (sizeof (struct coding_system));
6907 coding_system = p->decode_coding_system;
6908 if (! NILP (p->filter))
6910 else if (BUFFERP (p->buffer))
6912 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
6913 coding_system = raw_text_coding_system (coding_system);
6915 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
6917 if (!proc_encode_coding_system[outch])
6918 proc_encode_coding_system[outch]
6919 = (struct coding_system *) xmalloc (sizeof (struct coding_system));
6920 setup_coding_system (p->encode_coding_system,
6921 proc_encode_coding_system[outch]);
6922 #endif
6925 /* Close all descriptors currently in use for communication
6926 with subprocess. This is used in a newly-forked subprocess
6927 to get rid of irrelevant descriptors. */
6929 void
6930 close_process_descs (void)
6932 #ifndef DOS_NT
6933 int i;
6934 for (i = 0; i < MAXDESC; i++)
6936 Lisp_Object process;
6937 process = chan_process[i];
6938 if (!NILP (process))
6940 int in = XPROCESS (process)->infd;
6941 int out = XPROCESS (process)->outfd;
6942 if (in >= 0)
6943 emacs_close (in);
6944 if (out >= 0 && in != out)
6945 emacs_close (out);
6948 #endif
6951 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
6952 doc: /* Return the (or a) process associated with BUFFER.
6953 BUFFER may be a buffer or the name of one. */)
6954 (register Lisp_Object buffer)
6956 #ifdef subprocesses
6957 register Lisp_Object buf, tail, proc;
6959 if (NILP (buffer)) return Qnil;
6960 buf = Fget_buffer (buffer);
6961 if (NILP (buf)) return Qnil;
6963 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
6965 proc = Fcdr (XCAR (tail));
6966 if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
6967 return proc;
6969 #endif /* subprocesses */
6970 return Qnil;
6973 DEFUN ("process-inherit-coding-system-flag",
6974 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
6975 1, 1, 0,
6976 doc: /* Return the value of inherit-coding-system flag for PROCESS.
6977 If this flag is t, `buffer-file-coding-system' of the buffer
6978 associated with PROCESS will inherit the coding system used to decode
6979 the process output. */)
6980 (register Lisp_Object process)
6982 #ifdef subprocesses
6983 CHECK_PROCESS (process);
6984 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
6985 #else
6986 /* Ignore the argument and return the value of
6987 inherit-process-coding-system. */
6988 return inherit_process_coding_system ? Qt : Qnil;
6989 #endif
6992 /* Kill all processes associated with `buffer'.
6993 If `buffer' is nil, kill all processes */
6995 void
6996 kill_buffer_processes (Lisp_Object buffer)
6998 #ifdef subprocesses
6999 Lisp_Object tail, proc;
7001 for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
7003 proc = XCDR (XCAR (tail));
7004 if (PROCESSP (proc)
7005 && (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer)))
7007 if (NETCONN_P (proc) || SERIALCONN_P (proc))
7008 Fdelete_process (proc);
7009 else if (XPROCESS (proc)->infd >= 0)
7010 process_send_signal (proc, SIGHUP, Qnil, 1);
7013 #else /* subprocesses */
7014 /* Since we have no subprocesses, this does nothing. */
7015 #endif /* subprocesses */
7018 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
7019 Swaiting_for_user_input_p, 0, 0, 0,
7020 doc: /* Returns non-nil if Emacs is waiting for input from the user.
7021 This is intended for use by asynchronous process output filters and sentinels. */)
7022 (void)
7024 #ifdef subprocesses
7025 return (waiting_for_user_input_p ? Qt : Qnil);
7026 #else
7027 return Qnil;
7028 #endif
7031 /* Stop reading input from keyboard sources. */
7033 void
7034 hold_keyboard_input (void)
7036 kbd_is_on_hold = 1;
7039 /* Resume reading input from keyboard sources. */
7041 void
7042 unhold_keyboard_input (void)
7044 kbd_is_on_hold = 0;
7047 /* Return non-zero if keyboard input is on hold, zero otherwise. */
7050 kbd_on_hold_p (void)
7052 return kbd_is_on_hold;
7056 /* Enumeration of and access to system processes a-la ps(1). */
7058 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
7059 0, 0, 0,
7060 doc: /* Return a list of numerical process IDs of all running processes.
7061 If this functionality is unsupported, return nil.
7063 See `process-attributes' for getting attributes of a process given its ID. */)
7064 (void)
7066 return list_system_processes ();
7069 DEFUN ("process-attributes", Fprocess_attributes,
7070 Sprocess_attributes, 1, 1, 0,
7071 doc: /* Return attributes of the process given by its PID, a number.
7073 Value is an alist where each element is a cons cell of the form
7075 \(KEY . VALUE)
7077 If this functionality is unsupported, the value is nil.
7079 See `list-system-processes' for getting a list of all process IDs.
7081 The KEYs of the attributes that this function may return are listed
7082 below, together with the type of the associated VALUE (in parentheses).
7083 Not all platforms support all of these attributes; unsupported
7084 attributes will not appear in the returned alist.
7085 Unless explicitly indicated otherwise, numbers can have either
7086 integer or floating point values.
7088 euid -- Effective user User ID of the process (number)
7089 user -- User name corresponding to euid (string)
7090 egid -- Effective user Group ID of the process (number)
7091 group -- Group name corresponding to egid (string)
7092 comm -- Command name (executable name only) (string)
7093 state -- Process state code, such as "S", "R", or "T" (string)
7094 ppid -- Parent process ID (number)
7095 pgrp -- Process group ID (number)
7096 sess -- Session ID, i.e. process ID of session leader (number)
7097 ttname -- Controlling tty name (string)
7098 tpgid -- ID of foreground process group on the process's tty (number)
7099 minflt -- number of minor page faults (number)
7100 majflt -- number of major page faults (number)
7101 cminflt -- cumulative number of minor page faults (number)
7102 cmajflt -- cumulative number of major page faults (number)
7103 utime -- user time used by the process, in the (HIGH LOW USEC) format
7104 stime -- system time used by the process, in the (HIGH LOW USEC) format
7105 time -- sum of utime and stime, in the (HIGH LOW USEC) format
7106 cutime -- user time used by the process and its children, (HIGH LOW USEC)
7107 cstime -- system time used by the process and its children, (HIGH LOW USEC)
7108 ctime -- sum of cutime and cstime, in the (HIGH LOW USEC) format
7109 pri -- priority of the process (number)
7110 nice -- nice value of the process (number)
7111 thcount -- process thread count (number)
7112 start -- time the process started, in the (HIGH LOW USEC) format
7113 vsize -- virtual memory size of the process in KB's (number)
7114 rss -- resident set size of the process in KB's (number)
7115 etime -- elapsed time the process is running, in (HIGH LOW USEC) format
7116 pcpu -- percents of CPU time used by the process (floating-point number)
7117 pmem -- percents of total physical memory used by process's resident set
7118 (floating-point number)
7119 args -- command line which invoked the process (string). */)
7120 ( Lisp_Object pid)
7122 return system_process_attributes (pid);
7126 void
7127 init_process (void)
7129 #ifdef subprocesses
7130 register int i;
7132 inhibit_sentinels = 0;
7134 #ifdef SIGCHLD
7135 #ifndef CANNOT_DUMP
7136 if (! noninteractive || initialized)
7137 #endif
7138 signal (SIGCHLD, sigchld_handler);
7139 #endif
7141 FD_ZERO (&input_wait_mask);
7142 FD_ZERO (&non_keyboard_wait_mask);
7143 FD_ZERO (&non_process_wait_mask);
7144 FD_ZERO (&write_mask);
7145 max_process_desc = 0;
7146 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7148 #ifdef NON_BLOCKING_CONNECT
7149 FD_ZERO (&connect_wait_mask);
7150 num_pending_connects = 0;
7151 #endif
7153 #ifdef ADAPTIVE_READ_BUFFERING
7154 process_output_delay_count = 0;
7155 process_output_skip = 0;
7156 #endif
7158 /* Don't do this, it caused infinite select loops. The display
7159 method should call add_keyboard_wait_descriptor on stdin if it
7160 needs that. */
7161 #if 0
7162 FD_SET (0, &input_wait_mask);
7163 #endif
7165 Vprocess_alist = Qnil;
7166 #ifdef SIGCHLD
7167 deleted_pid_list = Qnil;
7168 #endif
7169 for (i = 0; i < MAXDESC; i++)
7171 chan_process[i] = Qnil;
7172 proc_buffered_char[i] = -1;
7174 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7175 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7176 #ifdef DATAGRAM_SOCKETS
7177 memset (datagram_address, 0, sizeof datagram_address);
7178 #endif
7181 Lisp_Object subfeatures = Qnil;
7182 const struct socket_options *sopt;
7184 #define ADD_SUBFEATURE(key, val) \
7185 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7187 #ifdef NON_BLOCKING_CONNECT
7188 ADD_SUBFEATURE (QCnowait, Qt);
7189 #endif
7190 #ifdef DATAGRAM_SOCKETS
7191 ADD_SUBFEATURE (QCtype, Qdatagram);
7192 #endif
7193 #ifdef HAVE_SEQPACKET
7194 ADD_SUBFEATURE (QCtype, Qseqpacket);
7195 #endif
7196 #ifdef HAVE_LOCAL_SOCKETS
7197 ADD_SUBFEATURE (QCfamily, Qlocal);
7198 #endif
7199 ADD_SUBFEATURE (QCfamily, Qipv4);
7200 #ifdef AF_INET6
7201 ADD_SUBFEATURE (QCfamily, Qipv6);
7202 #endif
7203 #ifdef HAVE_GETSOCKNAME
7204 ADD_SUBFEATURE (QCservice, Qt);
7205 #endif
7206 #if defined(O_NONBLOCK) || defined(O_NDELAY)
7207 ADD_SUBFEATURE (QCserver, Qt);
7208 #endif
7210 for (sopt = socket_options; sopt->name; sopt++)
7211 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7213 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7216 #if defined (DARWIN_OS)
7217 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7218 processes. As such, we only change the default value. */
7219 if (initialized)
7221 char const *release = (STRINGP (Voperating_system_release)
7222 ? SSDATA (Voperating_system_release)
7223 : 0);
7224 if (!release || !release[0] || (release[0] < MIN_PTY_KERNEL_VERSION
7225 && release[1] == '.')) {
7226 Vprocess_connection_type = Qnil;
7229 #endif
7230 #endif /* subprocesses */
7231 kbd_is_on_hold = 0;
7234 void
7235 syms_of_process (void)
7237 #ifdef subprocesses
7239 Qprocessp = intern_c_string ("processp");
7240 staticpro (&Qprocessp);
7241 Qrun = intern_c_string ("run");
7242 staticpro (&Qrun);
7243 Qstop = intern_c_string ("stop");
7244 staticpro (&Qstop);
7245 Qsignal = intern_c_string ("signal");
7246 staticpro (&Qsignal);
7248 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7249 here again.
7251 Qexit = intern_c_string ("exit");
7252 staticpro (&Qexit); */
7254 Qopen = intern_c_string ("open");
7255 staticpro (&Qopen);
7256 Qclosed = intern_c_string ("closed");
7257 staticpro (&Qclosed);
7258 Qconnect = intern_c_string ("connect");
7259 staticpro (&Qconnect);
7260 Qfailed = intern_c_string ("failed");
7261 staticpro (&Qfailed);
7262 Qlisten = intern_c_string ("listen");
7263 staticpro (&Qlisten);
7264 Qlocal = intern_c_string ("local");
7265 staticpro (&Qlocal);
7266 Qipv4 = intern_c_string ("ipv4");
7267 staticpro (&Qipv4);
7268 #ifdef AF_INET6
7269 Qipv6 = intern_c_string ("ipv6");
7270 staticpro (&Qipv6);
7271 #endif
7272 Qdatagram = intern_c_string ("datagram");
7273 staticpro (&Qdatagram);
7274 Qseqpacket = intern_c_string ("seqpacket");
7275 staticpro (&Qseqpacket);
7277 QCport = intern_c_string (":port");
7278 staticpro (&QCport);
7279 QCspeed = intern_c_string (":speed");
7280 staticpro (&QCspeed);
7281 QCprocess = intern_c_string (":process");
7282 staticpro (&QCprocess);
7284 QCbytesize = intern_c_string (":bytesize");
7285 staticpro (&QCbytesize);
7286 QCstopbits = intern_c_string (":stopbits");
7287 staticpro (&QCstopbits);
7288 QCparity = intern_c_string (":parity");
7289 staticpro (&QCparity);
7290 Qodd = intern_c_string ("odd");
7291 staticpro (&Qodd);
7292 Qeven = intern_c_string ("even");
7293 staticpro (&Qeven);
7294 QCflowcontrol = intern_c_string (":flowcontrol");
7295 staticpro (&QCflowcontrol);
7296 Qhw = intern_c_string ("hw");
7297 staticpro (&Qhw);
7298 Qsw = intern_c_string ("sw");
7299 staticpro (&Qsw);
7300 QCsummary = intern_c_string (":summary");
7301 staticpro (&QCsummary);
7303 Qreal = intern_c_string ("real");
7304 staticpro (&Qreal);
7305 Qnetwork = intern_c_string ("network");
7306 staticpro (&Qnetwork);
7307 Qserial = intern_c_string ("serial");
7308 staticpro (&Qserial);
7309 QCbuffer = intern_c_string (":buffer");
7310 staticpro (&QCbuffer);
7311 QChost = intern_c_string (":host");
7312 staticpro (&QChost);
7313 QCservice = intern_c_string (":service");
7314 staticpro (&QCservice);
7315 QClocal = intern_c_string (":local");
7316 staticpro (&QClocal);
7317 QCremote = intern_c_string (":remote");
7318 staticpro (&QCremote);
7319 QCcoding = intern_c_string (":coding");
7320 staticpro (&QCcoding);
7321 QCserver = intern_c_string (":server");
7322 staticpro (&QCserver);
7323 QCnowait = intern_c_string (":nowait");
7324 staticpro (&QCnowait);
7325 QCsentinel = intern_c_string (":sentinel");
7326 staticpro (&QCsentinel);
7327 QClog = intern_c_string (":log");
7328 staticpro (&QClog);
7329 QCnoquery = intern_c_string (":noquery");
7330 staticpro (&QCnoquery);
7331 QCstop = intern_c_string (":stop");
7332 staticpro (&QCstop);
7333 QCoptions = intern_c_string (":options");
7334 staticpro (&QCoptions);
7335 QCplist = intern_c_string (":plist");
7336 staticpro (&QCplist);
7338 Qlast_nonmenu_event = intern_c_string ("last-nonmenu-event");
7339 staticpro (&Qlast_nonmenu_event);
7341 staticpro (&Vprocess_alist);
7342 #ifdef SIGCHLD
7343 staticpro (&deleted_pid_list);
7344 #endif
7346 #endif /* subprocesses */
7348 QCname = intern_c_string (":name");
7349 staticpro (&QCname);
7350 QCtype = intern_c_string (":type");
7351 staticpro (&QCtype);
7353 Qeuid = intern_c_string ("euid");
7354 staticpro (&Qeuid);
7355 Qegid = intern_c_string ("egid");
7356 staticpro (&Qegid);
7357 Quser = intern_c_string ("user");
7358 staticpro (&Quser);
7359 Qgroup = intern_c_string ("group");
7360 staticpro (&Qgroup);
7361 Qcomm = intern_c_string ("comm");
7362 staticpro (&Qcomm);
7363 Qstate = intern_c_string ("state");
7364 staticpro (&Qstate);
7365 Qppid = intern_c_string ("ppid");
7366 staticpro (&Qppid);
7367 Qpgrp = intern_c_string ("pgrp");
7368 staticpro (&Qpgrp);
7369 Qsess = intern_c_string ("sess");
7370 staticpro (&Qsess);
7371 Qttname = intern_c_string ("ttname");
7372 staticpro (&Qttname);
7373 Qtpgid = intern_c_string ("tpgid");
7374 staticpro (&Qtpgid);
7375 Qminflt = intern_c_string ("minflt");
7376 staticpro (&Qminflt);
7377 Qmajflt = intern_c_string ("majflt");
7378 staticpro (&Qmajflt);
7379 Qcminflt = intern_c_string ("cminflt");
7380 staticpro (&Qcminflt);
7381 Qcmajflt = intern_c_string ("cmajflt");
7382 staticpro (&Qcmajflt);
7383 Qutime = intern_c_string ("utime");
7384 staticpro (&Qutime);
7385 Qstime = intern_c_string ("stime");
7386 staticpro (&Qstime);
7387 Qtime = intern_c_string ("time");
7388 staticpro (&Qtime);
7389 Qcutime = intern_c_string ("cutime");
7390 staticpro (&Qcutime);
7391 Qcstime = intern_c_string ("cstime");
7392 staticpro (&Qcstime);
7393 Qctime = intern_c_string ("ctime");
7394 staticpro (&Qctime);
7395 Qpri = intern_c_string ("pri");
7396 staticpro (&Qpri);
7397 Qnice = intern_c_string ("nice");
7398 staticpro (&Qnice);
7399 Qthcount = intern_c_string ("thcount");
7400 staticpro (&Qthcount);
7401 Qstart = intern_c_string ("start");
7402 staticpro (&Qstart);
7403 Qvsize = intern_c_string ("vsize");
7404 staticpro (&Qvsize);
7405 Qrss = intern_c_string ("rss");
7406 staticpro (&Qrss);
7407 Qetime = intern_c_string ("etime");
7408 staticpro (&Qetime);
7409 Qpcpu = intern_c_string ("pcpu");
7410 staticpro (&Qpcpu);
7411 Qpmem = intern_c_string ("pmem");
7412 staticpro (&Qpmem);
7413 Qargs = intern_c_string ("args");
7414 staticpro (&Qargs);
7416 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7417 doc: /* *Non-nil means delete processes immediately when they exit.
7418 A value of nil means don't delete them until `list-processes' is run. */);
7420 delete_exited_processes = 1;
7422 #ifdef subprocesses
7423 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7424 doc: /* Control type of device used to communicate with subprocesses.
7425 Values are nil to use a pipe, or t or `pty' to use a pty.
7426 The value has no effect if the system has no ptys or if all ptys are busy:
7427 then a pipe is used in any case.
7428 The value takes effect when `start-process' is called. */);
7429 Vprocess_connection_type = Qt;
7431 #ifdef ADAPTIVE_READ_BUFFERING
7432 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7433 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7434 On some systems, when Emacs reads the output from a subprocess, the output data
7435 is read in very small blocks, potentially resulting in very poor performance.
7436 This behavior can be remedied to some extent by setting this variable to a
7437 non-nil value, as it will automatically delay reading from such processes, to
7438 allow them to produce more output before Emacs tries to read it.
7439 If the value is t, the delay is reset after each write to the process; any other
7440 non-nil value means that the delay is not reset on write.
7441 The variable takes effect when `start-process' is called. */);
7442 Vprocess_adaptive_read_buffering = Qt;
7443 #endif
7445 defsubr (&Sprocessp);
7446 defsubr (&Sget_process);
7447 defsubr (&Sdelete_process);
7448 defsubr (&Sprocess_status);
7449 defsubr (&Sprocess_exit_status);
7450 defsubr (&Sprocess_id);
7451 defsubr (&Sprocess_name);
7452 defsubr (&Sprocess_tty_name);
7453 defsubr (&Sprocess_command);
7454 defsubr (&Sset_process_buffer);
7455 defsubr (&Sprocess_buffer);
7456 defsubr (&Sprocess_mark);
7457 defsubr (&Sset_process_filter);
7458 defsubr (&Sprocess_filter);
7459 defsubr (&Sset_process_sentinel);
7460 defsubr (&Sprocess_sentinel);
7461 defsubr (&Sset_process_window_size);
7462 defsubr (&Sset_process_inherit_coding_system_flag);
7463 defsubr (&Sset_process_query_on_exit_flag);
7464 defsubr (&Sprocess_query_on_exit_flag);
7465 defsubr (&Sprocess_contact);
7466 defsubr (&Sprocess_plist);
7467 defsubr (&Sset_process_plist);
7468 defsubr (&Sprocess_list);
7469 defsubr (&Sstart_process);
7470 defsubr (&Sserial_process_configure);
7471 defsubr (&Smake_serial_process);
7472 defsubr (&Sset_network_process_option);
7473 defsubr (&Smake_network_process);
7474 defsubr (&Sformat_network_address);
7475 #if defined(HAVE_NET_IF_H)
7476 #ifdef SIOCGIFCONF
7477 defsubr (&Snetwork_interface_list);
7478 #endif
7479 #if defined(SIOCGIFADDR) || defined(SIOCGIFHWADDR) || defined(SIOCGIFFLAGS)
7480 defsubr (&Snetwork_interface_info);
7481 #endif
7482 #endif /* defined(HAVE_NET_IF_H) */
7483 #ifdef DATAGRAM_SOCKETS
7484 defsubr (&Sprocess_datagram_address);
7485 defsubr (&Sset_process_datagram_address);
7486 #endif
7487 defsubr (&Saccept_process_output);
7488 defsubr (&Sprocess_send_region);
7489 defsubr (&Sprocess_send_string);
7490 defsubr (&Sinterrupt_process);
7491 defsubr (&Skill_process);
7492 defsubr (&Squit_process);
7493 defsubr (&Sstop_process);
7494 defsubr (&Scontinue_process);
7495 defsubr (&Sprocess_running_child_p);
7496 defsubr (&Sprocess_send_eof);
7497 defsubr (&Ssignal_process);
7498 defsubr (&Swaiting_for_user_input_p);
7499 defsubr (&Sprocess_type);
7500 defsubr (&Sset_process_coding_system);
7501 defsubr (&Sprocess_coding_system);
7502 defsubr (&Sset_process_filter_multibyte);
7503 defsubr (&Sprocess_filter_multibyte_p);
7505 #endif /* subprocesses */
7507 defsubr (&Sget_buffer_process);
7508 defsubr (&Sprocess_inherit_coding_system_flag);
7509 defsubr (&Slist_system_processes);
7510 defsubr (&Sprocess_attributes);