process.c 201 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1998, 1999,
      2001, 2002, 2003, 2004, 2005 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
#include <config.h>
24 25
#include <signal.h>

Jim Blandy's avatar
Jim Blandy committed
26 27 28 29 30 31 32 33
/* 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
34 35 36 37 38 39 40 41
#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
42 43 44
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
45

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

Jim Blandy's avatar
Jim Blandy committed
51 52 53 54 55
#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>
56 57 58
#ifdef NEED_NET_ERRNO_H
#include <net/errno.h>
#endif /* NEED_NET_ERRNO_H */
59 60

/* Are local (unix) sockets supported?  */
61
#if defined (HAVE_SYS_UN_H) && !defined (NO_SOCKETS_IN_FILE_SYSTEM)
62 63 64 65 66 67 68 69
#if !defined (AF_LOCAL) && defined (AF_UNIX)
#define AF_LOCAL AF_UNIX
#endif
#ifdef AF_LOCAL
#define HAVE_LOCAL_SOCKETS
#include <sys/un.h>
#endif
#endif
Jim Blandy's avatar
Jim Blandy committed
70 71
#endif /* HAVE_SOCKETS */

72
/* TERM is a poor-man's SLIP, used on GNU/Linux.  */
73 74 75 76
#ifdef TERM
#include <client.h>
#endif

77 78
/* On some systems, e.g. DGUX, inet_addr returns a 'struct in_addr'. */
#ifdef HAVE_BROKEN_INET_ADDR
79 80 81 82 83 84 85
#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

86
#if defined(BSD_SYSTEM) || defined(STRIDE)
Jim Blandy's avatar
Jim Blandy committed
87
#include <sys/ioctl.h>
88
#if !defined (O_NDELAY) && defined (HAVE_PTYS) && !defined(USG5)
Jim Blandy's avatar
Jim Blandy committed
89 90
#include <fcntl.h>
#endif /* HAVE_PTYS and no O_NDELAY */
91
#endif /* BSD_SYSTEM || STRIDE */
Jim Blandy's avatar
Jim Blandy committed
92

93 94 95 96
#ifdef BROKEN_O_NONBLOCK
#undef O_NONBLOCK
#endif /* BROKEN_O_NONBLOCK */

Jim Blandy's avatar
Jim Blandy committed
97 98 99 100
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

101 102 103 104 105 106 107 108 109 110 111
/* Can we use SIOCGIFCONF and/or SIOCGIFADDR */
#ifdef HAVE_SOCKETS
#if defined(HAVE_SYS_IOCTL_H) && defined(HAVE_NET_IF_H)
/* sys/ioctl.h may have been included already */
#ifndef SIOCGIFADDR
#include <sys/ioctl.h>
#endif
#include <net/if.h>
#endif
#endif

Jim Blandy's avatar
Jim Blandy committed
112 113 114
#ifdef IRIS
#include <sys/sysmacros.h>	/* for "minor" */
#endif /* not IRIS */
115

Dave Love's avatar
Dave Love committed
116 117 118
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
119 120

#include "systime.h"
121
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
122 123 124 125

#include "lisp.h"
#include "window.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
126 127
#include "charset.h"
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
128 129 130 131
#include "process.h"
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
132
#include "keyboard.h"
133
#include "frame.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
134
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
135
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
136
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
137
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
138

139
Lisp_Object Qprocessp;
140
Lisp_Object Qrun, Qstop, Qsignal;
141
Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
142 143
Lisp_Object Qlocal, Qdatagram;
Lisp_Object QCname, QCbuffer, QChost, QCservice, QCtype;
144
Lisp_Object QClocal, QCremote, QCcoding;
145
Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
146
Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
Kim F. Storm's avatar
Kim F. Storm committed
147
Lisp_Object QCfilter_multibyte;
148
Lisp_Object Qlast_nonmenu_event;
149 150 151 152
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

Jim Blandy's avatar
Jim Blandy committed
153 154
/* Qexit is declared and initialized in eval.c.  */

155 156 157 158 159
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

Jim Blandy's avatar
Jim Blandy committed
160
/* a process object is a network connection when its childp field is neither
161
   Qt nor Qnil but is instead a property list (KEY VAL ...).  */
