process.c 241 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-2018 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 <https://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
#include <stdio.h>
Paul Eggert's avatar
Paul Eggert committed
25
#include <stdlib.h>
Jim Blandy's avatar
Jim Blandy committed
26
#include <errno.h>
27
#include <sys/types.h>		/* Some typedefs are used in sys/file.h.  */
Jim Blandy's avatar
Jim Blandy committed
28 29
#include <sys/file.h>
#include <sys/stat.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
30
#include <unistd.h>
31 32
#include <fcntl.h>

33 34
#include "lisp.h"

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

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

Eli Zaretskii's avatar
Eli Zaretskii committed
43 44
#endif	/* subprocesses */

Paul Eggert's avatar
Paul Eggert committed
45 46
#ifdef HAVE_SETRLIMIT
# include <sys/resource.h>
47 48 49 50 51

/* If NOFILE_LIMIT.rlim_cur is greater than FD_SETSIZE, then
   NOFILE_LIMIT is the initial limit on the number of open files,
   which should be restored in child processes.  */
static struct rlimit nofile_limit;
Paul Eggert's avatar
Paul Eggert committed
52 53
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
54 55
#ifdef subprocesses

56
/* Are local (unix) sockets supported?  */
57
#if defined (HAVE_SYS_UN_H)
58 59 60 61 62 63 64 65
#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
66 67

#include <sys/ioctl.h>
Juanma Barranquero's avatar
Juanma Barranquero committed
68
#if defined (HAVE_NET_IF_H)
69 70
#include <net/if.h>
#endif /* HAVE_NET_IF_H */
Jim Blandy's avatar
Jim Blandy committed
71

Juanma Barranquero's avatar
Juanma Barranquero committed
72
#if defined (HAVE_IFADDRS_H)
73 74 75 76
/* 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
77
#if defined (HAVE_NET_IF_DL_H)
78 79 80 81 82
#include <net/if_dl.h>
#endif

#endif

Jim Blandy's avatar
Jim Blandy committed
83 84 85 86
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

Paul Eggert's avatar
Paul Eggert committed
87 88 89 90 91
#ifdef USG5_4
# include <sys/stream.h>
# include <sys/stropts.h>
#endif

92 93 94 95
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
96 97 98 99
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

100
#include <c-ctype.h>
101
#include <flexmember.h>
102
#include <sig2str.h>
103
#include <verify.h>
104

105 106
#endif	/* subprocesses */

Jim Blandy's avatar
Jim Blandy committed
107
#include "systime.h"
108
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
109 110

#include "window.h"
111
#include "character.h"
112
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
113
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
114
#include "process.h"
115
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
116
#include "termopts.h"
117
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
118
#include "blockinput.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
119
#include "atimer.h"
120 121 122
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
123 124 125
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
126

127 128 129 130
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

131
#ifdef HAVE_GLIB
132
#include "xgselect.h"
133 134 135
#ifndef WINDOWSNT
#include <glib.h>
#endif
136
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
137

138 139 140 141 142
#if defined HAVE_GETADDRINFO_A || defined HAVE_GNUTLS
/* This is 0.1s in nanoseconds. */
#define ASYNC_RETRY_NSEC 100000000
#endif

143
#ifdef WINDOWSNT
144
extern int sys_select (int, fd_set *, fd_set *, fd_set *,
145
                       const struct timespec *, const sigset_t *);
146 147
#endif

148
/* Work around GCC 4.3.0 bug with strict overflow checking; see
149
   <https://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
150
   This bug appears to be fixed in GCC 5.1, so don't work around it there.  */
151
#if GNUC_PREREQ (4, 3, 0) && ! GNUC_PREREQ (5, 1, 0)
Eli Zaretskii's avatar
Eli Zaretskii committed
152 153 154 155 156 157 158 159 160 161 162 163 164
# 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

165 166
#ifndef SOCK_CLOEXEC
# define SOCK_CLOEXEC 0
Paul Eggert's avatar
Paul Eggert committed
167
#endif
168
#ifndef SOCK_NONBLOCK
169
# define SOCK_NONBLOCK 0
170
#endif
Paul Eggert's avatar
Paul Eggert committed
171

172 173 174 175 176 177 178 179 180 181 182 183
/* True if ERRNUM represents an error where the system call would
   block if a blocking variant were used.  */
