process.c 234 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
#include <stdio.h>
Paul Eggert's avatar
Paul Eggert committed
25
#include <stdlib.h>
Jim Blandy's avatar
Jim Blandy committed
26
#include <errno.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>
Richard M. Stallman's avatar
Richard M. Stallman committed
30
#include <unistd.h>
31 32
#include <fcntl.h>

33 34
#include "lisp.h"

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

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

Paul Eggert's avatar
Paul Eggert committed
43 44 45 46
#ifdef HAVE_SETRLIMIT
# include <sys/resource.h>
#endif

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

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

Juanma Barranquero's avatar
Juanma Barranquero committed
63
#if defined (HAVE_IFADDRS_H)
64 65 66 67
/* 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
68
#if defined (HAVE_NET_IF_DL_H)
69 70 71 72 73
#include <net/if_dl.h>
#endif

#endif

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

Paul Eggert's avatar
Paul Eggert committed
78 79 80 81 82
#ifdef USG5_4
# include <sys/stream.h>
# include <sys/stropts.h>
#endif

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

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

91
#include <c-ctype.h>
92
#include <flexmember.h>
93
#include <sig2str.h>
94
#include <verify.h>
95

96 97
#endif	/* subprocesses */

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

#include "window.h"
102
#include "character.h"
103
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
104
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
105
#include "process.h"
106
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
107
#include "termopts.h"
108
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
109
#include "blockinput.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
110
#include "atimer.h"
111 112 113
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
114 115 116
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
117

118 119 120 121
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

122
#ifdef HAVE_GLIB
123
#include "xgselect.h"
124 125 126
#ifndef WINDOWSNT
#include <glib.h>
#endif
127
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
128

129 130 131 132 133
#if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
/* This is 0.1s in nanoseconds. */
#define ASYNC_RETRY_NSEC 100000000
#endif

134
#ifdef WINDOWSNT
135
extern int sys_select (int, fd_set *, fd_set *, fd_set *,
136
		       struct timespec *, void *);
137 138
#endif

139
/* Work around GCC 4.3.0 bug with strict overflow checking; see
Eli Zaretskii's avatar
Eli Zaretskii committed
140
   <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
141
   This bug appears to be fixed in GCC 5.1, so don't work around it there.  */
142
#if GNUC_PREREQ (4, 3, 0) && ! GNUC_PREREQ (5, 1, 0)
Eli Zaretskii's avatar
Eli Zaretskii committed
143 144 145 146 147 148 149 150 151 152 153 154 155
# 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

156 157
#ifndef SOCK_CLOEXEC
# define SOCK_CLOEXEC 0
Paul Eggert's avatar
Paul Eggert committed
158
#endif
159
#ifndef SOCK_NONBLOCK
160
# define SOCK_NONBLOCK 0
161
#endif
Paul Eggert's avatar
Paul Eggert committed
162

163 164 165 166 167 168 169 170 171 172 173 174
/* True if ERRNUM represents an error where the system call would
   block if a blocking variant were used.  */
static bool
would_block (int errnum)
{
#ifdef EWOULDBLOCK
  if (EWOULDBLOCK != EAGAIN && errnum == EWOULDBLOCK)
    return true;
#endif
  return errnum == EAGAIN;
}

Paul Eggert's avatar
Paul Eggert committed
175
#ifndef HAVE_ACCEPT4
176 177 178 179 180 181 182 183 184 185 186

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

187 188 189
# undef accept4
# define accept4(sockfd, addr, addrlen, flags) \
    process_accept4 (sockfd, addr, addrlen, flags)
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
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

205 206 207 208
#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))
209 210
#define PIPECONN_P(p) (EQ (XPROCESS (p)->type, Qpipe))
#define PIPECONN1_P(p) (EQ (p->type, Qpipe))
Jim Blandy's avatar
Jim Blandy committed
211 212

/* Number of events of change of status of a process.  */
213
static EMACS_INT process_tick;
Jim Blandy's avatar
Jim Blandy committed
214
/* Number of events for which the user or sentinel has been notified.  */
215
static EMACS_INT update_tick;
Jim Blandy's avatar
Jim Blandy committed
216

