process.c 217 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 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
Richard M. Stallman's avatar
Richard M. Stallman committed
44 45 46
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
47

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

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

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
87 88 89 90 91 92 93 94 95 96 97
/* 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
98 99 100
#ifdef IRIS
#include <sys/sysmacros.h>	/* for "minor" */
#endif /* not IRIS */
101

Dave Love's avatar
Dave Love committed
102 103 104
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
105

106 107 108 109 110 111
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

112
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
113
#include "systime.h"
114
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
115 116 117

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

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

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

153 154 155 156 157
/* 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
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 182 183 184 185
#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
186
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
187

188
extern char *get_operating_system_release ();
189

190 191 192 193 194 195 196 197 198 199 200
/* 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

201
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
202
extern int errno;
203
#endif
Roland McGrath's avatar
Roland McGrath committed
204
#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
205
extern char *sys_errlist[];
Roland McGrath's avatar
Roland McGrath committed
206
#endif
Jim Blandy's avatar
Jim Blandy committed
207

208 209 210 211
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
212 213
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
214
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
215

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

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

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
/* 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 */

262 263
#ifdef TERM
#undef NON_BLOCKING_CONNECT
264
#undef DATAGRAM_SOCKETS
265 266
#endif

Kenichi Handa's avatar
Kenichi Handa committed
267 268 269 270 271 272 273 274 275 276 277
#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)

278 279
/* 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
280 281 282

static int process_output_delay_count;

283
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
284 285 286 287 288

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
289 290
   non-nil value does not reset the delay.  A value of nil disables
   adaptive read buffering completely.  */
Kenichi Handa's avatar
Kenichi Handa committed
291 292 293 294 295
static Lisp_Object Vprocess_adaptive_read_buffering;
#else
#define process_output_delay_count 0
#endif

296

297
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
298

299 300 301 302
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));
303

304
/* If we support a window system, turn on the code to poll periodically
305
   to detect C-g.  It isn't actually used when doing interrupt input.  */
306
#ifdef HAVE_WINDOW_SYSTEM
307 308 309
#define POLL_FOR_INPUT
#endif

310 311 312 313 314 315
static Lisp_Object get_process ();
static void exec_sentinel ();

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

318 319
static SELECT_TYPE input_wait_mask;

320
/* Mask that excludes keyboard input descriptor(s).  */
321 322 323

static SELECT_TYPE non_keyboard_wait_mask;

324
/* Mask that excludes process input descriptor(s).  */
325 326 327

static SELECT_TYPE non_process_wait_mask;

328 329 330 331
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

332
#ifdef NON_BLOCKING_CONNECT
333 334 335 336 337 338 339 340 341
/* 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;

342 343 344 345 346
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

347 348 349
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

350 351
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
352

353 354 355
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

356 357
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
358 359

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

/* Alist of elements (NAME . PROCESS) */
363
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
364 365 366 367 368 369 370

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

371 372
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
373

Karl Heuer's avatar
Karl Heuer committed
374
/* Table of `struct coding-system' for each process.  */
375 376
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
377

378 379 380 381 382 383 384
#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)
385
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
386 387 388 389 390
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

394 395 396 397
/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
int inhibit_sentinels;

398
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
399 400 401
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
402
/* The file name of the pty opened by allocate_pty.  */
403 404

static char pty_name[24];
405
#endif
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

410
static Lisp_Object status_convert (int);
411

412
static void
Jim Blandy's avatar
Jim Blandy committed
413 414 415
update_status (p)
     struct Lisp_Process *p;
{
416
  eassert (p->raw_status_new);
417
  p->status = status_convert (p->raw_status);
418
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
419 420
}

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

424
static Lisp_Object
425
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
{
  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.  */

442
static void
Jim Blandy's avatar
Jim Blandy committed
443 444 445 446 447 448 449 450
decode_status (l, symbol, code, coredump)
     Lisp_Object l;
     Lisp_Object *symbol;
     int *code;
     int *coredump;
{
  Lisp_Object tem;

451
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
452 453 454 455 456 457 458
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
459 460 461 462
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
463 464 465 466 467 468
      *coredump = !NILP (tem);
    }
}

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

469 470 471
static Lisp_Object
status_message (p)
     struct Lisp_Process *p;