static bool
would_block (int errnum)
{
#ifdef EWOULDBLOCK
  if (EWOULDBLOCK != EAGAIN && errnum == EWOULDBLOCK)
    return true;
#endif
  return errnum == EAGAIN;
}

Paul Eggert's avatar
Paul Eggert committed
184
#ifndef HAVE_ACCEPT4
185 186 187 188 189 190 191 192 193 194 195

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

196 197 198
# undef accept4
# define accept4(sockfd, addr, addrlen, flags) \
    process_accept4 (sockfd, addr, addrlen, flags)
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
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

214 215 216 217
#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))
218 219
#define PIPECONN_P(p) (EQ (XPROCESS (p)->type, Qpipe))
#define PIPECONN1_P(p) (EQ (p->type, Qpipe))
Jim Blandy's avatar
Jim Blandy committed
220 221

/* Number of events of change of status of a process.  */
222
static EMACS_INT process_tick;
Jim Blandy's avatar
Jim Blandy committed
223
/* Number of events for which the user or sentinel has been notified.  */
224
static EMACS_INT update_tick;
Jim Blandy's avatar
Jim Blandy committed
225

226 227 228 229 230
/* 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
231 232 233 234 235 236 237
#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
238

Stefan Monnier's avatar
Stefan Monnier committed
239 240 241 242
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

243
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
244 245 246
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

247 248
/* 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
249 250 251

static int process_output_delay_count;

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

254
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
255

256
static void start_process_unwind (Lisp_Object);
257
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
258
#ifdef USABLE_SIGIO
259
static bool keyboard_bit_set (fd_set *);
260
#endif
261
static void deactivate_process (Lisp_Object);
262
static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
263 264
static int read_process_output (Lisp_Object, int);
static void create_pty (Lisp_Object);
265
static void exec_sentinel (Lisp_Object, Lisp_Object);
266

267 268
/* Number of bits set in connect_wait_mask.  */
static int num_pending_connects;
269

Tom Tromey's avatar
Tom Tromey committed
270
/* The largest descriptor currently in use; -1 if none.  */
Tom Tromey's avatar
Tom Tromey committed
271
static int max_desc;
272

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

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

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

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

292
static int proc_buffered_char[FD_SETSIZE];
293

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

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

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

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

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
enum fd_bits
{
  /* Read from file descriptor.  */
  FOR_READ = 1,
  /* Write to file descriptor.  */
  FOR_WRITE = 2,
  /* This descriptor refers to a keyboard.  Only valid if FOR_READ is
     set.  */
  KEYBOARD_FD = 4,
  /* This descriptor refers to a process.  */
  PROCESS_FD = 8,
  /* A non-blocking connect.  Only valid if FOR_WRITE is set.  */
  NON_BLOCKING_CONNECT_FD = 16
};

428
static struct fd_callback_data
429 430 431
{
  fd_callback func;
  void *data;
432 433
  /* Flags from enum fd_bits.  */
  int flags;
Tom Tromey's avatar
Tom Tromey committed
434 435 436 437 438 439 440
  /* If this fd is locked to a certain thread, this points to it.
     Otherwise, this is NULL.  If an fd is locked to a thread, then
     only that thread is permitted to wait on it.  */
  struct thread_state *thread;
  /* If this fd is currently being selected on by a thread, this
     points to the thread.  Otherwise it is NULL.  */
  struct thread_state *waiting_thread;
441
} fd_callback_info[FD_SETSIZE];
442 443 444 445 446 447 448 449 450 451 452 453


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

Tom Tromey's avatar
Tom Tromey committed
456
static void
457 458
add_non_keyboard_read_fd (int fd)
{
Ken Raeburn's avatar
Ken Raeburn committed
459
  eassert (fd >= 0 && fd < FD_SETSIZE);
460
  eassert (fd_callback_info[fd].func == NULL);
Eli Zaretskii's avatar
Eli Zaretskii committed
461 462

  fd_callback_info[fd].flags &= ~KEYBOARD_FD;
463
  fd_callback_info[fd].flags |= FOR_READ;
Tom Tromey's avatar
Tom Tromey committed
464 465
  if (fd > max_desc)
    max_desc = fd;
466 467
}

Tom Tromey's avatar
Tom Tromey committed
468
static void
469 470 471 472
add_process_read_fd (int fd)
{
  add_non_keyboard_read_fd (fd);
  fd_callback_info[fd].flags |= PROCESS_FD;
473 474 475 476 477 478 479 480 481
}

