process.c 213 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

Eli Zaretskii's avatar
Eli Zaretskii committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
/* 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.  */
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
# pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

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

160 161
#ifndef SOCK_CLOEXEC
# define SOCK_CLOEXEC 0
Paul Eggert's avatar
Paul Eggert committed
162 163 164
#endif

#ifndef HAVE_ACCEPT4
165 166 167 168 169 170 171 172 173 174 175

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

176 177 178
# undef accept4
# define accept4(sockfd, addr, addrlen, flags) \
    process_accept4 (sockfd, addr, addrlen, flags)
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
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

194
Lisp_Object Qprocessp;
195 196 197 198 199
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
200
#ifdef AF_INET6
201
static Lisp_Object Qipv6;
Kim F. Storm's avatar
Kim F. Storm committed
202
#endif
203 204
static Lisp_Object QCport, QCprocess;
Lisp_Object QCspeed;
205 206
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
207 208 209 210 211
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;
212 213
static Lisp_Object Qinternal_default_process_sentinel;
static Lisp_Object Qinternal_default_process_filter;
214

215 216 217 218
#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
219 220

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

225 226
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

227
/* Only W32 has this, it really means that select can't take write mask.  */
228 229
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
230
enum { SELECT_CAN_DO_WRITE_MASK = false };
231
#else
232
enum { SELECT_CAN_DO_WRITE_MASK = true };
233 234 235 236 237 238 239 240 241 242 243
#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 */

244 245 246 247 248
/* 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
249 250 251 252 253 254 255
#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
256

Stefan Monnier's avatar
Stefan Monnier committed
257 258 259 260
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
261 262 263 264 265
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#define ADAPTIVE_READ_BUFFERING
#endif

#ifdef ADAPTIVE_READ_BUFFERING
266
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
267 268 269
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

270 271
/* 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
272 273 274

static int process_output_delay_count;

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

277
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
278 279 280 281 282

#else
#define process_output_delay_count 0
#endif

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

293 294
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
295

296 297
/* Mask of bits indicating the descriptors that we wait for input on.  */

298
static fd_set input_wait_mask;
299

300
/* Mask that excludes keyboard input descriptor(s).  */
301

302
static fd_set non_keyboard_wait_mask;
303

304
/* Mask that excludes process input descriptor(s).  */
305

306
static fd_set non_process_wait_mask;
307

308
/* Mask for selecting for write.  */
309

310
static fd_set write_mask;
311

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

317
static fd_set connect_wait_mask;
318 319 320

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

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

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

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

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

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

341
static int proc_buffered_char[FD_SETSIZE];
342

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

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

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

451 452


453
static struct fd_callback_data
454 455 456 457 458 459
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
  int condition; /* mask of the defines above.  */
460
} fd_callback_info[FD_SETSIZE];
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505


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

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

522 523 524 525 526 527 528 529 530 531 532
/* 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;
533
      delete_input_desc (fd);
534 535 536
    }
}

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

541
static Lisp_Object status_convert (int);
542

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Ted Zlatanov's avatar
Ted Zlatanov committed
739 740 741 742
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

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

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

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

  deactivate_process (proc);
}
771

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

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

Jim Blandy's avatar
Jim Blandy committed
790 791 792 793
/* 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
794

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

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

829 830 831

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

835 836 837 838 839
   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.  */
840 841
static Lisp_Object deleted_pid_list;

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

}

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

859
  process = get_process (process);
860 861
  p = XPROCESS (process);

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

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

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

915 916
  if (STRINGP (process))
    process = Fget_process (process);
917
  else
918
    process = get_process (process);
919

920 921
  if (NILP (process))
    return process;
922

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
1000
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
1001
       2, 2, 0,
1002 1003
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1004
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
1005
{
1006 1007
  struct Lisp_Process *p;

1008
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
1009
  if (!NILP (buffer))
1010
    CHECK_BUFFER (buffer);
1011
  p = XPROCESS (process);
Paul Eggert's avatar
Paul Eggert committed
1012
  pset_buffer (p, buffer);
1013
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Paul Eggert's avatar
Paul Eggert committed