217 218 219 220 221
/* 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
222 223 224 225 226 227 228
#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
229

Stefan Monnier's avatar
Stefan Monnier committed
230 231 232 233
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

234
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
235 236 237
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

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

static int process_output_delay_count;

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

245
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
246

247
static void start_process_unwind (Lisp_Object);
248
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
249
#ifdef USABLE_SIGIO
250
static bool keyboard_bit_set (fd_set *);
251
#endif
252
static void deactivate_process (Lisp_Object);
253
static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
254 255
static int read_process_output (Lisp_Object, int);
static void create_pty (Lisp_Object);
256
static void exec_sentinel (Lisp_Object, Lisp_Object);
257

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

260
static fd_set input_wait_mask;
261

262
/* Mask that excludes keyboard input descriptor(s).  */
263

264
static fd_set non_keyboard_wait_mask;
265

266
/* Mask that excludes process input descriptor(s).  */
267

268
static fd_set non_process_wait_mask;
269

270
/* Mask for selecting for write.  */
271

272
static fd_set write_mask;
273

274 275 276 277
/* 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.  */

278
static fd_set connect_wait_mask;
279 280 281

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

283
/* The largest descriptor currently in use for a process object; -1 if none.  */
284 285
static int max_process_desc;

286
/* The largest descriptor currently in use for input; -1 if none.  */
287
static int max_input_desc;
288

289 290 291 292
/* Set the external socket descriptor for Emacs to use when
   `make-network-process' is called with a non-nil
   `:use-external-socket' option.  The value should be either -1, or
   the file descriptor of a socket that is already bound.  */
293
static int external_sock_fd;
294

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

299
/* Alist of elements (NAME . PROCESS).  */
300
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
301 302 303 304 305 306 307

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

308
static int proc_buffered_char[FD_SETSIZE];
309

Karl Heuer's avatar
Karl Heuer committed
310
/* Table of `struct coding-system' for each process.  */
311 312
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
313

314 315
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
316
static struct sockaddr_and_len {
317
  struct sockaddr *sa;
318
  ptrdiff_t len;
319
} datagram_address[FD_SETSIZE];
320
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
321 322 323 324
#define DATAGRAM_CONN_P(proc)                                           \
  (PROCESSP (proc) &&                                                   \
   XPROCESS (proc)->infd >= 0 &&                                        \
   datagram_address[XPROCESS (proc)->infd].sa != 0)
325 326 327 328
#else
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

417

Dmitry Antipov's avatar
Dmitry Antipov committed
418 419 420 421 422
static Lisp_Object
make_lisp_proc (struct Lisp_Process *p)
{
  return make_lisp_ptr (p, Lisp_Vectorlike);
}
423

424
static struct fd_callback_data
425 426 427 428 429
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
430
  int condition; /* Mask of the defines above.  */
431
} fd_callback_info[FD_SETSIZE];
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 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476


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

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
/* 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;
    }
}

493 494 495 496 497 498 499 500 501 502 503
/* 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;
504
      delete_input_desc (fd);
505 506 507
    }
}

Jim Blandy's avatar
Jim Blandy committed
508 509 510 511

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

512
static Lisp_Object status_convert (int);
513

514
static void
515
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
516
{
517
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
518
  pset_status (p, status_convert (p->raw_status));
519
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
520 521
}

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

525
static Lisp_Object
526
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
527 528 529 530
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
531
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538 539
				WCOREDUMP (w) ? Qt : Qnil));
  else if (WIFSIGNALED (w))
    return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
				  WCOREDUMP (w) ? Qt : Qnil));
  else
    return Qrun;
}

540 541 542 543 544 545 546 547
/* True if STATUS is that of a process attempting connection.  */

static bool
connecting_status (Lisp_Object status)
{
  return CONSP (status) && EQ (XCAR (status), Qconnect);
}

Jim Blandy's avatar
Jim Blandy committed
548 549 550
/* Given a status-list, extract the three pieces of information
   and store them individually through the three pointers.  */

551
static void
552 553
decode_status (Lisp_Object l, Lisp_Object *symbol, Lisp_Object *code,
	       bool *coredump)
Jim Blandy's avatar
Jim Blandy committed
554 555 556
{
  Lisp_Object tem;

557 558 559
  if (connecting_status (l))
    l = XCAR (l);

560
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
561 562
    {
      *symbol = l;
563
      *code = make_number (0);
Jim Blandy's avatar
Jim Blandy committed
564 565 566 567
      *coredump = 0;
    }
  else
    {
568 569
      *symbol = XCAR (l);
      tem = XCDR (l);
570
      *code = XCAR (tem);
571
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
572 573 574 575 576 577
      *coredump = !NILP (tem);
    }
}

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

