1 /* Old synchronous subprocess invocation for SXEmacs.
2 Copyright (C) 1985, 86, 87, 88, 93, 94, 95 Free Software Foundation, Inc.
4 This file is part of SXEmacs
6 SXEmacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 SXEmacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 /* Synched up with: Mule 2.0, FSF 19.30. */
21 /* Partly sync'ed with 19.36.4 */
23 /* #### This ENTIRE file is only used in batch mode.
25 We only need two things to get rid of both this and ntproc.c:
27 -- my `stderr-proc' ws, which adds support for a separate stderr
28 in asynch. subprocesses. (it's a feature in `old-call-process-internal'.)
29 -- a noninteractive event loop that supports processes.
37 #include "ui/insdel.h"
41 #include "ui/window.h"
43 #include "mule/file-coding.h"
48 #include "sysfile.h" /* Always include after sysproc.h */
49 #include "syssignal.h" /* Always include before systty.h */
50 #include "ui/systty.h"
54 Lisp_Object Vshell_file_name;
56 /* The environment to pass to all subprocesses when they are started.
57 This is in the semi-bogus format of ("VAR=VAL" "VAR2=VAL2" ... )
59 Lisp_Object Vprocess_environment;
61 /* True iff we are about to fork off a synchronous process or if we
62 are waiting for it. */
63 volatile int synch_process_alive;
65 /* Nonzero => this is a string explaining death of synchronous subprocess. */
66 const char *synch_process_death;
68 /* If synch_process_death is zero,
69 this is exit code of synchronous subprocess. */
70 int synch_process_retcode;
72 /* Clean up when exiting Fcall_process_internal.
73 On Windows, delete the temporary file on any kind of termination.
74 On Unix, kill the process and any children on termination by signal. */
76 /* Nonzero if this is termination due to exit. */
77 static int call_process_exited;
79 Lisp_Object Vlisp_EXEC_SUFFIXES;
81 static Lisp_Object call_process_kill(Lisp_Object fdpid)
83 Lisp_Object fd = Fcar(fdpid);
84 Lisp_Object pid = Fcdr(fdpid);
90 EMACS_KILLPG(XINT(pid), SIGKILL);
92 synch_process_alive = 0;
96 static Lisp_Object call_process_cleanup(Lisp_Object fdpid)
98 int fd = XINT(Fcar(fdpid));
99 int pid = XINT(Fcdr(fdpid));
101 if (!call_process_exited && EMACS_KILLPG(pid, SIGINT) == 0) {
102 int speccount = specpdl_depth();
104 record_unwind_protect(call_process_kill, fdpid);
105 /* #### "c-G" -- need non-consing Single-key-description */
107 ("Waiting for process to die...(type C-g again to kill it instantly)");
109 wait_for_termination(pid);
111 /* "Discard" the unwind protect. */
114 unbind_to(speccount, Qnil);
116 message("Waiting for process to die... done");
118 synch_process_alive = 0;
123 static Lisp_Object fork_error;
125 DEFUN("old-call-process-internal", Fold_call_process_internal, 1, MANY, 0, /*
126 Call PROGRAM synchronously in separate process, with coding-system specified.
128 (PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS).
129 The program's input comes from file INFILE (nil means `/dev/null').
130 Insert output in BUFFER before point; t means current buffer;
131 nil for BUFFER means discard it; 0 means discard and don't wait.
132 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
133 REAL-BUFFER says what to do with standard output, as above,
134 while STDERR-FILE says what to do with standard error in the child.
135 STDERR-FILE may be nil (discard standard error output),
136 t (mix it with ordinary output), or a file name string.
138 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
139 Remaining arguments are strings passed as command arguments to PROGRAM.
141 If BUFFER is 0, `call-process' returns immediately with value nil.
142 Otherwise it waits for PROGRAM to terminate and returns a numeric exit status
143 or a signal description string.
144 If you quit, the process is killed with SIGINT, or SIGKILL if you
147 (int nargs, Lisp_Object * args))
149 /* This function can GC */
150 Lisp_Object infile, buffer, current_dir, display, path;
157 int speccount = specpdl_depth();
158 struct gcpro gcpro1, gcpro2, gcpro3;
159 char **new_argv = alloca_array(char *, max(2, nargs - 2));
161 /* File to use for stderr in the child.
162 t means use same as standard output. */
163 Lisp_Object error_file;
165 CHECK_STRING(args[0]);
169 #if defined (NO_SUBPROCESSES)
170 /* Without asynchronous processes we cannot have BUFFER == 0. */
171 if (nargs >= 3 && !INTP(args[2]))
173 ("Operating system cannot handle asynchronous subprocesses");
174 #endif /* NO_SUBPROCESSES */
176 /* Do this before building new_argv because GC in Lisp code
177 * called by various filename-hacking routines might relocate strings */
178 locate_file(Vexec_path, args[0], Vlisp_EXEC_SUFFIXES, &path, X_OK);
180 /* Make sure that the child will be able to chdir to the current
181 buffer's current directory, or its unhandled equivalent. We
182 can't just have the child check for an error when it does the
183 chdir, since it's in a vfork. */
185 struct gcpro ngcpro1, ngcpro2;
186 /* Do this test before building new_argv because GC in Lisp code
187 * called by various filename-hacking routines might relocate strings */
188 /* Make sure that the child will be able to chdir to the current
189 buffer's current directory. We can't just have the child check
190 for an error when it does the chdir, since it's in a vfork. */
192 current_dir = current_buffer->directory;
193 NGCPRO2(current_dir, path); /* Caller gcprotects args[] */
194 current_dir = Funhandled_file_name_directory(current_dir);
195 current_dir = expand_and_dir_to_file(current_dir, Qnil);
197 /* This is in FSF, but it breaks everything in the presence of
198 ange-ftp-visited files, so away with it. */
199 if (NILP(Ffile_accessible_directory_p(current_dir)))
200 report_file_error("Setting current directory",
201 Fcons(current_buffer->directory,
207 GCPRO2(current_dir, path);
209 if (nargs >= 2 && !NILP(args[1])) {
210 struct gcpro ngcpro1;
211 NGCPRO1(current_buffer->directory);
212 infile = Fexpand_file_name(args[1], current_buffer->directory);
214 CHECK_STRING(infile);
216 infile = build_string(NULL_DEVICE);
220 GCPRO3(infile, current_dir, path); /* Fexpand_file_name might trash it */
225 /* If BUFFER is a list, its meaning is
226 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
228 if (CONSP(XCDR(buffer))) {
229 Lisp_Object file_for_stderr =
232 if (NILP(file_for_stderr)
233 || EQ(Qt, file_for_stderr))
234 error_file = file_for_stderr;
237 Fexpand_file_name(file_for_stderr,
241 buffer = XCAR(buffer);
244 if (!(EQ(buffer, Qnil)
247 Lisp_Object spec_buffer = buffer;
248 buffer = Fget_buffer(buffer);
249 /* Mention the buffer name for a better error message. */
251 CHECK_BUFFER(spec_buffer);
252 CHECK_BUFFER(buffer);
259 display = ((nargs >= 4) ? args[3] : Qnil);
261 /* From here we assume we won't GC (unless an error is signaled). */
264 for (i = 4; i < nargs; i++) {
265 CHECK_STRING(args[i]);
266 new_argv[i - 3] = (char *)XSTRING_DATA(args[i]);
269 new_argv[max(nargs - 3, 1)] = 0;
272 report_file_error("Searching for program",
273 Fcons(args[0], Qnil));
274 new_argv[0] = (char *)XSTRING_DATA(path);
276 filefd = open((char *)XSTRING_DATA(infile), O_RDONLY | OPEN_BINARY, 0);
278 report_file_error("Opening process input file",
279 Fcons(infile, Qnil));
282 fd[1] = open(NULL_DEVICE, O_WRONLY | OPEN_BINARY, 0);
286 report_file_error("Opening process input file pipe",
287 Fcons(infile, Qnil));
290 /* Replaced by close_process_descs */
291 set_exclusive_use(fd[0]);
296 /* child_setup must clobber environ in systems with true vfork.
297 Protect it from permanent change. */
298 REGISTER char **save_environ = environ;
299 REGISTER int fd1 = fd[1];
302 /* Record that we're about to create a synchronous process. */
303 synch_process_alive = 1;
305 /* These vars record information from process termination.
306 Clear them now before process can possibly terminate,
307 to avoid timing error if process terminates soon. */
308 synch_process_death = 0;
309 synch_process_retcode = 0;
311 if (NILP(error_file))
312 fd_error = open(NULL_DEVICE, O_WRONLY | OPEN_BINARY);
313 else if (STRINGP(error_file)) {
314 fd_error = open((const char *)XSTRING_DATA(error_file),
315 O_WRONLY | O_TRUNC | O_CREAT |
316 OPEN_BINARY, CREAT_MODE
321 int save_errno = errno;
327 report_file_error("Cannot open",
328 Fcons(error_file, Qnil));
337 /* This is necessary because some shells may attempt to
338 access the current controlling terminal and will hang
339 if they are run in the background, as will be the case
340 when XEmacs is started in the background. Martin
341 Buchholz observed this problem running a subprocess
342 that used zsh to call gzip to uncompress an info
344 disconnect_controlling_terminal();
345 child_setup(filefd, fd1, fd_error, new_argv,
346 (char *)XSTRING_DATA(current_dir));
351 environ = save_environ;
353 /* Close most of our fd's, but not fd[0]
354 since we will use that to read input from. */
360 if (!NILP(fork_error))
361 signal_error(Qfile_error, fork_error);
364 int save_errno = errno;
368 report_file_error("Doing fork", Qnil);
374 #if defined (NO_SUBPROCESSES)
375 /* If Emacs has been built with asynchronous subprocess support,
376 we don't need to do this, I think because it will then have
377 the facilities for handling SIGCHLD. */
378 wait_without_blocking();
379 #endif /* NO_SUBPROCESSES */
386 Lisp_Object instream;
387 struct gcpro ngcpro1;
389 /* Enable sending signal if user quits below. */
390 call_process_exited = 0;
392 record_unwind_protect(call_process_cleanup,
393 Fcons(make_int(fd[0]), make_int(pid)));
395 /* FSFmacs calls Fset_buffer() here. We don't have to because
396 we can insert into buffers other than the current one. */
398 XSETBUFFER(buffer, current_buffer);
400 make_filedesc_input_stream(fd[0], 0, -1, LSTR_ALLOW_QUIT);
403 make_decoding_input_stream
405 Fget_coding_system(Vcoding_system_for_read));
406 Lstream_set_character_mode(XLSTREAM(instream));
411 /* Repeatedly read until we've filled as much as possible
412 of the buffer size we have. But don't read
413 less than 1024--save that for the next bufferfull. */
416 while (nread < bufsize - 1024) {
417 Lstream_data_count this_read
419 Lstream_read(XLSTREAM(instream),
434 /* Now NREAD is the total amount of data in the buffer. */
442 buffer_insert_raw_string(XBUFFER(buffer),
446 /* Make the buffer bigger as we continue to read more data,
448 if (bufsize < 64 * 1024 && total_read > 32 * bufsize) {
450 bufptr = (char *)alloca(bufsize);
453 if (!NILP(display) && INTERACTIVE) {
458 Lstream_close(XLSTREAM(instream));
462 /* Wait for it to terminate, unless it already has. */
463 wait_for_termination(pid);
465 /* Don't kill any children that the subprocess may have left behind
467 call_process_exited = 1;
468 unbind_to(speccount, Qnil);
470 if (synch_process_death)
471 return build_string(synch_process_death);
472 return make_int(synch_process_retcode);
476 /* Move the file descriptor FD so that its number is not less than MIN. *
477 The original file descriptor remains open. */
478 static int relocate_fd(int fd, int min)
481 for( ; min >= 0 && lseek(min, SEEK_CUR,0) >= 0; min++ ) {
482 if (errno == EBADF) {
483 int newfd = dup2(fd,min);
485 stderr_out("Error while setting up child: %s\n",
489 assert(newfd == min);
499 stderr_out("Error while setting up child: %s\n",
502 } else if (newfd >= min ) {
505 int recurse_fd = relocate_fd(newfd, min);
513 /* This is the last thing run in a newly forked inferior
514 either synchronous or asynchronous.
515 Copy descriptors IN, OUT and ERR
516 as descriptors STDIN_FILENO, STDOUT_FILENO, and STDERR_FILENO.
517 Initialize inferior's priority, pgrp, connected dir and environment.
518 then exec another program based on new_argv.
520 This function may change environ for the superior process.
521 Therefore, the superior process must save and restore the value
522 of environ around the fork and the call to this function.
524 ENV is the environment for the subprocess.
526 XEmacs: We've removed the SET_PGRP argument because it's already
527 done by the callers of child_setup.
529 CURRENT_DIR is an elisp string giving the path of the current
530 directory the subprocess should have. Since we can't really signal
531 a decent error from within the child, this should be verified as an
532 executable directory by the parent. */
535 child_setup(int in, int out, int err, char **new_argv, const char *current_dir)
540 #ifdef SET_EMACS_PRIORITY
541 if (emacs_priority != 0)
542 nice(-emacs_priority);
545 /* Under Windows, we are not in a child process at all, so we should
546 not close handles inherited from the parent -- we are the parent
547 and doing so will screw up all manner of things! Similarly, most
548 of the rest of the cleanup done in this function is not done
551 #### This entire child_setup() function is an utter and complete
552 piece of shit. I would rewrite it, at the very least splitting
553 out the Windows and non-Windows stuff into two completely
554 different functions; but instead I'm trying to make it go away
555 entirely, using the Lisp definition in process.el. What's left
556 is to fix up the routines in event-msw.c (and in event-Xt.c and
557 event-tty.c) to allow for stream devices to be handled correctly.
558 There isn't much to do, in fact, and I'll fix it shortly. That
559 way, the Lisp definition can be used non-interactively too. */
560 #if !defined (NO_SUBPROCESSES)
561 /* Close Emacs's descriptors that this process should not have. */
562 close_process_descs();
563 #endif /* not NO_SUBPROCESSES */
566 /* Note that use of alloca is always safe here. It's obvious for systems
567 that do not have true vfork or that have true (stack) alloca.
568 If using vfork and C_ALLOCA it is safe because that changes
569 the superior's static variables as if the superior had done alloca
570 and will be cleaned up in the usual way. */
574 i = strlen(current_dir);
575 pwd = alloca_array(char, i + 6);
576 memcpy(pwd, "PWD=", 4);
577 memcpy(pwd + 4, current_dir, i);
579 if (!IS_DIRECTORY_SEP(pwd[i - 1]))
580 pwd[i++] = DIRECTORY_SEP;
583 /* We can't signal an Elisp error here; we're in a vfork. Since
584 the callers check the current directory before forking, this
585 should only return an error if the directory's permissions
586 are changed between the check and this chdir, but we should
588 if (chdir(pwd + 4) < 0) {
589 /* Don't report the chdir error, or ange-ftp.el doesn't work. */
590 /* (FSFmacs does _exit (errno) here.) */
593 /* Strip trailing "/". Cretinous *[]&@$#^%@#$% Un*x */
594 /* leave "//" (from FSF) */
595 while (i > 6 && IS_DIRECTORY_SEP(pwd[i - 1]))
600 /* Set `env' to a vector of the strings in Vprocess_environment. */
601 /* + 2 to include PWD and terminating 0. */
602 env = alloca_array(char *, XINT(Flength(Vprocess_environment)) + 2);
604 REGISTER Lisp_Object tail;
605 char **new_env = env;
607 /* If we have a PWD envvar and we know the real current directory,
608 pass one down, but with corrected value. */
609 if (pwd && getenv("PWD"))
612 /* Copy the Vprocess_environment strings into new_env. */
613 for (tail = Vprocess_environment;
614 CONSP(tail) && STRINGP(XCAR(tail)); tail = XCDR(tail)) {
616 char *envvar_external;
618 TO_EXTERNAL_FORMAT(LISP_STRING, XCAR(tail),
619 C_STRING_ALLOCA, envvar_external,
622 /* See if envvar_external duplicates any string already in the env.
623 If so, don't put it in.
624 When an env var has multiple definitions,
625 we keep the definition that comes first in process-environment. */
626 for (; ep != new_env; ep++) {
627 char *p = *ep, *q = envvar_external;
630 /* The string is malformed; might as well drop it. */
639 if (pwd && !strncmp("PWD=", envvar_external, 4)) {
643 *new_env++ = envvar_external;
650 /* Make sure that in, out, and err are not actually already in
651 descriptors zero, one, or two; this could happen if Emacs is
652 started with its standard in, out, or error closed, as might
654 in = relocate_fd(in, 3);
655 out = relocate_fd(out, 3);
656 err = relocate_fd(err, 3);
658 /* Set the standard input/output channels of the new process. */
660 close(STDOUT_FILENO);
661 close(STDERR_FILENO);
663 dup2(in, STDIN_FILENO);
664 dup2(out, STDOUT_FILENO);
665 dup2(err, STDERR_FILENO);
671 /* Close non-process-related file descriptors. It would be cleaner to
672 close just the ones that need to be, but the following brute
673 force approach is certainly effective, and not too slow. */
678 for (fd = 3; fd < MAXDESC; fd++)
683 something missing here;
686 /* execvp does not accept an environment arg so the only way
687 to pass this environment is to set environ. Our caller
688 is responsible for restoring the ambient value of environ. */
690 execvp(new_argv[0], new_argv);
692 stdout_out("Can't exec program %s\n", new_argv[0]);
697 getenv_internal(const Bufbyte * var,
698 Bytecount varlen, Bufbyte ** value, Bytecount * valuelen)
702 for (scan = Vprocess_environment; CONSP(scan); scan = XCDR(scan)) {
703 Lisp_Object entry = XCAR(scan);
706 && XSTRING_LENGTH(entry) > varlen
707 && XSTRING_BYTE(entry, varlen) == '='
708 && !memcmp(XSTRING_DATA(entry), var, varlen)
710 *value = XSTRING_DATA(entry) + (varlen + 1);
711 *valuelen = XSTRING_LENGTH(entry) - (varlen + 1);
719 DEFUN("getenv", Fgetenv, 1, 2, "sEnvironment variable: \np", /*
720 Return the value of environment variable VAR, as a string.
721 VAR is a string, the name of the variable.
722 When invoked interactively, prints the value in the echo area.
726 Bufbyte *value = NULL;
728 Lisp_Object v = Qnil;
733 if (getenv_internal(XSTRING_DATA(var), XSTRING_LENGTH(var),
734 &value, &valuelen)) {
735 v = make_string(value, valuelen);
737 if (!NILP(interactivep)) {
739 message("%s not defined in environment",
742 /* #### Should use Fprin1_to_string or Fprin1 to handle string
743 containing quotes correctly. */
744 message("\"%s\"", value);
749 /* A version of getenv that consults process_environment, easily
751 char *egetenv(const char *var)
753 /* This cannot GC -- 7-28-00 ben */
758 ((const Bufbyte *)var, strlen(var), &value, &valuelen))
759 return (char *)value;
764 void init_callproc(void)
766 /* This function can GC */
769 /* jwz: always initialize Vprocess_environment, so that egetenv()
772 Vprocess_environment = Qnil;
773 for (envp = environ; envp && *envp; envp++)
774 Vprocess_environment =
775 Fcons(build_ext_string(*envp, Qfile_name),
776 Vprocess_environment);
780 /* Initialize shell-file-name from environment variables or best guess. */
781 const char *shell = egetenv("SHELL");
784 Vshell_file_name = build_string(shell);
789 void set_process_environment(void)
791 REGISTER char **envp;
793 Vprocess_environment = Qnil;
797 for (envp = environ; *envp; envp++)
798 Vprocess_environment = Fcons(build_string(*envp),
799 Vprocess_environment);
803 void syms_of_callproc(void)
805 DEFSUBR(Fold_call_process_internal);
809 void vars_of_callproc(void)
811 /* This function can GC */
813 DEFVAR_LISP("shell-file-name", &Vshell_file_name /*
814 *File name to load inferior shells from.
815 Initialized from the SHELL environment variable.
818 DEFVAR_LISP("process-environment", &Vprocess_environment /*
819 List of environment variables for subprocesses to inherit.
820 Each element should be a string of the form ENVVARNAME=VALUE.
821 The environment which Emacs inherits is placed in this variable
825 Vlisp_EXEC_SUFFIXES = build_string(EXEC_SUFFIXES);
826 staticpro(&Vlisp_EXEC_SUFFIXES);