process.c 220 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 BROKEN_O_NONBLOCK
#undef O_NONBLOCK
#endif /* BROKEN_O_NONBLOCK */

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

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

Dave Love's avatar
Dave Love committed
106 107 108
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
109

110 111 112 113 114 115
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

116
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
117
#include "systime.h"
118
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
119 120 121

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

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

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

157 158 159 160 161
/* 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
162
#ifdef HAVE_SOCKETS
163 164 165 166
#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
167 168
#else
#define NETCONN_P(p) 0
169
#define NETCONN1_P(p) 0
170 171
#define SERIALCONN_P(p) 0
#define SERIALCONN1_P(p) 0
Jim Blandy's avatar
Jim Blandy committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
#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
190
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
191

192
extern char *get_operating_system_release ();
193

194 195 196 197 198 199 200 201 202 203 204
/* 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

205
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
206
extern int errno;
207
#endif
Roland McGrath's avatar
Roland McGrath committed
208
#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
209
extern char *sys_errlist[];
Roland McGrath's avatar
Roland McGrath committed
210
#endif
Jim Blandy's avatar
Jim Blandy committed
211

212 213 214 215
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
216 217
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
218
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
219

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

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
/* 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 */

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
/* 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 */

266 267
#ifdef TERM
#undef NON_BLOCKING_CONNECT
268
#undef DATAGRAM_SOCKETS
269 270
#endif

Kenichi Handa's avatar
Kenichi Handa committed
271 272 273 274 275 276 277 278 279 280 281
#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)

282 283
/* 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
284 285 286

static int process_output_delay_count;

287
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
288 289 290 291 292

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

300

301
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
302

303 304 305 306
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));
307

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

314 315 316 317 318 319
static Lisp_Object get_process ();
static void exec_sentinel ();

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

322 323
static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

328
/* Mask that excludes process input descriptor(s).  */
329 330 331

static SELECT_TYPE non_process_wait_mask;

332 333 334 335
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

336
#ifdef NON_BLOCKING_CONNECT
337 338 339 340 341 342 343 344 345
/* 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;

346 347 348 349 350
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

351 352 353
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

354 355
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
356

357 358 359
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

360 361
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
362 363

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

/* Alist of elements (NAME . PROCESS) */
367
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
368 369 370 371 372 373 374

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

375 376
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
377

Karl Heuer's avatar
Karl Heuer committed
378
/* Table of `struct coding-system' for each process.  */
379 380
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
381

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

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

398 399 400 401
/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
int inhibit_sentinels;

402
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
403 404 405
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
406
/* The file name of the pty opened by allocate_pty.  */
407 408

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

414
static Lisp_Object status_convert ();
415

416
static void
Jim Blandy's avatar
Jim Blandy committed
417 418 419 420
update_status (p)
     struct Lisp_Process *p;
{
  union { int i; WAITTYPE wt; } u;
421 422
  eassert (p->raw_status_new);
  u.i = p->raw_status;
Jim Blandy's avatar
Jim Blandy committed
423
  p->status = status_convert (u.wt);
424
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
425 426
}

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

430
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
status_convert (w)
     WAITTYPE w;
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
    return Fcons (Qexit, Fcons (make_number (WRETCODE (w)),
				WCOREDUMP (w) ? Qt : Qnil));
  else if (WIFSIGNALED (w))
    return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
				  WCOREDUMP (w) ? Qt : Qnil));
  else
    return Qrun;
}

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

449
static void
Jim Blandy's avatar
Jim Blandy committed
450 451 452 453 454 455 456 457
decode_status (l, symbol, code, coredump)
     Lisp_Object l;
     Lisp_Object *symbol;
     int *code;
     int *coredump;
{
  Lisp_Object tem;

458
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
459 460 461 462 463 464 465
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
466 467 468 469
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
470 471 472 473 474 475
      *coredump = !NILP (tem);
    }
}

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

476 477 478
static Lisp_Object
status_message (p)
     struct Lisp_Process *p;
Jim Blandy's avatar
Jim Blandy committed
479
{
480
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
481 482 483 484 485 486 487 488
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

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

523 524 525 526 527
/* 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.  */

528
static int
Jim Blandy's avatar
Jim Blandy committed
529 530
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
531
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538 539 540
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
541
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
542 543 544 545 546 547
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

548 549 550
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
	{
# 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;
566

567 568 569 570 571 572 573 574
	    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
575
	  }
576 577 578 579 580 581 582
#  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 */
	}
583
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
584 585 586 587 588 589 590 591 592 593 594 595

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

620
  p = allocate_process ();
621

622 623 624 625
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
626
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
627
  p->pty_flag = 0;
628
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
629 630 631
  p->status = Qrun;
  p->mark = Fmake_marker ();

