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

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2016 Free Software
Paul Eggert's avatar
Paul Eggert committed
4
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>
Paul Eggert's avatar
Paul Eggert committed
23

Jim Blandy's avatar
Jim Blandy committed
24 25
#include <stdio.h>
#include <errno.h>
26
#include <sys/types.h>		/* Some typedefs are used in sys/file.h.  */
Jim Blandy's avatar
Jim Blandy committed
27 28
#include <sys/file.h>
#include <sys/stat.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
29
#include <unistd.h>
30 31
#include <fcntl.h>

32 33
#include "lisp.h"

34 35 36
/* Only MS-DOS does not define `subprocesses'.  */
#ifdef subprocesses

Jim Blandy's avatar
Jim Blandy committed
37 38 39 40
#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
41 42

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

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

Juanma Barranquero's avatar
Juanma Barranquero committed
58
#if defined (HAVE_IFADDRS_H)
59 60 61 62
/* 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
63
#if defined (HAVE_NET_IF_DL_H)
64 65 66 67 68
#include <net/if_dl.h>
#endif

#endif

Jim Blandy's avatar
Jim Blandy committed
69 70 71 72
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

Paul Eggert's avatar
Paul Eggert committed
73 74 75 76 77
#ifdef USG5_4
# include <sys/stream.h>
# include <sys/stropts.h>
#endif

78 79 80 81
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
82 83 84 85
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

86 87
#include <c-ctype.h>
#include <sig2str.h>
88
#include <verify.h>
89

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
#include "termopts.h"
102
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
103
#include "blockinput.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
104
#include "atimer.h"
105 106 107
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
108 109 110
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
111

112 113 114 115
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

116
#ifdef HAVE_GLIB
117
#include "xgselect.h"
118 119 120
#ifndef WINDOWSNT
#include <glib.h>
#endif
121
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
122

123
#ifdef WINDOWSNT
124
extern int sys_select (int, fd_set *, fd_set *, fd_set *,
125
		       struct timespec *, void *);
126 127
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
128 129
/* Work around GCC 4.7.0 bug with strict overflow checking; see
   <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
130 131
   This bug appears to be fixed in GCC 5.1, so don't work around it there.  */
#if __GNUC__ == 4 && __GNUC_MINOR__ >= 3
Eli Zaretskii's avatar
Eli Zaretskii committed
132 133 134 135 136 137 138 139 140 141 142 143 144
# pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

/* True if keyboard input is on hold, zero otherwise.  */

static bool kbd_is_on_hold;

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

#ifdef subprocesses

145 146
#ifndef SOCK_CLOEXEC
# define SOCK_CLOEXEC 0
Paul Eggert's avatar
Paul Eggert committed
147 148 149
#endif

#ifndef HAVE_ACCEPT4
150 151 152 153 154 155 156 157 158 159 160

/* Emulate GNU/Linux accept4 and socket well enough for this module.  */

static int
close_on_exec (int fd)
{
  if (0 <= fd)
    fcntl (fd, F_SETFD, FD_CLOEXEC);
  return fd;
}

161 162 163
# undef accept4
# define accept4(sockfd, addr, addrlen, flags) \
    process_accept4 (sockfd, addr, addrlen, flags)
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
static int
accept4 (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags)
{
  return close_on_exec (accept (sockfd, addr, addrlen));
}

static int
process_socket (int domain, int type, int protocol)
{
  return close_on_exec (socket (domain, type, protocol));
}
# undef socket
# define socket(domain, type, protocol) process_socket (domain, type, protocol)
#endif

179 180 181 182
#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))
183 184
#define PIPECONN_P(p) (EQ (XPROCESS (p)->type, Qpipe))
#define PIPECONN1_P(p) (EQ (p->type, Qpipe))
Jim Blandy's avatar
Jim Blandy committed
185 186

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