/* Stop monitoring file descriptor FD for when read is possible.  */

void
delete_read_fd (int fd)
{
  delete_keyboard_wait_descriptor (fd);

482
  if (fd_callback_info[fd].flags == 0)
483 484 485 486 487 488 489 490 491 492 493 494
    {
      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)
{
Eli Zaretskii's avatar
Eli Zaretskii committed
495
  eassert (fd >= 0 && fd < FD_SETSIZE);
496 497 498

  fd_callback_info[fd].func = func;
  fd_callback_info[fd].data = data;
499
  fd_callback_info[fd].flags |= FOR_WRITE;
Eli Zaretskii's avatar
Eli Zaretskii committed
500 501
  if (fd > max_desc)
    max_desc = fd;
502 503
}

Tom Tromey's avatar
Tom Tromey committed
504
static void
505 506
add_non_blocking_write_fd (int fd)
{
Ken Raeburn's avatar
Ken Raeburn committed
507
  eassert (fd >= 0 && fd < FD_SETSIZE);
508 509 510
  eassert (fd_callback_info[fd].func == NULL);

  fd_callback_info[fd].flags |= FOR_WRITE | NON_BLOCKING_CONNECT_FD;
Tom Tromey's avatar
Tom Tromey committed
511 512
  if (fd > max_desc)
    max_desc = fd;
513
  ++num_pending_connects;
514
}
515 516

static void
Tom Tromey's avatar
Tom Tromey committed
517
recompute_max_desc (void)
518
{
Tom Tromey's avatar
Tom Tromey committed
519
  int fd;
520

Tom Tromey's avatar
Tom Tromey committed
521 522 523 524 525 526 527
  for (fd = max_desc; fd >= 0; --fd)
    {
      if (fd_callback_info[fd].flags != 0)
	{
	  max_desc = fd;
	  break;
	}
528 529 530
    }
}

531 532 533 534 535
/* Stop monitoring file descriptor FD for when write is possible.  */

void
delete_write_fd (int fd)
{
536 537 538
  if ((fd_callback_info[fd].flags & NON_BLOCKING_CONNECT_FD) != 0)
    {
      if (--num_pending_connects < 0)
Eli Zaretskii's avatar
Eli Zaretskii committed
539
	emacs_abort ();
540 541 542
    }
  fd_callback_info[fd].flags &= ~(FOR_WRITE | NON_BLOCKING_CONNECT_FD);
  if (fd_callback_info[fd].flags == 0)
543 544 545 546
    {
      fd_callback_info[fd].func = 0;
      fd_callback_info[fd].data = 0;

Tom Tromey's avatar
Tom Tromey committed
547 548
      if (fd == max_desc)
	recompute_max_desc ();
549 550 551 552
    }
}

static void
Ken Raeburn's avatar
Ken Raeburn committed
553
compute_input_wait_mask (fd_set *mask)
554 555
{
  int fd;
556

557
  FD_ZERO (mask);
Tom Tromey's avatar
Tom Tromey committed
558
  for (fd = 0; fd <= max_desc; ++fd)
559
    {
Tom Tromey's avatar
Tom Tromey committed
560 561 562 563 564 565
      if (fd_callback_info[fd].thread != NULL
	  && fd_callback_info[fd].thread != current_thread)
	continue;
      if (fd_callback_info[fd].waiting_thread != NULL
	  && fd_callback_info[fd].waiting_thread != current_thread)
	continue;
566
      if ((fd_callback_info[fd].flags & FOR_READ) != 0)
Tom Tromey's avatar
Tom Tromey committed
567 568 569 570
	{
	  FD_SET (fd, mask);
	  fd_callback_info[fd].waiting_thread = current_thread;
	}
571 572 573
    }
}

574
static void
Ken Raeburn's avatar
Ken Raeburn committed
575
compute_non_process_wait_mask (fd_set *mask)
576 577 578 579
{
  int fd;

  FD_ZERO (mask);
Tom Tromey's avatar
Tom Tromey committed
580
  for (fd = 0; fd <= max_desc; ++fd)
581
    {
Tom Tromey's avatar
Tom Tromey committed
582 583 584 585 586 587
      if (fd_callback_info[fd].thread != NULL
	  && fd_callback_info[fd].thread != current_thread)
	continue;
      if (fd_callback_info[fd].waiting_thread != NULL
	  && fd_callback_info[fd].waiting_thread != current_thread)
	continue;
588 589
      if ((fd_callback_info[fd].flags & FOR_READ) != 0
	  && (fd_callback_info[fd].flags & PROCESS_FD) == 0)
Tom Tromey's avatar
Tom Tromey committed
590 591 592 593
	{
	  FD_SET (fd, mask);
	  fd_callback_info[fd].waiting_thread = current_thread;
	}
594 595 596 597
    }
}

static void
Ken Raeburn's avatar
Ken Raeburn committed
598
compute_non_keyboard_wait_mask (fd_set *mask)
599 600 601 602
{
  int fd;

  FD_ZERO (mask);
Tom Tromey's avatar
Tom Tromey committed
603
  for (fd = 0; fd <= max_desc; ++fd)
604
    {
Tom Tromey's avatar
Tom Tromey committed
605 606 607 608 609 610
      if (fd_callback_info[fd].thread != NULL
	  && fd_callback_info[fd].thread != current_thread)
	continue;
      if (fd_callback_info[fd].waiting_thread != NULL
	  && fd_callback_info[fd].waiting_thread != current_thread)
	continue;
611 612
      if ((fd_callback_info[fd].flags & FOR_READ) != 0
	  && (fd_callback_info[fd].flags & KEYBOARD_FD) == 0)
Tom Tromey's avatar
Tom Tromey committed
613 614 615 616
	{
	  FD_SET (fd, mask);
	  fd_callback_info[fd].waiting_thread = current_thread;
	}
617 618 619 620
    }
}

static void
Ken Raeburn's avatar
Ken Raeburn committed
621
compute_write_mask (fd_set *mask)
622 623 624 625
{
  int fd;

  FD_ZERO (mask);
Tom Tromey's avatar
Tom Tromey committed
626
  for (fd = 0; fd <= max_desc; ++fd)
627
    {
Tom Tromey's avatar
Tom Tromey committed
628 629 630 631 632 633
      if (fd_callback_info[fd].thread != NULL
	  && fd_callback_info[fd].thread != current_thread)
	continue;
      if (fd_callback_info[fd].waiting_thread != NULL
	  && fd_callback_info[fd].waiting_thread != current_thread)
	continue;
634
      if ((fd_callback_info[fd].flags & FOR_WRITE) != 0)
Tom Tromey's avatar
Tom Tromey committed
635 636 637 638
	{
	  FD_SET (fd, mask);
	  fd_callback_info[fd].waiting_thread = current_thread;
	}
639 640 641
    }
}

Tom Tromey's avatar
Tom Tromey committed
642 643 644 645
static void
clear_waiting_thread_info (void)
{
  int fd;
646

Tom Tromey's avatar
Tom Tromey committed
647
  for (fd = 0; fd <= max_desc; ++fd)
Tom Tromey's avatar
Tom Tromey committed
648 649 650
    {
      if (fd_callback_info[fd].waiting_thread == current_thread)
	fd_callback_info[fd].waiting_thread = NULL;
651 652 653
    }
}

Jim Blandy's avatar
Jim Blandy committed
654 655 656 657

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

658
static Lisp_Object status_convert (int);
659

660
static void
661
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
662
{
663
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
664
  pset_status (p, status_convert (p->raw_status));
665
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
666 667
}

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

671
static Lisp_Object
672
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
673 674 675 676
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
677
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
678 679 680 681 682 683 684 685
				WCOREDUMP (w) ? Qt : Qnil));
  else if (WIFSIGNALED (w))
    return Fcons (Qsignal, Fcons (make_number (WTERMSIG (w)),
				  WCOREDUMP (w) ? Qt : Qnil));
  else
    return Qrun;
}

