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 273
/* 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.  */
274
static int external_sock_fd;
275

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

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

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

289
static int proc_buffered_char[FD_SETSIZE];
290

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

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

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

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

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


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

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

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

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

494
static Lisp_Object status_convert (int);
495

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	if (fd >= 0)
	  {
638 639 640 641 642 643
#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 */

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

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

/* Allocate basically initialized process.  */

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

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

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

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

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

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

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

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

  deactivate_process (proc);
}
735

736 737 738 739 740 741
#ifdef HAVE_GETADDRINFO_A
static void
free_dns_request (Lisp_Object proc)
{
  struct Lisp_Process *p = XPROCESS (proc);

742 743 744 745
  if (p->dns_request->ar_result)
    freeaddrinfo (p->dns_request->ar_result);
  xfree (p->dns_request);
  p->dns_request = NULL;
746 747 748
}
#endif

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

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

Jim Blandy's avatar
Jim Blandy committed
767 768 769 770
/* 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
771

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

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

806 807 808

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

812 813 814 815 816
   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.  */
817 818
static Lisp_Object deleted_pid_list;

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

}

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

836
  process = get_process (process);
837 838
  p = XPROCESS (process);

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

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

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

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

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

911 912
  if (STRINGP (process))
    process = Fget_process (process);
913
  else
914
    process = get_process (process);
915

916 917
  if (NILP (process))
    return process;
918

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

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

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

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

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

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

986
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
987 988 989
       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
990
  (register Lisp_Object process)
991
{
992
  CHECK_PROCESS (process);
993
  return XPROCESS (process)->tty_name;
994 995
}

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