]> code.delx.au - gnu-emacs/blob - src/process.c
9015383b8b53d28c0c605c14648b34705d337f06
[gnu-emacs] / src / process.c
1 /* Asynchronous subprocess control for GNU Emacs.
2
3 Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2015 Free Software
4 Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
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.
12
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.
17
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/>. */
20
21
22 #include <config.h>
23
24 #include <stdio.h>
25 #include <errno.h>
26 #include <sys/types.h> /* Some typedefs are used in sys/file.h. */
27 #include <sys/file.h>
28 #include <sys/stat.h>
29 #include <unistd.h>
30 #include <fcntl.h>
31
32 #include "lisp.h"
33
34 /* Only MS-DOS does not define `subprocesses'. */
35 #ifdef subprocesses
36
37 #include <sys/socket.h>
38 #include <netdb.h>
39 #include <netinet/in.h>
40 #include <arpa/inet.h>
41
42 /* Are local (unix) sockets supported? */
43 #if defined (HAVE_SYS_UN_H)
44 #if !defined (AF_LOCAL) && defined (AF_UNIX)
45 #define AF_LOCAL AF_UNIX
46 #endif
47 #ifdef AF_LOCAL
48 #define HAVE_LOCAL_SOCKETS
49 #include <sys/un.h>
50 #endif
51 #endif
52
53 #include <sys/ioctl.h>
54 #if defined (HAVE_NET_IF_H)
55 #include <net/if.h>
56 #endif /* HAVE_NET_IF_H */
57
58 #if defined (HAVE_IFADDRS_H)
59 /* Must be after net/if.h */
60 #include <ifaddrs.h>
61
62 /* We only use structs from this header when we use getifaddrs. */
63 #if defined (HAVE_NET_IF_DL_H)
64 #include <net/if_dl.h>
65 #endif
66
67 #endif
68
69 #ifdef NEED_BSDTTY
70 #include <bsdtty.h>
71 #endif
72
73 #ifdef USG5_4
74 # include <sys/stream.h>
75 # include <sys/stropts.h>
76 #endif
77
78 #ifdef HAVE_RES_INIT
79 #include <arpa/nameser.h>
80 #include <resolv.h>
81 #endif
82
83 #ifdef HAVE_UTIL_H
84 #include <util.h>
85 #endif
86
87 #ifdef HAVE_PTY_H
88 #include <pty.h>
89 #endif
90
91 #include <c-ctype.h>
92 #include <sig2str.h>
93 #include <verify.h>
94
95 #endif /* subprocesses */
96
97 #include "systime.h"
98 #include "systty.h"
99
100 #include "window.h"
101 #include "character.h"
102 #include "buffer.h"
103 #include "coding.h"
104 #include "process.h"
105 #include "frame.h"
106 #include "termhooks.h"
107 #include "termopts.h"
108 #include "commands.h"
109 #include "keyboard.h"
110 #include "blockinput.h"
111 #include "dispextern.h"
112 #include "composite.h"
113 #include "atimer.h"
114 #include "sysselect.h"
115 #include "syssignal.h"
116 #include "syswait.h"
117 #ifdef HAVE_GNUTLS
118 #include "gnutls.h"
119 #endif
120
121 #ifdef HAVE_WINDOW_SYSTEM
122 #include TERM_HEADER
123 #endif /* HAVE_WINDOW_SYSTEM */
124
125 #ifdef HAVE_GLIB
126 #include "xgselect.h"
127 #ifndef WINDOWSNT
128 #include <glib.h>
129 #endif
130 #endif
131
132 #ifdef WINDOWSNT
133 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
134 struct timespec *, void *);
135 #endif
136
137 /* Work around GCC 4.7.0 bug with strict overflow checking; see
138 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
139 These lines can be removed once the GCC bug is fixed. */
140 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
141 # pragma GCC diagnostic ignored "-Wstrict-overflow"
142 #endif
143 \f
144 /* True if keyboard input is on hold, zero otherwise. */
145
146 static bool kbd_is_on_hold;
147
148 /* Nonzero means don't run process sentinels. This is used
149 when exiting. */
150 bool inhibit_sentinels;
151
152 #ifdef subprocesses
153
154 #ifndef SOCK_CLOEXEC
155 # define SOCK_CLOEXEC 0
156 #endif
157
158 #ifndef HAVE_ACCEPT4
159
160 /* Emulate GNU/Linux accept4 and socket well enough for this module. */
161
162 static int
163 close_on_exec (int fd)
164 {
165 if (0 <= fd)
166 fcntl (fd, F_SETFD, FD_CLOEXEC);
167 return fd;
168 }
169
170 # undef accept4
171 # define accept4(sockfd, addr, addrlen, flags) \
172 process_accept4 (sockfd, addr, addrlen, flags)
173 static int
174 accept4 (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags)
175 {
176 return close_on_exec (accept (sockfd, addr, addrlen));
177 }
178
179 static int
180 process_socket (int domain, int type, int protocol)
181 {
182 return close_on_exec (socket (domain, type, protocol));
183 }
184 # undef socket
185 # define socket(domain, type, protocol) process_socket (domain, type, protocol)
186 #endif
187
188 #define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
189 #define NETCONN1_P(p) (EQ (p->type, Qnetwork))
190 #define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
191 #define SERIALCONN1_P(p) (EQ (p->type, Qserial))
192
193 /* Number of events of change of status of a process. */
194 static EMACS_INT process_tick;
195 /* Number of events for which the user or sentinel has been notified. */
196 static EMACS_INT update_tick;
197
198 /* Define NON_BLOCKING_CONNECT if we can support non-blocking connects. */
199
200 /* Only W32 has this, it really means that select can't take write mask. */
201 #ifdef BROKEN_NON_BLOCKING_CONNECT
202 #undef NON_BLOCKING_CONNECT
203 enum { SELECT_CAN_DO_WRITE_MASK = false };
204 #else
205 enum { SELECT_CAN_DO_WRITE_MASK = true };
206 #ifndef NON_BLOCKING_CONNECT
207 #ifdef HAVE_SELECT
208 #if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
209 #if defined (EWOULDBLOCK) || defined (EINPROGRESS)
210 #define NON_BLOCKING_CONNECT
211 #endif /* EWOULDBLOCK || EINPROGRESS */
212 #endif /* HAVE_GETPEERNAME || GNU_LINUX */
213 #endif /* HAVE_SELECT */
214 #endif /* NON_BLOCKING_CONNECT */
215 #endif /* BROKEN_NON_BLOCKING_CONNECT */
216
217 /* Define DATAGRAM_SOCKETS if datagrams can be used safely on
218 this system. We need to read full packets, so we need a
219 "non-destructive" select. So we require either native select,
220 or emulation of select using FIONREAD. */
221
222 #ifndef BROKEN_DATAGRAM_SOCKETS
223 # if defined HAVE_SELECT || defined USABLE_FIONREAD
224 # if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
225 # define DATAGRAM_SOCKETS
226 # endif
227 # endif
228 #endif
229
230 #if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
231 # define HAVE_SEQPACKET
232 #endif
233
234 #if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
235 #define ADAPTIVE_READ_BUFFERING
236 #endif
237
238 #ifdef ADAPTIVE_READ_BUFFERING
239 #define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
240 #define READ_OUTPUT_DELAY_MAX (READ_OUTPUT_DELAY_INCREMENT * 5)
241 #define READ_OUTPUT_DELAY_MAX_MAX (READ_OUTPUT_DELAY_INCREMENT * 7)
242
243 /* Number of processes which have a non-zero read_output_delay,
244 and therefore might be delayed for adaptive read buffering. */
245
246 static int process_output_delay_count;
247
248 /* True if any process has non-nil read_output_skip. */
249
250 static bool process_output_skip;
251
252 #else
253 #define process_output_delay_count 0
254 #endif
255
256 static void create_process (Lisp_Object, char **, Lisp_Object);
257 #ifdef USABLE_SIGIO
258 static bool keyboard_bit_set (fd_set *);
259 #endif
260 static void deactivate_process (Lisp_Object);
261 static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
262 static int read_process_output (Lisp_Object, int);
263 static void handle_child_signal (int);
264 static void create_pty (Lisp_Object);
265
266 static Lisp_Object get_process (register Lisp_Object name);
267 static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
268
269 /* Mask of bits indicating the descriptors that we wait for input on. */
270
271 static fd_set input_wait_mask;
272
273 /* Mask that excludes keyboard input descriptor(s). */
274
275 static fd_set non_keyboard_wait_mask;
276
277 /* Mask that excludes process input descriptor(s). */
278
279 static fd_set non_process_wait_mask;
280
281 /* Mask for selecting for write. */
282
283 static fd_set write_mask;
284
285 #ifdef NON_BLOCKING_CONNECT
286 /* Mask of bits indicating the descriptors that we wait for connect to
287 complete on. Once they complete, they are removed from this mask
288 and added to the input_wait_mask and non_keyboard_wait_mask. */
289
290 static fd_set connect_wait_mask;
291
292 /* Number of bits set in connect_wait_mask. */
293 static int num_pending_connects;
294 #endif /* NON_BLOCKING_CONNECT */
295
296 /* The largest descriptor currently in use for a process object; -1 if none. */
297 static int max_process_desc;
298
299 /* The largest descriptor currently in use for input; -1 if none. */
300 static int max_input_desc;
301
302 /* Indexed by descriptor, gives the process (if any) for that descriptor. */
303 static Lisp_Object chan_process[FD_SETSIZE];
304
305 /* Alist of elements (NAME . PROCESS). */
306 static Lisp_Object Vprocess_alist;
307
308 /* Buffered-ahead input char from process, indexed by channel.
309 -1 means empty (no char is buffered).
310 Used on sys V where the only way to tell if there is any
311 output from the process is to read at least one char.
312 Always -1 on systems that support FIONREAD. */
313
314 static int proc_buffered_char[FD_SETSIZE];
315
316 /* Table of `struct coding-system' for each process. */
317 static struct coding_system *proc_decode_coding_system[FD_SETSIZE];
318 static struct coding_system *proc_encode_coding_system[FD_SETSIZE];
319
320 #ifdef DATAGRAM_SOCKETS
321 /* Table of `partner address' for datagram sockets. */
322 static struct sockaddr_and_len {
323 struct sockaddr *sa;
324 int len;
325 } datagram_address[FD_SETSIZE];
326 #define DATAGRAM_CHAN_P(chan) (datagram_address[chan].sa != 0)
327 #define DATAGRAM_CONN_P(proc) \
328 (PROCESSP (proc) && \
329 XPROCESS (proc)->infd >= 0 && \
330 datagram_address[XPROCESS (proc)->infd].sa != 0)
331 #else
332 #define DATAGRAM_CHAN_P(chan) (0)
333 #define DATAGRAM_CONN_P(proc) (0)
334 #endif
335
336 /* FOR_EACH_PROCESS (LIST_VAR, PROC_VAR) followed by a statement is
337 a `for' loop which iterates over processes from Vprocess_alist. */
338
339 #define FOR_EACH_PROCESS(list_var, proc_var) \
340 FOR_EACH_ALIST_VALUE (Vprocess_alist, list_var, proc_var)
341
342 /* These setters are used only in this file, so they can be private. */
343 static void
344 pset_buffer (struct Lisp_Process *p, Lisp_Object val)
345 {
346 p->buffer = val;
347 }
348 static void
349 pset_command (struct Lisp_Process *p, Lisp_Object val)
350 {
351 p->command = val;
352 }
353 static void
354 pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
355 {
356 p->decode_coding_system = val;
357 }
358 static void
359 pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
360 {
361 p->decoding_buf = val;
362 }
363 static void
364 pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
365 {
366 p->encode_coding_system = val;
367 }
368 static void
369 pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
370 {
371 p->encoding_buf = val;
372 }
373 static void
374 pset_filter (struct Lisp_Process *p, Lisp_Object val)
375 {
376 p->filter = NILP (val) ? Qinternal_default_process_filter : val;
377 }
378 static void
379 pset_log (struct Lisp_Process *p, Lisp_Object val)
380 {
381 p->log = val;
382 }
383 static void
384 pset_mark (struct Lisp_Process *p, Lisp_Object val)
385 {
386 p->mark = val;
387 }
388 static void
389 pset_name (struct Lisp_Process *p, Lisp_Object val)
390 {
391 p->name = val;
392 }
393 static void
394 pset_plist (struct Lisp_Process *p, Lisp_Object val)
395 {
396 p->plist = val;
397 }
398 static void
399 pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
400 {
401 p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
402 }
403 static void
404 pset_status (struct Lisp_Process *p, Lisp_Object val)
405 {
406 p->status = val;
407 }
408 static void
409 pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
410 {
411 p->tty_name = val;
412 }
413 static void
414 pset_type (struct Lisp_Process *p, Lisp_Object val)
415 {
416 p->type = val;
417 }
418 static void
419 pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
420 {
421 p->write_queue = val;
422 }
423
424 \f
425
426 static struct fd_callback_data
427 {
428 fd_callback func;
429 void *data;
430 #define FOR_READ 1
431 #define FOR_WRITE 2
432 int condition; /* Mask of the defines above. */
433 } fd_callback_info[FD_SETSIZE];
434
435
436 /* Add a file descriptor FD to be monitored for when read is possible.
437 When read is possible, call FUNC with argument DATA. */
438
439 void
440 add_read_fd (int fd, fd_callback func, void *data)
441 {
442 add_keyboard_wait_descriptor (fd);
443
444 fd_callback_info[fd].func = func;
445 fd_callback_info[fd].data = data;
446 fd_callback_info[fd].condition |= FOR_READ;
447 }
448
449 /* Stop monitoring file descriptor FD for when read is possible. */
450
451 void
452 delete_read_fd (int fd)
453 {
454 delete_keyboard_wait_descriptor (fd);
455
456 fd_callback_info[fd].condition &= ~FOR_READ;
457 if (fd_callback_info[fd].condition == 0)
458 {
459 fd_callback_info[fd].func = 0;
460 fd_callback_info[fd].data = 0;
461 }
462 }
463
464 /* Add a file descriptor FD to be monitored for when write is possible.
465 When write is possible, call FUNC with argument DATA. */
466
467 void
468 add_write_fd (int fd, fd_callback func, void *data)
469 {
470 FD_SET (fd, &write_mask);
471 if (fd > max_input_desc)
472 max_input_desc = fd;
473
474 fd_callback_info[fd].func = func;
475 fd_callback_info[fd].data = data;
476 fd_callback_info[fd].condition |= FOR_WRITE;
477 }
478
479 /* FD is no longer an input descriptor; update max_input_desc accordingly. */
480
481 static void
482 delete_input_desc (int fd)
483 {
484 if (fd == max_input_desc)
485 {
486 do
487 fd--;
488 while (0 <= fd && ! (FD_ISSET (fd, &input_wait_mask)
489 || FD_ISSET (fd, &write_mask)));
490
491 max_input_desc = fd;
492 }
493 }
494
495 /* Stop monitoring file descriptor FD for when write is possible. */
496
497 void
498 delete_write_fd (int fd)
499 {
500 FD_CLR (fd, &write_mask);
501 fd_callback_info[fd].condition &= ~FOR_WRITE;
502 if (fd_callback_info[fd].condition == 0)
503 {
504 fd_callback_info[fd].func = 0;
505 fd_callback_info[fd].data = 0;
506 delete_input_desc (fd);
507 }
508 }
509
510 \f
511 /* Compute the Lisp form of the process status, p->status, from
512 the numeric status that was returned by `wait'. */
513
514 static Lisp_Object status_convert (int);
515
516 static void
517 update_status (struct Lisp_Process *p)
518 {
519 eassert (p->raw_status_new);
520 pset_status (p, status_convert (p->raw_status));
521 p->raw_status_new = 0;
522 }
523
524 /* Convert a process status word in Unix format to
525 the list that we use internally. */
526
527 static Lisp_Object
528 status_convert (int w)
529 {
530 if (WIFSTOPPED (w))
531 return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
532 else if (WIFEXITED (w))
533 return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
534 WCOREDUMP (w) ? Qt : Qnil));
535 else if (WIFSIGNALED (w))
536 return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
537 WCOREDUMP (w) ? Qt : Qnil));
538 else
539 return Qrun;
540 }
541
542 /* Given a status-list, extract the three pieces of information
543 and store them individually through the three pointers. */
544
545 static void
546 decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
547 {
548 Lisp_Object tem;
549
550 if (SYMBOLP (l))
551 {
552 *symbol = l;
553 *code = 0;
554 *coredump = 0;
555 }
556 else
557 {
558 *symbol = XCAR (l);
559 tem = XCDR (l);
560 *code = XFASTINT (XCAR (tem));
561 tem = XCDR (tem);
562 *coredump = !NILP (tem);
563 }
564 }
565
566 /* Return a string describing a process status list. */
567
568 static Lisp_Object
569 status_message (struct Lisp_Process *p)
570 {
571 Lisp_Object status = p->status;
572 Lisp_Object symbol;
573 int code;
574 bool coredump;
575 Lisp_Object string;
576
577 decode_status (status, &symbol, &code, &coredump);
578
579 if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
580 {
581 char const *signame;
582 synchronize_system_messages_locale ();
583 signame = strsignal (code);
584 if (signame == 0)
585 string = build_string ("unknown");
586 else
587 {
588 int c1, c2;
589
590 string = build_unibyte_string (signame);
591 if (! NILP (Vlocale_coding_system))
592 string = (code_convert_string_norecord
593 (string, Vlocale_coding_system, 0));
594 c1 = STRING_CHAR (SDATA (string));
595 c2 = downcase (c1);
596 if (c1 != c2)
597 Faset (string, make_number (0), make_number (c2));
598 }
599 AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
600 return concat2 (string, suffix);
601 }
602 else if (EQ (symbol, Qexit))
603 {
604 if (NETCONN1_P (p))
605 return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
606 if (code == 0)
607 return build_string ("finished\n");
608 AUTO_STRING (prefix, "exited abnormally with code ");
609 string = Fnumber_to_string (make_number (code));
610 AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
611 return concat3 (prefix, string, suffix);
612 }
613 else if (EQ (symbol, Qfailed))
614 {
615 AUTO_STRING (prefix, "failed with code ");
616 string = Fnumber_to_string (make_number (code));
617 AUTO_STRING (suffix, "\n");
618 return concat3 (prefix, string, suffix);
619 }
620 else
621 return Fcopy_sequence (Fsymbol_name (symbol));
622 }
623 \f
624 enum { PTY_NAME_SIZE = 24 };
625
626 /* Open an available pty, returning a file descriptor.
627 Store into PTY_NAME the file name of the terminal corresponding to the pty.
628 Return -1 on failure. */
629
630 static int
631 allocate_pty (char pty_name[PTY_NAME_SIZE])
632 {
633 #ifdef HAVE_PTYS
634 int fd;
635
636 #ifdef PTY_ITERATION
637 PTY_ITERATION
638 #else
639 register int c, i;
640 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
641 for (i = 0; i < 16; i++)
642 #endif
643 {
644 #ifdef PTY_NAME_SPRINTF
645 PTY_NAME_SPRINTF
646 #else
647 sprintf (pty_name, "/dev/pty%c%x", c, i);
648 #endif /* no PTY_NAME_SPRINTF */
649
650 #ifdef PTY_OPEN
651 PTY_OPEN;
652 #else /* no PTY_OPEN */
653 fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
654 #endif /* no PTY_OPEN */
655
656 if (fd >= 0)
657 {
658 #ifdef PTY_OPEN
659 /* Set FD's close-on-exec flag. This is needed even if
660 PT_OPEN calls posix_openpt with O_CLOEXEC, since POSIX
661 doesn't require support for that combination.
662 Multithreaded platforms where posix_openpt ignores
663 O_CLOEXEC (or where PTY_OPEN doesn't call posix_openpt)
664 have a race condition between the PTY_OPEN and here. */
665 fcntl (fd, F_SETFD, FD_CLOEXEC);
666 #endif
667 /* Check to make certain that both sides are available
668 this avoids a nasty yet stupid bug in rlogins. */
669 #ifdef PTY_TTY_NAME_SPRINTF
670 PTY_TTY_NAME_SPRINTF
671 #else
672 sprintf (pty_name, "/dev/tty%c%x", c, i);
673 #endif /* no PTY_TTY_NAME_SPRINTF */
674 if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
675 {
676 emacs_close (fd);
677 # ifndef __sgi
678 continue;
679 # else
680 return -1;
681 # endif /* __sgi */
682 }
683 setup_pty (fd);
684 return fd;
685 }
686 }
687 #endif /* HAVE_PTYS */
688 return -1;
689 }
690 \f
691 static Lisp_Object
692 make_process (Lisp_Object name)
693 {
694 register Lisp_Object val, tem, name1;
695 register struct Lisp_Process *p;
696 char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
697 printmax_t i;
698
699 p = allocate_process ();
700 /* Initialize Lisp data. Note that allocate_process initializes all
701 Lisp data to nil, so do it only for slots which should not be nil. */
702 pset_status (p, Qrun);
703 pset_mark (p, Fmake_marker ());
704
705 /* Initialize non-Lisp data. Note that allocate_process zeroes out all
706 non-Lisp data, so do it only for slots which should not be zero. */
707 p->infd = -1;
708 p->outfd = -1;
709 for (i = 0; i < PROCESS_OPEN_FDS; i++)
710 p->open_fd[i] = -1;
711
712 #ifdef HAVE_GNUTLS
713 p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
714 #endif
715
716 /* If name is already in use, modify it until it is unused. */
717
718 name1 = name;
719 for (i = 1; ; i++)
720 {
721 tem = Fget_process (name1);
722 if (NILP (tem)) break;
723 name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
724 }
725 name = name1;
726 pset_name (p, name);
727 pset_sentinel (p, Qinternal_default_process_sentinel);
728 pset_filter (p, Qinternal_default_process_filter);
729 XSETPROCESS (val, p);
730 Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
731 return val;
732 }
733
734 static void
735 remove_process (register Lisp_Object proc)
736 {
737 register Lisp_Object pair;
738
739 pair = Frassq (proc, Vprocess_alist);
740 Vprocess_alist = Fdelq (pair, Vprocess_alist);
741
742 deactivate_process (proc);
743 }
744
745 \f
746 DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
747 doc: /* Return t if OBJECT is a process. */)
748 (Lisp_Object object)
749 {
750 return PROCESSP (object) ? Qt : Qnil;
751 }
752
753 DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
754 doc: /* Return the process named NAME, or nil if there is none. */)
755 (register Lisp_Object name)
756 {
757 if (PROCESSP (name))
758 return name;
759 CHECK_STRING (name);
760 return Fcdr (Fassoc (name, Vprocess_alist));
761 }
762
763 /* This is how commands for the user decode process arguments. It
764 accepts a process, a process name, a buffer, a buffer name, or nil.
765 Buffers denote the first process in the buffer, and nil denotes the
766 current buffer. */
767
768 static Lisp_Object
769 get_process (register Lisp_Object name)
770 {
771 register Lisp_Object proc, obj;
772 if (STRINGP (name))
773 {
774 obj = Fget_process (name);
775 if (NILP (obj))
776 obj = Fget_buffer (name);
777 if (NILP (obj))
778 error ("Process %s does not exist", SDATA (name));
779 }
780 else if (NILP (name))
781 obj = Fcurrent_buffer ();
782 else
783 obj = name;
784
785 /* Now obj should be either a buffer object or a process object. */
786 if (BUFFERP (obj))
787 {
788 if (NILP (BVAR (XBUFFER (obj), name)))
789 error ("Attempt to get process for a dead buffer");
790 proc = Fget_buffer_process (obj);
791 if (NILP (proc))
792 error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
793 }
794 else
795 {
796 CHECK_PROCESS (obj);
797 proc = obj;
798 }
799 return proc;
800 }
801
802
803 /* Fdelete_process promises to immediately forget about the process, but in
804 reality, Emacs needs to remember those processes until they have been
805 treated by the SIGCHLD handler and waitpid has been invoked on them;
806 otherwise they might fill up the kernel's process table.
807
808 Some processes created by call-process are also put onto this list.
809
810 Members of this list are (process-ID . filename) pairs. The
811 process-ID is a number; the filename, if a string, is a file that
812 needs to be removed after the process exits. */
813 static Lisp_Object deleted_pid_list;
814
815 void
816 record_deleted_pid (pid_t pid, Lisp_Object filename)
817 {
818 deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
819 /* GC treated elements set to nil. */
820 Fdelq (Qnil, deleted_pid_list));
821
822 }
823
824 DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
825 doc: /* Delete PROCESS: kill it and forget about it immediately.
826 PROCESS may be a process, a buffer, the name of a process or buffer, or
827 nil, indicating the current buffer's process. */)
828 (register Lisp_Object process)
829 {
830 register struct Lisp_Process *p;
831
832 process = get_process (process);
833 p = XPROCESS (process);
834
835 p->raw_status_new = 0;
836 if (NETCONN1_P (p) || SERIALCONN1_P (p))
837 {
838 pset_status (p, list2 (Qexit, make_number (0)));
839 p->tick = ++process_tick;
840 status_notify (p, NULL);
841 redisplay_preserve_echo_area (13);
842 }
843 else
844 {
845 if (p->alive)
846 record_kill_process (p, Qnil);
847
848 if (p->infd >= 0)
849 {
850 /* Update P's status, since record_kill_process will make the
851 SIGCHLD handler update deleted_pid_list, not *P. */
852 Lisp_Object symbol;
853 if (p->raw_status_new)
854 update_status (p);
855 symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
856 if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
857 pset_status (p, list2 (Qsignal, make_number (SIGKILL)));
858
859 p->tick = ++process_tick;
860 status_notify (p, NULL);
861 redisplay_preserve_echo_area (13);
862 }
863 }
864 remove_process (process);
865 return Qnil;
866 }
867 \f
868 DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
869 doc: /* Return the status of PROCESS.
870 The returned value is one of the following symbols:
871 run -- for a process that is running.
872 stop -- for a process stopped but continuable.
873 exit -- for a process that has exited.
874 signal -- for a process that has got a fatal signal.
875 open -- for a network stream connection that is open.
876 listen -- for a network stream server that is listening.
877 closed -- for a network stream connection that is closed.
878 connect -- when waiting for a non-blocking connection to complete.
879 failed -- when a non-blocking connection has failed.
880 nil -- if arg is a process name and no such process exists.
881 PROCESS may be a process, a buffer, the name of a process, or
882 nil, indicating the current buffer's process. */)
883 (register Lisp_Object process)
884 {
885 register struct Lisp_Process *p;
886 register Lisp_Object status;
887
888 if (STRINGP (process))
889 process = Fget_process (process);
890 else
891 process = get_process (process);
892
893 if (NILP (process))
894 return process;
895
896 p = XPROCESS (process);
897 if (p->raw_status_new)
898 update_status (p);
899 status = p->status;
900 if (CONSP (status))
901 status = XCAR (status);
902 if (NETCONN1_P (p) || SERIALCONN1_P (p))
903 {
904 if (EQ (status, Qexit))
905 status = Qclosed;
906 else if (EQ (p->command, Qt))
907 status = Qstop;
908 else if (EQ (status, Qrun))
909 status = Qopen;
910 }
911 return status;
912 }
913
914 DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
915 1, 1, 0,
916 doc: /* Return the exit status of PROCESS or the signal number that killed it.
917 If PROCESS has not yet exited or died, return 0. */)
918 (register Lisp_Object process)
919 {
920 CHECK_PROCESS (process);
921 if (XPROCESS (process)->raw_status_new)
922 update_status (XPROCESS (process));
923 if (CONSP (XPROCESS (process)->status))
924 return XCAR (XCDR (XPROCESS (process)->status));
925 return make_number (0);
926 }
927
928 DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
929 doc: /* Return the process id of PROCESS.
930 This is the pid of the external process which PROCESS uses or talks to.
931 For a network connection, this value is nil. */)
932 (register Lisp_Object process)
933 {
934 pid_t pid;
935
936 CHECK_PROCESS (process);
937 pid = XPROCESS (process)->pid;
938 return (pid ? make_fixnum_or_float (pid) : Qnil);
939 }
940
941 DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
942 doc: /* Return the name of PROCESS, as a string.
943 This is the name of the program invoked in PROCESS,
944 possibly modified to make it unique among process names. */)
945 (register Lisp_Object process)
946 {
947 CHECK_PROCESS (process);
948 return XPROCESS (process)->name;
949 }
950
951 DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
952 doc: /* Return the command that was executed to start PROCESS.
953 This is a list of strings, the first string being the program executed
954 and the rest of the strings being the arguments given to it.
955 For a network or serial process, this is nil (process is running) or t
956 \(process is stopped). */)
957 (register Lisp_Object process)
958 {
959 CHECK_PROCESS (process);
960 return XPROCESS (process)->command;
961 }
962
963 DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
964 doc: /* Return the name of the terminal PROCESS uses, or nil if none.
965 This is the terminal that the process itself reads and writes on,
966 not the name of the pty that Emacs uses to talk with that terminal. */)
967 (register Lisp_Object process)
968 {
969 CHECK_PROCESS (process);
970 return XPROCESS (process)->tty_name;
971 }
972
973 DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
974 2, 2, 0,
975 doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
976 Return BUFFER. */)
977 (register Lisp_Object process, Lisp_Object buffer)
978 {
979 struct Lisp_Process *p;
980
981 CHECK_PROCESS (process);
982 if (!NILP (buffer))
983 CHECK_BUFFER (buffer);
984 p = XPROCESS (process);
985 pset_buffer (p, buffer);
986 if (NETCONN1_P (p) || SERIALCONN1_P (p))
987 pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
988 setup_process_coding_systems (process);
989 return buffer;
990 }
991
992 DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
993 1, 1, 0,
994 doc: /* Return the buffer PROCESS is associated with.
995 The default process filter inserts output from PROCESS into this buffer. */)
996 (register Lisp_Object process)
997 {
998 CHECK_PROCESS (process);
999 return XPROCESS (process)->buffer;
1000 }
1001
1002 DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1003 1, 1, 0,
1004 doc: /* Return the marker for the end of the last output from PROCESS. */)
1005 (register Lisp_Object process)
1006 {
1007 CHECK_PROCESS (process);
1008 return XPROCESS (process)->mark;
1009 }
1010
1011 DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1012 2, 2, 0,
1013 doc: /* Give PROCESS the filter function FILTER; nil means default.
1014 A value of t means stop accepting output from the process.
1015
1016 When a process has a non-default filter, its buffer is not used for output.
1017 Instead, each time it does output, the entire string of output is
1018 passed to the filter.
1019
1020 The filter gets two arguments: the process and the string of output.
1021 The string argument is normally a multibyte string, except:
1022 - if the process's input coding system is no-conversion or raw-text,
1023 it is a unibyte string (the non-converted input), or else
1024 - if `default-enable-multibyte-characters' is nil, it is a unibyte
1025 string (the result of converting the decoded input multibyte
1026 string to unibyte with `string-make-unibyte'). */)
1027 (register Lisp_Object process, Lisp_Object filter)
1028 {
1029 struct Lisp_Process *p;
1030
1031 CHECK_PROCESS (process);
1032 p = XPROCESS (process);
1033
1034 /* Don't signal an error if the process's input file descriptor
1035 is closed. This could make debugging Lisp more difficult,
1036 for example when doing something like
1037
1038 (setq process (start-process ...))
1039 (debug)
1040 (set-process-filter process ...) */
1041
1042 if (NILP (filter))
1043 filter = Qinternal_default_process_filter;
1044
1045 if (p->infd >= 0)
1046 {
1047 if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1048 {
1049 FD_CLR (p->infd, &input_wait_mask);
1050 FD_CLR (p->infd, &non_keyboard_wait_mask);
1051 }
1052 else if (EQ (p->filter, Qt)
1053 /* Network or serial process not stopped: */
1054 && !EQ (p->command, Qt))
1055 {
1056 FD_SET (p->infd, &input_wait_mask);
1057 FD_SET (p->infd, &non_keyboard_wait_mask);
1058 }
1059 }
1060
1061 pset_filter (p, filter);
1062 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1063 pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1064 setup_process_coding_systems (process);
1065 return filter;
1066 }
1067
1068 DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1069 1, 1, 0,
1070 doc: /* Return the filter function of PROCESS.
1071 See `set-process-filter' for more info on filter functions. */)
1072 (register Lisp_Object process)
1073 {
1074 CHECK_PROCESS (process);
1075 return XPROCESS (process)->filter;
1076 }
1077
1078 DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1079 2, 2, 0,
1080 doc: /* Give PROCESS the sentinel SENTINEL; nil for default.
1081 The sentinel is called as a function when the process changes state.
1082 It gets two arguments: the process, and a string describing the change. */)
1083 (register Lisp_Object process, Lisp_Object sentinel)
1084 {
1085 struct Lisp_Process *p;
1086
1087 CHECK_PROCESS (process);
1088 p = XPROCESS (process);
1089
1090 if (NILP (sentinel))
1091 sentinel = Qinternal_default_process_sentinel;
1092
1093 pset_sentinel (p, sentinel);
1094 if (NETCONN1_P (p) || SERIALCONN1_P (p))
1095 pset_childp (p, Fplist_put (p->childp, QCsentinel, sentinel));
1096 return sentinel;
1097 }
1098
1099 DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1100 1, 1, 0,
1101 doc: /* Return the sentinel of PROCESS.
1102 See `set-process-sentinel' for more info on sentinels. */)
1103 (register Lisp_Object process)
1104 {
1105 CHECK_PROCESS (process);
1106 return XPROCESS (process)->sentinel;
1107 }
1108
1109 DEFUN ("set-process-window-size", Fset_process_window_size,
1110 Sset_process_window_size, 3, 3, 0,
1111 doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH. */)
1112 (Lisp_Object process, Lisp_Object height, Lisp_Object width)
1113 {
1114 CHECK_PROCESS (process);
1115
1116 /* All known platforms store window sizes as 'unsigned short'. */
1117 CHECK_RANGED_INTEGER (height, 0, USHRT_MAX);
1118 CHECK_RANGED_INTEGER (width, 0, USHRT_MAX);
1119
1120 if (XPROCESS (process)->infd < 0
1121 || (set_window_size (XPROCESS (process)->infd,
1122 XINT (height), XINT (width))
1123 < 0))
1124 return Qnil;
1125 else
1126 return Qt;
1127 }
1128
1129 DEFUN ("set-process-inherit-coding-system-flag",
1130 Fset_process_inherit_coding_system_flag,
1131 Sset_process_inherit_coding_system_flag, 2, 2, 0,
1132 doc: /* Determine whether buffer of PROCESS will inherit coding-system.
1133 If the second argument FLAG is non-nil, then the variable
1134 `buffer-file-coding-system' of the buffer associated with PROCESS
1135 will be bound to the value of the coding system used to decode
1136 the process output.
1137
1138 This is useful when the coding system specified for the process buffer
1139 leaves either the character code conversion or the end-of-line conversion
1140 unspecified, or if the coding system used to decode the process output
1141 is more appropriate for saving the process buffer.
1142
1143 Binding the variable `inherit-process-coding-system' to non-nil before
1144 starting the process is an alternative way of setting the inherit flag
1145 for the process which will run.
1146
1147 This function returns FLAG. */)
1148 (register Lisp_Object process, Lisp_Object flag)
1149 {
1150 CHECK_PROCESS (process);
1151 XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1152 return flag;
1153 }
1154
1155 DEFUN ("set-process-query-on-exit-flag",
1156 Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
1157 2, 2, 0,
1158 doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1159 If the second argument FLAG is non-nil, Emacs will query the user before
1160 exiting or killing a buffer if PROCESS is running. This function
1161 returns FLAG. */)
1162 (register Lisp_Object process, Lisp_Object flag)
1163 {
1164 CHECK_PROCESS (process);
1165 XPROCESS (process)->kill_without_query = NILP (flag);
1166 return flag;
1167 }
1168
1169 DEFUN ("process-query-on-exit-flag",
1170 Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1171 1, 1, 0,
1172 doc: /* Return the current value of query-on-exit flag for PROCESS. */)
1173 (register Lisp_Object process)
1174 {
1175 CHECK_PROCESS (process);
1176 return (XPROCESS (process)->kill_without_query ? Qnil : Qt);
1177 }
1178
1179 DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1180 1, 2, 0,
1181 doc: /* Return the contact info of PROCESS; t for a real child.
1182 For a network or serial connection, the value depends on the optional
1183 KEY arg. If KEY is nil, value is a cons cell of the form (HOST
1184 SERVICE) for a network connection or (PORT SPEED) for a serial
1185 connection. If KEY is t, the complete contact information for the
1186 connection is returned, else the specific value for the keyword KEY is
1187 returned. See `make-network-process' or `make-serial-process' for a
1188 list of keywords. */)
1189 (register Lisp_Object process, Lisp_Object key)
1190 {
1191 Lisp_Object contact;
1192
1193 CHECK_PROCESS (process);
1194 contact = XPROCESS (process)->childp;
1195
1196 #ifdef DATAGRAM_SOCKETS
1197 if (DATAGRAM_CONN_P (process)
1198 && (EQ (key, Qt) || EQ (key, QCremote)))
1199 contact = Fplist_put (contact, QCremote,
1200 Fprocess_datagram_address (process));
1201 #endif
1202
1203 if ((!NETCONN_P (process) && !SERIALCONN_P (process)) || EQ (key, Qt))
1204 return contact;
1205 if (NILP (key) && NETCONN_P (process))
1206 return list2 (Fplist_get (contact, QChost),
1207 Fplist_get (contact, QCservice));
1208 if (NILP (key) && SERIALCONN_P (process))
1209 return list2 (Fplist_get (contact, QCport),
1210 Fplist_get (contact, QCspeed));
1211 return Fplist_get (contact, key);
1212 }
1213
1214 DEFUN ("process-plist", Fprocess_plist, Sprocess_plist,
1215 1, 1, 0,
1216 doc: /* Return the plist of PROCESS. */)
1217 (register Lisp_Object process)
1218 {
1219 CHECK_PROCESS (process);
1220 return XPROCESS (process)->plist;
1221 }
1222
1223 DEFUN ("set-process-plist", Fset_process_plist, Sset_process_plist,
1224 2, 2, 0,
1225 doc: /* Replace the plist of PROCESS with PLIST. Returns PLIST. */)
1226 (register Lisp_Object process, Lisp_Object plist)
1227 {
1228 CHECK_PROCESS (process);
1229 CHECK_LIST (plist);
1230
1231 pset_plist (XPROCESS (process), plist);
1232 return plist;
1233 }
1234
1235 #if 0 /* Turned off because we don't currently record this info
1236 in the process. Perhaps add it. */
1237 DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
1238 doc: /* Return the connection type of PROCESS.
1239 The value is nil for a pipe, t or `pty' for a pty, or `stream' for
1240 a socket connection. */)
1241 (Lisp_Object process)
1242 {
1243 return XPROCESS (process)->type;
1244 }
1245 #endif
1246
1247 DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1248 doc: /* Return the connection type of PROCESS.
1249 The value is either the symbol `real', `network', or `serial'.
1250 PROCESS may be a process, a buffer, the name of a process or buffer, or
1251 nil, indicating the current buffer's process. */)
1252 (Lisp_Object process)
1253 {
1254 Lisp_Object proc;
1255 proc = get_process (process);
1256 return XPROCESS (proc)->type;
1257 }
1258
1259 DEFUN ("format-network-address", Fformat_network_address, Sformat_network_address,
1260 1, 2, 0,
1261 doc: /* Convert network ADDRESS from internal format to a string.
1262 A 4 or 5 element vector represents an IPv4 address (with port number).
1263 An 8 or 9 element vector represents an IPv6 address (with port number).
1264 If optional second argument OMIT-PORT is non-nil, don't include a port
1265 number in the string, even when present in ADDRESS.
1266 Returns nil if format of ADDRESS is invalid. */)
1267 (Lisp_Object address, Lisp_Object omit_port)
1268 {
1269 if (NILP (address))
1270 return Qnil;
1271
1272 if (STRINGP (address)) /* AF_LOCAL */
1273 return address;
1274
1275 if (VECTORP (address)) /* AF_INET or AF_INET6 */
1276 {
1277 register struct Lisp_Vector *p = XVECTOR (address);
1278 ptrdiff_t size = p->header.size;
1279 Lisp_Object args[10];
1280 int nargs, i;
1281 char const *format;
1282
1283 if (size == 4 || (size == 5 && !NILP (omit_port)))
1284 {
1285 format = "%d.%d.%d.%d";
1286 nargs = 4;
1287 }
1288 else if (size == 5)
1289 {
1290 format = "%d.%d.%d.%d:%d";
1291 nargs = 5;
1292 }
1293 else if (size == 8 || (size == 9 && !NILP (omit_port)))
1294 {
1295 format = "%x:%x:%x:%x:%x:%x:%x:%x";
1296 nargs = 8;
1297 }
1298 else if (size == 9)
1299 {
1300 format = "[%x:%x:%x:%x:%x:%x:%x:%x]:%d";
1301 nargs = 9;
1302 }
1303 else
1304 return Qnil;
1305
1306 AUTO_STRING (format_obj, format);
1307 args[0] = format_obj;
1308
1309 for (i = 0; i < nargs; i++)
1310 {
1311 if (! RANGED_INTEGERP (0, p->contents[i], 65535))
1312 return Qnil;
1313
1314 if (nargs <= 5 /* IPv4 */
1315 && i < 4 /* host, not port */
1316 && XINT (p->contents[i]) > 255)
1317 return Qnil;
1318
1319 args[i + 1] = p->contents[i];
1320 }
1321
1322 return Fformat (nargs + 1, args);
1323 }
1324
1325 if (CONSP (address))
1326 {
1327 AUTO_STRING (format, "<Family %d>");
1328 return Fformat (2, (Lisp_Object []) {format, Fcar (address)});
1329 }
1330
1331 return Qnil;
1332 }
1333
1334 DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1335 doc: /* Return a list of all processes that are Emacs sub-processes. */)
1336 (void)
1337 {
1338 return Fmapcar (Qcdr, Vprocess_alist);
1339 }
1340 \f
1341 /* Starting asynchronous inferior processes. */
1342
1343 static void start_process_unwind (Lisp_Object proc);
1344
1345 DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1346 doc: /* Start a program in a subprocess. Return the process object for it.
1347 NAME is name for process. It is modified if necessary to make it unique.
1348 BUFFER is the buffer (or buffer name) to associate with the process.
1349
1350 Process output (both standard output and standard error streams) goes
1351 at end of BUFFER, unless you specify an output stream or filter
1352 function to handle the output. BUFFER may also be nil, meaning that
1353 this process is not associated with any buffer.
1354
1355 PROGRAM is the program file name. It is searched for in `exec-path'
1356 (which see). If nil, just associate a pty with the buffer. Remaining
1357 arguments are strings to give program as arguments.
1358
1359 If you want to separate standard output from standard error, invoke
1360 the command through a shell and redirect one of them using the shell
1361 syntax.
1362
1363 usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS) */)
1364 (ptrdiff_t nargs, Lisp_Object *args)
1365 {
1366 Lisp_Object buffer, name, program, proc, current_dir, tem;
1367 unsigned char **new_argv;
1368 ptrdiff_t i;
1369 ptrdiff_t count = SPECPDL_INDEX ();
1370 USE_SAFE_ALLOCA;
1371
1372 buffer = args[1];
1373 if (!NILP (buffer))
1374 buffer = Fget_buffer_create (buffer);
1375
1376 /* Make sure that the child will be able to chdir to the current
1377 buffer's current directory, or its unhandled equivalent. We
1378 can't just have the child check for an error when it does the
1379 chdir, since it's in a vfork.
1380
1381 We have to GCPRO around this because Fexpand_file_name and
1382 Funhandled_file_name_directory might call a file name handling
1383 function. The argument list is protected by the caller, so all
1384 we really have to worry about is buffer. */
1385 {
1386 struct gcpro gcpro1;
1387 GCPRO1 (buffer);
1388 current_dir = encode_current_directory ();
1389 UNGCPRO;
1390 }
1391
1392 name = args[0];
1393 CHECK_STRING (name);
1394
1395 program = args[2];
1396
1397 if (!NILP (program))
1398 CHECK_STRING (program);
1399
1400 proc = make_process (name);
1401 /* If an error occurs and we can't start the process, we want to
1402 remove it from the process list. This means that each error
1403 check in create_process doesn't need to call remove_process
1404 itself; it's all taken care of here. */
1405 record_unwind_protect (start_process_unwind, proc);
1406
1407 pset_childp (XPROCESS (proc), Qt);
1408 pset_plist (XPROCESS (proc), Qnil);
1409 pset_type (XPROCESS (proc), Qreal);
1410 pset_buffer (XPROCESS (proc), buffer);
1411 pset_sentinel (XPROCESS (proc), Qinternal_default_process_sentinel);
1412 pset_filter (XPROCESS (proc), Qinternal_default_process_filter);
1413 pset_command (XPROCESS (proc), Flist (nargs - 2, args + 2));
1414
1415 #ifdef HAVE_GNUTLS
1416 /* AKA GNUTLS_INITSTAGE(proc). */
1417 XPROCESS (proc)->gnutls_initstage = GNUTLS_STAGE_EMPTY;
1418 pset_gnutls_cred_type (XPROCESS (proc), Qnil);
1419 #endif
1420
1421 #ifdef ADAPTIVE_READ_BUFFERING
1422 XPROCESS (proc)->adaptive_read_buffering
1423 = (NILP (Vprocess_adaptive_read_buffering) ? 0
1424 : EQ (Vprocess_adaptive_read_buffering, Qt) ? 1 : 2);
1425 #endif
1426
1427 /* Make the process marker point into the process buffer (if any). */
1428 if (BUFFERP (buffer))
1429 set_marker_both (XPROCESS (proc)->mark, buffer,
1430 BUF_ZV (XBUFFER (buffer)),
1431 BUF_ZV_BYTE (XBUFFER (buffer)));
1432
1433 {
1434 /* Decide coding systems for communicating with the process. Here
1435 we don't setup the structure coding_system nor pay attention to
1436 unibyte mode. They are done in create_process. */
1437
1438 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1439 Lisp_Object coding_systems = Qt;
1440 Lisp_Object val, *args2;
1441 struct gcpro gcpro1, gcpro2;
1442
1443 val = Vcoding_system_for_read;
1444 if (NILP (val))
1445 {
1446 SAFE_ALLOCA_LISP (args2, nargs + 1);
1447 args2[0] = Qstart_process;
1448 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1449 GCPRO2 (proc, current_dir);
1450 if (!NILP (program))
1451 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1452 UNGCPRO;
1453 if (CONSP (coding_systems))
1454 val = XCAR (coding_systems);
1455 else if (CONSP (Vdefault_process_coding_system))
1456 val = XCAR (Vdefault_process_coding_system);
1457 }
1458 pset_decode_coding_system (XPROCESS (proc), val);
1459
1460 val = Vcoding_system_for_write;
1461 if (NILP (val))
1462 {
1463 if (EQ (coding_systems, Qt))
1464 {
1465 SAFE_ALLOCA_LISP (args2, nargs + 1);
1466 args2[0] = Qstart_process;
1467 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1468 GCPRO2 (proc, current_dir);
1469 if (!NILP (program))
1470 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1471 UNGCPRO;
1472 }
1473 if (CONSP (coding_systems))
1474 val = XCDR (coding_systems);
1475 else if (CONSP (Vdefault_process_coding_system))
1476 val = XCDR (Vdefault_process_coding_system);
1477 }
1478 pset_encode_coding_system (XPROCESS (proc), val);
1479 /* Note: At this moment, the above coding system may leave
1480 text-conversion or eol-conversion unspecified. They will be
1481 decided after we read output from the process and decode it by
1482 some coding system, or just before we actually send a text to
1483 the process. */
1484 }
1485
1486
1487 pset_decoding_buf (XPROCESS (proc), empty_unibyte_string);
1488 XPROCESS (proc)->decoding_carryover = 0;
1489 pset_encoding_buf (XPROCESS (proc), empty_unibyte_string);
1490
1491 XPROCESS (proc)->inherit_coding_system_flag
1492 = !(NILP (buffer) || !inherit_process_coding_system);
1493
1494 if (!NILP (program))
1495 {
1496 /* If program file name is not absolute, search our path for it.
1497 Put the name we will really use in TEM. */
1498 if (!IS_DIRECTORY_SEP (SREF (program, 0))
1499 && !(SCHARS (program) > 1
1500 && IS_DEVICE_SEP (SREF (program, 1))))
1501 {
1502 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1503
1504 tem = Qnil;
1505 GCPRO4 (name, program, buffer, current_dir);
1506 openp (Vexec_path, program, Vexec_suffixes, &tem,
1507 make_number (X_OK), false);
1508 UNGCPRO;
1509 if (NILP (tem))
1510 report_file_error ("Searching for program", program);
1511 tem = Fexpand_file_name (tem, Qnil);
1512 }
1513 else
1514 {
1515 if (!NILP (Ffile_directory_p (program)))
1516 error ("Specified program for new process is a directory");
1517 tem = program;
1518 }
1519
1520 /* If program file name starts with /: for quoting a magic name,
1521 discard that. */
1522 if (SBYTES (tem) > 2 && SREF (tem, 0) == '/'
1523 && SREF (tem, 1) == ':')
1524 tem = Fsubstring (tem, make_number (2), Qnil);
1525
1526 {
1527 Lisp_Object arg_encoding = Qnil;
1528 struct gcpro gcpro1;
1529 GCPRO1 (tem);
1530
1531 /* Encode the file name and put it in NEW_ARGV.
1532 That's where the child will use it to execute the program. */
1533 tem = list1 (ENCODE_FILE (tem));
1534
1535 /* Here we encode arguments by the coding system used for sending
1536 data to the process. We don't support using different coding
1537 systems for encoding arguments and for encoding data sent to the
1538 process. */
1539
1540 for (i = 3; i < nargs; i++)
1541 {
1542 tem = Fcons (args[i], tem);
1543 CHECK_STRING (XCAR (tem));
1544 if (STRING_MULTIBYTE (XCAR (tem)))
1545 {
1546 if (NILP (arg_encoding))
1547 arg_encoding = (complement_process_encoding_system
1548 (XPROCESS (proc)->encode_coding_system));
1549 XSETCAR (tem,
1550 code_convert_string_norecord
1551 (XCAR (tem), arg_encoding, 1));
1552 }
1553 }
1554
1555 UNGCPRO;
1556 }
1557
1558 /* Now that everything is encoded we can collect the strings into
1559 NEW_ARGV. */
1560 SAFE_NALLOCA (new_argv, 1, nargs - 1);
1561 new_argv[nargs - 2] = 0;
1562
1563 for (i = nargs - 2; i-- != 0; )
1564 {
1565 new_argv[i] = SDATA (XCAR (tem));
1566 tem = XCDR (tem);
1567 }
1568
1569 create_process (proc, (char **) new_argv, current_dir);
1570 }
1571 else
1572 create_pty (proc);
1573
1574 SAFE_FREE ();
1575 return unbind_to (count, proc);
1576 }
1577
1578 /* This function is the unwind_protect form for Fstart_process. If
1579 PROC doesn't have its pid set, then we know someone has signaled
1580 an error and the process wasn't started successfully, so we should
1581 remove it from the process list. */
1582 static void
1583 start_process_unwind (Lisp_Object proc)
1584 {
1585 if (!PROCESSP (proc))
1586 emacs_abort ();
1587
1588 /* Was PROC started successfully?
1589 -2 is used for a pty with no process, eg for gdb. */
1590 if (XPROCESS (proc)->pid <= 0 && XPROCESS (proc)->pid != -2)
1591 remove_process (proc);
1592 }
1593
1594 /* If *FD_ADDR is nonnegative, close it, and mark it as closed. */
1595
1596 static void
1597 close_process_fd (int *fd_addr)
1598 {
1599 int fd = *fd_addr;
1600 if (0 <= fd)
1601 {
1602 *fd_addr = -1;
1603 emacs_close (fd);
1604 }
1605 }
1606
1607 /* Indexes of file descriptors in open_fds. */
1608 enum
1609 {
1610 /* The pipe from Emacs to its subprocess. */
1611 SUBPROCESS_STDIN,
1612 WRITE_TO_SUBPROCESS,
1613
1614 /* The main pipe from the subprocess to Emacs. */
1615 READ_FROM_SUBPROCESS,
1616 SUBPROCESS_STDOUT,
1617
1618 /* The pipe from the subprocess to Emacs that is closed when the
1619 subprocess execs. */
1620 READ_FROM_EXEC_MONITOR,
1621 EXEC_MONITOR_OUTPUT
1622 };
1623
1624 verify (PROCESS_OPEN_FDS == EXEC_MONITOR_OUTPUT + 1);
1625
1626 static void
1627 create_process (Lisp_Object process, char **new_argv, Lisp_Object current_dir)
1628 {
1629 struct Lisp_Process *p = XPROCESS (process);
1630 int inchannel, outchannel;
1631 pid_t pid;
1632 int vfork_errno;
1633 int forkin, forkout;
1634 bool pty_flag = 0;
1635 char pty_name[PTY_NAME_SIZE];
1636 Lisp_Object lisp_pty_name = Qnil;
1637 sigset_t oldset;
1638
1639 inchannel = outchannel = -1;
1640
1641 if (!NILP (Vprocess_connection_type))
1642 outchannel = inchannel = allocate_pty (pty_name);
1643
1644 if (inchannel >= 0)
1645 {
1646 p->open_fd[READ_FROM_SUBPROCESS] = inchannel;
1647 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1648 /* On most USG systems it does not work to open the pty's tty here,
1649 then close it and reopen it in the child. */
1650 /* Don't let this terminal become our controlling terminal
1651 (in case we don't have one). */
1652 forkout = forkin = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1653 if (forkin < 0)
1654 report_file_error ("Opening pty", Qnil);
1655 p->open_fd[SUBPROCESS_STDIN] = forkin;
1656 #else
1657 forkin = forkout = -1;
1658 #endif /* not USG, or USG_SUBTTY_WORKS */
1659 pty_flag = 1;
1660 lisp_pty_name = build_string (pty_name);
1661 }
1662 else
1663 {
1664 if (emacs_pipe (p->open_fd + SUBPROCESS_STDIN) != 0
1665 || emacs_pipe (p->open_fd + READ_FROM_SUBPROCESS) != 0)
1666 report_file_error ("Creating pipe", Qnil);
1667 forkin = p->open_fd[SUBPROCESS_STDIN];
1668 outchannel = p->open_fd[WRITE_TO_SUBPROCESS];
1669 inchannel = p->open_fd[READ_FROM_SUBPROCESS];
1670 forkout = p->open_fd[SUBPROCESS_STDOUT];
1671 }
1672
1673 #ifndef WINDOWSNT
1674 if (emacs_pipe (p->open_fd + READ_FROM_EXEC_MONITOR) != 0)
1675 report_file_error ("Creating pipe", Qnil);
1676 #endif
1677
1678 fcntl (inchannel, F_SETFL, O_NONBLOCK);
1679 fcntl (outchannel, F_SETFL, O_NONBLOCK);
1680
1681 /* Record this as an active process, with its channels. */
1682 chan_process[inchannel] = process;
1683 p->infd = inchannel;
1684 p->outfd = outchannel;
1685
1686 /* Previously we recorded the tty descriptor used in the subprocess.
1687 It was only used for getting the foreground tty process, so now
1688 we just reopen the device (see emacs_get_tty_pgrp) as this is
1689 more portable (see USG_SUBTTY_WORKS above). */
1690
1691 p->pty_flag = pty_flag;
1692 pset_status (p, Qrun);
1693
1694 FD_SET (inchannel, &input_wait_mask);
1695 FD_SET (inchannel, &non_keyboard_wait_mask);
1696 if (inchannel > max_process_desc)
1697 max_process_desc = inchannel;
1698
1699 /* This may signal an error. */
1700 setup_process_coding_systems (process);
1701
1702 block_input ();
1703 block_child_signal (&oldset);
1704
1705 #ifndef WINDOWSNT
1706 /* vfork, and prevent local vars from being clobbered by the vfork. */
1707 {
1708 Lisp_Object volatile current_dir_volatile = current_dir;
1709 Lisp_Object volatile lisp_pty_name_volatile = lisp_pty_name;
1710 char **volatile new_argv_volatile = new_argv;
1711 int volatile forkin_volatile = forkin;
1712 int volatile forkout_volatile = forkout;
1713 struct Lisp_Process *p_volatile = p;
1714
1715 pid = vfork ();
1716
1717 current_dir = current_dir_volatile;
1718 lisp_pty_name = lisp_pty_name_volatile;
1719 new_argv = new_argv_volatile;
1720 forkin = forkin_volatile;
1721 forkout = forkout_volatile;
1722 p = p_volatile;
1723
1724 pty_flag = p->pty_flag;
1725 }
1726
1727 if (pid == 0)
1728 #endif /* not WINDOWSNT */
1729 {
1730 int xforkin = forkin;
1731 int xforkout = forkout;
1732
1733 /* Make the pty be the controlling terminal of the process. */
1734 #ifdef HAVE_PTYS
1735 /* First, disconnect its current controlling terminal. */
1736 /* We tried doing setsid only if pty_flag, but it caused
1737 process_set_signal to fail on SGI when using a pipe. */
1738 setsid ();
1739 /* Make the pty's terminal the controlling terminal. */
1740 if (pty_flag && xforkin >= 0)
1741 {
1742 #ifdef TIOCSCTTY
1743 /* We ignore the return value
1744 because faith@cs.unc.edu says that is necessary on Linux. */
1745 ioctl (xforkin, TIOCSCTTY, 0);
1746 #endif
1747 }
1748 #if defined (LDISC1)
1749 if (pty_flag && xforkin >= 0)
1750 {
1751 struct termios t;
1752 tcgetattr (xforkin, &t);
1753 t.c_lflag = LDISC1;
1754 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
1755 emacs_perror ("create_process/tcsetattr LDISC1");
1756 }
1757 #else
1758 #if defined (NTTYDISC) && defined (TIOCSETD)
1759 if (pty_flag && xforkin >= 0)
1760 {
1761 /* Use new line discipline. */
1762 int ldisc = NTTYDISC;
1763 ioctl (xforkin, TIOCSETD, &ldisc);
1764 }
1765 #endif
1766 #endif
1767 #ifdef TIOCNOTTY
1768 /* In 4.3BSD, the TIOCSPGRP bug has been fixed, and now you
1769 can do TIOCSPGRP only to the process's controlling tty. */
1770 if (pty_flag)
1771 {
1772 /* I wonder: would just ioctl (0, TIOCNOTTY, 0) work here?
1773 I can't test it since I don't have 4.3. */
1774 int j = emacs_open ("/dev/tty", O_RDWR, 0);
1775 if (j >= 0)
1776 {
1777 ioctl (j, TIOCNOTTY, 0);
1778 emacs_close (j);
1779 }
1780 }
1781 #endif /* TIOCNOTTY */
1782
1783 #if !defined (DONT_REOPEN_PTY)
1784 /*** There is a suggestion that this ought to be a
1785 conditional on TIOCSPGRP, or !defined TIOCSCTTY.
1786 Trying the latter gave the wrong results on Debian GNU/Linux 1.1;
1787 that system does seem to need this code, even though
1788 both TIOCSCTTY is defined. */
1789 /* Now close the pty (if we had it open) and reopen it.
1790 This makes the pty the controlling terminal of the subprocess. */
1791 if (pty_flag)
1792 {
1793
1794 /* I wonder if emacs_close (emacs_open (SSDATA (lisp_pty_name), ...))
1795 would work? */
1796 if (xforkin >= 0)
1797 emacs_close (xforkin);
1798 xforkout = xforkin = emacs_open (SSDATA (lisp_pty_name), O_RDWR, 0);
1799
1800 if (xforkin < 0)
1801 {
1802 emacs_perror (SSDATA (lisp_pty_name));
1803 _exit (EXIT_CANCELED);
1804 }
1805
1806 }
1807 #endif /* not DONT_REOPEN_PTY */
1808
1809 #ifdef SETUP_SLAVE_PTY
1810 if (pty_flag)
1811 {
1812 SETUP_SLAVE_PTY;
1813 }
1814 #endif /* SETUP_SLAVE_PTY */
1815 #endif /* HAVE_PTYS */
1816
1817 signal (SIGINT, SIG_DFL);
1818 signal (SIGQUIT, SIG_DFL);
1819 #ifdef SIGPROF
1820 signal (SIGPROF, SIG_DFL);
1821 #endif
1822
1823 /* Emacs ignores SIGPIPE, but the child should not. */
1824 signal (SIGPIPE, SIG_DFL);
1825
1826 /* Stop blocking SIGCHLD in the child. */
1827 unblock_child_signal (&oldset);
1828
1829 if (pty_flag)
1830 child_setup_tty (xforkout);
1831 #ifdef WINDOWSNT
1832 pid = child_setup (xforkin, xforkout, xforkout, new_argv, 1, current_dir);
1833 #else /* not WINDOWSNT */
1834 child_setup (xforkin, xforkout, xforkout, new_argv, 1, current_dir);
1835 #endif /* not WINDOWSNT */
1836 }
1837
1838 /* Back in the parent process. */
1839
1840 vfork_errno = errno;
1841 p->pid = pid;
1842 if (pid >= 0)
1843 p->alive = 1;
1844
1845 /* Stop blocking in the parent. */
1846 unblock_child_signal (&oldset);
1847 unblock_input ();
1848
1849 if (pid < 0)
1850 report_file_errno ("Doing vfork", Qnil, vfork_errno);
1851 else
1852 {
1853 /* vfork succeeded. */
1854
1855 /* Close the pipe ends that the child uses, or the child's pty. */
1856 close_process_fd (&p->open_fd[SUBPROCESS_STDIN]);
1857 close_process_fd (&p->open_fd[SUBPROCESS_STDOUT]);
1858
1859 #ifdef WINDOWSNT
1860 register_child (pid, inchannel);
1861 #endif /* WINDOWSNT */
1862
1863 pset_tty_name (p, lisp_pty_name);
1864
1865 #ifndef WINDOWSNT
1866 /* Wait for child_setup to complete in case that vfork is
1867 actually defined as fork. The descriptor
1868 XPROCESS (proc)->open_fd[EXEC_MONITOR_OUTPUT]
1869 of a pipe is closed at the child side either by close-on-exec
1870 on successful execve or the _exit call in child_setup. */
1871 {
1872 char dummy;
1873
1874 close_process_fd (&p->open_fd[EXEC_MONITOR_OUTPUT]);
1875 emacs_read (p->open_fd[READ_FROM_EXEC_MONITOR], &dummy, 1);
1876 close_process_fd (&p->open_fd[READ_FROM_EXEC_MONITOR]);
1877 }
1878 #endif
1879 }
1880 }
1881
1882 static void
1883 create_pty (Lisp_Object process)
1884 {
1885 struct Lisp_Process *p = XPROCESS (process);
1886 char pty_name[PTY_NAME_SIZE];
1887 int pty_fd = NILP (Vprocess_connection_type) ? -1 : allocate_pty (pty_name);
1888
1889 if (pty_fd >= 0)
1890 {
1891 p->open_fd[SUBPROCESS_STDIN] = pty_fd;
1892 #if ! defined (USG) || defined (USG_SUBTTY_WORKS)
1893 /* On most USG systems it does not work to open the pty's tty here,
1894 then close it and reopen it in the child. */
1895 /* Don't let this terminal become our controlling terminal
1896 (in case we don't have one). */
1897 int forkout = emacs_open (pty_name, O_RDWR | O_NOCTTY, 0);
1898 if (forkout < 0)
1899 report_file_error ("Opening pty", Qnil);
1900 p->open_fd[WRITE_TO_SUBPROCESS] = forkout;
1901 #if defined (DONT_REOPEN_PTY)
1902 /* In the case that vfork is defined as fork, the parent process
1903 (Emacs) may send some data before the child process completes
1904 tty options setup. So we setup tty before forking. */
1905 child_setup_tty (forkout);
1906 #endif /* DONT_REOPEN_PTY */
1907 #endif /* not USG, or USG_SUBTTY_WORKS */
1908
1909 fcntl (pty_fd, F_SETFL, O_NONBLOCK);
1910
1911 /* Record this as an active process, with its channels.
1912 As a result, child_setup will close Emacs's side of the pipes. */
1913 chan_process[pty_fd] = process;
1914 p->infd = pty_fd;
1915 p->outfd = pty_fd;
1916
1917 /* Previously we recorded the tty descriptor used in the subprocess.
1918 It was only used for getting the foreground tty process, so now
1919 we just reopen the device (see emacs_get_tty_pgrp) as this is
1920 more portable (see USG_SUBTTY_WORKS above). */
1921
1922 p->pty_flag = 1;
1923 pset_status (p, Qrun);
1924 setup_process_coding_systems (process);
1925
1926 FD_SET (pty_fd, &input_wait_mask);
1927 FD_SET (pty_fd, &non_keyboard_wait_mask);
1928 if (pty_fd > max_process_desc)
1929 max_process_desc = pty_fd;
1930
1931 pset_tty_name (p, build_string (pty_name));
1932 }
1933
1934 p->pid = -2;
1935 }
1936
1937 \f
1938 /* Convert an internal struct sockaddr to a lisp object (vector or string).
1939 The address family of sa is not included in the result. */
1940
1941 Lisp_Object
1942 conv_sockaddr_to_lisp (struct sockaddr *sa, int len)
1943 {
1944 Lisp_Object address;
1945 int i;
1946 unsigned char *cp;
1947 register struct Lisp_Vector *p;
1948
1949 /* Workaround for a bug in getsockname on BSD: Names bound to
1950 sockets in the UNIX domain are inaccessible; getsockname returns
1951 a zero length name. */
1952 if (len < offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family))
1953 return empty_unibyte_string;
1954
1955 switch (sa->sa_family)
1956 {
1957 case AF_INET:
1958 {
1959 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
1960 len = sizeof (sin->sin_addr) + 1;
1961 address = Fmake_vector (make_number (len), Qnil);
1962 p = XVECTOR (address);
1963 p->contents[--len] = make_number (ntohs (sin->sin_port));
1964 cp = (unsigned char *) &sin->sin_addr;
1965 break;
1966 }
1967 #ifdef AF_INET6
1968 case AF_INET6:
1969 {
1970 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
1971 uint16_t *ip6 = (uint16_t *) &sin6->sin6_addr;
1972 len = sizeof (sin6->sin6_addr) / 2 + 1;
1973 address = Fmake_vector (make_number (len), Qnil);
1974 p = XVECTOR (address);
1975 p->contents[--len] = make_number (ntohs (sin6->sin6_port));
1976 for (i = 0; i < len; i++)
1977 p->contents[i] = make_number (ntohs (ip6[i]));
1978 return address;
1979 }
1980 #endif
1981 #ifdef HAVE_LOCAL_SOCKETS
1982 case AF_LOCAL:
1983 {
1984 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
1985 ptrdiff_t name_length = len - offsetof (struct sockaddr_un, sun_path);
1986 /* If the first byte is NUL, the name is a Linux abstract
1987 socket name, and the name can contain embedded NULs. If
1988 it's not, we have a NUL-terminated string. Be careful not
1989 to walk past the end of the object looking for the name
1990 terminator, however. */
1991 if (name_length > 0 && sockun->sun_path[0] != '\0')
1992 {
1993 const char *terminator
1994 = memchr (sockun->sun_path, '\0', name_length);
1995
1996 if (terminator)
1997 name_length = terminator - (const char *) sockun->sun_path;
1998 }
1999
2000 return make_unibyte_string (sockun->sun_path, name_length);
2001 }
2002 #endif
2003 default:
2004 len -= offsetof (struct sockaddr, sa_family) + sizeof (sa->sa_family);
2005 address = Fcons (make_number (sa->sa_family),
2006 Fmake_vector (make_number (len), Qnil));
2007 p = XVECTOR (XCDR (address));
2008 cp = (unsigned char *) &sa->sa_family + sizeof (sa->sa_family);
2009 break;
2010 }
2011
2012 i = 0;
2013 while (i < len)
2014 p->contents[i++] = make_number (*cp++);
2015
2016 return address;
2017 }
2018
2019
2020 /* Get family and required size for sockaddr structure to hold ADDRESS. */
2021
2022 static int
2023 get_lisp_to_sockaddr_size (Lisp_Object address, int *familyp)
2024 {
2025 register struct Lisp_Vector *p;
2026
2027 if (VECTORP (address))
2028 {
2029 p = XVECTOR (address);
2030 if (p->header.size == 5)
2031 {
2032 *familyp = AF_INET;
2033 return sizeof (struct sockaddr_in);
2034 }
2035 #ifdef AF_INET6
2036 else if (p->header.size == 9)
2037 {
2038 *familyp = AF_INET6;
2039 return sizeof (struct sockaddr_in6);
2040 }
2041 #endif
2042 }
2043 #ifdef HAVE_LOCAL_SOCKETS
2044 else if (STRINGP (address))
2045 {
2046 *familyp = AF_LOCAL;
2047 return sizeof (struct sockaddr_un);
2048 }
2049 #endif
2050 else if (CONSP (address) && TYPE_RANGED_INTEGERP (int, XCAR (address))
2051 && VECTORP (XCDR (address)))
2052 {
2053 struct sockaddr *sa;
2054 p = XVECTOR (XCDR (address));
2055 if (MAX_ALLOCA - sizeof sa->sa_family < p->header.size)
2056 return 0;
2057 *familyp = XINT (XCAR (address));
2058 return p->header.size + sizeof (sa->sa_family);
2059 }
2060 return 0;
2061 }
2062
2063 /* Convert an address object (vector or string) to an internal sockaddr.
2064
2065 The address format has been basically validated by
2066 get_lisp_to_sockaddr_size, but this does not mean FAMILY is valid;
2067 it could have come from user data. So if FAMILY is not valid,
2068 we return after zeroing *SA. */
2069
2070 static void
2071 conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int len)
2072 {
2073 register struct Lisp_Vector *p;
2074 register unsigned char *cp = NULL;
2075 register int i;
2076 EMACS_INT hostport;
2077
2078 memset (sa, 0, len);
2079
2080 if (VECTORP (address))
2081 {
2082 p = XVECTOR (address);
2083 if (family == AF_INET)
2084 {
2085 struct sockaddr_in *sin = (struct sockaddr_in *) sa;
2086 len = sizeof (sin->sin_addr) + 1;
2087 hostport = XINT (p->contents[--len]);
2088 sin->sin_port = htons (hostport);
2089 cp = (unsigned char *)&sin->sin_addr;
2090 sa->sa_family = family;
2091 }
2092 #ifdef AF_INET6
2093 else if (family == AF_INET6)
2094 {
2095 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *) sa;
2096 uint16_t *ip6 = (uint16_t *)&sin6->sin6_addr;
2097 len = sizeof (sin6->sin6_addr) + 1;
2098 hostport = XINT (p->contents[--len]);
2099 sin6->sin6_port = htons (hostport);
2100 for (i = 0; i < len; i++)
2101 if (INTEGERP (p->contents[i]))
2102 {
2103 int j = XFASTINT (p->contents[i]) & 0xffff;
2104 ip6[i] = ntohs (j);
2105 }
2106 sa->sa_family = family;
2107 return;
2108 }
2109 #endif
2110 else
2111 return;
2112 }
2113 else if (STRINGP (address))
2114 {
2115 #ifdef HAVE_LOCAL_SOCKETS
2116 if (family == AF_LOCAL)
2117 {
2118 struct sockaddr_un *sockun = (struct sockaddr_un *) sa;
2119 cp = SDATA (address);
2120 for (i = 0; i < sizeof (sockun->sun_path) && *cp; i++)
2121 sockun->sun_path[i] = *cp++;
2122 sa->sa_family = family;
2123 }
2124 #endif
2125 return;
2126 }
2127 else
2128 {
2129 p = XVECTOR (XCDR (address));
2130 cp = (unsigned char *)sa + sizeof (sa->sa_family);
2131 }
2132
2133 for (i = 0; i < len; i++)
2134 if (INTEGERP (p->contents[i]))
2135 *cp++ = XFASTINT (p->contents[i]) & 0xff;
2136 }
2137
2138 #ifdef DATAGRAM_SOCKETS
2139 DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address,
2140 1, 1, 0,
2141 doc: /* Get the current datagram address associated with PROCESS. */)
2142 (Lisp_Object process)
2143 {
2144 int channel;
2145
2146 CHECK_PROCESS (process);
2147
2148 if (!DATAGRAM_CONN_P (process))
2149 return Qnil;
2150
2151 channel = XPROCESS (process)->infd;
2152 return conv_sockaddr_to_lisp (datagram_address[channel].sa,
2153 datagram_address[channel].len);
2154 }
2155
2156 DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address,
2157 2, 2, 0,
2158 doc: /* Set the datagram address for PROCESS to ADDRESS.
2159 Returns nil upon error setting address, ADDRESS otherwise. */)
2160 (Lisp_Object process, Lisp_Object address)
2161 {
2162 int channel;
2163 int family, len;
2164
2165 CHECK_PROCESS (process);
2166
2167 if (!DATAGRAM_CONN_P (process))
2168 return Qnil;
2169
2170 channel = XPROCESS (process)->infd;
2171
2172 len = get_lisp_to_sockaddr_size (address, &family);
2173 if (len == 0 || datagram_address[channel].len != len)
2174 return Qnil;
2175 conv_lisp_to_sockaddr (family, address, datagram_address[channel].sa, len);
2176 return address;
2177 }
2178 #endif
2179 \f
2180
2181 static const struct socket_options {
2182 /* The name of this option. Should be lowercase version of option
2183 name without SO_ prefix. */
2184 const char *name;
2185 /* Option level SOL_... */
2186 int optlevel;
2187 /* Option number SO_... */
2188 int optnum;
2189 enum { SOPT_UNKNOWN, SOPT_BOOL, SOPT_INT, SOPT_IFNAME, SOPT_LINGER } opttype;
2190 enum { OPIX_NONE = 0, OPIX_MISC = 1, OPIX_REUSEADDR = 2 } optbit;
2191 } socket_options[] =
2192 {
2193 #ifdef SO_BINDTODEVICE
2194 { ":bindtodevice", SOL_SOCKET, SO_BINDTODEVICE, SOPT_IFNAME, OPIX_MISC },
2195 #endif
2196 #ifdef SO_BROADCAST
2197 { ":broadcast", SOL_SOCKET, SO_BROADCAST, SOPT_BOOL, OPIX_MISC },
2198 #endif
2199 #ifdef SO_DONTROUTE
2200 { ":dontroute", SOL_SOCKET, SO_DONTROUTE, SOPT_BOOL, OPIX_MISC },
2201 #endif
2202 #ifdef SO_KEEPALIVE
2203 { ":keepalive", SOL_SOCKET, SO_KEEPALIVE, SOPT_BOOL, OPIX_MISC },
2204 #endif
2205 #ifdef SO_LINGER
2206 { ":linger", SOL_SOCKET, SO_LINGER, SOPT_LINGER, OPIX_MISC },
2207 #endif
2208 #ifdef SO_OOBINLINE
2209 { ":oobinline", SOL_SOCKET, SO_OOBINLINE, SOPT_BOOL, OPIX_MISC },
2210 #endif
2211 #ifdef SO_PRIORITY
2212 { ":priority", SOL_SOCKET, SO_PRIORITY, SOPT_INT, OPIX_MISC },
2213 #endif
2214 #ifdef SO_REUSEADDR
2215 { ":reuseaddr", SOL_SOCKET, SO_REUSEADDR, SOPT_BOOL, OPIX_REUSEADDR },
2216 #endif
2217 { 0, 0, 0, SOPT_UNKNOWN, OPIX_NONE }
2218 };
2219
2220 /* Set option OPT to value VAL on socket S.
2221
2222 Returns (1<<socket_options[OPT].optbit) if option is known, 0 otherwise.
2223 Signals an error if setting a known option fails.
2224 */
2225
2226 static int
2227 set_socket_option (int s, Lisp_Object opt, Lisp_Object val)
2228 {
2229 char *name;
2230 const struct socket_options *sopt;
2231 int ret = 0;
2232
2233 CHECK_SYMBOL (opt);
2234
2235 name = SSDATA (SYMBOL_NAME (opt));
2236 for (sopt = socket_options; sopt->name; sopt++)
2237 if (strcmp (name, sopt->name) == 0)
2238 break;
2239
2240 switch (sopt->opttype)
2241 {
2242 case SOPT_BOOL:
2243 {
2244 int optval;
2245 optval = NILP (val) ? 0 : 1;
2246 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2247 &optval, sizeof (optval));
2248 break;
2249 }
2250
2251 case SOPT_INT:
2252 {
2253 int optval;
2254 if (TYPE_RANGED_INTEGERP (int, val))
2255 optval = XINT (val);
2256 else
2257 error ("Bad option value for %s", name);
2258 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2259 &optval, sizeof (optval));
2260 break;
2261 }
2262
2263 #ifdef SO_BINDTODEVICE
2264 case SOPT_IFNAME:
2265 {
2266 char devname[IFNAMSIZ + 1];
2267
2268 /* This is broken, at least in the Linux 2.4 kernel.
2269 To unbind, the arg must be a zero integer, not the empty string.
2270 This should work on all systems. KFS. 2003-09-23. */
2271 memset (devname, 0, sizeof devname);
2272 if (STRINGP (val))
2273 {
2274 char *arg = SSDATA (val);
2275 int len = min (strlen (arg), IFNAMSIZ);
2276 memcpy (devname, arg, len);
2277 }
2278 else if (!NILP (val))
2279 error ("Bad option value for %s", name);
2280 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2281 devname, IFNAMSIZ);
2282 break;
2283 }
2284 #endif
2285
2286 #ifdef SO_LINGER
2287 case SOPT_LINGER:
2288 {
2289 struct linger linger;
2290
2291 linger.l_onoff = 1;
2292 linger.l_linger = 0;
2293 if (TYPE_RANGED_INTEGERP (int, val))
2294 linger.l_linger = XINT (val);
2295 else
2296 linger.l_onoff = NILP (val) ? 0 : 1;
2297 ret = setsockopt (s, sopt->optlevel, sopt->optnum,
2298 &linger, sizeof (linger));
2299 break;
2300 }
2301 #endif
2302
2303 default:
2304 return 0;
2305 }
2306
2307 if (ret < 0)
2308 {
2309 int setsockopt_errno = errno;
2310 report_file_errno ("Cannot set network option", list2 (opt, val),
2311 setsockopt_errno);
2312 }
2313
2314 return (1 << sopt->optbit);
2315 }
2316
2317
2318 DEFUN ("set-network-process-option",
2319 Fset_network_process_option, Sset_network_process_option,
2320 3, 4, 0,
2321 doc: /* For network process PROCESS set option OPTION to value VALUE.
2322 See `make-network-process' for a list of options and values.
2323 If optional fourth arg NO-ERROR is non-nil, don't signal an error if
2324 OPTION is not a supported option, return nil instead; otherwise return t. */)
2325 (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error)
2326 {
2327 int s;
2328 struct Lisp_Process *p;
2329
2330 CHECK_PROCESS (process);
2331 p = XPROCESS (process);
2332 if (!NETCONN1_P (p))
2333 error ("Process is not a network process");
2334
2335 s = p->infd;
2336 if (s < 0)
2337 error ("Process is not running");
2338
2339 if (set_socket_option (s, option, value))
2340 {
2341 pset_childp (p, Fplist_put (p->childp, option, value));
2342 return Qt;
2343 }
2344
2345 if (NILP (no_error))
2346 error ("Unknown or unsupported option");
2347
2348 return Qnil;
2349 }
2350
2351 \f
2352 DEFUN ("serial-process-configure",
2353 Fserial_process_configure,
2354 Sserial_process_configure,
2355 0, MANY, 0,
2356 doc: /* Configure speed, bytesize, etc. of a serial process.
2357
2358 Arguments are specified as keyword/argument pairs. Attributes that
2359 are not given are re-initialized from the process's current
2360 configuration (available via the function `process-contact') or set to
2361 reasonable default values. The following arguments are defined:
2362
2363 :process PROCESS
2364 :name NAME
2365 :buffer BUFFER
2366 :port PORT
2367 -- Any of these arguments can be given to identify the process that is
2368 to be configured. If none of these arguments is given, the current
2369 buffer's process is used.
2370
2371 :speed SPEED -- SPEED is the speed of the serial port in bits per
2372 second, also called baud rate. Any value can be given for SPEED, but
2373 most serial ports work only at a few defined values between 1200 and
2374 115200, with 9600 being the most common value. If SPEED is nil, the
2375 serial port is not configured any further, i.e., all other arguments
2376 are ignored. This may be useful for special serial ports such as
2377 Bluetooth-to-serial converters which can only be configured through AT
2378 commands. A value of nil for SPEED can be used only when passed
2379 through `make-serial-process' or `serial-term'.
2380
2381 :bytesize BYTESIZE -- BYTESIZE is the number of bits per byte, which
2382 can be 7 or 8. If BYTESIZE is not given or nil, a value of 8 is used.
2383
2384 :parity PARITY -- PARITY can be nil (don't use parity), the symbol
2385 `odd' (use odd parity), or the symbol `even' (use even parity). If
2386 PARITY is not given, no parity is used.
2387
2388 :stopbits STOPBITS -- STOPBITS is the number of stopbits used to
2389 terminate a byte transmission. STOPBITS can be 1 or 2. If STOPBITS
2390 is not given or nil, 1 stopbit is used.
2391
2392 :flowcontrol FLOWCONTROL -- FLOWCONTROL determines the type of
2393 flowcontrol to be used, which is either nil (don't use flowcontrol),
2394 the symbol `hw' (use RTS/CTS hardware flowcontrol), or the symbol `sw'
2395 \(use XON/XOFF software flowcontrol). If FLOWCONTROL is not given, no
2396 flowcontrol is used.
2397
2398 `serial-process-configure' is called by `make-serial-process' for the
2399 initial configuration of the serial port.
2400
2401 Examples:
2402
2403 \(serial-process-configure :process "/dev/ttyS0" :speed 1200)
2404
2405 \(serial-process-configure
2406 :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
2407
2408 \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
2409
2410 usage: (serial-process-configure &rest ARGS) */)
2411 (ptrdiff_t nargs, Lisp_Object *args)
2412 {
2413 struct Lisp_Process *p;
2414 Lisp_Object contact = Qnil;
2415 Lisp_Object proc = Qnil;
2416 struct gcpro gcpro1;
2417
2418 contact = Flist (nargs, args);
2419 GCPRO1 (contact);
2420
2421 proc = Fplist_get (contact, QCprocess);
2422 if (NILP (proc))
2423 proc = Fplist_get (contact, QCname);
2424 if (NILP (proc))
2425 proc = Fplist_get (contact, QCbuffer);
2426 if (NILP (proc))
2427 proc = Fplist_get (contact, QCport);
2428 proc = get_process (proc);
2429 p = XPROCESS (proc);
2430 if (!EQ (p->type, Qserial))
2431 error ("Not a serial process");
2432
2433 if (NILP (Fplist_get (p->childp, QCspeed)))
2434 {
2435 UNGCPRO;
2436 return Qnil;
2437 }
2438
2439 serial_configure (p, contact);
2440
2441 UNGCPRO;
2442 return Qnil;
2443 }
2444
2445 DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process,
2446 0, MANY, 0,
2447 doc: /* Create and return a serial port process.
2448
2449 In Emacs, serial port connections are represented by process objects,
2450 so input and output work as for subprocesses, and `delete-process'
2451 closes a serial port connection. However, a serial process has no
2452 process id, it cannot be signaled, and the status codes are different
2453 from normal processes.
2454
2455 `make-serial-process' creates a process and a buffer, on which you
2456 probably want to use `process-send-string'. Try \\[serial-term] for
2457 an interactive terminal. See below for examples.
2458
2459 Arguments are specified as keyword/argument pairs. The following
2460 arguments are defined:
2461
2462 :port PORT -- (mandatory) PORT is the path or name of the serial port.
2463 For example, this could be "/dev/ttyS0" on Unix. On Windows, this
2464 could be "COM1", or "\\\\.\\COM10" for ports higher than COM9 (double
2465 the backslashes in strings).
2466
2467 :speed SPEED -- (mandatory) is handled by `serial-process-configure',
2468 which this function calls.
2469
2470 :name NAME -- NAME is the name of the process. If NAME is not given,
2471 the value of PORT is used.
2472
2473 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2474 with the process. Process output goes at the end of that buffer,
2475 unless you specify an output stream or filter function to handle the
2476 output. If BUFFER is not given, the value of NAME is used.
2477
2478 :coding CODING -- If CODING is a symbol, it specifies the coding
2479 system used for both reading and writing for this process. If CODING
2480 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2481 ENCODING is used for writing.
2482
2483 :noquery BOOL -- When exiting Emacs, query the user if BOOL is nil and
2484 the process is running. If BOOL is not given, query before exiting.
2485
2486 :stop BOOL -- Start process in the `stopped' state if BOOL is non-nil.
2487 In the stopped state, a serial process does not accept incoming data,
2488 but you can send outgoing data. The stopped state is cleared by
2489 `continue-process' and set by `stop-process'.
2490
2491 :filter FILTER -- Install FILTER as the process filter.
2492
2493 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2494
2495 :plist PLIST -- Install PLIST as the initial plist of the process.
2496
2497 :bytesize
2498 :parity
2499 :stopbits
2500 :flowcontrol
2501 -- This function calls `serial-process-configure' to handle these
2502 arguments.
2503
2504 The original argument list, possibly modified by later configuration,
2505 is available via the function `process-contact'.
2506
2507 Examples:
2508
2509 \(make-serial-process :port "/dev/ttyS0" :speed 9600)
2510
2511 \(make-serial-process :port "COM1" :speed 115200 :stopbits 2)
2512
2513 \(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd)
2514
2515 \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
2516
2517 usage: (make-serial-process &rest ARGS) */)
2518 (ptrdiff_t nargs, Lisp_Object *args)
2519 {
2520 int fd = -1;
2521 Lisp_Object proc, contact, port;
2522 struct Lisp_Process *p;
2523 struct gcpro gcpro1;
2524 Lisp_Object name, buffer;
2525 Lisp_Object tem, val;
2526 ptrdiff_t specpdl_count;
2527
2528 if (nargs == 0)
2529 return Qnil;
2530
2531 contact = Flist (nargs, args);
2532 GCPRO1 (contact);
2533
2534 port = Fplist_get (contact, QCport);
2535 if (NILP (port))
2536 error ("No port specified");
2537 CHECK_STRING (port);
2538
2539 if (NILP (Fplist_member (contact, QCspeed)))
2540 error (":speed not specified");
2541 if (!NILP (Fplist_get (contact, QCspeed)))
2542 CHECK_NUMBER (Fplist_get (contact, QCspeed));
2543
2544 name = Fplist_get (contact, QCname);
2545 if (NILP (name))
2546 name = port;
2547 CHECK_STRING (name);
2548 proc = make_process (name);
2549 specpdl_count = SPECPDL_INDEX ();
2550 record_unwind_protect (remove_process, proc);
2551 p = XPROCESS (proc);
2552
2553 fd = serial_open (port);
2554 p->open_fd[SUBPROCESS_STDIN] = fd;
2555 p->infd = fd;
2556 p->outfd = fd;
2557 if (fd > max_process_desc)
2558 max_process_desc = fd;
2559 chan_process[fd] = proc;
2560
2561 buffer = Fplist_get (contact, QCbuffer);
2562 if (NILP (buffer))
2563 buffer = name;
2564 buffer = Fget_buffer_create (buffer);
2565 pset_buffer (p, buffer);
2566
2567 pset_childp (p, contact);
2568 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
2569 pset_type (p, Qserial);
2570 pset_sentinel (p, Fplist_get (contact, QCsentinel));
2571 pset_filter (p, Fplist_get (contact, QCfilter));
2572 pset_log (p, Qnil);
2573 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
2574 p->kill_without_query = 1;
2575 if (tem = Fplist_get (contact, QCstop), !NILP (tem))
2576 pset_command (p, Qt);
2577 eassert (! p->pty_flag);
2578
2579 if (!EQ (p->command, Qt))
2580 {
2581 FD_SET (fd, &input_wait_mask);
2582 FD_SET (fd, &non_keyboard_wait_mask);
2583 }
2584
2585 if (BUFFERP (buffer))
2586 {
2587 set_marker_both (p->mark, buffer,
2588 BUF_ZV (XBUFFER (buffer)),
2589 BUF_ZV_BYTE (XBUFFER (buffer)));
2590 }
2591
2592 tem = Fplist_member (contact, QCcoding);
2593 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
2594 tem = Qnil;
2595
2596 val = Qnil;
2597 if (!NILP (tem))
2598 {
2599 val = XCAR (XCDR (tem));
2600 if (CONSP (val))
2601 val = XCAR (val);
2602 }
2603 else if (!NILP (Vcoding_system_for_read))
2604 val = Vcoding_system_for_read;
2605 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2606 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2607 val = Qnil;
2608 pset_decode_coding_system (p, val);
2609
2610 val = Qnil;
2611 if (!NILP (tem))
2612 {
2613 val = XCAR (XCDR (tem));
2614 if (CONSP (val))
2615 val = XCDR (val);
2616 }
2617 else if (!NILP (Vcoding_system_for_write))
2618 val = Vcoding_system_for_write;
2619 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
2620 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
2621 val = Qnil;
2622 pset_encode_coding_system (p, val);
2623
2624 setup_process_coding_systems (proc);
2625 pset_decoding_buf (p, empty_unibyte_string);
2626 p->decoding_carryover = 0;
2627 pset_encoding_buf (p, empty_unibyte_string);
2628 p->inherit_coding_system_flag
2629 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
2630
2631 Fserial_process_configure (nargs, args);
2632
2633 specpdl_ptr = specpdl + specpdl_count;
2634
2635 UNGCPRO;
2636 return proc;
2637 }
2638
2639 /* Create a network stream/datagram client/server process. Treated
2640 exactly like a normal process when reading and writing. Primary
2641 differences are in status display and process deletion. A network
2642 connection has no PID; you cannot signal it. All you can do is
2643 stop/continue it and deactivate/close it via delete-process. */
2644
2645 DEFUN ("make-network-process", Fmake_network_process, Smake_network_process,
2646 0, MANY, 0,
2647 doc: /* Create and return a network server or client process.
2648
2649 In Emacs, network connections are represented by process objects, so
2650 input and output work as for subprocesses and `delete-process' closes
2651 a network connection. However, a network process has no process id,
2652 it cannot be signaled, and the status codes are different from normal
2653 processes.
2654
2655 Arguments are specified as keyword/argument pairs. The following
2656 arguments are defined:
2657
2658 :name NAME -- NAME is name for process. It is modified if necessary
2659 to make it unique.
2660
2661 :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2662 with the process. Process output goes at end of that buffer, unless
2663 you specify an output stream or filter function to handle the output.
2664 BUFFER may be also nil, meaning that this process is not associated
2665 with any buffer.
2666
2667 :host HOST -- HOST is name of the host to connect to, or its IP
2668 address. The symbol `local' specifies the local host. If specified
2669 for a server process, it must be a valid name or address for the local
2670 host, and only clients connecting to that address will be accepted.
2671
2672 :service SERVICE -- SERVICE is name of the service desired, or an
2673 integer specifying a port number to connect to. If SERVICE is t,
2674 a random port number is selected for the server. (If Emacs was
2675 compiled with getaddrinfo, a port number can also be specified as a
2676 string, e.g. "80", as well as an integer. This is not portable.)
2677
2678 :type TYPE -- TYPE is the type of connection. The default (nil) is a
2679 stream type connection, `datagram' creates a datagram type connection,
2680 `seqpacket' creates a reliable datagram connection.
2681
2682 :family FAMILY -- FAMILY is the address (and protocol) family for the
2683 service specified by HOST and SERVICE. The default (nil) is to use
2684 whatever address family (IPv4 or IPv6) that is defined for the host
2685 and port number specified by HOST and SERVICE. Other address families
2686 supported are:
2687 local -- for a local (i.e. UNIX) address specified by SERVICE.
2688 ipv4 -- use IPv4 address family only.
2689 ipv6 -- use IPv6 address family only.
2690
2691 :local ADDRESS -- ADDRESS is the local address used for the connection.
2692 This parameter is ignored when opening a client process. When specified
2693 for a server process, the FAMILY, HOST and SERVICE args are ignored.
2694
2695 :remote ADDRESS -- ADDRESS is the remote partner's address for the
2696 connection. This parameter is ignored when opening a stream server
2697 process. For a datagram server process, it specifies the initial
2698 setting of the remote datagram address. When specified for a client
2699 process, the FAMILY, HOST, and SERVICE args are ignored.
2700
2701 The format of ADDRESS depends on the address family:
2702 - An IPv4 address is represented as an vector of integers [A B C D P]
2703 corresponding to numeric IP address A.B.C.D and port number P.
2704 - A local address is represented as a string with the address in the
2705 local address space.
2706 - An "unsupported family" address is represented by a cons (F . AV)
2707 where F is the family number and AV is a vector containing the socket
2708 address data with one element per address data byte. Do not rely on
2709 this format in portable code, as it may depend on implementation
2710 defined constants, data sizes, and data structure alignment.
2711
2712 :coding CODING -- If CODING is a symbol, it specifies the coding
2713 system used for both reading and writing for this process. If CODING
2714 is a cons (DECODING . ENCODING), DECODING is used for reading, and
2715 ENCODING is used for writing.
2716
2717 :nowait BOOL -- If BOOL is non-nil for a stream type client process,
2718 return without waiting for the connection to complete; instead, the
2719 sentinel function will be called with second arg matching "open" (if
2720 successful) or "failed" when the connect completes. Default is to use
2721 a blocking connect (i.e. wait) for stream type connections.
2722
2723 :noquery BOOL -- Query the user unless BOOL is non-nil, and process is
2724 running when Emacs is exited.
2725
2726 :stop BOOL -- Start process in the `stopped' state if BOOL non-nil.
2727 In the stopped state, a server process does not accept new
2728 connections, and a client process does not handle incoming traffic.
2729 The stopped state is cleared by `continue-process' and set by
2730 `stop-process'.
2731
2732 :filter FILTER -- Install FILTER as the process filter.
2733
2734 :filter-multibyte BOOL -- If BOOL is non-nil, strings given to the
2735 process filter are multibyte, otherwise they are unibyte.
2736 If this keyword is not specified, the strings are multibyte if
2737 the default value of `enable-multibyte-characters' is non-nil.
2738
2739 :sentinel SENTINEL -- Install SENTINEL as the process sentinel.
2740
2741 :log LOG -- Install LOG as the server process log function. This
2742 function is called when the server accepts a network connection from a
2743 client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER
2744 is the server process, CLIENT is the new process for the connection,
2745 and MESSAGE is a string.
2746
2747 :plist PLIST -- Install PLIST as the new process's initial plist.
2748
2749 :server QLEN -- if QLEN is non-nil, create a server process for the
2750 specified FAMILY, SERVICE, and connection type (stream or datagram).
2751 If QLEN is an integer, it is used as the max. length of the server's
2752 pending connection queue (also known as the backlog); the default
2753 queue length is 5. Default is to create a client process.
2754
2755 The following network options can be specified for this connection:
2756
2757 :broadcast BOOL -- Allow send and receive of datagram broadcasts.
2758 :dontroute BOOL -- Only send to directly connected hosts.
2759 :keepalive BOOL -- Send keep-alive messages on network stream.
2760 :linger BOOL or TIMEOUT -- Send queued messages before closing.
2761 :oobinline BOOL -- Place out-of-band data in receive data stream.
2762 :priority INT -- Set protocol defined priority for sent packets.
2763 :reuseaddr BOOL -- Allow reusing a recently used local address
2764 (this is allowed by default for a server process).
2765 :bindtodevice NAME -- bind to interface NAME. Using this may require
2766 special privileges on some systems.
2767
2768 Consult the relevant system programmer's manual pages for more
2769 information on using these options.
2770
2771
2772 A server process will listen for and accept connections from clients.
2773 When a client connection is accepted, a new network process is created
2774 for the connection with the following parameters:
2775
2776 - The client's process name is constructed by concatenating the server
2777 process's NAME and a client identification string.
2778 - If the FILTER argument is non-nil, the client process will not get a
2779 separate process buffer; otherwise, the client's process buffer is a newly
2780 created buffer named after the server process's BUFFER name or process
2781 NAME concatenated with the client identification string.
2782 - The connection type and the process filter and sentinel parameters are
2783 inherited from the server process's TYPE, FILTER and SENTINEL.
2784 - The client process's contact info is set according to the client's
2785 addressing information (typically an IP address and a port number).
2786 - The client process's plist is initialized from the server's plist.
2787
2788 Notice that the FILTER and SENTINEL args are never used directly by
2789 the server process. Also, the BUFFER argument is not used directly by
2790 the server process, but via the optional :log function, accepted (and
2791 failed) connections may be logged in the server process's buffer.
2792
2793 The original argument list, modified with the actual connection
2794 information, is available via the `process-contact' function.
2795
2796 usage: (make-network-process &rest ARGS) */)
2797 (ptrdiff_t nargs, Lisp_Object *args)
2798 {
2799 Lisp_Object proc;
2800 Lisp_Object contact;
2801 struct Lisp_Process *p;
2802 #ifdef HAVE_GETADDRINFO
2803 struct addrinfo ai, *res, *lres;
2804 struct addrinfo hints;
2805 const char *portstring;
2806 char portbuf[128];
2807 #else /* HAVE_GETADDRINFO */
2808 struct _emacs_addrinfo
2809 {
2810 int ai_family;
2811 int ai_socktype;
2812 int ai_protocol;
2813 int ai_addrlen;
2814 struct sockaddr *ai_addr;
2815 struct _emacs_addrinfo *ai_next;
2816 } ai, *res, *lres;
2817 #endif /* HAVE_GETADDRINFO */
2818 struct sockaddr_in address_in;
2819 #ifdef HAVE_LOCAL_SOCKETS
2820 struct sockaddr_un address_un;
2821 #endif
2822 int port;
2823 int ret = 0;
2824 int xerrno = 0;
2825 int s = -1, outch, inch;
2826 struct gcpro gcpro1;
2827 ptrdiff_t count = SPECPDL_INDEX ();
2828 ptrdiff_t count1;
2829 Lisp_Object colon_address; /* Either QClocal or QCremote. */
2830 Lisp_Object tem;
2831 Lisp_Object name, buffer, host, service, address;
2832 Lisp_Object filter, sentinel;
2833 bool is_non_blocking_client = 0;
2834 bool is_server = 0;
2835 int backlog = 5;
2836 int socktype;
2837 int family = -1;
2838
2839 if (nargs == 0)
2840 return Qnil;
2841
2842 /* Save arguments for process-contact and clone-process. */
2843 contact = Flist (nargs, args);
2844 GCPRO1 (contact);
2845
2846 #ifdef WINDOWSNT
2847 /* Ensure socket support is loaded if available. */
2848 init_winsock (TRUE);
2849 #endif
2850
2851 /* :type TYPE (nil: stream, datagram */
2852 tem = Fplist_get (contact, QCtype);
2853 if (NILP (tem))
2854 socktype = SOCK_STREAM;
2855 #ifdef DATAGRAM_SOCKETS
2856 else if (EQ (tem, Qdatagram))
2857 socktype = SOCK_DGRAM;
2858 #endif
2859 #ifdef HAVE_SEQPACKET
2860 else if (EQ (tem, Qseqpacket))
2861 socktype = SOCK_SEQPACKET;
2862 #endif
2863 else
2864 error ("Unsupported connection type");
2865
2866 /* :server BOOL */
2867 tem = Fplist_get (contact, QCserver);
2868 if (!NILP (tem))
2869 {
2870 /* Don't support network sockets when non-blocking mode is
2871 not available, since a blocked Emacs is not useful. */
2872 is_server = 1;
2873 if (TYPE_RANGED_INTEGERP (int, tem))
2874 backlog = XINT (tem);
2875 }
2876
2877 /* Make colon_address an alias for :local (server) or :remote (client). */
2878 colon_address = is_server ? QClocal : QCremote;
2879
2880 /* :nowait BOOL */
2881 if (!is_server && socktype != SOCK_DGRAM
2882 && (tem = Fplist_get (contact, QCnowait), !NILP (tem)))
2883 {
2884 #ifndef NON_BLOCKING_CONNECT
2885 error ("Non-blocking connect not supported");
2886 #else
2887 is_non_blocking_client = 1;
2888 #endif
2889 }
2890
2891 name = Fplist_get (contact, QCname);
2892 buffer = Fplist_get (contact, QCbuffer);
2893 filter = Fplist_get (contact, QCfilter);
2894 sentinel = Fplist_get (contact, QCsentinel);
2895
2896 CHECK_STRING (name);
2897
2898 /* Initialize addrinfo structure in case we don't use getaddrinfo. */
2899 ai.ai_socktype = socktype;
2900 ai.ai_protocol = 0;
2901 ai.ai_next = NULL;
2902 res = &ai;
2903
2904 /* :local ADDRESS or :remote ADDRESS */
2905 address = Fplist_get (contact, colon_address);
2906 if (!NILP (address))
2907 {
2908 host = service = Qnil;
2909
2910 if (!(ai.ai_addrlen = get_lisp_to_sockaddr_size (address, &family)))
2911 error ("Malformed :address");
2912 ai.ai_family = family;
2913 ai.ai_addr = alloca (ai.ai_addrlen);
2914 conv_lisp_to_sockaddr (family, address, ai.ai_addr, ai.ai_addrlen);
2915 goto open_socket;
2916 }
2917
2918 /* :family FAMILY -- nil (for Inet), local, or integer. */
2919 tem = Fplist_get (contact, QCfamily);
2920 if (NILP (tem))
2921 {
2922 #if defined (HAVE_GETADDRINFO) && defined (AF_INET6)
2923 family = AF_UNSPEC;
2924 #else
2925 family = AF_INET;
2926 #endif
2927 }
2928 #ifdef HAVE_LOCAL_SOCKETS
2929 else if (EQ (tem, Qlocal))
2930 family = AF_LOCAL;
2931 #endif
2932 #ifdef AF_INET6
2933 else if (EQ (tem, Qipv6))
2934 family = AF_INET6;
2935 #endif
2936 else if (EQ (tem, Qipv4))
2937 family = AF_INET;
2938 else if (TYPE_RANGED_INTEGERP (int, tem))
2939 family = XINT (tem);
2940 else
2941 error ("Unknown address family");
2942
2943 ai.ai_family = family;
2944
2945 /* :service SERVICE -- string, integer (port number), or t (random port). */
2946 service = Fplist_get (contact, QCservice);
2947
2948 /* :host HOST -- hostname, ip address, or 'local for localhost. */
2949 host = Fplist_get (contact, QChost);
2950 if (!NILP (host))
2951 {
2952 if (EQ (host, Qlocal))
2953 /* Depending on setup, "localhost" may map to different IPv4 and/or
2954 IPv6 addresses, so it's better to be explicit (Bug#6781). */
2955 host = build_string ("127.0.0.1");
2956 CHECK_STRING (host);
2957 }
2958
2959 #ifdef HAVE_LOCAL_SOCKETS
2960 if (family == AF_LOCAL)
2961 {
2962 if (!NILP (host))
2963 {
2964 message (":family local ignores the :host \"%s\" property",
2965 SDATA (host));
2966 contact = Fplist_put (contact, QChost, Qnil);
2967 host = Qnil;
2968 }
2969 CHECK_STRING (service);
2970 memset (&address_un, 0, sizeof address_un);
2971 address_un.sun_family = AF_LOCAL;
2972 if (sizeof address_un.sun_path <= SBYTES (service))
2973 error ("Service name too long");
2974 lispstpcpy (address_un.sun_path, service);
2975 ai.ai_addr = (struct sockaddr *) &address_un;
2976 ai.ai_addrlen = sizeof address_un;
2977 goto open_socket;
2978 }
2979 #endif
2980
2981 /* Slow down polling to every ten seconds.
2982 Some kernels have a bug which causes retrying connect to fail
2983 after a connect. Polling can interfere with gethostbyname too. */
2984 #ifdef POLL_FOR_INPUT
2985 if (socktype != SOCK_DGRAM)
2986 {
2987 record_unwind_protect_void (run_all_atimers);
2988 bind_polling_period (10);
2989 }
2990 #endif
2991
2992 #ifdef HAVE_GETADDRINFO
2993 /* If we have a host, use getaddrinfo to resolve both host and service.
2994 Otherwise, use getservbyname to lookup the service. */
2995 if (!NILP (host))
2996 {
2997
2998 /* SERVICE can either be a string or int.
2999 Convert to a C string for later use by getaddrinfo. */
3000 if (EQ (service, Qt))
3001 portstring = "0";
3002 else if (INTEGERP (service))
3003 {
3004 sprintf (portbuf, "%"pI"d", XINT (service));
3005 portstring = portbuf;
3006 }
3007 else
3008 {
3009 CHECK_STRING (service);
3010 portstring = SSDATA (service);
3011 }
3012
3013 immediate_quit = 1;
3014 QUIT;
3015 memset (&hints, 0, sizeof (hints));
3016 hints.ai_flags = 0;
3017 hints.ai_family = family;
3018 hints.ai_socktype = socktype;
3019 hints.ai_protocol = 0;
3020
3021 #ifdef HAVE_RES_INIT
3022 res_init ();
3023 #endif
3024
3025 ret = getaddrinfo (SSDATA (host), portstring, &hints, &res);
3026 if (ret)
3027 #ifdef HAVE_GAI_STRERROR
3028 error ("%s/%s %s", SSDATA (host), portstring, gai_strerror (ret));
3029 #else
3030 error ("%s/%s getaddrinfo error %d", SSDATA (host), portstring, ret);
3031 #endif
3032 immediate_quit = 0;
3033
3034 goto open_socket;
3035 }
3036 #endif /* HAVE_GETADDRINFO */
3037
3038 /* We end up here if getaddrinfo is not defined, or in case no hostname
3039 has been specified (e.g. for a local server process). */
3040
3041 if (EQ (service, Qt))
3042 port = 0;
3043 else if (INTEGERP (service))
3044 port = htons ((unsigned short) XINT (service));
3045 else
3046 {
3047 struct servent *svc_info;
3048 CHECK_STRING (service);
3049 svc_info = getservbyname (SSDATA (service),
3050 (socktype == SOCK_DGRAM ? "udp" : "tcp"));
3051 if (svc_info == 0)
3052 error ("Unknown service: %s", SDATA (service));
3053 port = svc_info->s_port;
3054 }
3055
3056 memset (&address_in, 0, sizeof address_in);
3057 address_in.sin_family = family;
3058 address_in.sin_addr.s_addr = INADDR_ANY;
3059 address_in.sin_port = port;
3060
3061 #ifndef HAVE_GETADDRINFO
3062 if (!NILP (host))
3063 {
3064 struct hostent *host_info_ptr;
3065
3066 /* gethostbyname may fail with TRY_AGAIN, but we don't honor that,
3067 as it may `hang' Emacs for a very long time. */
3068 immediate_quit = 1;
3069 QUIT;
3070
3071 #ifdef HAVE_RES_INIT
3072 res_init ();
3073 #endif
3074
3075 host_info_ptr = gethostbyname (SDATA (host));
3076 immediate_quit = 0;
3077
3078 if (host_info_ptr)
3079 {
3080 memcpy (&address_in.sin_addr, host_info_ptr->h_addr,
3081 host_info_ptr->h_length);
3082 family = host_info_ptr->h_addrtype;
3083 address_in.sin_family = family;
3084 }
3085 else
3086 /* Attempt to interpret host as numeric inet address. */
3087 {
3088 unsigned long numeric_addr;
3089 numeric_addr = inet_addr (SSDATA (host));
3090 if (numeric_addr == -1)
3091 error ("Unknown host \"%s\"", SDATA (host));
3092
3093 memcpy (&address_in.sin_addr, &numeric_addr,
3094 sizeof (address_in.sin_addr));
3095 }
3096
3097 }
3098 #endif /* not HAVE_GETADDRINFO */
3099
3100 ai.ai_family = family;
3101 ai.ai_addr = (struct sockaddr *) &address_in;
3102 ai.ai_addrlen = sizeof address_in;
3103
3104 open_socket:
3105
3106 /* Do this in case we never enter the for-loop below. */
3107 count1 = SPECPDL_INDEX ();
3108 s = -1;
3109
3110 for (lres = res; lres; lres = lres->ai_next)
3111 {
3112 ptrdiff_t optn;
3113 int optbits;
3114
3115 #ifdef WINDOWSNT
3116 retry_connect:
3117 #endif
3118
3119 s = socket (lres->ai_family, lres->ai_socktype | SOCK_CLOEXEC,
3120 lres->ai_protocol);
3121 if (s < 0)
3122 {
3123 xerrno = errno;
3124 continue;
3125 }
3126
3127 #ifdef DATAGRAM_SOCKETS
3128 if (!is_server && socktype == SOCK_DGRAM)
3129 break;
3130 #endif /* DATAGRAM_SOCKETS */
3131
3132 #ifdef NON_BLOCKING_CONNECT
3133 if (is_non_blocking_client)
3134 {
3135 ret = fcntl (s, F_SETFL, O_NONBLOCK);
3136 if (ret < 0)
3137 {
3138 xerrno = errno;
3139 emacs_close (s);
3140 s = -1;
3141 continue;
3142 }
3143 }
3144 #endif
3145
3146 /* Make us close S if quit. */
3147 record_unwind_protect_int (close_file_unwind, s);
3148
3149 /* Parse network options in the arg list.
3150 We simply ignore anything which isn't a known option (including other keywords).
3151 An error is signaled if setting a known option fails. */
3152 for (optn = optbits = 0; optn < nargs - 1; optn += 2)
3153 optbits |= set_socket_option (s, args[optn], args[optn + 1]);
3154
3155 if (is_server)
3156 {
3157 /* Configure as a server socket. */
3158
3159 /* SO_REUSEADDR = 1 is default for server sockets; must specify
3160 explicit :reuseaddr key to override this. */
3161 #ifdef HAVE_LOCAL_SOCKETS
3162 if (family != AF_LOCAL)
3163 #endif
3164 if (!(optbits & (1 << OPIX_REUSEADDR)))
3165 {
3166 int optval = 1;
3167 if (setsockopt (s, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof optval))
3168 report_file_error ("Cannot set reuse option on server socket", Qnil);
3169 }
3170
3171 if (bind (s, lres->ai_addr, lres->ai_addrlen))
3172 report_file_error ("Cannot bind server socket", Qnil);
3173
3174 #ifdef HAVE_GETSOCKNAME
3175 if (EQ (service, Qt))
3176 {
3177 struct sockaddr_in sa1;
3178 socklen_t len1 = sizeof (sa1);
3179 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3180 {
3181 ((struct sockaddr_in *)(lres->ai_addr))->sin_port = sa1.sin_port;
3182 service = make_number (ntohs (sa1.sin_port));
3183 contact = Fplist_put (contact, QCservice, service);
3184 }
3185 }
3186 #endif
3187
3188 if (socktype != SOCK_DGRAM && listen (s, backlog))
3189 report_file_error ("Cannot listen on server socket", Qnil);
3190
3191 break;
3192 }
3193
3194 immediate_quit = 1;
3195 QUIT;
3196
3197 ret = connect (s, lres->ai_addr, lres->ai_addrlen);
3198 xerrno = errno;
3199
3200 if (ret == 0 || xerrno == EISCONN)
3201 {
3202 /* The unwind-protect will be discarded afterwards.
3203 Likewise for immediate_quit. */
3204 break;
3205 }
3206
3207 #ifdef NON_BLOCKING_CONNECT
3208 #ifdef EINPROGRESS
3209 if (is_non_blocking_client && xerrno == EINPROGRESS)
3210 break;
3211 #else
3212 #ifdef EWOULDBLOCK
3213 if (is_non_blocking_client && xerrno == EWOULDBLOCK)
3214 break;
3215 #endif
3216 #endif
3217 #endif
3218
3219 #ifndef WINDOWSNT
3220 if (xerrno == EINTR)
3221 {
3222 /* Unlike most other syscalls connect() cannot be called
3223 again. (That would return EALREADY.) The proper way to
3224 wait for completion is pselect(). */
3225 int sc;
3226 socklen_t len;
3227 fd_set fdset;
3228 retry_select:
3229 FD_ZERO (&fdset);
3230 FD_SET (s, &fdset);
3231 QUIT;
3232 sc = pselect (s + 1, NULL, &fdset, NULL, NULL, NULL);
3233 if (sc == -1)
3234 {
3235 if (errno == EINTR)
3236 goto retry_select;
3237 else
3238 report_file_error ("Failed select", Qnil);
3239 }
3240 eassert (sc > 0);
3241
3242 len = sizeof xerrno;
3243 eassert (FD_ISSET (s, &fdset));
3244 if (getsockopt (s, SOL_SOCKET, SO_ERROR, &xerrno, &len) < 0)
3245 report_file_error ("Failed getsockopt", Qnil);
3246 if (xerrno)
3247 report_file_errno ("Failed connect", Qnil, xerrno);
3248 break;
3249 }
3250 #endif /* !WINDOWSNT */
3251
3252 immediate_quit = 0;
3253
3254 /* Discard the unwind protect closing S. */
3255 specpdl_ptr = specpdl + count1;
3256 emacs_close (s);
3257 s = -1;
3258
3259 #ifdef WINDOWSNT
3260 if (xerrno == EINTR)
3261 goto retry_connect;
3262 #endif
3263 }
3264
3265 if (s >= 0)
3266 {
3267 #ifdef DATAGRAM_SOCKETS
3268 if (socktype == SOCK_DGRAM)
3269 {
3270 if (datagram_address[s].sa)
3271 emacs_abort ();
3272 datagram_address[s].sa = xmalloc (lres->ai_addrlen);
3273 datagram_address[s].len = lres->ai_addrlen;
3274 if (is_server)
3275 {
3276 Lisp_Object remote;
3277 memset (datagram_address[s].sa, 0, lres->ai_addrlen);
3278 if (remote = Fplist_get (contact, QCremote), !NILP (remote))
3279 {
3280 int rfamily, rlen;
3281 rlen = get_lisp_to_sockaddr_size (remote, &rfamily);
3282 if (rlen != 0 && rfamily == lres->ai_family
3283 && rlen == lres->ai_addrlen)
3284 conv_lisp_to_sockaddr (rfamily, remote,
3285 datagram_address[s].sa, rlen);
3286 }
3287 }
3288 else
3289 memcpy (datagram_address[s].sa, lres->ai_addr, lres->ai_addrlen);
3290 }
3291 #endif
3292 contact = Fplist_put (contact, colon_address,
3293 conv_sockaddr_to_lisp (lres->ai_addr, lres->ai_addrlen));
3294 #ifdef HAVE_GETSOCKNAME
3295 if (!is_server)
3296 {
3297 struct sockaddr_in sa1;
3298 socklen_t len1 = sizeof (sa1);
3299 if (getsockname (s, (struct sockaddr *)&sa1, &len1) == 0)
3300 contact = Fplist_put (contact, QClocal,
3301 conv_sockaddr_to_lisp ((struct sockaddr *)&sa1, len1));
3302 }
3303 #endif
3304 }
3305
3306 immediate_quit = 0;
3307
3308 #ifdef HAVE_GETADDRINFO
3309 if (res != &ai)
3310 {
3311 block_input ();
3312 freeaddrinfo (res);
3313 unblock_input ();
3314 }
3315 #endif
3316
3317 if (s < 0)
3318 {
3319 /* If non-blocking got this far - and failed - assume non-blocking is
3320 not supported after all. This is probably a wrong assumption, but
3321 the normal blocking calls to open-network-stream handles this error
3322 better. */
3323 if (is_non_blocking_client)
3324 return Qnil;
3325
3326 report_file_errno ((is_server
3327 ? "make server process failed"
3328 : "make client process failed"),
3329 contact, xerrno);
3330 }
3331
3332 inch = s;
3333 outch = s;
3334
3335 if (!NILP (buffer))
3336 buffer = Fget_buffer_create (buffer);
3337 proc = make_process (name);
3338
3339 chan_process[inch] = proc;
3340
3341 fcntl (inch, F_SETFL, O_NONBLOCK);
3342
3343 p = XPROCESS (proc);
3344
3345 pset_childp (p, contact);
3346 pset_plist (p, Fcopy_sequence (Fplist_get (contact, QCplist)));
3347 pset_type (p, Qnetwork);
3348
3349 pset_buffer (p, buffer);
3350 pset_sentinel (p, sentinel);
3351 pset_filter (p, filter);
3352 pset_log (p, Fplist_get (contact, QClog));
3353 if (tem = Fplist_get (contact, QCnoquery), !NILP (tem))
3354 p->kill_without_query = 1;
3355 if ((tem = Fplist_get (contact, QCstop), !NILP (tem)))
3356 pset_command (p, Qt);
3357 p->pid = 0;
3358
3359 p->open_fd[SUBPROCESS_STDIN] = inch;
3360 p->infd = inch;
3361 p->outfd = outch;
3362
3363 /* Discard the unwind protect for closing S, if any. */
3364 specpdl_ptr = specpdl + count1;
3365
3366 /* Unwind bind_polling_period and request_sigio. */
3367 unbind_to (count, Qnil);
3368
3369 if (is_server && socktype != SOCK_DGRAM)
3370 pset_status (p, Qlisten);
3371
3372 /* Make the process marker point into the process buffer (if any). */
3373 if (BUFFERP (buffer))
3374 set_marker_both (p->mark, buffer,
3375 BUF_ZV (XBUFFER (buffer)),
3376 BUF_ZV_BYTE (XBUFFER (buffer)));
3377
3378 #ifdef NON_BLOCKING_CONNECT
3379 if (is_non_blocking_client)
3380 {
3381 /* We may get here if connect did succeed immediately. However,
3382 in that case, we still need to signal this like a non-blocking
3383 connection. */
3384 pset_status (p, Qconnect);
3385 if (!FD_ISSET (inch, &connect_wait_mask))
3386 {
3387 FD_SET (inch, &connect_wait_mask);
3388 FD_SET (inch, &write_mask);
3389 num_pending_connects++;
3390 }
3391 }
3392 else
3393 #endif
3394 /* A server may have a client filter setting of Qt, but it must
3395 still listen for incoming connects unless it is stopped. */
3396 if ((!EQ (p->filter, Qt) && !EQ (p->command, Qt))
3397 || (EQ (p->status, Qlisten) && NILP (p->command)))
3398 {
3399 FD_SET (inch, &input_wait_mask);
3400 FD_SET (inch, &non_keyboard_wait_mask);
3401 }
3402
3403 if (inch > max_process_desc)
3404 max_process_desc = inch;
3405
3406 tem = Fplist_member (contact, QCcoding);
3407 if (!NILP (tem) && (!CONSP (tem) || !CONSP (XCDR (tem))))
3408 tem = Qnil; /* No error message (too late!). */
3409
3410 {
3411 /* Setup coding systems for communicating with the network stream. */
3412 struct gcpro gcpro1;
3413 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
3414 Lisp_Object coding_systems = Qt;
3415 Lisp_Object fargs[5], val;
3416
3417 if (!NILP (tem))
3418 {
3419 val = XCAR (XCDR (tem));
3420 if (CONSP (val))
3421 val = XCAR (val);
3422 }
3423 else if (!NILP (Vcoding_system_for_read))
3424 val = Vcoding_system_for_read;
3425 else if ((!NILP (buffer) && NILP (BVAR (XBUFFER (buffer), enable_multibyte_characters)))
3426 || (NILP (buffer) && NILP (BVAR (&buffer_defaults, enable_multibyte_characters))))
3427 /* We dare not decode end-of-line format by setting VAL to
3428 Qraw_text, because the existing Emacs Lisp libraries
3429 assume that they receive bare code including a sequence of
3430 CR LF. */
3431 val = Qnil;
3432 else
3433 {
3434 if (NILP (host) || NILP (service))
3435 coding_systems = Qnil;
3436 else
3437 {
3438 fargs[0] = Qopen_network_stream, fargs[1] = name,
3439 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3440 GCPRO1 (proc);
3441 coding_systems = Ffind_operation_coding_system (5, fargs);
3442 UNGCPRO;
3443 }
3444 if (CONSP (coding_systems))
3445 val = XCAR (coding_systems);
3446 else if (CONSP (Vdefault_process_coding_system))
3447 val = XCAR (Vdefault_process_coding_system);
3448 else
3449 val = Qnil;
3450 }
3451 pset_decode_coding_system (p, val);
3452
3453 if (!NILP (tem))
3454 {
3455 val = XCAR (XCDR (tem));
3456 if (CONSP (val))
3457 val = XCDR (val);
3458 }
3459 else if (!NILP (Vcoding_system_for_write))
3460 val = Vcoding_system_for_write;
3461 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3462 val = Qnil;
3463 else
3464 {
3465 if (EQ (coding_systems, Qt))
3466 {
3467 if (NILP (host) || NILP (service))
3468 coding_systems = Qnil;
3469 else
3470 {
3471 fargs[0] = Qopen_network_stream, fargs[1] = name,
3472 fargs[2] = buffer, fargs[3] = host, fargs[4] = service;
3473 GCPRO1 (proc);
3474 coding_systems = Ffind_operation_coding_system (5, fargs);
3475 UNGCPRO;
3476 }
3477 }
3478 if (CONSP (coding_systems))
3479 val = XCDR (coding_systems);
3480 else if (CONSP (Vdefault_process_coding_system))
3481 val = XCDR (Vdefault_process_coding_system);
3482 else
3483 val = Qnil;
3484 }
3485 pset_encode_coding_system (p, val);
3486 }
3487 setup_process_coding_systems (proc);
3488
3489 pset_decoding_buf (p, empty_unibyte_string);
3490 p->decoding_carryover = 0;
3491 pset_encoding_buf (p, empty_unibyte_string);
3492
3493 p->inherit_coding_system_flag
3494 = !(!NILP (tem) || NILP (buffer) || !inherit_process_coding_system);
3495
3496 UNGCPRO;
3497 return proc;
3498 }
3499
3500 \f
3501 #ifdef HAVE_NET_IF_H
3502
3503 #ifdef SIOCGIFCONF
3504 static Lisp_Object
3505 network_interface_list (void)
3506 {
3507 struct ifconf ifconf;
3508 struct ifreq *ifreq;
3509 void *buf = NULL;
3510 ptrdiff_t buf_size = 512;
3511 int s;
3512 Lisp_Object res;
3513 ptrdiff_t count;
3514
3515 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
3516 if (s < 0)
3517 return Qnil;
3518 count = SPECPDL_INDEX ();
3519 record_unwind_protect_int (close_file_unwind, s);
3520
3521 do
3522 {
3523 buf = xpalloc (buf, &buf_size, 1, INT_MAX, 1);
3524 ifconf.ifc_buf = buf;
3525 ifconf.ifc_len = buf_size;
3526 if (ioctl (s, SIOCGIFCONF, &ifconf))
3527 {
3528 emacs_close (s);
3529 xfree (buf);
3530 return Qnil;
3531 }
3532 }
3533 while (ifconf.ifc_len == buf_size);
3534
3535 res = unbind_to (count, Qnil);
3536 ifreq = ifconf.ifc_req;
3537 while ((char *) ifreq < (char *) ifconf.ifc_req + ifconf.ifc_len)
3538 {
3539 struct ifreq *ifq = ifreq;
3540 #ifdef HAVE_STRUCT_IFREQ_IFR_ADDR_SA_LEN
3541 #define SIZEOF_IFREQ(sif) \
3542 ((sif)->ifr_addr.sa_len < sizeof (struct sockaddr) \
3543 ? sizeof (*(sif)) : sizeof ((sif)->ifr_name) + (sif)->ifr_addr.sa_len)
3544
3545 int len = SIZEOF_IFREQ (ifq);
3546 #else
3547 int len = sizeof (*ifreq);
3548 #endif
3549 char namebuf[sizeof (ifq->ifr_name) + 1];
3550 ifreq = (struct ifreq *) ((char *) ifreq + len);
3551
3552 if (ifq->ifr_addr.sa_family != AF_INET)
3553 continue;
3554
3555 memcpy (namebuf, ifq->ifr_name, sizeof (ifq->ifr_name));
3556 namebuf[sizeof (ifq->ifr_name)] = 0;
3557 res = Fcons (Fcons (build_string (namebuf),
3558 conv_sockaddr_to_lisp (&ifq->ifr_addr,
3559 sizeof (struct sockaddr))),
3560 res);
3561 }
3562
3563 xfree (buf);
3564 return res;
3565 }
3566 #endif /* SIOCGIFCONF */
3567
3568 #if defined (SIOCGIFADDR) || defined (SIOCGIFHWADDR) || defined (SIOCGIFFLAGS)
3569
3570 struct ifflag_def {
3571 int flag_bit;
3572 const char *flag_sym;
3573 };
3574
3575 static const struct ifflag_def ifflag_table[] = {
3576 #ifdef IFF_UP
3577 { IFF_UP, "up" },
3578 #endif
3579 #ifdef IFF_BROADCAST
3580 { IFF_BROADCAST, "broadcast" },
3581 #endif
3582 #ifdef IFF_DEBUG
3583 { IFF_DEBUG, "debug" },
3584 #endif
3585 #ifdef IFF_LOOPBACK
3586 { IFF_LOOPBACK, "loopback" },
3587 #endif
3588 #ifdef IFF_POINTOPOINT
3589 { IFF_POINTOPOINT, "pointopoint" },
3590 #endif
3591 #ifdef IFF_RUNNING
3592 { IFF_RUNNING, "running" },
3593 #endif
3594 #ifdef IFF_NOARP
3595 { IFF_NOARP, "noarp" },
3596 #endif
3597 #ifdef IFF_PROMISC
3598 { IFF_PROMISC, "promisc" },
3599 #endif
3600 #ifdef IFF_NOTRAILERS
3601 #ifdef NS_IMPL_COCOA
3602 /* Really means smart, notrailers is obsolete. */
3603 { IFF_NOTRAILERS, "smart" },
3604 #else
3605 { IFF_NOTRAILERS, "notrailers" },
3606 #endif
3607 #endif
3608 #ifdef IFF_ALLMULTI
3609 { IFF_ALLMULTI, "allmulti" },
3610 #endif
3611 #ifdef IFF_MASTER
3612 { IFF_MASTER, "master" },
3613 #endif
3614 #ifdef IFF_SLAVE
3615 { IFF_SLAVE, "slave" },
3616 #endif
3617 #ifdef IFF_MULTICAST
3618 { IFF_MULTICAST, "multicast" },
3619 #endif
3620 #ifdef IFF_PORTSEL
3621 { IFF_PORTSEL, "portsel" },
3622 #endif
3623 #ifdef IFF_AUTOMEDIA
3624 { IFF_AUTOMEDIA, "automedia" },
3625 #endif
3626 #ifdef IFF_DYNAMIC
3627 { IFF_DYNAMIC, "dynamic" },
3628 #endif
3629 #ifdef IFF_OACTIVE
3630 { IFF_OACTIVE, "oactive" }, /* OpenBSD: transmission in progress. */
3631 #endif
3632 #ifdef IFF_SIMPLEX
3633 { IFF_SIMPLEX, "simplex" }, /* OpenBSD: can't hear own transmissions. */
3634 #endif
3635 #ifdef IFF_LINK0
3636 { IFF_LINK0, "link0" }, /* OpenBSD: per link layer defined bit. */
3637 #endif
3638 #ifdef IFF_LINK1
3639 { IFF_LINK1, "link1" }, /* OpenBSD: per link layer defined bit. */
3640 #endif
3641 #ifdef IFF_LINK2
3642 { IFF_LINK2, "link2" }, /* OpenBSD: per link layer defined bit. */
3643 #endif
3644 { 0, 0 }
3645 };
3646
3647 static Lisp_Object
3648 network_interface_info (Lisp_Object ifname)
3649 {
3650 struct ifreq rq;
3651 Lisp_Object res = Qnil;
3652 Lisp_Object elt;
3653 int s;
3654 bool any = 0;
3655 ptrdiff_t count;
3656 #if (! (defined SIOCGIFHWADDR && defined HAVE_STRUCT_IFREQ_IFR_HWADDR) \
3657 && defined HAVE_GETIFADDRS && defined LLADDR)
3658 struct ifaddrs *ifap;
3659 #endif
3660
3661 CHECK_STRING (ifname);
3662
3663 if (sizeof rq.ifr_name <= SBYTES (ifname))
3664 error ("interface name too long");
3665 lispstpcpy (rq.ifr_name, ifname);
3666
3667 s = socket (AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
3668 if (s < 0)
3669 return Qnil;
3670 count = SPECPDL_INDEX ();
3671 record_unwind_protect_int (close_file_unwind, s);
3672
3673 elt = Qnil;
3674 #if defined (SIOCGIFFLAGS) && defined (HAVE_STRUCT_IFREQ_IFR_FLAGS)
3675 if (ioctl (s, SIOCGIFFLAGS, &rq) == 0)
3676 {
3677 int flags = rq.ifr_flags;
3678 const struct ifflag_def *fp;
3679 int fnum;
3680
3681 /* If flags is smaller than int (i.e. short) it may have the high bit set
3682 due to IFF_MULTICAST. In that case, sign extending it into
3683 an int is wrong. */
3684 if (flags < 0 && sizeof (rq.ifr_flags) < sizeof (flags))
3685 flags = (unsigned short) rq.ifr_flags;
3686
3687 any = 1;
3688 for (fp = ifflag_table; flags != 0 && fp->flag_sym; fp++)
3689 {
3690 if (flags & fp->flag_bit)
3691 {
3692 elt = Fcons (intern (fp->flag_sym), elt);
3693 flags -= fp->flag_bit;
3694 }
3695 }
3696 for (fnum = 0; flags && fnum < 32; flags >>= 1, fnum++)
3697 {
3698 if (flags & 1)
3699 {
3700 elt = Fcons (make_number (fnum), elt);
3701 }
3702 }
3703 }
3704 #endif
3705 res = Fcons (elt, res);
3706
3707 elt = Qnil;
3708 #if defined (SIOCGIFHWADDR) && defined (HAVE_STRUCT_IFREQ_IFR_HWADDR)
3709 if (ioctl (s, SIOCGIFHWADDR, &rq) == 0)
3710 {
3711 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3712 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3713 int n;
3714
3715 any = 1;
3716 for (n = 0; n < 6; n++)
3717 p->contents[n] = make_number (((unsigned char *)
3718 &rq.ifr_hwaddr.sa_data[0])
3719 [n]);
3720 elt = Fcons (make_number (rq.ifr_hwaddr.sa_family), hwaddr);
3721 }
3722 #elif defined (HAVE_GETIFADDRS) && defined (LLADDR)
3723 if (getifaddrs (&ifap) != -1)
3724 {
3725 Lisp_Object hwaddr = Fmake_vector (make_number (6), Qnil);
3726 register struct Lisp_Vector *p = XVECTOR (hwaddr);
3727 struct ifaddrs *it;
3728
3729 for (it = ifap; it != NULL; it = it->ifa_next)
3730 {
3731 struct sockaddr_dl *sdl = (struct sockaddr_dl*) it->ifa_addr;
3732 unsigned char linkaddr[6];
3733 int n;
3734
3735 if (it->ifa_addr->sa_family != AF_LINK
3736 || strcmp (it->ifa_name, SSDATA (ifname)) != 0
3737 || sdl->sdl_alen != 6)
3738 continue;
3739
3740 memcpy (linkaddr, LLADDR (sdl), sdl->sdl_alen);
3741 for (n = 0; n < 6; n++)
3742 p->contents[n] = make_number (linkaddr[n]);
3743
3744 elt = Fcons (make_number (it->ifa_addr->sa_family), hwaddr);
3745 break;
3746 }
3747 }
3748 #ifdef HAVE_FREEIFADDRS
3749 freeifaddrs (ifap);
3750 #endif
3751
3752 #endif /* HAVE_GETIFADDRS && LLADDR */
3753
3754 res = Fcons (elt, res);
3755
3756 elt = Qnil;
3757 #if defined (SIOCGIFNETMASK) && (defined (HAVE_STRUCT_IFREQ_IFR_NETMASK) || defined (HAVE_STRUCT_IFREQ_IFR_ADDR))
3758 if (ioctl (s, SIOCGIFNETMASK, &rq) == 0)
3759 {
3760 any = 1;
3761 #ifdef HAVE_STRUCT_IFREQ_IFR_NETMASK
3762 elt = conv_sockaddr_to_lisp (&rq.ifr_netmask, sizeof (rq.ifr_netmask));
3763 #else
3764 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3765 #endif
3766 }
3767 #endif
3768 res = Fcons (elt, res);
3769
3770 elt = Qnil;
3771 #if defined (SIOCGIFBRDADDR) && defined (HAVE_STRUCT_IFREQ_IFR_BROADADDR)
3772 if (ioctl (s, SIOCGIFBRDADDR, &rq) == 0)
3773 {
3774 any = 1;
3775 elt = conv_sockaddr_to_lisp (&rq.ifr_broadaddr, sizeof (rq.ifr_broadaddr));
3776 }
3777 #endif
3778 res = Fcons (elt, res);
3779
3780 elt = Qnil;
3781 #if defined (SIOCGIFADDR) && defined (HAVE_STRUCT_IFREQ_IFR_ADDR)
3782 if (ioctl (s, SIOCGIFADDR, &rq) == 0)
3783 {
3784 any = 1;
3785 elt = conv_sockaddr_to_lisp (&rq.ifr_addr, sizeof (rq.ifr_addr));
3786 }
3787 #endif
3788 res = Fcons (elt, res);
3789
3790 return unbind_to (count, any ? res : Qnil);
3791 }
3792 #endif /* !SIOCGIFADDR && !SIOCGIFHWADDR && !SIOCGIFFLAGS */
3793 #endif /* defined (HAVE_NET_IF_H) */
3794
3795 DEFUN ("network-interface-list", Fnetwork_interface_list,
3796 Snetwork_interface_list, 0, 0, 0,
3797 doc: /* Return an alist of all network interfaces and their network address.
3798 Each element is a cons, the car of which is a string containing the
3799 interface name, and the cdr is the network address in internal
3800 format; see the description of ADDRESS in `make-network-process'.
3801
3802 If the information is not available, return nil. */)
3803 (void)
3804 {
3805 #if (defined HAVE_NET_IF_H && defined SIOCGIFCONF) || defined WINDOWSNT
3806 return network_interface_list ();
3807 #else
3808 return Qnil;
3809 #endif
3810 }
3811
3812 DEFUN ("network-interface-info", Fnetwork_interface_info,
3813 Snetwork_interface_info, 1, 1, 0,
3814 doc: /* Return information about network interface named IFNAME.
3815 The return value is a list (ADDR BCAST NETMASK HWADDR FLAGS),
3816 where ADDR is the layer 3 address, BCAST is the layer 3 broadcast address,
3817 NETMASK is the layer 3 network mask, HWADDR is the layer 2 address, and
3818 FLAGS is the current flags of the interface.
3819
3820 Data that is unavailable is returned as nil. */)
3821 (Lisp_Object ifname)
3822 {
3823 #if ((defined HAVE_NET_IF_H \
3824 && (defined SIOCGIFADDR || defined SIOCGIFHWADDR \
3825 || defined SIOCGIFFLAGS)) \
3826 || defined WINDOWSNT)
3827 return network_interface_info (ifname);
3828 #else
3829 return Qnil;
3830 #endif
3831 }
3832
3833
3834 /* Turn off input and output for process PROC. */
3835
3836 static void
3837 deactivate_process (Lisp_Object proc)
3838 {
3839 int inchannel;
3840 struct Lisp_Process *p = XPROCESS (proc);
3841 int i;
3842
3843 #ifdef HAVE_GNUTLS
3844 /* Delete GnuTLS structures in PROC, if any. */
3845 emacs_gnutls_deinit (proc);
3846 #endif /* HAVE_GNUTLS */
3847
3848 #ifdef ADAPTIVE_READ_BUFFERING
3849 if (p->read_output_delay > 0)
3850 {
3851 if (--process_output_delay_count < 0)
3852 process_output_delay_count = 0;
3853 p->read_output_delay = 0;
3854 p->read_output_skip = 0;
3855 }
3856 #endif
3857
3858 /* Beware SIGCHLD hereabouts. */
3859
3860 for (i = 0; i < PROCESS_OPEN_FDS; i++)
3861 close_process_fd (&p->open_fd[i]);
3862
3863 inchannel = p->infd;
3864 if (inchannel >= 0)
3865 {
3866 p->infd = -1;
3867 p->outfd = -1;
3868 #ifdef DATAGRAM_SOCKETS
3869 if (DATAGRAM_CHAN_P (inchannel))
3870 {
3871 xfree (datagram_address[inchannel].sa);
3872 datagram_address[inchannel].sa = 0;
3873 datagram_address[inchannel].len = 0;
3874 }
3875 #endif
3876 chan_process[inchannel] = Qnil;
3877 FD_CLR (inchannel, &input_wait_mask);
3878 FD_CLR (inchannel, &non_keyboard_wait_mask);
3879 #ifdef NON_BLOCKING_CONNECT
3880 if (FD_ISSET (inchannel, &connect_wait_mask))
3881 {
3882 FD_CLR (inchannel, &connect_wait_mask);
3883 FD_CLR (inchannel, &write_mask);
3884 if (--num_pending_connects < 0)
3885 emacs_abort ();
3886 }
3887 #endif
3888 if (inchannel == max_process_desc)
3889 {
3890 /* We just closed the highest-numbered process input descriptor,
3891 so recompute the highest-numbered one now. */
3892 int i = inchannel;
3893 do
3894 i--;
3895 while (0 <= i && NILP (chan_process[i]));
3896
3897 max_process_desc = i;
3898 }
3899 }
3900 }
3901
3902 \f
3903 DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output,
3904 0, 4, 0,
3905 doc: /* Allow any pending output from subprocesses to be read by Emacs.
3906 It is given to their filter functions.
3907 Optional argument PROCESS means do not return until output has been
3908 received from PROCESS.
3909
3910 Optional second argument SECONDS and third argument MILLISEC
3911 specify a timeout; return after that much time even if there is
3912 no subprocess output. If SECONDS is a floating point number,
3913 it specifies a fractional number of seconds to wait.
3914 The MILLISEC argument is obsolete and should be avoided.
3915
3916 If optional fourth argument JUST-THIS-ONE is non-nil, accept output
3917 from PROCESS only, suspending reading output from other processes.
3918 If JUST-THIS-ONE is an integer, don't run any timers either.
3919 Return non-nil if we received any output from PROCESS (or, if PROCESS
3920 is nil, from any process) before the timeout expired. */)
3921 (register Lisp_Object process, Lisp_Object seconds, Lisp_Object millisec, Lisp_Object just_this_one)
3922 {
3923 intmax_t secs;
3924 int nsecs;
3925
3926 if (! NILP (process))
3927 CHECK_PROCESS (process);
3928 else
3929 just_this_one = Qnil;
3930
3931 if (!NILP (millisec))
3932 { /* Obsolete calling convention using integers rather than floats. */
3933 CHECK_NUMBER (millisec);
3934 if (NILP (seconds))
3935 seconds = make_float (XINT (millisec) / 1000.0);
3936 else
3937 {
3938 CHECK_NUMBER (seconds);
3939 seconds = make_float (XINT (millisec) / 1000.0 + XINT (seconds));
3940 }
3941 }
3942
3943 secs = 0;
3944 nsecs = -1;
3945
3946 if (!NILP (seconds))
3947 {
3948 if (INTEGERP (seconds))
3949 {
3950 if (XINT (seconds) > 0)
3951 {
3952 secs = XINT (seconds);
3953 nsecs = 0;
3954 }
3955 }
3956 else if (FLOATP (seconds))
3957 {
3958 if (XFLOAT_DATA (seconds) > 0)
3959 {
3960 struct timespec t = dtotimespec (XFLOAT_DATA (seconds));
3961 secs = min (t.tv_sec, WAIT_READING_MAX);
3962 nsecs = t.tv_nsec;
3963 }
3964 }
3965 else
3966 wrong_type_argument (Qnumberp, seconds);
3967 }
3968 else if (! NILP (process))
3969 nsecs = 0;
3970
3971 return
3972 ((wait_reading_process_output (secs, nsecs, 0, 0,
3973 Qnil,
3974 !NILP (process) ? XPROCESS (process) : NULL,
3975 (NILP (just_this_one) ? 0
3976 : !INTEGERP (just_this_one) ? 1 : -1))
3977 <= 0)
3978 ? Qnil : Qt);
3979 }
3980
3981 /* Accept a connection for server process SERVER on CHANNEL. */
3982
3983 static EMACS_INT connect_counter = 0;
3984
3985 static void
3986 server_accept_connection (Lisp_Object server, int channel)
3987 {
3988 Lisp_Object proc, caller, name, buffer;
3989 Lisp_Object contact, host, service;
3990 struct Lisp_Process *ps = XPROCESS (server);
3991 struct Lisp_Process *p;
3992 int s;
3993 union u_sockaddr {
3994 struct sockaddr sa;
3995 struct sockaddr_in in;
3996 #ifdef AF_INET6
3997 struct sockaddr_in6 in6;
3998 #endif
3999 #ifdef HAVE_LOCAL_SOCKETS
4000 struct sockaddr_un un;
4001 #endif
4002 } saddr;
4003 socklen_t len = sizeof saddr;
4004 ptrdiff_t count;
4005
4006 s = accept4 (channel, &saddr.sa, &len, SOCK_CLOEXEC);
4007
4008 if (s < 0)
4009 {
4010 int code = errno;
4011
4012 if (code == EAGAIN)
4013 return;
4014 #ifdef EWOULDBLOCK
4015 if (code == EWOULDBLOCK)
4016 return;
4017 #endif
4018
4019 if (!NILP (ps->log))
4020 call3 (ps->log, server, Qnil,
4021 concat3 (build_string ("accept failed with code"),
4022 Fnumber_to_string (make_number (code)),
4023 build_string ("\n")));
4024 return;
4025 }
4026
4027 count = SPECPDL_INDEX ();
4028 record_unwind_protect_int (close_file_unwind, s);
4029
4030 connect_counter++;
4031
4032 /* Setup a new process to handle the connection. */
4033
4034 /* Generate a unique identification of the caller, and build contact
4035 information for this process. */
4036 host = Qt;
4037 service = Qnil;
4038 switch (saddr.sa.sa_family)
4039 {
4040 case AF_INET:
4041 {
4042 unsigned char *ip = (unsigned char *)&saddr.in.sin_addr.s_addr;
4043
4044 AUTO_STRING (ipv4_format, "%d.%d.%d.%d");
4045 host = Fformat (5, ((Lisp_Object [])
4046 { ipv4_format, make_number (ip[0]),
4047 make_number (ip[1]), make_number (ip[2]), make_number (ip[3]) }));
4048 service = make_number (ntohs (saddr.in.sin_port));
4049 AUTO_STRING (caller_format, " <%s:%d>");
4050 caller = Fformat (3, (Lisp_Object []) {caller_format, host, service});
4051 }
4052 break;
4053
4054 #ifdef AF_INET6
4055 case AF_INET6:
4056 {
4057 Lisp_Object args[9];
4058 uint16_t *ip6 = (uint16_t *)&saddr.in6.sin6_addr;
4059 int i;
4060
4061 AUTO_STRING (ipv6_format, "%x:%x:%x:%x:%x:%x:%x:%x");
4062 args[0] = ipv6_format;
4063 for (i = 0; i < 8; i++)
4064 args[i + 1] = make_number (ntohs (ip6[i]));
4065 host = Fformat (9, args);
4066 service = make_number (ntohs (saddr.in.sin_port));
4067 AUTO_STRING (caller_format, " <[%s]:%d>");
4068 caller = Fformat (3, (Lisp_Object []) {caller_format, host, service});
4069 }
4070 break;
4071 #endif
4072
4073 #ifdef HAVE_LOCAL_SOCKETS
4074 case AF_LOCAL:
4075 #endif
4076 default:
4077 caller = Fnumber_to_string (make_number (connect_counter));
4078 AUTO_STRING (space_less_than, " <");
4079 AUTO_STRING (greater_than, ">");
4080 caller = concat3 (space_less_than, caller, greater_than);
4081 break;
4082 }
4083
4084 /* Create a new buffer name for this process if it doesn't have a
4085 filter. The new buffer name is based on the buffer name or
4086 process name of the server process concatenated with the caller
4087 identification. */
4088
4089 if (!(EQ (ps->filter, Qinternal_default_process_filter)
4090 || EQ (ps->filter, Qt)))
4091 buffer = Qnil;
4092 else
4093 {
4094 buffer = ps->buffer;
4095 if (!NILP (buffer))
4096 buffer = Fbuffer_name (buffer);
4097 else
4098 buffer = ps->name;
4099 if (!NILP (buffer))
4100 {
4101 buffer = concat2 (buffer, caller);
4102 buffer = Fget_buffer_create (buffer);
4103 }
4104 }
4105
4106 /* Generate a unique name for the new server process. Combine the
4107 server process name with the caller identification. */
4108
4109 name = concat2 (ps->name, caller);
4110 proc = make_process (name);
4111
4112 chan_process[s] = proc;
4113
4114 fcntl (s, F_SETFL, O_NONBLOCK);
4115
4116 p = XPROCESS (proc);
4117
4118 /* Build new contact information for this setup. */
4119 contact = Fcopy_sequence (ps->childp);
4120 contact = Fplist_put (contact, QCserver, Qnil);
4121 contact = Fplist_put (contact, QChost, host);
4122 if (!NILP (service))
4123 contact = Fplist_put (contact, QCservice, service);
4124 contact = Fplist_put (contact, QCremote,
4125 conv_sockaddr_to_lisp (&saddr.sa, len));
4126 #ifdef HAVE_GETSOCKNAME
4127 len = sizeof saddr;
4128 if (getsockname (s, &saddr.sa, &len) == 0)
4129 contact = Fplist_put (contact, QClocal,
4130 conv_sockaddr_to_lisp (&saddr.sa, len));
4131 #endif
4132
4133 pset_childp (p, contact);
4134 pset_plist (p, Fcopy_sequence (ps->plist));
4135 pset_type (p, Qnetwork);
4136
4137 pset_buffer (p, buffer);
4138 pset_sentinel (p, ps->sentinel);
4139 pset_filter (p, ps->filter);
4140 pset_command (p, Qnil);
4141 p->pid = 0;
4142
4143 /* Discard the unwind protect for closing S. */
4144 specpdl_ptr = specpdl + count;
4145
4146 p->open_fd[SUBPROCESS_STDIN] = s;
4147 p->infd = s;
4148 p->outfd = s;
4149 pset_status (p, Qrun);
4150
4151 /* Client processes for accepted connections are not stopped initially. */
4152 if (!EQ (p->filter, Qt))
4153 {
4154 FD_SET (s, &input_wait_mask);
4155 FD_SET (s, &non_keyboard_wait_mask);
4156 }
4157
4158 if (s > max_process_desc)
4159 max_process_desc = s;
4160
4161 /* Setup coding system for new process based on server process.
4162 This seems to be the proper thing to do, as the coding system
4163 of the new process should reflect the settings at the time the
4164 server socket was opened; not the current settings. */
4165
4166 pset_decode_coding_system (p, ps->decode_coding_system);
4167 pset_encode_coding_system (p, ps->encode_coding_system);
4168 setup_process_coding_systems (proc);
4169
4170 pset_decoding_buf (p, empty_unibyte_string);
4171 p->decoding_carryover = 0;
4172 pset_encoding_buf (p, empty_unibyte_string);
4173
4174 p->inherit_coding_system_flag
4175 = (NILP (buffer) ? 0 : ps->inherit_coding_system_flag);
4176
4177 AUTO_STRING (dash, "-");
4178 AUTO_STRING (nl, "\n");
4179 Lisp_Object host_string = STRINGP (host) ? host : dash;
4180
4181 if (!NILP (ps->log))
4182 {
4183 AUTO_STRING (accept_from, "accept from ");
4184 call3 (ps->log, server, proc, concat3 (accept_from, host_string, nl));
4185 }
4186
4187 AUTO_STRING (open_from, "open from ");
4188 exec_sentinel (proc, concat3 (open_from, host_string, nl));
4189 }
4190
4191 /* This variable is different from waiting_for_input in keyboard.c.
4192 It is used to communicate to a lisp process-filter/sentinel (via the
4193 function Fwaiting_for_user_input_p below) whether Emacs was waiting
4194 for user-input when that process-filter was called.
4195 waiting_for_input cannot be used as that is by definition 0 when
4196 lisp code is being evalled.
4197 This is also used in record_asynch_buffer_change.
4198 For that purpose, this must be 0
4199 when not inside wait_reading_process_output. */
4200 static int waiting_for_user_input_p;
4201
4202 static void
4203 wait_reading_process_output_unwind (int data)
4204 {
4205 waiting_for_user_input_p = data;
4206 }
4207
4208 /* This is here so breakpoints can be put on it. */
4209 static void
4210 wait_reading_process_output_1 (void)
4211 {
4212 }
4213
4214 /* Read and dispose of subprocess output while waiting for timeout to
4215 elapse and/or keyboard input to be available.
4216
4217 TIME_LIMIT is:
4218 timeout in seconds
4219 If negative, gobble data immediately available but don't wait for any.
4220
4221 NSECS is:
4222 an additional duration to wait, measured in nanoseconds
4223 If TIME_LIMIT is zero, then:
4224 If NSECS == 0, there is no limit.
4225 If NSECS > 0, the timeout consists of NSECS only.
4226 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
4227
4228 READ_KBD is:
4229 0 to ignore keyboard input, or
4230 1 to return when input is available, or
4231 -1 meaning caller will actually read the input, so don't throw to
4232 the quit handler, or
4233
4234 DO_DISPLAY means redisplay should be done to show subprocess
4235 output that arrives.
4236
4237 If WAIT_FOR_CELL is a cons cell, wait until its car is non-nil
4238 (and gobble terminal input into the buffer if any arrives).
4239
4240 If WAIT_PROC is specified, wait until something arrives from that
4241 process.
4242
4243 If JUST_WAIT_PROC is nonzero, handle only output from WAIT_PROC
4244 (suspending output from other processes). A negative value
4245 means don't run any timers either.
4246
4247 Return positive if we received input from WAIT_PROC (or from any
4248 process if WAIT_PROC is null), zero if we attempted to receive
4249 input but got none, and negative if we didn't even try. */
4250
4251 int
4252 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
4253 bool do_display,
4254 Lisp_Object wait_for_cell,
4255 struct Lisp_Process *wait_proc, int just_wait_proc)
4256 {
4257 int channel, nfds;
4258 fd_set Available;
4259 fd_set Writeok;
4260 bool check_write;
4261 int check_delay;
4262 bool no_avail;
4263 int xerrno;
4264 Lisp_Object proc;
4265 struct timespec timeout, end_time;
4266 int got_some_input = -1;
4267 ptrdiff_t count = SPECPDL_INDEX ();
4268
4269 FD_ZERO (&Available);
4270 FD_ZERO (&Writeok);
4271
4272 if (time_limit == 0 && nsecs == 0 && wait_proc && !NILP (Vinhibit_quit)
4273 && !(CONSP (wait_proc->status)
4274 && EQ (XCAR (wait_proc->status), Qexit)))
4275 message1 ("Blocking call to accept-process-output with quit inhibited!!");
4276
4277 record_unwind_protect_int (wait_reading_process_output_unwind,
4278 waiting_for_user_input_p);
4279 waiting_for_user_input_p = read_kbd;
4280
4281 if (time_limit < 0)
4282 {
4283 time_limit = 0;
4284 nsecs = -1;
4285 }
4286 else if (TYPE_MAXIMUM (time_t) < time_limit)
4287 time_limit = TYPE_MAXIMUM (time_t);
4288
4289 /* Since we may need to wait several times,
4290 compute the absolute time to return at. */
4291 if (time_limit || nsecs > 0)
4292 {
4293 timeout = make_timespec (time_limit, nsecs);
4294 end_time = timespec_add (current_timespec (), timeout);
4295 }
4296
4297 while (1)
4298 {
4299 bool timeout_reduced_for_timers = false;
4300
4301 /* If calling from keyboard input, do not quit
4302 since we want to return C-g as an input character.
4303 Otherwise, do pending quit if requested. */
4304 if (read_kbd >= 0)
4305 QUIT;
4306 else if (pending_signals)
4307 process_pending_signals ();
4308
4309 /* Exit now if the cell we're waiting for became non-nil. */
4310 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4311 break;
4312
4313 /* After reading input, vacuum up any leftovers without waiting. */
4314 if (0 <= got_some_input)
4315 nsecs = -1;
4316
4317 /* Compute time from now till when time limit is up. */
4318 /* Exit if already run out. */
4319 if (nsecs < 0)
4320 {
4321 /* A negative timeout means
4322 gobble output available now
4323 but don't wait at all. */
4324
4325 timeout = make_timespec (0, 0);
4326 }
4327 else if (time_limit || nsecs > 0)
4328 {
4329 struct timespec now = current_timespec ();
4330 if (timespec_cmp (end_time, now) <= 0)
4331 break;
4332 timeout = timespec_sub (end_time, now);
4333 }
4334 else
4335 {
4336 timeout = make_timespec (100000, 0);
4337 }
4338
4339 /* Normally we run timers here.
4340 But not if wait_for_cell; in those cases,
4341 the wait is supposed to be short,
4342 and those callers cannot handle running arbitrary Lisp code here. */
4343 if (NILP (wait_for_cell)
4344 && just_wait_proc >= 0)
4345 {
4346 struct timespec timer_delay;
4347
4348 do
4349 {
4350 unsigned old_timers_run = timers_run;
4351 struct buffer *old_buffer = current_buffer;
4352 Lisp_Object old_window = selected_window;
4353
4354 timer_delay = timer_check ();
4355
4356 /* If a timer has run, this might have changed buffers
4357 an alike. Make read_key_sequence aware of that. */
4358 if (timers_run != old_timers_run
4359 && (old_buffer != current_buffer
4360 || !EQ (old_window, selected_window))
4361 && waiting_for_user_input_p == -1)
4362 record_asynch_buffer_change ();
4363
4364 if (timers_run != old_timers_run && do_display)
4365 /* We must retry, since a timer may have requeued itself
4366 and that could alter the time_delay. */
4367 redisplay_preserve_echo_area (9);
4368 else
4369 break;
4370 }
4371 while (!detect_input_pending ());
4372
4373 /* If there is unread keyboard input, also return. */
4374 if (read_kbd != 0
4375 && requeued_events_pending_p ())
4376 break;
4377
4378 /* A negative timeout means do not wait at all. */
4379 if (nsecs >= 0)
4380 {
4381 if (timespec_valid_p (timer_delay))
4382 {
4383 if (timespec_cmp (timer_delay, timeout) < 0)
4384 {
4385 timeout = timer_delay;
4386 timeout_reduced_for_timers = true;
4387 }
4388 }
4389 else
4390 {
4391 /* This is so a breakpoint can be put here. */
4392 wait_reading_process_output_1 ();
4393 }
4394 }
4395 }
4396
4397 /* Cause C-g and alarm signals to take immediate action,
4398 and cause input available signals to zero out timeout.
4399
4400 It is important that we do this before checking for process
4401 activity. If we get a SIGCHLD after the explicit checks for
4402 process activity, timeout is the only way we will know. */
4403 if (read_kbd < 0)
4404 set_waiting_for_input (&timeout);
4405
4406 /* If status of something has changed, and no input is
4407 available, notify the user of the change right away. After
4408 this explicit check, we'll let the SIGCHLD handler zap
4409 timeout to get our attention. */
4410 if (update_tick != process_tick)
4411 {
4412 fd_set Atemp;
4413 fd_set Ctemp;
4414
4415 if (kbd_on_hold_p ())
4416 FD_ZERO (&Atemp);
4417 else
4418 Atemp = input_wait_mask;
4419 Ctemp = write_mask;
4420
4421 timeout = make_timespec (0, 0);
4422 if ((pselect (max (max_process_desc, max_input_desc) + 1,
4423 &Atemp,
4424 #ifdef NON_BLOCKING_CONNECT
4425 (num_pending_connects > 0 ? &Ctemp : NULL),
4426 #else
4427 NULL,
4428 #endif
4429 NULL, &timeout, NULL)
4430 <= 0))
4431 {
4432 /* It's okay for us to do this and then continue with
4433 the loop, since timeout has already been zeroed out. */
4434 clear_waiting_for_input ();
4435 got_some_input = status_notify (NULL, wait_proc);
4436 if (do_display) redisplay_preserve_echo_area (13);
4437 }
4438 }
4439
4440 /* Don't wait for output from a non-running process. Just
4441 read whatever data has already been received. */
4442 if (wait_proc && wait_proc->raw_status_new)
4443 update_status (wait_proc);
4444 if (wait_proc
4445 && wait_proc->infd >= 0
4446 && ! EQ (wait_proc->status, Qrun)
4447 && ! EQ (wait_proc->status, Qconnect))
4448 {
4449 bool read_some_bytes = false;
4450
4451 clear_waiting_for_input ();
4452 XSETPROCESS (proc, wait_proc);
4453
4454 /* Read data from the process, until we exhaust it. */
4455 while (true)
4456 {
4457 int nread = read_process_output (proc, wait_proc->infd);
4458 if (nread < 0)
4459 {
4460 if (errno == EIO || errno == EAGAIN)
4461 break;
4462 #ifdef EWOULDBLOCK
4463 if (errno == EWOULDBLOCK)
4464 break;
4465 #endif
4466 }
4467 else
4468 {
4469 if (got_some_input < nread)
4470 got_some_input = nread;
4471 if (nread == 0)
4472 break;
4473 read_some_bytes = true;
4474 }
4475 }
4476 if (read_some_bytes && do_display)
4477 redisplay_preserve_echo_area (10);
4478
4479 break;
4480 }
4481
4482 /* Wait till there is something to do. */
4483
4484 if (wait_proc && just_wait_proc)
4485 {
4486 if (wait_proc->infd < 0) /* Terminated. */
4487 break;
4488 FD_SET (wait_proc->infd, &Available);
4489 check_delay = 0;
4490 check_write = 0;
4491 }
4492 else if (!NILP (wait_for_cell))
4493 {
4494 Available = non_process_wait_mask;
4495 check_delay = 0;
4496 check_write = 0;
4497 }
4498 else
4499 {
4500 if (! read_kbd)
4501 Available = non_keyboard_wait_mask;
4502 else
4503 Available = input_wait_mask;
4504 Writeok = write_mask;
4505 check_delay = wait_proc ? 0 : process_output_delay_count;
4506 check_write = SELECT_CAN_DO_WRITE_MASK;
4507 }
4508
4509 /* If frame size has changed or the window is newly mapped,
4510 redisplay now, before we start to wait. There is a race
4511 condition here; if a SIGIO arrives between now and the select
4512 and indicates that a frame is trashed, the select may block
4513 displaying a trashed screen. */
4514 if (frame_garbaged && do_display)
4515 {
4516 clear_waiting_for_input ();
4517 redisplay_preserve_echo_area (11);
4518 if (read_kbd < 0)
4519 set_waiting_for_input (&timeout);
4520 }
4521
4522 /* Skip the `select' call if input is available and we're
4523 waiting for keyboard input or a cell change (which can be
4524 triggered by processing X events). In the latter case, set
4525 nfds to 1 to avoid breaking the loop. */
4526 no_avail = 0;
4527 if ((read_kbd || !NILP (wait_for_cell))
4528 && detect_input_pending ())
4529 {
4530 nfds = read_kbd ? 0 : 1;
4531 no_avail = 1;
4532 FD_ZERO (&Available);
4533 }
4534
4535 if (!no_avail)
4536 {
4537
4538 #ifdef ADAPTIVE_READ_BUFFERING
4539 /* Set the timeout for adaptive read buffering if any
4540 process has non-zero read_output_skip and non-zero
4541 read_output_delay, and we are not reading output for a
4542 specific process. It is not executed if
4543 Vprocess_adaptive_read_buffering is nil. */
4544 if (process_output_skip && check_delay > 0)
4545 {
4546 int nsecs = timeout.tv_nsec;
4547 if (timeout.tv_sec > 0 || nsecs > READ_OUTPUT_DELAY_MAX)
4548 nsecs = READ_OUTPUT_DELAY_MAX;
4549 for (channel = 0; check_delay > 0 && channel <= max_process_desc; channel++)
4550 {
4551 proc = chan_process[channel];
4552 if (NILP (proc))
4553 continue;
4554 /* Find minimum non-zero read_output_delay among the
4555 processes with non-zero read_output_skip. */
4556 if (XPROCESS (proc)->read_output_delay > 0)
4557 {
4558 check_delay--;
4559 if (!XPROCESS (proc)->read_output_skip)
4560 continue;
4561 FD_CLR (channel, &Available);
4562 XPROCESS (proc)->read_output_skip = 0;
4563 if (XPROCESS (proc)->read_output_delay < nsecs)
4564 nsecs = XPROCESS (proc)->read_output_delay;
4565 }
4566 }
4567 timeout = make_timespec (0, nsecs);
4568 process_output_skip = 0;
4569 }
4570 #endif
4571
4572 #if defined (HAVE_NS)
4573 nfds = ns_select
4574 #elif defined (HAVE_GLIB)
4575 nfds = xg_select
4576 #else
4577 nfds = pselect
4578 #endif
4579 (max (max_process_desc, max_input_desc) + 1,
4580 &Available,
4581 (check_write ? &Writeok : 0),
4582 NULL, &timeout, NULL);
4583
4584 #ifdef HAVE_GNUTLS
4585 /* GnuTLS buffers data internally. In lowat mode it leaves
4586 some data in the TCP buffers so that select works, but
4587 with custom pull/push functions we need to check if some
4588 data is available in the buffers manually. */
4589 if (nfds == 0)
4590 {
4591 if (! wait_proc)
4592 {
4593 /* We're not waiting on a specific process, so loop
4594 through all the channels and check for data.
4595 This is a workaround needed for some versions of
4596 the gnutls library -- 2.12.14 has been confirmed
4597 to need it. See
4598 http://comments.gmane.org/gmane.emacs.devel/145074 */
4599 for (channel = 0; channel < FD_SETSIZE; ++channel)
4600 if (! NILP (chan_process[channel]))
4601 {
4602 struct Lisp_Process *p =
4603 XPROCESS (chan_process[channel]);
4604 if (p && p->gnutls_p && p->gnutls_state
4605 && ((emacs_gnutls_record_check_pending
4606 (p->gnutls_state))
4607 > 0))
4608 {
4609 nfds++;
4610 eassert (p->infd == channel);
4611 FD_SET (p->infd, &Available);
4612 }
4613 }
4614 }
4615 else
4616 {
4617 /* Check this specific channel. */
4618 if (wait_proc->gnutls_p /* Check for valid process. */
4619 && wait_proc->gnutls_state
4620 /* Do we have pending data? */
4621 && ((emacs_gnutls_record_check_pending
4622 (wait_proc->gnutls_state))
4623 > 0))
4624 {
4625 nfds = 1;
4626 eassert (0 <= wait_proc->infd);
4627 /* Set to Available. */
4628 FD_SET (wait_proc->infd, &Available);
4629 }
4630 }
4631 }
4632 #endif
4633 }
4634
4635 xerrno = errno;
4636
4637 /* Make C-g and alarm signals set flags again. */
4638 clear_waiting_for_input ();
4639
4640 /* If we woke up due to SIGWINCH, actually change size now. */
4641 do_pending_window_change (0);
4642
4643 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
4644 /* We waited the full specified time, so return now. */
4645 break;
4646 if (nfds < 0)
4647 {
4648 if (xerrno == EINTR)
4649 no_avail = 1;
4650 else if (xerrno == EBADF)
4651 emacs_abort ();
4652 else
4653 report_file_errno ("Failed select", Qnil, xerrno);
4654 }
4655
4656 /* Check for keyboard input. */
4657 /* If there is any, return immediately
4658 to give it higher priority than subprocesses. */
4659
4660 if (read_kbd != 0)
4661 {
4662 unsigned old_timers_run = timers_run;
4663 struct buffer *old_buffer = current_buffer;
4664 Lisp_Object old_window = selected_window;
4665 bool leave = false;
4666
4667 if (detect_input_pending_run_timers (do_display))
4668 {
4669 swallow_events (do_display);
4670 if (detect_input_pending_run_timers (do_display))
4671 leave = true;
4672 }
4673
4674 /* If a timer has run, this might have changed buffers
4675 an alike. Make read_key_sequence aware of that. */
4676 if (timers_run != old_timers_run
4677 && waiting_for_user_input_p == -1
4678 && (old_buffer != current_buffer
4679 || !EQ (old_window, selected_window)))
4680 record_asynch_buffer_change ();
4681
4682 if (leave)
4683 break;
4684 }
4685
4686 /* If there is unread keyboard input, also return. */
4687 if (read_kbd != 0
4688 && requeued_events_pending_p ())
4689 break;
4690
4691 /* If we are not checking for keyboard input now,
4692 do process events (but don't run any timers).
4693 This is so that X events will be processed.
4694 Otherwise they may have to wait until polling takes place.
4695 That would causes delays in pasting selections, for example.
4696
4697 (We used to do this only if wait_for_cell.) */
4698 if (read_kbd == 0 && detect_input_pending ())
4699 {
4700 swallow_events (do_display);
4701 #if 0 /* Exiting when read_kbd doesn't request that seems wrong, though. */
4702 if (detect_input_pending ())
4703 break;
4704 #endif
4705 }
4706
4707 /* Exit now if the cell we're waiting for became non-nil. */
4708 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
4709 break;
4710
4711 #ifdef USABLE_SIGIO
4712 /* If we think we have keyboard input waiting, but didn't get SIGIO,
4713 go read it. This can happen with X on BSD after logging out.
4714 In that case, there really is no input and no SIGIO,
4715 but select says there is input. */
4716
4717 if (read_kbd && interrupt_input
4718 && keyboard_bit_set (&Available) && ! noninteractive)
4719 handle_input_available_signal (SIGIO);
4720 #endif
4721
4722 /* If checking input just got us a size-change event from X,
4723 obey it now if we should. */
4724 if (read_kbd || ! NILP (wait_for_cell))
4725 do_pending_window_change (0);
4726
4727 /* Check for data from a process. */
4728 if (no_avail || nfds == 0)
4729 continue;
4730
4731 for (channel = 0; channel <= max_input_desc; ++channel)
4732 {
4733 struct fd_callback_data *d = &fd_callback_info[channel];
4734 if (d->func
4735 && ((d->condition & FOR_READ
4736 && FD_ISSET (channel, &Available))
4737 || (d->condition & FOR_WRITE
4738 && FD_ISSET (channel, &write_mask))))
4739 d->func (channel, d->data);
4740 }
4741
4742 for (channel = 0; channel <= max_process_desc; channel++)
4743 {
4744 if (FD_ISSET (channel, &Available)
4745 && FD_ISSET (channel, &non_keyboard_wait_mask)
4746 && !FD_ISSET (channel, &non_process_wait_mask))
4747 {
4748 int nread;
4749
4750 /* If waiting for this channel, arrange to return as
4751 soon as no more input to be processed. No more
4752 waiting. */
4753 proc = chan_process[channel];
4754 if (NILP (proc))
4755 continue;
4756
4757 /* If this is a server stream socket, accept connection. */
4758 if (EQ (XPROCESS (proc)->status, Qlisten))
4759 {
4760 server_accept_connection (proc, channel);
4761 continue;
4762 }
4763
4764 /* Read data from the process, starting with our
4765 buffered-ahead character if we have one. */
4766
4767 nread = read_process_output (proc, channel);
4768 if ((!wait_proc || wait_proc == XPROCESS (proc)) && got_some_input < nread)
4769 got_some_input = nread;
4770 if (nread > 0)
4771 {
4772 /* Since read_process_output can run a filter,
4773 which can call accept-process-output,
4774 don't try to read from any other processes
4775 before doing the select again. */
4776 FD_ZERO (&Available);
4777
4778 if (do_display)
4779 redisplay_preserve_echo_area (12);
4780 }
4781 #ifdef EWOULDBLOCK
4782 else if (nread == -1 && errno == EWOULDBLOCK)
4783 ;
4784 #endif
4785 else if (nread == -1 && errno == EAGAIN)
4786 ;
4787 #ifdef WINDOWSNT
4788 /* FIXME: Is this special case still needed? */
4789 /* Note that we cannot distinguish between no input
4790 available now and a closed pipe.
4791 With luck, a closed pipe will be accompanied by
4792 subprocess termination and SIGCHLD. */
4793 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4794 ;
4795 #endif
4796 #ifdef HAVE_PTYS
4797 /* On some OSs with ptys, when the process on one end of
4798 a pty exits, the other end gets an error reading with
4799 errno = EIO instead of getting an EOF (0 bytes read).
4800 Therefore, if we get an error reading and errno =
4801 EIO, just continue, because the child process has
4802 exited and should clean itself up soon (e.g. when we
4803 get a SIGCHLD). */
4804 else if (nread == -1 && errno == EIO)
4805 {
4806 struct Lisp_Process *p = XPROCESS (proc);
4807
4808 /* Clear the descriptor now, so we only raise the
4809 signal once. */
4810 FD_CLR (channel, &input_wait_mask);
4811 FD_CLR (channel, &non_keyboard_wait_mask);
4812
4813 if (p->pid == -2)
4814 {
4815 /* If the EIO occurs on a pty, the SIGCHLD handler's
4816 waitpid call will not find the process object to
4817 delete. Do it here. */
4818 p->tick = ++process_tick;
4819 pset_status (p, Qfailed);
4820 }
4821 }
4822 #endif /* HAVE_PTYS */
4823 /* If we can detect process termination, don't consider the
4824 process gone just because its pipe is closed. */
4825 else if (nread == 0 && !NETCONN_P (proc) && !SERIALCONN_P (proc))
4826 ;
4827 else
4828 {
4829 /* Preserve status of processes already terminated. */
4830 XPROCESS (proc)->tick = ++process_tick;
4831 deactivate_process (proc);
4832 if (XPROCESS (proc)->raw_status_new)
4833 update_status (XPROCESS (proc));
4834 if (EQ (XPROCESS (proc)->status, Qrun))
4835 pset_status (XPROCESS (proc),
4836 list2 (Qexit, make_number (256)));
4837 }
4838 }
4839 #ifdef NON_BLOCKING_CONNECT
4840 if (FD_ISSET (channel, &Writeok)
4841 && FD_ISSET (channel, &connect_wait_mask))
4842 {
4843 struct Lisp_Process *p;
4844
4845 FD_CLR (channel, &connect_wait_mask);
4846 FD_CLR (channel, &write_mask);
4847 if (--num_pending_connects < 0)
4848 emacs_abort ();
4849
4850 proc = chan_process[channel];
4851 if (NILP (proc))
4852 continue;
4853
4854 p = XPROCESS (proc);
4855
4856 #ifdef GNU_LINUX
4857 /* getsockopt(,,SO_ERROR,,) is said to hang on some systems.
4858 So only use it on systems where it is known to work. */
4859 {
4860 socklen_t xlen = sizeof (xerrno);
4861 if (getsockopt (channel, SOL_SOCKET, SO_ERROR, &xerrno, &xlen))
4862 xerrno = errno;
4863 }
4864 #else
4865 {
4866 struct sockaddr pname;
4867 socklen_t pnamelen = sizeof (pname);
4868
4869 /* If connection failed, getpeername will fail. */
4870 xerrno = 0;
4871 if (getpeername (channel, &pname, &pnamelen) < 0)
4872 {
4873 /* Obtain connect failure code through error slippage. */
4874 char dummy;
4875 xerrno = errno;
4876 if (errno == ENOTCONN && read (channel, &dummy, 1) < 0)
4877 xerrno = errno;
4878 }
4879 }
4880 #endif
4881 if (xerrno)
4882 {
4883 p->tick = ++process_tick;
4884 pset_status (p, list2 (Qfailed, make_number (xerrno)));
4885 deactivate_process (proc);
4886 }
4887 else
4888 {
4889 pset_status (p, Qrun);
4890 /* Execute the sentinel here. If we had relied on
4891 status_notify to do it later, it will read input
4892 from the process before calling the sentinel. */
4893 exec_sentinel (proc, build_string ("open\n"));
4894 if (0 <= p->infd && !EQ (p->filter, Qt)
4895 && !EQ (p->command, Qt))
4896 {
4897 FD_SET (p->infd, &input_wait_mask);
4898 FD_SET (p->infd, &non_keyboard_wait_mask);
4899 }
4900 }
4901 }
4902 #endif /* NON_BLOCKING_CONNECT */
4903 } /* End for each file descriptor. */
4904 } /* End while exit conditions not met. */
4905
4906 unbind_to (count, Qnil);
4907
4908 /* If calling from keyboard input, do not quit
4909 since we want to return C-g as an input character.
4910 Otherwise, do pending quit if requested. */
4911 if (read_kbd >= 0)
4912 {
4913 /* Prevent input_pending from remaining set if we quit. */
4914 clear_input_pending ();
4915 QUIT;
4916 }
4917
4918 return got_some_input;
4919 }
4920 \f
4921 /* Given a list (FUNCTION ARGS...), apply FUNCTION to the ARGS. */
4922
4923 static Lisp_Object
4924 read_process_output_call (Lisp_Object fun_and_args)
4925 {
4926 return apply1 (XCAR (fun_and_args), XCDR (fun_and_args));
4927 }
4928
4929 static Lisp_Object
4930 read_process_output_error_handler (Lisp_Object error_val)
4931 {
4932 cmd_error_internal (error_val, "error in process filter: ");
4933 Vinhibit_quit = Qt;
4934 update_echo_area ();
4935 Fsleep_for (make_number (2), Qnil);
4936 return Qt;
4937 }
4938
4939 static void
4940 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
4941 ssize_t nbytes,
4942 struct coding_system *coding);
4943
4944 /* Read pending output from the process channel,
4945 starting with our buffered-ahead character if we have one.
4946 Yield number of decoded characters read.
4947
4948 This function reads at most 4096 characters.
4949 If you want to read all available subprocess output,
4950 you must call it repeatedly until it returns zero.
4951
4952 The characters read are decoded according to PROC's coding-system
4953 for decoding. */
4954
4955 static int
4956 read_process_output (Lisp_Object proc, int channel)
4957 {
4958 ssize_t nbytes;
4959 struct Lisp_Process *p = XPROCESS (proc);
4960 struct coding_system *coding = proc_decode_coding_system[channel];
4961 int carryover = p->decoding_carryover;
4962 enum { readmax = 4096 };
4963 ptrdiff_t count = SPECPDL_INDEX ();
4964 Lisp_Object odeactivate;
4965 char chars[sizeof coding->carryover + readmax];
4966
4967 if (carryover)
4968 /* See the comment above. */
4969 memcpy (chars, SDATA (p->decoding_buf), carryover);
4970
4971 #ifdef DATAGRAM_SOCKETS
4972 /* We have a working select, so proc_buffered_char is always -1. */
4973 if (DATAGRAM_CHAN_P (channel))
4974 {
4975 socklen_t len = datagram_address[channel].len;
4976 nbytes = recvfrom (channel, chars + carryover, readmax,
4977 0, datagram_address[channel].sa, &len);
4978 }
4979 else
4980 #endif
4981 {
4982 bool buffered = proc_buffered_char[channel] >= 0;
4983 if (buffered)
4984 {
4985 chars[carryover] = proc_buffered_char[channel];
4986 proc_buffered_char[channel] = -1;
4987 }
4988 #ifdef HAVE_GNUTLS
4989 if (p->gnutls_p && p->gnutls_state)
4990 nbytes = emacs_gnutls_read (p, chars + carryover + buffered,
4991 readmax - buffered);
4992 else
4993 #endif
4994 nbytes = emacs_read (channel, chars + carryover + buffered,
4995 readmax - buffered);
4996 #ifdef ADAPTIVE_READ_BUFFERING
4997 if (nbytes > 0 && p->adaptive_read_buffering)
4998 {
4999 int delay = p->read_output_delay;
5000 if (nbytes < 256)
5001 {
5002 if (delay < READ_OUTPUT_DELAY_MAX_MAX)
5003 {
5004 if (delay == 0)
5005 process_output_delay_count++;
5006 delay += READ_OUTPUT_DELAY_INCREMENT * 2;
5007 }
5008 }
5009 else if (delay > 0 && nbytes == readmax - buffered)
5010 {
5011 delay -= READ_OUTPUT_DELAY_INCREMENT;
5012 if (delay == 0)
5013 process_output_delay_count--;
5014 }
5015 p->read_output_delay = delay;
5016 if (delay)
5017 {
5018 p->read_output_skip = 1;
5019 process_output_skip = 1;
5020 }
5021 }
5022 #endif
5023 nbytes += buffered;
5024 nbytes += buffered && nbytes <= 0;
5025 }
5026
5027 p->decoding_carryover = 0;
5028
5029 /* At this point, NBYTES holds number of bytes just received
5030 (including the one in proc_buffered_char[channel]). */
5031 if (nbytes <= 0)
5032 {
5033 if (nbytes < 0 || coding->mode & CODING_MODE_LAST_BLOCK)
5034 return nbytes;
5035 coding->mode |= CODING_MODE_LAST_BLOCK;
5036 }
5037
5038 /* Now set NBYTES how many bytes we must decode. */
5039 nbytes += carryover;
5040
5041 odeactivate = Vdeactivate_mark;
5042 /* There's no good reason to let process filters change the current
5043 buffer, and many callers of accept-process-output, sit-for, and
5044 friends don't expect current-buffer to be changed from under them. */
5045 record_unwind_current_buffer ();
5046
5047 read_and_dispose_of_process_output (p, chars, nbytes, coding);
5048
5049 /* Handling the process output should not deactivate the mark. */
5050 Vdeactivate_mark = odeactivate;
5051
5052 unbind_to (count, Qnil);
5053 return nbytes;
5054 }
5055
5056 static void
5057 read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars,
5058 ssize_t nbytes,
5059 struct coding_system *coding)
5060 {
5061 Lisp_Object outstream = p->filter;
5062 Lisp_Object text;
5063 bool outer_running_asynch_code = running_asynch_code;
5064 int waiting = waiting_for_user_input_p;
5065
5066 /* No need to gcpro these, because all we do with them later
5067 is test them for EQness, and none of them should be a string. */
5068 #if 0
5069 Lisp_Object obuffer, okeymap;
5070 XSETBUFFER (obuffer, current_buffer);
5071 okeymap = BVAR (current_buffer, keymap);
5072 #endif
5073
5074 /* We inhibit quit here instead of just catching it so that
5075 hitting ^G when a filter happens to be running won't screw
5076 it up. */
5077 specbind (Qinhibit_quit, Qt);
5078 specbind (Qlast_nonmenu_event, Qt);
5079
5080 /* In case we get recursively called,
5081 and we already saved the match data nonrecursively,
5082 save the same match data in safely recursive fashion. */
5083 if (outer_running_asynch_code)
5084 {
5085 Lisp_Object tem;
5086 /* Don't clobber the CURRENT match data, either! */
5087 tem = Fmatch_data (Qnil, Qnil, Qnil);
5088 restore_search_regs ();
5089 record_unwind_save_match_data ();
5090 Fset_match_data (tem, Qt);
5091 }
5092
5093 /* For speed, if a search happens within this code,
5094 save the match data in a special nonrecursive fashion. */
5095 running_asynch_code = 1;
5096
5097 decode_coding_c_string (coding, (unsigned char *) chars, nbytes, Qt);
5098 text = coding->dst_object;
5099 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5100 /* A new coding system might be found. */
5101 if (!EQ (p->decode_coding_system, Vlast_coding_system_used))
5102 {
5103 pset_decode_coding_system (p, Vlast_coding_system_used);
5104
5105 /* Don't call setup_coding_system for
5106 proc_decode_coding_system[channel] here. It is done in
5107 detect_coding called via decode_coding above. */
5108
5109 /* If a coding system for encoding is not yet decided, we set
5110 it as the same as coding-system for decoding.
5111
5112 But, before doing that we must check if
5113 proc_encode_coding_system[p->outfd] surely points to a
5114 valid memory because p->outfd will be changed once EOF is
5115 sent to the process. */
5116 if (NILP (p->encode_coding_system) && p->outfd >= 0
5117 && proc_encode_coding_system[p->outfd])
5118 {
5119 pset_encode_coding_system
5120 (p, coding_inherit_eol_type (Vlast_coding_system_used, Qnil));
5121 setup_coding_system (p->encode_coding_system,
5122 proc_encode_coding_system[p->outfd]);
5123 }
5124 }
5125
5126 if (coding->carryover_bytes > 0)
5127 {
5128 if (SCHARS (p->decoding_buf) < coding->carryover_bytes)
5129 pset_decoding_buf (p, make_uninit_string (coding->carryover_bytes));
5130 memcpy (SDATA (p->decoding_buf), coding->carryover,
5131 coding->carryover_bytes);
5132 p->decoding_carryover = coding->carryover_bytes;
5133 }
5134 if (SBYTES (text) > 0)
5135 /* FIXME: It's wrong to wrap or not based on debug-on-error, and
5136 sometimes it's simply wrong to wrap (e.g. when called from
5137 accept-process-output). */
5138 internal_condition_case_1 (read_process_output_call,
5139 list3 (outstream, make_lisp_proc (p), text),
5140 !NILP (Vdebug_on_error) ? Qnil : Qerror,
5141 read_process_output_error_handler);
5142
5143 /* If we saved the match data nonrecursively, restore it now. */
5144 restore_search_regs ();
5145 running_asynch_code = outer_running_asynch_code;
5146
5147 /* Restore waiting_for_user_input_p as it was
5148 when we were called, in case the filter clobbered it. */
5149 waiting_for_user_input_p = waiting;
5150
5151 #if 0 /* Call record_asynch_buffer_change unconditionally,
5152 because we might have changed minor modes or other things
5153 that affect key bindings. */
5154 if (! EQ (Fcurrent_buffer (), obuffer)
5155 || ! EQ (current_buffer->keymap, okeymap))
5156 #endif
5157 /* But do it only if the caller is actually going to read events.
5158 Otherwise there's no need to make him wake up, and it could
5159 cause trouble (for example it would make sit_for return). */
5160 if (waiting_for_user_input_p == -1)
5161 record_asynch_buffer_change ();
5162 }
5163
5164 DEFUN ("internal-default-process-filter", Finternal_default_process_filter,
5165 Sinternal_default_process_filter, 2, 2, 0,
5166 doc: /* Function used as default process filter.
5167 This inserts the process's output into its buffer, if there is one.
5168 Otherwise it discards the output. */)
5169 (Lisp_Object proc, Lisp_Object text)
5170 {
5171 struct Lisp_Process *p;
5172 ptrdiff_t opoint;
5173
5174 CHECK_PROCESS (proc);
5175 p = XPROCESS (proc);
5176 CHECK_STRING (text);
5177
5178 if (!NILP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5179 {
5180 Lisp_Object old_read_only;
5181 ptrdiff_t old_begv, old_zv;
5182 ptrdiff_t old_begv_byte, old_zv_byte;
5183 ptrdiff_t before, before_byte;
5184 ptrdiff_t opoint_byte;
5185 struct buffer *b;
5186
5187 Fset_buffer (p->buffer);
5188 opoint = PT;
5189 opoint_byte = PT_BYTE;
5190 old_read_only = BVAR (current_buffer, read_only);
5191 old_begv = BEGV;
5192 old_zv = ZV;
5193 old_begv_byte = BEGV_BYTE;
5194 old_zv_byte = ZV_BYTE;
5195
5196 bset_read_only (current_buffer, Qnil);
5197
5198 /* Insert new output into buffer at the current end-of-output
5199 marker, thus preserving logical ordering of input and output. */
5200 if (XMARKER (p->mark)->buffer)
5201 set_point_from_marker (p->mark);
5202 else
5203 SET_PT_BOTH (ZV, ZV_BYTE);
5204 before = PT;
5205 before_byte = PT_BYTE;
5206
5207 /* If the output marker is outside of the visible region, save
5208 the restriction and widen. */
5209 if (! (BEGV <= PT && PT <= ZV))
5210 Fwiden ();
5211
5212 /* Adjust the multibyteness of TEXT to that of the buffer. */
5213 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
5214 != ! STRING_MULTIBYTE (text))
5215 text = (STRING_MULTIBYTE (text)
5216 ? Fstring_as_unibyte (text)
5217 : Fstring_to_multibyte (text));
5218 /* Insert before markers in case we are inserting where
5219 the buffer's mark is, and the user's next command is Meta-y. */
5220 insert_from_string_before_markers (text, 0, 0,
5221 SCHARS (text), SBYTES (text), 0);
5222
5223 /* Make sure the process marker's position is valid when the
5224 process buffer is changed in the signal_after_change above.
5225 W3 is known to do that. */
5226 if (BUFFERP (p->buffer)
5227 && (b = XBUFFER (p->buffer), b != current_buffer))
5228 set_marker_both (p->mark, p->buffer, BUF_PT (b), BUF_PT_BYTE (b));
5229 else
5230 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
5231
5232 update_mode_lines = 23;
5233
5234 /* Make sure opoint and the old restrictions
5235 float ahead of any new text just as point would. */
5236 if (opoint >= before)
5237 {
5238 opoint += PT - before;
5239 opoint_byte += PT_BYTE - before_byte;
5240 }
5241 if (old_begv > before)
5242 {
5243 old_begv += PT - before;
5244 old_begv_byte += PT_BYTE - before_byte;
5245 }
5246 if (old_zv >= before)
5247 {
5248 old_zv += PT - before;
5249 old_zv_byte += PT_BYTE - before_byte;
5250 }
5251
5252 /* If the restriction isn't what it should be, set it. */
5253 if (old_begv != BEGV || old_zv != ZV)
5254 Fnarrow_to_region (make_number (old_begv), make_number (old_zv));
5255
5256 bset_read_only (current_buffer, old_read_only);
5257 SET_PT_BOTH (opoint, opoint_byte);
5258 }
5259 return Qnil;
5260 }
5261 \f
5262 /* Sending data to subprocess. */
5263
5264 /* In send_process, when a write fails temporarily,
5265 wait_reading_process_output is called. It may execute user code,
5266 e.g. timers, that attempts to write new data to the same process.
5267 We must ensure that data is sent in the right order, and not
5268 interspersed half-completed with other writes (Bug#10815). This is
5269 handled by the write_queue element of struct process. It is a list
5270 with each entry having the form
5271
5272 (string . (offset . length))
5273
5274 where STRING is a lisp string, OFFSET is the offset into the
5275 string's byte sequence from which we should begin to send, and
5276 LENGTH is the number of bytes left to send. */
5277
5278 /* Create a new entry in write_queue.
5279 INPUT_OBJ should be a buffer, string Qt, or Qnil.
5280 BUF is a pointer to the string sequence of the input_obj or a C
5281 string in case of Qt or Qnil. */
5282
5283 static void
5284 write_queue_push (struct Lisp_Process *p, Lisp_Object input_obj,
5285 const char *buf, ptrdiff_t len, bool front)
5286 {
5287 ptrdiff_t offset;
5288 Lisp_Object entry, obj;
5289
5290 if (STRINGP (input_obj))
5291 {
5292 offset = buf - SSDATA (input_obj);
5293 obj = input_obj;
5294 }
5295 else
5296 {
5297 offset = 0;
5298 obj = make_unibyte_string (buf, len);
5299 }
5300
5301 entry = Fcons (obj, Fcons (make_number (offset), make_number (len)));
5302
5303 if (front)
5304 pset_write_queue (p, Fcons (entry, p->write_queue));
5305 else
5306 pset_write_queue (p, nconc2 (p->write_queue, list1 (entry)));
5307 }
5308
5309 /* Remove the first element in the write_queue of process P, put its
5310 contents in OBJ, BUF and LEN, and return true. If the
5311 write_queue is empty, return false. */
5312
5313 static bool
5314 write_queue_pop (struct Lisp_Process *p, Lisp_Object *obj,
5315 const char **buf, ptrdiff_t *len)
5316 {
5317 Lisp_Object entry, offset_length;
5318 ptrdiff_t offset;
5319
5320 if (NILP (p->write_queue))
5321 return 0;
5322
5323 entry = XCAR (p->write_queue);
5324 pset_write_queue (p, XCDR (p->write_queue));
5325
5326 *obj = XCAR (entry);
5327 offset_length = XCDR (entry);
5328
5329 *len = XINT (XCDR (offset_length));
5330 offset = XINT (XCAR (offset_length));
5331 *buf = SSDATA (*obj) + offset;
5332
5333 return 1;
5334 }
5335
5336 /* Send some data to process PROC.
5337 BUF is the beginning of the data; LEN is the number of characters.
5338 OBJECT is the Lisp object that the data comes from. If OBJECT is
5339 nil or t, it means that the data comes from C string.
5340
5341 If OBJECT is not nil, the data is encoded by PROC's coding-system
5342 for encoding before it is sent.
5343
5344 This function can evaluate Lisp code and can garbage collect. */
5345
5346 static void
5347 send_process (Lisp_Object proc, const char *buf, ptrdiff_t len,
5348 Lisp_Object object)
5349 {
5350 struct Lisp_Process *p = XPROCESS (proc);
5351 ssize_t rv;
5352 struct coding_system *coding;
5353
5354 if (p->raw_status_new)
5355 update_status (p);
5356 if (! EQ (p->status, Qrun))
5357 error ("Process %s not running", SDATA (p->name));
5358 if (p->outfd < 0)
5359 error ("Output file descriptor of %s is closed", SDATA (p->name));
5360
5361 coding = proc_encode_coding_system[p->outfd];
5362 Vlast_coding_system_used = CODING_ID_NAME (coding->id);
5363
5364 if ((STRINGP (object) && STRING_MULTIBYTE (object))
5365 || (BUFFERP (object)
5366 && !NILP (BVAR (XBUFFER (object), enable_multibyte_characters)))
5367 || EQ (object, Qt))
5368 {
5369 pset_encode_coding_system
5370 (p, complement_process_encoding_system (p->encode_coding_system));
5371 if (!EQ (Vlast_coding_system_used, p->encode_coding_system))
5372 {
5373 /* The coding system for encoding was changed to raw-text
5374 because we sent a unibyte text previously. Now we are
5375 sending a multibyte text, thus we must encode it by the
5376 original coding system specified for the current process.
5377
5378 Another reason we come here is that the coding system
5379 was just complemented and a new one was returned by
5380 complement_process_encoding_system. */
5381 setup_coding_system (p->encode_coding_system, coding);
5382 Vlast_coding_system_used = p->encode_coding_system;
5383 }
5384 coding->src_multibyte = 1;
5385 }
5386 else
5387 {
5388 coding->src_multibyte = 0;
5389 /* For sending a unibyte text, character code conversion should
5390 not take place but EOL conversion should. So, setup raw-text
5391 or one of the subsidiary if we have not yet done it. */
5392 if (CODING_REQUIRE_ENCODING (coding))
5393 {
5394 if (CODING_REQUIRE_FLUSHING (coding))
5395 {
5396 /* But, before changing the coding, we must flush out data. */
5397 coding->mode |= CODING_MODE_LAST_BLOCK;
5398 send_process (proc, "", 0, Qt);
5399 coding->mode &= CODING_MODE_LAST_BLOCK;
5400 }
5401 setup_coding_system (raw_text_coding_system
5402 (Vlast_coding_system_used),
5403 coding);
5404 coding->src_multibyte = 0;
5405 }
5406 }
5407 coding->dst_multibyte = 0;
5408
5409 if (CODING_REQUIRE_ENCODING (coding))
5410 {
5411 coding->dst_object = Qt;
5412 if (BUFFERP (object))
5413 {
5414 ptrdiff_t from_byte, from, to;
5415 ptrdiff_t save_pt, save_pt_byte;
5416 struct buffer *cur = current_buffer;
5417
5418 set_buffer_internal (XBUFFER (object));
5419 save_pt = PT, save_pt_byte = PT_BYTE;
5420
5421 from_byte = PTR_BYTE_POS ((unsigned char *) buf);
5422 from = BYTE_TO_CHAR (from_byte);
5423 to = BYTE_TO_CHAR (from_byte + len);
5424 TEMP_SET_PT_BOTH (from, from_byte);
5425 encode_coding_object (coding, object, from, from_byte,
5426 to, from_byte + len, Qt);
5427 TEMP_SET_PT_BOTH (save_pt, save_pt_byte);
5428 set_buffer_internal (cur);
5429 }
5430 else if (STRINGP (object))
5431 {
5432 encode_coding_object (coding, object, 0, 0, SCHARS (object),
5433 SBYTES (object), Qt);
5434 }
5435 else
5436 {
5437 coding->dst_object = make_unibyte_string (buf, len);
5438 coding->produced = len;
5439 }
5440
5441 len = coding->produced;
5442 object = coding->dst_object;
5443 buf = SSDATA (object);
5444 }
5445
5446 /* If there is already data in the write_queue, put the new data
5447 in the back of queue. Otherwise, ignore it. */
5448 if (!NILP (p->write_queue))
5449 write_queue_push (p, object, buf, len, 0);
5450
5451 do /* while !NILP (p->write_queue) */
5452 {
5453 ptrdiff_t cur_len = -1;
5454 const char *cur_buf;
5455 Lisp_Object cur_object;
5456
5457 /* If write_queue is empty, ignore it. */
5458 if (!write_queue_pop (p, &cur_object, &cur_buf, &cur_len))
5459 {
5460 cur_len = len;
5461 cur_buf = buf;
5462 cur_object = object;
5463 }
5464
5465 while (cur_len > 0)
5466 {
5467 /* Send this batch, using one or more write calls. */
5468 ptrdiff_t written = 0;
5469 int outfd = p->outfd;
5470 #ifdef DATAGRAM_SOCKETS
5471 if (DATAGRAM_CHAN_P (outfd))
5472 {
5473 rv = sendto (outfd, cur_buf, cur_len,
5474 0, datagram_address[outfd].sa,
5475 datagram_address[outfd].len);
5476 if (rv >= 0)
5477 written = rv;
5478 else if (errno == EMSGSIZE)
5479 report_file_error ("Sending datagram", proc);
5480 }
5481 else
5482 #endif
5483 {
5484 #ifdef HAVE_GNUTLS
5485 if (p->gnutls_p && p->gnutls_state)
5486 written = emacs_gnutls_write (p, cur_buf, cur_len);
5487 else
5488 #endif
5489 written = emacs_write_sig (outfd, cur_buf, cur_len);
5490 rv = (written ? 0 : -1);
5491 #ifdef ADAPTIVE_READ_BUFFERING
5492 if (p->read_output_delay > 0
5493 && p->adaptive_read_buffering == 1)
5494 {
5495 p->read_output_delay = 0;
5496 process_output_delay_count--;
5497 p->read_output_skip = 0;
5498 }
5499 #endif
5500 }
5501
5502 if (rv < 0)
5503 {
5504 if (errno == EAGAIN
5505 #ifdef EWOULDBLOCK
5506 || errno == EWOULDBLOCK
5507 #endif
5508 )
5509 /* Buffer is full. Wait, accepting input;
5510 that may allow the program
5511 to finish doing output and read more. */
5512 {
5513 #ifdef BROKEN_PTY_READ_AFTER_EAGAIN
5514 /* A gross hack to work around a bug in FreeBSD.
5515 In the following sequence, read(2) returns
5516 bogus data:
5517
5518 write(2) 1022 bytes
5519 write(2) 954 bytes, get EAGAIN
5520 read(2) 1024 bytes in process_read_output
5521 read(2) 11 bytes in process_read_output
5522
5523 That is, read(2) returns more bytes than have
5524 ever been written successfully. The 1033 bytes
5525 read are the 1022 bytes written successfully
5526 after processing (for example with CRs added if
5527 the terminal is set up that way which it is
5528 here). The same bytes will be seen again in a
5529 later read(2), without the CRs. */
5530
5531 if (errno == EAGAIN)
5532 {
5533 int flags = FWRITE;
5534 ioctl (p->outfd, TIOCFLUSH, &flags);
5535 }
5536 #endif /* BROKEN_PTY_READ_AFTER_EAGAIN */
5537
5538 /* Put what we should have written in wait_queue. */
5539 write_queue_push (p, cur_object, cur_buf, cur_len, 1);
5540 wait_reading_process_output (0, 20 * 1000 * 1000,
5541 0, 0, Qnil, NULL, 0);
5542 /* Reread queue, to see what is left. */
5543 break;
5544 }
5545 else if (errno == EPIPE)
5546 {
5547 p->raw_status_new = 0;
5548 pset_status (p, list2 (Qexit, make_number (256)));
5549 p->tick = ++process_tick;
5550 deactivate_process (proc);
5551 error ("process %s no longer connected to pipe; closed it",
5552 SDATA (p->name));
5553 }
5554 else
5555 /* This is a real error. */
5556 report_file_error ("Writing to process", proc);
5557 }
5558 cur_buf += written;
5559 cur_len -= written;
5560 }
5561 }
5562 while (!NILP (p->write_queue));
5563 }
5564
5565 DEFUN ("process-send-region", Fprocess_send_region, Sprocess_send_region,
5566 3, 3, 0,
5567 doc: /* Send current contents of region as input to PROCESS.
5568 PROCESS may be a process, a buffer, the name of a process or buffer, or
5569 nil, indicating the current buffer's process.
5570 Called from program, takes three arguments, PROCESS, START and END.
5571 If the region is more than 500 characters long,
5572 it is sent in several bunches. This may happen even for shorter regions.
5573 Output from processes can arrive in between bunches. */)
5574 (Lisp_Object process, Lisp_Object start, Lisp_Object end)
5575 {
5576 Lisp_Object proc = get_process (process);
5577 ptrdiff_t start_byte, end_byte;
5578
5579 validate_region (&start, &end);
5580
5581 start_byte = CHAR_TO_BYTE (XINT (start));
5582 end_byte = CHAR_TO_BYTE (XINT (end));
5583
5584 if (XINT (start) < GPT && XINT (end) > GPT)
5585 move_gap_both (XINT (start), start_byte);
5586
5587 send_process (proc, (char *) BYTE_POS_ADDR (start_byte),
5588 end_byte - start_byte, Fcurrent_buffer ());
5589
5590 return Qnil;
5591 }
5592
5593 DEFUN ("process-send-string", Fprocess_send_string, Sprocess_send_string,
5594 2, 2, 0,
5595 doc: /* Send PROCESS the contents of STRING as input.
5596 PROCESS may be a process, a buffer, the name of a process or buffer, or
5597 nil, indicating the current buffer's process.
5598 If STRING is more than 500 characters long,
5599 it is sent in several bunches. This may happen even for shorter strings.
5600 Output from processes can arrive in between bunches. */)
5601 (Lisp_Object process, Lisp_Object string)
5602 {
5603 Lisp_Object proc;
5604 CHECK_STRING (string);
5605 proc = get_process (process);
5606 send_process (proc, SSDATA (string),
5607 SBYTES (string), string);
5608 return Qnil;
5609 }
5610 \f
5611 /* Return the foreground process group for the tty/pty that
5612 the process P uses. */
5613 static pid_t
5614 emacs_get_tty_pgrp (struct Lisp_Process *p)
5615 {
5616 pid_t gid = -1;
5617
5618 #ifdef TIOCGPGRP
5619 if (ioctl (p->infd, TIOCGPGRP, &gid) == -1 && ! NILP (p->tty_name))
5620 {
5621 int fd;
5622 /* Some OS:es (Solaris 8/9) does not allow TIOCGPGRP from the
5623 master side. Try the slave side. */
5624 fd = emacs_open (SSDATA (p->tty_name), O_RDONLY, 0);
5625
5626 if (fd != -1)
5627 {
5628 ioctl (fd, TIOCGPGRP, &gid);
5629 emacs_close (fd);
5630 }
5631 }
5632 #endif /* defined (TIOCGPGRP ) */
5633
5634 return gid;
5635 }
5636
5637 DEFUN ("process-running-child-p", Fprocess_running_child_p,
5638 Sprocess_running_child_p, 0, 1, 0,
5639 doc: /* Return t if PROCESS has given the terminal to a child.
5640 If the operating system does not make it possible to find out,
5641 return t unconditionally. */)
5642 (Lisp_Object process)
5643 {
5644 /* Initialize in case ioctl doesn't exist or gives an error,
5645 in a way that will cause returning t. */
5646 pid_t gid;
5647 Lisp_Object proc;
5648 struct Lisp_Process *p;
5649
5650 proc = get_process (process);
5651 p = XPROCESS (proc);
5652
5653 if (!EQ (p->type, Qreal))
5654 error ("Process %s is not a subprocess",
5655 SDATA (p->name));
5656 if (p->infd < 0)
5657 error ("Process %s is not active",
5658 SDATA (p->name));
5659
5660 gid = emacs_get_tty_pgrp (p);
5661
5662 if (gid == p->pid)
5663 return Qnil;
5664 return Qt;
5665 }
5666 \f
5667 /* Send a signal number SIGNO to PROCESS.
5668 If CURRENT_GROUP is t, that means send to the process group
5669 that currently owns the terminal being used to communicate with PROCESS.
5670 This is used for various commands in shell mode.
5671 If CURRENT_GROUP is lambda, that means send to the process group
5672 that currently owns the terminal, but only if it is NOT the shell itself.
5673
5674 If NOMSG is false, insert signal-announcements into process's buffers
5675 right away.
5676
5677 If we can, we try to signal PROCESS by sending control characters
5678 down the pty. This allows us to signal inferiors who have changed
5679 their uid, for which kill would return an EPERM error. */
5680
5681 static void
5682 process_send_signal (Lisp_Object process, int signo, Lisp_Object current_group,
5683 bool nomsg)
5684 {
5685 Lisp_Object proc;
5686 struct Lisp_Process *p;
5687 pid_t gid;
5688 bool no_pgrp = 0;
5689
5690 proc = get_process (process);
5691 p = XPROCESS (proc);
5692
5693 if (!EQ (p->type, Qreal))
5694 error ("Process %s is not a subprocess",
5695 SDATA (p->name));
5696 if (p->infd < 0)
5697 error ("Process %s is not active",
5698 SDATA (p->name));
5699
5700 if (!p->pty_flag)
5701 current_group = Qnil;
5702
5703 /* If we are using pgrps, get a pgrp number and make it negative. */
5704 if (NILP (current_group))
5705 /* Send the signal to the shell's process group. */
5706 gid = p->pid;
5707 else
5708 {
5709 #ifdef SIGNALS_VIA_CHARACTERS
5710 /* If possible, send signals to the entire pgrp
5711 by sending an input character to it. */
5712
5713 struct termios t;
5714 cc_t *sig_char = NULL;
5715
5716 tcgetattr (p->infd, &t);
5717
5718 switch (signo)
5719 {
5720 case SIGINT:
5721 sig_char = &t.c_cc[VINTR];
5722 break;
5723
5724 case SIGQUIT:
5725 sig_char = &t.c_cc[VQUIT];
5726 break;
5727
5728 case SIGTSTP:
5729 #if defined (VSWTCH) && !defined (PREFER_VSUSP)
5730 sig_char = &t.c_cc[VSWTCH];
5731 #else
5732 sig_char = &t.c_cc[VSUSP];
5733 #endif
5734 break;
5735 }
5736
5737 if (sig_char && *sig_char != CDISABLE)
5738 {
5739 send_process (proc, (char *) sig_char, 1, Qnil);
5740 return;
5741 }
5742 /* If we can't send the signal with a character,
5743 fall through and send it another way. */
5744
5745 /* The code above may fall through if it can't
5746 handle the signal. */
5747 #endif /* defined (SIGNALS_VIA_CHARACTERS) */
5748
5749 #ifdef TIOCGPGRP
5750 /* Get the current pgrp using the tty itself, if we have that.
5751 Otherwise, use the pty to get the pgrp.
5752 On pfa systems, saka@pfu.fujitsu.co.JP writes:
5753 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
5754 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
5755 His patch indicates that if TIOCGPGRP returns an error, then
5756 we should just assume that p->pid is also the process group id. */
5757
5758 gid = emacs_get_tty_pgrp (p);
5759
5760 if (gid == -1)
5761 /* If we can't get the information, assume
5762 the shell owns the tty. */
5763 gid = p->pid;
5764
5765 /* It is not clear whether anything really can set GID to -1.
5766 Perhaps on some system one of those ioctls can or could do so.
5767 Or perhaps this is vestigial. */
5768 if (gid == -1)
5769 no_pgrp = 1;
5770 #else /* ! defined (TIOCGPGRP) */
5771 /* Can't select pgrps on this system, so we know that
5772 the child itself heads the pgrp. */
5773 gid = p->pid;
5774 #endif /* ! defined (TIOCGPGRP) */
5775
5776 /* If current_group is lambda, and the shell owns the terminal,
5777 don't send any signal. */
5778 if (EQ (current_group, Qlambda) && gid == p->pid)
5779 return;
5780 }
5781
5782 #ifdef SIGCONT
5783 if (signo == SIGCONT)
5784 {
5785 p->raw_status_new = 0;
5786 pset_status (p, Qrun);
5787 p->tick = ++process_tick;
5788 if (!nomsg)
5789 {
5790 status_notify (NULL, NULL);
5791 redisplay_preserve_echo_area (13);
5792 }
5793 }
5794 #endif
5795
5796 #ifdef TIOCSIGSEND
5797 /* Work around a HP-UX 7.0 bug that mishandles signals to subjobs.
5798 We don't know whether the bug is fixed in later HP-UX versions. */
5799 if (! NILP (current_group) && ioctl (p->infd, TIOCSIGSEND, signo) != -1)
5800 return;
5801 #endif
5802
5803 /* If we don't have process groups, send the signal to the immediate
5804 subprocess. That isn't really right, but it's better than any
5805 obvious alternative. */
5806 pid_t pid = no_pgrp ? gid : - gid;
5807
5808 /* Do not kill an already-reaped process, as that could kill an
5809 innocent bystander that happens to have the same process ID. */
5810 sigset_t oldset;
5811 block_child_signal (&oldset);
5812 if (p->alive)
5813 kill (pid, signo);
5814 unblock_child_signal (&oldset);
5815 }
5816
5817 DEFUN ("interrupt-process", Finterrupt_process, Sinterrupt_process, 0, 2, 0,
5818 doc: /* Interrupt process PROCESS.
5819 PROCESS may be a process, a buffer, or the name of a process or buffer.
5820 No arg or nil means current buffer's process.
5821 Second arg CURRENT-GROUP non-nil means send signal to
5822 the current process-group of the process's controlling terminal
5823 rather than to the process's own process group.
5824 If the process is a shell, this means interrupt current subjob
5825 rather than the shell.
5826
5827 If CURRENT-GROUP is `lambda', and if the shell owns the terminal,
5828 don't send the signal. */)
5829 (Lisp_Object process, Lisp_Object current_group)
5830 {
5831 process_send_signal (process, SIGINT, current_group, 0);
5832 return process;
5833 }
5834
5835 DEFUN ("kill-process", Fkill_process, Skill_process, 0, 2, 0,
5836 doc: /* Kill process PROCESS. May be process or name of one.
5837 See function `interrupt-process' for more details on usage. */)
5838 (Lisp_Object process, Lisp_Object current_group)
5839 {
5840 process_send_signal (process, SIGKILL, current_group, 0);
5841 return process;
5842 }
5843
5844 DEFUN ("quit-process", Fquit_process, Squit_process, 0, 2, 0,
5845 doc: /* Send QUIT signal to process PROCESS. May be process or name of one.
5846 See function `interrupt-process' for more details on usage. */)
5847 (Lisp_Object process, Lisp_Object current_group)
5848 {
5849 process_send_signal (process, SIGQUIT, current_group, 0);
5850 return process;
5851 }
5852
5853 DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
5854 doc: /* Stop process PROCESS. May be process or name of one.
5855 See function `interrupt-process' for more details on usage.
5856 If PROCESS is a network or serial process, inhibit handling of incoming
5857 traffic. */)
5858 (Lisp_Object process, Lisp_Object current_group)
5859 {
5860 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5861 {
5862 struct Lisp_Process *p;
5863
5864 p = XPROCESS (process);
5865 if (NILP (p->command)
5866 && p->infd >= 0)
5867 {
5868 FD_CLR (p->infd, &input_wait_mask);
5869 FD_CLR (p->infd, &non_keyboard_wait_mask);
5870 }
5871 pset_command (p, Qt);
5872 return process;
5873 }
5874 #ifndef SIGTSTP
5875 error ("No SIGTSTP support");
5876 #else
5877 process_send_signal (process, SIGTSTP, current_group, 0);
5878 #endif
5879 return process;
5880 }
5881
5882 DEFUN ("continue-process", Fcontinue_process, Scontinue_process, 0, 2, 0,
5883 doc: /* Continue process PROCESS. May be process or name of one.
5884 See function `interrupt-process' for more details on usage.
5885 If PROCESS is a network or serial process, resume handling of incoming
5886 traffic. */)
5887 (Lisp_Object process, Lisp_Object current_group)
5888 {
5889 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)))
5890 {
5891 struct Lisp_Process *p;
5892
5893 p = XPROCESS (process);
5894 if (EQ (p->command, Qt)
5895 && p->infd >= 0
5896 && (!EQ (p->filter, Qt) || EQ (p->status, Qlisten)))
5897 {
5898 FD_SET (p->infd, &input_wait_mask);
5899 FD_SET (p->infd, &non_keyboard_wait_mask);
5900 #ifdef WINDOWSNT
5901 if (fd_info[ p->infd ].flags & FILE_SERIAL)
5902 PurgeComm (fd_info[ p->infd ].hnd, PURGE_RXABORT | PURGE_RXCLEAR);
5903 #else /* not WINDOWSNT */
5904 tcflush (p->infd, TCIFLUSH);
5905 #endif /* not WINDOWSNT */
5906 }
5907 pset_command (p, Qnil);
5908 return process;
5909 }
5910 #ifdef SIGCONT
5911 process_send_signal (process, SIGCONT, current_group, 0);
5912 #else
5913 error ("No SIGCONT support");
5914 #endif
5915 return process;
5916 }
5917
5918 /* Return the integer value of the signal whose abbreviation is ABBR,
5919 or a negative number if there is no such signal. */
5920 static int
5921 abbr_to_signal (char const *name)
5922 {
5923 int i, signo;
5924 char sigbuf[20]; /* Large enough for all valid signal abbreviations. */
5925
5926 if (!strncmp (name, "SIG", 3) || !strncmp (name, "sig", 3))
5927 name += 3;
5928
5929 for (i = 0; i < sizeof sigbuf; i++)
5930 {
5931 sigbuf[i] = c_toupper (name[i]);
5932 if (! sigbuf[i])
5933 return str2sig (sigbuf, &signo) == 0 ? signo : -1;
5934 }
5935
5936 return -1;
5937 }
5938
5939 DEFUN ("signal-process", Fsignal_process, Ssignal_process,
5940 2, 2, "sProcess (name or number): \nnSignal code: ",
5941 doc: /* Send PROCESS the signal with code SIGCODE.
5942 PROCESS may also be a number specifying the process id of the
5943 process to signal; in this case, the process need not be a child of
5944 this Emacs.
5945 SIGCODE may be an integer, or a symbol whose name is a signal name. */)
5946 (Lisp_Object process, Lisp_Object sigcode)
5947 {
5948 pid_t pid;
5949 int signo;
5950
5951 if (STRINGP (process))
5952 {
5953 Lisp_Object tem = Fget_process (process);
5954 if (NILP (tem))
5955 {
5956 Lisp_Object process_number
5957 = string_to_number (SSDATA (process), 10, 1);
5958 if (INTEGERP (process_number) || FLOATP (process_number))
5959 tem = process_number;
5960 }
5961 process = tem;
5962 }
5963 else if (!NUMBERP (process))
5964 process = get_process (process);
5965
5966 if (NILP (process))
5967 return process;
5968
5969 if (NUMBERP (process))
5970 CONS_TO_INTEGER (process, pid_t, pid);
5971 else
5972 {
5973 CHECK_PROCESS (process);
5974 pid = XPROCESS (process)->pid;
5975 if (pid <= 0)
5976 error ("Cannot signal process %s", SDATA (XPROCESS (process)->name));
5977 }
5978
5979 if (INTEGERP (sigcode))
5980 {
5981 CHECK_TYPE_RANGED_INTEGER (int, sigcode);
5982 signo = XINT (sigcode);
5983 }
5984 else
5985 {
5986 char *name;
5987
5988 CHECK_SYMBOL (sigcode);
5989 name = SSDATA (SYMBOL_NAME (sigcode));
5990
5991 signo = abbr_to_signal (name);
5992 if (signo < 0)
5993 error ("Undefined signal name %s", name);
5994 }
5995
5996 return make_number (kill (pid, signo));
5997 }
5998
5999 DEFUN ("process-send-eof", Fprocess_send_eof, Sprocess_send_eof, 0, 1, 0,
6000 doc: /* Make PROCESS see end-of-file in its input.
6001 EOF comes after any text already sent to it.
6002 PROCESS may be a process, a buffer, the name of a process or buffer, or
6003 nil, indicating the current buffer's process.
6004 If PROCESS is a network connection, or is a process communicating
6005 through a pipe (as opposed to a pty), then you cannot send any more
6006 text to PROCESS after you call this function.
6007 If PROCESS is a serial process, wait until all output written to the
6008 process has been transmitted to the serial port. */)
6009 (Lisp_Object process)
6010 {
6011 Lisp_Object proc;
6012 struct coding_system *coding = NULL;
6013 int outfd;
6014
6015 if (DATAGRAM_CONN_P (process))
6016 return process;
6017
6018 proc = get_process (process);
6019 outfd = XPROCESS (proc)->outfd;
6020 if (outfd >= 0)
6021 coding = proc_encode_coding_system[outfd];
6022
6023 /* Make sure the process is really alive. */
6024 if (XPROCESS (proc)->raw_status_new)
6025 update_status (XPROCESS (proc));
6026 if (! EQ (XPROCESS (proc)->status, Qrun))
6027 error ("Process %s not running", SDATA (XPROCESS (proc)->name));
6028
6029 if (coding && CODING_REQUIRE_FLUSHING (coding))
6030 {
6031 coding->mode |= CODING_MODE_LAST_BLOCK;
6032 send_process (proc, "", 0, Qnil);
6033 }
6034
6035 if (XPROCESS (proc)->pty_flag)
6036 send_process (proc, "\004", 1, Qnil);
6037 else if (EQ (XPROCESS (proc)->type, Qserial))
6038 {
6039 #ifndef WINDOWSNT
6040 if (tcdrain (XPROCESS (proc)->outfd) != 0)
6041 report_file_error ("Failed tcdrain", Qnil);
6042 #endif /* not WINDOWSNT */
6043 /* Do nothing on Windows because writes are blocking. */
6044 }
6045 else
6046 {
6047 struct Lisp_Process *p = XPROCESS (proc);
6048 int old_outfd = p->outfd;
6049 int new_outfd;
6050
6051 #ifdef HAVE_SHUTDOWN
6052 /* If this is a network connection, or socketpair is used
6053 for communication with the subprocess, call shutdown to cause EOF.
6054 (In some old system, shutdown to socketpair doesn't work.
6055 Then we just can't win.) */
6056 if (0 <= old_outfd
6057 && (EQ (p->type, Qnetwork) || p->infd == old_outfd))
6058 shutdown (old_outfd, 1);
6059 #endif
6060 close_process_fd (&p->open_fd[WRITE_TO_SUBPROCESS]);
6061 new_outfd = emacs_open (NULL_DEVICE, O_WRONLY, 0);
6062 if (new_outfd < 0)
6063 report_file_error ("Opening null device", Qnil);
6064 p->open_fd[WRITE_TO_SUBPROCESS] = new_outfd;
6065 p->outfd = new_outfd;
6066
6067 if (!proc_encode_coding_system[new_outfd])
6068 proc_encode_coding_system[new_outfd]
6069 = xmalloc (sizeof (struct coding_system));
6070 if (old_outfd >= 0)
6071 {
6072 *proc_encode_coding_system[new_outfd]
6073 = *proc_encode_coding_system[old_outfd];
6074 memset (proc_encode_coding_system[old_outfd], 0,
6075 sizeof (struct coding_system));
6076 }
6077 else
6078 setup_coding_system (p->encode_coding_system,
6079 proc_encode_coding_system[new_outfd]);
6080 }
6081 return process;
6082 }
6083 \f
6084 /* The main Emacs thread records child processes in three places:
6085
6086 - Vprocess_alist, for asynchronous subprocesses, which are child
6087 processes visible to Lisp.
6088
6089 - deleted_pid_list, for child processes invisible to Lisp,
6090 typically because of delete-process. These are recorded so that
6091 the processes can be reaped when they exit, so that the operating
6092 system's process table is not cluttered by zombies.
6093
6094 - the local variable PID in Fcall_process, call_process_cleanup and
6095 call_process_kill, for synchronous subprocesses.
6096 record_unwind_protect is used to make sure this process is not
6097 forgotten: if the user interrupts call-process and the child
6098 process refuses to exit immediately even with two C-g's,
6099 call_process_kill adds PID's contents to deleted_pid_list before
6100 returning.
6101
6102 The main Emacs thread invokes waitpid only on child processes that
6103 it creates and that have not been reaped. This avoid races on
6104 platforms such as GTK, where other threads create their own
6105 subprocesses which the main thread should not reap. For example,
6106 if the main thread attempted to reap an already-reaped child, it
6107 might inadvertently reap a GTK-created process that happened to
6108 have the same process ID. */
6109
6110 /* LIB_CHILD_HANDLER is a SIGCHLD handler that Emacs calls while doing
6111 its own SIGCHLD handling. On POSIXish systems, glib needs this to
6112 keep track of its own children. GNUstep is similar. */
6113
6114 static void dummy_handler (int sig) {}
6115 static signal_handler_t volatile lib_child_handler;
6116
6117 /* Handle a SIGCHLD signal by looking for known child processes of
6118 Emacs whose status have changed. For each one found, record its
6119 new status.
6120
6121 All we do is change the status; we do not run sentinels or print
6122 notifications. That is saved for the next time keyboard input is
6123 done, in order to avoid timing errors.
6124
6125 ** WARNING: this can be called during garbage collection.
6126 Therefore, it must not be fooled by the presence of mark bits in
6127 Lisp objects.
6128
6129 ** USG WARNING: Although it is not obvious from the documentation
6130 in signal(2), on a USG system the SIGCLD handler MUST NOT call
6131 signal() before executing at least one wait(), otherwise the
6132 handler will be called again, resulting in an infinite loop. The
6133 relevant portion of the documentation reads "SIGCLD signals will be
6134 queued and the signal-catching function will be continually
6135 reentered until the queue is empty". Invoking signal() causes the
6136 kernel to reexamine the SIGCLD queue. Fred Fish, UniSoft Systems
6137 Inc.
6138
6139 ** Malloc WARNING: This should never call malloc either directly or
6140 indirectly; if it does, that is a bug. */
6141
6142 static void
6143 handle_child_signal (int sig)
6144 {
6145 Lisp_Object tail, proc;
6146
6147 /* Find the process that signaled us, and record its status. */
6148
6149 /* The process can have been deleted by Fdelete_process, or have
6150 been started asynchronously by Fcall_process. */
6151 for (tail = deleted_pid_list; CONSP (tail); tail = XCDR (tail))
6152 {
6153 bool all_pids_are_fixnums
6154 = (MOST_NEGATIVE_FIXNUM <= TYPE_MINIMUM (pid_t)
6155 && TYPE_MAXIMUM (pid_t) <= MOST_POSITIVE_FIXNUM);
6156 Lisp_Object head = XCAR (tail);
6157 Lisp_Object xpid;
6158 if (! CONSP (head))
6159 continue;
6160 xpid = XCAR (head);
6161 if (all_pids_are_fixnums ? INTEGERP (xpid) : NUMBERP (xpid))
6162 {
6163 pid_t deleted_pid;
6164 if (INTEGERP (xpid))
6165 deleted_pid = XINT (xpid);
6166 else
6167 deleted_pid = XFLOAT_DATA (xpid);
6168 if (child_status_changed (deleted_pid, 0, 0))
6169 {
6170 if (STRINGP (XCDR (head)))
6171 unlink (SSDATA (XCDR (head)));
6172 XSETCAR (tail, Qnil);
6173 }
6174 }
6175 }
6176
6177 /* Otherwise, if it is asynchronous, it is in Vprocess_alist. */
6178 FOR_EACH_PROCESS (tail, proc)
6179 {
6180 struct Lisp_Process *p = XPROCESS (proc);
6181 int status;
6182
6183 if (p->alive
6184 && child_status_changed (p->pid, &status, WUNTRACED | WCONTINUED))
6185 {
6186 /* Change the status of the process that was found. */
6187 p->tick = ++process_tick;
6188 p->raw_status = status;
6189 p->raw_status_new = 1;
6190
6191 /* If process has terminated, stop waiting for its output. */
6192 if (WIFSIGNALED (status) || WIFEXITED (status))
6193 {
6194 bool clear_desc_flag = 0;
6195 p->alive = 0;
6196 if (p->infd >= 0)
6197 clear_desc_flag = 1;
6198
6199 /* clear_desc_flag avoids a compiler bug in Microsoft C. */
6200 if (clear_desc_flag)
6201 {
6202 FD_CLR (p->infd, &input_wait_mask);
6203 FD_CLR (p->infd, &non_keyboard_wait_mask);
6204 }
6205 }
6206 }
6207 }
6208
6209 lib_child_handler (sig);
6210 #ifdef NS_IMPL_GNUSTEP
6211 /* NSTask in GNUstep sets its child handler each time it is called.
6212 So we must re-set ours. */
6213 catch_child_signal ();
6214 #endif
6215 }
6216
6217 static void
6218 deliver_child_signal (int sig)
6219 {
6220 deliver_process_signal (sig, handle_child_signal);
6221 }
6222 \f
6223
6224 static Lisp_Object
6225 exec_sentinel_error_handler (Lisp_Object error_val)
6226 {
6227 cmd_error_internal (error_val, "error in process sentinel: ");
6228 Vinhibit_quit = Qt;
6229 update_echo_area ();
6230 Fsleep_for (make_number (2), Qnil);
6231 return Qt;
6232 }
6233
6234 static void
6235 exec_sentinel (Lisp_Object proc, Lisp_Object reason)
6236 {
6237 Lisp_Object sentinel, odeactivate;
6238 struct Lisp_Process *p = XPROCESS (proc);
6239 ptrdiff_t count = SPECPDL_INDEX ();
6240 bool outer_running_asynch_code = running_asynch_code;
6241 int waiting = waiting_for_user_input_p;
6242
6243 if (inhibit_sentinels)
6244 return;
6245
6246 /* No need to gcpro these, because all we do with them later
6247 is test them for EQness, and none of them should be a string. */
6248 odeactivate = Vdeactivate_mark;
6249 #if 0
6250 Lisp_Object obuffer, okeymap;
6251 XSETBUFFER (obuffer, current_buffer);
6252 okeymap = BVAR (current_buffer, keymap);
6253 #endif
6254
6255 /* There's no good reason to let sentinels change the current
6256 buffer, and many callers of accept-process-output, sit-for, and
6257 friends don't expect current-buffer to be changed from under them. */
6258 record_unwind_current_buffer ();
6259
6260 sentinel = p->sentinel;
6261
6262 /* Inhibit quit so that random quits don't screw up a running filter. */
6263 specbind (Qinhibit_quit, Qt);
6264 specbind (Qlast_nonmenu_event, Qt); /* Why? --Stef */
6265
6266 /* In case we get recursively called,
6267 and we already saved the match data nonrecursively,
6268 save the same match data in safely recursive fashion. */
6269 if (outer_running_asynch_code)
6270 {
6271 Lisp_Object tem;
6272 tem = Fmatch_data (Qnil, Qnil, Qnil);
6273 restore_search_regs ();
6274 record_unwind_save_match_data ();
6275 Fset_match_data (tem, Qt);
6276 }
6277
6278 /* For speed, if a search happens within this code,
6279 save the match data in a special nonrecursive fashion. */
6280 running_asynch_code = 1;
6281
6282 internal_condition_case_1 (read_process_output_call,
6283 list3 (sentinel, proc, reason),
6284 !NILP (Vdebug_on_error) ? Qnil : Qerror,
6285 exec_sentinel_error_handler);
6286
6287 /* If we saved the match data nonrecursively, restore it now. */
6288 restore_search_regs ();
6289 running_asynch_code = outer_running_asynch_code;
6290
6291 Vdeactivate_mark = odeactivate;
6292
6293 /* Restore waiting_for_user_input_p as it was
6294 when we were called, in case the filter clobbered it. */
6295 waiting_for_user_input_p = waiting;
6296
6297 #if 0
6298 if (! EQ (Fcurrent_buffer (), obuffer)
6299 || ! EQ (current_buffer->keymap, okeymap))
6300 #endif
6301 /* But do it only if the caller is actually going to read events.
6302 Otherwise there's no need to make him wake up, and it could
6303 cause trouble (for example it would make sit_for return). */
6304 if (waiting_for_user_input_p == -1)
6305 record_asynch_buffer_change ();
6306
6307 unbind_to (count, Qnil);
6308 }
6309
6310 /* Report all recent events of a change in process status
6311 (either run the sentinel or output a message).
6312 This is usually done while Emacs is waiting for keyboard input
6313 but can be done at other times.
6314
6315 Return positive if any input was received from WAIT_PROC (or from
6316 any process if WAIT_PROC is null), zero if input was attempted but
6317 none received, and negative if we didn't even try. */
6318
6319 static int
6320 status_notify (struct Lisp_Process *deleting_process,
6321 struct Lisp_Process *wait_proc)
6322 {
6323 Lisp_Object proc;
6324 Lisp_Object tail, msg;
6325 struct gcpro gcpro1, gcpro2;
6326 int got_some_input = -1;
6327
6328 tail = Qnil;
6329 msg = Qnil;
6330 /* We need to gcpro tail; if read_process_output calls a filter
6331 which deletes a process and removes the cons to which tail points
6332 from Vprocess_alist, and then causes a GC, tail is an unprotected
6333 reference. */
6334 GCPRO2 (tail, msg);
6335
6336 /* Set this now, so that if new processes are created by sentinels
6337 that we run, we get called again to handle their status changes. */
6338 update_tick = process_tick;
6339
6340 FOR_EACH_PROCESS (tail, proc)
6341 {
6342 Lisp_Object symbol;
6343 register struct Lisp_Process *p = XPROCESS (proc);
6344
6345 if (p->tick != p->update_tick)
6346 {
6347 p->update_tick = p->tick;
6348
6349 /* If process is still active, read any output that remains. */
6350 while (! EQ (p->filter, Qt)
6351 && ! EQ (p->status, Qconnect)
6352 && ! EQ (p->status, Qlisten)
6353 /* Network or serial process not stopped: */
6354 && ! EQ (p->command, Qt)
6355 && p->infd >= 0
6356 && p != deleting_process)
6357 {
6358 int nread = read_process_output (proc, p->infd);
6359 if (got_some_input < nread)
6360 got_some_input = nread;
6361 if (nread <= 0)
6362 break;
6363 }
6364
6365 /* Get the text to use for the message. */
6366 if (p->raw_status_new)
6367 update_status (p);
6368 msg = status_message (p);
6369
6370 /* If process is terminated, deactivate it or delete it. */
6371 symbol = p->status;
6372 if (CONSP (p->status))
6373 symbol = XCAR (p->status);
6374
6375 if (EQ (symbol, Qsignal) || EQ (symbol, Qexit)
6376 || EQ (symbol, Qclosed))
6377 {
6378 if (delete_exited_processes)
6379 remove_process (proc);
6380 else
6381 deactivate_process (proc);
6382 }
6383
6384 /* The actions above may have further incremented p->tick.
6385 So set p->update_tick again so that an error in the sentinel will
6386 not cause this code to be run again. */
6387 p->update_tick = p->tick;
6388 /* Now output the message suitably. */
6389 exec_sentinel (proc, msg);
6390 }
6391 } /* end for */
6392
6393 update_mode_lines = 24; /* In case buffers use %s in mode-line-format. */
6394 UNGCPRO;
6395 return got_some_input;
6396 }
6397
6398 DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel,
6399 Sinternal_default_process_sentinel, 2, 2, 0,
6400 doc: /* Function used as default sentinel for processes.
6401 This inserts a status message into the process's buffer, if there is one. */)
6402 (Lisp_Object proc, Lisp_Object msg)
6403 {
6404 Lisp_Object buffer, symbol;
6405 struct Lisp_Process *p;
6406 CHECK_PROCESS (proc);
6407 p = XPROCESS (proc);
6408 buffer = p->buffer;
6409 symbol = p->status;
6410 if (CONSP (symbol))
6411 symbol = XCAR (symbol);
6412
6413 if (!EQ (symbol, Qrun) && !NILP (buffer))
6414 {
6415 Lisp_Object tem;
6416 struct buffer *old = current_buffer;
6417 ptrdiff_t opoint, opoint_byte;
6418 ptrdiff_t before, before_byte;
6419
6420 /* Avoid error if buffer is deleted
6421 (probably that's why the process is dead, too). */
6422 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
6423 return Qnil;
6424 Fset_buffer (buffer);
6425
6426 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
6427 msg = (code_convert_string_norecord
6428 (msg, Vlocale_coding_system, 1));
6429
6430 opoint = PT;
6431 opoint_byte = PT_BYTE;
6432 /* Insert new output into buffer
6433 at the current end-of-output marker,
6434 thus preserving logical ordering of input and output. */
6435 if (XMARKER (p->mark)->buffer)
6436 Fgoto_char (p->mark);
6437 else
6438 SET_PT_BOTH (ZV, ZV_BYTE);
6439
6440 before = PT;
6441 before_byte = PT_BYTE;
6442
6443 tem = BVAR (current_buffer, read_only);
6444 bset_read_only (current_buffer, Qnil);
6445 insert_string ("\nProcess ");
6446 { /* FIXME: temporary kludge. */
6447 Lisp_Object tem2 = p->name; Finsert (1, &tem2); }
6448 insert_string (" ");
6449 Finsert (1, &msg);
6450 bset_read_only (current_buffer, tem);
6451 set_marker_both (p->mark, p->buffer, PT, PT_BYTE);
6452
6453 if (opoint >= before)
6454 SET_PT_BOTH (opoint + (PT - before),
6455 opoint_byte + (PT_BYTE - before_byte));
6456 else
6457 SET_PT_BOTH (opoint, opoint_byte);
6458
6459 set_buffer_internal (old);
6460 }
6461 return Qnil;
6462 }
6463
6464 \f
6465 DEFUN ("set-process-coding-system", Fset_process_coding_system,
6466 Sset_process_coding_system, 1, 3, 0,
6467 doc: /* Set coding systems of PROCESS to DECODING and ENCODING.
6468 DECODING will be used to decode subprocess output and ENCODING to
6469 encode subprocess input. */)
6470 (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding)
6471 {
6472 register struct Lisp_Process *p;
6473
6474 CHECK_PROCESS (process);
6475 p = XPROCESS (process);
6476 if (p->infd < 0)
6477 error ("Input file descriptor of %s closed", SDATA (p->name));
6478 if (p->outfd < 0)
6479 error ("Output file descriptor of %s closed", SDATA (p->name));
6480 Fcheck_coding_system (decoding);
6481 Fcheck_coding_system (encoding);
6482 encoding = coding_inherit_eol_type (encoding, Qnil);
6483 pset_decode_coding_system (p, decoding);
6484 pset_encode_coding_system (p, encoding);
6485 setup_process_coding_systems (process);
6486
6487 return Qnil;
6488 }
6489
6490 DEFUN ("process-coding-system",
6491 Fprocess_coding_system, Sprocess_coding_system, 1, 1, 0,
6492 doc: /* Return a cons of coding systems for decoding and encoding of PROCESS. */)
6493 (register Lisp_Object process)
6494 {
6495 CHECK_PROCESS (process);
6496 return Fcons (XPROCESS (process)->decode_coding_system,
6497 XPROCESS (process)->encode_coding_system);
6498 }
6499
6500 DEFUN ("set-process-filter-multibyte", Fset_process_filter_multibyte,
6501 Sset_process_filter_multibyte, 2, 2, 0,
6502 doc: /* Set multibyteness of the strings given to PROCESS's filter.
6503 If FLAG is non-nil, the filter is given multibyte strings.
6504 If FLAG is nil, the filter is given unibyte strings. In this case,
6505 all character code conversion except for end-of-line conversion is
6506 suppressed. */)
6507 (Lisp_Object process, Lisp_Object flag)
6508 {
6509 register struct Lisp_Process *p;
6510
6511 CHECK_PROCESS (process);
6512 p = XPROCESS (process);
6513 if (NILP (flag))
6514 pset_decode_coding_system
6515 (p, raw_text_coding_system (p->decode_coding_system));
6516 setup_process_coding_systems (process);
6517
6518 return Qnil;
6519 }
6520
6521 DEFUN ("process-filter-multibyte-p", Fprocess_filter_multibyte_p,
6522 Sprocess_filter_multibyte_p, 1, 1, 0,
6523 doc: /* Return t if a multibyte string is given to PROCESS's filter.*/)
6524 (Lisp_Object process)
6525 {
6526 register struct Lisp_Process *p;
6527 struct coding_system *coding;
6528
6529 CHECK_PROCESS (process);
6530 p = XPROCESS (process);
6531 if (p->infd < 0)
6532 return Qnil;
6533 coding = proc_decode_coding_system[p->infd];
6534 return (CODING_FOR_UNIBYTE (coding) ? Qnil : Qt);
6535 }
6536
6537
6538 \f
6539
6540 # ifdef HAVE_GPM
6541
6542 void
6543 add_gpm_wait_descriptor (int desc)
6544 {
6545 add_keyboard_wait_descriptor (desc);
6546 }
6547
6548 void
6549 delete_gpm_wait_descriptor (int desc)
6550 {
6551 delete_keyboard_wait_descriptor (desc);
6552 }
6553
6554 # endif
6555
6556 # ifdef USABLE_SIGIO
6557
6558 /* Return true if *MASK has a bit set
6559 that corresponds to one of the keyboard input descriptors. */
6560
6561 static bool
6562 keyboard_bit_set (fd_set *mask)
6563 {
6564 int fd;
6565
6566 for (fd = 0; fd <= max_input_desc; fd++)
6567 if (FD_ISSET (fd, mask) && FD_ISSET (fd, &input_wait_mask)
6568 && !FD_ISSET (fd, &non_keyboard_wait_mask))
6569 return 1;
6570
6571 return 0;
6572 }
6573 # endif
6574
6575 #else /* not subprocesses */
6576
6577 /* Defined in msdos.c. */
6578 extern int sys_select (int, fd_set *, fd_set *, fd_set *,
6579 struct timespec *, void *);
6580
6581 /* Implementation of wait_reading_process_output, assuming that there
6582 are no subprocesses. Used only by the MS-DOS build.
6583
6584 Wait for timeout to elapse and/or keyboard input to be available.
6585
6586 TIME_LIMIT is:
6587 timeout in seconds
6588 If negative, gobble data immediately available but don't wait for any.
6589
6590 NSECS is:
6591 an additional duration to wait, measured in nanoseconds
6592 If TIME_LIMIT is zero, then:
6593 If NSECS == 0, there is no limit.
6594 If NSECS > 0, the timeout consists of NSECS only.
6595 If NSECS < 0, gobble data immediately, as if TIME_LIMIT were negative.
6596
6597 READ_KBD is:
6598 0 to ignore keyboard input, or
6599 1 to return when input is available, or
6600 -1 means caller will actually read the input, so don't throw to
6601 the quit handler.
6602
6603 see full version for other parameters. We know that wait_proc will
6604 always be NULL, since `subprocesses' isn't defined.
6605
6606 DO_DISPLAY means redisplay should be done to show subprocess
6607 output that arrives.
6608
6609 Return positive if we received input from WAIT_PROC (or from any
6610 process if WAIT_PROC is null), zero if we attempted to receive
6611 input but got none, and negative if we didn't even try. */
6612
6613 int
6614 wait_reading_process_output (intmax_t time_limit, int nsecs, int read_kbd,
6615 bool do_display,
6616 Lisp_Object wait_for_cell,
6617 struct Lisp_Process *wait_proc, int just_wait_proc)
6618 {
6619 register int nfds;
6620 struct timespec end_time, timeout;
6621
6622 if (time_limit < 0)
6623 {
6624 time_limit = 0;
6625 nsecs = -1;
6626 }
6627 else if (TYPE_MAXIMUM (time_t) < time_limit)
6628 time_limit = TYPE_MAXIMUM (time_t);
6629
6630 /* What does time_limit really mean? */
6631 if (time_limit || nsecs > 0)
6632 {
6633 timeout = make_timespec (time_limit, nsecs);
6634 end_time = timespec_add (current_timespec (), timeout);
6635 }
6636
6637 /* Turn off periodic alarms (in case they are in use)
6638 and then turn off any other atimers,
6639 because the select emulator uses alarms. */
6640 stop_polling ();
6641 turn_on_atimers (0);
6642
6643 while (1)
6644 {
6645 bool timeout_reduced_for_timers = false;
6646 fd_set waitchannels;
6647 int xerrno;
6648
6649 /* If calling from keyboard input, do not quit
6650 since we want to return C-g as an input character.
6651 Otherwise, do pending quit if requested. */
6652 if (read_kbd >= 0)
6653 QUIT;
6654
6655 /* Exit now if the cell we're waiting for became non-nil. */
6656 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6657 break;
6658
6659 /* Compute time from now till when time limit is up. */
6660 /* Exit if already run out. */
6661 if (nsecs < 0)
6662 {
6663 /* A negative timeout means
6664 gobble output available now
6665 but don't wait at all. */
6666
6667 timeout = make_timespec (0, 0);
6668 }
6669 else if (time_limit || nsecs > 0)
6670 {
6671 struct timespec now = current_timespec ();
6672 if (timespec_cmp (end_time, now) <= 0)
6673 break;
6674 timeout = timespec_sub (end_time, now);
6675 }
6676 else
6677 {
6678 timeout = make_timespec (100000, 0);
6679 }
6680
6681 /* If our caller will not immediately handle keyboard events,
6682 run timer events directly.
6683 (Callers that will immediately read keyboard events
6684 call timer_delay on their own.) */
6685 if (NILP (wait_for_cell))
6686 {
6687 struct timespec timer_delay;
6688
6689 do
6690 {
6691 unsigned old_timers_run = timers_run;
6692 timer_delay = timer_check ();
6693 if (timers_run != old_timers_run && do_display)
6694 /* We must retry, since a timer may have requeued itself
6695 and that could alter the time delay. */
6696 redisplay_preserve_echo_area (14);
6697 else
6698 break;
6699 }
6700 while (!detect_input_pending ());
6701
6702 /* If there is unread keyboard input, also return. */
6703 if (read_kbd != 0
6704 && requeued_events_pending_p ())
6705 break;
6706
6707 if (timespec_valid_p (timer_delay) && nsecs >= 0)
6708 {
6709 if (timespec_cmp (timer_delay, timeout) < 0)
6710 {
6711 timeout = timer_delay;
6712 timeout_reduced_for_timers = true;
6713 }
6714 }
6715 }
6716
6717 /* Cause C-g and alarm signals to take immediate action,
6718 and cause input available signals to zero out timeout. */
6719 if (read_kbd < 0)
6720 set_waiting_for_input (&timeout);
6721
6722 /* If a frame has been newly mapped and needs updating,
6723 reprocess its display stuff. */
6724 if (frame_garbaged && do_display)
6725 {
6726 clear_waiting_for_input ();
6727 redisplay_preserve_echo_area (15);
6728 if (read_kbd < 0)
6729 set_waiting_for_input (&timeout);
6730 }
6731
6732 /* Wait till there is something to do. */
6733 FD_ZERO (&waitchannels);
6734 if (read_kbd && detect_input_pending ())
6735 nfds = 0;
6736 else
6737 {
6738 if (read_kbd || !NILP (wait_for_cell))
6739 FD_SET (0, &waitchannels);
6740 nfds = pselect (1, &waitchannels, NULL, NULL, &timeout, NULL);
6741 }
6742
6743 xerrno = errno;
6744
6745 /* Make C-g and alarm signals set flags again. */
6746 clear_waiting_for_input ();
6747
6748 /* If we woke up due to SIGWINCH, actually change size now. */
6749 do_pending_window_change (0);
6750
6751 if ((time_limit || nsecs) && nfds == 0 && ! timeout_reduced_for_timers)
6752 /* We waited the full specified time, so return now. */
6753 break;
6754
6755 if (nfds == -1)
6756 {
6757 /* If the system call was interrupted, then go around the
6758 loop again. */
6759 if (xerrno == EINTR)
6760 FD_ZERO (&waitchannels);
6761 else
6762 report_file_errno ("Failed select", Qnil, xerrno);
6763 }
6764
6765 /* Check for keyboard input. */
6766
6767 if (read_kbd
6768 && detect_input_pending_run_timers (do_display))
6769 {
6770 swallow_events (do_display);
6771 if (detect_input_pending_run_timers (do_display))
6772 break;
6773 }
6774
6775 /* If there is unread keyboard input, also return. */
6776 if (read_kbd
6777 && requeued_events_pending_p ())
6778 break;
6779
6780 /* If wait_for_cell. check for keyboard input
6781 but don't run any timers.
6782 ??? (It seems wrong to me to check for keyboard
6783 input at all when wait_for_cell, but the code
6784 has been this way since July 1994.
6785 Try changing this after version 19.31.) */
6786 if (! NILP (wait_for_cell)
6787 && detect_input_pending ())
6788 {
6789 swallow_events (do_display);
6790 if (detect_input_pending ())
6791 break;
6792 }
6793
6794 /* Exit now if the cell we're waiting for became non-nil. */
6795 if (! NILP (wait_for_cell) && ! NILP (XCAR (wait_for_cell)))
6796 break;
6797 }
6798
6799 start_polling ();
6800
6801 return -1;
6802 }
6803
6804 #endif /* not subprocesses */
6805
6806 /* The following functions are needed even if async subprocesses are
6807 not supported. Some of them are no-op stubs in that case. */
6808
6809 #ifdef HAVE_TIMERFD
6810
6811 /* Add FD, which is a descriptor returned by timerfd_create,
6812 to the set of non-keyboard input descriptors. */
6813
6814 void
6815 add_timer_wait_descriptor (int fd)
6816 {
6817 FD_SET (fd, &input_wait_mask);
6818 FD_SET (fd, &non_keyboard_wait_mask);
6819 FD_SET (fd, &non_process_wait_mask);
6820 fd_callback_info[fd].func = timerfd_callback;
6821 fd_callback_info[fd].data = NULL;
6822 fd_callback_info[fd].condition |= FOR_READ;
6823 if (fd > max_input_desc)
6824 max_input_desc = fd;
6825 }
6826
6827 #endif /* HAVE_TIMERFD */
6828
6829 /* Add DESC to the set of keyboard input descriptors. */
6830
6831 void
6832 add_keyboard_wait_descriptor (int desc)
6833 {
6834 #ifdef subprocesses /* Actually means "not MSDOS". */
6835 FD_SET (desc, &input_wait_mask);
6836 FD_SET (desc, &non_process_wait_mask);
6837 if (desc > max_input_desc)
6838 max_input_desc = desc;
6839 #endif
6840 }
6841
6842 /* From now on, do not expect DESC to give keyboard input. */
6843
6844 void
6845 delete_keyboard_wait_descriptor (int desc)
6846 {
6847 #ifdef subprocesses
6848 FD_CLR (desc, &input_wait_mask);
6849 FD_CLR (desc, &non_process_wait_mask);
6850 delete_input_desc (desc);
6851 #endif
6852 }
6853
6854 /* Setup coding systems of PROCESS. */
6855
6856 void
6857 setup_process_coding_systems (Lisp_Object process)
6858 {
6859 #ifdef subprocesses
6860 struct Lisp_Process *p = XPROCESS (process);
6861 int inch = p->infd;
6862 int outch = p->outfd;
6863 Lisp_Object coding_system;
6864
6865 if (inch < 0 || outch < 0)
6866 return;
6867
6868 if (!proc_decode_coding_system[inch])
6869 proc_decode_coding_system[inch] = xmalloc (sizeof (struct coding_system));
6870 coding_system = p->decode_coding_system;
6871 if (EQ (p->filter, Qinternal_default_process_filter)
6872 && BUFFERP (p->buffer))
6873 {
6874 if (NILP (BVAR (XBUFFER (p->buffer), enable_multibyte_characters)))
6875 coding_system = raw_text_coding_system (coding_system);
6876 }
6877 setup_coding_system (coding_system, proc_decode_coding_system[inch]);
6878
6879 if (!proc_encode_coding_system[outch])
6880 proc_encode_coding_system[outch] = xmalloc (sizeof (struct coding_system));
6881 setup_coding_system (p->encode_coding_system,
6882 proc_encode_coding_system[outch]);
6883 #endif
6884 }
6885
6886 DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
6887 doc: /* Return the (or a) process associated with BUFFER.
6888 BUFFER may be a buffer or the name of one. */)
6889 (register Lisp_Object buffer)
6890 {
6891 #ifdef subprocesses
6892 register Lisp_Object buf, tail, proc;
6893
6894 if (NILP (buffer)) return Qnil;
6895 buf = Fget_buffer (buffer);
6896 if (NILP (buf)) return Qnil;
6897
6898 FOR_EACH_PROCESS (tail, proc)
6899 if (EQ (XPROCESS (proc)->buffer, buf))
6900 return proc;
6901 #endif /* subprocesses */
6902 return Qnil;
6903 }
6904
6905 DEFUN ("process-inherit-coding-system-flag",
6906 Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
6907 1, 1, 0,
6908 doc: /* Return the value of inherit-coding-system flag for PROCESS.
6909 If this flag is t, `buffer-file-coding-system' of the buffer
6910 associated with PROCESS will inherit the coding system used to decode
6911 the process output. */)
6912 (register Lisp_Object process)
6913 {
6914 #ifdef subprocesses
6915 CHECK_PROCESS (process);
6916 return XPROCESS (process)->inherit_coding_system_flag ? Qt : Qnil;
6917 #else
6918 /* Ignore the argument and return the value of
6919 inherit-process-coding-system. */
6920 return inherit_process_coding_system ? Qt : Qnil;
6921 #endif
6922 }
6923
6924 /* Kill all processes associated with `buffer'.
6925 If `buffer' is nil, kill all processes. */
6926
6927 void
6928 kill_buffer_processes (Lisp_Object buffer)
6929 {
6930 #ifdef subprocesses
6931 Lisp_Object tail, proc;
6932
6933 FOR_EACH_PROCESS (tail, proc)
6934 if (NILP (buffer) || EQ (XPROCESS (proc)->buffer, buffer))
6935 {
6936 if (NETCONN_P (proc) || SERIALCONN_P (proc))
6937 Fdelete_process (proc);
6938 else if (XPROCESS (proc)->infd >= 0)
6939 process_send_signal (proc, SIGHUP, Qnil, 1);
6940 }
6941 #else /* subprocesses */
6942 /* Since we have no subprocesses, this does nothing. */
6943 #endif /* subprocesses */
6944 }
6945
6946 DEFUN ("waiting-for-user-input-p", Fwaiting_for_user_input_p,
6947 Swaiting_for_user_input_p, 0, 0, 0,
6948 doc: /* Return non-nil if Emacs is waiting for input from the user.
6949 This is intended for use by asynchronous process output filters and sentinels. */)
6950 (void)
6951 {
6952 #ifdef subprocesses
6953 return (waiting_for_user_input_p ? Qt : Qnil);
6954 #else
6955 return Qnil;
6956 #endif
6957 }
6958
6959 /* Stop reading input from keyboard sources. */
6960
6961 void
6962 hold_keyboard_input (void)
6963 {
6964 kbd_is_on_hold = 1;
6965 }
6966
6967 /* Resume reading input from keyboard sources. */
6968
6969 void
6970 unhold_keyboard_input (void)
6971 {
6972 kbd_is_on_hold = 0;
6973 }
6974
6975 /* Return true if keyboard input is on hold, zero otherwise. */
6976
6977 bool
6978 kbd_on_hold_p (void)
6979 {
6980 return kbd_is_on_hold;
6981 }
6982
6983 \f
6984 /* Enumeration of and access to system processes a-la ps(1). */
6985
6986 DEFUN ("list-system-processes", Flist_system_processes, Slist_system_processes,
6987 0, 0, 0,
6988 doc: /* Return a list of numerical process IDs of all running processes.
6989 If this functionality is unsupported, return nil.
6990
6991 See `process-attributes' for getting attributes of a process given its ID. */)
6992 (void)
6993 {
6994 return list_system_processes ();
6995 }
6996
6997 DEFUN ("process-attributes", Fprocess_attributes,
6998 Sprocess_attributes, 1, 1, 0,
6999 doc: /* Return attributes of the process given by its PID, a number.
7000
7001 Value is an alist where each element is a cons cell of the form
7002
7003 \(KEY . VALUE)
7004
7005 If this functionality is unsupported, the value is nil.
7006
7007 See `list-system-processes' for getting a list of all process IDs.
7008
7009 The KEYs of the attributes that this function may return are listed
7010 below, together with the type of the associated VALUE (in parentheses).
7011 Not all platforms support all of these attributes; unsupported
7012 attributes will not appear in the returned alist.
7013 Unless explicitly indicated otherwise, numbers can have either
7014 integer or floating point values.
7015
7016 euid -- Effective user User ID of the process (number)
7017 user -- User name corresponding to euid (string)
7018 egid -- Effective user Group ID of the process (number)
7019 group -- Group name corresponding to egid (string)
7020 comm -- Command name (executable name only) (string)
7021 state -- Process state code, such as "S", "R", or "T" (string)
7022 ppid -- Parent process ID (number)
7023 pgrp -- Process group ID (number)
7024 sess -- Session ID, i.e. process ID of session leader (number)
7025 ttname -- Controlling tty name (string)
7026 tpgid -- ID of foreground process group on the process's tty (number)
7027 minflt -- number of minor page faults (number)
7028 majflt -- number of major page faults (number)
7029 cminflt -- cumulative number of minor page faults (number)
7030 cmajflt -- cumulative number of major page faults (number)
7031 utime -- user time used by the process, in (current-time) format,
7032 which is a list of integers (HIGH LOW USEC PSEC)
7033 stime -- system time used by the process (current-time)
7034 time -- sum of utime and stime (current-time)
7035 cutime -- user time used by the process and its children (current-time)
7036 cstime -- system time used by the process and its children (current-time)
7037 ctime -- sum of cutime and cstime (current-time)
7038 pri -- priority of the process (number)
7039 nice -- nice value of the process (number)
7040 thcount -- process thread count (number)
7041 start -- time the process started (current-time)
7042 vsize -- virtual memory size of the process in KB's (number)
7043 rss -- resident set size of the process in KB's (number)
7044 etime -- elapsed time the process is running, in (HIGH LOW USEC PSEC) format
7045 pcpu -- percents of CPU time used by the process (floating-point number)
7046 pmem -- percents of total physical memory used by process's resident set
7047 (floating-point number)
7048 args -- command line which invoked the process (string). */)
7049 ( Lisp_Object pid)
7050 {
7051 return system_process_attributes (pid);
7052 }
7053
7054 #ifdef subprocesses
7055 /* Arrange to catch SIGCHLD if this hasn't already been arranged.
7056 Invoke this after init_process_emacs, and after glib and/or GNUstep
7057 futz with the SIGCHLD handler, but before Emacs forks any children.
7058 This function's caller should block SIGCHLD. */
7059
7060 void
7061 catch_child_signal (void)
7062 {
7063 struct sigaction action, old_action;
7064 sigset_t oldset;
7065 emacs_sigaction_init (&action, deliver_child_signal);
7066 block_child_signal (&oldset);
7067 sigaction (SIGCHLD, &action, &old_action);
7068 eassert (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7069 || ! (old_action.sa_flags & SA_SIGINFO));
7070
7071 if (old_action.sa_handler != deliver_child_signal)
7072 lib_child_handler
7073 = (old_action.sa_handler == SIG_DFL || old_action.sa_handler == SIG_IGN
7074 ? dummy_handler
7075 : old_action.sa_handler);
7076 unblock_child_signal (&oldset);
7077 }
7078 #endif /* subprocesses */
7079
7080 \f
7081 /* This is not called "init_process" because that is the name of a
7082 Mach system call, so it would cause problems on Darwin systems. */
7083 void
7084 init_process_emacs (void)
7085 {
7086 #ifdef subprocesses
7087 register int i;
7088
7089 inhibit_sentinels = 0;
7090
7091 #ifndef CANNOT_DUMP
7092 if (! noninteractive || initialized)
7093 #endif
7094 {
7095 #if defined HAVE_GLIB && !defined WINDOWSNT
7096 /* Tickle glib's child-handling code. Ask glib to wait for Emacs itself;
7097 this should always fail, but is enough to initialize glib's
7098 private SIGCHLD handler, allowing catch_child_signal to copy
7099 it into lib_child_handler. */
7100 g_source_unref (g_child_watch_source_new (getpid ()));
7101 #endif
7102 catch_child_signal ();
7103 }
7104
7105 FD_ZERO (&input_wait_mask);
7106 FD_ZERO (&non_keyboard_wait_mask);
7107 FD_ZERO (&non_process_wait_mask);
7108 FD_ZERO (&write_mask);
7109 max_process_desc = max_input_desc = -1;
7110 memset (fd_callback_info, 0, sizeof (fd_callback_info));
7111
7112 #ifdef NON_BLOCKING_CONNECT
7113 FD_ZERO (&connect_wait_mask);
7114 num_pending_connects = 0;
7115 #endif
7116
7117 #ifdef ADAPTIVE_READ_BUFFERING
7118 process_output_delay_count = 0;
7119 process_output_skip = 0;
7120 #endif
7121
7122 /* Don't do this, it caused infinite select loops. The display
7123 method should call add_keyboard_wait_descriptor on stdin if it
7124 needs that. */
7125 #if 0
7126 FD_SET (0, &input_wait_mask);
7127 #endif
7128
7129 Vprocess_alist = Qnil;
7130 deleted_pid_list = Qnil;
7131 for (i = 0; i < FD_SETSIZE; i++)
7132 {
7133 chan_process[i] = Qnil;
7134 proc_buffered_char[i] = -1;
7135 }
7136 memset (proc_decode_coding_system, 0, sizeof proc_decode_coding_system);
7137 memset (proc_encode_coding_system, 0, sizeof proc_encode_coding_system);
7138 #ifdef DATAGRAM_SOCKETS
7139 memset (datagram_address, 0, sizeof datagram_address);
7140 #endif
7141
7142 {
7143 Lisp_Object subfeatures = Qnil;
7144 const struct socket_options *sopt;
7145
7146 #define ADD_SUBFEATURE(key, val) \
7147 subfeatures = pure_cons (pure_cons (key, pure_cons (val, Qnil)), subfeatures)
7148
7149 #ifdef NON_BLOCKING_CONNECT
7150 ADD_SUBFEATURE (QCnowait, Qt);
7151 #endif
7152 #ifdef DATAGRAM_SOCKETS
7153 ADD_SUBFEATURE (QCtype, Qdatagram);
7154 #endif
7155 #ifdef HAVE_SEQPACKET
7156 ADD_SUBFEATURE (QCtype, Qseqpacket);
7157 #endif
7158 #ifdef HAVE_LOCAL_SOCKETS
7159 ADD_SUBFEATURE (QCfamily, Qlocal);
7160 #endif
7161 ADD_SUBFEATURE (QCfamily, Qipv4);
7162 #ifdef AF_INET6
7163 ADD_SUBFEATURE (QCfamily, Qipv6);
7164 #endif
7165 #ifdef HAVE_GETSOCKNAME
7166 ADD_SUBFEATURE (QCservice, Qt);
7167 #endif
7168 ADD_SUBFEATURE (QCserver, Qt);
7169
7170 for (sopt = socket_options; sopt->name; sopt++)
7171 subfeatures = pure_cons (intern_c_string (sopt->name), subfeatures);
7172
7173 Fprovide (intern_c_string ("make-network-process"), subfeatures);
7174 }
7175
7176 #if defined (DARWIN_OS)
7177 /* PTYs are broken on Darwin < 6, but are sometimes useful for interactive
7178 processes. As such, we only change the default value. */
7179 if (initialized)
7180 {
7181 char const *release = (STRINGP (Voperating_system_release)
7182 ? SSDATA (Voperating_system_release)
7183 : 0);
7184 if (!release || !release[0] || (release[0] < '7' && release[1] == '.')) {
7185 Vprocess_connection_type = Qnil;
7186 }
7187 }
7188 #endif
7189 #endif /* subprocesses */
7190 kbd_is_on_hold = 0;
7191 }
7192
7193 void
7194 syms_of_process (void)
7195 {
7196 #ifdef subprocesses
7197
7198 DEFSYM (Qprocessp, "processp");
7199 DEFSYM (Qrun, "run");
7200 DEFSYM (Qstop, "stop");
7201 DEFSYM (Qsignal, "signal");
7202
7203 /* Qexit is already staticpro'd by syms_of_eval; don't staticpro it
7204 here again. */
7205
7206 DEFSYM (Qopen, "open");
7207 DEFSYM (Qclosed, "closed");
7208 DEFSYM (Qconnect, "connect");
7209 DEFSYM (Qfailed, "failed");
7210 DEFSYM (Qlisten, "listen");
7211 DEFSYM (Qlocal, "local");
7212 DEFSYM (Qipv4, "ipv4");
7213 #ifdef AF_INET6
7214 DEFSYM (Qipv6, "ipv6");
7215 #endif
7216 DEFSYM (Qdatagram, "datagram");
7217 DEFSYM (Qseqpacket, "seqpacket");
7218
7219 DEFSYM (QCport, ":port");
7220 DEFSYM (QCspeed, ":speed");
7221 DEFSYM (QCprocess, ":process");
7222
7223 DEFSYM (QCbytesize, ":bytesize");
7224 DEFSYM (QCstopbits, ":stopbits");
7225 DEFSYM (QCparity, ":parity");
7226 DEFSYM (Qodd, "odd");
7227 DEFSYM (Qeven, "even");
7228 DEFSYM (QCflowcontrol, ":flowcontrol");
7229 DEFSYM (Qhw, "hw");
7230 DEFSYM (Qsw, "sw");
7231 DEFSYM (QCsummary, ":summary");
7232
7233 DEFSYM (Qreal, "real");
7234 DEFSYM (Qnetwork, "network");
7235 DEFSYM (Qserial, "serial");
7236 DEFSYM (QCbuffer, ":buffer");
7237 DEFSYM (QChost, ":host");
7238 DEFSYM (QCservice, ":service");
7239 DEFSYM (QClocal, ":local");
7240 DEFSYM (QCremote, ":remote");
7241 DEFSYM (QCcoding, ":coding");
7242 DEFSYM (QCserver, ":server");
7243 DEFSYM (QCnowait, ":nowait");
7244 DEFSYM (QCsentinel, ":sentinel");
7245 DEFSYM (QClog, ":log");
7246 DEFSYM (QCnoquery, ":noquery");
7247 DEFSYM (QCstop, ":stop");
7248 DEFSYM (QCoptions, ":options");
7249 DEFSYM (QCplist, ":plist");
7250
7251 DEFSYM (Qlast_nonmenu_event, "last-nonmenu-event");
7252
7253 staticpro (&Vprocess_alist);
7254 staticpro (&deleted_pid_list);
7255
7256 #endif /* subprocesses */
7257
7258 DEFSYM (QCname, ":name");
7259 DEFSYM (QCtype, ":type");
7260
7261 DEFSYM (Qeuid, "euid");
7262 DEFSYM (Qegid, "egid");
7263 DEFSYM (Quser, "user");
7264 DEFSYM (Qgroup, "group");
7265 DEFSYM (Qcomm, "comm");
7266 DEFSYM (Qstate, "state");
7267 DEFSYM (Qppid, "ppid");
7268 DEFSYM (Qpgrp, "pgrp");
7269 DEFSYM (Qsess, "sess");
7270 DEFSYM (Qttname, "ttname");
7271 DEFSYM (Qtpgid, "tpgid");
7272 DEFSYM (Qminflt, "minflt");
7273 DEFSYM (Qmajflt, "majflt");
7274 DEFSYM (Qcminflt, "cminflt");
7275 DEFSYM (Qcmajflt, "cmajflt");
7276 DEFSYM (Qutime, "utime");
7277 DEFSYM (Qstime, "stime");
7278 DEFSYM (Qtime, "time");
7279 DEFSYM (Qcutime, "cutime");
7280 DEFSYM (Qcstime, "cstime");
7281 DEFSYM (Qctime, "ctime");
7282 #ifdef subprocesses
7283 DEFSYM (Qinternal_default_process_sentinel,
7284 "internal-default-process-sentinel");
7285 DEFSYM (Qinternal_default_process_filter,
7286 "internal-default-process-filter");
7287 #endif
7288 DEFSYM (Qpri, "pri");
7289 DEFSYM (Qnice, "nice");
7290 DEFSYM (Qthcount, "thcount");
7291 DEFSYM (Qstart, "start");
7292 DEFSYM (Qvsize, "vsize");
7293 DEFSYM (Qrss, "rss");
7294 DEFSYM (Qetime, "etime");
7295 DEFSYM (Qpcpu, "pcpu");
7296 DEFSYM (Qpmem, "pmem");
7297 DEFSYM (Qargs, "args");
7298
7299 DEFVAR_BOOL ("delete-exited-processes", delete_exited_processes,
7300 doc: /* Non-nil means delete processes immediately when they exit.
7301 A value of nil means don't delete them until `list-processes' is run. */);
7302
7303 delete_exited_processes = 1;
7304
7305 #ifdef subprocesses
7306 DEFVAR_LISP ("process-connection-type", Vprocess_connection_type,
7307 doc: /* Control type of device used to communicate with subprocesses.
7308 Values are nil to use a pipe, or t or `pty' to use a pty.
7309 The value has no effect if the system has no ptys or if all ptys are busy:
7310 then a pipe is used in any case.
7311 The value takes effect when `start-process' is called. */);
7312 Vprocess_connection_type = Qt;
7313
7314 #ifdef ADAPTIVE_READ_BUFFERING
7315 DEFVAR_LISP ("process-adaptive-read-buffering", Vprocess_adaptive_read_buffering,
7316 doc: /* If non-nil, improve receive buffering by delaying after short reads.
7317 On some systems, when Emacs reads the output from a subprocess, the output data
7318 is read in very small blocks, potentially resulting in very poor performance.
7319 This behavior can be remedied to some extent by setting this variable to a
7320 non-nil value, as it will automatically delay reading from such processes, to
7321 allow them to produce more output before Emacs tries to read it.
7322 If the value is t, the delay is reset after each write to the process; any other
7323 non-nil value means that the delay is not reset on write.
7324 The variable takes effect when `start-process' is called. */);
7325 Vprocess_adaptive_read_buffering = Qt;
7326 #endif
7327
7328 defsubr (&Sprocessp);
7329 defsubr (&Sget_process);
7330 defsubr (&Sdelete_process);
7331 defsubr (&Sprocess_status);
7332 defsubr (&Sprocess_exit_status);
7333 defsubr (&Sprocess_id);
7334 defsubr (&Sprocess_name);
7335 defsubr (&Sprocess_tty_name);
7336 defsubr (&Sprocess_command);
7337 defsubr (&Sset_process_buffer);
7338 defsubr (&Sprocess_buffer);
7339 defsubr (&Sprocess_mark);
7340 defsubr (&Sset_process_filter);
7341 defsubr (&Sprocess_filter);
7342 defsubr (&Sset_process_sentinel);
7343 defsubr (&Sprocess_sentinel);
7344 defsubr (&Sset_process_window_size);
7345 defsubr (&Sset_process_inherit_coding_system_flag);
7346 defsubr (&Sset_process_query_on_exit_flag);
7347 defsubr (&Sprocess_query_on_exit_flag);
7348 defsubr (&Sprocess_contact);
7349 defsubr (&Sprocess_plist);
7350 defsubr (&Sset_process_plist);
7351 defsubr (&Sprocess_list);
7352 defsubr (&Sstart_process);
7353 defsubr (&Sserial_process_configure);
7354 defsubr (&Smake_serial_process);
7355 defsubr (&Sset_network_process_option);
7356 defsubr (&Smake_network_process);
7357 defsubr (&Sformat_network_address);
7358 defsubr (&Snetwork_interface_list);
7359 defsubr (&Snetwork_interface_info);
7360 #ifdef DATAGRAM_SOCKETS
7361 defsubr (&Sprocess_datagram_address);
7362 defsubr (&Sset_process_datagram_address);
7363 #endif
7364 defsubr (&Saccept_process_output);
7365 defsubr (&Sprocess_send_region);
7366 defsubr (&Sprocess_send_string);
7367 defsubr (&Sinterrupt_process);
7368 defsubr (&Skill_process);
7369 defsubr (&Squit_process);
7370 defsubr (&Sstop_process);
7371 defsubr (&Scontinue_process);
7372 defsubr (&Sprocess_running_child_p);
7373 defsubr (&Sprocess_send_eof);
7374 defsubr (&Ssignal_process);
7375 defsubr (&Swaiting_for_user_input_p);
7376 defsubr (&Sprocess_type);
7377 defsubr (&Sinternal_default_process_sentinel);
7378 defsubr (&Sinternal_default_process_filter);
7379 defsubr (&Sset_process_coding_system);
7380 defsubr (&Sprocess_coding_system);
7381 defsubr (&Sset_process_filter_multibyte);
7382 defsubr (&Sprocess_filter_multibyte_p);
7383
7384 #endif /* subprocesses */
7385
7386 defsubr (&Sget_buffer_process);
7387 defsubr (&Sprocess_inherit_coding_system_flag);
7388 defsubr (&Slist_system_processes);
7389 defsubr (&Sprocess_attributes);
7390 }