process.c 219 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2 3 4

Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2011
  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

Richard M. Stallman's avatar
Richard M. Stallman committed
35
#include <unistd.h>
36 37
#include <fcntl.h>

38 39 40
/* Only MS-DOS does not define `subprocesses'.  */
#ifdef subprocesses

Jim Blandy's avatar
Jim Blandy committed
41 42 43 44
#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
45 46

/* Are local (unix) sockets supported?  */
47
#if defined (HAVE_SYS_UN_H)
48 49 50 51 52 53 54 55
#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
56 57

#include <sys/ioctl.h>
58 59 60
#if defined(HAVE_NET_IF_H)
#include <net/if.h>
#endif /* HAVE_NET_IF_H */
Jim Blandy's avatar
Jim Blandy committed
61 62 63 64 65

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

66 67 68 69 70 71
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

72 73 74 75
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
76 77 78 79
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

80 81
#endif	/* subprocesses */

82
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
83
#include "systime.h"
84
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
85 86 87

#include "window.h"
#include "buffer.h"
88
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
89
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
90
#include "process.h"
91
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
92 93 94
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
95
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
96
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
97
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
98
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
99
#include "atimer.h"
100 101 102
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
103 104 105
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
106

107 108 109
#if defined (USE_GTK) || defined (HAVE_GCONF)
#include "xgselect.h"
#endif /* defined (USE_GTK) || defined (HAVE_GCONF) */
110 111 112
#ifdef HAVE_NS
#include "nsterm.h"
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
113

114 115 116 117 118 119 120 121 122 123 124 125 126 127
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;

/* Non-zero if keyboard input is on hold, zero otherwise.  */

static int kbd_is_on_hold;

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

128 129
#ifdef subprocesses

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

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

152 153 154 155 156
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

157 158 159 160
#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
161 162 163 164

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

165
extern const char *get_operating_system_release (void);
166

167 168 169 170
/* From sysdep.c or w32.c  */
extern int serial_open (char *port);
extern void serial_configure (struct Lisp_Process *p, Lisp_Object contact);

171 172 173 174
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

175 176
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
177
/* Number of events of change of status of a process.  */
178
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
179
/* Number of events for which the user or sentinel has been notified.  */
180
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
181

182 183
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

184
/* Only W32 has this, it really means that select can't take write mask.  */
185 186
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
187
#define SELECT_CANT_DO_WRITE_MASK
188 189 190 191 192 193 194 195 196 197 198 199 200 201
#else
#ifndef NON_BLOCKING_CONNECT
#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 /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
/* 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
#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 /* DATAGRAM_SOCKETS */
#endif /* BROKEN_DATAGRAM_SOCKETS */

Stefan Monnier's avatar
Stefan Monnier committed
219 220 221 222
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
223 224 225 226 227 228 229 230 231 232 233
#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)

234 235
/* 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
236 237 238

static int process_output_delay_count;

239
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
240 241 242 243 244 245 246

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

247 248 249 250 251
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);
252

253
/* If we support a window system, turn on the code to poll periodically
254
   to detect C-g.  It isn't actually used when doing interrupt input.  */
255
#ifdef HAVE_WINDOW_SYSTEM
256 257 258
#define POLL_FOR_INPUT
#endif

259 260
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
261

262 263 264 265
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

266
/* Mask that excludes keyboard input descriptor(s).  */
267 268 269

static SELECT_TYPE non_keyboard_wait_mask;

270
/* Mask that excludes process input descriptor(s).  */
271 272 273

static SELECT_TYPE non_process_wait_mask;

274
/* Mask for selecting for write.  */
275

276
static SELECT_TYPE write_mask;
277

278
#ifdef NON_BLOCKING_CONNECT
279 280 281 282 283 284 285 286 287
/* 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;

288
#define IF_NON_BLOCKING_CONNECT(s) s
289
#else  /* NON_BLOCKING_CONNECT */
290
#define IF_NON_BLOCKING_CONNECT(s)
291
#endif	/* NON_BLOCKING_CONNECT */
292

