process.c 223 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))
192 193
#define PIPECONN_P(p) (EQ (XPROCESS (p)->type, Qpipe))
#define PIPECONN1_P(p) (EQ (p->type, Qpipe))
Jim Blandy's avatar
Jim Blandy committed
194 195

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

200 201 202 203 204 205 206 207 208
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.
   The code can be simplified by assuming NON_BLOCKING_CONNECT once
   Emacs starts assuming POSIX 1003.1-2001 or later.  */

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

210 211 212 213 214
/* 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
215 216 217 218 219 220 221
#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
222

Stefan Monnier's avatar
Stefan Monnier committed
223 224 225 226
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
227 228 229 230 231
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#define ADAPTIVE_READ_BUFFERING
#endif

#ifdef ADAPTIVE_READ_BUFFERING
232
#define READ_OUTPUT_DELAY_INCREMENT (TIMESPEC_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
233 234 235
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

236 237
/* 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
238 239 240

static int process_output_delay_count;

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

243
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
244 245 246 247 248

#else
#define process_output_delay_count 0
#endif

249
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
250
#ifdef USABLE_SIGIO
251
static bool keyboard_bit_set (fd_set *);
252
#endif
253
static void deactivate_process (Lisp_Object);
254
static int status_notify (struct Lisp_Process *, struct Lisp_Process *);
255
static int read_process_output (Lisp_Object, int);
256
static void handle_child_signal (int);
257
static void create_pty (Lisp_Object);
258

259 260
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
261

262 263
/* Mask of bits indicating the descriptors that we wait for input on.  */

264
static fd_set input_wait_mask;
265

266
/* Mask that excludes keyboard input descriptor(s).  */
267

268
static fd_set non_keyboard_wait_mask;
269

270
/* Mask that excludes process input descriptor(s).  */
271

272
static fd_set non_process_wait_mask;
273

274
/* Mask for selecting for write.  */
275

276
static fd_set write_mask;
277

278
#ifdef NON_BLOCKING_CONNECT
279 280 281 282
/* 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.  */

283
static fd_set connect_wait_mask;
284 285 286

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

289
/* The largest descriptor currently in use for a process object; -1 if none.  */
290 291
static int max_process_desc;

292
/* The largest descriptor currently in use for input; -1 if none.  */
293
static int max_input_desc;
294

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

298
/* Alist of elements (NAME . PROCESS).  */
299
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
300 301 302 303 304 305 306

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

307
static int proc_buffered_char[FD_SETSIZE];
308

Karl Heuer's avatar
Karl Heuer committed
309
/* Table of `struct coding-system' for each process.  */
310 311
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
312

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

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

422

Dmitry Antipov's avatar
Dmitry Antipov committed
423 424 425 426 427
static Lisp_Object
make_lisp_proc (struct Lisp_Process *p)
{
  return make_lisp_ptr (p, Lisp_Vectorlike);
}
428

429
static struct fd_callback_data
430 431 432 433 434
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
435
  int condition; /* Mask of the defines above.  */
436
} fd_callback_info[FD_SETSIZE];
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 479 480 481


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

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

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

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

