1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs 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 2, or (at your option)
11 GNU Emacs 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 GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
28 extern char *strerror ();
30 /* Define SIGCHLD as an alias for SIGCLD. */
32 #if !defined (SIGCHLD) && defined (SIGCLD)
33 #define SIGCHLD SIGCLD
36 #include <sys/types.h>
43 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
46 #include <sys/param.h>
63 #include "syssignal.h"
67 extern noshare
char **environ
;
69 extern char **environ
;
72 #define max(a, b) ((a) > (b) ? (a) : (b))
75 Lisp_Object Vbinary_process
;
78 Lisp_Object Vexec_path
, Vexec_directory
, Vdata_directory
, Vdoc_directory
;
79 Lisp_Object Vconfigure_info_directory
;
81 Lisp_Object Vshell_file_name
;
83 Lisp_Object Vprocess_environment
;
85 /* True iff we are about to fork off a synchronous process or if we
86 are waiting for it. */
87 int synch_process_alive
;
89 /* Nonzero => this is a string explaining death of synchronous subprocess. */
90 char *synch_process_death
;
92 /* If synch_process_death is zero,
93 this is exit code of synchronous subprocess. */
94 int synch_process_retcode
;
96 extern Lisp_Object Vdoc_file_name
;
98 #ifndef VMS /* VMS version is in vmsproc.c. */
101 call_process_kill (fdpid
)
104 close (XFASTINT (Fcar (fdpid
)));
105 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
106 synch_process_alive
= 0;
111 call_process_cleanup (fdpid
)
115 /* for MSDOS fdpid is really (fd . tempfile) */
116 register Lisp_Object file
= Fcdr (fdpid
);
117 close (XFASTINT (Fcar (fdpid
)));
118 if (strcmp (XSTRING (file
)-> data
, NULL_DEVICE
) != 0)
119 unlink (XSTRING (file
)->data
);
120 #else /* not MSDOS */
121 register int pid
= XFASTINT (Fcdr (fdpid
));
123 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
125 int count
= specpdl_ptr
- specpdl
;
126 record_unwind_protect (call_process_kill
, fdpid
);
127 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
130 wait_for_termination (pid
);
132 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
133 message1 ("Waiting for process to die...done");
135 synch_process_alive
= 0;
136 close (XFASTINT (Fcar (fdpid
)));
137 #endif /* not MSDOS */
141 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
142 "Call PROGRAM synchronously in separate process.\n\
143 The program's input comes from file INFILE (nil means `/dev/null').\n\
144 Insert output in BUFFER before point; t means current buffer;\n\
145 nil for BUFFER means discard it; 0 means discard and don't wait.\n\
146 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.\n\
147 Remaining arguments are strings passed as command arguments to PROGRAM.\n\
148 If BUFFER is 0, returns immediately with value nil.\n\
149 Otherwise waits for PROGRAM to terminate\n\
150 and returns a numeric exit status or a signal description string.\n\
151 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.")
154 register Lisp_Object
*args
;
156 Lisp_Object infile
, buffer
, current_dir
, display
, path
;
161 int count
= specpdl_ptr
- specpdl
;
162 register unsigned char **new_argv
163 = (unsigned char **) alloca ((max (2, nargs
- 2)) * sizeof (char *));
164 struct buffer
*old
= current_buffer
;
165 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
166 char *outf
, *tempfile
;
172 CHECK_STRING (args
[0], 0);
175 /* Without asynchronous processes we cannot have BUFFER == 0. */
176 if (nargs
>= 3 && XTYPE (args
[2]) == Lisp_Int
)
177 error ("Operating system cannot handle asynchronous subprocesses");
178 #endif /* subprocesses */
180 if (nargs
>= 2 && ! NILP (args
[1]))
182 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
183 CHECK_STRING (infile
, 1);
186 infile
= build_string (NULL_DEVICE
);
190 register Lisp_Object tem
;
192 buffer
= tem
= args
[2];
195 || XFASTINT (tem
) == 0))
197 buffer
= Fget_buffer (tem
);
198 CHECK_BUFFER (buffer
, 2);
204 /* Make sure that the child will be able to chdir to the current
205 buffer's current directory, or its unhandled equivalent. We
206 can't just have the child check for an error when it does the
207 chdir, since it's in a vfork.
209 We have to GCPRO around this because Fexpand_file_name,
210 Funhandled_file_name_directory, and Ffile_accessible_directory_p
211 might call a file name handling function. The argument list is
212 protected by the caller, so all we really have to worry about is
215 struct gcpro gcpro1
, gcpro2
, gcpro3
;
217 current_dir
= current_buffer
->directory
;
219 GCPRO3 (infile
, buffer
, current_dir
);
222 expand_and_dir_to_file
223 (Funhandled_file_name_directory (current_dir
), Qnil
);
224 if (NILP (Ffile_accessible_directory_p (current_dir
)))
225 report_file_error ("Setting current directory",
226 Fcons (current_buffer
->directory
, Qnil
));
231 display
= nargs
>= 4 ? args
[3] : Qnil
;
235 for (i
= 4; i
< nargs
; i
++)
237 CHECK_STRING (args
[i
], i
);
238 new_argv
[i
- 3] = XSTRING (args
[i
])->data
;
240 /* Program name is first command arg */
241 new_argv
[0] = XSTRING (args
[0])->data
;
245 filefd
= open (XSTRING (infile
)->data
, O_RDONLY
, 0);
248 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
250 /* Search for program; barf if not found. */
251 openp (Vexec_path
, args
[0], EXEC_SUFFIXES
, &path
, 1);
255 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
257 new_argv
[0] = XSTRING (path
)->data
;
259 #ifdef MSDOS /* MW, July 1993 */
260 /* These vars record information from process termination.
261 Clear them now before process can possibly terminate,
262 to avoid timing error if process terminates soon. */
263 synch_process_death
= 0;
264 synch_process_retcode
= 0;
266 if ((outf
= egetenv ("TMP")) || (outf
= egetenv ("TEMP")))
267 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
270 tempfile
= alloca (20);
273 dostounix_filename (tempfile
);
274 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
275 strcat (tempfile
, "/");
276 strcat (tempfile
, "detmp.XXX");
279 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
283 report_file_error ("Opening process output file", Fcons (tempfile
, Qnil
));
287 if (XTYPE (buffer
) == Lisp_Int
)
288 fd
[1] = open (NULL_DEVICE
, O_WRONLY
), fd
[0] = -1;
295 /* Replaced by close_process_descs */
296 set_exclusive_use (fd
[0]);
301 /* child_setup must clobber environ in systems with true vfork.
302 Protect it from permanent change. */
303 register char **save_environ
= environ
;
304 register int fd1
= fd
[1];
306 #if 0 /* Some systems don't have sigblock. */
307 mask
= sigblock (sigmask (SIGCHLD
));
310 /* Record that we're about to create a synchronous process. */
311 synch_process_alive
= 1;
313 /* These vars record information from process termination.
314 Clear them now before process can possibly terminate,
315 to avoid timing error if process terminates soon. */
316 synch_process_death
= 0;
317 synch_process_retcode
= 0;
319 #ifdef MSDOS /* MW, July 1993 */
320 pid
= run_msdos_command (new_argv
, current_dir
, filefd
, outfilefd
);
322 fd1
= -1; /* No harm in closing that one! */
323 fd
[0] = open (tempfile
, NILP (Vbinary_process
) ? O_TEXT
: O_BINARY
);
327 report_file_error ("Cannot re-open temporary file", Qnil
);
329 #else /* not MSDOS */
341 child_setup (filefd
, fd1
, fd1
, new_argv
, 0, current_dir
);
343 #endif /* not MSDOS */
346 /* Tell SIGCHLD handler to look for this pid. */
347 synch_process_pid
= pid
;
348 /* Now let SIGCHLD come through. */
352 environ
= save_environ
;
362 report_file_error ("Doing vfork", Qnil
);
365 if (XTYPE (buffer
) == Lisp_Int
)
368 /* If Emacs has been built with asynchronous subprocess support,
369 we don't need to do this, I think because it will then have
370 the facilities for handling SIGCHLD. */
371 wait_without_blocking ();
372 #endif /* subprocesses */
377 /* MSDOS needs different cleanup information. */
378 record_unwind_protect (call_process_cleanup
,
379 Fcons (make_number (fd
[0]), build_string (tempfile
)));
381 record_unwind_protect (call_process_cleanup
,
382 Fcons (make_number (fd
[0]), make_number (pid
)));
383 #endif /* not MSDOS */
386 if (XTYPE (buffer
) == Lisp_Buffer
)
387 Fset_buffer (buffer
);
396 while ((nread
= read (fd
[0], buf
, sizeof buf
)) > 0)
401 if (!NILP (display
) && INTERACTIVE
)
404 prepare_menu_bars ();
406 redisplay_preserve_echo_area ();
413 /* Wait for it to terminate, unless it already has. */
414 wait_for_termination (pid
);
418 set_buffer_internal (old
);
420 unbind_to (count
, Qnil
);
422 if (synch_process_death
)
423 return build_string (synch_process_death
);
424 return make_number (synch_process_retcode
);
429 delete_temp_file (name
)
432 unlink (XSTRING (name
)->data
);
435 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
437 "Send text from START to END to a synchronous process running PROGRAM.\n\
438 Delete the text if fourth arg DELETE is non-nil.\n\
439 Insert output in BUFFER before point; t means current buffer;\n\
440 nil for BUFFER means discard it; 0 means discard and don't wait.\n\
441 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.\n\
442 Remaining args are passed to PROGRAM at startup as command args.\n\
443 If BUFFER is nil, returns immediately with value nil.\n\
444 Otherwise waits for PROGRAM to terminate\n\
445 and returns a numeric exit status or a signal description string.\n\
446 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.")
449 register Lisp_Object
*args
;
451 register Lisp_Object filename_string
, start
, end
;
457 int count
= specpdl_ptr
- specpdl
;
461 if ((outf
= egetenv ("TMP")) || (outf
= egetenv ("TEMP")))
462 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
465 tempfile
= alloca (20);
468 dostounix_filename (tempfile
);
469 if (tempfile
[strlen (tempfile
) - 1] != '/')
470 strcat (tempfile
, "/");
471 strcat (tempfile
, "detmp.XXX");
472 #else /* not MSDOS */
475 strcpy (tempfile
, "tmp:emacsXXXXXX.");
477 strcpy (tempfile
, "/tmp/emacsXXXXXX");
479 #endif /* not MSDOS */
483 filename_string
= build_string (tempfile
);
486 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
);
487 record_unwind_protect (delete_temp_file
, filename_string
);
490 Fdelete_region (start
, end
);
492 args
[3] = filename_string
;
494 return unbind_to (count
, Fcall_process (nargs
- 2, args
+ 2));
497 #ifndef VMS /* VMS version is in vmsproc.c. */
499 /* This is the last thing run in a newly forked inferior
500 either synchronous or asynchronous.
501 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
502 Initialize inferior's priority, pgrp, connected dir and environment.
503 then exec another program based on new_argv.
505 This function may change environ for the superior process.
506 Therefore, the superior process must save and restore the value
507 of environ around the vfork and the call to this function.
509 ENV is the environment for the subprocess.
511 SET_PGRP is nonzero if we should put the subprocess into a separate
514 CURRENT_DIR is an elisp string giving the path of the current
515 directory the subprocess should have. Since we can't really signal
516 a decent error from within the child, this should be verified as an
517 executable directory by the parent. */
519 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
521 register char **new_argv
;
523 Lisp_Object current_dir
;
526 /* The MSDOS port of gcc cannot fork, vfork, ... so we must call system
528 #else /* not MSDOS */
534 extern int emacs_priority
;
536 nice (- emacs_priority
);
540 /* Close Emacs's descriptors that this process should not have. */
541 close_process_descs ();
545 /* Note that use of alloca is always safe here. It's obvious for systems
546 that do not have true vfork or that have true (stack) alloca.
547 If using vfork and C_ALLOCA it is safe because that changes
548 the superior's static variables as if the superior had done alloca
549 and will be cleaned up in the usual way. */
551 register unsigned char *temp
;
554 i
= XSTRING (current_dir
)->size
;
555 temp
= (unsigned char *) alloca (i
+ 2);
556 bcopy (XSTRING (current_dir
)->data
, temp
, i
);
557 if (temp
[i
- 1] != '/') temp
[i
++] = '/';
560 /* We can't signal an Elisp error here; we're in a vfork. Since
561 the callers check the current directory before forking, this
562 should only return an error if the directory's permissions
563 are changed between the check and this chdir, but we should
565 if (chdir (temp
) < 0)
569 /* Set `env' to a vector of the strings in Vprocess_environment. */
571 register Lisp_Object tem
;
572 register char **new_env
;
573 register int new_length
;
576 for (tem
= Vprocess_environment
;
577 (XTYPE (tem
) == Lisp_Cons
578 && XTYPE (XCONS (tem
)->car
) == Lisp_String
);
579 tem
= XCONS (tem
)->cdr
)
582 /* new_length + 1 to include terminating 0. */
583 env
= new_env
= (char **) alloca ((new_length
+ 1) * sizeof (char *));
585 /* Copy the Vprocess_environment strings into new_env. */
586 for (tem
= Vprocess_environment
;
587 (XTYPE (tem
) == Lisp_Cons
588 && XTYPE (XCONS (tem
)->car
) == Lisp_String
);
589 tem
= XCONS (tem
)->cdr
)
592 char *string
= (char *) XSTRING (XCONS (tem
)->car
)->data
;
593 /* See if this string duplicates any string already in the env.
594 If so, don't put it in.
595 When an env var has multiple definitions,
596 we keep the definition that comes first in process-environment. */
597 for (; ep
!= new_env
; ep
++)
599 char *p
= *ep
, *q
= string
;
603 /* The string is malformed; might as well drop it. */
618 /* Make sure that in, out, and err are not actually already in
619 descriptors zero, one, or two; this could happen if Emacs is
620 started with its standard in, out, or error closed, as might
622 in
= relocate_fd (in
, 3);
623 out
= relocate_fd (out
, 3);
624 err
= relocate_fd (err
, 3);
638 #ifndef SETPGRP_RELEASES_CTTY
639 setpgrp (); /* No arguments but equivalent in this case */
644 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
645 EMACS_SET_TTY_PGRP (0, &pid
);
648 something missing here
;
651 /* execvp does not accept an environment arg so the only way
652 to pass this environment is to set environ. Our caller
653 is responsible for restoring the ambient value of environ. */
655 execvp (new_argv
[0], new_argv
);
657 write (1, "Couldn't exec the program ", 26);
658 write (1, new_argv
[0], strlen (new_argv
[0]));
660 #endif /* not MSDOS */
663 /* Move the file descriptor FD so that its number is not less than MIN.
664 If the file descriptor is moved at all, the original is freed. */
666 relocate_fd (fd
, min
)
676 char *message1
= "Error while setting up child: ";
677 char *errmessage
= strerror (errno
);
678 char *message2
= "\n";
679 write (2, message1
, strlen (message1
));
680 write (2, errmessage
, strlen (errmessage
));
681 write (2, message2
, strlen (message2
));
684 /* Note that we hold the original FD open while we recurse,
685 to guarantee we'll get a new FD if we need it. */
686 new = relocate_fd (new, min
);
693 getenv_internal (var
, varlen
, value
, valuelen
)
701 for (scan
= Vprocess_environment
; CONSP (scan
); scan
= XCONS (scan
)->cdr
)
703 Lisp_Object entry
= XCONS (scan
)->car
;
705 if (XTYPE (entry
) == Lisp_String
706 && XSTRING (entry
)->size
> varlen
707 && XSTRING (entry
)->data
[varlen
] == '='
708 && ! bcmp (XSTRING (entry
)->data
, var
, varlen
))
710 *value
= (char *) XSTRING (entry
)->data
+ (varlen
+ 1);
711 *valuelen
= XSTRING (entry
)->size
- (varlen
+ 1);
719 DEFUN ("getenv", Fgetenv
, Sgetenv
, 1, 1, 0,
720 "Return the value of environment variable VAR, as a string.\n\
721 VAR should be a string. Value is nil if VAR is undefined in the environment.\n\
722 This function consults the variable ``process-environment'' for its value.")
729 CHECK_STRING (var
, 0);
730 if (getenv_internal (XSTRING (var
)->data
, XSTRING (var
)->size
,
732 return make_string (value
, valuelen
);
737 /* A version of getenv that consults process_environment, easily
746 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
))
754 /* This is run before init_cmdargs. */
758 char *data_dir
= egetenv ("EMACSDATA");
759 char *doc_dir
= egetenv ("EMACSDOC");
762 = Ffile_name_as_directory (build_string (data_dir
? data_dir
765 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
768 /* Check the EMACSPATH environment variable, defaulting to the
769 PATH_EXEC path from paths.h. */
770 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
771 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
772 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
775 /* This is run after init_cmdargs, so that Vinvocation_directory is valid. */
779 char *data_dir
= egetenv ("EMACSDATA");
784 if (initialized
&& !NILP (Vinstallation_directory
))
786 /* Add to the path the lib-src subdir of the installation dir. */
788 tem
= Fexpand_file_name (build_string ("lib-src"),
789 Vinstallation_directory
);
790 if (NILP (Fmember (tem
, Vexec_path
)))
792 Vexec_path
= nconc2 (Vexec_path
, Fcons (tem
, Qnil
));
793 Vexec_directory
= Ffile_name_as_directory (tem
);
795 /* If we use ../lib-src, maybe use ../etc as well.
796 Do so if ../etc exists and has our DOC-... file in it. */
799 tem
= Fexpand_file_name (build_string ("etc"),
800 Vinstallation_directory
);
801 Vdata_directory
= Ffile_name_as_directory (tem
);
806 tempdir
= Fdirectory_file_name (Vexec_directory
);
807 if (access (XSTRING (tempdir
)->data
, 0) < 0)
810 "Warning: arch-dependent data dir (%s) does not exist.\n",
811 XSTRING (Vexec_directory
)->data
);
815 tempdir
= Fdirectory_file_name (Vdata_directory
);
816 if (access (XSTRING (tempdir
)->data
, 0) < 0)
819 "Warning: arch-independent data dir (%s) does not exist.\n",
820 XSTRING (Vdata_directory
)->data
);
825 Vshell_file_name
= build_string ("*dcl*");
827 sh
= (char *) getenv ("SHELL");
828 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
832 set_process_environment ()
834 register char **envp
;
836 Vprocess_environment
= Qnil
;
840 for (envp
= environ
; *envp
; envp
++)
841 Vprocess_environment
= Fcons (build_string (*envp
),
842 Vprocess_environment
);
848 DEFVAR_LISP ("binary-process", &Vbinary_process
,
849 "*If non-nil then new subprocesses are assumed to produce binary output.");
850 Vbinary_process
= Qnil
;
853 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
854 "*File name to load inferior shells from.\n\
855 Initialized from the SHELL environment variable.");
857 DEFVAR_LISP ("exec-path", &Vexec_path
,
858 "*List of directories to search programs to run in subprocesses.\n\
859 Each element is a string (directory name) or nil (try default directory).");
861 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
862 "Directory of architecture-dependent files that come with GNU Emacs,\n\
863 especially executable programs intended for Emacs to invoke.");
865 DEFVAR_LISP ("data-directory", &Vdata_directory
,
866 "Directory of architecture-independent files that come with GNU Emacs,\n\
867 intended for Emacs to use.");
869 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
870 "Directory containing the DOC file that comes with GNU Emacs.\n\
871 This is usually the same as data-directory.");
873 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
874 "For internal use by the build procedure only.\n\
875 This is the name of the directory in which the build procedure installed\n\
876 Emacs's info files; the default value for Info-default-directory-list\n\
878 Vconfigure_info_directory
= build_string (PATH_INFO
);
880 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
881 "List of environment variables for subprocesses to inherit.\n\
882 Each element should be a string of the form ENVVARNAME=VALUE.\n\
883 The environment which Emacs inherits is placed in this variable\n\
884 when Emacs starts.");
887 defsubr (&Scall_process
);
890 defsubr (&Scall_process_region
);