293 294 295
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

296 297
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
298

Jim Blandy's avatar
Jim Blandy committed
299
/* Indexed by descriptor, gives the process (if any) for that descriptor */
300
Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
301 302

/* Alist of elements (NAME . PROCESS) */
303
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
304 305 306 307 308 309 310

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

311 312
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
313

Karl Heuer's avatar
Karl Heuer committed
314
/* Table of `struct coding-system' for each process.  */
315 316
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
317

318 319 320 321 322 323 324
#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)
325
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
326 327 328 329 330
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413


struct fd_callback_data
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
  int condition; /* mask of the defines above.  */
} fd_callback_info[MAXDESC];


/* Add a file descriptor FD to be monitored for when read is possible.
   When read is possible, call FUNC with argument DATA.  */

void
add_read_fd (int fd, fd_callback func, void *data)
{
  xassert (fd < MAXDESC);
  add_keyboard_wait_descriptor (fd);

  fd_callback_info[fd].func = func;
  fd_callback_info[fd].data = data;
  fd_callback_info[fd].condition |= FOR_READ;
}

/* Stop monitoring file descriptor FD for when read is possible.  */

void
delete_read_fd (int fd)
{
  xassert (fd < MAXDESC);
  delete_keyboard_wait_descriptor (fd);

  fd_callback_info[fd].condition &= ~FOR_READ;
  if (fd_callback_info[fd].condition == 0)
    {
      fd_callback_info[fd].func = 0;
      fd_callback_info[fd].data = 0;
    }
}

/* Add a file descriptor FD to be monitored for when write is possible.
   When write is possible, call FUNC with argument DATA.  */

void
add_write_fd (int fd, fd_callback func, void *data)
{
  xassert (fd < MAXDESC);
  FD_SET (fd, &write_mask);
  if (fd > max_input_desc)
    max_input_desc = fd;

  fd_callback_info[fd].func = func;
  fd_callback_info[fd].data = data;
  fd_callback_info[fd].condition |= FOR_WRITE;
}

/* Stop monitoring file descriptor FD for when write is possible.  */

void
delete_write_fd (int fd)
{
  int lim = max_input_desc;

  xassert (fd < MAXDESC);
  FD_CLR (fd, &write_mask);
  fd_callback_info[fd].condition &= ~FOR_WRITE;
  if (fd_callback_info[fd].condition == 0)
    {
      fd_callback_info[fd].func = 0;
      fd_callback_info[fd].data = 0;

      if (fd == max_input_desc)
        for (fd = lim; fd >= 0; fd--)
          if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
            {
              max_input_desc = fd;
              break;
            }
414

415 416 417
    }
}

Jim Blandy's avatar
Jim Blandy committed
418 419 420 421

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

422
static Lisp_Object status_convert (int);
423

424
static void
425
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
426
{
427
  eassert (p->raw_status_new);
428
  p->status = status_convert (p->raw_status);
429
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
430 431
}

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

435
static Lisp_Object
436
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
{
  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.  */

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

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

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

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

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
488
      char *signame;
489
      synchronize_system_messages_locale ();
490
      signame = strsignal (code);
491
      if (signame == 0)
492 493 494 495 496 497 498 499 500
	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));
501
	  c1 = STRING_CHAR (SDATA (string));
502 503
	  c2 = DOWNCASE (c1);
	  if (c1 != c2)
504
	    Faset (string, make_number (0), make_number (c2));
505
	}
Jim Blandy's avatar
Jim Blandy committed
506 507 508 509 510
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
511 512
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
513 514
      if (code == 0)
	return build_string ("finished\n");
515
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
516
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
517 518
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
519
    }
520 521 522 523
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
524 525
      return concat3 (build_string ("failed with code "),
		      string, string2);
526
    }
Jim Blandy's avatar
Jim Blandy committed
527 528 529 530 531 532
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

