process.c 147 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2 3
   Copyright (C) 1985, 86, 87, 88, 93, 94, 95, 96, 98, 1999,
      2001, 2002 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#define _GNU_SOURCE		/* to get strsignal declared with glibc 2 */
24
#include <config.h>
25 26
#include <signal.h>

Jim Blandy's avatar
Jim Blandy committed
27 28 29 30 31 32 33 34
/* This file is split into two parts by the following preprocessor
   conditional.  The 'then' clause contains all of the support for
   asynchronous subprocesses.  The 'else' clause contains stub
   versions of some of the asynchronous subprocess routines that are
   often called elsewhere in Emacs, so we don't have to #ifdef the
   sections that call them.  */


Jim Blandy's avatar
Jim Blandy committed
35 36 37 38 39 40 41 42
#ifdef subprocesses

#include <stdio.h>
#include <errno.h>
#include <setjmp.h>
#include <sys/types.h>		/* some typedefs are used in sys/file.h */
#include <sys/file.h>
#include <sys/stat.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
43 44 45
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
46

47
#if defined(WINDOWSNT) || defined(UNIX98_PTYS)
48 49 50 51
#include <stdlib.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Jim Blandy's avatar
Jim Blandy committed
52 53 54 55 56
#ifdef HAVE_SOCKETS	/* TCP connection support, if kernel can do it */
#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
57 58 59
#ifdef NEED_NET_ERRNO_H
#include <net/errno.h>
#endif /* NEED_NET_ERRNO_H */
Jim Blandy's avatar
Jim Blandy committed
60 61
#endif /* HAVE_SOCKETS */

62
/* TERM is a poor-man's SLIP, used on GNU/Linux.  */
63 64 65 66
#ifdef TERM
#include <client.h>
#endif

67 68
/* On some systems, e.g. DGUX, inet_addr returns a 'struct in_addr'. */
#ifdef HAVE_BROKEN_INET_ADDR
69 70 71 72 73 74 75
#define IN_ADDR struct in_addr
#define NUMERIC_ADDR_ERROR (numeric_addr.s_addr == -1)
#else
#define IN_ADDR unsigned long
#define NUMERIC_ADDR_ERROR (numeric_addr == -1)
#endif

76
#if defined(BSD_SYSTEM) || defined(STRIDE)
Jim Blandy's avatar
Jim Blandy committed
77
#include <sys/ioctl.h>
78
#if !defined (O_NDELAY) && defined (HAVE_PTYS) && !defined(USG5)
Jim Blandy's avatar
Jim Blandy committed
79 80
#include <fcntl.h>
#endif /* HAVE_PTYS and no O_NDELAY */
81
#endif /* BSD_SYSTEM || STRIDE */
Jim Blandy's avatar
Jim Blandy committed
82

83 84 85 86
#ifdef BROKEN_O_NONBLOCK
#undef O_NONBLOCK
#endif /* BROKEN_O_NONBLOCK */

Jim Blandy's avatar
Jim Blandy committed
87 88 89 90 91 92 93 94 95
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

#ifdef IRIS
#include <sys/sysmacros.h>	/* for "minor" */
#endif /* not IRIS */

#include "systime.h"
96
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
97 98 99 100

#include "lisp.h"
#include "window.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
101 102
#include "charset.h"
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
103 104 105 106
#include "process.h"
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
107
#include "keyboard.h"
108
#include "frame.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
109
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
110
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
111
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
112
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
113

114
Lisp_Object Qprocessp;
115 116
Lisp_Object Qrun, Qstop, Qsignal;
Lisp_Object Qopen, Qclosed, Qconnect, Qfailed;
117
Lisp_Object Qlast_nonmenu_event;
Jim Blandy's avatar
Jim Blandy committed
118 119 120
/* Qexit is declared and initialized in eval.c.  */

/* a process object is a network connection when its childp field is neither
121
   Qt nor Qnil but is instead a cons cell (HOSTNAME PORTNUM).  */
Jim Blandy's avatar
Jim Blandy committed
122 123

#ifdef HAVE_SOCKETS
124
#define NETCONN_P(p) (GC_CONSP (XPROCESS (p)->childp))
Jim Blandy's avatar
Jim Blandy committed
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
#else
#define NETCONN_P(p) 0
#endif /* HAVE_SOCKETS */