191 192 193 194 195 196 197 198 199
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.
   The code can be simplified by assuming NON_BLOCKING_CONNECT once
   Emacs starts assuming POSIX 1003.1-2001 or later.  */

#if (defined HAVE_SELECT				\
     && (defined GNU_LINUX || defined HAVE_GETPEERNAME)	\
     && (defined EWOULDBLOCK || defined EINPROGRESS))
# define NON_BLOCKING_CONNECT
#endif
200

201 202 203 204 205
/* 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.  */

Paul Eggert's avatar
Paul Eggert committed
206 207 208 209 210 211 212
#ifndef BROKEN_DATAGRAM_SOCKETS
# if defined HAVE_SELECT || defined USABLE_FIONREAD
#  if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
#   define DATAGRAM_SOCKETS
#  endif
# endif
#endif
213

Stefan Monnier's avatar
Stefan Monnier committed
214 215 216 217
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

218
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
219 220 221
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

222 223
/* 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
224 225 226

static int process_output_delay_count;

227
/* True if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
228

229
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
230

231
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
232
#ifdef USABLE_SIGIO
233
static bool keyboard_bit_set (fd_set *);
234
#endif
235
static void deactivate_process (Lisp_Object);
236
static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
237
static int read_process_output (Lisp_Object, int);
238
static void handle_child_signal (int);
239
static void create_pty (Lisp_Object);
240

241 242
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
243

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

246
static fd_set input_wait_mask;
247

248
/* Mask that excludes keyboard input descriptor(s).  */
249

250
static fd_set non_keyboard_wait_mask;
251

252
/* Mask that excludes process input descriptor(s).  */
253

254
static fd_set non_process_wait_mask;
255

256
/* Mask for selecting for write.  */
257

258
static fd_set write_mask;
259

260
#ifdef NON_BLOCKING_CONNECT
261 262 263 264
/* 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.  */

265
static fd_set connect_wait_mask;
266 267 268

/* Number of bits set in connect_wait_mask.  */
static int num_pending_connects;
269
#endif	/* NON_BLOCKING_CONNECT */
270

271
/* The largest descriptor currently in use for a process object; -1 if none.  */
272 273
static int max_process_desc;

274
/* The largest descriptor currently in use for input; -1 if none.  */
275
static int max_input_desc;
276

277
/* Indexed by descriptor, gives the process (if any) for that descriptor.  */
278
static Lisp_Object chan_process[FD_SETSIZE];
279
static void wait_for_socket_fds (Lisp_Object, char const *);
Jim Blandy's avatar
Jim Blandy committed
280

281
/* Alist of elements (NAME . PROCESS).  */
282
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
283 284 285 286 287 288 289

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

290
static int proc_buffered_char[FD_SETSIZE];
291

Karl Heuer's avatar
Karl Heuer committed
292
/* Table of `struct coding-system' for each process.  */
293 294
static struct coding_system *proc_decode_coding_system[FD_SETSIZE];
static struct coding_system *proc_encode_coding_system[FD_SETSIZE];
Karl Heuer's avatar
Karl Heuer committed
295

296 297
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
298
static struct sockaddr_and_len {
299
  struct sockaddr *sa;
300
  ptrdiff_t len;
301
} datagram_address[FD_SETSIZE];
302
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
303 304 305 306
#define DATAGRAM_CONN_P(proc)                                           \
  (PROCESSP (proc) &&                                                   \
   XPROCESS (proc)->infd >= 0 &&                                        \
   datagram_address[XPROCESS (proc)->infd].sa != 0)
307 308 309 310 311
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

312 313 314 315 316 317
/* FOR_EACH_PROCESS (LIST_VAR, PROC_VAR) followed by a statement is
   a `for' loop which iterates over processes from Vprocess_alist.  */

#define FOR_EACH_PROCESS(list_var, proc_var)			\
  FOR_EACH_ALIST_VALUE (Vprocess_alist, list_var, proc_var)

