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
#if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
128
#include "xgselect.h"
129
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
130

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

136 137 138
/* 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.  */
139
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
140 141 142
# pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

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

151
static bool kbd_is_on_hold;
152 153 154

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

157 158
#ifdef subprocesses

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

180 181 182 183
#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
184 185

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

190 191
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

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

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

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

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

#ifdef ADAPTIVE_READ_BUFFERING
230
#define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
231 232 233
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

234 235
/* 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
236 237 238

static int process_output_delay_count;

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

241
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
242 243 244 245 246

#else
#define process_output_delay_count 0
#endif

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

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

263 264
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
265

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

static SELECT_TYPE input_wait_mask;

270
/* Mask that excludes keyboard input descriptor(s).  */
271 272 273

static SELECT_TYPE non_keyboard_wait_mask;

274
/* Mask that excludes process input descriptor(s).  */
275 276 277

static SELECT_TYPE non_process_wait_mask;

278
/* Mask for selecting for write.  */
279

280
static SELECT_TYPE write_mask;
281

282
#ifdef NON_BLOCKING_CONNECT
283 284 285 286 287 288 289 290
/* 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;
291
#endif	/* NON_BLOCKING_CONNECT */
292

293 294 295
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

296 297
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
298

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

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

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

311
static int proc_buffered_char[MAXDESC];
312

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

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

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

412 413


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

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

493 494 495
    }
}

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

500
static Lisp_Object status_convert (int);
501

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

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

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

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

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

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

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

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

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

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

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

615 616 617 618 619
/* 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.  */

620
static int
621
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
622 623 624 625 626 627
{
  int fd;

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

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

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

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

685 686 687 688
  /* 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
689

Ted Zlatanov's avatar
Ted Zlatanov committed
690 691 692 693
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

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

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

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

  deactivate_process (proc);
}
722

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

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

Jim Blandy's avatar
Jim Blandy committed
741 742 743 744
/* 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
745

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

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

779 780 781

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

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

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

805
  process = get_process (process);
806 807
  p = XPROCESS (process);

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

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

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

861 862
  if (STRINGP (process))
    process = Fget_process (process);
863
  else
864
    process = get_process (process);
865

866 867
  if (NILP (process))
    return process;
868

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

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

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

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

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

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

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

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

954
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
955
  if (!NILP (buffer))
956
    CHECK_BUFFER (buffer);
957
  p = XPROCESS (process);
Paul Eggert's avatar
Paul Eggert committed