/* Define first descriptor number available for subprocesses.  */
#ifdef VMS
#define FIRST_PROC_DESC 1
#else /* Not VMS */
#define FIRST_PROC_DESC 3
#endif

/* Define SIGCHLD as an alias for SIGCLD.  There are many conditionals
   testing SIGCHLD.  */

#if !defined (SIGCHLD) && defined (SIGCLD)
#define SIGCHLD SIGCLD
#endif /* SIGCLD */

#include "syssignal.h"

Richard M. Stallman's avatar
Richard M. Stallman committed
145
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
146

147 148
extern void set_waiting_for_input P_ ((EMACS_TIME *));

149
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
150
extern int errno;
151
#endif
Roland McGrath's avatar
Roland McGrath committed
152
#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
153
extern char *sys_errlist[];
Roland McGrath's avatar
Roland McGrath committed
154
#endif
Jim Blandy's avatar
Jim Blandy committed
155

156 157 158 159
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
160 161
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
162
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167 168 169

#ifdef SKTPAIR
#ifndef HAVE_SOCKETS
#include <sys/socket.h>
#endif
#endif /* SKTPAIR */

170 171
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
172
/* Number of events of change of status of a process.  */
173
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
174
/* Number of events for which the user or sentinel has been notified.  */
175
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
176

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
#else
#ifndef NON_BLOCKING_CONNECT
#ifdef HAVE_SOCKETS
#ifdef HAVE_SELECT
#if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
#if defined (O_NONBLOCK) || defined (O_NDELAY)
#if defined (EWOULDBLOCK) || defined (EINPROGRESS)
#define NON_BLOCKING_CONNECT
#endif /* EWOULDBLOCK || EINPROGRESS */
#endif /* O_NONBLOCK || O_NDELAY */
#endif /* HAVE_GETPEERNAME || GNU_LINUX */
#endif /* HAVE_SELECT */
#endif /* HAVE_SOCKETS */
#endif /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

#ifdef TERM
#undef NON_BLOCKING_CONNECT
#endif

201
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
202

203 204
extern int keyboard_bit_set P_ ((SELECT_TYPE *));

205
/* If we support a window system, turn on the code to poll periodically
206
   to detect C-g.  It isn't actually used when doing interrupt input.  */
207
#ifdef HAVE_WINDOW_SYSTEM
208 209 210
#define POLL_FOR_INPUT
#endif

211
/* Mask of bits indicating the descriptors that we wait for input on.  */
Jim Blandy's avatar
Jim Blandy committed
212

213 214
static SELECT_TYPE input_wait_mask;

215 216 217 218
/* Mask that excludes keyboard input descriptor (s).  */

static SELECT_TYPE non_keyboard_wait_mask;

219 220 221 222
/* Mask that excludes process input descriptor (s).  */

static SELECT_TYPE non_process_wait_mask;

223 224 225 226 227 228 229 230 231
/* Mask of bits indicating the descriptors that we wait for connect to
   complete on.  Once they complete, they are removed from this mask
   and added to the input_wait_mask and non_keyboard_wait_mask.  */

static SELECT_TYPE connect_wait_mask;

/* Number of bits set in connect_wait_mask.  */
static int num_pending_connects;

232 233 234
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

235 236
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
237

238 239
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
240 241

/* Indexed by descriptor, gives the process (if any) for that descriptor */
242
Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
243 244

/* Alist of elements (NAME . PROCESS) */
245
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
246 247 248 249 250 251 252

/* Buffered-ahead input char from process, indexed by channel.
   -1 means empty (no char is buffered).
   Used on sys V where the only way to tell if there is any
   output from the process is to read at least one char.
   Always -1 on systems that support FIONREAD.  */

253 254
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
255

Karl Heuer's avatar
Karl Heuer committed
256
/* Table of `struct coding-system' for each process.  */
257 258
static struct coding_system *proc_decode_coding_system[MAXDESC];
static struct coding_system *proc_encode_coding_system[MAXDESC];
Karl Heuer's avatar
Karl Heuer committed
259

260
static Lisp_Object get_process ();
261
static void exec_sentinel ();
Richard M. Stallman's avatar
Richard M. Stallman committed
262

263
extern EMACS_TIME timer_check ();
264
extern int timers_run;
265

Richard M. Stallman's avatar
Richard M. Stallman committed
266 267
/* Maximum number of bytes to send to a pty without an eof.  */
static int pty_max_bytes;
268

269
extern Lisp_Object Vfile_name_coding_system, Vdefault_file_name_coding_system;
270

