]> code.delx.au - gnu-emacs/blob - src/callproc.c
Avoid extra multibyteness check in ENCODE_FILE users.
[gnu-emacs] / src / callproc.c
1 /* Synchronous subprocess invocation for GNU Emacs.
2
3 Copyright (C) 1985-1988, 1993-1995, 1999-2015 Free Software Foundation,
4 Inc.
5
6 This file is part of GNU Emacs.
7
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20
21
22 #include <config.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <sys/types.h>
26 #include <unistd.h>
27
28 #include <sys/file.h>
29 #include <fcntl.h>
30
31 #include "lisp.h"
32
33 #ifdef WINDOWSNT
34 #define NOMINMAX
35 #include <sys/socket.h> /* for fcntl */
36 #include <windows.h>
37 #include "w32.h"
38 #define _P_NOWAIT 1 /* from process.h */
39 #endif
40
41 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
42 #include <sys/stat.h>
43 #include <sys/param.h>
44 #endif /* MSDOS */
45
46 #include "commands.h"
47 #include "character.h"
48 #include "buffer.h"
49 #include "ccl.h"
50 #include "coding.h"
51 #include "composite.h"
52 #include <epaths.h>
53 #include "process.h"
54 #include "syssignal.h"
55 #include "systty.h"
56 #include "syswait.h"
57 #include "blockinput.h"
58 #include "frame.h"
59 #include "termhooks.h"
60
61 #ifdef MSDOS
62 #include "msdos.h"
63 #endif
64
65 #ifdef HAVE_NS
66 #include "nsterm.h"
67 #endif
68
69 /* Pattern used by call-process-region to make temp files. */
70 static Lisp_Object Vtemp_file_name_pattern;
71
72 /* The next two variables are used while record-unwind-protect is in place
73 during call-process for a subprocess for which record_deleted_pid has
74 not yet been called. At other times, synch_process_pid is zero and
75 synch_process_tempfile's contents are irrelevant. Doing this via static
76 C variables is more convenient than putting them into the arguments
77 of record-unwind-protect, as they need to be updated at randomish
78 times in the code, and Lisp cannot always store these values as
79 Emacs integers. It's safe to use static variables here, as the
80 code is never invoked reentrantly. */
81
82 /* If nonzero, a process-ID that has not been reaped. */
83 static pid_t synch_process_pid;
84
85 /* If a string, the name of a temp file that has not been removed. */
86 #ifdef MSDOS
87 static Lisp_Object synch_process_tempfile;
88 #else
89 # define synch_process_tempfile make_number (0)
90 #endif
91
92 /* Indexes of file descriptors that need closing on call_process_kill. */
93 enum
94 {
95 /* The subsidiary process's stdout and stderr. stdin is handled
96 separately, in either Fcall_process_region or create_temp_file. */
97 CALLPROC_STDOUT, CALLPROC_STDERR,
98
99 /* How to read from a pipe (or substitute) from the subsidiary process. */
100 CALLPROC_PIPEREAD,
101
102 /* A bound on the number of file descriptors. */
103 CALLPROC_FDS
104 };
105
106 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
107 \f
108 /* Return the current buffer's working directory, or the home
109 directory if it's unreachable, as a string suitable for a system call.
110 Signal an error if the result would not be an accessible directory. */
111
112 Lisp_Object
113 encode_current_directory (void)
114 {
115 Lisp_Object dir;
116 struct gcpro gcpro1;
117
118 dir = BVAR (current_buffer, directory);
119 GCPRO1 (dir);
120
121 dir = Funhandled_file_name_directory (dir);
122
123 /* If the file name handler says that dir is unreachable, use
124 a sensible default. */
125 if (NILP (dir))
126 dir = build_string ("~");
127
128 dir = expand_and_dir_to_file (dir, Qnil);
129
130 if (NILP (Ffile_accessible_directory_p (dir)))
131 report_file_error ("Setting current directory",
132 BVAR (current_buffer, directory));
133
134 /* Remove "/:" from dir. */
135 if (! NILP (Fstring_match (build_string ("^/:"), dir, Qnil)))
136 dir = Fsubstring (dir, make_number (2), Qnil);
137
138 dir = ENCODE_FILE (dir);
139 if (! file_accessible_directory_p (dir))
140 report_file_error ("Setting current directory",
141 BVAR (current_buffer, directory));
142
143 RETURN_UNGCPRO (dir);
144 }
145
146 /* If P is reapable, record it as a deleted process and kill it.
147 Do this in a critical section. Unless PID is wedged it will be
148 reaped on receipt of the first SIGCHLD after the critical section. */
149
150 void
151 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
152 {
153 #ifndef MSDOS
154 sigset_t oldset;
155 block_child_signal (&oldset);
156
157 if (p->alive)
158 {
159 record_deleted_pid (p->pid, tempfile);
160 p->alive = 0;
161 kill (- p->pid, SIGKILL);
162 }
163
164 unblock_child_signal (&oldset);
165 #endif /* !MSDOS */
166 }
167
168 /* Clean up files, file descriptors and processes created by Fcall_process. */
169
170 static void
171 delete_temp_file (Lisp_Object name)
172 {
173 unlink (SSDATA (name));
174 }
175
176 static void
177 call_process_kill (void *ptr)
178 {
179 int *callproc_fd = ptr;
180 int i;
181 for (i = 0; i < CALLPROC_FDS; i++)
182 if (0 <= callproc_fd[i])
183 emacs_close (callproc_fd[i]);
184
185 if (synch_process_pid)
186 {
187 struct Lisp_Process proc;
188 proc.alive = 1;
189 proc.pid = synch_process_pid;
190 record_kill_process (&proc, synch_process_tempfile);
191 synch_process_pid = 0;
192 }
193 else if (STRINGP (synch_process_tempfile))
194 delete_temp_file (synch_process_tempfile);
195 }
196
197 /* Clean up when exiting Fcall_process: restore the buffer, and
198 kill the subsidiary process group if the process still exists. */
199
200 static void
201 call_process_cleanup (Lisp_Object buffer)
202 {
203 Fset_buffer (buffer);
204
205 #ifndef MSDOS
206 if (synch_process_pid)
207 {
208 kill (-synch_process_pid, SIGINT);
209 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
210 immediate_quit = 1;
211 QUIT;
212 wait_for_termination (synch_process_pid, 0, 1);
213 synch_process_pid = 0;
214 immediate_quit = 0;
215 message1 ("Waiting for process to die...done");
216 }
217 #endif /* !MSDOS */
218 }
219
220 #ifdef DOS_NT
221 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
222 #else
223 static mode_t const default_output_mode = 0666;
224 #endif
225
226 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
227 doc: /* Call PROGRAM synchronously in separate process.
228 The remaining arguments are optional.
229 The program's input comes from file INFILE (nil means `/dev/null').
230 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
231 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
232 FILE is a file name string, means that it should be written to that file
233 \(if the file already exists it is overwritten).
234 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
235 REAL-BUFFER says what to do with standard output, as above,
236 while STDERR-FILE says what to do with standard error in the child.
237 STDERR-FILE may be nil (discard standard error output),
238 t (mix it with ordinary output), or a file name string.
239
240 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
241 Remaining arguments are strings passed as command arguments to PROGRAM.
242
243 If executable PROGRAM can't be found as an executable, `call-process'
244 signals a Lisp error. `call-process' reports errors in execution of
245 the program only through its return and output.
246
247 If DESTINATION is 0, `call-process' returns immediately with value nil.
248 Otherwise it waits for PROGRAM to terminate
249 and returns a numeric exit status or a signal description string.
250 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
251
252 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
253 (ptrdiff_t nargs, Lisp_Object *args)
254 {
255 Lisp_Object infile, encoded_infile;
256 int filefd;
257 struct gcpro gcpro1;
258 ptrdiff_t count = SPECPDL_INDEX ();
259
260 if (nargs >= 2 && ! NILP (args[1]))
261 {
262 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
263 CHECK_STRING (infile);
264 }
265 else
266 infile = build_string (NULL_DEVICE);
267
268 GCPRO1 (infile);
269 encoded_infile = ENCODE_FILE (infile);
270
271 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
272 if (filefd < 0)
273 report_file_error ("Opening process input file", infile);
274 record_unwind_protect_int (close_file_unwind, filefd);
275 UNGCPRO;
276 return unbind_to (count, call_process (nargs, args, filefd, -1));
277 }
278
279 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
280
281 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
282 unwinder that is intended to remove the input temporary file; in
283 this case NARGS must be at least 2 and ARGS[1] is the file's name.
284
285 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
286
287 static Lisp_Object
288 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
289 ptrdiff_t tempfile_index)
290 {
291 Lisp_Object buffer, current_dir, path;
292 bool display_p;
293 int fd0;
294 int callproc_fd[CALLPROC_FDS];
295 int status;
296 ptrdiff_t i;
297 ptrdiff_t count = SPECPDL_INDEX ();
298 USE_SAFE_ALLOCA;
299
300 char **new_argv;
301 /* File to use for stderr in the child.
302 t means use same as standard output. */
303 Lisp_Object error_file;
304 Lisp_Object output_file = Qnil;
305 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
306 char *tempfile = NULL;
307 int pid;
308 #else
309 sigset_t oldset;
310 pid_t pid;
311 #endif
312 int child_errno;
313 int fd_output, fd_error;
314 struct coding_system process_coding; /* coding-system of process output */
315 struct coding_system argument_coding; /* coding-system of arguments */
316 /* Set to the return value of Ffind_operation_coding_system. */
317 Lisp_Object coding_systems;
318 bool discard_output;
319
320 if (synch_process_pid)
321 error ("call-process invoked recursively");
322
323 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
324 coding_systems = Qt;
325
326 CHECK_STRING (args[0]);
327
328 error_file = Qt;
329
330 #ifndef subprocesses
331 /* Without asynchronous processes we cannot have BUFFER == 0. */
332 if (nargs >= 3
333 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
334 error ("Operating system cannot handle asynchronous subprocesses");
335 #endif /* subprocesses */
336
337 /* Decide the coding-system for giving arguments. */
338 {
339 Lisp_Object val, *args2;
340
341 /* If arguments are supplied, we may have to encode them. */
342 if (nargs >= 5)
343 {
344 bool must_encode = 0;
345 Lisp_Object coding_attrs;
346
347 for (i = 4; i < nargs; i++)
348 CHECK_STRING (args[i]);
349
350 for (i = 4; i < nargs; i++)
351 if (STRING_MULTIBYTE (args[i]))
352 must_encode = 1;
353
354 if (!NILP (Vcoding_system_for_write))
355 val = Vcoding_system_for_write;
356 else if (! must_encode)
357 val = Qraw_text;
358 else
359 {
360 SAFE_NALLOCA (args2, 1, nargs + 1);
361 args2[0] = Qcall_process;
362 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
363 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
364 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
365 }
366 val = complement_process_encoding_system (val);
367 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
368 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
369 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
370 {
371 /* We should not use an ASCII incompatible coding system. */
372 val = raw_text_coding_system (val);
373 setup_coding_system (val, &argument_coding);
374 }
375 }
376 }
377
378 if (nargs < 3)
379 buffer = Qnil;
380 else
381 {
382 buffer = args[2];
383
384 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
385 FILE-FOR-STDERR), unless the first element is :file, in which case see
386 the next paragraph. */
387 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
388 {
389 if (CONSP (XCDR (buffer)))
390 {
391 Lisp_Object stderr_file;
392 stderr_file = XCAR (XCDR (buffer));
393
394 if (NILP (stderr_file) || EQ (Qt, stderr_file))
395 error_file = stderr_file;
396 else
397 error_file = Fexpand_file_name (stderr_file, Qnil);
398 }
399
400 buffer = XCAR (buffer);
401 }
402
403 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
404 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
405 {
406 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
407 BVAR (current_buffer, directory));
408 CHECK_STRING (output_file);
409 buffer = Qnil;
410 }
411
412 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
413 {
414 Lisp_Object spec_buffer;
415 spec_buffer = buffer;
416 buffer = Fget_buffer_create (buffer);
417 /* Mention the buffer name for a better error message. */
418 if (NILP (buffer))
419 CHECK_BUFFER (spec_buffer);
420 CHECK_BUFFER (buffer);
421 }
422 }
423
424 /* Make sure that the child will be able to chdir to the current
425 buffer's current directory, or its unhandled equivalent. We
426 can't just have the child check for an error when it does the
427 chdir, since it's in a vfork.
428
429 We have to GCPRO around this because Fexpand_file_name,
430 Funhandled_file_name_directory, and Ffile_accessible_directory_p
431 might call a file name handling function. The argument list is
432 protected by the caller, so all we really have to worry about is
433 buffer. */
434 {
435 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
436
437 current_dir = encode_current_directory ();
438
439 GCPRO4 (buffer, current_dir, error_file, output_file);
440
441 if (STRINGP (error_file))
442 error_file = ENCODE_FILE (error_file);
443 if (STRINGP (output_file))
444 output_file = ENCODE_FILE (output_file);
445 UNGCPRO;
446 }
447
448 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
449
450 for (i = 0; i < CALLPROC_FDS; i++)
451 callproc_fd[i] = -1;
452 #ifdef MSDOS
453 synch_process_tempfile = make_number (0);
454 #endif
455 record_unwind_protect_ptr (call_process_kill, callproc_fd);
456
457 /* Search for program; barf if not found. */
458 {
459 struct gcpro gcpro1, gcpro2, gcpro3;
460 int ok;
461
462 GCPRO3 (buffer, current_dir, error_file);
463 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
464 make_number (X_OK), false);
465 UNGCPRO;
466 if (ok < 0)
467 report_file_error ("Searching for program", args[0]);
468 }
469
470 /* If program file name starts with /: for quoting a magic name,
471 discard that. */
472 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
473 && SREF (path, 1) == ':')
474 path = Fsubstring (path, make_number (2), Qnil);
475
476 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
477
478 {
479 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
480
481 GCPRO4 (buffer, current_dir, path, error_file);
482 if (nargs > 4)
483 {
484 ptrdiff_t i;
485
486 argument_coding.dst_multibyte = 0;
487 for (i = 4; i < nargs; i++)
488 {
489 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
490 if (CODING_REQUIRE_ENCODING (&argument_coding))
491 /* We must encode this argument. */
492 args[i] = encode_coding_string (&argument_coding, args[i], 1);
493 }
494 for (i = 4; i < nargs; i++)
495 new_argv[i - 3] = SSDATA (args[i]);
496 new_argv[i - 3] = 0;
497 }
498 else
499 new_argv[1] = 0;
500 path = ENCODE_FILE (path);
501 new_argv[0] = SSDATA (path);
502 UNGCPRO;
503 }
504
505 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
506
507 #ifdef MSDOS
508 if (! discard_output && ! STRINGP (output_file))
509 {
510 char const *tmpdir = egetenv ("TMPDIR");
511 char const *outf = tmpdir ? tmpdir : "";
512 tempfile = alloca (strlen (outf) + 20);
513 strcpy (tempfile, outf);
514 dostounix_filename (tempfile);
515 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
516 strcat (tempfile, "/");
517 strcat (tempfile, "emXXXXXX");
518 mktemp (tempfile);
519 if (!*tempfile)
520 report_file_error ("Opening process output file", Qnil);
521 output_file = build_string (tempfile);
522 synch_process_tempfile = output_file;
523 }
524 #endif
525
526 if (discard_output)
527 {
528 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
529 if (fd_output < 0)
530 report_file_error ("Opening null device", Qnil);
531 }
532 else if (STRINGP (output_file))
533 {
534 fd_output = emacs_open (SSDATA (output_file),
535 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
536 default_output_mode);
537 if (fd_output < 0)
538 {
539 int open_errno = errno;
540 output_file = DECODE_FILE (output_file);
541 report_file_errno ("Opening process output file",
542 output_file, open_errno);
543 }
544 }
545 else
546 {
547 int fd[2];
548 if (emacs_pipe (fd) != 0)
549 report_file_error ("Creating process pipe", Qnil);
550 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
551 fd_output = fd[1];
552 }
553 callproc_fd[CALLPROC_STDOUT] = fd_output;
554
555 fd_error = fd_output;
556
557 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
558 {
559 fd_error = emacs_open ((STRINGP (error_file)
560 ? SSDATA (error_file)
561 : NULL_DEVICE),
562 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
563 default_output_mode);
564 if (fd_error < 0)
565 {
566 int open_errno = errno;
567 report_file_errno ("Cannot redirect stderr",
568 (STRINGP (error_file)
569 ? DECODE_FILE (error_file)
570 : build_string (NULL_DEVICE)),
571 open_errno);
572 }
573 callproc_fd[CALLPROC_STDERR] = fd_error;
574 }
575
576 #ifdef MSDOS /* MW, July 1993 */
577 /* Note that on MSDOS `child_setup' actually returns the child process
578 exit status, not its PID, so assign it to status below. */
579 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
580
581 if (pid < 0)
582 {
583 child_errno = errno;
584 unbind_to (count, Qnil);
585 synchronize_system_messages_locale ();
586 return
587 code_convert_string_norecord (build_string (strerror (child_errno)),
588 Vlocale_coding_system, 0);
589 }
590 status = pid;
591
592 for (i = 0; i < CALLPROC_FDS; i++)
593 if (0 <= callproc_fd[i])
594 {
595 emacs_close (callproc_fd[i]);
596 callproc_fd[i] = -1;
597 }
598 emacs_close (filefd);
599 clear_unwind_protect (count - 1);
600
601 if (tempfile)
602 {
603 /* Since CRLF is converted to LF within `decode_coding', we
604 can always open a file with binary mode. */
605 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile,
606 O_RDONLY | O_BINARY, 0);
607 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
608 {
609 int open_errno = errno;
610 report_file_errno ("Cannot re-open temporary file",
611 build_string (tempfile), open_errno);
612 }
613 }
614
615 #endif /* MSDOS */
616
617 /* Do the unwind-protect now, even though the pid is not known, so
618 that no storage allocation is done in the critical section.
619 The actual PID will be filled in during the critical section. */
620 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
621
622 #ifndef MSDOS
623
624 block_input ();
625 block_child_signal (&oldset);
626
627 #ifdef WINDOWSNT
628 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
629 #else /* not WINDOWSNT */
630
631 /* vfork, and prevent local vars from being clobbered by the vfork. */
632 {
633 Lisp_Object volatile buffer_volatile = buffer;
634 Lisp_Object volatile coding_systems_volatile = coding_systems;
635 Lisp_Object volatile current_dir_volatile = current_dir;
636 bool volatile display_p_volatile = display_p;
637 bool volatile sa_must_free_volatile = sa_must_free;
638 int volatile fd_error_volatile = fd_error;
639 int volatile filefd_volatile = filefd;
640 ptrdiff_t volatile count_volatile = count;
641 ptrdiff_t volatile sa_avail_volatile = sa_avail;
642 ptrdiff_t volatile sa_count_volatile = sa_count;
643 char **volatile new_argv_volatile = new_argv;
644 int volatile callproc_fd_volatile[CALLPROC_FDS];
645 for (i = 0; i < CALLPROC_FDS; i++)
646 callproc_fd_volatile[i] = callproc_fd[i];
647
648 pid = vfork ();
649
650 buffer = buffer_volatile;
651 coding_systems = coding_systems_volatile;
652 current_dir = current_dir_volatile;
653 display_p = display_p_volatile;
654 sa_must_free = sa_must_free_volatile;
655 fd_error = fd_error_volatile;
656 filefd = filefd_volatile;
657 count = count_volatile;
658 sa_avail = sa_avail_volatile;
659 sa_count = sa_count_volatile;
660 new_argv = new_argv_volatile;
661
662 for (i = 0; i < CALLPROC_FDS; i++)
663 callproc_fd[i] = callproc_fd_volatile[i];
664 fd_output = callproc_fd[CALLPROC_STDOUT];
665 }
666
667 if (pid == 0)
668 {
669 unblock_child_signal (&oldset);
670
671 setsid ();
672
673 /* Emacs ignores SIGPIPE, but the child should not. */
674 signal (SIGPIPE, SIG_DFL);
675 /* Likewise for SIGPROF. */
676 #ifdef SIGPROF
677 signal (SIGPROF, SIG_DFL);
678 #endif
679
680 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
681 }
682
683 #endif /* not WINDOWSNT */
684
685 child_errno = errno;
686
687 if (pid > 0)
688 {
689 synch_process_pid = pid;
690
691 if (INTEGERP (buffer))
692 {
693 if (tempfile_index < 0)
694 record_deleted_pid (pid, Qnil);
695 else
696 {
697 eassert (1 < nargs);
698 record_deleted_pid (pid, args[1]);
699 clear_unwind_protect (tempfile_index);
700 }
701 synch_process_pid = 0;
702 }
703 }
704
705 unblock_child_signal (&oldset);
706 unblock_input ();
707
708 if (pid < 0)
709 report_file_errno ("Doing vfork", Qnil, child_errno);
710
711 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
712 since we will use that to read input from. */
713 for (i = 0; i < CALLPROC_FDS; i++)
714 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
715 {
716 emacs_close (callproc_fd[i]);
717 callproc_fd[i] = -1;
718 }
719 emacs_close (filefd);
720 clear_unwind_protect (count - 1);
721
722 #endif /* not MSDOS */
723
724 if (INTEGERP (buffer))
725 return unbind_to (count, Qnil);
726
727 if (BUFFERP (buffer))
728 Fset_buffer (buffer);
729
730 fd0 = callproc_fd[CALLPROC_PIPEREAD];
731
732 if (0 <= fd0)
733 {
734 Lisp_Object val, *args2;
735
736 val = Qnil;
737 if (!NILP (Vcoding_system_for_read))
738 val = Vcoding_system_for_read;
739 else
740 {
741 if (EQ (coding_systems, Qt))
742 {
743 ptrdiff_t i;
744
745 SAFE_NALLOCA (args2, 1, nargs + 1);
746 args2[0] = Qcall_process;
747 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
748 coding_systems
749 = Ffind_operation_coding_system (nargs + 1, args2);
750 }
751 if (CONSP (coding_systems))
752 val = XCAR (coding_systems);
753 else if (CONSP (Vdefault_process_coding_system))
754 val = XCAR (Vdefault_process_coding_system);
755 else
756 val = Qnil;
757 }
758 Fcheck_coding_system (val);
759 /* In unibyte mode, character code conversion should not take
760 place but EOL conversion should. So, setup raw-text or one
761 of the subsidiary according to the information just setup. */
762 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
763 && !NILP (val))
764 val = raw_text_coding_system (val);
765 setup_coding_system (val, &process_coding);
766 process_coding.dst_multibyte
767 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
768 process_coding.src_multibyte = 0;
769 }
770
771 immediate_quit = 1;
772 QUIT;
773
774 if (0 <= fd0)
775 {
776 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
777 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
778 char buf[CALLPROC_BUFFER_SIZE_MAX];
779 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
780 int nread;
781 EMACS_INT total_read = 0;
782 int carryover = 0;
783 bool display_on_the_fly = display_p;
784 struct coding_system saved_coding = process_coding;
785
786 while (1)
787 {
788 /* Repeatedly read until we've filled as much as possible
789 of the buffer size we have. But don't read
790 less than 1024--save that for the next bufferful. */
791 nread = carryover;
792 while (nread < bufsize - 1024)
793 {
794 int this_read = emacs_read (fd0, buf + nread,
795 bufsize - nread);
796
797 if (this_read < 0)
798 goto give_up;
799
800 if (this_read == 0)
801 {
802 process_coding.mode |= CODING_MODE_LAST_BLOCK;
803 break;
804 }
805
806 nread += this_read;
807 total_read += this_read;
808
809 if (display_on_the_fly)
810 break;
811 }
812
813 /* Now NREAD is the total amount of data in the buffer. */
814 immediate_quit = 0;
815
816 if (!nread)
817 ;
818 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
819 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
820 insert_1_both (buf, nread, nread, 0, 1, 0);
821 else
822 { /* We have to decode the input. */
823 Lisp_Object curbuf;
824 ptrdiff_t count1 = SPECPDL_INDEX ();
825
826 XSETBUFFER (curbuf, current_buffer);
827 /* FIXME: Call signal_after_change! */
828 prepare_to_modify_buffer (PT, PT, NULL);
829 /* We cannot allow after-change-functions be run
830 during decoding, because that might modify the
831 buffer, while we rely on process_coding.produced to
832 faithfully reflect inserted text until we
833 TEMP_SET_PT_BOTH below. */
834 specbind (Qinhibit_modification_hooks, Qt);
835 decode_coding_c_string (&process_coding,
836 (unsigned char *) buf, nread, curbuf);
837 unbind_to (count1, Qnil);
838 if (display_on_the_fly
839 && CODING_REQUIRE_DETECTION (&saved_coding)
840 && ! CODING_REQUIRE_DETECTION (&process_coding))
841 {
842 /* We have detected some coding system, but the
843 detection may have been via insufficient data.
844 So give up displaying on the fly. */
845 if (process_coding.produced > 0)
846 del_range_2 (process_coding.dst_pos,
847 process_coding.dst_pos_byte,
848 (process_coding.dst_pos
849 + process_coding.produced_char),
850 (process_coding.dst_pos_byte
851 + process_coding.produced),
852 0);
853 display_on_the_fly = false;
854 process_coding = saved_coding;
855 carryover = nread;
856 /* Make the above condition always fail in the future. */
857 saved_coding.common_flags
858 &= ~CODING_REQUIRE_DETECTION_MASK;
859 continue;
860 }
861
862 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
863 PT_BYTE + process_coding.produced);
864 carryover = process_coding.carryover_bytes;
865 if (carryover > 0)
866 memcpy (buf, process_coding.carryover,
867 process_coding.carryover_bytes);
868 }
869
870 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
871 break;
872
873 /* Make the buffer bigger as we continue to read more data,
874 but not past CALLPROC_BUFFER_SIZE_MAX. */
875 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
876 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
877 bufsize = CALLPROC_BUFFER_SIZE_MAX;
878
879 if (display_p)
880 {
881 redisplay_preserve_echo_area (1);
882 /* This variable might have been set to 0 for code
883 detection. In that case, set it back to 1 because
884 we should have already detected a coding system. */
885 display_on_the_fly = true;
886 }
887 immediate_quit = true;
888 QUIT;
889 }
890 give_up: ;
891
892 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
893 /* If the caller required, let the buffer inherit the
894 coding-system used to decode the process output. */
895 if (inherit_process_coding_system)
896 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
897 make_number (total_read));
898 }
899
900 #ifndef MSDOS
901 /* Wait for it to terminate, unless it already has. */
902 wait_for_termination (pid, &status, fd0 < 0);
903 #endif
904
905 immediate_quit = 0;
906
907 /* Don't kill any children that the subprocess may have left behind
908 when exiting. */
909 synch_process_pid = 0;
910
911 SAFE_FREE ();
912 unbind_to (count, Qnil);
913
914 if (WIFSIGNALED (status))
915 {
916 const char *signame;
917
918 synchronize_system_messages_locale ();
919 signame = strsignal (WTERMSIG (status));
920
921 if (signame == 0)
922 signame = "unknown";
923
924 return code_convert_string_norecord (build_string (signame),
925 Vlocale_coding_system, 0);
926 }
927
928 eassert (WIFEXITED (status));
929 return make_number (WEXITSTATUS (status));
930 }
931 \f
932 /* Create a temporary file suitable for storing the input data of
933 call-process-region. NARGS and ARGS are the same as for
934 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
935 naming the file, and return a file descriptor for reading.
936 Unwind-protect the file, so that the file descriptor will be closed
937 and the file removed when the caller unwinds the specpdl stack. */
938
939 static int
940 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
941 Lisp_Object *filename_string_ptr)
942 {
943 int fd;
944 struct gcpro gcpro1;
945 Lisp_Object filename_string;
946 Lisp_Object val, start, end;
947 Lisp_Object tmpdir;
948
949 if (STRINGP (Vtemporary_file_directory))
950 tmpdir = Vtemporary_file_directory;
951 else
952 {
953 char *outf;
954 #ifndef DOS_NT
955 outf = getenv ("TMPDIR");
956 tmpdir = build_string (outf ? outf : "/tmp/");
957 #else /* DOS_NT */
958 if ((outf = egetenv ("TMPDIR"))
959 || (outf = egetenv ("TMP"))
960 || (outf = egetenv ("TEMP")))
961 tmpdir = build_string (outf);
962 else
963 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
964 #endif
965 }
966
967 {
968 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
969 char *tempfile;
970 ptrdiff_t count;
971
972 #ifdef WINDOWSNT
973 /* Cannot use the result of Fexpand_file_name, because it
974 downcases the XXXXXX part of the pattern, and mktemp then
975 doesn't recognize it. */
976 if (!NILP (Vw32_downcase_file_names))
977 {
978 Lisp_Object dirname = Ffile_name_directory (pattern);
979
980 if (NILP (dirname))
981 pattern = Vtemp_file_name_pattern;
982 else
983 pattern = concat2 (dirname, Vtemp_file_name_pattern);
984 }
985 #endif
986
987 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
988 GCPRO1 (filename_string);
989 tempfile = SSDATA (filename_string);
990
991 count = SPECPDL_INDEX ();
992 record_unwind_protect_nothing ();
993 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
994 if (fd < 0)
995 report_file_error ("Failed to open temporary file using pattern",
996 pattern);
997 set_unwind_protect (count, delete_temp_file, filename_string);
998 record_unwind_protect_int (close_file_unwind, fd);
999 }
1000
1001 start = args[0];
1002 end = args[1];
1003 /* Decide coding-system of the contents of the temporary file. */
1004 if (!NILP (Vcoding_system_for_write))
1005 val = Vcoding_system_for_write;
1006 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1007 val = Qraw_text;
1008 else
1009 {
1010 Lisp_Object coding_systems;
1011 Lisp_Object *args2;
1012 USE_SAFE_ALLOCA;
1013 SAFE_NALLOCA (args2, 1, nargs + 1);
1014 args2[0] = Qcall_process_region;
1015 memcpy (args2 + 1, args, nargs * sizeof *args);
1016 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1017 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1018 SAFE_FREE ();
1019 }
1020 val = complement_process_encoding_system (val);
1021
1022 {
1023 ptrdiff_t count1 = SPECPDL_INDEX ();
1024
1025 specbind (intern ("coding-system-for-write"), val);
1026 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1027 happen to get a ".Z" suffix. */
1028 specbind (intern ("file-name-handler-alist"), Qnil);
1029 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
1030
1031 unbind_to (count1, Qnil);
1032 }
1033
1034 if (lseek (fd, 0, SEEK_SET) < 0)
1035 report_file_error ("Setting file position", filename_string);
1036
1037 /* Note that Fcall_process takes care of binding
1038 coding-system-for-read. */
1039
1040 *filename_string_ptr = filename_string;
1041 UNGCPRO;
1042 return fd;
1043 }
1044
1045 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1046 3, MANY, 0,
1047 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1048 The remaining arguments are optional.
1049 Delete the text if fourth arg DELETE is non-nil.
1050
1051 Insert output in BUFFER before point; t means current buffer; nil for
1052 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1053 FILE)', where FILE is a file name string, means that it should be
1054 written to that file (if the file already exists it is overwritten).
1055 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1056 REAL-BUFFER says what to do with standard output, as above,
1057 while STDERR-FILE says what to do with standard error in the child.
1058 STDERR-FILE may be nil (discard standard error output),
1059 t (mix it with ordinary output), or a file name string.
1060
1061 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1062 Remaining args are passed to PROGRAM at startup as command args.
1063
1064 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1065 Otherwise it waits for PROGRAM to terminate
1066 and returns a numeric exit status or a signal description string.
1067 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1068
1069 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1070 (ptrdiff_t nargs, Lisp_Object *args)
1071 {
1072 struct gcpro gcpro1;
1073 Lisp_Object infile, val;
1074 ptrdiff_t count = SPECPDL_INDEX ();
1075 Lisp_Object start = args[0];
1076 Lisp_Object end = args[1];
1077 bool empty_input;
1078 int fd;
1079
1080 if (STRINGP (start))
1081 empty_input = SCHARS (start) == 0;
1082 else if (NILP (start))
1083 empty_input = BEG == Z;
1084 else
1085 {
1086 validate_region (&args[0], &args[1]);
1087 start = args[0];
1088 end = args[1];
1089 empty_input = XINT (start) == XINT (end);
1090 }
1091
1092 if (!empty_input)
1093 fd = create_temp_file (nargs, args, &infile);
1094 else
1095 {
1096 infile = Qnil;
1097 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1098 if (fd < 0)
1099 report_file_error ("Opening null device", Qnil);
1100 record_unwind_protect_int (close_file_unwind, fd);
1101 }
1102
1103 GCPRO1 (infile);
1104
1105 if (nargs > 3 && !NILP (args[3]))
1106 Fdelete_region (start, end);
1107
1108 if (nargs > 3)
1109 {
1110 args += 2;
1111 nargs -= 2;
1112 }
1113 else
1114 {
1115 args[0] = args[2];
1116 nargs = 2;
1117 }
1118 args[1] = infile;
1119
1120 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1121 RETURN_UNGCPRO (unbind_to (count, val));
1122 }
1123 \f
1124 #ifndef WINDOWSNT
1125 static int relocate_fd (int fd, int minfd);
1126 #endif
1127
1128 static char **
1129 add_env (char **env, char **new_env, char *string)
1130 {
1131 char **ep;
1132 bool ok = 1;
1133 if (string == NULL)
1134 return new_env;
1135
1136 /* See if this string duplicates any string already in the env.
1137 If so, don't put it in.
1138 When an env var has multiple definitions,
1139 we keep the definition that comes first in process-environment. */
1140 for (ep = env; ok && ep != new_env; ep++)
1141 {
1142 char *p = *ep, *q = string;
1143 while (ok)
1144 {
1145 if (*q != *p)
1146 break;
1147 if (*q == 0)
1148 /* The string is a lone variable name; keep it for now, we
1149 will remove it later. It is a placeholder for a
1150 variable that is not to be included in the environment. */
1151 break;
1152 if (*q == '=')
1153 ok = 0;
1154 p++, q++;
1155 }
1156 }
1157 if (ok)
1158 *new_env++ = string;
1159 return new_env;
1160 }
1161
1162 #ifndef DOS_NT
1163
1164 /* 'exec' failed inside a child running NAME, with error number ERR.
1165 Possibly a vforked child needed to allocate a large vector on the
1166 stack; such a child cannot fall back on malloc because that might
1167 mess up the allocator's data structures in the parent.
1168 Report the error and exit the child. */
1169
1170 static _Noreturn void
1171 exec_failed (char const *name, int err)
1172 {
1173 /* Avoid deadlock if the child's perror writes to a full pipe; the
1174 pipe's reader is the parent, but with vfork the parent can't
1175 run until the child exits. Truncate the diagnostic instead. */
1176 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1177
1178 errno = err;
1179 emacs_perror (name);
1180 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1181 }
1182
1183 #else
1184
1185 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1186 fork and exec, and handle alloca exhaustion in a different way. */
1187
1188 static void
1189 exec_failed (char const *name, int err)
1190 {
1191 }
1192
1193 #endif
1194
1195 /* This is the last thing run in a newly forked inferior
1196 either synchronous or asynchronous.
1197 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1198 Initialize inferior's priority, pgrp, connected dir and environment.
1199 then exec another program based on new_argv.
1200
1201 If SET_PGRP, put the subprocess into a separate process group.
1202
1203 CURRENT_DIR is an elisp string giving the path of the current
1204 directory the subprocess should have. Since we can't really signal
1205 a decent error from within the child, this should be verified as an
1206 executable directory by the parent. */
1207
1208 int
1209 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1210 Lisp_Object current_dir)
1211 {
1212 char **env;
1213 char *pwd_var;
1214 #ifdef WINDOWSNT
1215 int cpid;
1216 HANDLE handles[3];
1217 #else
1218 pid_t pid = getpid ();
1219 #endif /* WINDOWSNT */
1220
1221 /* Note that use of alloca is always safe here. It's obvious for systems
1222 that do not have true vfork or that have true (stack) alloca.
1223 If using vfork and C_ALLOCA (when Emacs used to include
1224 src/alloca.c) it is safe because that changes the superior's
1225 static variables as if the superior had done alloca and will be
1226 cleaned up in the usual way. */
1227 {
1228 char *temp;
1229 ptrdiff_t i;
1230
1231 i = SBYTES (current_dir);
1232 #ifdef MSDOS
1233 /* MSDOS must have all environment variables malloc'ed, because
1234 low-level libc functions that launch subsidiary processes rely
1235 on that. */
1236 pwd_var = xmalloc (i + 5);
1237 #else
1238 if (MAX_ALLOCA - 5 < i)
1239 exec_failed (new_argv[0], ENOMEM);
1240 pwd_var = alloca (i + 5);
1241 #endif
1242 temp = pwd_var + 4;
1243 memcpy (pwd_var, "PWD=", 4);
1244 lispstpcpy (temp, current_dir);
1245
1246 #ifndef DOS_NT
1247 /* We can't signal an Elisp error here; we're in a vfork. Since
1248 the callers check the current directory before forking, this
1249 should only return an error if the directory's permissions
1250 are changed between the check and this chdir, but we should
1251 at least check. */
1252 if (chdir (temp) < 0)
1253 _exit (EXIT_CANCELED);
1254 #else /* DOS_NT */
1255 /* Get past the drive letter, so that d:/ is left alone. */
1256 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1257 {
1258 temp += 2;
1259 i -= 2;
1260 }
1261 #endif /* DOS_NT */
1262
1263 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1264 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1265 temp[--i] = 0;
1266 }
1267
1268 /* Set `env' to a vector of the strings in the environment. */
1269 {
1270 register Lisp_Object tem;
1271 register char **new_env;
1272 char **p, **q;
1273 register int new_length;
1274 Lisp_Object display = Qnil;
1275
1276 new_length = 0;
1277
1278 for (tem = Vprocess_environment;
1279 CONSP (tem) && STRINGP (XCAR (tem));
1280 tem = XCDR (tem))
1281 {
1282 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1283 && (SDATA (XCAR (tem)) [7] == '\0'
1284 || SDATA (XCAR (tem)) [7] == '='))
1285 /* DISPLAY is specified in process-environment. */
1286 display = Qt;
1287 new_length++;
1288 }
1289
1290 /* If not provided yet, use the frame's DISPLAY. */
1291 if (NILP (display))
1292 {
1293 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1294 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1295 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1296 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1297 Vinitial_environment);
1298 if (STRINGP (tmp))
1299 {
1300 display = tmp;
1301 new_length++;
1302 }
1303 }
1304
1305 /* new_length + 2 to include PWD and terminating 0. */
1306 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1307 exec_failed (new_argv[0], ENOMEM);
1308 env = new_env = alloca ((new_length + 2) * sizeof *env);
1309 /* If we have a PWD envvar, pass one down,
1310 but with corrected value. */
1311 if (egetenv ("PWD"))
1312 *new_env++ = pwd_var;
1313
1314 if (STRINGP (display))
1315 {
1316 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1317 exec_failed (new_argv[0], ENOMEM);
1318 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1319 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1320 new_env = add_env (env, new_env, vdata);
1321 }
1322
1323 /* Overrides. */
1324 for (tem = Vprocess_environment;
1325 CONSP (tem) && STRINGP (XCAR (tem));
1326 tem = XCDR (tem))
1327 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1328
1329 *new_env = 0;
1330
1331 /* Remove variable names without values. */
1332 p = q = env;
1333 while (*p != 0)
1334 {
1335 while (*q != 0 && strchr (*q, '=') == NULL)
1336 q++;
1337 *p = *q++;
1338 if (*p != 0)
1339 p++;
1340 }
1341 }
1342
1343
1344 #ifdef WINDOWSNT
1345 prepare_standard_handles (in, out, err, handles);
1346 set_process_dir (SDATA (current_dir));
1347 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1348 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1349 reset_standard_handles (in, out, err, handles);
1350 if (cpid == -1)
1351 /* An error occurred while trying to spawn the process. */
1352 report_file_error ("Spawning child process", Qnil);
1353 return cpid;
1354
1355 #else /* not WINDOWSNT */
1356 /* Make sure that in, out, and err are not actually already in
1357 descriptors zero, one, or two; this could happen if Emacs is
1358 started with its standard in, out, or error closed, as might
1359 happen under X. */
1360 {
1361 int oin = in, oout = out;
1362
1363 /* We have to avoid relocating the same descriptor twice! */
1364
1365 in = relocate_fd (in, 3);
1366
1367 if (out == oin)
1368 out = in;
1369 else
1370 out = relocate_fd (out, 3);
1371
1372 if (err == oin)
1373 err = in;
1374 else if (err == oout)
1375 err = out;
1376 else
1377 err = relocate_fd (err, 3);
1378 }
1379
1380 #ifndef MSDOS
1381 /* Redirect file descriptors and clear the close-on-exec flag on the
1382 redirected ones. IN, OUT, and ERR are close-on-exec so they
1383 need not be closed explicitly. */
1384 dup2 (in, 0);
1385 dup2 (out, 1);
1386 dup2 (err, 2);
1387
1388 setpgid (0, 0);
1389 tcsetpgrp (0, pid);
1390
1391 execve (new_argv[0], new_argv, env);
1392 exec_failed (new_argv[0], errno);
1393
1394 #else /* MSDOS */
1395 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1396 xfree (pwd_var);
1397 if (pid == -1)
1398 /* An error occurred while trying to run the subprocess. */
1399 report_file_error ("Spawning child process", Qnil);
1400 return pid;
1401 #endif /* MSDOS */
1402 #endif /* not WINDOWSNT */
1403 }
1404
1405 #ifndef WINDOWSNT
1406 /* Move the file descriptor FD so that its number is not less than MINFD.
1407 If the file descriptor is moved at all, the original is closed on MSDOS,
1408 but not elsewhere as the caller will close it anyway. */
1409 static int
1410 relocate_fd (int fd, int minfd)
1411 {
1412 if (fd >= minfd)
1413 return fd;
1414 else
1415 {
1416 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
1417 if (new == -1)
1418 {
1419 emacs_perror ("while setting up child");
1420 _exit (EXIT_CANCELED);
1421 }
1422 #ifdef MSDOS
1423 emacs_close (fd);
1424 #endif
1425 return new;
1426 }
1427 }
1428 #endif /* not WINDOWSNT */
1429
1430 static bool
1431 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1432 ptrdiff_t *valuelen, Lisp_Object env)
1433 {
1434 for (; CONSP (env); env = XCDR (env))
1435 {
1436 Lisp_Object entry = XCAR (env);
1437 if (STRINGP (entry)
1438 && SBYTES (entry) >= varlen
1439 #ifdef WINDOWSNT
1440 /* NT environment variables are case insensitive. */
1441 && ! strnicmp (SDATA (entry), var, varlen)
1442 #else /* not WINDOWSNT */
1443 && ! memcmp (SDATA (entry), var, varlen)
1444 #endif /* not WINDOWSNT */
1445 )
1446 {
1447 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1448 {
1449 *value = SSDATA (entry) + (varlen + 1);
1450 *valuelen = SBYTES (entry) - (varlen + 1);
1451 return 1;
1452 }
1453 else if (SBYTES (entry) == varlen)
1454 {
1455 /* Lone variable names in Vprocess_environment mean that
1456 variable should be removed from the environment. */
1457 *value = NULL;
1458 return 1;
1459 }
1460 }
1461 }
1462 return 0;
1463 }
1464
1465 static bool
1466 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1467 ptrdiff_t *valuelen, Lisp_Object frame)
1468 {
1469 /* Try to find VAR in Vprocess_environment first. */
1470 if (getenv_internal_1 (var, varlen, value, valuelen,
1471 Vprocess_environment))
1472 return *value ? 1 : 0;
1473
1474 /* For DISPLAY try to get the values from the frame or the initial env. */
1475 if (strcmp (var, "DISPLAY") == 0)
1476 {
1477 Lisp_Object display
1478 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1479 if (STRINGP (display))
1480 {
1481 *value = SSDATA (display);
1482 *valuelen = SBYTES (display);
1483 return 1;
1484 }
1485 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1486 if (getenv_internal_1 (var, varlen, value, valuelen,
1487 Vinitial_environment))
1488 return *value ? 1 : 0;
1489 }
1490
1491 return 0;
1492 }
1493
1494 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1495 doc: /* Get the value of environment variable VARIABLE.
1496 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1497 the environment. Otherwise, value is a string.
1498
1499 This function searches `process-environment' for VARIABLE.
1500
1501 If optional parameter ENV is a list, then search this list instead of
1502 `process-environment', and return t when encountering a negative entry
1503 \(an entry for a variable with no value). */)
1504 (Lisp_Object variable, Lisp_Object env)
1505 {
1506 char *value;
1507 ptrdiff_t valuelen;
1508
1509 CHECK_STRING (variable);
1510 if (CONSP (env))
1511 {
1512 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1513 &value, &valuelen, env))
1514 return value ? make_string (value, valuelen) : Qt;
1515 else
1516 return Qnil;
1517 }
1518 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1519 &value, &valuelen, env))
1520 return make_string (value, valuelen);
1521 else
1522 return Qnil;
1523 }
1524
1525 /* A version of getenv that consults the Lisp environment lists,
1526 easily callable from C. This is usually called from egetenv. */
1527 char *
1528 egetenv_internal (const char *var, ptrdiff_t len)
1529 {
1530 char *value;
1531 ptrdiff_t valuelen;
1532
1533 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1534 return value;
1535 else
1536 return 0;
1537 }
1538
1539 \f
1540 /* This is run before init_cmdargs. */
1541
1542 void
1543 init_callproc_1 (void)
1544 {
1545 #ifdef HAVE_NS
1546 const char *etc_dir = ns_etc_directory ();
1547 const char *path_exec = ns_exec_path ();
1548 #endif
1549
1550 Vdata_directory = decode_env_path ("EMACSDATA",
1551 #ifdef HAVE_NS
1552 etc_dir ? etc_dir :
1553 #endif
1554 PATH_DATA, 0);
1555 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1556
1557 Vdoc_directory = decode_env_path ("EMACSDOC",
1558 #ifdef HAVE_NS
1559 etc_dir ? etc_dir :
1560 #endif
1561 PATH_DOC, 0);
1562 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1563
1564 /* Check the EMACSPATH environment variable, defaulting to the
1565 PATH_EXEC path from epaths.h. */
1566 Vexec_path = decode_env_path ("EMACSPATH",
1567 #ifdef HAVE_NS
1568 path_exec ? path_exec :
1569 #endif
1570 PATH_EXEC, 0);
1571 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1572 /* FIXME? For ns, path_exec should go at the front? */
1573 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1574 }
1575
1576 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1577
1578 void
1579 init_callproc (void)
1580 {
1581 bool data_dir = egetenv ("EMACSDATA") != 0;
1582
1583 char *sh;
1584 Lisp_Object tempdir;
1585 #ifdef HAVE_NS
1586 if (data_dir == 0)
1587 data_dir = ns_etc_directory () != 0;
1588 #endif
1589
1590 if (!NILP (Vinstallation_directory))
1591 {
1592 /* Add to the path the lib-src subdir of the installation dir. */
1593 Lisp_Object tem;
1594 tem = Fexpand_file_name (build_string ("lib-src"),
1595 Vinstallation_directory);
1596 #ifndef MSDOS
1597 /* MSDOS uses wrapped binaries, so don't do this. */
1598 if (NILP (Fmember (tem, Vexec_path)))
1599 {
1600 #ifdef HAVE_NS
1601 const char *path_exec = ns_exec_path ();
1602 #endif
1603 Vexec_path = decode_env_path ("EMACSPATH",
1604 #ifdef HAVE_NS
1605 path_exec ? path_exec :
1606 #endif
1607 PATH_EXEC, 0);
1608 Vexec_path = Fcons (tem, Vexec_path);
1609 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1610 }
1611
1612 Vexec_directory = Ffile_name_as_directory (tem);
1613 #endif /* not MSDOS */
1614
1615 /* Maybe use ../etc as well as ../lib-src. */
1616 if (data_dir == 0)
1617 {
1618 tem = Fexpand_file_name (build_string ("etc"),
1619 Vinstallation_directory);
1620 Vdoc_directory = Ffile_name_as_directory (tem);
1621 }
1622 }
1623
1624 /* Look for the files that should be in etc. We don't use
1625 Vinstallation_directory, because these files are never installed
1626 near the executable, and they are never in the build
1627 directory when that's different from the source directory.
1628
1629 Instead, if these files are not in the nominal place, we try the
1630 source directory. */
1631 if (data_dir == 0)
1632 {
1633 Lisp_Object tem, tem1, srcdir;
1634 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1635
1636 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1637
1638 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1639 tem1 = Ffile_exists_p (tem);
1640 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1641 {
1642 Lisp_Object newdir;
1643 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1644 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1645 tem1 = Ffile_exists_p (tem);
1646 if (!NILP (tem1))
1647 Vdata_directory = newdir;
1648 }
1649 }
1650
1651 #ifndef CANNOT_DUMP
1652 if (initialized)
1653 #endif
1654 {
1655 tempdir = Fdirectory_file_name (Vexec_directory);
1656 if (! file_accessible_directory_p (tempdir))
1657 dir_warning ("arch-dependent data dir", Vexec_directory);
1658 }
1659
1660 tempdir = Fdirectory_file_name (Vdata_directory);
1661 if (! file_accessible_directory_p (tempdir))
1662 dir_warning ("arch-independent data dir", Vdata_directory);
1663
1664 sh = getenv ("SHELL");
1665 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1666
1667 #ifdef DOS_NT
1668 Vshared_game_score_directory = Qnil;
1669 #else
1670 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1671 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1672 Vshared_game_score_directory = Qnil;
1673 #endif
1674 }
1675
1676 void
1677 set_initial_environment (void)
1678 {
1679 char **envp;
1680 for (envp = environ; *envp; envp++)
1681 Vprocess_environment = Fcons (build_string (*envp),
1682 Vprocess_environment);
1683 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1684 to use `delete' and friends on process-environment. */
1685 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1686 }
1687
1688 void
1689 syms_of_callproc (void)
1690 {
1691 #ifndef DOS_NT
1692 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1693 #else /* DOS_NT */
1694 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1695 #endif
1696 staticpro (&Vtemp_file_name_pattern);
1697
1698 #ifdef MSDOS
1699 synch_process_tempfile = make_number (0);
1700 staticpro (&synch_process_tempfile);
1701 #endif
1702
1703 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1704 doc: /* File name to load inferior shells from.
1705 Initialized from the SHELL environment variable, or to a system-dependent
1706 default if SHELL is not set. */);
1707
1708 DEFVAR_LISP ("exec-path", Vexec_path,
1709 doc: /* List of directories to search programs to run in subprocesses.
1710 Each element is a string (directory name) or nil (try default directory).
1711
1712 By default the last element of this list is `exec-directory'. The
1713 last element is not always used, for example in shell completion
1714 (`shell-dynamic-complete-command'). */);
1715
1716 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1717 doc: /* List of suffixes to try to find executable file names.
1718 Each element is a string. */);
1719 Vexec_suffixes = Qnil;
1720
1721 DEFVAR_LISP ("exec-directory", Vexec_directory,
1722 doc: /* Directory for executables for Emacs to invoke.
1723 More generally, this includes any architecture-dependent files
1724 that are built and installed from the Emacs distribution. */);
1725
1726 DEFVAR_LISP ("data-directory", Vdata_directory,
1727 doc: /* Directory of machine-independent files that come with GNU Emacs.
1728 These are files intended for Emacs to use while it runs. */);
1729
1730 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1731 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1732 This is usually the same as `data-directory'. */);
1733
1734 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1735 doc: /* For internal use by the build procedure only.
1736 This is the name of the directory in which the build procedure installed
1737 Emacs's info files; the default value for `Info-default-directory-list'
1738 includes this. */);
1739 Vconfigure_info_directory = build_string (PATH_INFO);
1740
1741 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1742 doc: /* Directory of score files for games which come with GNU Emacs.
1743 If this variable is nil, then Emacs is unable to use a shared directory. */);
1744 #ifdef DOS_NT
1745 Vshared_game_score_directory = Qnil;
1746 #else
1747 Vshared_game_score_directory = build_string (PATH_GAME);
1748 #endif
1749
1750 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1751 doc: /* List of environment variables inherited from the parent process.
1752 Each element should be a string of the form ENVVARNAME=VALUE.
1753 The elements must normally be decoded (using `locale-coding-system') for use. */);
1754 Vinitial_environment = Qnil;
1755
1756 DEFVAR_LISP ("process-environment", Vprocess_environment,
1757 doc: /* List of overridden environment variables for subprocesses to inherit.
1758 Each element should be a string of the form ENVVARNAME=VALUE.
1759
1760 Entries in this list take precedence to those in the frame-local
1761 environments. Therefore, let-binding `process-environment' is an easy
1762 way to temporarily change the value of an environment variable,
1763 irrespective of where it comes from. To use `process-environment' to
1764 remove an environment variable, include only its name in the list,
1765 without "=VALUE".
1766
1767 This variable is set to nil when Emacs starts.
1768
1769 If multiple entries define the same variable, the first one always
1770 takes precedence.
1771
1772 Non-ASCII characters are encoded according to the initial value of
1773 `locale-coding-system', i.e. the elements must normally be decoded for
1774 use.
1775
1776 See `setenv' and `getenv'. */);
1777 Vprocess_environment = Qnil;
1778
1779 defsubr (&Scall_process);
1780 defsubr (&Sgetenv_internal);
1781 defsubr (&Scall_process_region);
1782 }