process.c 212 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 4
Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2015 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
/* 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

/* 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

154 155
#ifndef SOCK_CLOEXEC
# define SOCK_CLOEXEC 0
Paul Eggert's avatar
Paul Eggert committed
156 157 158
#endif

#ifndef HAVE_ACCEPT4
159 160 161 162 163 164 165 166 167 168 169

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

170 171 172
# undef accept4
# define accept4(sockfd, addr, addrlen, flags) \
    process_accept4 (sockfd, addr, addrlen, flags)
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
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

188 189 190 191
#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
192 193

/* Number of events of change of status of a process.  */
194
static EMACS_INT process_tick;
Jim Blandy's avatar
Jim Blandy committed
195
/* Number of events for which the user or sentinel has been notified.  */
196
static EMACS_INT update_tick;
Jim Blandy's avatar
Jim Blandy committed
197

198 199
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

200
/* Only W32 has this, it really means that select can't take write mask.  */
201 202
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
203
enum { SELECT_CAN_DO_WRITE_MASK = false };
204
#else
205
enum { SELECT_CAN_DO_WRITE_MASK = true };
206 207 208 209 210 211 212 213 214 215 216
#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 */

217 218 219 220 221
/* 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
222 223 224 225 226 227 228
#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
229

Stefan Monnier's avatar
Stefan Monnier committed
230 231 232 233
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
234 235 236 237 238
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#define ADAPTIVE_READ_BUFFERING
#endif

#ifdef ADAPTIVE_READ_BUFFERING
239
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
240 241 242
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

243 244
/* 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
245 246 247

static int process_output_delay_count;

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

250
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
251 252 253 254 255

#else
#define process_output_delay_count 0
#endif

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

266 267
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
268

269 270
/* Mask of bits indicating the descriptors that we wait for input on.  */

271
static fd_set input_wait_mask;
272

273
/* Mask that excludes keyboard input descriptor(s).  */
274

275
static fd_set non_keyboard_wait_mask;
276

277
/* Mask that excludes process input descriptor(s).  */
278

279
static fd_set non_process_wait_mask;
280

281
/* Mask for selecting for write.  */
282

283
static fd_set write_mask;
284

285
#ifdef NON_BLOCKING_CONNECT
286 287 288 289
/* 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.  */

290
static fd_set connect_wait_mask;
291 292 293

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

296
/* The largest descriptor currently in use for a process object; -1 if none.  */
297 298
static int max_process_desc;

299
/* The largest descriptor currently in use for input; -1 if none.  */
300
static int max_input_desc;
301

302
/* Indexed by descriptor, gives the process (if any) for that descriptor.  */
303
static Lisp_Object chan_process[FD_SETSIZE];
Jim Blandy's avatar
Jim Blandy committed
304

305
/* Alist of elements (NAME . PROCESS).  */
306
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
307 308 309 310 311 312 313

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

314
static int proc_buffered_char[FD_SETSIZE];
315

Karl Heuer's avatar
Karl Heuer committed
316
/* Table of `struct coding-system' for each process.  */
317 318
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
319

320 321
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
322
static struct sockaddr_and_len {
323 324
  struct sockaddr *sa;
  int len;
325
} datagram_address[FD_SETSIZE];
326
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
327 328 329 330
#define DATAGRAM_CONN_P(proc)                                           \
  (PROCESSP (proc) &&                                                   \
   XPROCESS (proc)->infd >= 0 &&                                        \
   datagram_address[XPROCESS (proc)->infd].sa != 0)
331 332 333 334 335
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

336 337 338 339 340 341
/* 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
342
/* These setters are used only in this file, so they can be private.  */
343
static void
Paul Eggert's avatar
Paul Eggert committed
344 345 346 347
pset_buffer (struct Lisp_Process *p, Lisp_Object val)
{
  p->buffer = val;
}
348
static void
Paul Eggert's avatar
Paul Eggert committed
349 350 351 352
pset_command (struct Lisp_Process *p, Lisp_Object val)
{
  p->command = val;
}
353
static void
Paul Eggert's avatar
Paul Eggert committed
354 355 356 357
pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->decode_coding_system = val;
}
358
static void
Paul Eggert's avatar
Paul Eggert committed
359 360 361 362
pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->decoding_buf = val;
}
363
static void
Paul Eggert's avatar
Paul Eggert committed
364 365 366 367
pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->encode_coding_system = val;
}
368
static void
Paul Eggert's avatar
Paul Eggert committed
369 370 371 372
pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->encoding_buf = val;
}
373
static void
Paul Eggert's avatar
Paul Eggert committed
374 375
pset_filter (struct Lisp_Process *p, Lisp_Object val)
{
376
  p->filter = NILP (val) ? Qinternal_default_process_filter : val;
Paul Eggert's avatar
Paul Eggert committed
377
}
378
static void
Paul Eggert's avatar
Paul Eggert committed
379 380 381 382
pset_log (struct Lisp_Process *p, Lisp_Object val)
{
  p->log = val;
}
383
static void
Paul Eggert's avatar
Paul Eggert committed
384 385 386 387
pset_mark (struct Lisp_Process *p, Lisp_Object val)
{
  p->mark = val;
}
388
static void
Paul Eggert's avatar
Paul Eggert committed
389 390 391 392
pset_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->name = val;
}
393
static void
Paul Eggert's avatar
Paul Eggert committed
394 395 396 397
pset_plist (struct Lisp_Process *p, Lisp_Object val)
{
  p->plist = val;
}
398
static void
Paul Eggert's avatar
Paul Eggert committed
399 400
pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
{
401
  p->sentinel = NILP (val) ? Qinternal_default_process_sentinel : val;
Paul Eggert's avatar
Paul Eggert committed
402
}
403
static void
Paul Eggert's avatar
Paul Eggert committed
404 405 406 407
pset_status (struct Lisp_Process *p, Lisp_Object val)
{
  p->status = val;
}
408
static void
Paul Eggert's avatar
Paul Eggert committed
409 410 411 412
pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->tty_name = val;
}
413
static void
Paul Eggert's avatar
Paul Eggert committed
414 415 416 417
pset_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->type = val;
}
418
static void
Paul Eggert's avatar
Paul Eggert committed
419 420 421 422 423
pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
{
  p->write_queue = val;
}