271 272
#ifdef HAVE_PTYS
/* The file name of the pty opened by allocate_pty.  */
273 274

static char pty_name[24];
275
#endif
Jim Blandy's avatar
Jim Blandy committed
276 277 278 279

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

280 281
Lisp_Object status_convert ();

Andreas Schwab's avatar
Andreas Schwab committed
282
void
Jim Blandy's avatar
Jim Blandy committed
283 284 285 286 287 288 289 290 291 292
update_status (p)
     struct Lisp_Process *p;
{
  union { int i; WAITTYPE wt; } u;
  u.i = XFASTINT (p->raw_status_low) + (XFASTINT (p->raw_status_high) << 16);
  p->status = status_convert (u.wt);
  p->raw_status_low = Qnil;
  p->raw_status_high = Qnil;
}

Jim Blandy's avatar
Typo.  
Jim Blandy committed
293
/*  Convert a process status word in Unix format to 
Jim Blandy's avatar
Jim Blandy committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
    the list that we use internally.  */

Lisp_Object
status_convert (w)
     WAITTYPE w;
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
    return Fcons (Qexit, Fcons (make_number (WRETCODE (w)),
				WCOREDUMP (w) ? Qt : Qnil));
  else if (WIFSIGNALED (w))
    return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
				  WCOREDUMP (w) ? Qt : Qnil));
  else
    return Qrun;
}

/* Given a status-list, extract the three pieces of information
   and store them individually through the three pointers.  */

void
decode_status (l, symbol, code, coredump)
     Lisp_Object l;
     Lisp_Object *symbol;
     int *code;
     int *coredump;
{
  Lisp_Object tem;

324
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
325 326 327 328 329 330 331
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
332 333 334 335
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
      *coredump = !NILP (tem);
    }
}

/* Return a string describing a process status list.  */

Lisp_Object 
status_message (status)
     Lisp_Object status;
{
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

  decode_status (status, &symbol, &code, &coredump);

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
354
      char *signame;
355
      synchronize_system_messages_locale ();
356
      signame = strsignal (code);
357 358 359
      if (signame == 0)
	signame = "unknown";
      string = build_string (signame);
Jim Blandy's avatar
Jim Blandy committed
360 361 362 363 364 365 366 367
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      XSTRING (string)->data[0] = DOWNCASE (XSTRING (string)->data[0]);
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
      if (code == 0)
	return build_string ("finished\n");
368
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
369 370 371 372
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (build_string ("exited abnormally with code "),
		      concat2 (string, string2));
    }
373 374 375 376 377 378 379
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
      return concat2 (build_string ("failed with code "),
		      concat2 (string, string2));
    }
Jim Blandy's avatar
Jim Blandy committed
380 381 382 383 384 385
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

386 387 388 389 390
/* Open an available pty, returning a file descriptor.
   Return -1 on failure.
   The file name of the terminal corresponding to the pty
   is left in the variable pty_name.  */