Dan Nicolaescu's avatar
Dan Nicolaescu committed
533 534 535
/* The file name of the pty opened by allocate_pty.  */
static char pty_name[24];

536 537 538 539 540
/* 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.  */

541
static int
542
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
543
{
Andreas Schwab's avatar
Andreas Schwab committed
544
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
545 546 547 548 549 550 551 552 553
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
554
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
555 556 557 558 559 560
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

561 562 563
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
564 565 566 567 568 569 570
	{
	  { /* 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;
571

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

	if (fd >= 0)
	  {
	    /* check to make certain that both sides are available
	       this avoids a nasty yet stupid bug in rlogins */
#ifdef PTY_TTY_NAME_SPRINTF
	    PTY_TTY_NAME_SPRINTF
#else
596
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
597 598 599
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
600
		emacs_close (fd);
601
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
602
		continue;
603
# else
Jim Blandy's avatar
Jim Blandy committed
604
		return -1;
605
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
606 607 608 609 610 611 612 613 614
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

615
static Lisp_Object
616
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
617 618 619 620 621 622
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

623
  p = allocate_process ();
624

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

Kenichi Handa's avatar
Kenichi Handa committed
636
#ifdef ADAPTIVE_READ_BUFFERING
637 638 639
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
640 641
#endif

Ted Zlatanov's avatar
Ted Zlatanov committed
642 643
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
644
  p->gnutls_log_level = 0;
645
  p->gnutls_p = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
646 647
#endif

Jim Blandy's avatar
Jim Blandy committed
648 649 650 651 652 653 654 655 656 657 658 659
  /* 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;
660
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
661 662 663 664
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

665
static void
666
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
667 668 669 670 671 672 673 674
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
675

Jim Blandy's avatar
Jim Blandy committed
676 677

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
678
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
679
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
680
{
681
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
682 683 684
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
685
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
686
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
687
{
688
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
689
    return name;
690
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
691 692 693
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
694 695 696 697
/* 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
698

699
static Lisp_Object
700
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
701
{
702 703 704 705 706 707 708
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
709
	error ("Process %s does not exist", SDATA (name));
710 711 712
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
713
  else
714 715 716 717 718
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
719
    {
720
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
721
      if (NILP (proc))
722
	error ("Buffer %s has no process", SDATA (B_ (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
723 724
    }
  else
725
    {
726
      CHECK_PROCESS (obj);
727 728 729
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
730 731
}

732 733 734 735 736 737 738 739 740 741

#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
742
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
743 744 745
       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
746
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
747
{
748 749
  register struct Lisp_Process *p;

750
  process = get_process (process);
751 752
  p = XPROCESS (process);

753
  p->raw_status_new = 0;
754
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
755
    {
756
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
757
      p->tick = ++process_tick;
758
      status_notify (p);
759
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
760
    }
761
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
762
    {
763 764
#ifdef SIGCHLD
      Lisp_Object symbol;
765 766
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
767
      EMACS_INT pid = p->pid;
768 769

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
770
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
771 772 773 774 775 776 777 778 779
				/* 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))
780 781
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
782 783 784 785 786 787 788
      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));
789
	  p->tick = ++process_tick;
790
	  status_notify (p);
791
	  redisplay_preserve_echo_area (13);
792
	}
Jim Blandy's avatar
Jim Blandy committed
793
    }
794
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
795 796 797 798
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
799 800 801 802 803 804 805
       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.
806
listen -- for a network stream server that is listening.
807
closed -- for a network stream connection that is closed.
808 809
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
810 811 812
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
813
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
814 815 816
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
817

818 819
  if (STRINGP (process))
    process = Fget_process (process);
820
  else
821
    process = get_process (process);
822

823 824
  if (NILP (process))
    return process;
825

826
  p = XPROCESS (process);
827
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
828 829
    update_status (p);
  status = p->status;
830
  if (CONSP (status))
831
    status = XCAR (status);
832
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
833
    {
834
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
835
	status = Qclosed;
836 837 838 839
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
840 841 842 843 844 845
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
846 847
       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
848
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
849
{
850
  CHECK_PROCESS (process);
851
  if (XPROCESS (process)->raw_status_new)
852 853
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
854
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
855 856 857 858
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
859
       doc: /* Return the process id of PROCESS.
860
This is the pid of the external process which PROCESS uses or talks to.
861
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
862
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
863
{
864 865 866 867
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

868
  CHECK_PROCESS (process);
869 870
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
871 872 873
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
874 875 876
       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
877
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
878
{
879
  CHECK_PROCESS (process);
880
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
881 882 883
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
884 885 886
       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.
887 888
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
889
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
890
{
891
  CHECK_PROCESS (process);
892
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
893 894
}

895
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
896 897 898
       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
899
  (register Lisp_Object process)
900
{
901
  CHECK_PROCESS (process);
902
  return XPROCESS (process)->tty_name;
903 904
}

Jim Blandy's avatar
Jim Blandy committed
905
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
906 907
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
908
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
909
{
910 911
  struct Lisp_Process *p;

912
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
913
  if (!NILP (buffer))
914
    CHECK_BUFFER (buffer);
915 916
  p = XPROCESS (process);
  p->buffer = buffer;
917
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
918
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
919
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
920 921 922 923
  return buffer;
}

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

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
934 935
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
936
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
937
{
938
  CHECK_PROCESS (process);
939
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
940 941 942
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
943 944
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
945
A value of t means stop accepting output from the process.
946 947 948

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
949
passed to the filter.
950

951
The filter gets two arguments: the process and the string of output.
952 953 954 955 956 957
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
958
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
959
{
960
  struct Lisp_Process *p;
961

962
  CHECK_PROCESS (process);
963 964 965 966 967 968 969 970 971
  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 ...)  */
972

973
  if (p->infd >= 0)
974
    {
975
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
976
	{
977 978
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
979
	}
980
      else if (EQ (p->filter, Qt)
981 982
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
983
	{
984 985
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
986
	}
987
    }
988

989
  p->filter = filter;
990
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
991
    p->childp = Fplist_put (p->childp, QCfilter, filter);
992
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
993 994 995 996
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
997 998 999
       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
1000
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1001
{
1002
  CHECK_PROCESS (process);
1003
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1004 1005 1006
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1007 1008 1009 1010
       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
1011
  (register Lisp_Object process, Lisp_Object sentinel)
Jim Blandy's avatar
Jim Blandy committed
1012
{
Kenichi Handa's avatar
Kenichi Handa committed
1013 1014
  struct Lisp_Process *p;

1015
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1016 1017 1018
  p = XPROCESS (process);

  p->sentinel = sentinel;
1019
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
1020
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1021 1022 1023 1024
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1025 1026 1027
       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
1028
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1029
{
1030
  CHECK_PROCESS (process);
1031
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1032 1033
}

1034
DEFUN ("set-process-window-size", Fset_process_window_size,
1035 1036
       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
1037
  (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1038
{
1039 1040 1041
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
1042

1043 1044
  if (XPROCESS (process)->infd < 0
      || set_window_size (XPROCESS (process)->infd,
1045
			  XINT (height), XINT (width)) <= 0)
1046 1047 1048 1049 1050
    return Qnil;
  else
    return Qt;
}

1051
DEFUN ("set-process-inherit-coding-system-flag",
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
       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
1068
  (register Lisp_Object process, Lisp_Object flag)
1069
{
1070
  CHECK_PROCESS (process);
1071
  XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1072 1073 1074
  return flag;
}

1075 1076 1077 1078
DEFUN ("set-process-query-on-exit-flag",
       Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
       2, 2, 0,
       doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1079
If the second argument FLAG is non-nil, Emacs will query the user before
1080
exiting or killing a buffer if PROCESS is running.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1081
  (register Lisp_Object process, Lisp_Object flag)
Jim Blandy's avatar