1 /* Asynchronous subprocess implemenation 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 */
52 #include "file-coding.h"
59 #include "syssignal.h" /* Always include before systty.h */
65 * Implemenation-specific data. Pointed to by Lisp_Process->process_data
68 struct unix_process_data
70 /* Non-0 if this is really a ToolTalk channel. */
71 int connected_via_filedesc_p;
72 /* Descriptor by which we read from this process. -1 for dead process */
74 /* Descriptor for the tty which this process is using.
75 -1 if we didn't record it (on some systems, there's no need). */
77 /* Name of subprocess terminal. */
79 /* Non-false if communicating through a pty. */
83 #define UNIX_DATA(p) ((struct unix_process_data*)((p)->process_data))
86 /* The file name of the pty opened by allocate_pty. */
88 static char pty_name[24];
93 /**********************************************************************/
94 /* Static helper routines */
95 /**********************************************************************/
98 close_safely_handler (int signo)
100 EMACS_REESTABLISH_SIGNAL (signo, close_safely_handler);
105 close_safely (int fd)
108 signal (SIGALRM, close_safely_handler);
116 close_descriptor_pair (int in, int out)
120 if (out != in && out >= 0)
124 /* Close all descriptors currently in use for communication
125 with subprocess. This is used in a newly-forked subprocess
126 to get rid of irrelevant descriptors. */
129 close_process_descs_mapfun (CONST void* key, void* contents, void* arg)
132 CVOID_TO_LISP (proc, contents);
133 event_stream_delete_stream_pair (XPROCESS(proc)->pipe_instream,
134 XPROCESS(proc)->pipe_outstream);
138 /* #### This function is currently called from child_setup
139 in callproc.c. It should become static though - kkm */
141 close_process_descs (void)
143 maphash (close_process_descs_mapfun, usid_to_process, 0);
146 /* connect to an existing file descriptor. This is very similar to
147 open-network-stream except that it assumes that the connection has
148 already been initialized. It is currently used for ToolTalk
151 /* This function used to be visible on the Lisp level, but there is no
152 real point in doing that. Here is the doc string:
154 "Connect to an existing file descriptor.\n\
155 Returns a subprocess-object to represent the connection.\n\
156 Input and output work as for subprocesses; `delete-process' closes it.\n\
157 Args are NAME BUFFER INFD OUTFD.\n\
158 NAME is name for process. It is modified if necessary to make it unique.\n\
159 BUFFER is the buffer (or buffer-name) to associate with the process.\n\
160 Process output goes at end of that buffer, unless you specify\n\
161 an output stream or filter function to handle the output.\n\
162 BUFFER may be also nil, meaning that this process is not associated\n\
164 INFD and OUTFD specify the file descriptors to use for input and\n\
165 output, respectively."
169 connect_to_file_descriptor (Lisp_Object name, Lisp_Object buffer,
170 Lisp_Object infd, Lisp_Object outfd)
172 /* This function can GC */
181 if (get_process_from_usid (FD_TO_USID(inch)))
182 error ("There is already a process connected to fd %d", inch);
184 buffer = Fget_buffer_create (buffer);
185 proc = make_process_internal (name);
187 XPROCESS (proc)->pid = Fcons (infd, name);
188 XPROCESS (proc)->buffer = buffer;
189 init_process_io_handles (XPROCESS (proc), (void*)inch, (void*)XINT (outfd), 0);
190 UNIX_DATA (XPROCESS (proc))->connected_via_filedesc_p = 1;
192 event_stream_select_process (XPROCESS (proc));
199 /* Open an available pty, returning a file descriptor.
200 Return -1 on failure.
201 The file name of the terminal corresponding to the pty
202 is left in the variable pty_name. */
210 /* Some systems name their pseudoterminals so that there are gaps in
211 the usual sequence - for example, on HP9000/S700 systems, there
212 are no pseudoterminals with names ending in 'f'. So we wait for
213 three failures in a row before deciding that we've reached the
215 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_NDELAY | OPEN_BINARY, 0);
242 if (fstat (fd, &stb) < 0)
245 if (stat (pty_name, &stb) < 0)
248 if (failed_count >= 3)
254 fd = open (pty_name, O_RDWR | O_NONBLOCK | OPEN_BINARY, 0);
256 fd = open (pty_name, O_RDWR | O_NDELAY | OPEN_BINARY, 0);
258 #endif /* not IRIS */
259 #endif /* no PTY_OPEN */
263 /* check to make certain that both sides are available
264 this avoids a nasty yet stupid bug in rlogins */
265 #ifdef PTY_TTY_NAME_SPRINTF
268 sprintf (pty_name, "/dev/tty%c%x", c, i);
269 #endif /* no PTY_TTY_NAME_SPRINTF */
271 if (access (pty_name, 6) != 0)
274 #if !defined(IRIS) && !defined(__sgi)
280 #endif /* not UNIPLUS */
287 #endif /* HAVE_PTYS */
290 create_bidirectional_pipe (int *inchannel, int *outchannel,
291 volatile int *forkin, volatile int *forkout)
296 if (socketpair (AF_UNIX, SOCK_STREAM, 0, sv) < 0)
298 *outchannel = *inchannel = sv[0];
299 *forkout = *forkin = sv[1];
300 #else /* not SKTPAIR */
303 if (temp < 0) return -1;
307 if (temp < 0) return -1;
310 #endif /* not SKTPAIR */
318 get_internet_address (Lisp_Object host, struct sockaddr_in *address,
321 struct hostent *host_info_ptr = NULL;
331 if (count++ > 10) break;
332 #ifndef BROKEN_CYGWIN
336 /* Some systems can't handle SIGIO/SIGALARM in gethostbyname. */
337 slow_down_interrupts ();
338 host_info_ptr = gethostbyname ((char *) XSTRING_DATA (host));
339 speed_up_interrupts ();
341 if (! (host_info_ptr == 0 && h_errno == TRY_AGAIN))
344 Fsleep_for (make_int (1));
348 address->sin_family = host_info_ptr->h_addrtype;
349 memcpy (&address->sin_addr, host_info_ptr->h_addr, host_info_ptr->h_length);
353 IN_ADDR numeric_addr;
354 /* Attempt to interpret host as numeric inet address */
355 numeric_addr = inet_addr ((char *) XSTRING_DATA (host));
356 if (NUMERIC_ADDR_ERROR)
358 maybe_error (Qprocess, errb,
359 "Unknown host \"%s\"", XSTRING_DATA (host));
363 /* There was some broken code here that called strlen() here
364 on (char *) &numeric_addr and even sometimes accessed
365 uninitialized data. */
366 address->sin_family = AF_INET;
367 * (IN_ADDR *) &address->sin_addr = numeric_addr;
374 set_socket_nonblocking_maybe (int fd, int port, CONST char* proto)
376 #ifdef PROCESS_IO_BLOCKING
379 for (tail = network_stream_blocking_port_list; CONSP (tail); tail = XCDR (tail))
381 Lisp_Object tail_port = XCAR (tail);
383 if (STRINGP (tail_port))
385 struct servent *svc_info;
386 CHECK_STRING (tail_port);
387 svc_info = getservbyname ((char *) XSTRING_DATA (tail_port), proto);
388 if ((svc_info != 0) && (svc_info->s_port == port))
393 else if ((INTP (tail_port)) && (htons ((unsigned short) XINT (tail_port)) == port))
399 set_descriptor_non_blocking (fd);
402 set_descriptor_non_blocking (fd);
403 #endif /* PROCESS_IO_BLOCKING */
406 #endif /* HAVE_SOCKETS */
408 /* Compute the Lisp form of the process status from
409 the numeric status that was returned by `wait'. */
412 update_status_from_wait_code (struct Lisp_Process *p, int *w_fmh)
414 /* C compiler lossage when attempting to pass w directly */
419 p->status_symbol = Qstop;
420 p->exit_code = WSTOPSIG (w);
423 else if (WIFEXITED (w))
425 p->status_symbol = Qexit;
426 p->exit_code = WEXITSTATUS (w);
429 else if (WIFSIGNALED (w))
431 p->status_symbol = Qsignal;
432 p->exit_code = WTERMSIG (w);
433 p->core_dumped = WCOREDUMP (w);
437 p->status_symbol = Qrun;
444 #define MAX_EXITED_PROCESSES 1000
445 static volatile pid_t exited_processes[MAX_EXITED_PROCESSES];
446 static volatile int exited_processes_status[MAX_EXITED_PROCESSES];
447 static volatile int exited_processes_index;
449 static volatile int sigchld_happened;
451 /* On receipt of a signal that a child status has changed,
452 loop asking about children with changed statuses until
453 the system says there are no more. All we do is record
454 the processes and wait status.
456 This function could be called from within the SIGCHLD
457 handler, so it must be completely reentrant. When
458 not called from a SIGCHLD handler, BLOCK_SIGCHLD should
459 be non-zero so that SIGCHLD is blocked while this
460 function is running. (This is necessary so avoid
461 race conditions with the SIGCHLD_HAPPENED flag). */
464 record_exited_processes (int block_sigchld)
466 if (!sigchld_happened)
471 #ifdef EMACS_BLOCK_SIGNAL
473 EMACS_BLOCK_SIGNAL (SIGCHLD);
476 while (sigchld_happened)
481 /* Keep trying to get a status until we get a definitive result. */
488 # endif /* not WUNTRACED */
490 pid = waitpid ((pid_t) -1, &w, WNOHANG | WUNTRACED);
492 pid = wait3 (&w, WNOHANG | WUNTRACED, 0);
494 #else /* not WNOHANG */
496 #endif /* not WNOHANG */
498 while (pid <= 0 && errno == EINTR);
503 if (exited_processes_index < MAX_EXITED_PROCESSES)
505 exited_processes[exited_processes_index] = pid;
506 exited_processes_status[exited_processes_index] = w;
507 exited_processes_index++;
510 /* On systems with WNOHANG, we just ignore the number
511 of times that SIGCHLD was signalled, and keep looping
512 until there are no more processes to wait on. If we
513 don't have WNOHANG, we have to rely on the count in
517 #endif /* not WNOHANG */
520 sigchld_happened = 0;
523 EMACS_UNBLOCK_SIGNAL (SIGCHLD);
526 /* For any processes that have changed status and are recorded
527 and such, update the corresponding struct Lisp_Process.
528 We separate this from record_exited_processes() so that
529 we never have to call this function from within a signal
530 handler. We block SIGCHLD in case record_exited_processes()
531 is called from a signal handler. */
533 /** USG WARNING: Although it is not obvious from the documentation
534 in signal(2), on a USG system the SIGCLD handler MUST NOT call
535 signal() before executing at least one wait(), otherwise the handler
536 will be called again, resulting in an infinite loop. The relevant
537 portion of the documentation reads "SIGCLD signals will be queued
538 and the signal-catching function will be continually reentered until
539 the queue is empty". Invoking signal() causes the kernel to reexamine
540 the SIGCLD queue. Fred Fish, UniSoft Systems Inc.
542 (Note that now this only applies in SYS V Release 2 and before.
543 On SYS V Release 3, we use sigset() to set the signal handler for
544 the first time, and so we don't have to reestablish the signal handler
545 in the handler below. On SYS V Release 4, we don't get this weirdo
546 behavior when we use sigaction(), which we do use.) */
549 sigchld_handler (int signo)
551 #ifdef OBNOXIOUS_SYSV_SIGCLD_BEHAVIOR
552 int old_errno = errno;
555 record_exited_processes (0);
560 #ifdef HAVE_UNIXOID_EVENT_LOOP
561 signal_fake_event ();
563 /* WARNING - must come after wait3() for USG systems */
564 EMACS_REESTABLISH_SIGNAL (signo, sigchld_handler);
570 #ifdef SIGNALS_VIA_CHARACTERS
571 /* Get signal character to send to process if SIGNALS_VIA_CHARACTERS */
574 process_signal_char (int tty_fd, int signo)
576 /* If it's not a tty, pray that these default values work */
577 if (!isatty(tty_fd)) {
578 #define CNTL(ch) (037 & (ch))
581 case SIGINT: return CNTL('C');
582 case SIGQUIT: return CNTL('\\');
584 case SIGTSTP: return CNTL('Z');
590 /* TERMIOS is the latest and bestest, and seems most likely to work.
591 If the system has it, use it. */
594 tcgetattr (tty_fd, &t);
597 case SIGINT: return t.c_cc[VINTR];
598 case SIGQUIT: return t.c_cc[VQUIT];
599 #if defined(SIGTSTP) && defined(VSUSP)
600 case SIGTSTP: return t.c_cc[VSUSP];
605 # elif defined (TIOCGLTC) && defined (TIOCGETC) /* not HAVE_TERMIOS */
607 /* On Berkeley descendants, the following IOCTL's retrieve the
608 current control characters. */
613 case SIGINT: ioctl (tty_fd, TIOCGETC, &c); return c.t_intrc;
614 case SIGQUIT: ioctl (tty_fd, TIOCGETC, &c); return c.t_quitc;
616 case SIGTSTP: ioctl (tty_fd, TIOCGLTC, &lc); return lc.t_suspc;
617 # endif /* SIGTSTP */
621 # elif defined (TCGETA) /* ! defined (TIOCGLTC) && defined (TIOCGETC) */
623 /* On SYSV descendants, the TCGETA ioctl retrieves the current
624 control characters. */
626 ioctl (tty_fd, TCGETA, &t);
628 case SIGINT: return t.c_cc[VINTR];
629 case SIGQUIT: return t.c_cc[VQUIT];
631 case SIGTSTP: return t.c_cc[VSWTCH];
632 # endif /* SIGTSTP */
635 # else /* ! defined (TCGETA) */
636 #error ERROR! Using SIGNALS_VIA_CHARACTERS, but not HAVE_TERMIOS || (TIOCGLTC && TIOCGETC) || TCGETA
637 /* If your system configuration files define SIGNALS_VIA_CHARACTERS,
638 you'd better be using one of the alternatives above! */
639 # endif /* ! defined (TCGETA) */
642 #endif /* SIGNALS_VIA_CHARACTERS */
647 /**********************************************************************/
648 /* Process implementation methods */
649 /**********************************************************************/
652 * Allocate and initialize Lisp_Process->process_data
656 unix_alloc_process_data (struct Lisp_Process *p)
658 p->process_data = xnew (struct unix_process_data);
660 UNIX_DATA(p)->connected_via_filedesc_p = 0;
661 UNIX_DATA(p)->infd = -1;
662 UNIX_DATA(p)->subtty = -1;
663 UNIX_DATA(p)->tty_name = Qnil;
664 UNIX_DATA(p)->pty_flag = 0;
668 * Mark any Lisp objects in Lisp_Process->process_data
672 unix_mark_process_data (struct Lisp_Process *proc,
673 void (*markobj) (Lisp_Object))
675 ((markobj) (UNIX_DATA(proc)->tty_name));
679 * Initialize XEmacs process implemenation once
684 unix_init_process (void)
687 if (! noninteractive || initialized)
689 signal (SIGCHLD, sigchld_handler);
694 * Initialize any process local data. This is called when newly
695 * created process is connected to real OS file handles. The
696 * handles are generally represented by void* type, but are
697 * of type int (file descriptors) for UNIX
701 unix_init_process_io_handles (struct Lisp_Process *p, void* in, void* out, int flags)
703 UNIX_DATA(p)->infd = (int)in;
707 * Fork off a subprocess. P is a pointer to newly created subprocess
708 * object. If this function signals, the caller is responsible for
709 * deleting (and finalizing) the process object.
711 * The method must return PID of the new proces, a (positive??? ####) number
712 * which fits into Lisp_Int. No return value indicates an error, the method
713 * must signal an error instead.
717 unix_create_process (struct Lisp_Process *p,
718 Lisp_Object *argv, int nargv,
719 Lisp_Object program, Lisp_Object cur_dir)
721 /* This function rewritten by ben@xemacs.org. */
723 int pid, inchannel, outchannel;
724 /* Use volatile to protect variables from being clobbered by longjmp. */
725 volatile int forkin, forkout;
726 volatile int pty_flag = 0;
734 inchannel = outchannel = forkin = forkout = -1;
736 /* Nothing below here GCs so our string pointers shouldn't move. */
737 new_argv = alloca_array (char *, nargv + 2);
738 new_argv[0] = (char *) XSTRING_DATA (program);
739 for (i = 0; i < nargv; i++)
741 Lisp_Object tem = argv[i];
743 new_argv[i + 1] = (char *) XSTRING_DATA (tem);
746 current_dir = (char *) XSTRING_DATA (cur_dir);
749 if (!NILP (Vprocess_connection_type))
751 /* find a new pty, open the master side, return the opened
752 file handle, and store the name of the corresponding slave
753 side in global variable pty_name. */
754 outchannel = inchannel = allocate_pty ();
759 /* You're "supposed" to now open the slave in the child.
760 On some systems, we can open it here; this allows for
761 better error checking. */
763 /* On USG systems it does not work to open the pty's tty here
764 and then close and reopen it in the child. */
766 /* Don't let this terminal become our controlling terminal
767 (in case we don't have one). */
768 forkout = forkin = open (pty_name, O_RDWR | O_NOCTTY | OPEN_BINARY, 0);
770 forkout = forkin = open (pty_name, O_RDWR | OPEN_BINARY, 0);
775 UNIX_DATA(p)->pty_flag = pty_flag = 1;
778 #endif /* HAVE_PTYS */
779 if (create_bidirectional_pipe (&inchannel, &outchannel,
780 &forkin, &forkout) < 0)
784 /* Replaced by close_process_descs */
785 set_exclusive_use (inchannel);
786 set_exclusive_use (outchannel);
789 set_descriptor_non_blocking (inchannel);
791 /* Record this as an active process, with its channels.
792 As a result, child_setup will close Emacs's side of the pipes. */
793 init_process_io_handles (p, (void*)inchannel, (void*)outchannel,
794 pty_flag ? STREAM_PTY_FLUSHING : 0);
795 /* Record the tty descriptor used in the subprocess. */
796 UNIX_DATA(p)->subtty = forkin;
799 #if !defined(__CYGWIN32__)
800 /* child_setup must clobber environ on systems with true vfork.
801 Protect it from permanent change. */
802 char **save_environ = environ;
806 /* when performance monitoring is on, turn it off before the vfork(),
807 as the child has no handler for the signal -- when back in the
808 parent process, turn it back on if it was really on when you "turned
810 int logging_on = cadillac_stop_logging (); /* #### rename me */
816 /**** Now we're in the child process ****/
817 int xforkin = forkin;
818 int xforkout = forkout;
821 EMACS_SEPARATE_PROCESS_GROUP ();
825 /* Disconnect the current controlling terminal, pursuant to
826 making the pty be the controlling terminal of the process.
827 Also put us in our own process group. */
829 disconnect_controlling_terminal ();
831 /* Open the pty connection and make the pty's terminal
832 our controlling terminal.
834 On systems with TIOCSCTTY, we just use it to set
835 the controlling terminal. On other systems, the
836 first TTY we open becomes the controlling terminal.
837 So, we end up with four possibilities:
839 (1) on USG and TIOCSCTTY systems, we open the pty
841 (2) on other USG systems, we just open the pty.
842 (3) on non-USG systems with TIOCSCTTY, we
843 just use TIOCSCTTY. (On non-USG systems, we
844 already opened the pty in the parent process.)
845 (4) on non-USG systems without TIOCSCTTY, we
846 close the pty and reopen it.
848 This would be cleaner if we didn't open the pty
849 in the parent process, but doing it that way
850 makes it possible to trap error conditions.
851 It's harder to convey an error from the child
852 process, and I don't feel like messing with
855 /* There was some weirdo, probably wrong,
856 conditionalization on RTU and UNIPLUS here.
857 I deleted it. So sue me. */
859 /* SunOS has TIOCSCTTY but the close/open method
862 # if defined (USG) || !defined (TIOCSCTTY)
863 /* Now close the pty (if we had it open) and reopen it.
864 This makes the pty the controlling terminal of the
866 /* I wonder if close (open (pty_name, ...)) would work? */
869 xforkout = xforkin = open (pty_name, O_RDWR | OPEN_BINARY, 0);
872 write (1, "Couldn't open the pty terminal ", 31);
873 write (1, pty_name, strlen (pty_name));
877 # endif /* USG or not TIOCSCTTY */
879 /* Miscellaneous setup required for some systems.
880 Must be done before using tc* functions on xforkin.
881 This guarantees that isatty(xforkin) is true. */
883 # ifdef SETUP_SLAVE_PTY
885 # endif /* SETUP_SLAVE_PTY */
888 /* We ignore the return value
889 because faith@cs.unc.edu says that is necessary on Linux. */
890 assert (isatty (xforkin));
891 ioctl (xforkin, TIOCSCTTY, 0);
892 # endif /* TIOCSCTTY */
894 /* Change the line discipline. */
896 # if defined (HAVE_TERMIOS) && defined (LDISC1)
899 assert (isatty (xforkin));
900 tcgetattr (xforkin, &t);
902 if (tcsetattr (xforkin, TCSANOW, &t) < 0)
903 perror ("create_process/tcsetattr LDISC1 failed\n");
905 # elif defined (NTTYDISC) && defined (TIOCSETD)
907 /* Use new line discipline. TIOCSETD is accepted and
908 ignored on Sys5.4 systems with ttcompat. */
909 int ldisc = NTTYDISC;
910 assert (isatty (xforkin));
911 ioctl (xforkin, TIOCSETD, &ldisc);
913 # endif /* TIOCSETD & NTTYDISC */
915 /* Make our process group be the foreground group
916 of our new controlling terminal. */
919 int piddly = EMACS_GET_PROCESS_GROUP ();
920 EMACS_SET_TTY_PROCESS_GROUP (xforkin, &piddly);
923 /* On AIX, we've disabled SIGHUP above once we start a
924 child on a pty. Now reenable it in the child, so it
925 will die when we want it to.
926 JV: This needs to be done ALWAYS as we might have inherited
927 a SIG_IGN handling from our parent (nohup) and we are in new
930 signal (SIGHUP, SIG_DFL);
932 #endif /* HAVE_PTYS */
934 signal (SIGINT, SIG_DFL);
935 signal (SIGQUIT, SIG_DFL);
939 /* Set up the terminal characteristics of the pty. */
940 child_setup_tty (xforkout);
943 child_setup (xforkin, xforkout, xforkout, new_argv, current_dir);
947 cadillac_start_logging (); /* #### rename me */
950 #if !defined(__CYGWIN32__)
951 environ = save_environ;
957 close_descriptor_pair (forkin, forkout);
958 report_file_error ("Doing fork", Qnil);
961 /* #### dmoore - why is this commented out, otherwise we leave
962 subtty = forkin, but then we close forkin just below. */
963 /* UNIX_DATA(p)->subtty = -1; */
965 /* If the subfork execv fails, and it exits,
966 this close hangs. I don't know why.
967 So have an interrupt jar it loose. */
969 close_safely (forkin);
970 if (forkin != forkout && forkout >= 0)
975 UNIX_DATA (p)->tty_name = build_string (pty_name);
978 UNIX_DATA (p)->tty_name = Qnil;
980 /* Notice that SIGCHLD was not blocked. (This is not possible on
981 some systems.) No biggie if SIGCHLD occurs right around the
982 time that this call happens, because SIGCHLD() does not actually
983 deselect the process (that doesn't occur until the next time
984 we're waiting for an event, when status_notify() is called). */
990 close_descriptor_pair (forkin, forkout);
991 close_descriptor_pair (inchannel, outchannel);
993 report_file_error ("Opening pty or pipe", Qnil);
996 RETURN_NOT_REACHED (0);
1000 * Return nonzero if this process is a ToolTalk connection.
1004 unix_tooltalk_connection_p (struct Lisp_Process *p)
1006 return UNIX_DATA(p)->connected_via_filedesc_p;
1010 * This is called to set process' virtual terminal size
1014 unix_set_window_size (struct Lisp_Process* p, int cols, int rows)
1016 return set_window_size (UNIX_DATA(p)->infd, cols, rows);
1020 * This method is called to update status fields of the process
1021 * structure. If the process has not existed, this method is
1022 * expected to do nothing.
1024 * The method is called only for real child processes.
1029 unix_update_status_if_terminated (struct Lisp_Process* p)
1033 EMACS_BLOCK_SIGNAL (SIGCHLD);
1035 if (waitpid (XINT (p->pid), &w, WNOHANG) == XINT (p->pid))
1038 update_status_from_wait_code (p, &w);
1041 EMACS_UNBLOCK_SIGNAL (SIGCHLD);
1047 * Update status of all exited processes. Called when SIGCLD has signaled.
1052 unix_reap_exited_processes (void)
1055 struct Lisp_Process *p;
1057 #ifndef OBNOXIOUS_SYSV_SIGCLD_BEHAVIOR
1058 record_exited_processes (1);
1061 if (exited_processes_index <= 0)
1066 #ifdef EMACS_BLOCK_SIGNAL
1067 EMACS_BLOCK_SIGNAL (SIGCHLD);
1069 for (i = 0; i < exited_processes_index; i++)
1071 int pid = exited_processes[i];
1072 int w = exited_processes_status[i];
1074 /* Find the process that signaled us, and record its status. */
1079 LIST_LOOP (tail, Vprocess_list)
1081 Lisp_Object proc = XCAR (tail);
1082 p = XPROCESS (proc);
1083 if (INTP (p->pid) && XINT (p->pid) == pid)
1091 /* Change the status of the process that was found. */
1094 update_status_from_wait_code (p, &w);
1096 /* If process has terminated, stop waiting for its output. */
1097 if (WIFSIGNALED (w) || WIFEXITED (w))
1099 if (!NILP(p->pipe_instream))
1101 /* We can't just call event_stream->unselect_process_cb (p)
1102 here, because that calls XtRemoveInput, which is not
1103 necessarily reentrant, so we can't call this at interrupt
1111 /* There was no asynchronous process found for that id. Check
1112 if we have a synchronous process. Only set sync process status
1113 if there is one, so we work OK with the waitpid() call in
1114 wait_for_termination(). */
1115 if (synch_process_alive != 0)
1116 { /* Set the global sync process status variables. */
1117 synch_process_alive = 0;
1119 /* Report the status of the synchronous process. */
1121 synch_process_retcode = WEXITSTATUS (w);
1122 else if (WIFSIGNALED (w))
1123 synch_process_death = signal_name (WTERMSIG (w));
1128 exited_processes_index = 0;
1130 EMACS_UNBLOCK_SIGNAL (SIGCHLD);
1132 #endif /* SIGCHLD */
1135 * Stuff the entire contents of LSTREAM to the process ouptut pipe
1138 static JMP_BUF send_process_frame;
1141 send_process_trap (int signum)
1143 EMACS_REESTABLISH_SIGNAL (signum, send_process_trap);
1144 EMACS_UNBLOCK_SIGNAL (signum);
1145 LONGJMP (send_process_frame, 1);
1149 unix_send_process (Lisp_Object proc, struct lstream* lstream)
1151 /* Use volatile to protect variables from being clobbered by longjmp. */
1152 SIGTYPE (*volatile old_sigpipe) (int) = 0;
1153 volatile Lisp_Object vol_proc = proc;
1154 struct Lisp_Process *volatile p = XPROCESS (proc);
1156 if (!SETJMP (send_process_frame))
1158 /* use a reasonable-sized buffer (somewhere around the size of the
1159 stream buffer) so as to avoid inundating the stream with blocked
1161 Bufbyte chunkbuf[512];
1168 chunklen = Lstream_read (lstream, chunkbuf, 512);
1170 break; /* perhaps should abort() if < 0?
1171 This should never happen. */
1173 (SIGTYPE (*) (int)) signal (SIGPIPE, send_process_trap);
1174 /* Lstream_write() will never successfully write less than
1175 the amount sent in. In the worst case, it just buffers
1176 the unwritten data. */
1177 writeret = Lstream_write (XLSTREAM (DATA_OUTSTREAM(p)), chunkbuf,
1179 signal (SIGPIPE, old_sigpipe);
1181 /* This is a real error. Blocking errors are handled
1182 specially inside of the filedesc stream. */
1183 report_file_error ("writing to process",
1185 while (Lstream_was_blocked_p (XLSTREAM (p->pipe_outstream)))
1187 /* Buffer is full. Wait, accepting input;
1188 that may allow the program
1189 to finish doing output and read more. */
1190 Faccept_process_output (Qnil, make_int (1), Qnil);
1192 (SIGTYPE (*) (int)) signal (SIGPIPE, send_process_trap);
1193 Lstream_flush (XLSTREAM (p->pipe_outstream));
1194 signal (SIGPIPE, old_sigpipe);
1199 { /* We got here from a longjmp() from the SIGPIPE handler */
1200 signal (SIGPIPE, old_sigpipe);
1201 p->status_symbol = Qexit;
1202 p->exit_code = 256; /* #### SIGPIPE ??? */
1206 deactivate_process (vol_proc);
1207 error ("SIGPIPE raised on process %s; closed it",
1208 XSTRING_DATA (p->name));
1211 old_sigpipe = (SIGTYPE (*) (int)) signal (SIGPIPE, send_process_trap);
1212 Lstream_flush (XLSTREAM (DATA_OUTSTREAM(p)));
1213 signal (SIGPIPE, old_sigpipe);
1217 * Send EOF to the process. The default implementation simply
1218 * closes the output stream. The method must return 0 to call
1219 * the default implementation, or 1 if it has taken all care about
1220 * sending EOF to the process.
1224 unix_process_send_eof (Lisp_Object proc)
1226 if (!UNIX_DATA (XPROCESS (proc))->pty_flag)
1229 /* #### get_eof_char simply doesn't return the correct character
1230 here. Maybe it is needed to determine the right eof
1231 character in init_process_io_handles but here it simply screws
1234 Bufbyte eof_char = get_eof_char (XPROCESS (proc));
1235 send_process (proc, Qnil, &eof_char, 0, 1);
1237 send_process (proc, Qnil, (CONST Bufbyte *) "\004", 0, 1);
1243 * Called before the process is deactivated. The process object
1244 * is not immediately finalized, just undergoes a transition to
1247 * The return value is a unique stream ID, as returned by
1248 * event_stream_delete_stream_pair
1250 * In the lack of this method, only event_stream_delete_stream_pair
1251 * is called on both I/O streams of the process.
1253 * The UNIX version quards this by ignoring possible SIGPIPE.
1257 unix_deactivate_process (struct Lisp_Process *p)
1259 SIGTYPE (*old_sigpipe) (int) = 0;
1262 if (UNIX_DATA(p)->infd >= 0)
1263 flush_pending_output (UNIX_DATA(p)->infd);
1265 /* closing the outstream could result in SIGPIPE, so ignore it. */
1266 old_sigpipe = (SIGTYPE (*) (int)) signal (SIGPIPE, SIG_IGN);
1267 usid = event_stream_delete_stream_pair (p->pipe_instream, p->pipe_outstream);
1268 signal (SIGPIPE, old_sigpipe);
1270 UNIX_DATA(p)->infd = -1;
1275 /* send a signal number SIGNO to PROCESS.
1276 CURRENT_GROUP means send to the process group that currently owns
1277 the terminal being used to communicate with PROCESS.
1278 This is used for various commands in shell mode.
1279 If NOMSG is zero, insert signal-announcements into process's buffers
1282 If we can, we try to signal PROCESS by sending control characters
1283 down the pty. This allows us to signal inferiors who have changed
1284 their uid, for which killpg would return an EPERM error.
1286 The method signals an error if the given SIGNO is not valid
1290 unix_kill_child_process (Lisp_Object proc, int signo,
1291 int current_group, int nomsg)
1296 struct Lisp_Process *p = XPROCESS (proc);
1298 if (!UNIX_DATA(p)->pty_flag)
1301 /* If we are using pgrps, get a pgrp number and make it negative. */
1304 #ifdef SIGNALS_VIA_CHARACTERS
1305 /* If possible, send signals to the entire pgrp
1306 by sending an input character to it. */
1308 char sigchar = process_signal_char(UNIX_DATA(p)->subtty, signo);
1310 send_process (proc, Qnil, (Bufbyte *) &sigchar, 0, 1);
1314 #endif /* ! defined (SIGNALS_VIA_CHARACTERS) */
1317 /* Get the pgrp using the tty itself, if we have that.
1318 Otherwise, use the pty to get the pgrp.
1319 On pfa systems, saka@pfu.fujitsu.co.JP writes:
1320 "TIOCGPGRP symbol defined in sys/ioctl.h at E50.
1321 But, TIOCGPGRP does not work on E50 ;-P works fine on E60"
1322 His patch indicates that if TIOCGPGRP returns an error, then
1323 we should just assume that p->pid is also the process group id. */
1327 err = ioctl ( (UNIX_DATA(p)->subtty != -1
1328 ? UNIX_DATA(p)->subtty
1329 : UNIX_DATA(p)->infd), TIOCGPGRP, &gid);
1333 gid = - XINT (p->pid);
1334 #endif /* ! defined (pfa) */
1340 #else /* ! defined (TIOCGPGRP ) */
1341 /* Can't select pgrps on this system, so we know that
1342 the child itself heads the pgrp. */
1343 gid = - XINT (p->pid);
1344 #endif /* ! defined (TIOCGPGRP ) */
1347 gid = - XINT (p->pid);
1353 p->status_symbol = Qrun;
1360 #endif /* ! defined (SIGCONT) */
1364 flush_pending_output (UNIX_DATA(p)->infd);
1368 /* If we don't have process groups, send the signal to the immediate
1369 subprocess. That isn't really right, but it's better than any
1370 obvious alternative. */
1373 kill_retval = kill (XINT (p->pid), signo) ? errno : 0;
1377 /* gid may be a pid, or minus a pgrp's number */
1378 #if defined (TIOCSIGNAL) || defined (TIOCSIGSEND)
1382 kill_retval = ioctl (UNIX_DATA(p)->infd, TIOCSIGNAL, signo);
1383 #else /* ! defined (TIOCSIGNAL) */
1384 kill_retval = ioctl (UNIX_DATA(p)->infd, TIOCSIGSEND, signo);
1385 #endif /* ! defined (TIOCSIGNAL) */
1388 kill_retval = kill (- XINT (p->pid), signo) ? errno : 0;
1389 #else /* ! (defined (TIOCSIGNAL) || defined (TIOCSIGSEND)) */
1390 kill_retval = EMACS_KILLPG (-gid, signo) ? errno : 0;
1391 #endif /* ! (defined (TIOCSIGNAL) || defined (TIOCSIGSEND)) */
1394 if (kill_retval < 0 && errno == EINVAL)
1395 error ("Signal number %d is invalid for this system", signo);
1399 * Kill any process in the system given its PID.
1401 * Returns zero if a signal successfully sent, or
1402 * negative number upon failure
1406 unix_kill_process_by_pid (int pid, int sigcode)
1408 return kill (pid, sigcode);
1412 * Return TTY name used to communicate with subprocess
1416 unix_get_tty_name (struct Lisp_Process *p)
1418 return UNIX_DATA (p)->tty_name;
1422 * Canonicalize host name HOST, and return its canonical form
1424 * The default implemenation just takes HOST for a canonical name.
1429 unix_canonicalize_host_name (Lisp_Object host)
1431 struct sockaddr_in address;
1433 if (!get_internet_address (host, &address, ERROR_ME_NOT))
1436 if (address.sin_family == AF_INET)
1437 return build_string (inet_ntoa (address.sin_addr));
1439 /* #### any clue what to do here? */
1443 /* open a TCP network connection to a given HOST/SERVICE. Treated
1444 exactly like a normal process when reading and writing. Only
1445 differences are in status display and process deletion. A network
1446 connection has no PID; you cannot signal it. All you can do is
1447 deactivate and close it via delete-process */
1450 unix_open_network_stream (Lisp_Object name, Lisp_Object host, Lisp_Object service,
1451 Lisp_Object family, void** vinfd, void** voutfd)
1453 struct sockaddr_in address;
1456 volatile int retry = 0;
1459 CHECK_STRING (host);
1461 if (!EQ (family, Qtcpip))
1462 error ("Unsupported protocol family \"%s\"",
1463 string_data (symbol_name (XSYMBOL (family))));
1466 port = htons ((unsigned short) XINT (service));
1469 struct servent *svc_info;
1470 CHECK_STRING (service);
1471 svc_info = getservbyname ((char *) XSTRING_DATA (service), "tcp");
1473 error ("Unknown service \"%s\"", XSTRING_DATA (service));
1474 port = svc_info->s_port;
1477 get_internet_address (host, &address, ERROR_ME);
1478 address.sin_port = port;
1480 s = socket (address.sin_family, SOCK_STREAM, 0);
1482 report_file_error ("error creating socket", list1 (name));
1484 /* Turn off interrupts here -- see comments below. There used to
1485 be code which called bind_polling_period() to slow the polling
1486 period down rather than turn it off, but that seems rather
1487 bogus to me. Best thing here is to use a non-blocking connect
1488 or something, to check for QUIT. */
1490 /* Comments that are not quite valid: */
1492 /* Kernel bugs (on Ultrix at least) cause lossage (not just EINTR)
1493 when connect is interrupted. So let's not let it get interrupted.
1494 Note we do not turn off polling, because polling is only used
1495 when not interrupt_input, and thus not normally used on the systems
1496 which have this bug. On systems which use polling, there's no way
1497 to quit if polling is turned off. */
1499 /* Slow down polling. Some kernels have a bug which causes retrying
1500 connect to fail after a connect. */
1502 slow_down_interrupts ();
1506 /* A system call interrupted with a SIGALRM or SIGIO comes back
1507 here, with can_break_system_calls reset to 0. */
1508 SETJMP (break_system_call_jump);
1511 speed_up_interrupts ();
1513 /* In case something really weird happens ... */
1514 slow_down_interrupts ();
1517 /* Break out of connect with a signal (it isn't otherwise possible).
1518 Thus you don't get screwed with a hung network. */
1519 can_break_system_calls = 1;
1520 retval = connect (s, (struct sockaddr *) &address, sizeof (address));
1521 can_break_system_calls = 0;
1522 if (retval == -1 && errno != EISCONN)
1527 if (errno == EADDRINUSE && retry < 20)
1529 /* A delay here is needed on some FreeBSD systems,
1530 and it is harmless, since this retrying takes time anyway
1531 and should be infrequent.
1532 `sleep-for' allowed for quitting this loop with interrupts
1533 slowed down so it can't be used here. Async timers should
1534 already be disabled at this point so we can use `sleep'. */
1542 speed_up_interrupts ();
1545 report_file_error ("connection failed", list2 (host, name));
1548 speed_up_interrupts ();
1554 close (s); /* this used to be leaked; from Kyle Jones */
1555 report_file_error ("error duplicating socket", list1 (name));
1558 set_socket_nonblocking_maybe (inch, port, "tcp");
1560 *vinfd = (void*)inch;
1561 *voutfd = (void*)outch;
1565 #ifdef HAVE_MULTICAST
1567 /* Didier Verna <verna@inf.enst.fr> Nov. 28 1997.
1569 This function is similar to open-network-stream-internal, but provides a
1570 mean to open an UDP multicast connection instead of a TCP one. Like in the
1571 TCP case, the multicast connection will be seen as a sub-process,
1574 - Normaly, we should use sendto and recvfrom with non connected
1575 sockets. The current code doesn't allow us to do this. In the future, it
1576 would be a good idea to extend the process data structure in order to deal
1577 properly with the different types network connections.
1578 - For the same reason, when leaving a multicast group, it is better to make
1579 a setsockopt - IP_DROP_MEMBERSHIP before closing the descriptors.
1580 Unfortunately, this can't be done here because delete_process doesn't know
1581 about the kind of connection we have. However, this is not such an
1586 unix_open_multicast_group (Lisp_Object name, Lisp_Object dest, Lisp_Object port,
1587 Lisp_Object ttl, void** vinfd, void** voutfd)
1590 struct sockaddr_in sa;
1591 struct protoent *udp;
1594 unsigned char thettl;
1595 int one = 1; /* For REUSEADDR */
1597 volatile int retry = 0;
1599 CHECK_STRING (dest);
1601 CHECK_NATNUM (port);
1602 theport = htons ((unsigned short) XINT (port));
1605 thettl = (unsigned char) XINT (ttl);
1607 if ((udp = getprotobyname ("udp")) == NULL)
1608 error ("No info available for UDP protocol");
1610 /* Init the sockets. Yes, I need 2 sockets. I couldn't duplicate one. */
1611 if ((rs = socket (PF_INET, SOCK_DGRAM, udp->p_proto)) < 0)
1612 report_file_error ("error creating socket", list1(name));
1613 if ((ws = socket (PF_INET, SOCK_DGRAM, udp->p_proto)) < 0)
1616 report_file_error ("error creating socket", list1(name));
1619 /* This will be used for both sockets */
1620 memset (&sa, 0, sizeof(sa));
1621 sa.sin_family = AF_INET;
1622 sa.sin_port = theport;
1623 sa.sin_addr.s_addr = htonl (inet_addr ((char *) XSTRING_DATA (dest)));
1625 /* Socket configuration for reading ------------------------ */
1627 /* Multiple connections from the same machine. This must be done before
1628 bind. If it fails, it shouldn't be fatal. The only consequence is that
1629 people won't be able to connect twice from the same machine. */
1630 if (setsockopt (rs, SOL_SOCKET, SO_REUSEADDR, (char *) &one, sizeof (one))
1632 warn_when_safe (Qmulticast, Qwarning, "Cannot reuse socket address");
1634 /* bind socket name */
1635 if (bind (rs, (struct sockaddr *)&sa, sizeof(sa)))
1639 report_file_error ("error binding socket", list2(name, port));
1642 /* join multicast group */
1643 imr.imr_multiaddr.s_addr = htonl (inet_addr ((char *) XSTRING_DATA (dest)));
1644 imr.imr_interface.s_addr = htonl (INADDR_ANY);
1645 if (setsockopt (rs, IPPROTO_IP, IP_ADD_MEMBERSHIP,
1646 (char *) &imr, sizeof (struct ip_mreq)) < 0)
1650 report_file_error ("error adding membership", list2(name, dest));
1653 /* Socket configuration for writing ----------------------- */
1655 /* Normaly, there's no 'connect' in multicast, since we use preferentialy
1656 'sendto' and 'recvfrom'. However, in order to handle this connection in
1657 the process-like way it is done for TCP, we must be able to use 'write'
1658 instead of 'sendto'. Consequently, we 'connect' this socket. */
1660 /* See open-network-stream-internal for comments on this part of the code */
1661 slow_down_interrupts ();
1665 /* A system call interrupted with a SIGALRM or SIGIO comes back
1666 here, with can_break_system_calls reset to 0. */
1667 SETJMP (break_system_call_jump);
1670 speed_up_interrupts ();
1672 /* In case something really weird happens ... */
1673 slow_down_interrupts ();
1676 /* Break out of connect with a signal (it isn't otherwise possible).
1677 Thus you don't get screwed with a hung network. */
1678 can_break_system_calls = 1;
1679 ret = connect (ws, (struct sockaddr *) &sa, sizeof (sa));
1680 can_break_system_calls = 0;
1681 if (ret == -1 && errno != EISCONN)
1687 if (errno == EADDRINUSE && retry < 20)
1689 /* A delay here is needed on some FreeBSD systems,
1690 and it is harmless, since this retrying takes time anyway
1691 and should be infrequent.
1692 `sleep-for' allowed for quitting this loop with interrupts
1693 slowed down so it can't be used here. Async timers should
1694 already be disabled at this point so we can use `sleep'. */
1702 speed_up_interrupts ();
1705 report_file_error ("error connecting socket", list2(name, port));
1708 speed_up_interrupts ();
1711 if (setsockopt (ws, IPPROTO_IP, IP_MULTICAST_TTL,
1712 (char *) &thettl, sizeof (thettl)) < 0)
1716 report_file_error ("error setting ttl", list2(name, ttl));
1719 set_socket_nonblocking_maybe (rs, theport, "udp");
1722 *voutfd = (void*)ws;
1725 #endif /* HAVE_MULTICAST */
1727 #endif /* HAVE_SOCKETS */
1730 /**********************************************************************/
1731 /* Initialization */
1732 /**********************************************************************/
1735 process_type_create_unix (void)
1737 PROCESS_HAS_METHOD (unix, alloc_process_data);
1738 PROCESS_HAS_METHOD (unix, mark_process_data);
1740 PROCESS_HAS_METHOD (unix, init_process);
1741 PROCESS_HAS_METHOD (unix, reap_exited_processes);
1743 PROCESS_HAS_METHOD (unix, init_process_io_handles);
1744 PROCESS_HAS_METHOD (unix, create_process);
1745 PROCESS_HAS_METHOD (unix, tooltalk_connection_p);
1746 PROCESS_HAS_METHOD (unix, set_window_size);
1748 PROCESS_HAS_METHOD (unix, update_status_if_terminated);
1750 PROCESS_HAS_METHOD (unix, send_process);
1751 PROCESS_HAS_METHOD (unix, process_send_eof);
1752 PROCESS_HAS_METHOD (unix, deactivate_process);
1753 PROCESS_HAS_METHOD (unix, kill_child_process);
1754 PROCESS_HAS_METHOD (unix, kill_process_by_pid);
1755 PROCESS_HAS_METHOD (unix, get_tty_name);
1757 PROCESS_HAS_METHOD (unix, canonicalize_host_name);
1758 PROCESS_HAS_METHOD (unix, open_network_stream);
1759 #ifdef HAVE_MULTICAST
1760 PROCESS_HAS_METHOD (unix, open_multicast_group);
1766 vars_of_process_unix (void)
1768 Fprovide (intern ("unix-processes"));
1771 #endif /* !defined (NO_SUBPROCESSES) */