process.c 232 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,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
23 24
#include <signal.h>

Jim Blandy's avatar
Jim Blandy committed
25 26 27 28 29 30 31 32
/* 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
33 34 35
#ifdef subprocesses

#include <stdio.h>
36 37
#include <stdlib.h>
#include <ctype.h>
Jim Blandy's avatar
Jim Blandy committed
38 39 40 41 42
#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>
43 44 45
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
46 47 48 49 50 51

#ifdef HAVE_PWD_H
#include <pwd.h>
#include <grp.h>
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
52 53 54
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
55 56
#include <fcntl.h>

Jim Blandy's avatar
Jim Blandy committed
57 58 59 60 61
#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>
62 63

/* Are local (unix) sockets supported?  */
64
#if defined (HAVE_SYS_UN_H)
65 66 67 68 69 70 71 72
#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
73 74
#endif /* HAVE_SOCKETS */

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

#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

Kenichi Handa's avatar
Kenichi Handa committed
86 87 88 89 90 91 92 93 94 95 96
/* 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

Dave Love's avatar
Dave Love committed
97 98 99
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
100

101 102 103 104 105 106
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

107
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
108
#include "systime.h"
109
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
110 111 112

#include "window.h"
#include "buffer.h"
113
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
114
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
115
#include "process.h"
116
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
117 118 119
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
120
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
121
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
122
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
123
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
124
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
125

126
Lisp_Object Qprocessp;
Kim F. Storm's avatar
Kim F. Storm committed
127
Lisp_Object Qrun, Qstop, Qsignal;
128
Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
Kim F. Storm's avatar
Kim F. Storm committed
129
Lisp_Object Qlocal, Qipv4, Qdatagram;
130
Lisp_Object Qreal, Qnetwork, Qserial;
Kim F. Storm's avatar
Kim F. Storm committed
131 132 133
#ifdef AF_INET6
Lisp_Object Qipv6;
#endif
134 135 136
Lisp_Object QCport, QCspeed, QCprocess;
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
137
Lisp_Object QCname, QCbuffer, QChost, QCservice, QCtype;
138
Lisp_Object QClocal, QCremote, QCcoding;
139
Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
140
Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
141
Lisp_Object Qlast_nonmenu_event;
142 143 144 145
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

148 149 150 151 152
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

153 154 155 156 157
Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem;

Jim Blandy's avatar
Jim Blandy committed
158
#ifdef HAVE_SOCKETS
159 160 161 162
#define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
#define NETCONN1_P(p) (EQ ((p)->type, Qnetwork))
#define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
#define SERIALCONN1_P(p) (EQ ((p)->type, Qserial))
Jim Blandy's avatar
Jim Blandy committed
163 164
#else
#define NETCONN_P(p) 0
165
#define NETCONN1_P(p) 0
166 167
#define SERIALCONN_P(p) 0
#define SERIALCONN1_P(p) 0
Jim Blandy's avatar
Jim Blandy committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181
#endif /* HAVE_SOCKETS */

/* Define first descriptor number available for subprocesses.  */
#define FIRST_PROC_DESC 3

/* 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
182
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
183

184
extern char *get_operating_system_release ();
185

186 187 188 189 190 191 192 193 194 195 196
/* Serial processes require termios or Windows.  */
#if defined (HAVE_TERMIOS) || defined (WINDOWSNT)
#define HAVE_SERIAL
#endif

#ifdef HAVE_SERIAL
/* From sysdep.c or w32.c  */
extern int serial_open (char *port);
extern void serial_configure (struct Lisp_Process *p, Lisp_Object contact);
#endif

197
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
198
extern int errno;
199
#endif
Jim Blandy's avatar
Jim Blandy committed
200

201 202 203 204
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

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

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

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
/* 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 */

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
/* 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 */

Kenichi Handa's avatar
Kenichi Handa committed
255 256 257 258 259 260 261 262 263 264 265
#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)

266 267
/* Number of processes which have a non-zero read_output_delay,
   and therefore might be delayed for adaptive read buffering.  */
Kenichi Handa's avatar
Kenichi Handa committed
268 269 270

static int process_output_delay_count;

