process.c 224 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3
		 1996, 1998, 1999, 2001, 2002, 2003, 2004,
4
		 2005, 2006, 2007, 2008, 2009 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 36 37 38 39 40
#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>
41 42 43
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
44 45 46
#ifdef STDC_HEADERS
#include <stdlib.h>
#endif
47

Richard M. Stallman's avatar
Richard M. Stallman committed
48 49 50
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
51 52
#include <fcntl.h>

Jim Blandy's avatar
Jim Blandy committed
53 54 55 56 57
#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>
58 59

/* Are local (unix) sockets supported?  */
60
#if defined (HAVE_SYS_UN_H)
61 62 63 64 65 66 67 68
#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
69 70
#endif /* HAVE_SOCKETS */

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

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

Kenichi Handa's avatar
Kenichi Handa committed
82 83 84 85 86 87 88 89 90 91 92
/* 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
93 94 95
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
96

97 98 99 100 101 102
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

103
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
104
#include "systime.h"
105
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
106 107 108

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

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

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

144 145 146 147 148
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

149 150 151
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;
152
Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
153

Jim Blandy's avatar
Jim Blandy committed
154
#ifdef HAVE_SOCKETS
155 156 157 158
#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
159 160
#else
#define NETCONN_P(p) 0
161
#define NETCONN1_P(p) 0
162 163
#define SERIALCONN_P(p) 0
#define SERIALCONN1_P(p) 0
Jim Blandy's avatar
Jim Blandy committed
164 165 166 167 168 169 170 171 172 173 174 175 176 177
#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
178
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
179

180
extern char *get_operating_system_release ();
181

182 183 184 185 186 187 188 189 190 191 192
/* 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

193
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
194
extern int errno;
195
#endif
Jim Blandy's avatar
Jim Blandy committed
196

197 198 199 200
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
201 202
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
203
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
204

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

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
/* 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 */

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
/* 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
251 252 253 254 255 256 257 258 259 260 261
#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)

262 263
/* 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
264 265 266

static int process_output_delay_count;

267
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
268 269 270 271 272

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

280

281
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
282

283 284 285 286
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));
287

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

294 295 296 297 298 299
static Lisp_Object get_process ();
static void exec_sentinel ();

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

302 303
static SELECT_TYPE input_wait_mask;

304
/* Mask that excludes keyboard input descriptor(s).  */
305 306 307

static SELECT_TYPE non_keyboard_wait_mask;

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

static SELECT_TYPE non_process_wait_mask;

312 313 314 315
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

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

326 327 328 329 330
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

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

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

337 338 339
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

340 341
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
342 343

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

/* Alist of elements (NAME . PROCESS) */
347
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
348 349 350 351 352 353 354

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

355 356
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
357

Karl Heuer's avatar
Karl Heuer committed
358
/* Table of `struct coding-system' for each process.  */
359 360
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
361

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

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

378 379 380 381
/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
int inhibit_sentinels;

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

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

394
static Lisp_Object status_convert (int);
395

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

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

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

426
static void
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430 431 432 433 434
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
      int c;
468
      synchronize_system_messages_locale ();
469
      signame = strsignal (code);
470 471 472
      if (signame == 0)
	signame = "unknown";
      string = build_string (signame);
Jim Blandy's avatar
Jim Blandy committed
473
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
474 475
      c = STRING_CHAR ((char *) SDATA (string), 0);
      Faset (string, 0, make_number (DOWNCASE (c)));
Jim Blandy's avatar
Jim Blandy committed
476 477 478 479
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
480 481
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
482 483
      if (code == 0)
	return build_string ("finished\n");
484
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
485
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
486 487
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
488
    }
489 490 491 492
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
493 494
      return concat3 (build_string ("failed with code "),
		      string, string2);
495
    }
Jim Blandy's avatar
Jim Blandy committed
496 497 498 499 500 501
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

502 503 504 505 506
/* 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.  */

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

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

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

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

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

590
  p = allocate_process ();
591

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

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

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

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

/* Setup coding systems of PROCESS.  */

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

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

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

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

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

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

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

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

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

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

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

751 752 753 754 755 756 757 758 759 760

#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
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
  register struct Lisp_Process *p;

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

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

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
789
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
790 791 792 793 794 795 796 797 798
				/* 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))
799 800
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
801 802 803 804 805 806 807
      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));
808
	  p->tick = ++process_tick;
809 810
	  status_notify (p);
	}
Jim Blandy's avatar
Jim Blandy committed
811
    }
812
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
813 814 815 816
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
817 818 819 820 821 822 823
       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.
824
listen -- for a network stream server that is listening.
825
closed -- for a network stream connection that is closed.
826 827
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
828 829 830 831
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)
832
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
833 834 835
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
836

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1065
DEFUN ("set-process-window-size", Fset_process_window_size,
1066 1067 1068
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
     (process, height, width)
10