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. */
27 extern char *strerror ();
29 /* Define SIGCHLD as an alias for SIGCLD. */
31 #if !defined (SIGCHLD) && defined (SIGCLD)
32 #define SIGCHLD SIGCLD
35 #include <sys/types.h>
42 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
45 #include <sys/param.h>
62 #include "syssignal.h"
66 extern noshare
char **environ
;
68 extern char **environ
;
71 #define max(a, b) ((a) > (b) ? (a) : (b))
74 Lisp_Object Vbinary_process
;
77 Lisp_Object Vexec_path
, Vexec_directory
, Vdata_directory
;
78 Lisp_Object Vconfigure_info_directory
;
80 Lisp_Object Vshell_file_name
;
82 Lisp_Object Vprocess_environment
;
84 /* True iff we are about to fork off a synchronous process or if we
85 are waiting for it. */
86 int synch_process_alive
;
88 /* Nonzero => this is a string explaining death of synchronous subprocess. */
89 char *synch_process_death
;
91 /* If synch_process_death is zero,
92 this is exit code of synchronous subprocess. */
93 int synch_process_retcode
;
95 extern Lisp_Object Vdoc_file_name
;
97 #ifndef VMS /* VMS version is in vmsproc.c. */
100 call_process_kill (fdpid
)
103 close (XFASTINT (Fcar (fdpid
)));
104 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
105 synch_process_alive
= 0;
110 call_process_cleanup (fdpid
)
114 /* for MSDOS fdpid is really (fd . tempfile) */
115 register Lisp_Object file
= Fcdr (fdpid
);
116 close (XFASTINT (Fcar (fdpid
)));
117 if (strcmp (XSTRING (file
)-> data
, NULL_DEVICE
) != 0)
118 unlink (XSTRING (file
)->data
);
119 #else /* not MSDOS */
120 register int pid
= XFASTINT (Fcdr (fdpid
));
122 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
124 int count
= specpdl_ptr
- specpdl
;
125 record_unwind_protect (call_process_kill
, fdpid
);
126 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
129 wait_for_termination (pid
);
131 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
132 message1 ("Waiting for process to die...done");
134 synch_process_alive
= 0;
135 close (XFASTINT (Fcar (fdpid
)));
136 #endif /* not MSDOS */
140 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
141 "Call PROGRAM synchronously in separate process.\n\
142 The program's input comes from file INFILE (nil means `/dev/null').\n\
143 Insert output in BUFFER before point; t means current buffer;\n\
144 nil for BUFFER means discard it; 0 means discard and don't wait.\n\
145 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.\n\
146 Remaining arguments are strings passed as command arguments to PROGRAM.\n\
147 If BUFFER is 0, returns immediately with value nil.\n\
148 Otherwise waits for PROGRAM to terminate\n\
149 and returns a numeric exit status or a signal description string.\n\
150 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.")
153 register Lisp_Object
*args
;
155 Lisp_Object infile
, buffer
, current_dir
, display
, path
;
160 int count
= specpdl_ptr
- specpdl
;
161 register unsigned char **new_argv
162 = (unsigned char **) alloca ((max (2, nargs
- 2)) * sizeof (char *));
163 struct buffer
*old
= current_buffer
;
164 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
165 char *outf
, *tempfile
;
171 CHECK_STRING (args
[0], 0);
174 /* Without asynchronous processes we cannot have BUFFER == 0. */
175 if (nargs
>= 3 && XTYPE (args
[2]) == Lisp_Int
)
176 error ("Operating system cannot handle asynchronous subprocesses");
177 #endif /* subprocesses */
179 if (nargs
>= 2 && ! NILP (args
[1]))
181 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
182 CHECK_STRING (infile
, 1);
185 infile
= build_string (NULL_DEVICE
);
189 register Lisp_Object tem
;
191 buffer
= tem
= args
[2];
194 || XFASTINT (tem
) == 0))
196 buffer
= Fget_buffer (tem
);
197 CHECK_BUFFER (buffer
, 2);
203 /* Make sure that the child will be able to chdir to the current
204 buffer's current directory, or its unhandled equivalent. We
205 can't just have the child check for an error when it does the
206 chdir, since it's in a vfork.
208 We have to GCPRO around this because Fexpand_file_name,
209 Funhandled_file_name_directory, and Ffile_accessible_directory_p
210 might call a file name handling function. The argument list is
211 protected by the caller, so all we really have to worry about is
214 struct gcpro gcpro1
, gcpro2
, gcpro3
;
216 current_dir
= current_buffer
->directory
;
218 GCPRO3 (infile
, buffer
, current_dir
);
221 expand_and_dir_to_file
222 (Funhandled_file_name_directory (current_dir
), Qnil
);
223 if (NILP (Ffile_accessible_directory_p (current_dir
)))
224 report_file_error ("Setting current directory",
225 Fcons (current_buffer
->directory
, Qnil
));
230 display
= nargs
>= 4 ? args
[3] : Qnil
;
234 for (i
= 4; i
< nargs
; i
++)
236 CHECK_STRING (args
[i
], i
);
237 new_argv
[i
- 3] = XSTRING (args
[i
])->data
;
239 /* Program name is first command arg */
240 new_argv
[0] = XSTRING (args
[0])->data
;
244 filefd
= open (XSTRING (infile
)->data
, O_RDONLY
, 0);
247 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
249 /* Search for program; barf if not found. */
250 openp (Vexec_path
, args
[0], EXEC_SUFFIXES
, &path
, 1);
254 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
256 new_argv
[0] = XSTRING (path
)->data
;
258 #ifdef MSDOS /* MW, July 1993 */
259 /* These vars record information from process termination.
260 Clear them now before process can possibly terminate,
261 to avoid timing error if process terminates soon. */
262 synch_process_death
= 0;
263 synch_process_retcode
= 0;
265 if ((outf
= egetenv ("TMP")) || (outf
= egetenv ("TEMP")))
266 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
269 tempfile
= alloca (20);
272 dostounix_filename (tempfile
);
273 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
274 strcat (tempfile
, "/");
275 strcat (tempfile
, "detmp.XXX");
278 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
282 report_file_error ("Opening process output file", Fcons (tempfile
, Qnil
));
286 if (XTYPE (buffer
) == Lisp_Int
)
287 fd
[1] = open (NULL_DEVICE
, O_WRONLY
), fd
[0] = -1;
294 /* Replaced by close_process_descs */
295 set_exclusive_use (fd
[0]);
300 /* child_setup must clobber environ in systems with true vfork.
301 Protect it from permanent change. */
302 register char **save_environ
= environ
;
303 register int fd1
= fd
[1];
305 #if 0 /* Some systems don't have sigblock. */
306 mask
= sigblock (sigmask (SIGCHLD
));
309 /* Record that we're about to create a synchronous process. */
310 synch_process_alive
= 1;
312 /* These vars record information from process termination.
313 Clear them now before process can possibly terminate,
314 to avoid timing error if process terminates soon. */
315 synch_process_death
= 0;
316 synch_process_retcode
= 0;
318 #ifdef MSDOS /* MW, July 1993 */
319 pid
= run_msdos_command (new_argv
, current_dir
, filefd
, outfilefd
);
321 fd1
= -1; /* No harm in closing that one! */
322 fd
[0] = open (tempfile
, NILP (Vbinary_process
) ? O_TEXT
: O_BINARY
);
326 report_file_error ("Cannot re-open temporary file", Qnil
);
328 #else /* not MSDOS */
340 child_setup (filefd
, fd1
, fd1
, new_argv
, 0, current_dir
);
342 #endif /* not MSDOS */
345 /* Tell SIGCHLD handler to look for this pid. */
346 synch_process_pid
= pid
;
347 /* Now let SIGCHLD come through. */
351 environ
= save_environ
;
361 report_file_error ("Doing vfork", Qnil
);
364 if (XTYPE (buffer
) == Lisp_Int
)
367 /* If Emacs has been built with asynchronous subprocess support,
368 we don't need to do this, I think because it will then have
369 the facilities for handling SIGCHLD. */
370 wait_without_blocking ();
371 #endif /* subprocesses */
376 /* MSDOS needs different cleanup information. */
377 record_unwind_protect (call_process_cleanup
,
378 Fcons (make_number (fd
[0]), build_string (tempfile
)));
380 record_unwind_protect (call_process_cleanup
,
381 Fcons (make_number (fd
[0]), make_number (pid
)));
382 #endif /* not MSDOS */
385 if (XTYPE (buffer
) == Lisp_Buffer
)
386 Fset_buffer (buffer
);
395 while ((nread
= read (fd
[0], buf
, sizeof buf
)) > 0)
400 if (!NILP (display
) && INTERACTIVE
)
403 prepare_menu_bars ();
405 redisplay_preserve_echo_area ();
412 /* Wait for it to terminate, unless it already has. */
413 wait_for_termination (pid
);
417 set_buffer_internal (old
);
419 unbind_to (count
, Qnil
);
421 if (synch_process_death
)
422 return build_string (synch_process_death
);
423 return make_number (synch_process_retcode
);
428 delete_temp_file (name
)
431 unlink (XSTRING (name
)->data
);
434 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
436 "Send text from START to END to a synchronous process running PROGRAM.\n\
437 Delete the text if fourth arg DELETE is non-nil.\n\
438 Insert output in BUFFER before point; t means current buffer;\n\
439 nil for BUFFER means discard it; 0 means discard and don't wait.\n\
440 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.\n\
441 Remaining args are passed to PROGRAM at startup as command args.\n\
442 If BUFFER is nil, returns immediately with value nil.\n\
443 Otherwise waits for PROGRAM to terminate\n\
444 and returns a numeric exit status or a signal description string.\n\
445 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.")
448 register Lisp_Object
*args
;
450 register Lisp_Object filename_string
, start
, end
;
456 int count
= specpdl_ptr
- specpdl
;
460 if ((outf
= egetenv ("TMP")) || (outf
= egetenv ("TEMP")))
461 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
464 tempfile
= alloca (20);
467 dostounix_filename (tempfile
);
468 if (tempfile
[strlen (tempfile
) - 1] != '/')
469 strcat (tempfile
, "/");
470 strcat (tempfile
, "detmp.XXX");
471 #else /* not MSDOS */
474 strcpy (tempfile
, "tmp:emacsXXXXXX.");
476 strcpy (tempfile
, "/tmp/emacsXXXXXX");
478 #endif /* not MSDOS */
482 filename_string
= build_string (tempfile
);
485 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
);
486 record_unwind_protect (delete_temp_file
, filename_string
);
489 Fdelete_region (start
, end
);
491 args
[3] = filename_string
;
493 return unbind_to (count
, Fcall_process (nargs
- 2, args
+ 2));
496 #ifndef VMS /* VMS version is in vmsproc.c. */
498 /* This is the last thing run in a newly forked inferior
499 either synchronous or asynchronous.
500 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
501 Initialize inferior's priority, pgrp, connected dir and environment.
502 then exec another program based on new_argv.
504 This function may change environ for the superior process.
505 Therefore, the superior process must save and restore the value
506 of environ around the vfork and the call to this function.
508 ENV is the environment for the subprocess.
510 SET_PGRP is nonzero if we should put the subprocess into a separate
513 CURRENT_DIR is an elisp string giving the path of the current
514 directory the subprocess should have. Since we can't really signal
515 a decent error from within the child, this should be verified as an
516 executable directory by the parent. */
518 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
520 register char **new_argv
;
522 Lisp_Object current_dir
;
525 /* The MSDOS port of gcc cannot fork, vfork, ... so we must call system
527 #else /* not MSDOS */
533 extern int emacs_priority
;
535 nice (- emacs_priority
);
539 /* Close Emacs's descriptors that this process should not have. */
540 close_process_descs ();
544 /* Note that use of alloca is always safe here. It's obvious for systems
545 that do not have true vfork or that have true (stack) alloca.
546 If using vfork and C_ALLOCA it is safe because that changes
547 the superior's static variables as if the superior had done alloca
548 and will be cleaned up in the usual way. */
550 register unsigned char *temp
;
553 i
= XSTRING (current_dir
)->size
;
554 temp
= (unsigned char *) alloca (i
+ 2);
555 bcopy (XSTRING (current_dir
)->data
, temp
, i
);
556 if (temp
[i
- 1] != '/') temp
[i
++] = '/';
559 /* We can't signal an Elisp error here; we're in a vfork. Since
560 the callers check the current directory before forking, this
561 should only return an error if the directory's permissions
562 are changed between the check and this chdir, but we should
564 if (chdir (temp
) < 0)
568 /* Set `env' to a vector of the strings in Vprocess_environment. */
570 register Lisp_Object tem
;
571 register char **new_env
;
572 register int new_length
;
575 for (tem
= Vprocess_environment
;
576 (XTYPE (tem
) == Lisp_Cons
577 && XTYPE (XCONS (tem
)->car
) == Lisp_String
);
578 tem
= XCONS (tem
)->cdr
)
581 /* new_length + 1 to include terminating 0. */
582 env
= new_env
= (char **) alloca ((new_length
+ 1) * sizeof (char *));
584 /* Copy the Vprocess_environment strings into new_env. */
585 for (tem
= Vprocess_environment
;
586 (XTYPE (tem
) == Lisp_Cons
587 && XTYPE (XCONS (tem
)->car
) == Lisp_String
);
588 tem
= XCONS (tem
)->cdr
)
591 char *string
= (char *) XSTRING (XCONS (tem
)->car
)->data
;
592 /* See if this string duplicates any string already in the env.
593 If so, don't put it in.
594 When an env var has multiple definitions,
595 we keep the definition that comes first in process-environment. */
596 for (; ep
!= new_env
; ep
++)
598 char *p
= *ep
, *q
= string
;
602 /* The string is malformed; might as well drop it. */
617 /* Make sure that in, out, and err are not actually already in
618 descriptors zero, one, or two; this could happen if Emacs is
619 started with its standard in, out, or error closed, as might
621 in
= relocate_fd (in
, 3);
622 out
= relocate_fd (out
, 3);
623 err
= relocate_fd (err
, 3);
637 #ifndef SETPGRP_RELEASES_CTTY
638 setpgrp (); /* No arguments but equivalent in this case */
643 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
644 EMACS_SET_TTY_PGRP (0, &pid
);
647 something missing here
;
650 /* execvp does not accept an environment arg so the only way
651 to pass this environment is to set environ. Our caller
652 is responsible for restoring the ambient value of environ. */
654 execvp (new_argv
[0], new_argv
);
656 write (1, "Couldn't exec the program ", 26);
657 write (1, new_argv
[0], strlen (new_argv
[0]));
659 #endif /* not MSDOS */
662 /* Move the file descriptor FD so that its number is not less than MIN.
663 If the file descriptor is moved at all, the original is freed. */
665 relocate_fd (fd
, min
)
675 char *message1
= "Error while setting up child: ";
676 char *errmessage
= strerror (errno
);
677 char *message2
= "\n";
678 write (2, message1
, strlen (message1
));
679 write (2, errmessage
, strlen (errmessage
));
680 write (2, message2
, strlen (message2
));
683 /* Note that we hold the original FD open while we recurse,
684 to guarantee we'll get a new FD if we need it. */
685 new = relocate_fd (new, min
);
692 getenv_internal (var
, varlen
, value
, valuelen
)
700 for (scan
= Vprocess_environment
; CONSP (scan
); scan
= XCONS (scan
)->cdr
)
702 Lisp_Object entry
= XCONS (scan
)->car
;
704 if (XTYPE (entry
) == Lisp_String
705 && XSTRING (entry
)->size
> varlen
706 && XSTRING (entry
)->data
[varlen
] == '='
707 && ! bcmp (XSTRING (entry
)->data
, var
, varlen
))
709 *value
= (char *) XSTRING (entry
)->data
+ (varlen
+ 1);
710 *valuelen
= XSTRING (entry
)->size
- (varlen
+ 1);
718 DEFUN ("getenv", Fgetenv
, Sgetenv
, 1, 1, 0,
719 "Return the value of environment variable VAR, as a string.\n\
720 VAR should be a string. Value is nil if VAR is undefined in the environment.\n\
721 This function consults the variable ``process-environment'' for its value.")
728 CHECK_STRING (var
, 0);
729 if (getenv_internal (XSTRING (var
)->data
, XSTRING (var
)->size
,
731 return make_string (value
, valuelen
);
736 /* A version of getenv that consults process_environment, easily
745 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
))
753 /* This is run before init_cmdargs. */
757 char *data_dir
= egetenv ("EMACSDATA");
760 = Ffile_name_as_directory (build_string (data_dir
? data_dir
763 /* Check the EMACSPATH environment variable, defaulting to the
764 PATH_EXEC path from paths.h. */
765 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
766 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
767 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
770 /* This is run after init_cmdargs, so that Vinvocation_directory is valid. */
774 char *data_dir
= egetenv ("EMACSDATA");
779 if (initialized
&& !NILP (Vinvocation_directory
))
781 /* Add to the path the ../lib-src dir of the Emacs executable,
782 if that dir exists. */
783 Lisp_Object tem
, tem1
;
784 tem
= Fexpand_file_name (build_string ("../lib-src"),
785 Vinvocation_directory
);
786 tem1
= Ffile_exists_p (tem
);
787 if (!NILP (tem1
) && NILP (Fmember (tem
, Vexec_path
)))
789 Vexec_path
= nconc2 (Vexec_path
, Fcons (tem
, Qnil
));
790 Vexec_directory
= Ffile_name_as_directory (tem
);
792 /* If we use ../lib-src, maybe use ../etc as well.
793 Do so if ../etc exists and has our DOC-... file in it. */
796 Lisp_Object tem
, tem2
, tem3
;
797 tem
= Fexpand_file_name (build_string ("../etc"),
798 Vinvocation_directory
);
799 tem2
= Fexpand_file_name (Vdoc_file_name
, tem
);
800 tem3
= Ffile_exists_p (tem2
);
802 Vdata_directory
= Ffile_name_as_directory (tem
);
807 tempdir
= Fdirectory_file_name (Vexec_directory
);
808 if (access (XSTRING (tempdir
)->data
, 0) < 0)
810 printf ("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)
818 printf ("Warning: arch-independent data dir (%s) does not exist.\n",
819 XSTRING (Vdata_directory
)->data
);
824 Vshell_file_name
= build_string ("*dcl*");
826 sh
= (char *) getenv ("SHELL");
827 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
831 set_process_environment ()
833 register char **envp
;
835 Vprocess_environment
= Qnil
;
839 for (envp
= environ
; *envp
; envp
++)
840 Vprocess_environment
= Fcons (build_string (*envp
),
841 Vprocess_environment
);
847 DEFVAR_LISP ("binary-process", &Vbinary_process
,
848 "*If non-nil then new subprocesses are assumed to produce binary output.");
849 Vbinary_process
= Qnil
;
852 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
853 "*File name to load inferior shells from.\n\
854 Initialized from the SHELL environment variable.");
856 DEFVAR_LISP ("exec-path", &Vexec_path
,
857 "*List of directories to search programs to run in subprocesses.\n\
858 Each element is a string (directory name) or nil (try default directory).");
860 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
861 "Directory of architecture-dependent files that come with GNU Emacs,\n\
862 especially executable programs intended for Emacs to invoke.");
864 DEFVAR_LISP ("data-directory", &Vdata_directory
,
865 "Directory of architecture-independent files that come with GNU Emacs,\n\
866 intended for Emacs to use.");
868 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
869 "For internal use by the build procedure only.\n\
870 This is the name of the directory in which the build procedure installed\n\
871 Emacs's info files; the default value for Info-default-directory-list\n\
873 Vconfigure_info_directory
= build_string (PATH_INFO
);
875 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
876 "List of environment variables for subprocesses to inherit.\n\
877 Each element should be a string of the form ENVVARNAME=VALUE.\n\
878 The environment which Emacs inherits is placed in this variable\n\
879 when Emacs starts.");
882 defsubr (&Scall_process
);
885 defsubr (&Scall_process_region
);