686 687 688 689 690 691 692 693
/* True if STATUS is that of a process attempting connection.  */

static bool
connecting_status (Lisp_Object status)
{
  return CONSP (status) && EQ (XCAR (status), Qconnect);
}

Jim Blandy's avatar
Jim Blandy committed
694 695 696
/* Given a status-list, extract the three pieces of information
   and store them individually through the three pointers.  */

697
static void
698 699
decode_status (Lisp_Object l, Lisp_Object *symbol, Lisp_Object *code,
	       bool *coredump)
Jim Blandy's avatar
Jim Blandy committed
700 701 702
{
  Lisp_Object tem;

703 704 705
  if (connecting_status (l))
    l = XCAR (l);

706
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
707 708
    {
      *symbol = l;
709
      *code = make_number (0);
Jim Blandy's avatar
Jim Blandy committed
710 711 712 713
      *coredump = 0;
    }
  else
    {
714 715
      *symbol = XCAR (l);
      tem = XCDR (l);
716
      *code = XCAR (tem);
717
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
718 719 720 721 722 723
      *coredump = !NILP (tem);
    }
}

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

724
static Lisp_Object
725
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
726
{
727
  Lisp_Object status = p->status;
728
  Lisp_Object symbol, code;
729
  bool coredump;
730
  Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
731 732 733 734 735

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
736
      char const *signame;
737
      synchronize_system_messages_locale ();
738
      signame = strsignal (XFASTINT (code));
739
      if (signame == 0)
740 741 742 743 744
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

745
	  string = build_unibyte_string (signame);
746 747 748
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
749
	  c1 = STRING_CHAR (SDATA (string));
750
	  c2 = downcase (c1);
751
	  if (c1 != c2)
752
	    Faset (string, make_number (0), make_number (c2));
753
	}