517
static Lisp_Object status_convert (int);
518

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	if (fd >= 0)
	  {
661 662 663 664 665 666 667 668 669
#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
670 671
	    /* 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
672 673 674
#ifdef PTY_TTY_NAME_SPRINTF
	    PTY_TTY_NAME_SPRINTF
#else
675
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
676
#endif /* no PTY_TTY_NAME_SPRINTF */
677
	    if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
Jim Blandy's avatar
Jim Blandy committed
678
	      {
679
		emacs_close (fd);
680
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
681
		continue;
682
# else
Jim Blandy's avatar
Jim Blandy committed
683
		return -1;
684
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
685 686 687 688 689
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
690
#endif /* HAVE_PTYS */
Jim Blandy's avatar
Jim Blandy committed
691 692
  return -1;
}
693 694 695 696 697 698 699 700 701

/* Allocate basically initialized process.  */

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

702
static Lisp_Object
703
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
704 705 706
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
707 708
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
709

710
  p = allocate_process ();
711 712
  /* 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
713 714
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
715

716 717 718 719
  /* 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;
720 721
  for (i = 0; i < PROCESS_OPEN_FDS; i++)
    p->open_fd[i] = -1;
Kenichi Handa's avatar
Kenichi Handa committed
722

Ted Zlatanov's avatar
Ted Zlatanov committed
723 724 725 726
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

Jim Blandy's avatar
Jim Blandy committed
727 728 729 730 731 732 733
  /* 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;
734
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
735 736
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
737
  pset_name (p, name);
738 739
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
740
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
741 742 743 744
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

745
static void
746
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
747 748 749 750 751 752 753 754
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
755

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

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

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

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

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

813 814 815

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

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

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

}

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

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

846
  p->raw_status_new = 0;
847
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
848
    {
849
      pset_status (p, list2 (Qexit, make_number (0)));
850
      p->tick = ++process_tick;
851
      status_notify (p, NULL);
852
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
853
    }
854
  else
Jim Blandy's avatar
Jim Blandy committed
855
    {
856
      if (p->alive)
857
	record_kill_process (p, Qnil);
858 859

      if (p->infd >= 0)
860
	{
861 862 863 864 865 866 867 868 869
	  /* 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)));

870
	  p->tick = ++process_tick;
871
	  status_notify (p, NULL);
872
	  redisplay_preserve_echo_area (13);
873
	}
Jim Blandy's avatar
Jim Blandy committed
874
    }
875
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
876 877 878 879
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
880 881 882 883 884 885 886
       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.
887
listen -- for a network stream server that is listening.
888
closed -- for a network stream connection that is closed.
889 890
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
891 892 893
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
894
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
895 896 897
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
898

899 900
  if (STRINGP (process))
    process = Fget_process (process);
901
  else
902
    process = get_process (process);
903

904 905
  if (NILP (process))
    return process;
906

907
  p = XPROCESS (process);
908
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
909
    update_status (p);
910
  status = p->status;
911
  if (CONSP (status))
912
    status = XCAR (status);
913
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
914
    {
915
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
916
	status = Qclosed;
917
      else if (EQ (p->command, Qt))
918 919 920
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
921 922 923 924 925 926
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
927 928
       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
929
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
930
{
931
  CHECK_PROCESS (process);
932
  if (XPROCESS (process)->raw_status_new)
933
    update_status (XPROCESS (process));
934 935
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
936 937 938 939
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
940
       doc: /* Return the process id of PROCESS.
941
This is the pid of the external process which PROCESS uses or talks to.
942
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
943
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
944
{
945
  pid_t pid;
946

947
  CHECK_PROCESS (process);
948 949
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
950 951 952
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
953 954 955
       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
956
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
957
{
958
  CHECK_PROCESS (process);
959
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
960 961 962
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
963 964 965
       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.
966 967
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
968
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
969
{
970
  CHECK_PROCESS (process);
971
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
972 973
}

974
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
975 976 977
       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
978
  (register Lisp_Object process)
979
{
980
  CHECK_PROCESS (process);
981
  return XPROCESS (process)->tty_name;
982 983
}

Jim Blandy's avatar
Jim Blandy committed
984
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
985
       2, 2, 0,
986 987
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
988
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
989
{
990 991
  struct Lisp_Process *p;

992
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
993
  if (!NILP (buffer))
994
    CHECK_BUFFER (buffer);
995
  p = XPROCESS (process);
Paul Eggert's avatar
Paul Eggert committed
996
  pset_buffer (p, buffer);
997
  if (NETCONN1_P (p) || SERIALCONN1_P (p) || PIPECONN1_P (p))
Paul Eggert's avatar
Paul Eggert committed
998
    pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
999
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002 1003
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
1004 1005
       1, 1, 0,
       doc: /* Return the buffer PROCESS is associated with.
1006
The default process filter inserts output from PROCESS into this buffer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1007
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1008
{
1009
  CHECK_PROCESS (process);