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
#include <c-ctype.h>
#include <sig2str.h>
95
#include <verify.h>
96

97 98
#endif	/* subprocesses */

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

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

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

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

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

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

#ifndef HAVE_ACCEPT4
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 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;
}

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

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

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

185
static bool kbd_is_on_hold;
186 187 188

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

191 192
#ifdef subprocesses

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

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

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

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

226
/* Only W32 has this, it really means that select can't take write mask.  */
227 228
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
229
#define SELECT_CANT_DO_WRITE_MASK
230 231 232 233 234 235 236 237 238 239 240 241
#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 */

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

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

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

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

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

static int process_output_delay_count;

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

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

#else
#define process_output_delay_count 0
#endif

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

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

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

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

static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

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

static SELECT_TYPE non_process_wait_mask;

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

314
static SELECT_TYPE write_mask;
315

316
#ifdef NON_BLOCKING_CONNECT
317 318 319 320 321 322 323 324
/* 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;
325
#endif	/* NON_BLOCKING_CONNECT */
326

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

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

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

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

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

345
static int proc_buffered_char[MAXDESC];
346

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

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

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

452 453


454
static struct fd_callback_data
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
{
  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)
{
470
  eassert (fd < MAXDESC);
471 472 473 474 475 476 477 478 479 480 481 482
  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)
{
483
  eassert (fd < MAXDESC);
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
  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)
{
500
  eassert (fd < MAXDESC);
501 502 503 504 505 506 507 508 509
  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;
}

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

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

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

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

546
static Lisp_Object status_convert (int);
547

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

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

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

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

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

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

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

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

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

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

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

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

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

682 683 684
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
685
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
686
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
687 688 689 690 691 692 693 694

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

722
  p = allocate_process ();
723 724
  /* 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
725 726
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
727

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

Ted Zlatanov's avatar
Ted Zlatanov committed
735 736 737 738
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

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

757
static void
758
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
759 760 761 762 763 764 765 766
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
767

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

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

Jim Blandy's avatar
Jim Blandy committed
786 787 788 789
/* 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
790

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

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

824 825 826

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

830 831 832 833 834
   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.  */
835 836
static Lisp_Object deleted_pid_list;

837
void
838
record_deleted_pid (pid_t pid, Lisp_Object filename)
839
{
840
  deleted_pid_list = Fcons (Fcons (make_fixnum_or_float (pid), filename),
841 842 843 844 845
			    /* GC treated elements set to nil.  */
			    Fdelq (Qnil, deleted_pid_list));

}

Jim Blandy's avatar
Jim Blandy committed
846
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
847 848 849
       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
850
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
851
{
852 853
  register struct Lisp_Process *p;

854
  process = get_process (process);
855 856
  p = XPROCESS (process);

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

      if (p->infd >= 0)
871
	{
872 873 874 875 876 877 878 879 880
	  /* 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)));

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

910 911
  if (STRINGP (process))
    process = Fget_process (process);
912
  else
913
    process = get_process (process);
914

915 916
  if (NILP (process))
    return process;
917

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

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

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

958
  CHECK_PROCESS (process);
959 960
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
961 962 963
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
964 965 966
       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
967
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
968
{
969
  CHECK_PROCESS (process);
970
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
971 972 973
}

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

985
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
986 987 988
       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
989
  (register Lisp_Object process)
990
{
991
  CHECK_PROCESS (process);
992
  return XPROCESS (process)->tty_name;
993 994
}

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

1003
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
1004
  if (!NILP (buffer))
1005
    CHECK_BUFFER (buffer);
1006
  p = XPROCESS (process);
Paul Eggert's avatar
Paul Eggert committed
1007
  pset_buffer (p, buffer);
1008
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Paul Eggert's avatar
Paul Eggert committed
1009
    pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
1010
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1011 1012 1013 1014
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
1015 1016 1017
       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
1018
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1019
{