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