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

3 4
Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2014
  Free Software 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 82
#ifdef HAVE_RES_INIT
#include <arpa/nameser.h>
#include <resolv.h>
#endif

83 84 85 86
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
87 88 89 90
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

91 92
#include <c-ctype.h>
#include <sig2str.h>
93
#include <verify.h>
94

95 96
#endif	/* subprocesses */

Jim Blandy's avatar
Jim Blandy committed
97
#include "systime.h"
98
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
99 100

#include "window.h"
101
#include "character.h"
102
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
103
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
104
#include "process.h"
105
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
106 107 108
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
109
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
110
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
111
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
112
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
113
#include "atimer.h"
114 115 116
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
117 118 119
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
120

121 122 123 124
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

125
#ifdef HAVE_GLIB
126
#include "xgselect.h"
127 128 129
#ifndef WINDOWSNT
#include <glib.h>
#endif
130
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
131

132
#ifdef WINDOWSNT
133
extern int sys_select (int, fd_set *, fd_set *, fd_set *,
134
		       struct timespec *, void *);
135 136
#endif

137 138
#ifndef SOCK_CLOEXEC
# define SOCK_CLOEXEC 0
Paul Eggert's avatar
Paul Eggert committed
139 140 141
#endif

#ifndef HAVE_ACCEPT4
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167

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

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

168 169 170
/* Work around GCC 4.7.0 bug with strict overflow checking; see
   <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
   These lines can be removed once the GCC bug is fixed.  */
171
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
172 173 174
# pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

175 176 177 178 179 180
Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
Lisp_Object QCname, QCtype;

181
/* True if keyboard input is on hold, zero otherwise.  */
182

183
static bool kbd_is_on_hold;
184 185 186

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

189 190
#ifdef subprocesses

191
Lisp_Object Qprocessp;
192 193 194 195 196
static Lisp_Object Qrun, Qstop, Qsignal;
static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
Lisp_Object Qlocal;
static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
static Lisp_Object Qreal, Qnetwork, Qserial;
Kim F. Storm's avatar
Kim F. Storm committed
197
#ifdef AF_INET6
198
static Lisp_Object Qipv6;
Kim F. Storm's avatar
Kim F. Storm committed
199
#endif
200 201
static Lisp_Object QCport, QCprocess;
Lisp_Object QCspeed;
202 203
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
204 205 206 207 208
static Lisp_Object QCbuffer, QChost, QCservice;
static Lisp_Object QClocal, QCremote, QCcoding;
static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
static Lisp_Object Qlast_nonmenu_event;
209 210
static Lisp_Object Qinternal_default_process_sentinel;
static Lisp_Object Qinternal_default_process_filter;
211

212 213 214 215
#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))
Jim Blandy's avatar
Jim Blandy committed
216 217

/* Number of events of change of status of a process.  */
218
static EMACS_INT process_tick;
Jim Blandy's avatar
Jim Blandy committed
219
/* Number of events for which the user or sentinel has been notified.  */
220
static EMACS_INT update_tick;
Jim Blandy's avatar
Jim Blandy committed
221

222 223
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

224
/* Only W32 has this, it really means that select can't take write mask.  */
225 226
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
227
#define SELECT_CANT_DO_WRITE_MASK
228 229 230 231 232 233 234 235 236 237 238 239
#else
#ifndef NON_BLOCKING_CONNECT
#ifdef HAVE_SELECT
#if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
#if defined (EWOULDBLOCK) || defined (EINPROGRESS)
#define NON_BLOCKING_CONNECT
#endif /* EWOULDBLOCK || EINPROGRESS */
#endif /* HAVE_GETPEERNAME || GNU_LINUX */
#endif /* HAVE_SELECT */
#endif /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

240 241 242 243 244
/* 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
245 246 247 248 249 250 251
#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
252

Stefan Monnier's avatar
Stefan Monnier committed
253 254 255 256
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
257 258 259 260 261
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#define ADAPTIVE_READ_BUFFERING
#endif

#ifdef ADAPTIVE_READ_BUFFERING
262
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
263 264 265
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

266 267
/* 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
268 269 270

static int process_output_delay_count;

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

273
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
274 275 276 277 278

#else
#define process_output_delay_count 0
#endif

279
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
280
#ifdef USABLE_SIGIO
281
static bool keyboard_bit_set (fd_set *);
282
#endif
283 284 285
static void deactivate_process (Lisp_Object);
static void status_notify (struct Lisp_Process *);
static int read_process_output (Lisp_Object, int);
286
static void handle_child_signal (int);
287
static void create_pty (Lisp_Object);
288

289
/* If we support a window system, turn on the code to poll periodically
290
   to detect C-g.  It isn't actually used when doing interrupt input.  */
291
#ifdef HAVE_WINDOW_SYSTEM
292 293 294
#define POLL_FOR_INPUT
#endif