578
static Lisp_Object
579
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
580
{
581
  Lisp_Object status = p->status;
582
  Lisp_Object symbol, code;
583
  bool coredump;
584
  Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
585 586 587 588 589

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
590
      char const *signame;
591
      synchronize_system_messages_locale ();
592
      signame = strsignal (XFASTINT (code));
593
      if (signame == 0)
594 595 596 597 598
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

599
	  string = build_unibyte_string (signame);
600 601 602
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
603
	  c1 = STRING_CHAR (SDATA (string));
604
	  c2 = downcase (c1);
605
	  if (c1 != c2)
606
	    Faset (string, make_number (0), make_number (c2));
607
	}
608 609
      AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, suffix);
Jim Blandy's avatar
Jim Blandy committed
610 611 612
    }
  else if (EQ (symbol, Qexit))
    {
613
      if (NETCONN1_P (p))
614 615 616 617
	return build_string (XFASTINT (code) == 0
			     ? "deleted\n"
			     : "connection broken by remote peer\n");
      if (XFASTINT (code) == 0)
Jim Blandy's avatar
Jim Blandy committed
618
	return build_string ("finished\n");
619
      AUTO_STRING (prefix, "exited abnormally with code ");
620
      string = Fnumber_to_string (code);
621 622
      AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
      return concat3 (prefix, string, suffix);
Jim Blandy's avatar
Jim Blandy committed
623
    }
624 625
  else if (EQ (symbol, Qfailed))
    {
626 627
      AUTO_STRING (format, "failed with code %s\n");
      return CALLN (Fformat, format, code);
628
    }
Jim Blandy's avatar
Jim Blandy committed
629 630 631 632
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

633
enum { PTY_NAME_SIZE = 24 };
Dan Nicolaescu's avatar
Dan Nicolaescu committed
634

635
/* Open an available pty, returning a file descriptor.
636 637
   Store into PTY_NAME the file name of the terminal corresponding to the pty.
   Return -1 on failure.  */
638

