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-1988, 1993-1996, 1998-1999, 2001-2012
4
  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
#include <stdio.h>
#include <errno.h>
#include <setjmp.h>
27
#include <sys/types.h>		/* Some typedefs are used in sys/file.h.  */
Jim Blandy's avatar
Jim Blandy committed
28 29
#include <sys/file.h>
#include <sys/stat.h>
30
#include <setjmp.h>
31

Richard M. Stallman's avatar
Richard M. Stallman committed
32
#include <unistd.h>
33 34
#include <fcntl.h>

35 36
#include "lisp.h"

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

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

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

#include <sys/ioctl.h>
Juanma Barranquero's avatar
Juanma Barranquero committed
57
#if defined (HAVE_NET_IF_H)
58 59
#include <net/if.h>
#endif /* HAVE_NET_IF_H */
Jim Blandy's avatar
Jim Blandy committed
60

Juanma Barranquero's avatar
Juanma Barranquero committed
61
#if defined (HAVE_IFADDRS_H)
62 63 64 65
/* Must be after net/if.h */
#include <ifaddrs.h>

/* We only use structs from this header when we use getifaddrs.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
66
#if defined (HAVE_NET_IF_DL_H)
67 68 69 70 71
#include <net/if_dl.h>
#endif

#endif

Jim Blandy's avatar
Jim Blandy committed
72 73 74 75
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

76 77 78 79 80 81
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

82 83 84 85
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
86 87 88 89
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

90 91
#endif	/* subprocesses */

Jim Blandy's avatar
Jim Blandy committed
92
#include "systime.h"
93
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
94 95

#include "window.h"
96
#include "character.h"
97
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
98
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
99
#include "process.h"
100
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
101 102 103
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
104
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
105
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
106
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
107
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
108
#include "atimer.h"
109 110 111
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
112 113 114
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
115

116
#if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
117
#include "xgselect.h"
118
#endif
119 120 121
#ifdef HAVE_NS
#include "nsterm.h"
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
122

123 124 125 126 127 128 129
/* Work around GCC 4.7.0 bug with strict overflow checking; see
   <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
   These lines can be removed once the GCC bug is fixed.  */
#if (__GNUC__ == 4 && 3 <= __GNUC_MINOR__) || 4 < __GNUC__
# pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

130 131 132 133 134 135 136 137 138 139 140 141 142 143
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;

144 145
#ifdef subprocesses

146
Lisp_Object Qprocessp;
147 148 149 150 151
static Lisp_Object Qrun, Qstop, Qsignal;
static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
Lisp_Object Qlocal;
static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
static Lisp_Object Qreal, Qnetwork, Qserial;
Kim F. Storm's avatar
Kim F. Storm committed
152
#ifdef AF_INET6
153
static Lisp_Object Qipv6;
Kim F. Storm's avatar
Kim F. Storm committed
154
#endif
155 156
static Lisp_Object QCport, QCprocess;
Lisp_Object QCspeed;
157 158
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
159 160 161 162 163
static Lisp_Object QCbuffer, QChost, QCservice;
static Lisp_Object QClocal, QCremote, QCcoding;
static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
static Lisp_Object Qlast_nonmenu_event;
164 165 166 167
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

170 171 172 173 174
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

175 176 177 178
#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
179

180 181 182 183
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
184
/* Number of events of change of status of a process.  */
185
static EMACS_INT process_tick;
Jim Blandy's avatar
Jim Blandy committed
186
/* Number of events for which the user or sentinel has been notified.  */
187
static EMACS_INT update_tick;
Jim Blandy's avatar
Jim Blandy committed
188

189 190
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

191
/* Only W32 has this, it really means that select can't take write mask.  */
192 193
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
194
#define SELECT_CANT_DO_WRITE_MASK
195 196 197 198 199 200 201 202 203 204 205 206 207 208
#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 */

209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
/* 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
226 227 228 229
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
230 231 232 233 234
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#define ADAPTIVE_READ_BUFFERING
#endif

#ifdef ADAPTIVE_READ_BUFFERING
235
#define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
236 237 238
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

239 240
/* 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
241 242 243

static int process_output_delay_count;

244
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
245 246 247 248 249 250 251

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

252
static Lisp_Object Fget_process (Lisp_Object);
253
static void create_process (Lisp_Object, char **, Lisp_Object);
254
#ifdef SIGIO
255
static int keyboard_bit_set (SELECT_TYPE *);
256
#endif
257 258 259 260
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);
261

262
/* If we support a window system, turn on the code to poll periodically
263
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
264
#if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
265 266 267
#define POLL_FOR_INPUT
#endif

268 269
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
270

271 272 273 274
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

275
/* Mask that excludes keyboard input descriptor(s).  */
276 277 278