Jim Blandy's avatar
Jim Blandy committed
162 163

#ifdef HAVE_SOCKETS
164
#define NETCONN_P(p) (GC_CONSP (XPROCESS (p)->childp))
165
#define NETCONN1_P(p) (GC_CONSP ((p)->childp))
Jim Blandy's avatar
Jim Blandy committed
166 167
#else
#define NETCONN_P(p) 0
168
#define NETCONN1_P(p) 0
Jim Blandy's avatar
Jim Blandy committed
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
#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
187
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
188

189
extern void set_waiting_for_input P_ ((EMACS_TIME *));
190
extern char *get_operating_system_release ();
191

192
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
193
extern int errno;
194
#endif
Roland McGrath's avatar
Roland McGrath committed
195
#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
196
extern char *sys_errlist[];
Roland McGrath's avatar
Roland McGrath committed
197
#endif
Jim Blandy's avatar
Jim Blandy committed
198

199 200 201 202
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
203 204
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
205
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
206 207 208 209 210 211 212

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

213 214
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
215
/* Number of events of change of status of a process.  */
216
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
217
/* Number of events for which the user or sentinel has been notified.  */
218
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
219

220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
/* 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 */

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
/* Define DATAGRAM_SOCKETS if datagrams can be used safely on
   this system.  We need to read full packets, so we need a
   "non-destructive" select.  So we require either native select,
   or emulation of select using FIONREAD.  */

#ifdef BROKEN_DATAGRAM_SOCKETS
#undef DATAGRAM_SOCKETS
#else
#ifndef DATAGRAM_SOCKETS
#ifdef HAVE_SOCKETS
#if defined (HAVE_SELECT) || defined (FIONREAD)
#if defined (HAVE_SENDTO) && defined (HAVE_RECVFROM) && defined (EMSGSIZE)
#define DATAGRAM_SOCKETS
#endif /* HAVE_SENDTO && HAVE_RECVFROM && EMSGSIZE */
#endif /* HAVE_SELECT || FIONREAD */
#endif /* HAVE_SOCKETS */
#endif /* DATAGRAM_SOCKETS */
#endif /* BROKEN_DATAGRAM_SOCKETS */

259 260
#ifdef TERM
#undef NON_BLOCKING_CONNECT
261
#undef DATAGRAM_SOCKETS
262 263
#endif

264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#ifdef EMACS_HAS_USECS
#define ADAPTIVE_READ_BUFFERING
#endif
#endif

#ifdef ADAPTIVE_READ_BUFFERING
#define READ_OUTPUT_DELAY_INCREMENT 10000
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

/* Number of processes which might be delayed.  */

static int process_output_delay_count;

/* Non-zero if any process has non-nil process_output_skip.  */

static int process_output_skip;

/* Non-nil means to delay reading process output to improve buffering.
   A value of t means that delay is reset after each send, any other
   non-nil value does not reset the delay.  */
static Lisp_Object Vprocess_adaptive_read_buffering;
#else
#define process_output_delay_count 0
#endif

291

292
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
293

294 295
extern int keyboard_bit_set P_ ((SELECT_TYPE *));

296
/* If we support a window system, turn on the code to poll periodically
297
   to detect C-g.  It isn't actually used when doing interrupt input.  */
298
#ifdef HAVE_WINDOW_SYSTEM
299 300 301
#define POLL_FOR_INPUT
#endif

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

304 305
static SELECT_TYPE input_wait_mask;

306 307 308 309
/* Mask that excludes keyboard input descriptor (s).  */

static SELECT_TYPE non_keyboard_wait_mask;

310 311 312 313
/* Mask that excludes process input descriptor (s).  */

static SELECT_TYPE non_process_wait_mask;

314
#ifdef NON_BLOCKING_CONNECT
315 316 317 318 319 320 321 322 323
/* 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;

324 325 326 327 328
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

329 330 331
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

332 333
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
334

335 336
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
337 338

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

/* Alist of elements (NAME . PROCESS) */
342
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
343 344 345 346 347 348 349

/* 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.  */

350 351
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
352

Karl Heuer's avatar
Karl Heuer committed
353
/* Table of `struct coding-system' for each process.  */
354 355
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
356

