process.c 219 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3
		 1996, 1998, 1999, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
		 2005, 2006, 2007, 2008, 2009, 2010 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
#include <signal.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 27 28 29
#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>
30
#include <setjmp.h>
31 32 33
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
34 35 36
#ifdef STDC_HEADERS
#include <stdlib.h>
#endif
37

Richard M. Stallman's avatar
Richard M. Stallman committed
38 39 40
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
41 42
#include <fcntl.h>

43 44 45
/* Only MS-DOS does not define `subprocesses'.  */
#ifdef subprocesses

Jim Blandy's avatar
Jim Blandy committed
46 47 48 49 50
#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>
51 52

/* Are local (unix) sockets supported?  */
53
#if defined (HAVE_SYS_UN_H)
54 55 56 57 58 59 60 61
#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
62 63
#endif /* HAVE_SOCKETS */

Dan Nicolaescu's avatar
Dan Nicolaescu committed
64
#if defined(HAVE_SYS_IOCTL_H)
Jim Blandy's avatar
Jim Blandy committed
65
#include <sys/ioctl.h>
66
#if !defined (O_NDELAY) && defined (HAVE_PTYS) && !defined(USG5)
Jim Blandy's avatar
Jim Blandy committed
67 68
#include <fcntl.h>
#endif /* HAVE_PTYS and no O_NDELAY */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
69
#endif /* HAVE_SYS_IOCTL_H */
Jim Blandy's avatar
Jim Blandy committed
70 71 72 73 74

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

Kenichi Handa's avatar
Kenichi Handa committed
75 76 77 78 79 80 81 82 83 84 85
/* Can we use SIOCGIFCONF and/or SIOCGIFADDR */
#ifdef HAVE_SOCKETS
#if defined(HAVE_SYS_IOCTL_H) && defined(HAVE_NET_IF_H)
/* sys/ioctl.h may have been included already */
#ifndef SIOCGIFADDR
#include <sys/ioctl.h>
#endif
#include <net/if.h>
#endif
#endif

Dave Love's avatar
Dave Love committed
86 87 88
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
89

90 91 92 93 94 95
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

96 97
#endif	/* subprocesses */

98
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
99
#include "systime.h"
100
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
101 102 103

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

120 121 122 123
#if defined (USE_GTK) || defined (HAVE_GCONF)
#include "xgselect.h"
#endif /* defined (USE_GTK) || defined (HAVE_GCONF) */

124 125
#ifdef subprocesses

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

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

148 149 150 151 152
/* 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
153
#ifdef HAVE_SOCKETS
154 155 156 157
#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
158 159
#else
#define NETCONN_P(p) 0
160
#define NETCONN1_P(p) 0
161 162
#define SERIALCONN_P(p) 0
#define SERIALCONN1_P(p) 0
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167 168 169 170 171 172 173 174
#endif /* HAVE_SOCKETS */

/* Define first descriptor number available for subprocesses.  */
#define FIRST_PROC_DESC 3

/* Define SIGCHLD as an alias for SIGCLD.  There are many conditionals
   testing SIGCHLD.  */

#if !defined (SIGCHLD) && defined (SIGCLD)
#define SIGCHLD SIGCLD
#endif /* SIGCLD */

175
extern char *get_operating_system_release (void);
176

177 178 179 180 181 182 183 184 185 186 187
/* 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

188 189 190 191
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
192 193
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
194
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
195

196 197
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
198
/* Number of events of change of status of a process.  */
199
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
200
/* Number of events for which the user or sentinel has been notified.  */
201
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
/* 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 */

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

Stefan Monnier's avatar
Stefan Monnier committed
242 243 244 245
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
246 247 248 249 250 251 252 253 254 255 256
#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)

257 258
/* 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
259 260 261

static int process_output_delay_count;

262
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
263 264 265 266 267

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

275 276 277 278 279
static int keyboard_bit_set (SELECT_TYPE *);
static void deactivate_process (Lisp_Object);
static void status_notify (struct Lisp_Process *);
static int read_process_output (Lisp_Object, int);
static void create_pty (Lisp_Object);
280

281
/* If we support a window system, turn on the code to poll periodically
282
   to detect C-g.  It isn't actually used when doing interrupt input.  */
283
#ifdef HAVE_WINDOW_SYSTEM
284 285 286
#define POLL_FOR_INPUT
#endif

287 288
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
289

290
#endif	/* subprocesses */
Jim Blandy's avatar
Jim Blandy committed
291

292
extern int timers_run;
293

294 295 296 297 298 299
Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
Lisp_Object QCname, QCtype;

300 301 302 303
/* Non-zero if keyboard input is on hold, zero otherwise.  */

static int kbd_is_on_hold;

304 305 306
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;

307 308 309 310
/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
int inhibit_sentinels;

311 312 313 314 315 316
#ifdef subprocesses

/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

317
/* Mask that excludes keyboard input descriptor(s).  */
318 319 320

static SELECT_TYPE non_keyboard_wait_mask;

