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

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

46
/* Are local (unix) sockets supported?  */
47
#if defined (HAVE_SYS_UN_H)
48 49 50 51 52 53 54 55
#if !defined (AF_LOCAL) && defined (AF_UNIX)
#define AF_LOCAL AF_UNIX
#endif
#ifdef AF_LOCAL
#define HAVE_LOCAL_SOCKETS
#include <sys/un.h>
#endif
#endif
Jim Blandy's avatar
Jim Blandy committed
56 57

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

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

#endif

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

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

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

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

90 91
#include <c-ctype.h>
#include <sig2str.h>
92
#include <verify.h>
93

94 95
#endif	/* subprocesses */

Jim Blandy's avatar
Jim Blandy committed
96
#include "systime.h"
97
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
98 99

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

116 117 118 119
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

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

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

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

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

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

161 162 163 164 165 166 167 168 169 170 171 172
/* 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
173
#ifndef HAVE_ACCEPT4
174 175 176 177 178 179 180 181 182 183 184

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

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

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

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

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

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

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

236 237
/* 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
238 239 240

static int process_output_delay_count;

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

243
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
244

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

256 257
/* Mask of bits indicating the descriptors that we wait for input on.  */

258
static fd_set input_wait_mask;
259

260
/* Mask that excludes keyboard input descriptor(s).  */
261

262
static fd_set non_keyboard_wait_mask;
263

264
/* Mask that excludes process input descriptor(s).  */
265

266
static fd_set non_process_wait_mask;
267

268
/* Mask for selecting for write.  */
269

270
static fd_set write_mask;
271

272 273 274 275
/* 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.  */

276
static fd_set connect_wait_mask;
277 278 279

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

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

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

287 288 289 290
/* 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.  */
291
static int external_sock_fd;
292

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

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

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

306
static int proc_buffered_char[FD_SETSIZE];
307

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

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

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

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

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


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

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

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

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

510
static Lisp_Object status_convert (int);
511

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

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

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

538 539 540 541 542 543 544 545
/* 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
546 547 548
/* Given a status-list, extract the three pieces of information
   and store them individually through the three pointers.  */

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

555 556 557
  if (connecting_status (l))
    l = XCAR (l);

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

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

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

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

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

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

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

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

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

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

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

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

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

/* Allocate basically initialized process.  */

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

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

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

Ted Zlatanov's avatar
Ted Zlatanov committed
724
#ifdef HAVE_GNUTLS
725 726 727
  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
728 729
#endif

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

732 733
  Lisp_Object name1 = name;
  for (printmax_t i = 1; ; i++)
Jim Blandy's avatar
Jim Blandy committed
734
    {
735 736 737 738 739 740 741
      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
742 743
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
744
  pset_name (p, name);
745 746
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
747
  Lisp_Object val;
748
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
749 750 751 752
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

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

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

  deactivate_process (proc);
}
763

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

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

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

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

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

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

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

834 835 836

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

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

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

}

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

864
  process = get_process (process);
865 866
  p = XPROCESS (process);

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

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

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

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

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

939 940
  if (STRINGP (process))
    process = Fget_process (process);
941
  else
942
    process = get_process (process);
943

944 945
  if (NILP (process))
    return process;
946

947
  p = XPROCESS (process);
948
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
949
    update_status (p);
950
  status = p->status;
951
  if (CONSP (status))
952
    status = XCAR (status);
953
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
954
    {
955
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
956
	status = Qclosed;
957
      else if (EQ (p->command, Qt))
958 959 960
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
961 962 963 964 965 966
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
967 968
       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
969
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
970
{
971
  CHECK_PROCESS (process);
972
  if (XPROCESS (process)->raw_status_new)
973
    update_status (XPROCESS (process));
974 975
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
976 977 978 979
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
980
       doc: /* Return the process id of PROCESS.
981
This is the pid of the external process which PROCESS uses or talks to.
982
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
983
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
984
{
985
  pid_t pid;
986

987
  CHECK_PROCESS (process);
988 989
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
990 991 992
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
993 994 995
       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
996
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
997
{
998
  CHECK_PROCESS (process);
999
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
1003 1004 1005
       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.
1006
For a network or serial process, this is nil (process is running) or t
1007
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1008
  (register Lisp_Object process)