357 358 359 360 361 362 363
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
struct sockaddr_and_len {
  struct sockaddr *sa;
  int len;
} datagram_address[MAXDESC];
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
364
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XINT (XPROCESS (proc)->infd)].sa != 0)
365 366 367 368 369
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

370
static Lisp_Object get_process ();
371
static void exec_sentinel ();
Richard M. Stallman's avatar
Richard M. Stallman committed
372

373
extern EMACS_TIME timer_check ();
374
extern int timers_run;
375

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

379
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
380 381 382
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
383
/* The file name of the pty opened by allocate_pty.  */
384 385

static char pty_name[24];
386
#endif
Jim Blandy's avatar
Jim Blandy committed
387 388 389 390

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

391 392
Lisp_Object status_convert ();

Andreas Schwab's avatar
Andreas Schwab committed
393
void
Jim Blandy's avatar
Jim Blandy committed
394 395 396 397 398 399 400 401 402 403
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;
}

404
/*  Convert a process status word in Unix format to
Jim Blandy's avatar
Jim Blandy committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
    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;

435
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439 440 441 442
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
443 444 445 446
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450 451 452
      *coredump = !NILP (tem);
    }
}

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

453 454 455
static Lisp_Object
status_message (p)
     struct Lisp_Process *p;
Jim Blandy's avatar
Jim Blandy committed
456
{
457
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461 462 463 464 465
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
466
      char *signame;
467
      synchronize_system_messages_locale ();
468
      signame = strsignal (code);
469 470 471
      if (signame == 0)
	signame = "unknown";
      string = build_string (signame);
Jim Blandy's avatar
Jim Blandy committed
472
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
473
      SSET (string, 0, DOWNCASE (SREF (string, 0)));
Jim Blandy's avatar
Jim Blandy committed
474 475 476 477
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
478 479
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
480 481
      if (code == 0)
	return build_string ("finished\n");
482
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
483
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
484 485
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
486
    }
487 488 489 490
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
491 492
      return concat3 (build_string ("failed with code "),
		      string, string2);
493
    }
Jim Blandy's avatar
Jim Blandy committed
494 495 496 497 498 499
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

500 501 502 503 504
/* 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
505 506 507
int
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
508
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513 514 515 516 517
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
518
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
519 520 521 522 523 524
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

525 526 527
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
	{
# ifdef IRIS
	  /* Unusual IRIS code */
	  *ptyv = emacs_open ("/dev/ptc", O_RDWR | O_NDELAY, 0);
	  if (fd < 0)
	    return -1;
	  if (fstat (fd, &stb) < 0)
	    return -1;
# else /* not IRIS */
	  { /* 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;
543

544 545 546 547 548 549 550 551
	    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
552
	  }
553 554 555 556 557 558 559
#  ifdef O_NONBLOCK
	  fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
#  else
	  fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
#  endif
# endif /* not IRIS */
	}
560
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
561 562 563 564 565 566 567 568 569 570 571 572 573

	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)
	      {
574
		emacs_close (fd);
575
# if !defined(IRIS) && !defined(__sgi)
Jim Blandy's avatar
Jim Blandy committed
576
		continue;
577
# else
Jim Blandy's avatar
Jim Blandy committed
578
		return -1;
579
# endif /* IRIS */
Jim Blandy's avatar
Jim Blandy committed
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
	      }
#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;

599
  p = allocate_process ();
600

601 602
  XSETINT (p->infd, -1);
  XSETINT (p->outfd, -1);
603 604 605
  XSETFASTINT (p->pid, 0);
  XSETFASTINT (p->tick, 0);
  XSETFASTINT (p->update_tick, 0);
Jim Blandy's avatar
Jim Blandy committed
606 607 608 609 610
  p->raw_status_low = Qnil;
  p->raw_status_high = Qnil;
  p->status = Qrun;
  p->mark = Fmake_marker ();

611 612 613 614 615 616
#ifdef ADAPTIVE_READ_BUFFERING
  p->adaptive_read_buffering = Qnil;
  XSETFASTINT (p->read_output_delay, 0);
  p->read_output_skip = Qnil;
#endif