424 425


426
static struct fd_callback_data
427 428 429 430 431
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
432
  int condition; /* Mask of the defines above.  */
433
} fd_callback_info[FD_SETSIZE];
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478


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

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
/* 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;
    }
}

495 496 497 498 499 500 501 502 503 504 505
/* 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;
506
      delete_input_desc (fd);
507 508 509
    }
}

Jim Blandy's avatar
Jim Blandy committed
510 511 512 513

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

514
static Lisp_Object status_convert (int);
515

516
static void
517
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
518
{
519
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
520
  pset_status (p, status_convert (p->raw_status));
521
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
522 523
}

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

527
static Lisp_Object
528
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
529 530 531 532
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
533
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
534 535 536 537 538 539 540 541 542 543 544
				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.  */

545
static void
546
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
Jim Blandy's avatar
Jim Blandy committed
547 548 549
{
  Lisp_Object tem;

550
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
551 552 553 554 555 556 557
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
558 559 560 561
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
562 563 564 565 566 567
      *coredump = !NILP (tem);
    }
}

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

568
static Lisp_Object
569
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
570
{
571
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
572
  Lisp_Object symbol;
573 574
  int code;
  bool coredump;
575
  Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
576 577 578 579 580

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
581
      char const *signame;
582
      synchronize_system_messages_locale ();
583
      signame = strsignal (code);
584
      if (signame == 0)
585 586 587 588 589
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

590
	  string = build_unibyte_string (signame);
591 592 593
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
594
	  c1 = STRING_CHAR (SDATA (string));
595
	  c2 = downcase (c1);
596
	  if (c1 != c2)
597
	    Faset (string, make_number (0), make_number (c2));
598
	}
599 600
      AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, suffix);
Jim Blandy's avatar
Jim Blandy committed
601 602 603
    }
  else if (EQ (symbol, Qexit))
    {
604 605
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
606 607
      if (code == 0)
	return build_string ("finished\n");
608
      AUTO_STRING (prefix, "exited abnormally with code ");
609
      string = Fnumber_to_string (make_number (code));
610 611
      AUTO_STRING (suffix, coredump ? " (core dumped)\n" : "\n");
      return concat3 (prefix, string, suffix);
Jim Blandy's avatar
Jim Blandy committed
612
    }
613 614
  else if (EQ (symbol, Qfailed))
    {
615
      AUTO_STRING (prefix, "failed with code ");
616
      string = Fnumber_to_string (make_number (code));
617 618
      AUTO_STRING (suffix, "\n");
      return concat3 (prefix, string, suffix);
619
    }
Jim Blandy's avatar
Jim Blandy committed
620 621 622 623
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

624
enum { PTY_NAME_SIZE = 24 };
Dan Nicolaescu's avatar
Dan Nicolaescu committed
625

626
/* Open an available pty, returning a file descriptor.
627 628
   Store into PTY_NAME the file name of the terminal corresponding to the pty.
   Return -1 on failure.  */
629