static SELECT_TYPE non_keyboard_wait_mask;

279
/* Mask that excludes process input descriptor(s).  */
280 281 282

static SELECT_TYPE non_process_wait_mask;

283
/* Mask for selecting for write.  */
284

285
static SELECT_TYPE write_mask;
286

287
#ifdef NON_BLOCKING_CONNECT
288 289 290 291 292 293 294 295
/* 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;
296
#endif	/* NON_BLOCKING_CONNECT */
297

298 299 300
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

301 302
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
303

Jim Blandy's avatar
Jim Blandy committed
304
/* Indexed by descriptor, gives the process (if any) for that descriptor */
305
static Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
306 307

/* Alist of elements (NAME . PROCESS) */
308
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312 313 314 315

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

316
static int proc_buffered_char[MAXDESC];
317

Karl Heuer's avatar
Karl Heuer committed
318
/* Table of `struct coding-system' for each process.  */
319 320
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
321

322 323
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
324
static struct sockaddr_and_len {
325 326 327 328
  struct sockaddr *sa;
  int len;
} datagram_address[MAXDESC];
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
329
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
330 331 332 333 334
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

338 339


340
static struct fd_callback_data
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 414 415 416 417
{
  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;
            }
418

419 420 421
    }
}

Jim Blandy's avatar
Jim Blandy committed
422 423 424 425

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

426
static Lisp_Object status_convert (int);
427

428
static void
429
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
430
{
431
  eassert (p->raw_status_new);
432
  p->status = status_convert (p->raw_status);
433
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
434 435
}

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

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

