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

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2016 Free Software
Paul Eggert's avatar
Paul Eggert committed
4
Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Paul Eggert's avatar
Paul Eggert committed
23

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

32 33
#include "lisp.h"

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

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

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

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

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

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

#endif

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

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

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

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

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

90 91
#endif	/* subprocesses */

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

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

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

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

123 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

133
/* Work around GCC 4.3.0 bug with strict overflow checking; see
Eli Zaretskii's avatar
Eli Zaretskii committed
134
   <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
135
   This bug appears to be fixed in GCC 5.1, so don't work around it there.  */
136
#if GNUC_PREREQ (4, 3, 0) && ! GNUC_PREREQ (5, 1, 0)
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
#endif
153
#ifndef SOCK_NONBLOCK
154
# define SOCK_NONBLOCK 0
155
#endif
Paul Eggert's avatar
Paul Eggert committed
156

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

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

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

199 200 201 202
#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))
203 204
#define PIPECONN_P(p) (EQ (XPROCESS (p)->type, Qpipe))
#define PIPECONN1_P(p) (EQ (p->type, Qpipe))
Jim Blandy's avatar
Jim Blandy committed
205 206

/* Number of events of change of status of a process.  */
207
static EMACS_INT process_tick;
Jim Blandy's avatar
Jim Blandy committed
208
/* Number of events for which the user or sentinel has been notified.  */
209
static EMACS_INT update_tick;
Jim Blandy's avatar
Jim Blandy committed
210

211 212 213 214 215
/* 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
216 217 218 219 220 221 222
#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
223

Stefan Monnier's avatar
Stefan Monnier committed
224 225 226 227
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

228
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
229 230 231
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

232 233
/* 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
234 235 236

static int process_output_delay_count;

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

239
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
240

241
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
242
#ifdef USABLE_SIGIO
243
static bool keyboard_bit_set (fd_set *);
244
#endif
245
static void deactivate_process (Lisp_Object);
246
static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
247
static int read_process_output (Lisp_Object, int);
248
static void handle_child_signal (int);
249
static void create_pty (Lisp_Object);
250

251 252
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
253

254 255
/* Mask of bits indicating the descriptors that we wait for input on.  */

256
static fd_set input_wait_mask;
257

258
/* Mask that excludes keyboard input descriptor(s).  */
259

260
static fd_set non_keyboard_wait_mask;
261

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

264
static fd_set non_process_wait_mask;
265

266
/* Mask for selecting for write.  */
267

268
static fd_set write_mask;
269

270 271 272 273
/* 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.  */

274
static fd_set connect_wait_mask;
275 276 277

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

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

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

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

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

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

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

304
static int proc_buffered_char[FD_SETSIZE];
305

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

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

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

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

420
static struct fd_callback_data
421 422 423 424 425
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
426
  int condition; /* Mask of the defines above.  */
427
} fd_callback_info[FD_SETSIZE];
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472


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

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

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

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

508
static Lisp_Object status_convert (int);
509

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

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

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

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

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

553 554 555
  if (connecting_status (l))
    l = XCAR (l);

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

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

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

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

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

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

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

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

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

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

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

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

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

/* Allocate basically initialized process.  */

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

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

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

Ted Zlatanov's avatar
Ted Zlatanov committed
722 723
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
724
  p->gnutls_boot_parameters = Qnil;
Ted Zlatanov's avatar
Ted Zlatanov committed
725 726
#endif

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

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

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

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

  deactivate_process (proc);
}
760

761 762 763 764 765 766
#ifdef HAVE_GETADDRINFO_A
static void
free_dns_request (Lisp_Object proc)
{
  struct Lisp_Process *p = XPROCESS (proc);

767 768 769 770
  if (p->dns_request->ar_result)
    freeaddrinfo (p->dns_request->ar_result);
  xfree (p->dns_request);
  p->dns_request = NULL;
771 772 773
}
#endif

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

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

Jim Blandy's avatar
Jim Blandy committed
792 793 794 795
/* 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
796

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

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

831 832 833

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

837 838 839 840 841
   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.  */
842 843
static Lisp_Object deleted_pid_list;

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

}

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

861
  process = get_process (process);
862 863
  p = XPROCESS (process);

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

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

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

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

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

936 937
  if (STRINGP (process))
    process = Fget_process (process);
938
  else
939
    process = get_process (process);
940

941 942
  if (NILP (process))
    return process;
943

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

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

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

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

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

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