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 ();
411

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

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

426
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
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.  */

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

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

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

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

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

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

519 520 521 522 523
/* 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.  */

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

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

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

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

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

616
  p = allocate_process ();
617

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

Kenichi Handa's avatar
Kenichi Handa committed
628
#ifdef ADAPTIVE_READ_BUFFERING
629 630 631
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
632 633
#endif

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

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

/* Setup coding systems of PROCESS.  */

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

674 675 676
  if (inch < 0 || outch < 0)
    return;

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

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

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

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

724 725
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
726 727
  if (NILP (buf)) return Qnil;

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

Jim Blandy's avatar
Jim Blandy committed
737 738 739 740
/* 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
741

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

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

776 777 778 779 780 781 782 783 784 785

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

795
  process = get_process (process);
796 797
  p = XPROCESS (process);

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

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

862 863
  if (STRINGP (process))
    process = Fget_process (process);
864
  else
865
    process = get_process (process);
866

867 868
  if (NILP (process))
    return process;
869

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

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

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

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

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

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

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

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

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

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

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

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

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
1001
passed to the filter.
1002

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

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

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

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

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

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

1070
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1071 1072 1073
  p = XPROCESS (process);

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

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