process.c 231 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 124 125 126 127
#if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
/* This is 0.1s in nanoseconds. */
#define ASYNC_RETRY_NSEC 100000000
#endif

128
#ifdef WINDOWSNT
129
extern int sys_select (int, fd_set *, fd_set *, fd_set *,
130
		       struct timespec *, void *);
131 132
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
133 134
/* Work around GCC 4.7.0 bug with strict overflow checking; see
   <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
135 136
   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
137 138 139 140 141 142 143 144 145 146 147 148 149
# 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

150 151
#ifndef SOCK_CLOEXEC
# define SOCK_CLOEXEC 0
Paul Eggert's avatar
Paul Eggert committed
152 153 154
#endif

#ifndef HAVE_ACCEPT4
155 156 157 158 159 160 161 162 163 164 165

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

166 167 168
# undef accept4
# define accept4(sockfd, addr, addrlen, flags) \
    process_accept4 (sockfd, addr, addrlen, flags)
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
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

184 185 186 187
#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))
188 189
#define PIPECONN_P(p) (EQ (XPROCESS (p)->type, Qpipe))
#define PIPECONN1_P(p) (EQ (p->type, Qpipe))
Jim Blandy's avatar
Jim Blandy committed
190 191

/* Number of events of change of status of a process.  */
192
static EMACS_INT process_tick;
Jim Blandy's avatar
Jim Blandy committed
193
/* Number of events for which the user or sentinel has been notified.  */
194
static EMACS_INT update_tick;
Jim Blandy's avatar
Jim Blandy committed
195

196 197 198 199 200
/* 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
201 202 203 204 205 206 207
#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
208

Stefan Monnier's avatar
Stefan Monnier committed
209 210 211 212
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

213
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
214 215 216
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

217 218
/* 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
219 220 221

static int process_output_delay_count;

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

224
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
225

226
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
227
#ifdef USABLE_SIGIO
228
static bool keyboard_bit_set (fd_set *);
229
#endif
230
static void deactivate_process (Lisp_Object);
231
static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
232
static int read_process_output (Lisp_Object, int);
233
static void handle_child_signal (int);
234
static void create_pty (Lisp_Object);
235

236 237
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
238

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

241
static fd_set input_wait_mask;
242

243
/* Mask that excludes keyboard input descriptor(s).  */
244

245
static fd_set non_keyboard_wait_mask;
246

247
/* Mask that excludes process input descriptor(s).  */
248

249
static fd_set non_process_wait_mask;
250

251
/* Mask for selecting for write.  */
252

253
static fd_set write_mask;
254

255 256 257 258
/* 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.  */

259
static fd_set connect_wait_mask;
260 261 262

/* Number of bits set in connect_wait_mask.  */
static int num_pending_connects;
263

264
/* The largest descriptor currently in use for a process object; -1 if none.  */
265 266
static int max_process_desc;

267
/* The largest descriptor currently in use for input; -1 if none.  */
268
static int max_input_desc;
269

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

274
/* Alist of elements (NAME . PROCESS).  */
275
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
276 277 278 279 280 281 282

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

283
static int proc_buffered_char[FD_SETSIZE];
284

Karl Heuer's avatar
Karl Heuer committed
285
/* Table of `struct coding-system' for each process.  */
286 287
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
288

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

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

393

Dmitry Antipov's avatar
Dmitry Antipov committed
394 395 396 397 398
static Lisp_Object
make_lisp_proc (struct Lisp_Process *p)
{
  return make_lisp_ptr (p, Lisp_Vectorlike);
}
399

400
static struct fd_callback_data
401 402 403 404 405
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
406
  int condition; /* Mask of the defines above.  */
407
} fd_callback_info[FD_SETSIZE];
408 409 410 411 412 413 414 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


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