Paul Eggert's avatar
Paul Eggert committed
318
/* These setters are used only in this file, so they can be private.  */
319
static void
Paul Eggert's avatar
Paul Eggert committed
320 321 322 323
pset_buffer (struct Lisp_Process *p, Lisp_Object val)
{
  p->buffer = val;
}
324
static void
Paul Eggert's avatar
Paul Eggert committed
325 326 327 328
pset_command (struct Lisp_Process *p, Lisp_Object val)
{
  p->command = val;
}
329
static void
Paul Eggert's avatar
Paul Eggert committed
330 331 332 333
pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->decode_coding_system = val;
}
334
static void
Paul Eggert's avatar
Paul Eggert committed
335 336 337 338
pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->decoding_buf = val;
}
339
static void
Paul Eggert's avatar
Paul Eggert committed
340 341 342 343
pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->encode_coding_system = val;
}
344
static void
Paul Eggert's avatar
Paul Eggert committed
345 346 347 348
pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->encoding_buf = val;
}
349
static void
Paul Eggert's avatar
Paul Eggert committed
350 351
pset_filter (struct Lisp_Process *p, Lisp_Object val)
{
352
  p->filter = NILP (val) ? Qinternal_default_process_filter : val;
Paul Eggert's avatar
Paul Eggert committed
353
}
354
static void
Paul Eggert's avatar
Paul Eggert committed
355 356 357 358
pset_log (struct Lisp_Process *p, Lisp_Object val)
{
  p->log = val;
}
359
static void
Paul Eggert's avatar
Paul Eggert committed
360 361 362 363
pset_mark (struct Lisp_Process *p, Lisp_Object val)
{
  p->mark = val;
}
364
static void
Paul Eggert's avatar
Paul Eggert committed
365 366 367 368
pset_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->name = val;
}
369
static void
Paul Eggert's avatar
Paul Eggert committed
370 371 372 373
pset_plist (struct Lisp_Process *p, Lisp_Object val)
{
  p->plist = val;
}
374
static void
Paul Eggert's avatar
Paul Eggert committed
375 376
pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
{
377
  p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
Paul Eggert's avatar
Paul Eggert committed
378
}
379
static void
Paul Eggert's avatar
Paul Eggert committed
380 381 382 383
pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->tty_name = val;
}
384
static void
Paul Eggert's avatar
Paul Eggert committed
385 386 387 388
pset_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->type = val;
}
389
static void
Paul Eggert's avatar
Paul Eggert committed
390 391 392 393
pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
{
  p->write_queue = val;
}
394 395 396 397 398
static void
pset_stderrproc (struct Lisp_Process *p, Lisp_Object val)
{
  p->stderrproc = val;
}
Paul Eggert's avatar
Paul Eggert committed
399

400

Dmitry Antipov's avatar
Dmitry Antipov committed
401 402 403 404 405
static Lisp_Object
make_lisp_proc (struct Lisp_Process *p)
{
  return make_lisp_ptr (p, Lisp_Vectorlike);
}
406

407
static struct fd_callback_data
408 409 410 411 412
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
413
  int condition; /* Mask of the defines above.  */
414
} fd_callback_info[FD_SETSIZE];
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459


/* 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)
{
  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)
{
  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)
{
  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;
}

460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
/* FD is no longer an input descriptor; update max_input_desc accordingly.  */

static void
delete_input_desc (int fd)
{
  if (fd == max_input_desc)
    {
      do
	fd--;
      while (0 <= fd && ! (FD_ISSET (fd, &input_wait_mask)
			   || FD_ISSET (fd, &write_mask)));

      max_input_desc = fd;
    }
}

476 477 478 479 480 481 482 483 484 485 486
/* Stop monitoring file descriptor FD for when write is possible.  */

void
delete_write_fd (int fd)
{
  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;
487
      delete_input_desc (fd);
488 489 490
    }
}

Jim Blandy's avatar
Jim Blandy committed
491 492 493 494

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

