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