Jim Blandy's avatar
Jim Blandy committed
391 392 393 394
int
allocate_pty ()
{
  struct stat stb;
Andreas Schwab's avatar
Andreas Schwab committed
395
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
396 397
  int fd;

Jim Blandy's avatar
Jim Blandy committed
398 399 400 401 402 403 404
  /* Some systems name their pseudoterminals so that there are gaps in
     the usual sequence - for example, on HP9000/S700 systems, there
     are no pseudoterminals with names ending in 'f'.  So we wait for
     three failures in a row before deciding that we've reached the
     end of the ptys.  */
  int failed_count = 0;

Jim Blandy's avatar
Jim Blandy committed
405 406 407 408 409 410 411 412 413 414 415 416 417
#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

418 419 420
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
421 422
#ifdef IRIS
	/* Unusual IRIS code */
423
 	*ptyv = emacs_open ("/dev/ptc", O_RDWR | O_NDELAY, 0);
Jim Blandy's avatar
Jim Blandy committed
424 425 426
 	if (fd < 0)
 	  return -1;
	if (fstat (fd, &stb) < 0)
Jim Blandy's avatar
Jim Blandy committed
427
	  return -1;
428
#else /* not IRIS */
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432 433 434 435 436
	if (stat (pty_name, &stb) < 0)
	  {
	    failed_count++;
	    if (failed_count >= 3)
	      return -1;
	  }
	else
	  failed_count = 0;
Jim Blandy's avatar
Jim Blandy committed
437
#ifdef O_NONBLOCK
438
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
Jim Blandy's avatar
Jim Blandy committed
439
#else
440
	fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
Jim Blandy's avatar
Jim Blandy committed
441
#endif
442 443
#endif /* not IRIS */
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
444 445 446 447 448 449 450 451 452 453 454 455 456

	if (fd >= 0)
	  {
	    /* check to make certain that both sides are available
	       this avoids a nasty yet stupid bug in rlogins */
#ifdef PTY_TTY_NAME_SPRINTF
	    PTY_TTY_NAME_SPRINTF
#else
            sprintf (pty_name, "/dev/tty%c%x", c, i);
#endif /* no PTY_TTY_NAME_SPRINTF */
#ifndef UNIPLUS
	    if (access (pty_name, 6) != 0)
	      {
457
		emacs_close (fd);
458
#if !defined(IRIS) && !defined(__sgi)
Jim Blandy's avatar
Jim Blandy committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
		continue;
#else
		return -1;
#endif /* IRIS */
	      }
#endif /* not UNIPLUS */
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

Lisp_Object
make_process (name)
     Lisp_Object name;
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

482
  p = allocate_process ();
483

484 485
  XSETINT (p->infd, -1);
  XSETINT (p->outfd, -1);
486 487 488
  XSETFASTINT (p->pid, 0);
  XSETFASTINT (p->tick, 0);
  XSETFASTINT (p->update_tick, 0);
Jim Blandy's avatar
Jim Blandy committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
  p->raw_status_low = Qnil;
  p->raw_status_high = Qnil;
  p->status = Qrun;
  p->mark = Fmake_marker ();

  /* If name is already in use, modify it until it is unused.  */

  name1 = name;
  for (i = 1; ; i++)
    {
      tem = Fget_process (name1);
      if (NILP (tem)) break;
      sprintf (suffix, "<%d>", i);
      name1 = concat2 (name, build_string (suffix));
    }
  name = name1;
  p->name = name;
506
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
507 508 509 510
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
511
void
Jim Blandy's avatar
Jim Blandy committed
512 513 514 515 516 517 518 519 520 521 522 523
remove_process (proc)
     register Lisp_Object proc;
{
  register Lisp_Object pair;

  pair = Frassq (proc, Vprocess_alist);
  Vprocess_alist = Fdelq (pair, Vprocess_alist);

  deactivate_process (proc);
}

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
524 525
       doc: /* Return t if OBJECT is a process.  */)
     (object)
526
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
527
{
528
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
529 530 531
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
532 533
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
534 535
     register Lisp_Object name;
{
536
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
537
    return name;
538
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
539 540 541 542
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
543 544 545
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
546
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
547 548 549
{
  register Lisp_Object buf, tail, proc;

550 551
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
552 553 554 555 556
  if (NILP (buf)) return Qnil;

  for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
    {
      proc = Fcdr (Fcar (tail));
557
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
558 559 560 561 562
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
563 564 565 566
/* This is how commands for the user decode process arguments.  It
   accepts a process, a process name, a buffer, a buffer name, or nil.
   Buffers denote the first process in the buffer, and nil denotes the
   current buffer.  */
Jim Blandy's avatar
Jim Blandy committed
567

568
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
569 570 571
get_process (name)
     register Lisp_Object name;
{
572 573 574 575 576 577 578 579 580 581 582
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
	error ("Process %s does not exist", XSTRING (name)->data);
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
583
  else
584 585 586 587 588
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
589
    {
590
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
591
      if (NILP (proc))
592
	error ("Buffer %s has no process", XSTRING (XBUFFER (obj)->name)->data);
Jim Blandy's avatar
Jim Blandy committed
593 594
    }
  else
595
    {
596
      CHECK_PROCESS (obj);
597 598 599
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
600 601 602
}

DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
603 604 605 606
       doc: /* Delete PROCESS: kill it and forget about it immediately.
PROCESS may be a process, a buffer, the name of a process or buffer, or
nil, indicating the current buffer's process.  */)
     (process)
607
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
608
{
609 610 611 612
  process = get_process (process);
  XPROCESS (process)->raw_status_low = Qnil;
  XPROCESS (process)->raw_status_high = Qnil;
  if (NETCONN_P (process))
Jim Blandy's avatar
Jim Blandy committed
613
    {
614 615
      XPROCESS (process)->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
      XSETINT (XPROCESS (process)->tick, ++process_tick);
Jim Blandy's avatar
Jim Blandy committed
616
    }
617
  else if (XINT (XPROCESS (process)->infd) >= 0)
Jim Blandy's avatar
Jim Blandy committed
618
    {
619
      Fkill_process (process, Qnil);
Jim Blandy's avatar
Jim Blandy committed
620
      /* Do this now, since remove_process will make sigchld_handler do nothing.  */
621
      XPROCESS (process)->status 
Jim Blandy's avatar
Jim Blandy committed
622
	= Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
623
      XSETINT (XPROCESS (process)->tick, ++process_tick);
Jim Blandy's avatar
Jim Blandy committed
624 625
      status_notify ();
    }
626
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
631 632 633 634 635 636 637 638 639 640 641 642
       doc: /* Return the status of PROCESS.
The returned value is one of the following symbols:
run  -- for a process that is running.
stop -- for a process stopped but continuable.
exit -- for a process that has exited.
signal -- for a process that has got a fatal signal.
open -- for a network stream connection that is open.
closed -- for a network stream connection that is closed.
nil -- if arg is a process name and no such process exists.
PROCESS may be a process, a buffer, the name of a process, or
nil, indicating the current buffer's process.  */)
     (process)
643
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
644 645 646
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
647

648 649
  if (STRINGP (process))
    process = Fget_process (process);
650
  else
651
    process = get_process (process);
652

653 654
  if (NILP (process))
    return process;
655

656
  p = XPROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
657 658 659
  if (!NILP (p->raw_status_low))
    update_status (p);
  status = p->status;
660
  if (CONSP (status))
661
    status = XCAR (status);
662
  if (NETCONN_P (process))
Jim Blandy's avatar
Jim Blandy committed
663 664 665 666 667 668 669 670 671 672 673
    {
      if (EQ (status, Qrun))
	status = Qopen;
      else if (EQ (status, Qexit))
	status = Qclosed;
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
674 675 676
       doc: /* Return the exit status of PROCESS or the signal number that killed it.
If PROCESS has not yet exited or died, return 0.  */)
     (process)
677
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
678
{
679
  CHECK_PROCESS (process);
680 681 682
  if (!NILP (XPROCESS (process)->raw_status_low))
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
683
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
684 685 686 687
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
688 689 690 691
       doc: /* Return the process id of PROCESS.
This is the pid of the Unix process which PROCESS uses or talks to.
For a network connection, this value is nil.  */)
     (process)
692
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
693
{
694
  CHECK_PROCESS (process);
695
  return XPROCESS (process)->pid;
Jim Blandy's avatar
Jim Blandy committed
696 697 698
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
699 700 701 702
       doc: /* Return the name of PROCESS, as a string.
This is the name of the program invoked in PROCESS,
possibly modified to make it unique among process names.  */)
     (process)
703
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
704
{
705
  CHECK_PROCESS (process);
706
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
707 708 709
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
710 711 712 713 714
       doc: /* Return the command that was executed to start PROCESS.
This is a list of strings, the first string being the program executed
and the rest of the strings being the arguments given to it.
For a non-child channel, this is nil.  */)
     (process)
715
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
716
{
717
  CHECK_PROCESS (process);
718
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
719 720
}

721
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
722 723 724 725
       doc: /* Return the name of the terminal PROCESS uses, or nil if none.
This is the terminal that the process itself reads and writes on,
not the name of the pty that Emacs uses to talk with that terminal.  */)
     (process)
726
     register Lisp_Object process;
727
{
728
  CHECK_PROCESS (process);
729
  return XPROCESS (process)->tty_name;
730 731
}

Jim Blandy's avatar
Jim Blandy committed
732
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
733 734 735
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
736
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
737
{
738
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
739
  if (!NILP (buffer))
740
    CHECK_BUFFER (buffer);
741
  XPROCESS (process)->buffer = buffer;
Jim Blandy's avatar
Jim Blandy committed
742 743 744 745
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
746 747 748 749
       1, 1, 0,
       doc: /* Return the buffer PROCESS is associated with.
Output from PROCESS is inserted in this buffer unless PROCESS has a filter.  */)
     (process)
750
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
751
{
752
  CHECK_PROCESS (process);
753
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
754 755 756
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
757 758 759
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
760
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
761
{
762
  CHECK_PROCESS (process);
763
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
764 765 766
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
767 768 769 770 771 772 773 774
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
t means stop accepting output from the process.
When a process has a filter, each time it does output
the entire string of output is passed to the filter.
The filter gets two arguments: the process and the string of output.
If the process has a filter, its buffer is not used for output.  */)
     (process, filter)
775
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
776
{
777 778
  struct Lisp_Process *p;
  
779
  CHECK_PROCESS (process);
780 781 782 783 784 785 786 787 788 789 790
  p = XPROCESS (process);

  /* Don't signal an error if the process' input file descriptor
     is closed.  This could make debugging Lisp more difficult,
     for example when doing something like

     (setq process (start-process ...))
     (debug)
     (set-process-filter process ...)  */
  
  if (XINT (p->infd) >= 0)
791
    {
792 793 794 795 796 797 798 799 800 801
      if (EQ (filter, Qt))
	{
	  FD_CLR (XINT (p->infd), &input_wait_mask);
	  FD_CLR (XINT (p->infd), &non_keyboard_wait_mask);
	}
      else if (EQ (XPROCESS (process)->filter, Qt))
	{
	  FD_SET (XINT (p->infd), &input_wait_mask);
	  FD_SET (XINT (p->infd), &non_keyboard_wait_mask);
	}
802
    }
803 804
  
  p->filter = filter;
Jim Blandy's avatar
Jim Blandy committed
805 806 807 808
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
809 810 811 812
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
     (process)
813
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
814
{
815
  CHECK_PROCESS (process);
816
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
817 818 819
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
820 821 822 823 824
       2, 2, 0,
       doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
The sentinel is called as a function when the process changes state.
It gets two arguments: the process, and a string describing the change.  */)
     (process, sentinel)
825
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
826
{
827
  CHECK_PROCESS (process);
828
  XPROCESS (process)->sentinel = sentinel;
Jim Blandy's avatar
Jim Blandy committed
829 830 831 832
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
833 834 835 836
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
     (process)
837
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
838
{
839
  CHECK_PROCESS (process);
840
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
841 842
}

843
DEFUN ("set-process-window-size", Fset_process_window_size,
844 845 846
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
     (process, height, width)
847
     register Lisp_Object process, height, width;
848
{
849 850 851
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
852
  
853
  if (XINT (XPROCESS (process)->infd) < 0
854 855
      || set_window_size (XINT (XPROCESS (process)->infd),
			  XINT (height), XINT (width)) <= 0)
856 857 858 859 860
    return Qnil;
  else
    return Qt;
}

861
DEFUN ("set-process-inherit-coding-system-flag",
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
       Fset_process_inherit_coding_system_flag,
       Sset_process_inherit_coding_system_flag, 2, 2, 0,
       doc: /* Determine whether buffer of PROCESS will inherit coding-system.
If the second argument FLAG is non-nil, then the variable
`buffer-file-coding-system' of the buffer associated with PROCESS
will be bound to the value of the coding system used to decode
the process output.

This is useful when the coding system specified for the process buffer
leaves either the character code conversion or the end-of-line conversion
unspecified, or if the coding system used to decode the process output
is more appropriate for saving the process buffer.

Binding the variable `inherit-process-coding-system' to non-nil before
starting the process is an alternative way of setting the inherit flag
for the process which will run.  */)
     (process, flag)
879 880
     register Lisp_Object process, flag;
{
881
  CHECK_PROCESS (process);
882
  XPROCESS (process)->inherit_coding_system_flag = flag;
883 884 885 886
  return flag;
}

DEFUN ("process-inherit-coding-system-flag",
887 888 889 890 891 892 893
       Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
       1, 1, 0,
       doc: /* Return the value of inherit-coding-system flag for PROCESS.
If this flag is t, `buffer-file-coding-system' of the buffer
associated with PROCESS will inherit the coding system used to decode
the process output.  */)
     (process)
894 895
     register Lisp_Object process;
{
896
  CHECK_PROCESS (process);
897
  return XPROCESS (process)->inherit_coding_system_flag;
898 899
}

Jim Blandy's avatar
Jim Blandy committed
900
DEFUN ("process-kill-without-query", Fprocess_kill_without_query,
901 902 903 904 905
       Sprocess_kill_without_query, 1, 2, 0,
       doc: /* Say no query needed if PROCESS is running when Emacs is exited.
Optional second argument if non-nil says to require a query.
Value is t if a query was formerly required.  */)
     (process, value)
906
     register Lisp_Object process, value;
Jim Blandy's avatar
Jim Blandy committed
907 908 909
{
  Lisp_Object tem;

910
  CHECK_PROCESS (process);
911 912
  tem = XPROCESS (process)->kill_without_query;
  XPROCESS (process)->kill_without_query = Fnull (value);
Jim Blandy's avatar
Jim Blandy committed
913 914 915

  return Fnull (tem);
}
916

917
DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
918 919 920 921
       1, 1, 0,
       doc: /* Return the contact info of PROCESS; t for a real child.
For a net connection, the value is a cons cell of the form (HOST SERVICE).  */)
     (process)
922 923
     register Lisp_Object process;
{
924
  CHECK_PROCESS (process);
925 926 927
  return XPROCESS (process)->childp;
}

928 929 930
#if 0 /* Turned off because we don't currently record this info
	 in the process.  Perhaps add it.  */
DEFUN ("process-connection", Fprocess_connection, Sprocess_connection, 1, 1, 0,
931 932 933 934
       doc: /* Return the connection type of PROCESS.
The value is nil for a pipe, t or `pty' for a pty, or `stream' for
a socket connection.  */)
     (process)
935 936 937 938 939
     Lisp_Object process;
{
  return XPROCESS (process)->type;
}
#endif
Jim Blandy's avatar
Jim Blandy committed
940 941 942 943 944 945 946 947 948

Lisp_Object
list_processes_1 ()
{
  register Lisp_Object tail, tem;
  Lisp_Object proc, minspace, tem1;
  register struct Lisp_Process *p;
  char tembuf[80];

949
  XSETFASTINT (minspace, 1);
Jim Blandy's avatar
Jim Blandy committed
950 951 952 953 954 955 956

  set_buffer_internal (XBUFFER (Vstandard_output));
  Fbuffer_disable_undo (Vstandard_output);

  current_buffer->truncate_lines = Qt;

  write_string ("\
957 958
Proc         Status   Buffer         Tty         Command\n\
----         ------   ------         ---         -------\n", -1);
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974

  for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
    {
      Lisp_Object symbol;

      proc = Fcdr (Fcar (tail));
      p = XPROCESS (proc);
      if (NILP (p->childp))
	continue;

      Finsert (1, &p->name);
      Findent_to (make_number (13), minspace);

      if (!NILP (p->raw_status_low))
	update_status (p);
      symbol = p->status;
975
      if (CONSP (p->status))
976
	symbol = XCAR (p->status);
Jim Blandy's avatar
Jim Blandy committed
977 978 979 980 981 982 983 984

      
      if (EQ (symbol, Qsignal))
	{
	  Lisp_Object tem;
	  tem = Fcar (Fcdr (p->status));
#ifdef VMS
	  if (XINT (tem) < NSIG)
985
	    write_string (sys_errlist [XINT (tem)], -1);
Jim Blandy's avatar
Jim Blandy committed
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
	  else
#endif
	    Fprinc (symbol, Qnil);
	}
      else if (NETCONN_P (proc))
	{
	  if (EQ (symbol, Qrun))
	    write_string ("open", -1);
	  else if (EQ (symbol, Qexit))
	    write_string ("closed", -1);
	  else
	    Fprinc (symbol, Qnil);
	}
      else
	Fprinc (symbol, Qnil);

      if (EQ (symbol, Qexit))
	{
	  Lisp_Object tem;
	  tem = Fcar (Fcdr (p->status));
	  if (XFASTINT (tem))
	    {
1008
	      sprintf (tembuf, " %d", (int) XFASTINT (tem));
Jim Blandy's avatar
Jim Blandy committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
	      write_string (tembuf, -1);
	    }
	}

      if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
	remove_process (proc);

      Findent_to (make_number (22), minspace);
      if (NILP (p->buffer))
	insert_string ("(none)");
      else if (NILP (XBUFFER (p->buffer)->name))
	insert_string ("(Killed)");
      else
	Finsert (1, &XBUFFER (p->buffer)->name);

      Findent_to (make_number (37), minspace);

1026 1027 1028 1029 1030 1031 1032
      if (STRINGP (p->tty_name))
	Finsert (1, &p->tty_name);
      else
	insert_string ("(none)");

      Findent_to (make_number (49), minspace);

Jim Blandy's avatar
Jim Blandy committed
1033 1034 1035
      if (NETCONN_P (proc))
        {
	  sprintf (tembuf, "(network stream connection to %s)\n",
1036
		   XSTRING (XCAR (p->childp))->data);
Jim Blandy's avatar
Jim Blandy committed
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	  insert_string (tembuf);
        }
      else 
	{
	  tem = p->command;
	  while (1)
	    {
	      tem1 = Fcar (tem);
	      Finsert (1, &tem1);
	      tem = Fcdr (tem);
	      if (NILP (tem))
		break;
	      insert_string (" ");
	    }
	  insert_string ("\n");
       }
    }
  return Qnil;
}

DEFUN ("list-processes", Flist_processes, Slist_processes, 0, 0, "",
1058 1059 1060 1061
       doc: /* Display a list of all processes.
Any process listed as exited or signaled is actually eliminated
after the listing is made.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1062 1063 1064 1065 1066 1067 1068
{
  internal_with_output_to_temp_buffer ("*Process List*",
				       list_processes_1, Qnil);
  return Qnil;
}

DEFUN ("process-list", Fprocess_list, Sprocess_list, 0, 0, 0,
1069 1070
       doc: /* Return a list of all processes.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1071 1072 1073 1074
{
  return Fmapcar (Qcdr, Vprocess_alist);
}

1075 1076 1077 1078
/* Starting asynchronous inferior processes.  */

static Lisp_Object start_process_unwind ();

Jim Blandy's avatar
Jim Blandy committed
1079
DEFUN ("start-process", Fstart_process, Sstart_process, 3, MANY, 0,
1080 1081 1082 1083 1084 1085 1086 1087
       doc: /* Start a program in a subprocess.  Return the process object for it.
NAME is name for process.  It is modified if necessary to make it unique.
BUFFER is the buffer or (buffer-name) to associate with the process.
 Process output goes at end of that buffer, unless you specify
 an output stream or filter function to handle the output.
 BUFFER may be also nil, meaning that this process is not associated
 with any buffer.
Third arg is program file name.  It is searched for in PATH.
1088 1089
Remaining arguments are strings to give program as arguments.
usage: (start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS)  */)
1090
     (nargs, args)
Jim Blandy's avatar
Jim Blandy committed
1091 1092 1093
     int nargs;
     register Lisp_Object *args;
{
1094
  Lisp_Object buffer, name, program, proc, current_dir, tem;
Jim Blandy's avatar
Jim Blandy committed
1095 1096 1097 1098 1099 1100 1101
#ifdef VMS
  register unsigned char *new_argv;
  int len;
#else
  register unsigned char **new_argv;
#endif
  register int i;
1102
  int count = specpdl_ptr - specpdl;
Jim Blandy's avatar
Jim Blandy committed
1103 1104 1105 1106 1107

  buffer = args[1];
  if (!NILP (buffer))
    buffer = Fget_buffer_create (buffer);

1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
  /* Make sure that the child will be able to chdir to the current
     buffer's current directory, or its unhandled equivalent.  We
     can't just have the child check for an error when it does the
     chdir, since it's in a vfork.

     We have to GCPRO around this because Fexpand_file_name and
     Funhandled_file_name_directory might call a file name handling
     function.  The argument list is protected by the caller, so all
     we really have to worry about is buffer.  */
  {
    struct gcpro gcpro1, gcpro2;

    current_dir = current_buffer->directory;

    GCPRO2 (buffer, current_dir);

1124 1125 1126
    current_dir 
      = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir),
				Qnil);
1127 1128 1129 1130 1131 1132 1133
    if (NILP (Ffile_accessible_directory_p (current_dir)))
      report_file_error ("Setting current directory",
			 Fcons (current_buffer->directory, Qnil));

    UNGCPRO;
  }

Jim Blandy's avatar
Jim Blandy committed
1134
  name = args[0];
1135
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
1136 1137 1138

  program = args[2];

1139
  CHECK_STRING (program);
Jim Blandy's avatar
Jim Blandy committed
1140 1141

  proc = make_process (name);
1142 1143 1144 1145 1146
  /* If an error occurs and we can't start the process, we want to
     remove it from the process list.  This means that each error
     check in create_process doesn't need to call remove_process
     itself; it's all taken care of here.  */
  record_unwind_protect (start_process_unwind, proc);
Jim Blandy's avatar
Jim Blandy committed
1147 1148 1149 1150 1151 1152 1153