1 /* Asynchronous subprocess implementation for UNIX
2 Copyright (C) 1985, 1986, 1987, 1988, 1992, 1993, 1994, 1995
3 Free Software Foundation, Inc.
4 Copyright (C) 1995 Sun Microsystems, Inc.
5 Copyright (C) 1995, 1996 Ben Wing.
7 This file is part of XEmacs.
9 XEmacs is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 2, or (at your option) any
14 XEmacs is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 You should have received a copy of the GNU General Public License
20 along with XEmacs; see the file COPYING. If not, write to
21 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
24 /* This file has been Mule-ized except for `start-process-internal',
25 `open-network-stream-internal' and `open-multicast-group-internal'. */
27 /* This file has been split into process.c and process-unix.c by
28 Kirill M. Katsnelson <kkm@kis.ru>, so please bash him and not
29 the original author(s) */
33 #if !defined (NO_SUBPROCESSES)
35 /* The entire file is within this conditional */
50 #include "file-coding.h"
57 #include "syssignal.h" /* Always include before systty.h */
63 * Implementation-specific data. Pointed to by Lisp_Process->process_data
66 struct unix_process_data
68 /* Non-0 if this is really a ToolTalk channel. */
69 int connected_via_filedesc_p;
70 /* Descriptor by which we read from this process. -1 for dead process */
72 /* Descriptor for the tty which this process is using.
73 -1 if we didn't record it (on some systems, there's no need). */
75 /* Name of subprocess terminal. */
77 /* Non-false if communicating through a pty. */
81 #define UNIX_DATA(p) ((struct unix_process_data*)((p)->process_data))
84 /* The file name of the pty opened by allocate_pty. */
86 static char pty_name[24];
91 /**********************************************************************/
92 /* Static helper routines */
93 /**********************************************************************/
96 close_safely_handler (int signo)
98 EMACS_REESTABLISH_SIGNAL (signo, close_safely_handler);
103 close_safely (int fd)
106 signal (SIGALRM, close_safely_handler);
114 close_descriptor_pair (int in, int out)
118 if (out != in && out >= 0)
122 /* Close all descriptors currently in use for communication
123 with subprocess. This is used in a newly-forked subprocess
124 to get rid of irrelevant descriptors. */
127 close_process_descs_mapfun (CONST void* key, void* contents, void* arg)
130 CVOID_TO_LISP (proc, contents);
131 event_stream_delete_stream_pair (XPROCESS(proc)->pipe_instream,
132 XPROCESS(proc)->pipe_outstream);
136 /* #### This function is currently called from child_setup
137 in callproc.c. It should become static though - kkm */
139 close_process_descs (void)
141 maphash (close_process_descs_mapfun, usid_to_process, 0);
144 /* connect to an existing file descriptor. This is very similar to
145 open-network-stream except that it assumes that the connection has
146 already been initialized. It is currently used for ToolTalk
149 /* This function used to be visible on the Lisp level, but there is no
150 real point in doing that. Here is the doc string:
152 "Connect to an existing file descriptor.\n\
153 Returns a subprocess-object to represent the connection.\n\
154 Input and output work as for subprocesses; `delete-process' closes it.\n\
155 Args are NAME BUFFER INFD OUTFD.\n\
156 NAME is name for process. It is modified if necessary to make it unique.\n\
157 BUFFER is the buffer (or buffer-name) to associate with the process.\n\
158 Process output goes at end of that buffer, unless you specify\n\
159 an output stream or filter function to handle the output.\n\
160 BUFFER may be also nil, meaning that this process is not associated\n\
162 INFD and OUTFD specify the file descriptors to use for input and\n\
163 output, respectively."
167 connect_to_file_descriptor (Lisp_Object name, Lisp_Object buffer,
168 Lisp_Object infd, Lisp_Object outfd)
170 /* This function can GC */
179 if (get_process_from_usid (FD_TO_USID(inch)))
180 error ("There is already a process connected to fd %d", inch);
182 buffer = Fget_buffer_create (buffer);
183 proc = make_process_internal (name);
185 XPROCESS (proc)->pid = Fcons (infd, name);
186 XPROCESS (proc)->buffer = buffer;
187 init_process_io_handles (XPROCESS (proc), (void*)inch, (void*)XINT (outfd), 0);
188 UNIX_DATA (XPROCESS (proc))->connected_via_filedesc_p = 1;
190 event_stream_select_process (XPROCESS (proc));
197 /* Open an available pty, returning a file descriptor.
198 Return -1 on failure.
199 The file name of the terminal corresponding to the pty
200 is left in the variable pty_name. */
208 /* Some systems name their pseudoterminals so that there are gaps in
209 the usual sequence - for example, on HP9000/S700 systems, there
210 are no pseudoterminals with names ending in 'f'. So we wait for
211 three failures in a row before deciding that we've reached the
213 int failed_count = 0;
224 for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
225 for (i = 0; i < 16; i++)
228 #ifdef PTY_NAME_SPRINTF
231 sprintf (pty_name, "/dev/pty%c%x", c, i);
232 #endif /* no PTY_NAME_SPRINTF */
236 #else /* no PTY_OPEN */
238 /* Unusual IRIS code */
239 *ptyv = open ("/dev/ptc", O_RDWR | O_NONBLOCK | OPEN_BINARY, 0);
242 if (fstat (fd, &stb) < 0)
245 if (stat (pty_name, &stb) < 0)
248 if (failed_count >= 3)
253 fd = open (pty_name, O_RDWR | O_NONBLOCK | OPEN_BINARY, 0);
254 #endif /* not IRIS */
255 #endif /* no PTY_OPEN */
259 /* check to make certain that both sides are available
260 this avoids a nasty yet stupid bug in rlogins */
261 #ifdef PTY_TTY_NAME_SPRINTF
264 sprintf (pty_name, "/dev/tty%c%x", c, i);
265 #endif /* no PTY_TTY_NAME_SPRINTF */
266 #if !defined(UNIPLUS) && !defined(HAVE_GETPT)
267 if (access (pty_name, 6) != 0)
270 #if !defined(IRIS) && !defined(__sgi)
276 #endif /* not UNIPLUS */
283 #endif /* HAVE_PTYS */
286 create_bidirectional_pipe (int *inchannel, int *outchannel,
287 volatile int *forkin, volatile int *forkout)
292 if (socketpair (AF_UNIX, SOCK_STREAM, 0, sv) < 0)
294 *outchannel = *inchannel = sv[0];
295 *forkout = *forkin = sv[1];
296 #else /* not SKTPAIR */
299 if (temp < 0) return -1;
303 if (temp < 0) return -1;
306 #endif /* not SKTPAIR */
314 get_internet_address (Lisp_Object host, struct sockaddr_in *address,
317 struct hostent *host_info_ptr = NULL;
327 if (count++ > 10) break;
328 #ifndef BROKEN_CYGWIN
332 /* Some systems can't handle SIGIO/SIGALARM in gethostbyname. */
333 slow_down_interrupts ();
334 host_info_ptr = gethostbyname ((char *) XSTRING_DATA (host));
335 speed_up_interrupts ();
337 if (! (host_info_ptr == 0 && h_errno == TRY_AGAIN))
340 Fsleep_for (make_int (1));
344 address->sin_family = host_info_ptr->h_addrtype;
345 memcpy (&address->sin_addr, host_info_ptr->h_addr, host_info_ptr->h_length);
349 IN_ADDR numeric_addr;
350 /* Attempt to interpret host as numeric inet address */
351 numeric_addr = inet_addr ((char *) XSTRING_DATA (host));
352 if (NUMERIC_ADDR_ERROR)
354 maybe_error (Qprocess, errb,
355 "Unknown host \"%s\"", XSTRING_DATA (host));
359 /* There was some broken code here that called strlen() here
360 on (char *) &numeric_addr and even sometimes accessed
361 uninitialized data. */
362 address->sin_family = AF_INET;
363 * (IN_ADDR *) &address->sin_addr = numeric_addr;
370 set_socket_nonblocking_maybe (int fd, int port, CONST char* proto)
372 #ifdef PROCESS_IO_BLOCKING
375 for (tail = network_stream_blocking_port_list; CONSP (tail); tail = XCDR (tail))
377 Lisp_Object tail_port = XCAR (tail);
379 if (STRINGP (tail_port))
381 struct servent *svc_info;
382 CHECK_STRING (tail_port);
383 svc_info = getservbyname ((char *) XSTRING_DATA (tail_port), proto);
384 if ((svc_info != 0) && (svc_info->s_port == port))
389 else if (INTP (tail_port) && (htons ((unsigned short) XINT (tail_port)) == port))
395 set_descriptor_non_blocking (fd);
398 set_descriptor_non_blocking (fd);
399 #endif /* PROCESS_IO_BLOCKING */
402 #endif /* HAVE_SOCKETS */
404 /* Compute the Lisp form of the process status from
405 the numeric status that was returned by `wait'. */
408 update_status_from_wait_code (struct Lisp_Process *p, int *w_fmh)
410 /* C compiler lossage when attempting to pass w directly */
415 p->status_symbol = Qstop;
416 p->exit_code = WSTOPSIG (w);
419 else if (WIFEXITED (w))
421 p->status_symbol = Qexit;
422 p->exit_code = WEXITSTATUS (w);
425 else if (WIFSIGNALED (w))
427 p->status_symbol = Qsignal;
428 p->exit_code = WTERMSIG (w);
429 p->core_dumped = WCOREDUMP (w);
433 p->status_symbol = Qrun;
440 #define MAX_EXITED_PROCESSES 1000
441 static volatile pid_t exited_processes[MAX_EXITED_PROCESSES];
442 static volatile int exited_processes_status[MAX_EXITED_PROCESSES];
443 static volatile int exited_processes_index;
445 static volatile int sigchld_happened;
447 /* On receipt of a signal that a child status has changed,
448 loop asking about children with changed statuses until
449 the system says there are no more. All we do is record
450 the processes and wait status.
452 This function could be called from within the SIGCHLD
453 handler, so it must be completely reentrant. When
454 not called from a SIGCHLD handler, BLOCK_SIGCHLD should
455 be non-zero so that SIGCHLD is blocked while this
456 function is running. (This is necessary so avoid
457 race conditions with the SIGCHLD_HAPPENED flag). */
460 record_exited_processes (int block_sigchld)
462 if (!sigchld_happened)
467 #ifdef EMACS_BLOCK_SIGNAL
469 EMACS_BLOCK_SIGNAL (SIGCHLD);
472 while (sigchld_happened)
477 /* Keep trying to get a status until we get a definitive result. */
484 # endif /* not WUNTRACED */
486 pid = waitpid ((pid_t) -1, &w, WNOHANG | WUNTRACED);
488 pid = wait3 (&w, WNOHANG | WUNTRACED, 0);
490 #else /* not WNOHANG */
492 #endif /* not WNOHANG */
494 while (pid <= 0 && errno == EINTR);
499 if (exited_processes_index < MAX_EXITED_PROCESSES)
501 exited_processes[exited_processes_index] = pid;
502 exited_processes_status[exited_processes_index] = w;
503 exited_processes_index++;
506 /* On systems with WNOHANG, we just ignore the number
507 of times that SIGCHLD was signalled, and keep looping
508 until there are no more processes to wait on. If we
509 don't have WNOHANG, we have to rely on the count in
513 #endif /* not WNOHANG */
516 sigchld_happened = 0;
519 EMACS_UNBLOCK_SIGNAL (SIGCHLD);
522 /* For any processes that have changed status and are recorded
523 and such, update the corresponding struct Lisp_Process.
524 We separate this from record_exited_processes() so that
525 we never have to call this function from within a signal
526 handler. We block SIGCHLD in case record_exited_processes()
527 is called from a signal handler. */
529 /** USG WARNING: Although it is not obvious from the documentation
530 in signal(2), on a USG system the SIGCLD handler MUST NOT call
531 signal() before executing at least one wait(), otherwise the handler
532 will be called again, resulting in an infinite loop. The relevant
533 portion of the documentation reads "SIGCLD signals will be queued
534 and the signal-catching function will be continually reentered until
535 the queue is empty". Invoking signal() causes the kernel to reexamine
536 the SIGCLD queue. Fred Fish, UniSoft Systems Inc.
538 (Note that now this only applies in SYS V Release 2 and before.
539 On SYS V Release 3, we use sigset() to set the signal handler for
540 the first time, and so we don't have to reestablish the signal handler
541 in the handler below. On SYS V Release 4, we don't get this weirdo
542 behavior when we use sigaction(), which we do use.) */
545 sigchld_handler (int signo)
547 #ifdef OBNOXIOUS_SYSV_SIGCLD_BEHAVIOR
548 int old_errno = errno;
551 record_exited_processes (0);
556 #ifdef HAVE_UNIXOID_EVENT_LOOP
557 signal_fake_event ();
559 /* WARNING - must come after wait3() for USG systems */
560 EMACS_REESTABLISH_SIGNAL (signo, sigchld_handler);
566 #ifdef SIGNALS_VIA_CHARACTERS
567 /* Get signal character to send to process if SIGNALS_VIA_CHARACTERS */
570 process_signal_char (int tty_fd, int signo)
572 /* If it's not a tty, pray that these default values work */
573 if (!isatty(tty_fd)) {
574 #define CNTL(ch) (037 & (ch))
577 case SIGINT: return CNTL('C');
578 case SIGQUIT: return CNTL('\\');
580 case SIGTSTP: return CNTL('Z');
586 /* TERMIOS is the latest and bestest, and seems most likely to work.
587 If the system has it, use it. */
590 tcgetattr (tty_fd, &t);
593 case SIGINT: return t.c_cc[VINTR];
594 case SIGQUIT: return t.c_cc[VQUIT];
595 #if defined(SIGTSTP) && defined(VSUSP)
596 case SIGTSTP: return t.c_cc[VSUSP];
601 # elif defined (TIOCGLTC) && defined (TIOCGETC) /* not HAVE_TERMIOS */
603 /* On Berkeley descendants, the following IOCTL's retrieve the
604 current control characters. */
609 case SIGINT: ioctl (tty_fd, TIOCGETC, &c); return c.t_intrc;
610 case SIGQUIT: ioctl (tty_fd, TIOCGETC, &c); return c.t_quitc;
612 case SIGTSTP: ioctl (tty_fd, TIOCGLTC, &lc); return lc.t_suspc;
613 # endif /* SIGTSTP */
617 # elif defined (TCGETA) /* ! defined (TIOCGLTC) && defined (TIOCGETC) */
619 /* On SYSV descendants, the TCGETA ioctl retrieves the current
620 control characters. */
622 ioctl (tty_fd, TCGETA, &t);
624 case SIGINT: return t.c_cc[VINTR];
625 case SIGQUIT: return t.c_cc[VQUIT];
627 case SIGTSTP: return t.c_cc[VSWTCH];
628 # endif /* SIGTSTP */
631 # else /* ! defined (TCGETA) */
632 #error ERROR! Using SIGNALS_VIA_CHARACTERS, but not HAVE_TERMIOS || (TIOCGLTC && TIOCGETC) || TCGETA
633 /* If your system configuration files define SIGNALS_VIA_CHARACTERS,
634 you'd better be using one of the alternatives above! */
635 # endif /* ! defined (TCGETA) */
638 #endif /* SIGNALS_VIA_CHARACTERS */
643 /**********************************************************************/
644 /* Process implementation methods */
645 /**********************************************************************/
648 * Allocate and initialize Lisp_Process->process_data
652 unix_alloc_process_data (struct Lisp_Process *p)
654 p->process_data = xnew (struct unix_process_data);
656 UNIX_DATA(p)->connected_via_filedesc_p = 0;
657 UNIX_DATA(p)->infd = -1;
658 UNIX_DATA(p)->subtty = -1;
659 UNIX_DATA(p)->tty_name = Qnil;
660 UNIX_DATA(p)->pty_flag = 0;
664 * Mark any Lisp objects in Lisp_Process->process_data
668 unix_mark_process_data (struct Lisp_Process *proc)
670 mark_object (UNIX_DATA(proc)->tty_name);
674 * Initialize XEmacs process implementation once
679 unix_init_process (void)
682 if (! noninteractive || initialized)
684 signal (SIGCHLD, sigchld_handler);
689 * Initialize any process local data. This is called when newly
690 * created process is connected to real OS file handles. The
691 * handles are generally represented by void* type, but are
692 * of type int (file descriptors) for UNIX
696 unix_init_process_io_handles (struct Lisp_Process *p, void* in, void* out, int flags)
698 UNIX_DATA(p)->infd = (int)in;
702 * Fork off a subprocess. P is a pointer to a newly created subprocess
703 * object. If this function signals, the caller is responsible for
704 * deleting (and finalizing) the process object.
706 * The method must return PID of the new process, a (positive??? ####) number
707 * which fits into Lisp_Int. No return value indicates an error, the method
708 * must signal an error instead.
712 unix_create_process (struct Lisp_Process *p,
713 Lisp_Object *argv, int nargv,
714 Lisp_Object program, Lisp_Object cur_dir)
716 /* This function rewritten by ben@xemacs.org. */
721 /* Use volatile to protect variables from being clobbered by longjmp. */
722 volatile int forkin = -1;
723 volatile int forkout = -1;
724 volatile int pty_flag = 0;
727 if (!NILP (Vprocess_connection_type))
729 /* find a new pty, open the master side, return the opened
730 file handle, and store the name of the corresponding slave
731 side in global variable pty_name. */
732 outchannel = inchannel = allocate_pty ();
737 /* You're "supposed" to now open the slave in the child.
738 On some systems, we can open it here; this allows for
739 better error checking. */
741 /* On USG systems it does not work to open the pty's tty here
742 and then close and reopen it in the child. */
744 /* Don't let this terminal become our controlling terminal
745 (in case we don't have one). */
746 forkout = forkin = open (pty_name, O_RDWR | O_NOCTTY | OPEN_BINARY, 0);
748 forkout = forkin = open (pty_name, O_RDWR | OPEN_BINARY, 0);
753 UNIX_DATA(p)->pty_flag = pty_flag = 1;
756 #endif /* HAVE_PTYS */
757 if (create_bidirectional_pipe (&inchannel, &outchannel,
758 &forkin, &forkout) < 0)
762 /* Replaced by close_process_descs */
763 set_exclusive_use (inchannel);
764 set_exclusive_use (outchannel);
767 set_descriptor_non_blocking (inchannel);
769 /* Record this as an active process, with its channels.
770 As a result, child_setup will close Emacs's side of the pipes. */
771 init_process_io_handles (p, (void*)inchannel, (void*)outchannel,
772 pty_flag ? STREAM_PTY_FLUSHING : 0);
773 /* Record the tty descriptor used in the subprocess. */
774 UNIX_DATA(p)->subtty = forkin;
777 #if !defined(__CYGWIN32__)
778 /* child_setup must clobber environ on systems with true vfork.
779 Protect it from permanent change. */
780 char **save_environ = environ;
786 /**** Now we're in the child process ****/
787 int xforkin = forkin;
788 int xforkout = forkout;
791 EMACS_SEPARATE_PROCESS_GROUP ();
795 /* Disconnect the current controlling terminal, pursuant to
796 making the pty be the controlling terminal of the process.
797 Also put us in our own process group. */
799 disconnect_controlling_terminal ();
801 /* Open the pty connection and make the pty's terminal
802 our controlling terminal.
804 On systems with TIOCSCTTY, we just use it to set
805 the controlling terminal. On other systems, the
806 first TTY we open becomes the controlling terminal.
807 So, we end up with four possibilities:
809 (1) on USG and TIOCSCTTY systems, we open the pty
811 (2) on other USG systems, we just open the pty.
812 (3) on non-USG systems with TIOCSCTTY, we
813 just use TIOCSCTTY. (On non-USG systems, we
814 already opened the pty in the parent process.)
815 (4) on non-USG systems without TIOCSCTTY, we
816 close the pty and reopen it.
818 This would be cleaner if we didn't open the pty
819 in the parent process, but doing it that way
820 makes it possible to trap error conditions.
821 It's harder to convey an error from the child
822 process, and I don't feel like messing with
825 /* There was some weirdo, probably wrong,
826 conditionalization on RTU and UNIPLUS here.
827 I deleted it. So sue me. */
829 /* SunOS has TIOCSCTTY but the close/open method
832 # if defined (USG) || !defined (TIOCSCTTY)
833 /* Now close the pty (if we had it open) and reopen it.
834 This makes the pty the controlling terminal of the
836 /* I wonder if close (open (pty_name, ...)) would work? */
839 xforkout = xforkin = open (pty_name, O_RDWR | OPEN_BINARY, 0);
842 write (1, "Couldn't open the pty terminal ", 31);
843 write (1, pty_name, strlen (pty_name));
847 # endif /* USG or not TIOCSCTTY */
849 /* Miscellaneous setup required for some systems.
850 Must be done before using tc* functions on xforkin.
851 This guarantees that isatty(xforkin) is true. */
853 # ifdef SETUP_SLAVE_PTY
855 # endif /* SETUP_SLAVE_PTY */
858 /* We ignore the return value
859 because faith@cs.unc.edu says that is necessary on Linux. */
860 assert (isatty (xforkin));
861 ioctl (xforkin, TIOCSCTTY, 0);
862 # endif /* TIOCSCTTY */
864 /* Change the line discipline. */
866 # if defined (HAVE_TERMIOS) && defined (LDISC1)
869 assert (isatty (xforkin));
870 tcgetattr (xforkin, &t);
872 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
873 perror ("create_process/tcsetattr LDISC1 failed\n");
875 # elif defined (NTTYDISC) && defined (TIOCSETD)
877 /* Use new line discipline. TIOCSETD is accepted and
878 ignored on Sys5.4 systems with ttcompat. */
879 int ldisc = NTTYDISC;
880 assert (isatty (xforkin));
881 ioctl (xforkin, TIOCSETD, &ldisc);
883 # endif /* TIOCSETD & NTTYDISC */
885 /* Make our process group be the foreground group
886 of our new controlling terminal. */
889 int piddly = EMACS_GET_PROCESS_GROUP ();
890 EMACS_SET_TTY_PROCESS_GROUP (xforkin, &piddly);
893 /* On AIX, we've disabled SIGHUP above once we start a
894 child on a pty. Now reenable it in the child, so it
895 will die when we want it to.
896 JV: This needs to be done ALWAYS as we might have inherited
897 a SIG_IGN handling from our parent (nohup) and we are in new
900 signal (SIGHUP, SIG_DFL);
904 /* Set up the terminal characteristics of the pty. */
905 child_setup_tty (xforkout);
907 #endif /* HAVE_PTYS */
909 signal (SIGINT, SIG_DFL);
910 signal (SIGQUIT, SIG_DFL);
914 char **new_argv = alloca_array (char *, nargv + 2);
917 /* Nothing below here GCs so our string pointers shouldn't move. */
918 new_argv[0] = (char *) XSTRING_DATA (program);
919 for (i = 0; i < nargv; i++)
921 CHECK_STRING (argv[i]);
922 new_argv[i + 1] = (char *) XSTRING_DATA (argv[i]);
926 GET_C_STRING_FILENAME_DATA_ALLOCA (cur_dir, current_dir);
928 child_setup (xforkin, xforkout, xforkout, new_argv, current_dir);
931 } /**** End of child code ****/
933 /**** Back in parent process ****/
934 #if !defined(__CYGWIN32__)
935 environ = save_environ;
941 close_descriptor_pair (forkin, forkout);
942 report_file_error ("Doing fork", Qnil);
945 /* #### dmoore - why is this commented out, otherwise we leave
946 subtty = forkin, but then we close forkin just below. */
947 /* UNIX_DATA(p)->subtty = -1; */
949 /* If the subfork execv fails, and it exits,
950 this close hangs. I don't know why.
951 So have an interrupt jar it loose. */
953 close_safely (forkin);
954 if (forkin != forkout && forkout >= 0)
959 UNIX_DATA (p)->tty_name = build_string (pty_name);
962 UNIX_DATA (p)->tty_name = Qnil;
964 /* Notice that SIGCHLD was not blocked. (This is not possible on
965 some systems.) No biggie if SIGCHLD occurs right around the
966 time that this call happens, because SIGCHLD() does not actually
967 deselect the process (that doesn't occur until the next time
968 we're waiting for an event, when status_notify() is called). */
973 int save_errno = errno;
974 close_descriptor_pair (forkin, forkout);
975 close_descriptor_pair (inchannel, outchannel);
977 report_file_error ("Opening pty or pipe", Qnil);
978 return 0; /* not reached */
982 /* Return nonzero if this process is a ToolTalk connection. */
985 unix_tooltalk_connection_p (struct Lisp_Process *p)
987 return UNIX_DATA(p)->connected_via_filedesc_p;
990 /* This is called to set process' virtual terminal size */
993 unix_set_window_size (struct Lisp_Process* p, int cols, int rows)
995 return set_window_size (UNIX_DATA(p)->infd, cols, rows);
999 * This method is called to update status fields of the process
1000 * structure. If the process has not existed, this method is
1001 * expected to do nothing.
1003 * The method is called only for real child processes.
1008 unix_update_status_if_terminated (struct Lisp_Process* p)
1012 EMACS_BLOCK_SIGNAL (SIGCHLD);
1014 if (waitpid (XINT (p->pid), &w, WNOHANG) == XINT (p->pid))
1017 update_status_from_wait_code (p, &w);
1020 EMACS_UNBLOCK_SIGNAL (SIGCHLD);
1026 * Update status of all exited processes. Called when SIGCLD has signaled.
1031 unix_reap_exited_processes (void)
1034 struct Lisp_Process *p;
1036 #ifndef OBNOXIOUS_SYSV_SIGCLD_BEHAVIOR
1037 record_exited_processes (1);
1040 if (exited_processes_index <= 0)
1045 #ifdef EMACS_BLOCK_SIGNAL
1046 EMACS_BLOCK_SIGNAL (SIGCHLD);
1048 for (i = 0; i < exited_processes_index; i++)
1050 int pid = exited_processes[i];
1051 int w = exited_processes_status[i];
1053 /* Find the process that signaled us, and record its status. */
1058 LIST_LOOP (tail, Vprocess_list)
1060 Lisp_Object proc = XCAR (tail);
1061 p = XPROCESS (proc);
1062 if (INTP (p->pid) && XINT (p->pid) == pid)
1070 /* Change the status of the process that was found. */
1073 update_status_from_wait_code (p, &w);
1075 /* If process has terminated, stop waiting for its output. */
1076 if (WIFSIGNALED (w) || WIFEXITED (w))
1078 if (!NILP(p->pipe_instream))
1080 /* We can't just call event_stream->unselect_process_cb (p)
1081 here, because that calls XtRemoveInput, which is not
1082 necessarily reentrant, so we can't call this at interrupt
1090 /* There was no asynchronous process found for that id. Check
1091 if we have a synchronous process. Only set sync process status
1092 if there is one, so we work OK with the waitpid() call in
1093 wait_for_termination(). */
1094 if (synch_process_alive != 0)
1095 { /* Set the global sync process status variables. */
1096 synch_process_alive = 0;
1098 /* Report the status of the synchronous process. */
1100 synch_process_retcode = WEXITSTATUS (w);
1101 else if (WIFSIGNALED (w))
1102 synch_process_death = signal_name (WTERMSIG (w));
1107 exited_processes_index = 0;
1109 EMACS_UNBLOCK_SIGNAL (SIGCHLD);
1111 #endif /* SIGCHLD */
1114 * Stuff the entire contents of LSTREAM to the process output pipe
1117 static JMP_BUF send_process_frame;
1120 send_process_trap (int signum)
1122 EMACS_REESTABLISH_SIGNAL (signum, send_process_trap);
1123 EMACS_UNBLOCK_SIGNAL (signum);
1124 LONGJMP (send_process_frame, 1);
1128 unix_send_process (Lisp_Object proc, struct lstream* lstream)
1130 /* Use volatile to protect variables from being clobbered by longjmp. */
1131 SIGTYPE (*volatile old_sigpipe) (int) = 0;
1132 volatile Lisp_Object vol_proc = proc;
1133 struct Lisp_Process *volatile p = XPROCESS (proc);
1135 if (!SETJMP (send_process_frame))
1137 /* use a reasonable-sized buffer (somewhere around the size of the
1138 stream buffer) so as to avoid inundating the stream with blocked
1140 Bufbyte chunkbuf[512];
1147 chunklen = Lstream_read (lstream, chunkbuf, 512);
1149 break; /* perhaps should abort() if < 0?
1150 This should never happen. */
1152 (SIGTYPE (*) (int)) signal (SIGPIPE, send_process_trap);
1153 /* Lstream_write() will never successfully write less than
1154 the amount sent in. In the worst case, it just buffers
1155 the unwritten data. */
1156 writeret = Lstream_write (XLSTREAM (DATA_OUTSTREAM(p)), chunkbuf,
1158 signal (SIGPIPE, old_sigpipe);
1160 /* This is a real error. Blocking errors are handled
1161 specially inside of the filedesc stream. */
1162 report_file_error ("writing to process", list1 (proc));
1163 while (Lstream_was_blocked_p (XLSTREAM (p->pipe_outstream)))
1165 /* Buffer is full. Wait, accepting input;
1166 that may allow the program
1167 to finish doing output and read more. */
1168 Faccept_process_output (Qnil, make_int (1), Qnil);
1170 (SIGTYPE (*) (int)) signal (SIGPIPE, send_process_trap);
1171 Lstream_flush (XLSTREAM (p->pipe_outstream));
1172 signal (SIGPIPE, old_sigpipe);
1177 { /* We got here from a longjmp() from the SIGPIPE handler */
1178 signal (SIGPIPE, old_sigpipe);
1179 /* Close the file lstream so we don't attempt to write to it further */
1180 /* #### There is controversy over whether this might cause fd leakage */
1181 /* my tests say no. -slb */
1182 XLSTREAM (p->pipe_outstream)->flags &= ~LSTREAM_FL_IS_OPEN;
1183 p->status_symbol = Qexit;
1184 p->exit_code = 256; /* #### SIGPIPE ??? */
1188 deactivate_process (*((Lisp_Object *) (&vol_proc)));
1189 error ("SIGPIPE raised on process %s; closed it",
1190 XSTRING_DATA (p->name));
1193 old_sigpipe = (SIGTYPE (*) (int)) signal (SIGPIPE, send_process_trap);
1194 Lstream_flush (XLSTREAM (DATA_OUTSTREAM(p)));
1195 signal (SIGPIPE, old_sigpipe);
1199 * Send EOF to the process. The default implementation simply
1200 * closes the output stream. The method must return 0 to call
1201 * the default implementation, or 1 if it has taken all care about
1202 * sending EOF to the process.
1206 unix_process_send_eof (Lisp_Object proc)
1208 if (!UNIX_DATA (XPROCESS (proc))->pty_flag)
1211 /* #### get_eof_char simply doesn't return the correct character
1212 here. Maybe it is needed to determine the right eof
1213 character in init_process_io_handles but here it simply screws
1216 Bufbyte eof_char = get_eof_char (XPROCESS (proc));
1217 send_process (proc, Qnil, &eof_char, 0, 1);
1219 send_process (proc, Qnil, (CONST Bufbyte *) "\004", 0, 1);
1225 * Called before the process is deactivated. The process object
1226 * is not immediately finalized, just undergoes a transition to
1229 * The return value is a unique stream ID, as returned by
1230 * event_stream_delete_stream_pair
1232 * In the lack of this method, only event_stream_delete_stream_pair
1233 * is called on both I/O streams of the process.
1235 * The UNIX version guards this by ignoring possible SIGPIPE.
1239 unix_deactivate_process (struct Lisp_Process *p)
1241 SIGTYPE (*old_sigpipe) (int) = 0;
1244 if (UNIX_DATA(p)->infd >= 0)
1245 flush_pending_output (UNIX_DATA(p)->infd);
1247 /* closing the outstream could result in SIGPIPE, so ignore it. */
1248 old_sigpipe = (SIGTYPE (*) (int)) signal (SIGPIPE, SIG_IGN);
1249 usid = event_stream_delete_stream_pair (p->pipe_instream, p->pipe_outstream);
1250 signal (SIGPIPE, old_sigpipe);
1252 UNIX_DATA(p)->infd = -1;
1257 /* send a signal number SIGNO to PROCESS.
1258 CURRENT_GROUP means send to the process group that currently owns
1259 the terminal being used to communicate with PROCESS.
1260 This is used for various commands in shell mode.
1261 If NOMSG is zero, insert signal-announcements into process's buffers
1264 If we can, we try to signal PROCESS by sending control characters
1265 down the pty. This allows us to signal inferiors who have changed
1266 their uid, for which killpg would return an EPERM error.
1268 The method signals an error if the given SIGNO is not valid
1272 unix_kill_child_process (Lisp_Object proc, int signo,
1273 int current_group, int nomsg)
1278 struct Lisp_Process *p = XPROCESS (proc);
1280 if (!UNIX_DATA(p)->pty_flag)
1283 /* If we are using pgrps, get a pgrp number and make it negative. */
1286 #ifdef SIGNALS_VIA_CHARACTERS
1287 /* If possible, send signals to the entire pgrp
1288 by sending an input character to it. */
1290 char sigchar = process_signal_char(UNIX_DATA(p)->subtty, signo);
1292 send_process (proc, Qnil, (Bufbyte *) &sigchar, 0, 1);
1296 #endif /* ! defined (SIGNALS_VIA_CHARACTERS) */
1299 /* Get the pgrp using the tty itself, if we have that.
1300 Otherwise, use the pty to get the pgrp.
1301 On pfa systems, saka@pfu.fujitsu.co.JP writes:
1302 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
1303 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
1304 His patch indicates that if TIOCGPGRP returns an error, then
1305 we should just assume that p->pid is also the process group id. */
1309 err = ioctl ( (UNIX_DATA(p)->subtty != -1
1310 ? UNIX_DATA(p)->subtty
1311 : UNIX_DATA(p)->infd), TIOCGPGRP, &gid);
1315 gid = - XINT (p->pid);
1316 #endif /* ! defined (pfa) */
1322 #else /* ! defined (TIOCGPGRP ) */
1323 /* Can't select pgrps on this system, so we know that
1324 the child itself heads the pgrp. */
1325 gid = - XINT (p->pid);
1326 #endif /* ! defined (TIOCGPGRP ) */
1329 gid = - XINT (p->pid);
1335 p->status_symbol = Qrun;
1342 #endif /* ! defined (SIGCONT) */
1346 flush_pending_output (UNIX_DATA(p)->infd);
1350 /* If we don't have process groups, send the signal to the immediate
1351 subprocess. That isn't really right, but it's better than any
1352 obvious alternative. */
1355 kill_retval = kill (XINT (p->pid), signo) ? errno : 0;
1359 /* gid may be a pid, or minus a pgrp's number */
1360 #if defined (TIOCSIGNAL) || defined (TIOCSIGSEND)
1364 kill_retval = ioctl (UNIX_DATA(p)->infd, TIOCSIGNAL, signo);
1365 #else /* ! defined (TIOCSIGNAL) */
1366 kill_retval = ioctl (UNIX_DATA(p)->infd, TIOCSIGSEND, signo);
1367 #endif /* ! defined (TIOCSIGNAL) */
1370 kill_retval = kill (- XINT (p->pid), signo) ? errno : 0;
1371 #else /* ! (defined (TIOCSIGNAL) || defined (TIOCSIGSEND)) */
1372 kill_retval = EMACS_KILLPG (-gid, signo) ? errno : 0;
1373 #endif /* ! (defined (TIOCSIGNAL) || defined (TIOCSIGSEND)) */
1376 if (kill_retval < 0 && errno == EINVAL)
1377 error ("Signal number %d is invalid for this system", signo);
1381 * Kill any process in the system given its PID.
1383 * Returns zero if a signal successfully sent, or
1384 * negative number upon failure
1388 unix_kill_process_by_pid (int pid, int sigcode)
1390 return kill (pid, sigcode);
1394 * Return TTY name used to communicate with subprocess
1398 unix_get_tty_name (struct Lisp_Process *p)
1400 return UNIX_DATA (p)->tty_name;
1404 * Canonicalize host name HOST, and return its canonical form
1406 * The default implementation just takes HOST for a canonical name.
1411 unix_canonicalize_host_name (Lisp_Object host)
1413 struct sockaddr_in address;
1415 if (!get_internet_address (host, &address, ERROR_ME_NOT))
1418 if (address.sin_family == AF_INET)
1419 return build_string (inet_ntoa (address.sin_addr));
1421 /* #### any clue what to do here? */
1425 /* open a TCP network connection to a given HOST/SERVICE. Treated
1426 exactly like a normal process when reading and writing. Only
1427 differences are in status display and process deletion. A network
1428 connection has no PID; you cannot signal it. All you can do is
1429 deactivate and close it via delete-process */
1432 unix_open_network_stream (Lisp_Object name, Lisp_Object host, Lisp_Object service,
1433 Lisp_Object protocol, void** vinfd, void** voutfd)
1435 struct sockaddr_in address;
1440 volatile int retry = 0;
1443 CHECK_STRING (host);
1445 if (!EQ (protocol, Qtcp) && !EQ (protocol, Qudp))
1446 error ("Unsupported protocol \"%s\"",
1447 string_data (symbol_name (XSYMBOL (protocol))));
1450 port = htons ((unsigned short) XINT (service));
1453 struct servent *svc_info;
1454 CHECK_STRING (service);
1456 if (EQ (protocol, Qtcp))
1457 svc_info = getservbyname ((char *) XSTRING_DATA (service), "tcp");
1458 else /* EQ (protocol, Qudp) */
1459 svc_info = getservbyname ((char *) XSTRING_DATA (service), "udp");
1462 error ("Unknown service \"%s\"", XSTRING_DATA (service));
1463 port = svc_info->s_port;
1466 get_internet_address (host, &address, ERROR_ME);
1467 address.sin_port = port;
1469 if (EQ (protocol, Qtcp))
1470 s = socket (address.sin_family, SOCK_STREAM, 0);
1471 else /* EQ (protocol, Qudp) */
1472 s = socket (address.sin_family, SOCK_DGRAM, 0);
1475 report_file_error ("error creating socket", list1 (name));
1477 /* Turn off interrupts here -- see comments below. There used to
1478 be code which called bind_polling_period() to slow the polling
1479 period down rather than turn it off, but that seems rather
1480 bogus to me. Best thing here is to use a non-blocking connect
1481 or something, to check for QUIT. */
1483 /* Comments that are not quite valid: */
1485 /* Kernel bugs (on Ultrix at least) cause lossage (not just EINTR)
1486 when connect is interrupted. So let's not let it get interrupted.
1487 Note we do not turn off polling, because polling is only used
1488 when not interrupt_input, and thus not normally used on the systems
1489 which have this bug. On systems which use polling, there's no way
1490 to quit if polling is turned off. */
1492 /* Slow down polling. Some kernels have a bug which causes retrying
1493 connect to fail after a connect. */
1495 slow_down_interrupts ();
1499 /* A system call interrupted with a SIGALRM or SIGIO comes back
1500 here, with can_break_system_calls reset to 0. */
1501 SETJMP (break_system_call_jump);
1504 speed_up_interrupts ();
1506 /* In case something really weird happens ... */
1507 slow_down_interrupts ();
1510 /* Break out of connect with a signal (it isn't otherwise possible).
1511 Thus you don't get screwed with a hung network. */
1512 can_break_system_calls = 1;
1513 retval = connect (s, (struct sockaddr *) &address, sizeof (address));
1514 can_break_system_calls = 0;
1515 if (retval == -1 && errno != EISCONN)
1520 if (errno == EADDRINUSE && retry < 20)
1522 /* A delay here is needed on some FreeBSD systems,
1523 and it is harmless, since this retrying takes time anyway
1524 and should be infrequent.
1525 `sleep-for' allowed for quitting this loop with interrupts
1526 slowed down so it can't be used here. Async timers should
1527 already be disabled at this point so we can use `sleep'. */
1535 speed_up_interrupts ();
1538 report_file_error ("connection failed", list2 (host, name));
1541 speed_up_interrupts ();
1547 close (s); /* this used to be leaked; from Kyle Jones */
1548 report_file_error ("error duplicating socket", list1 (name));
1551 set_socket_nonblocking_maybe (inch, port, "tcp");
1553 *vinfd = (void*)inch;
1554 *voutfd = (void*)outch;
1558 #ifdef HAVE_MULTICAST
1560 /* Didier Verna <verna@inf.enst.fr> Nov. 28 1997.
1562 This function is similar to open-network-stream-internal, but provides a
1563 mean to open an UDP multicast connection instead of a TCP one. Like in the
1564 TCP case, the multicast connection will be seen as a sub-process,
1567 - Normally, we should use sendto and recvfrom with non connected
1568 sockets. The current code doesn't allow us to do this. In the future, it
1569 would be a good idea to extend the process data structure in order to deal
1570 properly with the different types network connections.
1571 - For the same reason, when leaving a multicast group, it is better to make
1572 a setsockopt - IP_DROP_MEMBERSHIP before closing the descriptors.
1573 Unfortunately, this can't be done here because delete_process doesn't know
1574 about the kind of connection we have. However, this is not such an
1579 unix_open_multicast_group (Lisp_Object name, Lisp_Object dest, Lisp_Object port,
1580 Lisp_Object ttl, void** vinfd, void** voutfd)
1583 struct sockaddr_in sa;
1584 struct protoent *udp;
1587 unsigned char thettl;
1588 int one = 1; /* For REUSEADDR */
1590 volatile int retry = 0;
1592 CHECK_STRING (dest);
1594 CHECK_NATNUM (port);
1595 theport = htons ((unsigned short) XINT (port));
1598 thettl = (unsigned char) XINT (ttl);
1600 if ((udp = getprotobyname ("udp")) == NULL)
1601 error ("No info available for UDP protocol");
1603 /* Init the sockets. Yes, I need 2 sockets. I couldn't duplicate one. */
1604 if ((rs = socket (PF_INET, SOCK_DGRAM, udp->p_proto)) < 0)
1605 report_file_error ("error creating socket", list1(name));
1606 if ((ws = socket (PF_INET, SOCK_DGRAM, udp->p_proto)) < 0)
1609 report_file_error ("error creating socket", list1(name));
1612 /* This will be used for both sockets */
1613 memset (&sa, 0, sizeof(sa));
1614 sa.sin_family = AF_INET;
1615 sa.sin_port = theport;
1616 sa.sin_addr.s_addr = htonl (inet_addr ((char *) XSTRING_DATA (dest)));
1618 /* Socket configuration for reading ------------------------ */
1620 /* Multiple connections from the same machine. This must be done before
1621 bind. If it fails, it shouldn't be fatal. The only consequence is that
1622 people won't be able to connect twice from the same machine. */
1623 if (setsockopt (rs, SOL_SOCKET, SO_REUSEADDR, (char *) &one, sizeof (one))
1625 warn_when_safe (Qmulticast, Qwarning, "Cannot reuse socket address");
1627 /* bind socket name */
1628 if (bind (rs, (struct sockaddr *)&sa, sizeof(sa)))
1632 report_file_error ("error binding socket", list2(name, port));
1635 /* join multicast group */
1636 imr.imr_multiaddr.s_addr = htonl (inet_addr ((char *) XSTRING_DATA (dest)));
1637 imr.imr_interface.s_addr = htonl (INADDR_ANY);
1638 if (setsockopt (rs, IPPROTO_IP, IP_ADD_MEMBERSHIP,
1639 (char *) &imr, sizeof (struct ip_mreq)) < 0)
1643 report_file_error ("error adding membership", list2(name, dest));
1646 /* Socket configuration for writing ----------------------- */
1648 /* Normally, there's no 'connect' in multicast, since we prefer to use
1649 'sendto' and 'recvfrom'. However, in order to handle this connection in
1650 the process-like way it is done for TCP, we must be able to use 'write'
1651 instead of 'sendto'. Consequently, we 'connect' this socket. */
1653 /* See open-network-stream-internal for comments on this part of the code */
1654 slow_down_interrupts ();
1658 /* A system call interrupted with a SIGALRM or SIGIO comes back
1659 here, with can_break_system_calls reset to 0. */
1660 SETJMP (break_system_call_jump);
1663 speed_up_interrupts ();
1665 /* In case something really weird happens ... */
1666 slow_down_interrupts ();
1669 /* Break out of connect with a signal (it isn't otherwise possible).
1670 Thus you don't get screwed with a hung network. */
1671 can_break_system_calls = 1;
1672 ret = connect (ws, (struct sockaddr *) &sa, sizeof (sa));
1673 can_break_system_calls = 0;
1674 if (ret == -1 && errno != EISCONN)
1680 if (errno == EADDRINUSE && retry < 20)
1682 /* A delay here is needed on some FreeBSD systems,
1683 and it is harmless, since this retrying takes time anyway
1684 and should be infrequent.
1685 `sleep-for' allowed for quitting this loop with interrupts
1686 slowed down so it can't be used here. Async timers should
1687 already be disabled at this point so we can use `sleep'. */
1695 speed_up_interrupts ();
1698 report_file_error ("error connecting socket", list2(name, port));
1701 speed_up_interrupts ();
1704 if (setsockopt (ws, IPPROTO_IP, IP_MULTICAST_TTL,
1705 (char *) &thettl, sizeof (thettl)) < 0)
1709 report_file_error ("error setting ttl", list2(name, ttl));
1712 set_socket_nonblocking_maybe (rs, theport, "udp");
1715 *voutfd = (void*)ws;
1718 #endif /* HAVE_MULTICAST */
1720 #endif /* HAVE_SOCKETS */
1723 /**********************************************************************/
1724 /* Initialization */
1725 /**********************************************************************/
1728 process_type_create_unix (void)
1730 PROCESS_HAS_METHOD (unix, alloc_process_data);
1731 PROCESS_HAS_METHOD (unix, mark_process_data);
1733 PROCESS_HAS_METHOD (unix, init_process);
1734 PROCESS_HAS_METHOD (unix, reap_exited_processes);
1736 PROCESS_HAS_METHOD (unix, init_process_io_handles);
1737 PROCESS_HAS_METHOD (unix, create_process);
1738 PROCESS_HAS_METHOD (unix, tooltalk_connection_p);
1739 PROCESS_HAS_METHOD (unix, set_window_size);
1741 PROCESS_HAS_METHOD (unix, update_status_if_terminated);
1743 PROCESS_HAS_METHOD (unix, send_process);
1744 PROCESS_HAS_METHOD (unix, process_send_eof);
1745 PROCESS_HAS_METHOD (unix, deactivate_process);
1746 PROCESS_HAS_METHOD (unix, kill_child_process);
1747 PROCESS_HAS_METHOD (unix, kill_process_by_pid);
1748 PROCESS_HAS_METHOD (unix, get_tty_name);
1750 PROCESS_HAS_METHOD (unix, canonicalize_host_name);
1751 PROCESS_HAS_METHOD (unix, open_network_stream);
1752 #ifdef HAVE_MULTICAST
1753 PROCESS_HAS_METHOD (unix, open_multicast_group);
1759 vars_of_process_unix (void)
1761 Fprovide (intern ("unix-processes"));
1764 #endif /* !defined (NO_SUBPROCESSES) */