271
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
272 273 274 275 276

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
277 278
   non-nil value does not reset the delay.  A value of nil disables
   adaptive read buffering completely.  */
Kenichi Handa's avatar
Kenichi Handa committed
279 280 281 282 283
static Lisp_Object Vprocess_adaptive_read_buffering;
#else
#define process_output_delay_count 0
#endif

284

285
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
286

287 288 289 290
static int keyboard_bit_set P_ ((SELECT_TYPE *));
static void deactivate_process P_ ((Lisp_Object));
static void status_notify P_ ((struct Lisp_Process *));
static int read_process_output P_ ((Lisp_Object, int));
291

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

298 299 300 301 302 303
static Lisp_Object get_process ();
static void exec_sentinel ();

extern EMACS_TIME timer_check ();
extern int timers_run;

304
/* Mask of bits indicating the descriptors that we wait for input on.  */
Jim Blandy's avatar
Jim Blandy committed
305

306 307
static SELECT_TYPE input_wait_mask;

308
/* Mask that excludes keyboard input descriptor(s).  */
309 310 311

static SELECT_TYPE non_keyboard_wait_mask;

312
/* Mask that excludes process input descriptor(s).  */
313 314 315

static SELECT_TYPE non_process_wait_mask;

316 317 318 319
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

320
#ifdef NON_BLOCKING_CONNECT
321 322 323 324 325 326 327 328 329
/* 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;

330 331 332 333 334
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

335 336 337
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

338 339
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
340

341 342 343
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

344 345
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
346 347

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

/* Alist of elements (NAME . PROCESS) */
351
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
352 353 354 355 356 357 358

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

359 360
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
361

Karl Heuer's avatar
Karl Heuer committed
362
/* Table of `struct coding-system' for each process.  */
363 364
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
365

366 367 368 369 370 371 372
#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)
373
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
374 375 376 377 378
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

382 383 384 385
/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
int inhibit_sentinels;

386
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
387 388 389
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
390
/* The file name of the pty opened by allocate_pty.  */
391 392

static char pty_name[24];
393
#endif
Jim Blandy's avatar
Jim Blandy committed
394 395 396 397

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

398
static Lisp_Object status_convert (int);
399

400
static void
Jim Blandy's avatar
Jim Blandy committed
401 402 403
update_status (p)
     struct Lisp_Process *p;
{
404
  eassert (p->raw_status_new);
405
  p->status = status_convert (p->raw_status);
406
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
407 408
}

409
/*  Convert a process status word in Unix format to
Jim Blandy's avatar
Jim Blandy committed
410 411
    the list that we use internally.  */