295 296
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
297

298 299
/* Mask of bits indicating the descriptors that we wait for input on.  */

300
static fd_set input_wait_mask;
301

302
/* Mask that excludes keyboard input descriptor(s).  */
303

304
static fd_set non_keyboard_wait_mask;
305

306
/* Mask that excludes process input descriptor(s).  */
307

308
static fd_set non_process_wait_mask;
309

310
/* Mask for selecting for write.  */
311

312
static fd_set write_mask;
313

314
#ifdef NON_BLOCKING_CONNECT
315 316 317 318
/* 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.  */

319
static fd_set connect_wait_mask;
320 321 322

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

325
/* The largest descriptor currently in use for a process object; -1 if none.  */
326 327
static int max_process_desc;

328
/* The largest descriptor currently in use for input; -1 if none.  */
329
static int max_input_desc;
330

Jim Blandy's avatar
Jim Blandy committed
331
/* Indexed by descriptor, gives the process (if any) for that descriptor */
332
static Lisp_Object chan_process[FD_SETSIZE];
Jim Blandy's avatar
Jim Blandy committed
333 334

/* Alist of elements (NAME . PROCESS) */
335
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339 340 341 342

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

343
static int proc_buffered_char[FD_SETSIZE];
344

Karl Heuer's avatar
Karl Heuer committed
345
/* Table of `struct coding-system' for each process.  */
346 347
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
348

349 350
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
351
static struct sockaddr_and_len {
352 353
  struct sockaddr *sa;
  int len;
354
} datagram_address[FD_SETSIZE];
355
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
356
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
357 358 359 360 361
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

362 363 364 365 366 367
/* 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
368
/* These setters are used only in this file, so they can be private.  */
369
static void
Paul Eggert's avatar
Paul Eggert committed
370 371 372 373
pset_buffer (struct Lisp_Process *p, Lisp_Object val)
{
  p->buffer = val;
}
374
static void
Paul Eggert's avatar
Paul Eggert committed
375 376 377 378
pset_command (struct Lisp_Process *p, Lisp_Object val)
{
  p->command = val;
}
379
static void
Paul Eggert's avatar
Paul Eggert committed
380 381 382 383
pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->decode_coding_system = val;
}
384
static void
Paul Eggert's avatar
Paul Eggert committed
385 386 387 388
pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->decoding_buf = val;
}
389
static void
Paul Eggert's avatar
Paul Eggert committed
390 391 392 393
pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->encode_coding_system = val;
}
394
static void
Paul Eggert's avatar
Paul Eggert committed
395 396 397 398
pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->encoding_buf = val;
}
399
static void
Paul Eggert's avatar
Paul Eggert committed
400 401
pset_filter (struct Lisp_Process *p, Lisp_Object val)
{
402
  p->filter = NILP (val) ? Qinternal_default_process_filter : val;
Paul Eggert's avatar
Paul Eggert committed
403
}
404
static void
Paul Eggert's avatar
Paul Eggert committed
405 406 407 408
pset_log (struct Lisp_Process *p, Lisp_Object val)
{
  p->log = val;
}
409
static void
Paul Eggert's avatar
Paul Eggert committed
410 411 412 413
pset_mark (struct Lisp_Process *p, Lisp_Object val)
{
  p->mark = val;
}
414
static void
Paul Eggert's avatar
Paul Eggert committed
415 416 417 418
pset_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->name = val;
}
419
static void
Paul Eggert's avatar
Paul Eggert committed
420 421 422 423
pset_plist (struct Lisp_Process *p, Lisp_Object val)
{
  p->plist = val;
}
424
static void
Paul Eggert's avatar
Paul Eggert committed
425 426
pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
{
427
  p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
Paul Eggert's avatar
Paul Eggert committed
428
}
429
static void
Paul Eggert's avatar
Paul Eggert committed
430 431 432 433
pset_status (struct Lisp_Process *p, Lisp_Object val)
{
  p->status = val;
}
434
static void
Paul Eggert's avatar
Paul Eggert committed
435 436 437 438
pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->tty_name = val;
}
439
static void
Paul Eggert's avatar
Paul Eggert committed
440 441 442 443
pset_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->type = val;
}
444
static void
Paul Eggert's avatar
Paul Eggert committed
445 446 447 448 449
pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
{
  p->write_queue = val;
}

450 451


452
static struct fd_callback_data
453 454 455 456 457 458
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
  int condition; /* mask of the defines above.  */
459
} fd_callback_info[FD_SETSIZE];
460 461 462 463 464 465 466 467


/* 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)
{
468
  eassert (fd < FD_SETSIZE);
469 470 471 472 473 474 475 476 477 478 479 480
  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)
{
481
  eassert (fd < FD_SETSIZE);
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
  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)
{
498
  eassert (fd < FD_SETSIZE);
499 500 501 502 503 504 505 506 507
  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;
}

508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
/* 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;
    }
}

524 525 526 527 528
/* Stop monitoring file descriptor FD for when write is possible.  */

