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 201 202 203 204
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.
   The code can be simplified by assuming NON_BLOCKING_CONNECT once
   Emacs starts assuming POSIX 1003.1-2001 or later.  */

#if (defined HAVE_SELECT				\
     && (defined GNU_LINUX || defined HAVE_GETPEERNAME)	\
     && (defined EWOULDBLOCK || defined EINPROGRESS))
# define NON_BLOCKING_CONNECT
#endif
205

206 207 208 209 210
/* 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
211 212 213 214 215 216 217
#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
218

Stefan Monnier's avatar
Stefan Monnier committed
219 220 221 222
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

223
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
224 225 226
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

227 228
/* 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
229 230 231

static int process_output_delay_count;

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

234
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
235

236
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
237
#ifdef USABLE_SIGIO
238
static bool keyboard_bit_set (fd_set *);
239
#endif
240
static void deactivate_process (Lisp_Object);
241
static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
242
static int read_process_output (Lisp_Object, int);
243
static void handle_child_signal (int);
244
static void create_pty (Lisp_Object);
245

246 247
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
248

249 250
/* Mask of bits indicating the descriptors that we wait for input on.  */

251
static fd_set input_wait_mask;
252

253
/* Mask that excludes keyboard input descriptor(s).  */
254

255
static fd_set non_keyboard_wait_mask;
256

257
/* Mask that excludes process input descriptor(s).  */
258

259
static fd_set non_process_wait_mask;
260

261
/* Mask for selecting for write.  */
262

263
static fd_set write_mask;
264

265
#ifdef NON_BLOCKING_CONNECT
266 267 268 269
/* 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.  */

270
static fd_set connect_wait_mask;
271 272 273

/* Number of bits set in connect_wait_mask.  */
static int num_pending_connects;
274
#endif	/* NON_BLOCKING_CONNECT */
275

276
/* The largest descriptor currently in use for a process object; -1 if none.  */
277 278
static int max_process_desc;

279
/* The largest descriptor currently in use for input; -1 if none.  */
280
static int max_input_desc;
281

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

286
/* Alist of elements (NAME . PROCESS).  */
287
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
288 289 290 291 292 293 294

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

295
static int proc_buffered_char[FD_SETSIZE];
296

Karl Heuer's avatar
Karl Heuer committed
297
/* Table of `struct coding-system' for each process.  */
298 299
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
300

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

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

405

Dmitry Antipov's avatar
Dmitry Antipov committed
406 407 408 409 410
static Lisp_Object
make_lisp_proc (struct Lisp_Process *p)
{
  return make_lisp_ptr (p, Lisp_Vectorlike);
}
411

412
static struct fd_callback_data
413 414 415 416 417
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
418
  int condition; /* Mask of the defines above.  */
419
} fd_callback_info[FD_SETSIZE];
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 459 460 461 462 463 464


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

465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
/* 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;
    }
}

481 482 483 484 485 486 487 488 489 490 491
/* 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;
492
      delete_input_desc (fd);
493 494 495
    }
}

Jim Blandy's avatar
Jim Blandy committed
496 497 498 499

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

500
static Lisp_Object status_convert (int);
501

502
static void
503
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
504
{
505
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
506
  pset_status (p, status_convert (p->raw_status));
507
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
508 509
}

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

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

531
static void
532
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
Jim Blandy's avatar
Jim Blandy committed
533 534 535
{
  Lisp_Object tem;

536
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
537 538 539 540 541 542 543
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
544 545 546 547
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
548 549 550 551 552 553
      *coredump = !NILP (tem);
    }
}

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

554
static Lisp_Object
555
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
556
{
557
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
558
  Lisp_Object symbol;
559 560
  int code;
  bool coredump;
561
  Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
562 563 564 565 566

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
567
      char const *signame;
568
      synchronize_system_messages_locale ();
569
      signame = strsignal (code);
570
      if (signame == 0)
571 572 573 574 575
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

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

612
/* Open an available pty, returning a file descriptor.
613 614
   Store into PTY_NAME the file name of the terminal corresponding to the pty.
   Return -1 on failure.  */
615