495
static Lisp_Object status_convert (int);
496

497
static void
498
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
499
{
500
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
501
  pset_status (p, status_convert (p->raw_status));
502
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
503 504
}

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

508
static Lisp_Object
509
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
514
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
515 516 517 518 519 520 521 522 523 524 525
				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.  */

526
static void
527
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
Jim Blandy's avatar
Jim Blandy committed
528 529 530
{
  Lisp_Object tem;

531
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
539 540 541 542
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
543 544 545 546 547 548
      *coredump = !NILP (tem);
    }
}

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

549
static Lisp_Object
550
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
551
{
552
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
553
  Lisp_Object symbol;
554 555
  int code;
  bool coredump;
556
  Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
557 558 559 560 561

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
562
      char const *signame;
563
      synchronize_system_messages_locale ();
564
      signame = strsignal (code);
565
      if (signame == 0)
566 567 568 569 570
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

571
	  string = build_unibyte_string (signame);
572 573 574
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
575
	  c1 = STRING_CHAR (SDATA (string));
576
	  c2 = downcase (c1);
577
	  if (c1 != c2)
578
	    Faset (string, make_number (0), make_number (c2));
579
	}
580 581
      AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, suffix);
Jim Blandy's avatar
Jim Blandy committed
582 583 584
    }
  else if (EQ (symbol, Qexit))
    {
585 586
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
587 588
      if (code == 0)
	return build_string ("finished\n");
589
      AUTO_STRING (prefix, "exited abnormally with code ");
590
      string = Fnumber_to_string (make_number (code));
591 592
      AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
      return concat3 (prefix, string, suffix);
Jim Blandy's avatar
Jim Blandy committed
593
    }
594 595
  else if (EQ (symbol, Qfailed))
    {
596
      AUTO_STRING (prefix, "failed with code ");
597
      string = Fnumber_to_string (make_number (code));
598 599
      AUTO_STRING (suffix, "\n");
      return concat3 (prefix, string, suffix);
600
    }
Jim Blandy's avatar
Jim Blandy committed
601 602 603 604
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

605
enum { PTY_NAME_SIZE = 24 };
Dan Nicolaescu's avatar
Dan Nicolaescu committed
606

607
/* Open an available pty, returning a file descriptor.
608 609
   Store into PTY_NAME the file name of the terminal corresponding to the pty.
   Return -1 on failure.  */
610