754 755
      AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, suffix);
Jim Blandy's avatar
Jim Blandy committed
756 757 758
    }
  else if (EQ (symbol, Qexit))
    {
759
      if (NETCONN1_P (p))
760 761 762 763
	return build_string (XFASTINT (code) == 0
			     ? "deleted\n"
			     : "connection broken by remote peer\n");
      if (XFASTINT (code) == 0)
Jim Blandy's avatar
Jim Blandy committed
764
	return build_string ("finished\n");
765
      AUTO_STRING (prefix, "exited abnormally with code ");
766
      string = Fnumber_to_string (code);
767 768
      AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
      return concat3 (prefix, string, suffix);
Jim Blandy's avatar
Jim Blandy committed
769
    }
770 771
  else if (EQ (symbol, Qfailed))
    {
772 773
      AUTO_STRING (format, "failed with code %s\n");
      return CALLN (Fformat, format, code);
774
    }
Jim Blandy's avatar
Jim Blandy committed
775 776 777 778
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

779
enum { PTY_NAME_SIZE = 24 };
Dan Nicolaescu's avatar
Dan Nicolaescu committed
780

781
/* Open an available pty, returning a file descriptor.
782 783
   Store into PTY_NAME the file name of the terminal corresponding to the pty.
   Return -1 on failure.  */
784