321
/* Mask that excludes process input descriptor(s).  */
322 323 324

static SELECT_TYPE non_process_wait_mask;

325 326 327 328
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

329
#ifdef NON_BLOCKING_CONNECT
330 331 332 333 334 335 336 337 338
/* 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;

339
#define IF_NON_BLOCKING_CONNECT(s) s
340
#else  /* NON_BLOCKING_CONNECT */
341
#define IF_NON_BLOCKING_CONNECT(s)
342
#endif	/* NON_BLOCKING_CONNECT */
343

344 345 346
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

347 348
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
349

350 351 352
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

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

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

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

365 366
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
367

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

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

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

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

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

400
static Lisp_Object status_convert (int);
401

402
static void
403
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
404
{
405
  eassert (p->raw_status_new);
406
  p->status = status_convert (p->raw_status);
407
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
408 409
}

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

413
static Lisp_Object
414
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
{
  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.  */

431
static void
432
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
433 434 435
{
  Lisp_Object tem;

436
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440 441 442 443
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
444 445 446 447
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
448 449 450 451 452 453
      *coredump = !NILP (tem);
    }
}

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

454
static Lisp_Object
455
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
456
{
457
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461 462 463 464 465
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
466
      char *signame;
467
      synchronize_system_messages_locale ();
468
      signame = strsignal (code);
469
      if (signame == 0)
470 471 472 473 474 475 476 477 478
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

	  string = make_unibyte_string (signame, strlen (signame));
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
479
	  c1 = STRING_CHAR ((char *) SDATA (string));
480 481
	  c2 = DOWNCASE (c1);
	  if (c1 != c2)
482
	    Faset (string, make_number (0), make_number (c2));
483
	}
Jim Blandy's avatar
Jim Blandy committed
484 485 486 487 488
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
489 490
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
491 492
      if (code == 0)
	return build_string ("finished\n");
493
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
494
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
495 496
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
497
    }
498 499 500 501
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
502 503
      return concat3 (build_string ("failed with code "),
		      string, string2);
504
    }
Jim Blandy's avatar
Jim Blandy committed
505 506 507 508 509 510
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

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

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

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

