process.c 210 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-2013 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 24 25

#define PROCESS_INLINE EXTERN_INLINE

Jim Blandy's avatar
Jim Blandy committed
26 27
#include <stdio.h>
#include <errno.h>
28
#include <sys/types.h>		/* Some typedefs are used in sys/file.h.  */
Jim Blandy's avatar
Jim Blandy committed
29 30
#include <sys/file.h>
#include <sys/stat.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
31
#include <unistd.h>
32 33
#include <fcntl.h>

34 35
#include "lisp.h"

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

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

/* Are local (unix) sockets supported?  */
45
#if defined (HAVE_SYS_UN_H)
46 47 48 49 50 51 52 53
#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
54 55

#include <sys/ioctl.h>
Juanma Barranquero's avatar
Juanma Barranquero committed
56
#if defined (HAVE_NET_IF_H)
57 58
#include <net/if.h>
#endif /* HAVE_NET_IF_H */
Jim Blandy's avatar
Jim Blandy committed
59

Juanma Barranquero's avatar
Juanma Barranquero committed
60
#if defined (HAVE_IFADDRS_H)
61 62 63 64
/* 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
65
#if defined (HAVE_NET_IF_DL_H)
66 67 68 69 70
#include <net/if_dl.h>
#endif

#endif

Jim Blandy's avatar
Jim Blandy committed
71 72 73 74
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

Paul Eggert's avatar
Paul Eggert committed
75 76 77 78 79
#ifdef USG5_4
# include <sys/stream.h>
# include <sys/stropts.h>
#endif

80 81 82 83 84
#ifdef HAVE_RES_INIT
#include <arpa/nameser.h>
#include <resolv.h>
#endif

85 86 87 88
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

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

93 94 95
#include <c-ctype.h>
#include <sig2str.h>

96 97
#endif	/* subprocesses */

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

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

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

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

133 134 135 136 137
#ifdef WINDOWSNT
extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
		       EMACS_TIME *, void *);
#endif

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

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

/* Emulate GNU/Linux accept4 and socket well enough for this module.  */

static int
close_on_exec (int fd)
{
  if (0 <= fd)
    fcntl (fd, F_SETFD, FD_CLOEXEC);
  return fd;
}

static int
accept4 (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags)
{
  return close_on_exec (accept (sockfd, addr, addrlen));
}

static int
process_socket (int domain, int type, int protocol)
{
  return close_on_exec (socket (domain, type, protocol));
}
# undef socket
# define socket(domain, type, protocol) process_socket (domain, type, protocol)
#endif

169 170 171
/* 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.  */
172
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
173 174 175
# pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

176 177 178 179 180 181
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;

182
/* True if keyboard input is on hold, zero otherwise.  */
183

184
static bool kbd_is_on_hold;
185 186 187

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

190 191
#ifdef subprocesses

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

213 214 215 216
#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
217 218

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

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

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

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

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

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

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

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

static int process_output_delay_count;

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

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

#else
#define process_output_delay_count 0
#endif

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

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

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

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

static SELECT_TYPE input_wait_mask;

303
/* Mask that excludes keyboard input descriptor(s).  */
304 305 306

static SELECT_TYPE non_keyboard_wait_mask;

307
/* Mask that excludes process input descriptor(s).  */
308 309 310

static SELECT_TYPE non_process_wait_mask;

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

313
static SELECT_TYPE write_mask;
314

315
#ifdef NON_BLOCKING_CONNECT
316 317 318 319 320 321 322 323
/* 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.  */

static SELECT_TYPE connect_wait_mask;

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

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

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

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

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

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

344
static int proc_buffered_char[MAXDESC];
345

Karl Heuer's avatar
Karl Heuer committed
346
/* Table of `struct coding-system' for each process.  */
347 348
static struct coding_system *proc_decode_coding_system[MAXDESC];
static struct coding_system *proc_encode_coding_system[MAXDESC];
Karl Heuer's avatar
Karl Heuer committed
349

350 351
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
352
static struct sockaddr_and_len {
353 354 355 356
  struct sockaddr *sa;
  int len;
} datagram_address[MAXDESC];
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
357
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && 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

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

445 446


447
static struct fd_callback_data
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
  int condition; /* mask of the defines above.  */
} fd_callback_info[MAXDESC];


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

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

519 520 521 522 523
/* Stop monitoring file descriptor FD for when write is possible.  */

void
delete_write_fd (int fd)
{
524
  eassert (fd < MAXDESC);
525 526 527 528 529 530
  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;
531
      delete_input_desc (fd);
532 533 534
    }
}

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

539
static Lisp_Object status_convert (int);
540

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

715
  p = allocate_process ();
716 717
  /* 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
718 719
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
720

721 722 723 724
  /* 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;
Kenichi Handa's avatar
Kenichi Handa committed
725

Ted Zlatanov's avatar
Ted Zlatanov committed
726 727 728 729
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

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

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

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

  deactivate_process (proc);
}
758

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

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

Jim Blandy's avatar
Jim Blandy committed
777 778 779 780
/* 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
781

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

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
802
    {
803
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
804
      if (NILP (proc))
Tom Tromey's avatar
Tom Tromey committed
805
	error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
806 807
    }
  else
808
    {
809
      CHECK_PROCESS (obj);
810 811 812
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
813 814
}

815 816 817

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

   Some processes created by call-process are also put onto this list.  */
822 823
static Lisp_Object deleted_pid_list;

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

}

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

841
  process = get_process (process);
842 843
  p = XPROCESS (process);

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

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

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

897 898
  if (STRINGP (process))
    process = Fget_process (process);
899
  else
900
    process = get_process (process);
901

902 903
  if (NILP (process))
    return process;
904

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

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

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

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

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

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

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

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

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

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
1002 1003 1004
       1, 1, 0,
       doc: /* Return the buffer PROCESS is associated with.
Output from PROCESS is inserted in this buffer unless PROCESS has a filter.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1005
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1006
{
1007
  CHECK_PROCESS (process);
1008
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
1009 1010 1011
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1012 1013
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1014
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1015
{
1016
  CHECK_PROCESS (process);
1017
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
1018 1019 1020
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1021
       2, 2, 0,
1022
       doc: /* Give PROCESS the filter function FILTER; nil means default.
1023
A value of t means stop accepting output from the process.
Kim F. Storm's avatar