785
static int
786
allocate_pty (char pty_name[PTY_NAME_SIZE])
Jim Blandy's avatar
Jim Blandy committed
787
{
788
#ifdef HAVE_PTYS
Jim Blandy's avatar
Jim Blandy committed
789 790 791 792 793
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
794
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
795 796 797 798 799 800 801 802 803 804
  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 */

805 806 807
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
808
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
809
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
810 811 812

	if (fd >= 0)
	  {
813 814 815 816 817 818
#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 */

819 820 821
	    /* 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.
822 823
	       Do this after PTY_TTY_NAME_SPRINTF, which on some platforms
	       doesn't work if the close-on-exec flag is set (Bug#20555).
824 825 826 827
	       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);
828 829 830

	    /* Check to make certain that both sides are available.
	       This avoids a nasty yet stupid bug in rlogins.  */
831
	    if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
Jim Blandy's avatar
Jim Blandy committed
832
	      {
833
		emacs_close (fd);
Jim Blandy's avatar
Jim Blandy committed
834 835 836 837 838 839
		continue;
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
840
#endif /* HAVE_PTYS */
Jim Blandy's avatar
Jim Blandy committed
841 842
  return -1;
}
843 844 845 846 847 848 849 850 851

/* Allocate basically initialized process.  */

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

852
static Lisp_Object
853
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
854
{
855
  struct Lisp_Process *p = allocate_process ();
856 857
  /* 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
858 859
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Tom Tromey's avatar
Tom Tromey committed
860
  pset_thread (p, Fcurrent_thread ());
Jim Blandy's avatar
Jim Blandy committed
861

862 863 864 865
  /* 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;
866
  for (int i = 0; i < PROCESS_OPEN_FDS; i++)
867
    p->open_fd[i] = -1;
Kenichi Handa's avatar
Kenichi Handa committed
868

Ted Zlatanov's avatar
Ted Zlatanov committed
869
#ifdef HAVE_GNUTLS
870 871 872
  verify (GNUTLS_STAGE_EMPTY == 0);
  eassert (p->gnutls_initstage == GNUTLS_STAGE_EMPTY);
  eassert (NILP (p->gnutls_boot_parameters));
Ted Zlatanov's avatar
Ted Zlatanov committed
873 874
#endif

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

877 878
  Lisp_Object name1 = name;
  for (printmax_t i = 1; ; i++)
Jim Blandy's avatar
Jim Blandy committed
879
    {
880 881 882 883 884 885 886
      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
887 888
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
889
  pset_name (p, name);
890 891
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
892
  Lisp_Object val;
893
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
894 895 896 897
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

898
static void
899
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
900 901 902 903 904 905 906 907
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
908

Tom Tromey's avatar
Tom Tromey committed
909 910 911 912 913 914 915 916 917 918 919 920
void
update_processes_for_thread_death (Lisp_Object dying_thread)
{
  Lisp_Object pair;

  for (pair = Vprocess_alist; !NILP (pair); pair = XCDR (pair))
    {
      Lisp_Object process = XCDR (XCAR (pair));
      if (EQ (XPROCESS (process)->thread, dying_thread))
	{
	  struct Lisp_Process *proc = XPROCESS (process);

Eli Zaretskii's avatar
Eli Zaretskii committed
921
	  pset_thread (proc, Qnil);
Tom Tromey's avatar
Tom Tromey committed
922 923 924 925 926 927 928 929
	  if (proc->infd >= 0)
	    fd_callback_info[proc->infd].thread = NULL;
	  if (proc->outfd >= 0)
	    fd_callback_info[proc->outfd].thread = NULL;
	}
    }
}

930 931 932 933 934 935
#ifdef HAVE_GETADDRINFO_A
static void
free_dns_request (Lisp_Object proc)
{
  struct Lisp_Process *p = XPROCESS (proc);

936 937 938 939
  if (p->dns_request->ar_result)
    freeaddrinfo (p->dns_request->ar_result);
  xfree (p->dns_request);
  p->dns_request = NULL;
940 941 942
}
#endif

Jim Blandy's avatar
Jim Blandy committed
943 944

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
945
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
946
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
947
{
948
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
949 950 951
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
952
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
953
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
954
{
955
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
956
    return name;
957
  CHECK_STRING (name);
958
  return Fcdr (Fassoc (name, Vprocess_alist, Qnil));
Jim Blandy's avatar
Jim Blandy committed
959 960
}

Jim Blandy's avatar
Jim Blandy committed
961 962 963 964
/* 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
965

966
static Lisp_Object
967
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
968
{
969 970 971 972 973 974 975
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
976
	error ("Process %s does not exist", SDATA (name));
977 978 979
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
980
  else
981 982
    obj = name;

983 984
  /* Now obj should be either a buffer object or a process object.  */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
985
    {
986 987
      if (NILP (BVAR (XBUFFER (obj), name)))
        error ("Attempt to get process for a dead buffer");
988
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
989
      if (NILP (proc))
990
        error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
991 992
    }
  else
993
    {
994
      CHECK_PROCESS (obj);
995 996 997
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
998 999
}

1000 1001 1002

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

1006 1007 1008 1009 1010
   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.  */
1011 1012
static Lisp_Object deleted_pid_list;

1013
void
1014
record_deleted_pid (pid_t pid, Lisp_Object filename)
1015
{
1016
  deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
1017 1018 1019 1020 1021
			    /* GC treated elements set to nil.  */
			    Fdelq (Qnil, deleted_pid_list));

}

Jim Blandy's avatar
Jim Blandy committed
1022
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
1023 1024 1025
       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
1026
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1027
{
1028 1029
  register struct Lisp_Process *p;

1030
  process = get_process (process);
1031 1032
  p = XPROCESS (process);

1033
#ifdef HAVE_GETADDRINFO_A
1034
  if (p->dns_request)
1035
    {
1036 1037
      /* Cancel the request.  Unless shutting down, wait until
	 completion.  Free the request if completely canceled. */
1038

1039 1040
      bool canceled = gai_cancel (p->dns_request) != EAI_NOTCANCELED;
      if (!canceled && !inhibit_sentinels)
1041
	{
1042 1043 1044 1045
	  struct gaicb const *req = p->dns_request;
	  while (gai_suspend (&req, 1, NULL) != 0)
	    continue;
	  canceled = true;
1046
	}
1047 1048
      if (canceled)
	free_dns_request (process);
1049 1050 1051
    }
#endif