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

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

This file is part of GNU Emacs.

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

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

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


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

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

32 33
#include "lisp.h"

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

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

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

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

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

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

#endif

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

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

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

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

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

90 91
#endif	/* subprocesses */

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

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

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

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

123 124 125 126 127
#if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
/* This is 0.1s in nanoseconds. */
#define ASYNC_RETRY_NSEC 100000000
#endif

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

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

static bool kbd_is_on_hold;

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

#ifdef subprocesses

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

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

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

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

166 167 168
# undef accept4
# define accept4(sockfd, addr, addrlen, flags) \
    process_accept4 (sockfd, addr, addrlen, flags)
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
static int
accept4 (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags)
{
  return close_on_exec (accept (sockfd, addr, addrlen));
}

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

184 185 186 187
#define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
#define NETCONN1_P(p) (EQ (p->type, Qnetwork))
#define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
#define SERIALCONN1_P(p) (EQ (p->type, Qserial))
188 189
#define PIPECONN_P(p) (EQ (XPROCESS (p)->type, Qpipe))
#define PIPECONN1_P(p) (EQ (p->type, Qpipe))
Jim Blandy's avatar
Jim Blandy committed
190 191

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

196 197 198 199 200
/* Define DATAGRAM_SOCKETS if datagrams can be used safely on
   this system.  We need to read full packets, so we need a
   "non-destructive" select.  So we require either native select,
   or emulation of select using FIONREAD.  */

Paul Eggert's avatar
Paul Eggert committed
201 202 203 204 205 206 207
#ifndef BROKEN_DATAGRAM_SOCKETS
# if defined HAVE_SELECT || defined USABLE_FIONREAD
#  if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
#   define DATAGRAM_SOCKETS
#  endif
# endif
#endif
208

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

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

217 218
/* Number of processes which have a non-zero read_output_delay,
   and therefore might be delayed for adaptive read buffering.  */
Kenichi Handa's avatar
Kenichi Handa committed
219 220 221

static int process_output_delay_count;

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

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

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

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

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

241
static fd_set input_wait_mask;
242

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

245
static fd_set non_keyboard_wait_mask;
246

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

249
static fd_set non_process_wait_mask;
250

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

253
static fd_set write_mask;
254

255 256 257 258
/* Mask of bits indicating the descriptors that we wait for connect to
   complete on.  Once they complete, they are removed from this mask
   and added to the input_wait_mask and non_keyboard_wait_mask.  */

259
static fd_set connect_wait_mask;
260 261 262

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

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

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

270 271 272
/* The descriptor  of any sockets passed to Emacs; -1 if none. */
static int external_sock_fd = -1;

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

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

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

286
static int proc_buffered_char[FD_SETSIZE];
287

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

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

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

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

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


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

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

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

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

491
static Lisp_Object status_convert (int);
492

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

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

504
static Lisp_Object
505
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
506 507 508 509
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
510
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
511 512 513 514 515 516 517 518 519 520 521
				WCOREDUMP (w) ? Qt : Qnil));
  else if (WIFSIGNALED (w))
    return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
				  WCOREDUMP (w) ? Qt : Qnil));
  else
    return Qrun;
}

/* Given a status-list, extract the three pieces of information
   and store them individually through the three pointers.  */

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

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

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

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

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

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

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

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

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

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

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

	if (fd >= 0)
	  {
635 636 637 638 639 640
#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 */

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

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

/* Allocate basically initialized process.  */

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

678
static Lisp_Object
679
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
680
{
681
  struct Lisp_Process *p = allocate_process ();
682 683
  /* 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
684 685
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
686

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

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

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

701 702
  Lisp_Object name1 = name;
  for (printmax_t i = 1; ; i++)
Jim Blandy's avatar
Jim Blandy committed
703
    {
704 705 706 707 708 709 710
      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
711 712
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
713
  pset_name (p, name);
714 715
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
716
  Lisp_Object val;
717
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
718 719 720 721
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

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

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

  deactivate_process (proc);
}
732

733 734 735 736 737 738
#ifdef HAVE_GETADDRINFO_A
static void
free_dns_request (Lisp_Object proc)
{
  struct Lisp_Process *p = XPROCESS (proc);

739 740 741 742
  if (p->dns_request->ar_result)
    freeaddrinfo (p->dns_request->ar_result);
  xfree (p->dns_request);
  p->dns_request = NULL;
743 744 745
}
#endif

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

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

Jim Blandy's avatar
Jim Blandy committed
764 765 766 767
/* 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
768

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

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

803 804 805

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

809 810 811 812 813
   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.  */
814 815
static Lisp_Object deleted_pid_list;

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

}

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

833
  process = get_process (process);
834 835
  p = XPROCESS (process);

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

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

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

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

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

908 909
  if (STRINGP (process))
    process = Fget_process (process);
910
  else
911
    process = get_process (process);
912

913 914
  if (NILP (process))
    return process;
915

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

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

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

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

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

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

983
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
984 985 986
       doc: /* Return the name of the terminal PROCESS uses, or nil if none.
This is the terminal that the process itself reads and writes on,
not the name of the pty that Emacs uses to talk with that terminal.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
987
  (register Lisp_Object process)
988
{
989
  CHECK_PROCESS (process);
990
  return XPROCESS (process)->tty_name;
991 992
}

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