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