Jim Blandy's avatar
Jim Blandy committed
617 618 619 620 621 622 623 624 625 626 627 628
  /* 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;
629
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
630 631 632 633
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
634
void
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638 639 640 641 642 643 644
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);
}
645 646 647 648 649 650 651 652 653 654 655

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
  int inch = XINT (p->infd);
  int outch = XINT (p->outfd);

656 657 658
  if (inch < 0 || outch < 0)
    return;

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
  if (!proc_decode_coding_system[inch])
    proc_decode_coding_system[inch]
      = (struct coding_system *) xmalloc (sizeof (struct coding_system));
  setup_coding_system (p->decode_coding_system,
		       proc_decode_coding_system[inch]);
  if (! NILP (p->filter))
    {
      if (NILP (p->filter_multibyte))
	setup_raw_text_coding_system (proc_decode_coding_system[inch]);
    }
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
	setup_raw_text_coding_system (proc_decode_coding_system[inch]);
    }

  if (!proc_encode_coding_system[outch])
    proc_encode_coding_system[outch]
      = (struct coding_system *) xmalloc (sizeof (struct coding_system));
  setup_coding_system (p->encode_coding_system,
		       proc_encode_coding_system[outch]);
}
Jim Blandy's avatar
Jim Blandy committed
681 682

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
683 684
       doc: /* Return t if OBJECT is a process.  */)
     (object)