639
static int
640
allocate_pty (char pty_name[PTY_NAME_SIZE])
Jim Blandy's avatar
Jim Blandy committed
641
{
642
#ifdef HAVE_PTYS
Jim Blandy's avatar
Jim Blandy committed
643 644 645 646 647
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
648
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
649 650 651 652 653 654 655 656 657 658
  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 */

659 660 661
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
662
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
663
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
664 665 666

	if (fd >= 0)
	  {
667 668 669 670 671 672
#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 */

673 674 675
	    /* 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.
676 677
	       Do this after PTY_TTY_NAME_SPRINTF, which on some platforms
	       doesn't work if the close-on-exec flag is set (Bug#20555).
678 679 680 681
	       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);
682 683 684

	    /* Check to make certain that both sides are available.
	       This avoids a nasty yet stupid bug in rlogins.  */
685
	    if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
Jim Blandy's avatar
Jim Blandy committed
686
	      {
687
		emacs_close (fd);
688
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
689
		continue;
690
# else
Jim Blandy's avatar
Jim Blandy committed
691
		return -1;
692
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
693 694 695 696 697
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
698
#endif /* HAVE_PTYS */
Jim Blandy's avatar
Jim Blandy committed
699 700
  return -1;
}
701 702 703 704 705 706 707 708 709

/* Allocate basically initialized process.  */

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

710
static Lisp_Object
711
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
712
{
713
  struct Lisp_Process *p = allocate_process ();
714 715
  /* 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
716 717
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
718

719 720 721 722
  /* 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;
723
  for (int i = 0; i < PROCESS_OPEN_FDS; i++)
724
    p->open_fd[i] = -1;
Kenichi Handa's avatar
Kenichi Handa committed
725

Ted Zlatanov's avatar
Ted Zlatanov committed
726
#ifdef HAVE_GNUTLS
727 728 729
  verify (GNUTLS_STAGE_EMPTY == 0);
  eassert (p->gnutls_initstage == GNUTLS_STAGE_EMPTY);
  eassert (NILP (p->gnutls_boot_parameters));
Ted Zlatanov's avatar
Ted Zlatanov committed
730 731
#endif

Jim Blandy's avatar
Jim Blandy committed
732 733
  /* If name is already in use, modify it until it is unused.  */

734 735
  Lisp_Object name1 = name;
  for (printmax_t i = 1; ; i++)
Jim Blandy's avatar
Jim Blandy committed
736
    {
737 738 739 740 741 742 743
      Lisp_Object tem = Fget_process (name1);
      if (NILP (tem))
	break;
      char const suffix_fmt[] = "<%"pMd">";
      char suffix[sizeof suffix_fmt + INT_STRLEN_BOUND (printmax_t)];
      AUTO_STRING_WITH_LEN (lsuffix, suffix, sprintf (suffix, suffix_fmt, i));
      name1 = concat2 (name, lsuffix);
Jim Blandy's avatar
Jim Blandy committed
744 745
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
746
  pset_name (p, name);
747 748
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
749
  Lisp_Object val;
750
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
751 752 753 754
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

755
static void
756
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
757 758 759 760 761 762 763 764
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
765

766 767 768 769 770 771
#ifdef HAVE_GETADDRINFO_A
static void
free_dns_request (Lisp_Object proc)
{
  struct Lisp_Process *p = XPROCESS (proc);

772 773 774 775
  if (p->dns_request->ar_result)
    freeaddrinfo (p->dns_request->ar_result);
  xfree (p->dns_request);
  p->dns_request = NULL;
776 777 778
}
#endif

Jim Blandy's avatar
Jim Blandy committed
779 780

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
781
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
782
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
783
{
784
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
785 786 787
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
788
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
789
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
790
{
791
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
792
    return name;
793
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
794 795 796
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
797 798 799 800
/* 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
801

802
static Lisp_Object
803
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
804
{
805 806 807 808 809 810 811
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
812
	error ("Process %s does not exist", SDATA (name));
813 814 815
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
816
  else
817 818
    obj = name;

819 820
  /* Now obj should be either a buffer object or a process object.  */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
821
    {
822 823
      if (NILP (BVAR (XBUFFER (obj), name)))
        error ("Attempt to get process for a dead buffer");
824
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
825
      if (NILP (proc))
826
        error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
827 828
    }
  else
829
    {
830
      CHECK_PROCESS (obj);
831 832 833
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
834 835
}

836 837 838

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

842 843 844 845 846
   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.  */
847 848
static Lisp_Object deleted_pid_list;

849
void
850
record_deleted_pid (pid_t pid, Lisp_Object filename)
851
{
852
  deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
853 854 855 856 857
			    /* GC treated elements set to nil.  */
			    Fdelq (Qnil, deleted_pid_list));

}

Jim Blandy's avatar
Jim Blandy committed
858
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
859 860 861
       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
862
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
863
{
864 865
  register struct Lisp_Process *p;

866
  process = get_process (process);
867 868
  p = XPROCESS (process);

869
#ifdef HAVE_GETADDRINFO_A
870
  if (p->dns_request)
871
    {
872 873
      /* Cancel the request.  Unless shutting down, wait until
	 completion.  Free the request if completely canceled. */
874

875 876
      bool canceled = gai_cancel (p->dns_request) != EAI_NOTCANCELED;
      if (!canceled && !inhibit_sentinels)
877
	{
878 879 880 881
	  struct gaicb const *req = p->dns_request;
	  while (gai_suspend (&req, 1, NULL) != 0)
	    continue;
	  canceled = true;
882
	}
883 884
      if (canceled)
	free_dns_request (process);
885 886 887
    }
#endif

888
  p->raw_status_new = 0;
889
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
890
    {
891
      pset_status (p, list2 (Qexit, make_number (0)));
892
      p->tick = ++process_tick;
893
      status_notify (p, NULL);
894
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
895
    }
896
  else
Jim Blandy's avatar
Jim Blandy committed
897
    {
898
      if (p->alive)
899
	record_kill_process (p, Qnil);
900 901

      if (p->infd >= 0)
902
	{
903 904 905 906 907 908 909 910 911
	  /* 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)));

912
	  p->tick = ++process_tick;
913
	  status_notify (p, NULL);
914
	  redisplay_preserve_echo_area (13);
915
	}
Jim Blandy's avatar
Jim Blandy committed
916
    }
917
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
918 919 920 921
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
922 923 924 925 926 927 928
       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.
929
listen -- for a network stream server that is listening.
930
closed -- for a network stream connection that is closed.
931 932
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
933 934 935
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
936
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
937 938 939
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
940

941 942
  if (STRINGP (process))
    process = Fget_process (process);
943
  else
944
    process = get_process (process);
945

946 947
  if (NILP (process))
    return process;
948

949
  p = XPROCESS (process);
950
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
951
    update_status (p);
952
  status = p->status;