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