611
static int
612
allocate_pty (char pty_name[PTY_NAME_SIZE])
Jim Blandy's avatar
Jim Blandy committed
613
{
614
#ifdef HAVE_PTYS
Jim Blandy's avatar
Jim Blandy committed
615 616 617 618 619
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
620
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
621 622 623 624 625 626 627 628 629 630
  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 */

631 632 633
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
634
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
635
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
636 637 638

	if (fd >= 0)
	  {
639 640 641 642 643 644
#ifdef PTY_TTY_NAME_SPRINTF
	    PTY_TTY_NAME_SPRINTF
#else
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
#endif /* no PTY_TTY_NAME_SPRINTF */

645 646 647
	    /* Set FD's close-on-exec flag.  This is needed even if
	       PT_OPEN calls posix_openpt with O_CLOEXEC, since POSIX
	       doesn't require support for that combination.
648 649
	       Do this after PTY_TTY_NAME_SPRINTF, which on some platforms
	       doesn't work if the close-on-exec flag is set (Bug#20555).
650 651 652 653
	       Multithreaded platforms where posix_openpt ignores
	       O_CLOEXEC (or where PTY_OPEN doesn't call posix_openpt)
	       have a race condition between the PTY_OPEN and here.  */
	    fcntl (fd, F_SETFD, FD_CLOEXEC);
654 655 656

	    /* Check to make certain that both sides are available.
	       This avoids a nasty yet stupid bug in rlogins.  */
657
	    if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
Jim Blandy's avatar
Jim Blandy committed
658
	      {
659
		emacs_close (fd);
660
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
661
		continue;
662
# else
Jim Blandy's avatar
Jim Blandy committed
663
		return -1;
664
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
665 666 667 668 669
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
670
#endif /* HAVE_PTYS */
Jim Blandy's avatar
Jim Blandy committed
671 672
  return -1;
}
673 674 675 676 677 678 679 680 681

/* Allocate basically initialized process.  */

static struct Lisp_Process *
allocate_process (void)
{
  return ALLOCATE_ZEROED_PSEUDOVECTOR (struct Lisp_Process, pid, PVEC_PROCESS);
}

682
static Lisp_Object
683
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
684 685 686
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
687 688
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
689

690
  p = allocate_process ();
691 692
  /* Initialize Lisp data.  Note that allocate_process initializes all
     Lisp data to nil, so do it only for slots which should not be nil.  */
Paul Eggert's avatar
Paul Eggert committed
693 694
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
695

696 697 698 699
  /* Initialize non-Lisp data.  Note that allocate_process zeroes out all
     non-Lisp data, so do it only for slots which should not be zero.  */
  p->infd = -1;
  p->outfd = -1;
700 701
  for (i = 0; i < PROCESS_OPEN_FDS; i++)
    p->open_fd[i] = -1;
Kenichi Handa's avatar
Kenichi Handa committed
702

Ted Zlatanov's avatar
Ted Zlatanov committed
703 704
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
705
  p->gnutls_boot_parameters = Qnil;
Ted Zlatanov's avatar
Ted Zlatanov committed
706 707
#endif

Jim Blandy's avatar
Jim Blandy committed
708 709 710 711 712 713 714
  /* 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;
715
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
716 717
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
718
  pset_name (p, name);
719 720
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
721
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
722 723 724 725
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

726
static void
727
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
728 729 730 731 732 733 734 735
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
736

737 738 739 740 741 742
#ifdef HAVE_GETADDRINFO_A
static void
free_dns_request (Lisp_Object proc)
{
  struct Lisp_Process *p = XPROCESS (proc);

743 744 745 746
  if (p->dns_request->ar_result)
    freeaddrinfo (p->dns_request->ar_result);
  xfree (p->dns_request);
  p->dns_request = NULL;
747 748 749
}
#endif

Jim Blandy's avatar
Jim Blandy committed
750 751

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
752
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
753
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
754
{
755
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
756 757 758
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
759
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
760
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
761
{
762
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
763
    return name;
764
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
765 766 767
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
768 769 770 771
/* 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
772

773
static Lisp_Object
774
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
775
{
776 777 778 779 780 781 782
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
783
	error ("Process %s does not exist", SDATA (name));
784 785 786
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
787
  else
788 789
    obj = name;

790 791
  /* Now obj should be either a buffer object or a process object.  */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
792
    {
793 794
      if (NILP (BVAR (XBUFFER (obj), name)))
        error ("Attempt to get process for a dead buffer");
795
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
796
      if (NILP (proc))
797
        error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
798 799
    }
  else
800
    {
801
      CHECK_PROCESS (obj);
802 803 804
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
805 806
}

807 808 809

/* Fdelete_process promises to immediately forget about the process, but in
   reality, Emacs needs to remember those processes until they have been
810
   treated by the SIGCHLD handler and waitpid has been invoked on them;
811 812
   otherwise they might fill up the kernel's process table.

813 814 815 816 817
   Some processes created by call-process are also put onto this list.

   Members of this list are (process-ID . filename) pairs.  The
   process-ID is a number; the filename, if a string, is a file that
   needs to be removed after the process exits.  */
818 819
static Lisp_Object deleted_pid_list;

820
void
821
record_deleted_pid (pid_t pid, Lisp_Object filename)
822
{
823
  deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
824 825 826 827 828
			    /* GC treated elements set to nil.  */
			    Fdelq (Qnil, deleted_pid_list));

}

Jim Blandy's avatar
Jim Blandy committed
829
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
830 831 832
       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
833
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
834
{
835 836
  register struct Lisp_Process *p;

837
  process = get_process (process);
838 839
  p = XPROCESS (process);

840
#ifdef HAVE_GETADDRINFO_A
841
  if (p->dns_request)
842
    {
843 844
      int ret;

845
      gai_cancel (p->dns_request);
846 847 848 849 850 851 852 853 854 855
      ret = gai_error (p->dns_request);
      if (ret == EAI_CANCELED || ret == 0)
	free_dns_request (process);
      else
	{
	  /* If we're called during shutdown, we don't really about
	     freeing all the resources.  Otherwise wait until
	     completion, and then free the request. */
	  if (! inhibit_sentinels)
	    {
856
	      gai_suspend ((struct gaicb const **) &p->dns_request, 1, NULL);
857 858 859
	      free_dns_request (process);
	    }
	}
860 861 862
    }
#endif

863
  p->raw_status_new = 0;
864
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
865
    {
866
      pset_status (p, list2 (Qexit, make_number (0)));
867
      p->tick = ++process_tick;
868
      status_notify (p, NULL);
869
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
870
    }
871
  else
Jim Blandy's avatar
Jim Blandy committed
872
    {
873
      if (p->alive)
874
	record_kill_process (p, Qnil);
875 876

      if (p->infd >= 0)
877
	{
878 879 880 881 882 883 884 885 886
	  /* Update P's status, since record_kill_process will make the
	     SIGCHLD handler update deleted_pid_list, not *P.  */
	  Lisp_Object symbol;
	  if (p->raw_status_new)
	    update_status (p);
	  symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
	  if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
	    pset_status (p, list2 (Qsignal, make_number (SIGKILL)));

887
	  p->tick = ++process_tick;
888
	  status_notify (p, NULL);
889
	  redisplay_preserve_echo_area (13);
890
	}
Jim Blandy's avatar
Jim Blandy committed
891
    }
892
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
893 894 895 896
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
897 898 899 900 901 902 903
       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.
904
listen -- for a network stream server that is listening.
905
closed -- for a network stream connection that is closed.
906 907
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
908 909 910
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
911
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
912 913 914
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
915

916 917
  if (STRINGP (process))
    process = Fget_process (process);
918
  else
919
    process = get_process (process);
920

921 922
  if (NILP (process))
    return process;
923

924
  p = XPROCESS (process);
925
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
926
    update_status (p);
927
  status = p->status;
928
  if (CONSP (status))
929
    status = XCAR (status);
930
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
931
    {
932
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
933
	status = Qclosed;
934
      else if (EQ (p->command, Qt))
935 936 937
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
938 939 940 941 942 943
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
944 945
       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
946
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
947
{
948
  CHECK_PROCESS (process);
949
  if (XPROCESS (process)->raw_status_new)
950
    update_status (XPROCESS (process));
951 952
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
953 954 955 956
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
957
       doc: /* Return the process id of PROCESS.
958
This is the pid of the external process which PROCESS uses or talks to.
959
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
960
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
961
{
962
  pid_t pid;
963

964
  CHECK_PROCESS (process);
965 966
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
967 968 969
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
970 971 972
       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
973
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
974
{
975
  CHECK_PROCESS (process);
976
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
977 978 979
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
980 981 982
       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.
983
For a network or serial process, this is nil (process is running) or t
984
(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
985
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
986
{
987
  CHECK_PROCESS (process);
988
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
989 990
}

991
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
992 993 994
       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
995
  (register Lisp_Object process)
996
{
997
  CHECK_PROCESS (process);
998
  return XPROCESS (process)->tty_name;
999 1000
}

Jim Blandy's avatar
Jim Blandy committed
1001
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
1002
       2, 2, 0,
1003 1004
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1005
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
1006
{
1007 1008
  struct Lisp_Process *p;