Kenichi Handa's avatar
Kenichi Handa committed
632
#ifdef ADAPTIVE_READ_BUFFERING
633 634 635
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
636 637
#endif

Jim Blandy's avatar
Jim Blandy committed
638 639 640 641 642 643 644 645 646 647 648 649
  /* 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;
650
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
651 652 653 654
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

655
static void
Jim Blandy's avatar
Jim Blandy committed
656 657 658 659 660 661 662 663 664 665
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);
}
666 667 668 669 670 671 672 673

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
674 675
  int inch = p->infd;
  int outch = p->outfd;
Kenichi Handa's avatar
Kenichi Handa committed
676
  Lisp_Object coding_system;
677

678 679 680
  if (inch < 0 || outch < 0)
    return;

681 682 683
  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
684
  coding_system = p->decode_coding_system;
685
  if (! NILP (p->filter))
686
    ;
687 688 689
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
Kenichi Handa's avatar
Kenichi Handa committed
690
	coding_system = raw_text_coding_system (coding_system);
691
    }
Kenichi Handa's avatar
Kenichi Handa committed
692
  setup_coding_system (coding_system, proc_decode_coding_system[inch]);
693 694 695 696 697 698 699

  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
700 701

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
702 703
       doc: /* Return t if OBJECT is a process.  */)
     (object)
704
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
705
{
706
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
707 708 709
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
710 711
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
712 713
     register Lisp_Object name;
{
714
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
715
    return name;
716
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
721 722 723
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
724
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
725 726 727
{
  register Lisp_Object buf, tail, proc;

728 729
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
730 731
  if (NILP (buf)) return Qnil;

732
  for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
733
    {
734
      proc = Fcdr (XCAR (tail));
735
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
736 737 738 739 740
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
741 742 743 744
/* 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
745

746
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
747 748 749
get_process (name)
     register Lisp_Object name;
{
750 751 752 753 754 755 756
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
757
	error ("Process %s does not exist", SDATA (name));
758 759 760
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
761
  else
762 763 764 765 766
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
767
    {
768
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
769
      if (NILP (proc))
770
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
771 772
    }
  else
773
    {
774
      CHECK_PROCESS (obj);
775 776 777
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
778 779
}

780 781 782 783 784 785 786 787 788 789

#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
790
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
791 792 793 794
       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)
795
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
796
{
797 798
  register struct Lisp_Process *p;

799
  process = get_process (process);
800 801
  p = XPROCESS (process);

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

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

866 867
  if (STRINGP (process))
    process = Fget_process (process);
868
  else
869
    process = get_process (process);
870

871 872
  if (NILP (process))
    return process;
873

874
  p = XPROCESS (process);
875
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
876 877
    update_status (p);
  status = p->status;
878
  if (CONSP (status))
879
    status = XCAR (status);
880
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
881
    {
882
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
883
	status = Qclosed;
884 885 886 887
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
888 889 890 891 892 893
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
894 895 896
       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)
897
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
898
{
899
  CHECK_PROCESS (process);
900
  if (XPROCESS (process)->raw_status_new)
901 902
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
903
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
904 905 906 907
  return make_number (0);
}

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

918
  CHECK_PROCESS (process);
919 920
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
921 922 923
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
924 925 926 927
       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)
928
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
929
{
930
  CHECK_PROCESS (process);
931
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
932 933 934
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
935 936 937
       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.
938 939
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
940
     (process)
941
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
942
{
943
  CHECK_PROCESS (process);
944
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
945 946
}

947
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
948 949 950 951
       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)
952
     register Lisp_Object process;
953
{
954
  CHECK_PROCESS (process);
955
  return XPROCESS (process)->tty_name;
956 957
}

Jim Blandy's avatar
Jim Blandy committed
958
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
959 960 961
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
962
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
963
{
964 965
  struct Lisp_Process *p;

966
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
967
  if (!NILP (buffer))
968
    CHECK_BUFFER (buffer);
969 970
  p = XPROCESS (process);
  p->buffer = buffer;
971
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
972
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
973
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
974 975 976 977
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
978 979 980 981
       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)
982
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
983
{
984
  CHECK_PROCESS (process);
985
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
986 987 988
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
989 990 991
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
992
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
993
{
994
  CHECK_PROCESS (process);
995
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
996 997 998
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
999 1000
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
1001
A value of t means stop accepting output from the process.
1002 1003 1004

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
1005
passed to the filter.
1006

1007
The filter gets two arguments: the process and the string of output.
1008 1009 1010 1011 1012 1013
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').  */)
1014
     (process, filter)
1015
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
1016
{
1017
  struct Lisp_Process *p;
1018

1019
  CHECK_PROCESS (process);