process.c 208 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 8 9

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22 23


24
#include <config.h>
25 26
#include <signal.h>

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

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

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

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

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

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

85 86 87 88
#ifdef BROKEN_O_NONBLOCK
#undef O_NONBLOCK
#endif /* BROKEN_O_NONBLOCK */

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

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

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

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

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

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

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

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

156 157 158 159 160
/* 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
161
/* a process object is a network connection when its childp field is neither
162
   Qt nor Qnil but is instead a property list (KEY VAL ...).  */
Jim Blandy's avatar
Jim Blandy committed
163 164

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

190
extern char *get_operating_system_release ();
191

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

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

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

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

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

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

253 254
#ifdef TERM
#undef NON_BLOCKING_CONNECT
255
#undef DATAGRAM_SOCKETS
256 257
#endif

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

269 270
/* 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
271 272 273

static int process_output_delay_count;

274
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
275 276 277 278 279

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

287

288
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
289

290 291 292 293
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));
294

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

301 302 303 304 305 306
static Lisp_Object get_process ();
static void exec_sentinel ();

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

309 310
static SELECT_TYPE input_wait_mask;

311
/* Mask that excludes keyboard input descriptor(s).  */
312 313 314

static SELECT_TYPE non_keyboard_wait_mask;

315
/* Mask that excludes process input descriptor(s).  */
316 317 318

static SELECT_TYPE non_process_wait_mask;

319 320 321 322
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

323
#ifdef NON_BLOCKING_CONNECT
324 325 326 327 328 329 330 331 332
/* 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;

333 334 335 336 337
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

338 339 340
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

341 342
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
343

344 345 346
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

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

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

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

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

362 363
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
364

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

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

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

385 386 387 388
/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
int inhibit_sentinels;

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

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

401
static Lisp_Object status_convert ();
402

403
static void
Jim Blandy's avatar
Jim Blandy committed
404 405 406 407
update_status (p)
     struct Lisp_Process *p;
{
  union { int i; WAITTYPE wt; } u;
408 409
  eassert (p->raw_status_new);
  u.i = p->raw_status;
Jim Blandy's avatar
Jim Blandy committed
410
  p->status = status_convert (u.wt);
411
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
412 413
}

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

417
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
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.  */

436
static void
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440 441 442 443 444
decode_status (l, symbol, code, coredump)
     Lisp_Object l;
     Lisp_Object *symbol;
     int *code;
     int *coredump;
{
  Lisp_Object tem;

445
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449 450 451 452
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
453 454 455 456
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460 461 462
      *coredump = !NILP (tem);
    }
}

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

463 464 465
static Lisp_Object
status_message (p)
     struct Lisp_Process *p;
Jim Blandy's avatar
Jim Blandy committed
466
{
467
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
468 469 470 471 472 473 474 475
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

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

510 511 512 513 514
/* 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.  */

515
static int
Jim Blandy's avatar
Jim Blandy committed
516 517
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
518
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
519 520 521 522 523 524 525 526 527
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
528
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
529 530 531 532 533 534
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

535 536 537
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
	{
# 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;
553

554 555 556 557 558 559 560 561
	    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
562
	  }
563 564 565 566 567 568 569
#  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 */
	}
570
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
571 572 573 574 575 576 577 578 579 580 581 582

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

607
  p = allocate_process ();
608

609 610 611 612
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
613
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
614
  p->pty_flag = 0;
615
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
616 617 618
  p->status = Qrun;
  p->mark = Fmake_marker ();

Kenichi Handa's avatar
Kenichi Handa committed
619
#ifdef ADAPTIVE_READ_BUFFERING
620 621 622
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
623 624
#endif

Jim Blandy's avatar
Jim Blandy committed
625 626 627 628 629 630 631 632 633 634 635 636
  /* 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;
637
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
638 639 640 641
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

642
static void
Jim Blandy's avatar
Jim Blandy committed
643 644 645 646 647 648 649 650 651 652
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);
}
653 654 655 656 657 658 659 660

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
661 662
  int inch = p->infd;
  int outch = p->outfd;
Kenichi Handa's avatar
Kenichi Handa committed
663
  Lisp_Object coding_system;
664

665 666 667
  if (inch < 0 || outch < 0)
    return;

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

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

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

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

718 719
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
720 721
  if (NILP (buf)) return Qnil;

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

Jim Blandy's avatar
Jim Blandy committed
731 732 733 734
/* 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
735

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

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

770 771 772 773 774 775 776 777 778 779

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

789
  process = get_process (process);
790 791
  p = XPROCESS (process);

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

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

856 857
  if (STRINGP (process))
    process = Fget_process (process);
858
  else
859
    process = get_process (process);
860

861 862
  if (NILP (process))
    return process;
863

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

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

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

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

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

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
925 926 927 928 929
       doc: /* Return the command that was executed to start PROCESS.
This is a list of strings, the first string being the program executed
and the rest of the strings being the arguments given to it.
For a non-child channel, this is nil.  */)
     (process)
930
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
931
{
932
  CHECK_PROCESS (process);
933
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
934 935
}

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

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

955
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
956
  if (!NILP (buffer))
957
    CHECK_BUFFER (buffer);
958 959 960 961
  p = XPROCESS (process);
  p->buffer = buffer;
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
962
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
963 964 965 966
  return buffer;
}

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

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

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

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
994
passed to the filter.
995

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

1008
  CHECK_PROCESS (process);
1009 1010 1011 1012 1013 1014 1015 1016 1017
  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 ...)  */
1018

1019
  if (p->infd >= 0)
1020
    {
1021
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1022
	{
1023 1024
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1025
	}
1026 1027
      else if (EQ (p->filter, Qt)
	       && !EQ (p->command, Qt)) /* Network process not stopped. */
1028
	{
1029 1030
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1031
	}
1032
    }
1033

1034
  p->filter = filter;
1035 1036
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCfilter, filter);
1037
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1038 1039 1040 1041
  return filter;
}

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

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1053 1054 1055 1056 1057
       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)
1058
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
1059
{
Kenichi Handa's avatar
Kenichi Handa committed
1060 1061
  struct Lisp_Process *p;

1062
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1063 1064 1065 1066 1067
  p = XPROCESS (process);

  p->sentinel = sentinel;
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1068 1069 1070 1071
  return sentinel;
}

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

1082
DEFUN ("set-process-window-size", Fset_process_window_size,
1083 1084 1085
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
     (process, height, width)
1086
     register Lisp_Object process, height, width;
1087
{
1088 1089 1090
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
1091

1092 1093