void
delete_write_fd (int fd)
{
529
  eassert (fd < FD_SETSIZE);
530 531 532 533 534 535
  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;
536
      delete_input_desc (fd);
537 538 539
    }
}

Jim Blandy's avatar
Jim Blandy committed
540 541 542 543

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

544
static Lisp_Object status_convert (int);
545

546
static void
547
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
548
{
549
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
550
  pset_status (p, status_convert (p->raw_status));
551
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
552 553
}

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

557
static Lisp_Object
558
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
559 560 561 562
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
563
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
564 565 566 567 568 569 570 571 572 573 574
				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.  */

575
static void
576
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
Jim Blandy's avatar
Jim Blandy committed
577 578 579
{
  Lisp_Object tem;

580
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
581 582 583 584 585 586 587
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
588 589 590 591
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
592 593 594 595 596 597
      *coredump = !NILP (tem);
    }
}

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

598
static Lisp_Object
599
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
600
{
601
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
602
  Lisp_Object symbol;
603 604
  int code;
  bool coredump;
Jim Blandy's avatar
Jim Blandy committed
605 606 607 608 609 610
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
611
      char const *signame;
612
      synchronize_system_messages_locale ();
613
      signame = strsignal (code);
614
      if (signame == 0)
615 616 617 618 619
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

620
	  string = build_unibyte_string (signame);
621 622 623
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
624
	  c1 = STRING_CHAR (SDATA (string));
625
	  c2 = downcase (c1);
626
	  if (c1 != c2)
627
	    Faset (string, make_number (0), make_number (c2));
628
	}
Jim Blandy's avatar
Jim Blandy committed
629 630 631 632 633
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
634 635
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
636 637
      if (code == 0)
	return build_string ("finished\n");
638
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
639
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
640 641
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
642
    }
643 644 645 646
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
647 648
      return concat3 (build_string ("failed with code "),
		      string, string2);
649
    }
Jim Blandy's avatar
Jim Blandy committed
650 651 652 653
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

654
enum { PTY_NAME_SIZE = 24 };
Dan Nicolaescu's avatar
Dan Nicolaescu committed
655

656
/* Open an available pty, returning a file descriptor.
657 658
   Store into PTY_NAME the file name of the terminal corresponding to the pty.
   Return -1 on failure.  */
659

660
static int
661
allocate_pty (char pty_name[PTY_NAME_SIZE])
Jim Blandy's avatar
Jim Blandy committed
662
{
663
#ifdef HAVE_PTYS
Jim Blandy's avatar
Jim Blandy committed
664 665 666 667 668
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
669
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
670 671 672 673 674 675 676 677 678 679
  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 */

680 681 682
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
683
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
684
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
685 686 687

	if (fd >= 0)
	  {
688 689 690 691 692 693 694 695 696
#ifdef PTY_OPEN
	    /* 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.
	       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);
#endif
Jim Blandy's avatar
Jim Blandy committed
697 698 699 700 701
	    /* check to make certain that both sides are available
	       this avoids a nasty yet stupid bug in rlogins */
#ifdef PTY_TTY_NAME_SPRINTF
	    PTY_TTY_NAME_SPRINTF
#else
702
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
703
#endif /* no PTY_TTY_NAME_SPRINTF */
704
	    if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
Jim Blandy's avatar
Jim Blandy committed
705
	      {
706
		emacs_close (fd);
707
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
708
		continue;
709
# else
Jim Blandy's avatar
Jim Blandy committed
710
		return -1;
711
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
712 713 714 715 716
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
717
#endif /* HAVE_PTYS */
Jim Blandy's avatar
Jim Blandy committed
718 719 720
  return -1;
}

721
static Lisp_Object
722
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
723 724 725
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
726 727
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
728

729
  p = allocate_process ();
730 731
  /* 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
732 733
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
734

735 736 737 738
  /* 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;
739 740
  for (i = 0; i < PROCESS_OPEN_FDS; i++)
    p->open_fd[i] = -1;
Kenichi Handa's avatar
Kenichi Handa committed
741

Ted Zlatanov's avatar
Ted Zlatanov committed
742 743 744 745
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

Jim Blandy's avatar
Jim Blandy committed
746 747 748 749 750 751 752
  /* 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;
753
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
754 755
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
756
  pset_name (p, name);
757 758
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
759
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
760 761 762 763
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

764
static void
765
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
766 767 768 769 770 771 772 773
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
774

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

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

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

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

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

832 833 834

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

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

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

}

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

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

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

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

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

918 919
  if (STRINGP (process))
    process = Fget_process (process);
920
  else
921
    process = get_process (process);
922

923 924
  if (NILP (process))
    return process;
925

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
1003
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
1004
       2, 2, 0,