616
static int
617
allocate_pty (char pty_name[PTY_NAME_SIZE])
Jim Blandy's avatar
Jim Blandy committed
618
{
619
#ifdef HAVE_PTYS
Jim Blandy's avatar
Jim Blandy committed
620 621 622 623 624
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
625
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
626 627 628 629 630 631 632 633 634 635
  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 */

636 637 638
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
639
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
640
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
641 642 643

	if (fd >= 0)
	  {
644 645 646 647 648 649
#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 */

650 651 652
	    /* 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.
653 654
	       Do this after PTY_TTY_NAME_SPRINTF, which on some platforms
	       doesn't work if the close-on-exec flag is set (Bug#20555).
655 656 657 658
	       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);
659 660 661

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

/* Allocate basically initialized process.  */

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

687
static Lisp_Object
688
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
689 690 691
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
692 693
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
694

695
  p = allocate_process ();
696 697
  /* 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
698 699
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
700

701 702 703 704
  /* 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;
705 706
  for (i = 0; i < PROCESS_OPEN_FDS; i++)
    p->open_fd[i] = -1;
Kenichi Handa's avatar
Kenichi Handa committed
707

Ted Zlatanov's avatar
Ted Zlatanov committed
708 709
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
710
  p->gnutls_boot_parameters = Qnil;
Ted Zlatanov's avatar
Ted Zlatanov committed
711 712
#endif

Jim Blandy's avatar
Jim Blandy committed
713 714 715 716 717 718 719
  /* If name is already in use, modify it until it is unused.  */

  name1 = name;
  for (i = 1; ; i++)
    {
      tem = Fget_process (name1);
      if (NILP (tem)) break;
720
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
721 722
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
723
  pset_name (p, name);
724 725
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
726
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
727 728 729 730
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

731
static void
732
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
733 734 735 736 737 738 739 740
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
741

742 743 744 745 746 747
#ifdef HAVE_GETADDRINFO_A
static void
free_dns_request (Lisp_Object proc)
{
  struct Lisp_Process *p = XPROCESS (proc);

748 749 750 751
  if (p->dns_request->ar_result)
    freeaddrinfo (p->dns_request->ar_result);
  xfree (p->dns_request);
  p->dns_request = NULL;
752 753 754
}
#endif

Jim Blandy's avatar
Jim Blandy committed
755 756

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
757
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
758
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
759
{
760
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
761 762 763
}

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

Jim Blandy's avatar
Jim Blandy committed
773 774 775 776
/* 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
777

778
static Lisp_Object
779
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
780
{
781 782 783 784 785 786 787
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
788
	error ("Process %s does not exist", SDATA (name));
789 790 791
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
792
  else
793 794
    obj = name;

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

812 813 814

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

818 819 820 821 822
   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.  */
823 824
static Lisp_Object deleted_pid_list;

825
void
826
record_deleted_pid (pid_t pid, Lisp_Object filename)
827
{
828
  deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
829 830 831 832 833
			    /* GC treated elements set to nil.  */
			    Fdelq (Qnil, deleted_pid_list));

}

Jim Blandy's avatar
Jim Blandy committed
834
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
835 836 837
       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
838
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
839
{
840 841
  register struct Lisp_Process *p;

842
  process = get_process (process);
843 844
  p = XPROCESS (process);

845
#ifdef HAVE_GETADDRINFO_A
846
  if (p->dns_request)
847
    {
848 849
      int ret;

850
      gai_cancel (p->dns_request);
851 852 853 854 855 856 857 858 859 860
      ret = gai_error (p->dns_request);
      if (ret == EAI_CANCELED || ret == 0)
	free_dns_request (process);
      else
	{
	  /* If we're called during shutdown, we don't really about
	     freeing all the resources.  Otherwise wait until
	     completion, and then free the request. */
	  if (! inhibit_sentinels)
	    {
861
	      gai_suspend ((struct gaicb const **) &p->dns_request, 1, NULL);
862 863 864
	      free_dns_request (process);
	    }
	}
865 866 867
    }
#endif

868
  p->raw_status_new = 0;
869
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
870
    {
871
      pset_status (p, list2 (Qexit, make_number (0)));
872
      p->tick = ++process_tick;
873
      status_notify (p, NULL);
874
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
875
    }
876
  else
Jim Blandy's avatar
Jim Blandy committed
877
    {
878
      if (p->alive)
879
	record_kill_process (p, Qnil);
880 881

      if (p->infd >= 0)
882
	{
883 884 885 886 887 888 889 890 891
	  /* 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)));

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

921 922
  if (STRINGP (process))
    process = Fget_process (process);
923
  else
924
    process = get_process (process);
925

926 927
  if (NILP (process))
    return process;
928

929
  p = XPROCESS (process);
930
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
931
    update_status (p);
932
  status = p->status;
933
  if (CONSP (status))
934
    status = XCAR (status);
935
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
936
    {
937
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
938
	status = Qclosed;
939
      else if (EQ (p->command, Qt))
940 941 942
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
943 944 945 946 947 948
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
949 950
       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
951
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
952
{
953
  CHECK_PROCESS (process);
954
  if (XPROCESS (process)->raw_status_new)
955
    update_status (XPROCESS (process));
956 957
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
958 959 960 961
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
962
       doc: /* Return the process id of PROCESS.
963
This is the pid of the external process which PROCESS uses or talks to.
964
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
965
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
966
{
967
  pid_t pid;
968

969
  CHECK_PROCESS (process);
970 971
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
972 973 974
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
975 976 977
       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
978
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
979
{
980
  CHECK_PROCESS (process);
981
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
982 983 984
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
985 986 987
       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.
988
For a network or serial process, this is nil (process is running) or t
989
(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
990
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
991
{
992
  CHECK_PROCESS (process);
993
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
994 995
}

996
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
997 998 999
       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
1000
  (register Lisp_Object process)
1001
{
1002
  CHECK_PROCESS (process);
1003
  return XPROCESS (process)->tty_name;
1004 1005
}

Jim Blandy's avatar
Jim Blandy committed
1006
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
1007
       2, 2, 0,
1008 1009
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1010
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
1011