453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
/* 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;
    }
}

469 470 471 472 473 474 475 476 477 478 479
/* 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;
480
      delete_input_desc (fd);
481 482 483
    }
}

Jim Blandy's avatar
Jim Blandy committed
484 485 486 487

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

488
static Lisp_Object status_convert (int);
489

490
static void
491
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
492
{
493
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
494
  pset_status (p, status_convert (p->raw_status));
495
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
496 497
}

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

501
static Lisp_Object
502
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
503 504 505 506
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
507
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512 513 514 515 516 517 518
				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.  */

519
static void
520
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
Jim Blandy's avatar
Jim Blandy committed
521 522 523
{
  Lisp_Object tem;

524
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
525 526 527 528 529 530 531
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
532 533 534 535
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
536 537 538 539 540 541
      *coredump = !NILP (tem);
    }
}

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

542
static Lisp_Object
543
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
544
{
545
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
546
  Lisp_Object symbol;
547 548
  int code;
  bool coredump;
549
  Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
550 551 552 553 554

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
555
      char const *signame;
556
      synchronize_system_messages_locale ();
557
      signame = strsignal (code);
558
      if (signame == 0)
559 560 561 562 563
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

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

600
/* Open an available pty, returning a file descriptor.
601 602
   Store into PTY_NAME the file name of the terminal corresponding to the pty.
   Return -1 on failure.  */
603

604
static int
605
allocate_pty (char pty_name[PTY_NAME_SIZE])
Jim Blandy's avatar
Jim Blandy committed
606
{
607
#ifdef HAVE_PTYS
Jim Blandy's avatar
Jim Blandy committed
608 609 610 611 612
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
613
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
614 615 616 617 618 619 620 621 622 623
  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 */

624 625 626
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
627
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
628
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
629 630 631

	if (fd >= 0)
	  {
632 633 634 635 636 637
#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 */

638 639 640
	    /* 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.
641 642
	       Do this after PTY_TTY_NAME_SPRINTF, which on some platforms
	       doesn't work if the close-on-exec flag is set (Bug#20555).
643 644 645 646
	       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);
647 648 649

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

/* Allocate basically initialized process.  */

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

675
static Lisp_Object
676
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
677 678 679
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
680 681
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
682

683
  p = allocate_process ();
684 685
  /* 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
686 687
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
688

689 690 691 692
  /* 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;
693 694
  for (i = 0; i < PROCESS_OPEN_FDS; i++)
    p->open_fd[i] = -1;
Kenichi Handa's avatar
Kenichi Handa committed
695

Ted Zlatanov's avatar
Ted Zlatanov committed
696 697
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
698
  p->gnutls_boot_parameters = Qnil;
Ted Zlatanov's avatar
Ted Zlatanov committed
699 700
#endif

Jim Blandy's avatar
Jim Blandy committed
701 702 703 704 705 706 707
  /* 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;
708
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
709 710
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
711
  pset_name (p, name);
712 713
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
714
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
715 716 717 718
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

719
static void
720
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
721 722 723 724 725 726 727 728
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
729

730 731 732 733 734 735
#ifdef HAVE_GETADDRINFO_A
static void
free_dns_request (Lisp_Object proc)
{
  struct Lisp_Process *p = XPROCESS (proc);

736 737 738 739
  if (p->dns_request->ar_result)
    freeaddrinfo (p->dns_request->ar_result);
  xfree (p->dns_request);
  p->dns_request = NULL;
740 741 742
}
#endif

Jim Blandy's avatar
Jim Blandy committed
743 744

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
745
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
746
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
747
{
748
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
749 750 751
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
752
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
753
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
754
{
755
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
756
    return name;
757
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
758 759 760
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
761 762 763 764
/* 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
765

766
static Lisp_Object
767
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
768
{
769 770 771 772 773 774 775
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
776
	error ("Process %s does not exist", SDATA (name));
777 778 779
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
780
  else
781 782
    obj = name;

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

800 801 802

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

806 807 808 809 810
   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.  */
811 812
static Lisp_Object deleted_pid_list;

813
void
814
record_deleted_pid (pid_t pid, Lisp_Object filename)
815
{
816
  deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
817 818 819 820 821
			    /* GC treated elements set to nil.  */
			    Fdelq (Qnil, deleted_pid_list));

}

Jim Blandy's avatar
Jim Blandy committed
822
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
823 824 825
       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
826
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
827
{
828 829
  register struct Lisp_Process *p;

830
  process = get_process (process);
831 832
  p = XPROCESS (process);

833
#ifdef HAVE_GETADDRINFO_A
834
  if (p->dns_request)
835
    {
836 837
      /* Cancel the request.  Unless shutting down, wait until
	 completion.  Free the request if completely canceled. */
838

839 840
      bool canceled = gai_cancel (p->dns_request) != EAI_NOTCANCELED;
      if (!canceled && !inhibit_sentinels)
841
	{
842 843 844 845
	  struct gaicb const *req = p->dns_request;
	  while (gai_suspend (&req, 1, NULL) != 0)
	    continue;
	  canceled = true;
846
	}
847 848
      if (canceled)
	free_dns_request (process);
849 850 851
    }
#endif

852
  p->raw_status_new = 0;
853
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
854
    {
855
      pset_status (p, list2 (Qexit, make_number (0)));
856
      p->tick = ++process_tick;
857
      status_notify (p, NULL);
858
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
859
    }
860
  else
Jim Blandy's avatar
Jim Blandy committed
861
    {
862
      if (p->alive)
863
	record_kill_process (p, Qnil);
864 865

      if (p->infd >= 0)
866
	{
867 868 869 870 871 872 873 874 875
	  /* 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)));

876
	  p->tick = ++process_tick;
877
	  status_notify (p, NULL);
878
	  redisplay_preserve_echo_area (13);
879
	}
Jim Blandy's avatar
Jim Blandy committed
880
    }
881
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
882 883 884 885
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
886 887 888 889 890 891 892
       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.
893
listen -- for a network stream server that is listening.
894
closed -- for a network stream connection that is closed.
895 896
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
897 898 899
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
900
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
901 902 903
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
904

905 906
  if (STRINGP (process))
    process = Fget_process (process);
907
  else
908
    process = get_process (process);
909

910 911
  if (NILP (process))
    return process;
912

913
  p = XPROCESS (process);
914
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
915
    update_status (p);
916
  status = p->status;
917
  if (CONSP (status))
918
    status = XCAR (status);
919
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
920
    {
921
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
922
	status = Qclosed;
923
      else if (EQ (p->command, Qt))
924 925 926
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
927 928 929 930 931 932
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
933 934
       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
935
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
936
{
937
  CHECK_PROCESS (process);
938
  if (XPROCESS (process)->raw_status_new)
939
    update_status (XPROCESS (process));
940 941
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
942 943 944 945
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
946
       doc: /* Return the process id of PROCESS.
947
This is the pid of the external process which PROCESS uses or talks to.
948
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
949
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
950
{
951
  pid_t pid;
952

953
  CHECK_PROCESS (process);
954 955
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
956 957 958
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
959 960 961
       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
962
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
963
{
964
  CHECK_PROCESS (process);
965
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
966 967 968
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
969 970 971
       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.
972
For a network or serial process, this is nil (process is running) or t
973
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
974
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
975
{
976
  CHECK_PROCESS (process);
977
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
978 979
}

980
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
981 982 983
       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
984
  (register Lisp_Object process)
985
{
986
  CHECK_PROCESS (process);
987
  return XPROCESS (process)->tty_name;
988 989
}

Jim Blandy's avatar
Jim Blandy committed
990
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
991
       2, 2, 0,
992 993
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
994
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
995
{
996 997
  struct Lisp_Process *p;

998
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
999
  if (!NILP (buffer))
1000
    CHECK_BUFFER (buffer);