Jim Blandy's avatar
Jim Blandy committed
472
{
473
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
474 475 476 477 478 479 480 481
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
482
      char *signame;
483
      synchronize_system_messages_locale ();
484
      signame = strsignal (code);
485 486 487
      if (signame == 0)
	signame = "unknown";
      string = build_string (signame);
Jim Blandy's avatar
Jim Blandy committed
488
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
489
      SSET (string, 0, DOWNCASE (SREF (string, 0)));
Jim Blandy's avatar
Jim Blandy committed
490 491 492 493
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
494 495
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
496 497
      if (code == 0)
	return build_string ("finished\n");
498
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
499
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
500 501
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
502
    }
503 504 505 506
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
507 508
      return concat3 (build_string ("failed with code "),
		      string, string2);
509
    }
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513 514 515
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

516 517 518 519 520
/* 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.  */

521
static int
Jim Blandy's avatar
Jim Blandy committed
522 523
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
524
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
525 526 527 528 529 530 531 532 533
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
534
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
535 536 537 538 539 540
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

541 542 543
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
	{
# 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;
559

560 561 562 563 564 565 566 567
	    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
568
	  }
569 570 571 572 573 574 575
#  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 */
	}
576
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580 581 582 583 584 585 586 587 588

	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)
	      {
589
		emacs_close (fd);
590
# if !defined(IRIS) && !defined(__sgi)
Jim Blandy's avatar
Jim Blandy committed
591
		continue;
592
# else
Jim Blandy's avatar
Jim Blandy committed
593
		return -1;
594
# endif /* IRIS */
Jim Blandy's avatar
Jim Blandy committed
595 596 597 598 599 600 601 602 603
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

604
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
605 606 607 608 609 610 611 612
make_process (name)
     Lisp_Object name;
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

613
  p = allocate_process ();
614

615 616 617 618
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
619
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
620
  p->pty_flag = 0;
621
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
622 623 624
  p->status = Qrun;
  p->mark = Fmake_marker ();

Kenichi Handa's avatar
Kenichi Handa committed
625
#ifdef ADAPTIVE_READ_BUFFERING
626 627 628
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
629 630
#endif

Jim Blandy's avatar
Jim Blandy committed
631 632 633 634 635 636 637 638 639 640 641 642
  /* 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;
643
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
644 645 646 647
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

648
static void
Jim Blandy's avatar
Jim Blandy committed
649 650 651 652 653 654 655 656 657 658
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);
}
659 660 661 662 663 664 665 666

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
667 668
  int inch = p->infd;
  int outch = p->outfd;
Kenichi Handa's avatar
Kenichi Handa committed
669
  Lisp_Object coding_system;
670

671 672 673
  if (inch < 0 || outch < 0)
    return;

674 675 676
  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
677
  coding_system = p->decode_coding_system;
678
  if (! NILP (p->filter))
679
    ;
680 681 682
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
Kenichi Handa's avatar
Kenichi Handa committed
683
	coding_system = raw_text_coding_system (coding_system);
684
    }
Kenichi Handa's avatar
Kenichi Handa committed
685
  setup_coding_system (coding_system, proc_decode_coding_system[inch]);
686 687 688 689 690 691 692

  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
693 694

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
695 696
       doc: /* Return t if OBJECT is a process.  */)
     (object)