457
static void
458
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
459 460 461
{
  Lisp_Object tem;

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

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

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

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

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

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

540 541 542 543 544
/* 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.  */

545
static int
546
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551 552
{
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
553
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
554 555 556 557 558 559 560 561 562 563
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

564 565 566
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
567 568 569 570 571 572 573
	{
	  { /* 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;
574
	    struct stat stb;
575

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

	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
600
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
601 602 603
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
604
		emacs_close (fd);
605
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
606
		continue;
607
# else
Jim Blandy's avatar
Jim Blandy committed
608
		return -1;
609
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
610 611 612 613 614 615 616 617 618
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

619
static Lisp_Object
620
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
621 622 623
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
624 625
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
626

627
  p = allocate_process ();
628

629 630 631 632
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
633
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
634
  p->pty_flag = 0;
635
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
636 637
  p->status = Qrun;
  p->mark = Fmake_marker ();
638
  p->kill_without_query = 0;
639
  p->write_queue = Qnil;
Jim Blandy's avatar
Jim Blandy committed
640

Kenichi Handa's avatar
Kenichi Handa committed
641
#ifdef ADAPTIVE_READ_BUFFERING
642 643 644
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
645 646
#endif

Ted Zlatanov's avatar
Ted Zlatanov committed
647 648
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
649
  /* Default log level.  */
650
  p->gnutls_log_level = 0;
651 652
  /* GnuTLS handshakes attempted for this connection.  */
  p->gnutls_handshakes_tried = 0;
653
  p->gnutls_p = 0;
Chong Yidong's avatar
Chong Yidong committed
654
  p->gnutls_state = NULL;
655 656
  p->gnutls_x509_cred = NULL;
  p->gnutls_anon_cred = NULL;
Ted Zlatanov's avatar
Ted Zlatanov committed
657 658
#endif

Jim Blandy's avatar
Jim Blandy committed
659 660 661 662 663 664 665
  /* 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;
666
      sprintf (suffix, "<%"pMd">", i);
Jim Blandy's avatar
Jim Blandy committed
667 668 669 670
      name1 = concat2 (name, build_string (suffix));
    }
  name = name1;
  p->name = name;
671
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
672 673 674 675
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

676
static void
677
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
678 679 680 681 682 683 684 685
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
686

Jim Blandy's avatar
Jim Blandy committed
687 688

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
689
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
690
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
691
{
692
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
693 694 695
}

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

Jim Blandy's avatar
Jim Blandy committed
705 706 707 708
/* 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
709

710
static Lisp_Object
711
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
712
{
713 714 715 716 717 718 719
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
720
	error ("Process %s does not exist", SDATA (name));
721 722 723
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
724
  else
725 726 727 728 729
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
730
    {
731
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
732
      if (NILP (proc))
Tom Tromey's avatar
Tom Tromey committed
733
	error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
734 735
    }
  else
736
    {
737
      CHECK_PROCESS (obj);
738 739 740
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
741 742
}

743 744 745 746 747 748 749 750 751 752

#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
753
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
754 755 756
       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
757
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
758
{
759 760
  register struct Lisp_Process *p;

761
  process = get_process (process);
762 763
  p = XPROCESS (process);

764
  p->raw_status_new = 0;
765
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
766
    {
767
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
768
      p->tick = ++process_tick;
769
      status_notify (p);
770
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
771
    }
772
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
773
    {
774 775
#ifdef SIGCHLD
      Lisp_Object symbol;
776
      pid_t pid = p->pid;
777 778

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

827 828
  if (STRINGP (process))
    process = Fget_process (process);
829
  else
830
    process = get_process (process);
831

832 833
  if (NILP (process))
    return process;
834

835
  p = XPROCESS (process);
836
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
837 838
    update_status (p);
  status = p->status;
839
  if (CONSP (status))
840
    status = XCAR (status);
841
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
842
    {
843
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
844
	status = Qclosed;
845 846 847 848
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
849 850 851 852 853 854
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
855 856
       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
857
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
858
{
859
  CHECK_PROCESS (process);
860
  if (XPROCESS (process)->raw_status_new)
861 862
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
863
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
864 865 866 867
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
868
       doc: /* Return the process id of PROCESS.
869
This is the pid of the external process which PROCESS uses or talks to.
870
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
871
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
872
{
873
  pid_t pid;
874

875
  CHECK_PROCESS (process);
876 877
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
878 879 880
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
881 882 883
       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
884
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
885
{
886
  CHECK_PROCESS (process);
887
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
888 889 890
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
891 892 893
       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.
894 895
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
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)->command;
Jim Blandy's avatar
Jim Blandy committed
900 901
}

902
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
903 904 905
       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
906
  (register Lisp_Object process)
907
{
908
  CHECK_PROCESS (process);
909
  return XPROCESS (process)->tty_name;
910 911
}

Jim Blandy's avatar
Jim Blandy committed
912
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
913
       2, 2, 0,
914 915
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
916
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
917
{
918 919
  struct Lisp_Process *p;

920
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
921
  if (!NILP (buffer))
922
    CHECK_BUFFER (buffer);
923 924
  p = XPROCESS (process);
  p->buffer = buffer;
925
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
926
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
927
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
928 929 930 931
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
932 933 934
       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
935
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
936
{
937
  CHECK_PROCESS (process);
938
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
939 940 941
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
942 943
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
944
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
945
{
946
  CHECK_PROCESS (process);
947
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
948 949 950
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
951 952
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
953
A value of t means stop accepting output from the process.
954 955 956

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
957
passed to the filter.
958

959
The filter gets two arguments: the process and the string of output.
960 961 962 963 964 965
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
966
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
967
{
968
  struct Lisp_Process *p;
969

970
  CHECK_PROCESS (process);
971 972 973 974 975 976 977 978 979
  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 ...)  */
980

981
  if (p->infd >= 0)
982
    {
983
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
984
	{
985 986
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
987
	}
988
      else if (EQ (p->filter, Qt)
989 990
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
991
	{
992 993
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
994
	}
995
    }
996

997
  p->filter = filter;
998
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
999
    p->childp = Fplist_put (p->childp, QCfilter, filter);
1000
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1001 1002 1003 1004
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1005 1006 1007
       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
1008
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1009
{
1010
  CHECK_PROCESS (process);
1011
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1015 1016 1017 1018
       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
1019
  (register Lisp_Object process, Lisp_Object sentinel)
Jim Blandy's avatar
Jim Blandy committed
1020
{
Kenichi Handa's avatar
Kenichi Handa committed
1021 1022
  struct Lisp_Process *p;

1023
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1024 1025 1026
  p = XPROCESS (process);

  p->sentinel = sentinel;
1027
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
1028
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1029 1030 1031 1032
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1033 1034 1035
       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
1036
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1037
{
1038
  CHECK_PROCESS (process);
1039
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1040 1041
}

1042
DEFUN ("set-process-window-size", Fset_process_window_size,
1043 1044
       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
1045
  (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1046
{
1047
  CHECK_PROCESS (process);