630
static int
631
allocate_pty (char pty_name[PTY_NAME_SIZE])
Jim Blandy's avatar
Jim Blandy committed
632
{
633
#ifdef HAVE_PTYS
Jim Blandy's avatar
Jim Blandy committed
634 635 636 637 638
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
639
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
640 641 642 643 644 645 646 647 648 649
  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 */

650 651 652
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
653
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
654
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
655 656 657

	if (fd >= 0)
	  {
658 659 660 661 662 663 664 665 666
#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
667 668
	    /* Check to make certain that both sides are available
	       this avoids a nasty yet stupid bug in rlogins.  */
Jim Blandy's avatar
Jim Blandy committed
669 670 671
#ifdef PTY_TTY_NAME_SPRINTF
	    PTY_TTY_NAME_SPRINTF
#else
672
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
673
#endif /* no PTY_TTY_NAME_SPRINTF */
674
	    if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
Jim Blandy's avatar
Jim Blandy committed
675
	      {
676
		emacs_close (fd);
677
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
678
		continue;
679
# else
Jim Blandy's avatar
Jim Blandy committed
680
		return -1;
681
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
682 683 684 685 686
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
687
#endif /* HAVE_PTYS */
Jim Blandy's avatar
Jim Blandy committed
688 689 690
  return -1;
}

691
static Lisp_Object
692
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
693 694 695
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
696 697
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
698

699
  p = allocate_process ();
700 701
  /* 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
702 703
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
704

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

Ted Zlatanov's avatar
Ted Zlatanov committed
712 713 714 715
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

Jim Blandy's avatar
Jim Blandy committed
716 717 718 719 720 721 722
  /* 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;
723
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
724 725
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
726
  pset_name (p, name);
727 728
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
729
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
730 731 732 733
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

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

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

  deactivate_process (proc);
}
744

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

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

Jim Blandy's avatar
Jim Blandy committed
763 764 765 766
/* 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
767

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

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

802 803 804

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

808 809 810 811 812
   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.  */
813 814
static Lisp_Object deleted_pid_list;

815
void
816
record_deleted_pid (pid_t pid, Lisp_Object filename)
817
{
818
  deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
819 820 821 822 823
			    /* GC treated elements set to nil.  */
			    Fdelq (Qnil, deleted_pid_list));

}

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

832
  process = get_process (process);
833 834
  p = XPROCESS (process);

835
  p->raw_status_new = 0;
836
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
837
    {
838
      pset_status (p, list2 (Qexit, make_number (0)));
839
      p->tick = ++process_tick;
840
      status_notify (p, NULL);
841
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
842
    }
843
  else
Jim Blandy's avatar
Jim Blandy committed
844
    {
845
      if (p->alive)
846
	record_kill_process (p, Qnil);
847 848

      if (p->infd >= 0)
849
	{
850 851 852 853 854 855 856 857 858
	  /* 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)));

859
	  p->tick = ++process_tick;
860
	  status_notify (p, NULL);
861
	  redisplay_preserve_echo_area (13);
862
	}
Jim Blandy's avatar
Jim Blandy committed
863
    }
864
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
865 866 867 868
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
869 870 871 872 873 874 875
       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.
876
listen -- for a network stream server that is listening.
877
closed -- for a network stream connection that is closed.
878 879
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
880 881 882
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
883
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
884 885 886
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
887

888 889
  if (STRINGP (process))
    process = Fget_process (process);
890
  else
891
    process = get_process (process);
892

893 894
  if (NILP (process))
    return process;
895

896
  p = XPROCESS (process);
897
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
898
    update_status (p);
899
  status = p->status;
900
  if (CONSP (status))
901
    status = XCAR (status);
902
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
903
    {
904
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
905
	status = Qclosed;
906
      else if (EQ (p->command, Qt))
907 908 909
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
910 911 912 913 914 915
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
916 917
       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
918
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
919
{
920
  CHECK_PROCESS (process);
921
  if (XPROCESS (process)->raw_status_new)
922
    update_status (XPROCESS (process));
923 924
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
925 926 927 928
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
929
       doc: /* Return the process id of PROCESS.
930
This is the pid of the external process which PROCESS uses or talks to.
931
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
932
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
933
{
934
  pid_t pid;
935

936
  CHECK_PROCESS (process);
937 938
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
939 940 941
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
942 943 944
       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
945
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
946
{
947
  CHECK_PROCESS (process);
948
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
949 950 951
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
952 953 954
       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.
955 956
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
957
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
958
{
959
  CHECK_PROCESS (process);
960
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
961 962
}

963
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
964 965 966
       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
967
  (register Lisp_Object process)
968
{
969
  CHECK_PROCESS (process);
970
  return XPROCESS (process)->tty_name;
971 972
}

Jim Blandy's avatar
Jim Blandy committed
973
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
974
       2, 2, 0,
975 976
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
977
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
978
{
979 980
  struct Lisp_Process *p;

981
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
982
  if (!NILP (buffer))
983
    CHECK_BUFFER (buffer);
984
  p = XPROCESS (process);
Paul Eggert's avatar
Paul Eggert committed
985
  pset_buffer (p, buffer);
986
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Paul Eggert's avatar
Paul Eggert committed
987
    pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
988
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
989 990 991 992
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
993 994
       1, 1, 0,
       doc: /* Return the buffer PROCESS is associated with.
995
The default process filter inserts output from PROCESS into this buffer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
996
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
997
{
998
  CHECK_PROCESS (process);
999
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1003 1004