685
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
686
{
687
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
688 689 690
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
691 692
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
693 694
     register Lisp_Object name;
{
695
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
696
    return name;
697
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
702 703 704
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
705
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
706 707 708
{
  register Lisp_Object buf, tail, proc;

709 710
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
711 712 713 714 715
  if (NILP (buf)) return Qnil;

  for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
    {
      proc = Fcdr (Fcar (tail));
716
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
722 723 724 725
/* 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
726

727
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
728 729 730
get_process (name)
     register Lisp_Object name;
{
731 732 733 734 735 736 737
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
738
	error ("Process %s does not exist", SDATA (name));
739 740 741
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
742
  else
743 744 745 746 747
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
748
    {
749
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
750
      if (NILP (proc))
751
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
752 753
    }
  else
754
    {
755
      CHECK_PROCESS (obj);
756 757 758
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
759 760 761
}

DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
762 763 764 765
       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)
766
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
767
{
768 769 770 771
  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
772
    {
773 774
      XPROCESS (process)->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
      XSETINT (XPROCESS (process)->tick, ++process_tick);
775
      status_notify ();
Jim Blandy's avatar
Jim Blandy committed
776
    }
777
  else if (XINT (XPROCESS (process)->infd) >= 0)
Jim Blandy's avatar
Jim Blandy committed
778
    {
779
      Fkill_process (process, Qnil);
Jim Blandy's avatar
Jim Blandy committed
780
      /* Do this now, since remove_process will make sigchld_handler do nothing.  */
781
      XPROCESS (process)->status
Jim Blandy's avatar
Jim Blandy committed
782
	= Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
783
      XSETINT (XPROCESS (process)->tick, ++process_tick);
Jim Blandy's avatar
Jim Blandy committed
784 785
      status_notify ();
    }
786
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
787 788 789 790
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
791 792 793 794 795 796 797
       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.
798
listen -- for a network stream server that is listening.
799
closed -- for a network stream connection that is closed.
800 801
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
802 803 804 805
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)
806
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
807 808 809
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
810

811 812
  if (STRINGP (process))
    process = Fget_process (process);
813
  else
814
    process = get_process (process);
815

816 817
  if (NILP (process))
    return process;
818

819
  p = XPROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
820 821 822
  if (!NILP (p->raw_status_low))
    update_status (p);
  status = p->status;
823
  if (CONSP (status))
824
    status = XCAR (status);
825
  if (NETCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
826
    {
827
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
828
	status = Qclosed;
829 830 831 832
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
833 834 835 836 837 838
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
839 840 841
       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)
842
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
843
{
844
  CHECK_PROCESS (process);
845 846 847
  if (!NILP (XPROCESS (process)->raw_status_low))
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
848
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
849 850 851 852
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
853
       doc: /* Return the process id of PROCESS.
854
This is the pid of the external process which PROCESS uses or talks to.
855 856
For a network connection, this value is nil.  */)
     (process)
857
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
858
{
859
  CHECK_PROCESS (process);
860
  return XPROCESS (process)->pid;
Jim Blandy's avatar
Jim Blandy committed
861 862 863
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
864 865 866 867
       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)
868
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
869
{
870
  CHECK_PROCESS (process);
871
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
872 873 874
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
875 876 877 878 879
       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)
880
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
881
{
882
  CHECK_PROCESS (process);
883
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
884 885
}

886
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
887 888 889 890
       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)
891
     register Lisp_Object process;
892
{
893
  CHECK_PROCESS (process);
894
  return XPROCESS (process)->tty_name;
895 896
}

Jim Blandy's avatar
Jim Blandy committed
897
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
898 899 900
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
901
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
902
{
903 904
  struct Lisp_Process *p;

905
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
906
  if (!NILP (buffer))
907
    CHECK_BUFFER (buffer);
908 909 910 911
  p = XPROCESS (process);
  p->buffer = buffer;
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
912
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
913 914 915 916
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
917 918 919 920
       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)
921
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
922
{
923
  CHECK_PROCESS (process);
924
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
925 926 927
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
928 929 930
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
931
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
932
{
933
  CHECK_PROCESS (process);
934
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
935 936 937
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
938 939 940
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
t means stop accepting output from the process.
941 942 943

When a process has a filter, its buffer is not used for output.
Instead, each time it does output, the entire string of output is
944
passed to the filter.
945

946
The filter gets two arguments: the process and the string of output.
947 948 949 950 951 952
The string argument is normally a multibyte string, except:
- if the process' input coding system is no-conversion or raw-text,
  it is a unibyte string (the non-converted input), or else
- if `default-enable-multibyte-characters' is nil, it is a unibyte
  string (the result of converting the decoded input multibyte
  string to unibyte with `string-make-unibyte').  */)
953
     (process, filter)
954
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
955
{
956
  struct Lisp_Process *p;
957

958
  CHECK_PROCESS (process);
959 960 961 962 963 964 965 966 967
  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 ...)  */
968

969
  if (XINT (p->infd) >= 0)
970
    {
971
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
972 973 974 975
	{
	  FD_CLR (XINT (p->infd), &input_wait_mask);
	  FD_CLR (XINT (p->infd), &non_keyboard_wait_mask);
	}
976 977
      else if (EQ (p->filter, Qt)
	       && !EQ (p->command, Qt)) /* Network process not stopped. */
978 979 980 981
	{
	  FD_SET (XINT (p->infd), &input_wait_mask);
	  FD_SET (XINT (p->infd), &non_keyboard_wait_mask);
	}
982
    }
983

984
  p->filter = filter;
985 986
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCfilter, filter);
987
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
988 989 990 991
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
992 993 994 995
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
     (process)
996
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
997
{
998
  CHECK_PROCESS (process);
999
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1003 1004 1005 1006 1007
       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)
1008
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
1009
{
1010 1011
  struct Lisp_Process *p;

1012
  CHECK_PROCESS (process);
1013 1014 1015 1016 1017
  p = XPROCESS (process);

  p->sentinel = sentinel;
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1018 1019 1020 1021
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1022 1023 1024 1025
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
     (process)
1026
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1027
{
1028
  CHECK_PROCESS (process);
1029
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1030 1031
}

1032
DEFUN ("set-process-window-size", Fset_process_window_size,
1033 1034 1035
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
     (process, height, width)
1036
     register Lisp_Object process, height, width;
1037
{
1038 1039 1040
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
1041

1042
  if (XINT (XPROCESS (process)->infd) < 0
1043 1044
      || set_window_size (XINT (XPROCESS (process)->infd),
			  XINT (height), XINT (width)) <= 0)
1045 1046 1047 1048 1049
    return Qnil;
  else
    return Qt;
}

1050
DEFUN ("set-process-inherit-coding-system-flag",
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
       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)
1068 1069
     register Lisp_Object process, flag;
{
1070
  CHECK_PROCESS (process);
1071
  XPROCESS (process)->inherit_coding_system_flag = flag;
1072 1073 1074 1075
  return flag;
}

DEFUN ("process-inherit-coding-system-flag",
1076 1077 1078 1079 1080 1081 1082
       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)
1083 1084
     register Lisp_Object process;
{