process.c 212 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2

3 4
Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2013 Free Software
Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Paul Eggert's avatar
Paul Eggert committed
23 24 25

#define PROCESS_INLINE EXTERN_INLINE

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

34 35
#include "lisp.h"

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

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

/* Are local (unix) sockets supported?  */
45
#if defined (HAVE_SYS_UN_H)
46 47 48 49 50 51 52 53
#if !defined (AF_LOCAL) && defined (AF_UNIX)
#define AF_LOCAL AF_UNIX
#endif
#ifdef AF_LOCAL
#define HAVE_LOCAL_SOCKETS
#include <sys/un.h>
#endif
#endif
Jim Blandy's avatar
Jim Blandy committed
54 55

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

Juanma Barranquero's avatar
Juanma Barranquero committed
60
#if defined (HAVE_IFADDRS_H)
61 62 63 64
/* Must be after net/if.h */
#include <ifaddrs.h>

/* We only use structs from this header when we use getifaddrs.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
65
#if defined (HAVE_NET_IF_DL_H)
66 67 68 69 70
#include <net/if_dl.h>
#endif

#endif

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

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

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

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

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

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

96 97
#endif	/* subprocesses */

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

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

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

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

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

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

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

153
static bool kbd_is_on_hold;
154 155 156

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

159 160
#ifdef subprocesses

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

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

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

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

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

210 211 212 213 214
/* Define DATAGRAM_SOCKETS if datagrams can be used safely on
   this system.  We need to read full packets, so we need a
   "non-destructive" select.  So we require either native select,
   or emulation of select using FIONREAD.  */

Paul Eggert's avatar
Paul Eggert committed
215 216 217 218 219 220 221
#ifndef BROKEN_DATAGRAM_SOCKETS
# if defined HAVE_SELECT || defined USABLE_FIONREAD
#  if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
#   define DATAGRAM_SOCKETS
#  endif
# endif
#endif
222

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

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

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

236 237
/* Number of processes which have a non-zero read_output_delay,
   and therefore might be delayed for adaptive read buffering.  */
Kenichi Handa's avatar
Kenichi Handa committed
238 239 240

static int process_output_delay_count;

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

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

#else
#define process_output_delay_count 0
#endif

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

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

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

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

static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

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

static SELECT_TYPE non_process_wait_mask;

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

282
static SELECT_TYPE write_mask;
283

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

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

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

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

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

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

313
static int proc_buffered_char[MAXDESC];
314

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

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

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

414 415


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

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

495 496 497
    }
}

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

502
static Lisp_Object status_convert (int);
503

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

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

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

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

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

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

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

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

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

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

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

617 618 619 620 621
/* 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.  */

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

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

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

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

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

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

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

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

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

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

  deactivate_process (proc);
}
724

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

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

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

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

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

781 782 783

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

956
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
957
  if (!NILP (buffer))
958
    CHECK_BUFFER (buffer);
959
  p = XPROCESS (process);
Paul Eggert's avatar
Paul Eggert committed
960
  pset_buffer (p, buffer);
961
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Paul Eggert's avatar
Paul Eggert committed
962
    pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
963
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
964 965 966 967
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
968 969 970
       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
971
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
972
{
973
  CHECK_PROCESS (process);
974
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
975 976 977
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
978 979
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
980
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
981
{
982
  CHECK_PROCESS (process);
983
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
984 985 986
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
987
       2, 2, 0,
988
       doc: /* Give PROCESS the filter function FILTER; nil means default.
989
A value of t means stop accepting output from the process.
990

991
When a process has a non-default filter, its buffer is not used for output.
992
Instead, each time it does output, the entire string of output is
993
passed to the filter.
994

995
The filter gets two arguments: the process and the string of output.
996 997 998 999 1000 1001
The string argument is normally a multibyte string, except:
- if the process' input coding system is no-conversion or raw-text,
  it is a unibyte string (the non-converted input), or else
- if `default-enable-multibyte-characters' is nil, it is a unibyte
  string (the result of converting the decoded input multibyte
  string to unibyte with `string-make-unibyte').  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1002
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
1003
{
1004
  struct Lisp_Process *p;
1005

1006
  CHECK_PROCESS (process);
1007 1008 1009 1010 1011 1012 1013 1014 1015
  p = XPROCESS (process);

  /* Don't signal an error if the process' input file descriptor
     is closed.  This could make debugging Lisp more difficult,
     for example when doing something like

     (setq process (start-process ...))
     (debug)
     (set-process-filter process ...)  */
1016

Stefan Monnier's avatar