697
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
698
{
699
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
700 701 702
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
703 704
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
705 706
     register Lisp_Object name;
{
707
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
708
    return name;
709
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
710 711 712 713
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
714 715 716
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
717
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
718 719 720
{
  register Lisp_Object buf, tail, proc;

721 722
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
723 724
  if (NILP (buf)) return Qnil;

725
  for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
726
    {
727
      proc = Fcdr (XCAR (tail));
728
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
729 730 731 732 733
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
734 735 736 737
/* 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
738

739
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
740 741 742
get_process (name)
     register Lisp_Object name;
{
743 744 745 746 747 748 749
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
750
	error ("Process %s does not exist", SDATA (name));
751 752 753
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
754
  else
755 756 757 758 759
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
760
    {
761
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
762
      if (NILP (proc))
763
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
764 765
    }
  else
766
    {
767
      CHECK_PROCESS (obj);
768 769 770
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
771 772
}

773 774 775 776 777 778 779 780 781 782

#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
783
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
784 785 786 787
       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)
788
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
789
{
790 791
  register struct Lisp_Process *p;

792
  process = get_process (process);
793 794
  p = XPROCESS (process);

795
  p->raw_status_new = 0;
796
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
797
    {
798
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
799
      p->tick = ++process_tick;
800
      status_notify (p);
Jim Blandy's avatar
Jim Blandy committed
801
    }
802
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
803
    {
804 805
#ifdef SIGCHLD
      Lisp_Object symbol;
806 807
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
808
      EMACS_INT pid = p->pid;
809 810

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
811
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
812 813 814 815 816 817 818 819 820
				/* 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))
821 822
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
823 824 825 826 827 828 829
      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));
830
	  p->tick = ++process_tick;
831 832
	  status_notify (p);
	}
Jim Blandy's avatar
Jim Blandy committed
833
    }
834
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
835 836 837 838
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
839 840 841 842 843 844 845
       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.
846
listen -- for a network stream server that is listening.
847
closed -- for a network stream connection that is closed.
848 849
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
850 851 852 853
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)
854
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
855 856 857
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
858

859 860
  if (STRINGP (process))
    process = Fget_process (process);
861
  else
862
    process = get_process (process);
863

864 865
  if (NILP (process))
    return process;
866

867
  p = XPROCESS (process);
868
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
869 870
    update_status (p);
  status = p->status;
871
  if (CONSP (status))
872
    status = XCAR (status);
873
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
874
    {
875
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
876
	status = Qclosed;
877 878 879 880
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
881 882 883 884 885 886
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
887 888 889
       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)
890
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
891
{
892
  CHECK_PROCESS (process);
893
  if (XPROCESS (process)->raw_status_new)
894 895
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
896
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
897 898 899 900
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
901
       doc: /* Return the process id of PROCESS.
902
This is the pid of the external process which PROCESS uses or talks to.
903 904
For a network connection, this value is nil.  */)
     (process)
905
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
906
{
907 908 909 910
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

911
  CHECK_PROCESS (process);
912 913
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
914 915 916
}

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

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
928 929 930
       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.
931 932
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
933
     (process)
934
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
935
{
936
  CHECK_PROCESS (process);
937
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
938 939
}

940
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
941 942 943 944
       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)
945
     register Lisp_Object process;
946
{
947
  CHECK_PROCESS (process);
948
  return XPROCESS (process)->tty_name;
949 950
}

Jim Blandy's avatar
Jim Blandy committed
951
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
952 953 954
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
955
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
956
{
957 958
  struct Lisp_Process *p;

959
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
960
  if (!NILP (buffer))
961
    CHECK_BUFFER (buffer);
962 963
  p = XPROCESS (process);
  p->buffer = buffer;
964
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
965
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
966
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
967 968 969 970
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
971 972 973 974
       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)
975
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
976
{
977
  CHECK_PROCESS (process);
978
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
979 980 981
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
982 983 984
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
985
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
986
{
987
  CHECK_PROCESS (process);
988
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
989 990 991
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
992 993
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
994
A value of t means stop accepting output from the process.
995 996 997

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
998
passed to the filter.
999

1000
The filter gets two arguments: the process and the string of output.
1001 1002 1003 1004 1005 1006
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').  */)
1007
     (process, filter)
1008
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
1009
{
1010
  struct Lisp_Process *p;
1011

1012
  CHECK_PROCESS (process);
1013 1014 1015 1016 1017 1018 1019 1020 1021
  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 ...)  */
1022

1023
  if (p->infd >= 0)
1024
    {
1025
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1026
	{
1027 1028
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1029
	}
1030
      else if (EQ (p->filter, Qt)
1031 1032
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
1033
	{
1034 1035
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1036
	}
1037
    }
1038

1039
  p->filter = filter;
1040
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
1041
    p->childp = Fplist_put (p->childp, QCfilter, filter);
1042
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1043 1044 1045 1046
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1047 1048 1049 1050
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
     (process)
1051
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1052
{
1053
  CHECK_PROCESS (process);
1054
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1055 1056 1057
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1058 1059 1060 1061 1062
       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)
1063
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
1064
{
Kenichi Handa's avatar
Kenichi Handa committed
1065 1066
  struct Lisp_Process *p;

1067
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1068 1069 1070
  p = XPROCESS (process);

  p->sentinel = sentinel;
1071
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
1072
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1073 1074 1075 1076
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1077 1078 1079 1080
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
     (process)
1081
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1082
{
1083
  CHECK_PROCESS (process);
1084
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar