process.c 211 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 85
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

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

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

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

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 141
/* 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.  */
142
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
143 144 145
# pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

146 147 148 149 150 151
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;

152
/* True if keyboard input is on hold, zero otherwise.  */
153

154
static bool kbd_is_on_hold;
155 156 157

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

160 161
#ifdef subprocesses

162
Lisp_Object Qprocessp;
163 164 165 166 167
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
168
#ifdef AF_INET6
169
static Lisp_Object Qipv6;
Kim F. Storm's avatar
Kim F. Storm committed
170
#endif
171 172
static Lisp_Object QCport, QCprocess;
Lisp_Object QCspeed;
173 174
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
175 176 177 178 179
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;
180 181
static Lisp_Object Qinternal_default_process_sentinel;
static Lisp_Object Qinternal_default_process_filter;
182

183 184 185 186
#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
187 188

/* Number of events of change of status of a process.  */
189
static EMACS_INT process_tick;
Jim Blandy's avatar
Jim Blandy committed
190
/* Number of events for which the user or sentinel has been notified.  */
191
static EMACS_INT update_tick;
Jim Blandy's avatar
Jim Blandy committed
192

193 194
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

195
/* Only W32 has this, it really means that select can't take write mask.  */
196 197
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
198
#define SELECT_CANT_DO_WRITE_MASK
199 200 201 202 203 204 205 206 207 208 209 210
#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 */

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

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

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

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

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

static int process_output_delay_count;

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

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

#else
#define process_output_delay_count 0
#endif

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

260
/* If we support a window system, turn on the code to poll periodically
261
   to detect C-g.  It isn't actually used when doing interrupt input.  */
262
#ifdef HAVE_WINDOW_SYSTEM
263 264 265
#define POLL_FOR_INPUT
#endif

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

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

static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

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

static SELECT_TYPE non_process_wait_mask;

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

283
static SELECT_TYPE write_mask;
284

285
#ifdef NON_BLOCKING_CONNECT
286 287 288 289 290 291 292 293
/* 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;
294
#endif	/* NON_BLOCKING_CONNECT */
295

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

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

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

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

/* Buffered-ahead input char from process, indexed by channel.
   -1 means empty (no char is buffered).
   Used on sys V where the only way to tell if there is any
   output from the process is to read at least one char.
   Always -1 on systems that support FIONREAD.  */

314
static int proc_buffered_char[MAXDESC];
315

Karl Heuer's avatar
Karl Heuer committed
316
/* Table of `struct coding-system' for each process.  */
317 318
static struct coding_system *proc_decode_coding_system[MAXDESC];
static struct coding_system *proc_encode_coding_system[MAXDESC];
Karl Heuer's avatar
Karl Heuer committed
319

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

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

415 416


417
static struct fd_callback_data
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
{
  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)
{
433
  eassert (fd < MAXDESC);
434 435 436 437 438 439 440 441 442 443 444 445
  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)
{
446
  eassert (fd < MAXDESC);
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
  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)
{
463
  eassert (fd < MAXDESC);
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
  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;
}

/* Stop monitoring file descriptor FD for when write is possible.  */

void
delete_write_fd (int fd)
{
  int lim = max_input_desc;

480
  eassert (fd < MAXDESC);
481 482 483 484 485 486 487 488 489 490 491 492 493 494
  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;

      if (fd == max_input_desc)
        for (fd = lim; fd >= 0; fd--)
          if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
            {
              max_input_desc = fd;
              break;
            }
495

496 497 498
    }
}

Jim Blandy's avatar
Jim Blandy committed
499 500 501 502

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

503
static Lisp_Object status_convert (int);
504

505
static void
506
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
507
{
508
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
509
  pset_status (p, status_convert (p->raw_status));
510
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
511 512
}

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

516
static Lisp_Object
517
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
518 519 520 521
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
522
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
523 524 525 526 527 528 529 530 531 532 533
				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.  */

534
static void
535
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
Jim Blandy's avatar
Jim Blandy committed
536 537 538
{
  Lisp_Object tem;

539
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
540 541 542 543 544 545 546
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
547 548 549 550
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
551 552 553 554 555 556
      *coredump = !NILP (tem);
    }
}

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

557
static Lisp_Object
558
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
559
{
560
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
561
  Lisp_Object symbol;
562 563
  int code;
  bool coredump;
Jim Blandy's avatar
Jim Blandy committed
564 565 566 567 568 569
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
570
      char const *signame;
571
      synchronize_system_messages_locale ();
572
      signame = strsignal (code);
573
      if (signame == 0)
574 575 576 577 578
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

579
	  string = build_unibyte_string (signame);
580 581 582
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
583
	  c1 = STRING_CHAR (SDATA (string));
584
	  c2 = downcase (c1);
585
	  if (c1 != c2)
586
	    Faset (string, make_number (0), make_number (c2));
587
	}
Jim Blandy's avatar
Jim Blandy committed
588 589 590 591 592
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
593 594
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
595 596
      if (code == 0)
	return build_string ("finished\n");
597
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
598
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
599 600
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
601
    }
602 603 604 605
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
606 607
      return concat3 (build_string ("failed with code "),
		      string, string2);
608
    }
Jim Blandy's avatar
Jim Blandy committed
609 610 611 612 613 614
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

Dan Nicolaescu's avatar
Dan Nicolaescu committed
615 616 617
/* The file name of the pty opened by allocate_pty.  */
static char pty_name[24];

618 619 620 621 622
/* Open an available pty, returning a file descriptor.
   Return -1 on failure.
   The file name of the terminal corresponding to the pty
   is left in the variable pty_name.  */

623
static int
624
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
625 626 627 628 629 630
{
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
631
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
632 633 634 635 636 637 638 639 640 641
  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 */

642 643 644
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
645
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
646
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
647 648 649 650 651 652 653 654

	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
655
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
656
#endif /* no PTY_TTY_NAME_SPRINTF */
657
	    if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
Jim Blandy's avatar
Jim Blandy committed
658
	      {
659
		emacs_close (fd);
660
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
661
		continue;
662
# else
Jim Blandy's avatar
Jim Blandy committed
663
		return -1;
664
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
665 666 667 668 669 670 671 672 673
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

674
static Lisp_Object
675
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
676 677 678
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
679 680
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
681

682
  p = allocate_process ();
683 684
  /* 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
685 686
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
687

688 689 690 691
  /* 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
692

Ted Zlatanov's avatar
Ted Zlatanov committed
693 694 695 696
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

Jim Blandy's avatar
Jim Blandy committed
697 698 699 700 701 702 703
  /* 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;
704
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
705 706
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
707
  pset_name (p, name);
708 709
  pset_sentinel (p, Qinternal_default_process_sentinel);
  pset_filter (p, Qinternal_default_process_filter);
710
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
711 712 713 714
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

715
static void
716
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721 722 723 724
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
725

Jim Blandy's avatar
Jim Blandy committed
726 727

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
728
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
729
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
730
{
731
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
732 733 734
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
735
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
736
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
737
{
738
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
739
    return name;
740
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
741 742 743
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
744 745 746 747
/* 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
748

749
static Lisp_Object
750
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
751
{
752 753 754 755 756 757 758
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
759
	error ("Process %s does not exist", SDATA (name));
760 761 762
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
763
  else
764 765 766 767 768
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
769
    {
770
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
771
      if (NILP (proc))
Tom Tromey's avatar
Tom Tromey committed
772
	error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
773 774
    }
  else
775
    {
776
      CHECK_PROCESS (obj);
777 778 779
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
780 781
}

782 783 784

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

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

791 792 793 794 795 796 797 798 799
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
800
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
801 802 803
       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
804
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
805
{
806 807
  register struct Lisp_Process *p;

808
  process = get_process (process);
809 810
  p = XPROCESS (process);

811
  p->raw_status_new = 0;
812
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
813
    {
Paul Eggert's avatar
Paul Eggert committed
814
      pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
815
      p->tick = ++process_tick;
816
      status_notify (p);
817
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
818
    }
819
  else
Jim Blandy's avatar
Jim Blandy committed
820
    {
821 822 823 824
      if (p->alive)
	record_kill_process (p);

      if (p->infd >= 0)
825
	{
826 827 828 829 830 831 832 833 834
	  /* 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)));

835
	  p->tick = ++process_tick;
836
	  status_notify (p);
837
	  redisplay_preserve_echo_area (13);
838
	}
Jim Blandy's avatar
Jim Blandy committed
839
    }
840
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
841 842 843 844
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
845 846 847 848 849 850 851
       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.
852
listen -- for a network stream server that is listening.
853
closed -- for a network stream connection that is closed.
854 855
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
856 857 858
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
859
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
860 861 862
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
863

864 865
  if (STRINGP (process))
    process = Fget_process (process);
866
  else
867
    process = get_process (process);
868

869 870
  if (NILP (process))
    return process;
871

872
  p = XPROCESS (process);
873
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
874
    update_status (p);
875
  status = p->status;
876
  if (CONSP (status))
877
    status = XCAR (status);
878
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
879
    {
880
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
881
	status = Qclosed;
882
      else if (EQ (p->command, Qt))
883 884 885
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
886 887 888 889 890 891
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
892 893
       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
894
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
895
{
896
  CHECK_PROCESS (process);
897
  if (XPROCESS (process)->raw_status_new)
898
    update_status (XPROCESS (process));
899 900
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
901 902 903 904
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
905
       doc: /* Return the process id of PROCESS.
906
This is the pid of the external process which PROCESS uses or talks to.
907
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
908
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
909
{
910
  pid_t pid;
911

912
  CHECK_PROCESS (process);
913 914
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
915 916 917
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
918 919 920
       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
921
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
922
{
923
  CHECK_PROCESS (process);
924
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
925 926 927
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
928 929 930
       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.
931 932
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
933
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
934
{
935
  CHECK_PROCESS (process);
936
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
937 938
}

939
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
940 941 942
       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
943
  (register Lisp_Object process)
944
{
945
  CHECK_PROCESS (process);
946
  return XPROCESS (process)->tty_name;
947 948
}

Jim Blandy's avatar
Jim Blandy committed
949
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
950
       2, 2, 0,
951 952
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
953
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
954
{
955 956
  struct Lisp_Process *p;

Pavel Janík's avatar