536 537 538
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
539 540 541 542 543 544 545
	{
	  { /* 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;
546

547 548 549 550 551 552 553 554
	    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
555
	  }
556 557 558 559 560 561
#  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
	}
562
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
563 564 565 566 567 568 569 570

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

598
  p = allocate_process ();
599

600 601 602 603
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
604
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
605
  p->pty_flag = 0;
606
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
607 608
  p->status = Qrun;
  p->mark = Fmake_marker ();
609
  p->kill_without_query = 0;
Jim Blandy's avatar
Jim Blandy committed
610

Kenichi Handa's avatar
Kenichi Handa committed
611
#ifdef ADAPTIVE_READ_BUFFERING
612 613 614
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
615 616
#endif

Jim Blandy's avatar
Jim Blandy committed
617 618 619 620 621 622 623 624 625 626 627 628
  /* 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;
629
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
630 631 632 633
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

634
static void
635
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
636 637 638 639 640 641 642 643
{
  register Lisp_Object pair;

  pair = Frassq (proc, Vprocess_alist);
  Vprocess_alist = Fdelq (pair, Vprocess_alist);

  deactivate_process (proc);
}
644

Jim Blandy's avatar
Jim Blandy committed
645 646

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
647
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
648
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
649
{
650
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
651 652 653
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
654
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
655
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
656
{
657
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
658
    return name;
659
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
660 661 662
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
663 664 665 666
/* 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
667

668
static Lisp_Object
669
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
670
{
671 672 673 674 675 676 677
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
678
	error ("Process %s does not exist", SDATA (name));
679 680 681
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
682
  else
683 684 685 686 687
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
688
    {
689
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
690
      if (NILP (proc))
691
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
692 693
    }
  else
694
    {
695
      CHECK_PROCESS (obj);
696 697 698
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
699 700
}

701 702 703 704 705 706 707 708 709 710

#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
711
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
712 713 714
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
715
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
716
{
717 718
  register struct Lisp_Process *p;

719
  process = get_process (process);
720 721
  p = XPROCESS (process);

722
  p->raw_status_new = 0;
723
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
724
    {
725
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
726
      p->tick = ++process_tick;
727
      status_notify (p);
728
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
729
    }
730
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
731
    {
732 733
#ifdef SIGCHLD
      Lisp_Object symbol;
734 735
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
736
      EMACS_INT pid = p->pid;
737 738

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
739
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
740 741 742 743 744 745 746 747 748
				/* 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))
749 750
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
751 752 753 754 755 756 757
      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));
758
	  p->tick = ++process_tick;
759
	  status_notify (p);
760
	  redisplay_preserve_echo_area (13);
761
	}
Jim Blandy's avatar
Jim Blandy committed
762
    }
763
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
764 765 766 767
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
768 769 770 771 772 773 774
       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.
775
listen -- for a network stream server that is listening.
776
closed -- for a network stream connection that is closed.
777 778
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
779 780 781
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
782
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
783 784 785
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
786

787 788
  if (STRINGP (process))
    process = Fget_process (process);
789
  else
790
    process = get_process (process);
791

792 793
  if (NILP (process))
    return process;
794

795
  p = XPROCESS (process);
796
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
797 798
    update_status (p);
  status = p->status;
799
  if (CONSP (status))
800
    status = XCAR (status);
801
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
802
    {
803
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
804
	status = Qclosed;
805 806 807 808
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
809 810 811 812 813 814
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
815 816
       doc: /* Return the exit status of PROCESS or the signal number that killed it.
If PROCESS has not yet exited or died, return 0.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
817
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
818
{
819
  CHECK_PROCESS (process);
820
  if (XPROCESS (process)->raw_status_new)
821 822
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
823
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
824 825 826 827
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
828
       doc: /* Return the process id of PROCESS.
829
This is the pid of the external process which PROCESS uses or talks to.
830
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
831
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
832
{
833 834 835 836
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

837
  CHECK_PROCESS (process);
838 839
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
840 841 842
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
843 844 845
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
846
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
847
{
848
  CHECK_PROCESS (process);
849
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
850 851 852
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
853 854 855
       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.
856 857
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
858
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
859
{
860
  CHECK_PROCESS (process);
861
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
862 863
}

864
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
865 866 867
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
868
  (register Lisp_Object process)
869
{
870
  CHECK_PROCESS (process);
871
  return XPROCESS (process)->tty_name;
872 873
}

Jim Blandy's avatar
Jim Blandy committed
874
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
875 876
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
877
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
878
{
879 880
  struct Lisp_Process *p;

881
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
882
  if (!NILP (buffer))
883
    CHECK_BUFFER (buffer);
884 885
  p = XPROCESS (process);
  p->buffer = buffer;
886
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
887
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
888
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
889 890 891 892
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
893 894 895
       1, 1, 0,
       doc: /* Return the buffer PROCESS is associated with.
Output from PROCESS is inserted in this buffer unless PROCESS has a filter.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
896
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
897
{
898
  CHECK_PROCESS (process);
899
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
900 901 902
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
903 904
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
905
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
906
{
907
  CHECK_PROCESS (process);
908
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
909 910 911
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
912 913
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
914
A value of t means stop accepting output from the process.
915 916 917

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
918
passed to the filter.
919

920
The filter gets two arguments: the process and the string of output.
921 922 923 924 925 926
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').  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
927
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
928
{
929
  struct Lisp_Process *p;
930

931
  CHECK_PROCESS (process);
932 933 934 935 936 937 938 939 940
  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 ...)  */
941

942
  if (p->infd >= 0)
943
    {
944
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
945
	{
946 947
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
948
	}
949
      else if (EQ (p->filter, Qt)
950 951
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
952
	{
953 954
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
955
	}
956
    }
957

958
  p->filter = filter;
959
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
960
    p->childp = Fplist_put (p->childp, QCfilter, filter);
961
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
962 963 964 965
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
966 967 968
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
969
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
970
{
971
  CHECK_PROCESS (process);
972
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
973 974 975
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
976 977 978 979
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
980
  (register Lisp_Object process, Lisp_Object sentinel)
Jim Blandy's avatar
Jim Blandy committed
981
{
Kenichi Handa's avatar
Kenichi Handa committed
982 983
  struct Lisp_Process *p;

984
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
985 986 987
  p = XPROCESS (process);

  p->sentinel = sentinel;
988
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
989
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
990 991 992 993
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
994 995 996
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
997
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
998
{
999
  CHECK_PROCESS (process);
1000
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1001 1002
}

1003
DEFUN ("set-process-window-size", Fset_process_window_size,
1004 1005
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1006
  (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1007
{
1008 1009 1010
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
1011

1012 1013
  if (XPROCESS (process)->infd < 0
      || set_window_size (XPROCESS (process)->infd,
1014
			  XINT (height), XINT (width)) <= 0)
1015 1016 1017 1018 1019
    return Qnil;
  else
    return Qt;
}

1020
DEFUN ("set-process-inherit-coding-system-flag",
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
       Fset_process_inherit_coding_system_flag,
       Sset_process_inherit_coding_system_flag, 2, 2, 0,
       doc: /* Determine whether buffer of PROCESS will inherit coding-system.
If the second argument FLAG is non-nil, then the variable
`buffer-file-coding-system' of the buffer associated with PROCESS
will be bound to the value of the coding system used to decode
the process output.

This is useful when the coding system specified for the process buffer
leaves either the character code conversion or the end-of-line conversion
unspecified, or if the coding system used to decode the process output
is more appropriate for saving the process buffer.

Binding the variable `inherit-process-coding-system' to non-nil before
starting the process is an alternative way of setting the inherit flag
for the process which will run.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1037
  (register Lisp_Object process, Lisp_Object flag)
1038
{
1039
  CHECK_PROCESS (process);
1040
  XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1041 1042 1043
  return flag;
}