412
static Lisp_Object
413
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
{
  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.  */

430
static void
Jim Blandy's avatar
Jim Blandy committed
431 432 433 434 435 436 437 438
decode_status (l, symbol, code, coredump)
     Lisp_Object l;
     Lisp_Object *symbol;
     int *code;
     int *coredump;
{
  Lisp_Object tem;

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

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

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

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

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

504 505 506 507 508
/* 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.  */

509
static int
Jim Blandy's avatar
Jim Blandy committed
510 511
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
512
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
513 514 515 516 517 518 519 520 521
  int fd;

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

529 530 531
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
532 533 534 535 536 537 538
	{
	  { /* 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;
539

540 541 542 543 544 545 546 547
	    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
548
	  }
549 550 551 552 553 554
#  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
	}
555
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
556 557 558 559 560 561 562 563 564 565 566 567

	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 */
	    if (access (pty_name, 6) != 0)
	      {
568
		emacs_close (fd);
569
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
570
		continue;
571
# else
Jim Blandy's avatar
Jim Blandy committed
572
		return -1;
573
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
574 575 576 577 578 579 580 581 582
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

583
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
584 585 586 587 588 589 590 591
make_process (name)
     Lisp_Object name;
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

592
  p = allocate_process ();
593

594 595 596 597
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
598
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
599
  p->pty_flag = 0;
600
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
601 602 603
  p->status = Qrun;
  p->mark = Fmake_marker ();

Kenichi Handa's avatar
Kenichi Handa committed
604
#ifdef ADAPTIVE_READ_BUFFERING
605 606 607
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
608 609
#endif

Jim Blandy's avatar
Jim Blandy committed
610 611 612 613 614 615 616 617 618 619 620 621
  /* 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;
622
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
623 624 625 626
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

627
static void
Jim Blandy's avatar
Jim Blandy committed
628 629 630 631 632 633 634 635 636 637
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);
}
638 639 640 641 642 643 644 645

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
646 647
  int inch = p->infd;
  int outch = p->outfd;
Kenichi Handa's avatar
Kenichi Handa committed
648
  Lisp_Object coding_system;
649

650 651 652
  if (inch < 0 || outch < 0)
    return;

653 654 655
  if (!proc_decode_coding_system[inch])
    proc_decode_coding_system[inch]
      = (struct coding_system *) xmalloc (sizeof (struct coding_system));
Kenichi Handa's avatar
Kenichi Handa committed
656
  coding_system = p->decode_coding_system;
657
  if (! NILP (p->filter))
658
    ;
659 660 661
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
Kenichi Handa's avatar
Kenichi Handa committed
662
	coding_system = raw_text_coding_system (coding_system);
663
    }
Kenichi Handa's avatar
Kenichi Handa committed
664
  setup_coding_system (coding_system, proc_decode_coding_system[inch]);
665 666 667 668 669 670 671

  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
672 673

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
674 675
       doc: /* Return t if OBJECT is a process.  */)
     (object)
676
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
677
{
678
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
679 680 681
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
682 683
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
684 685
     register Lisp_Object name;
{
686
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
687
    return name;
688
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
689 690 691 692
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
693 694 695
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
696
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
697 698 699
{
  register Lisp_Object buf, tail, proc;

700 701
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
702 703
  if (NILP (buf)) return Qnil;

704
  for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
705
    {
706
      proc = Fcdr (XCAR (tail));
707
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
708 709 710 711 712
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
713 714 715 716
/* 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
717

718
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
719 720 721
get_process (name)
     register Lisp_Object name;
{
722 723 724 725 726 727 728
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
729
	error ("Process %s does not exist", SDATA (name));
730 731 732
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
733
  else
734 735 736 737 738
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
739
    {
740
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
741
      if (NILP (proc))
742
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
743 744
    }
  else
745
    {
746
      CHECK_PROCESS (obj);
747 748 749
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
750 751
}

752 753 754 755 756 757 758 759 760 761

#ifdef SIGCHLD
/* Fdelete_process promises to immediately forget about the process, but in
   reality, Emacs needs to remember those processes until they have been
   treated by sigchld_handler; otherwise this handler would consider the
   process as being synchronous and say that the synchronous process is
   dead.  */
static Lisp_Object deleted_pid_list;
#endif

Jim Blandy's avatar
Jim Blandy committed
762
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
763 764 765 766
       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)
767
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
768
{
769 770
  register struct Lisp_Process *p;

771
  process = get_process (process);
772 773
  p = XPROCESS (process);

774
  p->raw_status_new = 0;
775
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
776
    {
777
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
778
      p->tick = ++process_tick;
779
      status_notify (p);
Jim Blandy's avatar
Jim Blandy committed
780
    }
781
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
782
    {
783 784
#ifdef SIGCHLD
      Lisp_Object symbol;
785 786
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
787
      EMACS_INT pid = p->pid;
788 789

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
790
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
791 792 793 794 795 796 797 798 799
				/* GC treated elements set to nil.  */
				Fdelq (Qnil, deleted_pid_list));
      /* If the process has already signaled, remove it from the list.  */
      if (p->raw_status_new)
	update_status (p);
      symbol = p->status;
      if (CONSP (p->status))
	symbol = XCAR (p->status);
      if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
800 801
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
802 803 804 805 806 807 808
      else
#endif
	{
	  Fkill_process (process, Qnil);
	  /* Do this now, since remove_process will make sigchld_handler do nothing.  */
	  p->status
	    = Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
809
	  p->tick = ++process_tick;
810 811
	  status_notify (p);
	}
Jim Blandy's avatar
Jim Blandy committed
812
    }
813
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
814 815 816 817
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
818 819 820 821 822 823 824
       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.
825
listen -- for a network stream server that is listening.
826
closed -- for a network stream connection that is closed.
827 828
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
829 830 831 832
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)
833
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
834 835 836
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
837

838 839
  if (STRINGP (process))
    process = Fget_process (process);
840
  else
841
    process = get_process (process);
842

843 844
  if (NILP (process))
    return process;
845

846
  p = XPROCESS (process);
847
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
848 849
    update_status (p);
  status = p->status;
850
  if (CONSP (status))
851
    status = XCAR (status);
852
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
853
    {
854
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
855
	status = Qclosed;
856 857 858 859
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
860 861 862 863 864 865
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
866 867 868
       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)
869
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
870
{
871
  CHECK_PROCESS (process);
872
  if (XPROCESS (process)->raw_status_new)
873 874
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
875
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
876 877 878 879
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
880
       doc: /* Return the process id of PROCESS.
881
This is the pid of the external process which PROCESS uses or talks to.
882 883
For a network connection, this value is nil.  */)
     (process)
884
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
885
{
886 887 888 889
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

890
  CHECK_PROCESS (process);
891 892
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
893 894 895
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
896 897 898 899
       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)
900
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
901
{
902
  CHECK_PROCESS (process);
903
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
904 905 906
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
907 908 909
       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.
910 911
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
912
     (process)
913
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
914
{
915
  CHECK_PROCESS (process);
916
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
917 918
}

919
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
920 921 922 923
       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)
924
     register Lisp_Object process;
925
{
926
  CHECK_PROCESS (process);
927
  return XPROCESS (process)->tty_name;
928 929
}

Jim Blandy's avatar
Jim Blandy committed
930
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
931 932 933
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
934
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
935
{
936 937
  struct Lisp_Process *p;

938
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
939
  if (!NILP (buffer))
940
    CHECK_BUFFER (buffer);
941 942
  p = XPROCESS (process);
  p->buffer = buffer;
943
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
944
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
945
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
946 947 948 949
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
950 951 952 953
       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)
954
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
955
{
956
  CHECK_PROCESS (process);
957
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
958 959 960
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
961 962 963
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
964
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
965
{
966
  CHECK_PROCESS (process);
967
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
968 969 970
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
971 972
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
973
A value of t means stop accepting output from the process.
974 975 976

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
977
passed to the filter.
978

979
The filter gets two arguments: the process and the string of output.
980 981 982 983 984 985
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').  */)
986
     (process, filter)
987
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
988
{
989
  struct Lisp_Process *p;
990

991
  CHECK_PROCESS (process);
992 993 994 995 996 997 998 999 1000
  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 ...)  */
1001

1002
  if (p->infd >= 0)
1003
    {
1004
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1005
	{
1006 1007
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1008
	}
1009
      else if (EQ (p->filter, Qt)
1010 1011
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
1012
	{
1013 1014
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1015
	}
1016
    }
1017

1018
  p->filter = filter;
1019
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
1020
    p->childp = Fplist_put (p->childp, QCfilter, filter);
1021
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1022 1023 1024 1025
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1026 1027 1028 1029
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
     (process)
1030
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1031
{
1032
  CHECK_PROCESS (process);
1033
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1034 1035 1036
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1037 1038 1039 1040 1041
       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)
1042
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
1043
{
Kenichi Handa's avatar
Kenichi Handa committed
1044 1045
  struct Lisp_Process *p;

1046
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1047 1048 1049
  p = XPROCESS (process);

  p->sentinel = sentinel;
1050
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
1051
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1052 1053 1054 1055
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1056 1057 1058 1059
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
     (process)
1060
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1061
{
1062
  CHECK_PROCESS (process);
1063
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1064 1065
}

1066
DEFUN ("set-process-window-size", Fset_process_window_size,
1067 1068 1069
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
     (process, height, width)
1070
     register Lisp_Object process, height, width;
1071
{
1072 1073 1074
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
1075

1076 1077
  if (XPROCESS (process)->infd < 0
      || set_window_size (XPROCESS (process)->infd,
1078