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

3
Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2012
4
  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
#endif	/* subprocesses */

Jim Blandy's avatar
Jim Blandy committed
96
#include "systime.h"
97
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
98 99

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

120 121 122 123
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

124
#if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
125
#include "xgselect.h"
126
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
127

128 129 130 131 132
#ifdef WINDOWSNT
extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
		       EMACS_TIME *, void *);
#endif

133 134 135 136 137 138 139 140
#ifndef WNOHANG
# undef waitpid
# define waitpid(pid, status, options) wait (status)
#endif
#ifndef WUNTRACED
# define WUNTRACED 0
#endif

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

148 149 150 151 152 153 154 155 156 157 158 159 160 161
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;

/* Non-zero if keyboard input is on hold, zero otherwise.  */

static int kbd_is_on_hold;

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

162 163
#ifdef subprocesses

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

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

197 198
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

199
/* Only W32 has this, it really means that select can't take write mask.  */
200 201
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
202
#define SELECT_CANT_DO_WRITE_MASK
203 204 205 206 207 208 209 210 211 212 213 214 215 216
#else
#ifndef NON_BLOCKING_CONNECT
#ifdef HAVE_SELECT
#if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
#if defined (O_NONBLOCK) || defined (O_NDELAY)
#if defined (EWOULDBLOCK) || defined (EINPROGRESS)
#define NON_BLOCKING_CONNECT
#endif /* EWOULDBLOCK || EINPROGRESS */
#endif /* O_NONBLOCK || O_NDELAY */
#endif /* HAVE_GETPEERNAME || GNU_LINUX */
#endif /* HAVE_SELECT */
#endif /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

217 218 219 220 221
/* 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
222 223 224 225 226 227 228
#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
229

Stefan Monnier's avatar
Stefan Monnier committed
230 231 232 233
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
234 235 236 237 238
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#define ADAPTIVE_READ_BUFFERING
#endif

#ifdef ADAPTIVE_READ_BUFFERING
239
#define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
240 241 242
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

243 244
/* 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
245 246 247

static int process_output_delay_count;

248
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
249 250 251 252 253 254 255

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

256
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
257
#ifdef USABLE_SIGIO
258
static int keyboard_bit_set (SELECT_TYPE *);
259
#endif
260 261 262
static void deactivate_process (Lisp_Object);
static void status_notify (struct Lisp_Process *);
static int read_process_output (Lisp_Object, int);
263
static void handle_child_signal (int);
264
static void create_pty (Lisp_Object);
265

266
/* If we support a window system, turn on the code to poll periodically
267
   to detect C-g.  It isn't actually used when doing interrupt input.  */
268
#ifdef HAVE_WINDOW_SYSTEM
269 270 271
#define POLL_FOR_INPUT
#endif

272 273
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
274

275 276 277 278
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

279
/* Mask that excludes keyboard input descriptor(s).  */
280 281 282

static SELECT_TYPE non_keyboard_wait_mask;

283
/* Mask that excludes process input descriptor(s).  */
284 285 286

static SELECT_TYPE non_process_wait_mask;

287
/* Mask for selecting for write.  */
288

289
static SELECT_TYPE write_mask;
290

291
#ifdef NON_BLOCKING_CONNECT
292 293 294 295 296 297 298 299
/* 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;
300
#endif	/* NON_BLOCKING_CONNECT */
301

302 303 304
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

305 306
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
307

Jim Blandy's avatar
Jim Blandy committed
308
/* Indexed by descriptor, gives the process (if any) for that descriptor */
309
static Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
310 311

/* Alist of elements (NAME . PROCESS) */
312
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
313 314 315 316 317 318 319

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

320
static int proc_buffered_char[MAXDESC];
321

Karl Heuer's avatar
Karl Heuer committed
322
/* Table of `struct coding-system' for each process.  */
323 324
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
325

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

Richard M. Stallman's avatar
Richard M. Stallman committed
339 340
/* Maximum number of bytes to send to a pty without an eof.  */
static int pty_max_bytes;
341

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

424 425


426
static struct fd_callback_data
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
{
  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)
{
442
  eassert (fd < MAXDESC);
443 444 445 446 447 448 449 450 451 452 453 454
  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)
{
455
  eassert (fd < MAXDESC);
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
  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)
{
472
  eassert (fd < MAXDESC);
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
  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;

489
  eassert (fd < MAXDESC);
490 491 492 493 494 495 496 497 498 499 500 501 502 503
  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;
            }
504

505 506 507
    }
}

Jim Blandy's avatar
Jim Blandy committed
508 509 510 511

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

512
static Lisp_Object status_convert (int);
513

514
static void
515
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
516
{
517
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
518
  pset_status (p, status_convert (p->raw_status));
519
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
520 521
}

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

525
static Lisp_Object
526
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
527 528 529 530
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
531
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538 539 540 541 542
				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.  */

543
static void
544
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
545 546 547
{
  Lisp_Object tem;

548
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
549 550 551 552 553 554 555
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
556 557 558 559
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563 564 565
      *coredump = !NILP (tem);
    }
}

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

566
static Lisp_Object
567
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
568
{
569
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
570 571 572 573 574 575 576 577
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
578
      char const *signame;
579
      synchronize_system_messages_locale ();
580
      signame = strsignal (code);
581
      if (signame == 0)
582 583 584 585 586
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

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

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

626 627 628 629 630
/* 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.  */

631
static int
632
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
633 634 635 636 637 638
{
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
639
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
640 641 642 643 644 645 646 647 648 649
  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 */

650 651 652
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
653 654 655 656 657 658 659
	{
#  ifdef O_NONBLOCK
	  fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
#  else
	  fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
#  endif
	}
660
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
661 662 663 664 665 666 667 668

	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
669
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
670 671 672
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
673
		emacs_close (fd);
674
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
675
		continue;
676
# else
Jim Blandy's avatar
Jim Blandy committed
677
		return -1;
678
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
679 680 681 682 683 684 685 686 687
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

688
static Lisp_Object
689
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
690 691 692
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
693 694
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
695

696
  p = allocate_process ();
697 698
  /* 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
699 700
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
701

702 703 704 705
  /* 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
706

Ted Zlatanov's avatar
Ted Zlatanov committed
707 708 709 710
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

Jim Blandy's avatar
Jim Blandy committed
711 712 713 714 715 716 717
  /* 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;
718
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
719 720
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
721
  pset_name (p, name);
722
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
723 724 725 726
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

727
static void
728
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
729 730 731 732 733 734 735 736
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
737

Jim Blandy's avatar
Jim Blandy committed
738 739

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
740
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
741
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
742
{
743
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
744 745 746
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
747
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
748
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
749
{
750
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
751
    return name;
752
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
753 754 755
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
756 757 758 759
/* 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
760

761
static Lisp_Object
762
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
763
{
764 765 766 767 768 769 770
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
771
	error ("Process %s does not exist", SDATA (name));
772 773 774
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
775
  else
776 777 778 779 780
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
781
    {
782
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
783
      if (NILP (proc))
Tom Tromey's avatar
Tom Tromey committed
784
	error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
785 786
    }
  else
787
    {
788
      CHECK_PROCESS (obj);
789 790 791
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
792 793
}

794 795 796 797

#ifdef SIGCHLD
/* Fdelete_process promises to immediately forget about the process, but in
   reality, Emacs needs to remember those processes until they have been
798
   treated by the SIGCHLD handler; otherwise this handler would consider the
799 800 801 802 803
   process as being synchronous and say that the synchronous process is
   dead.  */
static Lisp_Object deleted_pid_list;
#endif

Jim Blandy's avatar
Jim Blandy committed
804
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
805 806 807
       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
808
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
809
{
810 811
  register struct Lisp_Process *p;

812
  process = get_process (process);
813 814
  p = XPROCESS (process);

815
  p->raw_status_new = 0;
816
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
817
    {
Paul Eggert's avatar
Paul Eggert committed
818
      pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
819
      p->tick = ++process_tick;
820
      status_notify (p);
821
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
822
    }
823
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
824
    {
825 826
#ifdef SIGCHLD
      Lisp_Object symbol;
827
      pid_t pid = p->pid;
828 829

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
830
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
831 832 833 834 835
				/* GC treated elements set to nil.  */
				Fdelq (Qnil, deleted_pid_list));
      /* If the process has already signaled, remove it from the list.  */
      if (p->raw_status_new)
	update_status (p);
836 837 838
      symbol = p->status;
      if (CONSP (p->status))
	symbol = XCAR (p->status);
839
      if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
840 841
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
842 843 844 845
      else
#endif
	{
	  Fkill_process (process, Qnil);
846 847
	  /* Do this now, since remove_process will make the
	     SIGCHLD handler do nothing.  */
Paul Eggert's avatar
Paul Eggert committed
848
	  pset_status (p, Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil)));
849
	  p->tick = ++process_tick;
850
	  status_notify (p);
851
	  redisplay_preserve_echo_area (13);
852
	}
Jim Blandy's avatar
Jim Blandy committed
853
    }
854
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
855 856 857 858
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
859 860 861 862 863 864 865
       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.
866
listen -- for a network stream server that is listening.
867
closed -- for a network stream connection that is closed.
868 869
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
870 871 872
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
873
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
874 875 876
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
877

878 879
  if (STRINGP (process))
    process = Fget_process (process);
880
  else
881
    process = get_process (process);
882

883 884
  if (NILP (process))
    return process;
885

886
  p = XPROCESS (process);
887
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
888
    update_status (p);
889
  status = p->status;
890
  if (CONSP (status))
891
    status = XCAR (status);
892
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
893
    {
894
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
895
	status = Qclosed;
896
      else if (EQ (p->command, Qt))
897 898 899
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
900 901 902 903 904 905
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
906 907
       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
908
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
909
{
910
  CHECK_PROCESS (process);
911
  if (XPROCESS (process)->raw_status_new)
912
    update_status (XPROCESS (process));
913 914
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
915 916 917 918
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
919
       doc: /* Return the process id of PROCESS.
920
This is the pid of the external process which PROCESS uses or talks to.
921
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
922
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
923
{
924
  pid_t pid;
925

926
  CHECK_PROCESS (process);
927 928
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
929 930 931
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
932 933 934
       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
935
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
936
{
937
  CHECK_PROCESS (process);
938
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
939 940 941
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
942 943 944
       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.
945 946
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
947
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
948
{
949
  CHECK_PROCESS (process);
950
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
951 952
}

953
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
954 955 956
       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
957
  (register Lisp_Object process)
958
{
959
  CHECK_PROCESS (process);
960
  return XPROCESS (process)->tty_name;
961 962
}

Jim Blandy's avatar
Jim Blandy committed
963
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
964
       2, 2, 0,
965 966
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
967
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
968
{
969 970
  struct Lisp_Process *p;

971
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
972
  if (!NILP (buffer))
973
    CHECK_BUFFER (buffer);
974
  p = XPROCESS (process);
Paul Eggert's avatar
Paul Eggert committed
975
  pset_buffer (p, buffer);
976
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Paul Eggert's avatar
Paul Eggert committed
977
    pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
978
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
979 980 981 982
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
983 984 985
       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
986
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
987
{
988
  CHECK_PROCESS (process);
989
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
990 991 992
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
993 994
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
995
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
996
{
997
  CHECK_PROCESS (process);
998
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
999 1000 1001
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1002 1003
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
1004
A value of t means stop accepting output from the process.
1005 1006 1007

When a process has a filter, its buffer is not used for output.
Instead, each time it does output, the entire string of output is
1008
passed to the filter.
1009

1010
The filter gets two arguments: the process and the string of output.
1011 1012 1013 1014 1015 1016
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
1017
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
1018
{
1019
  struct Lisp_Process *p;
1020

1021
  CHECK_PROCESS (process);
1022 1023 1024 1025 1026 1027 1028 1029 1030
  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 ...)  */
1031

1032
  if (p->infd >= 0)
1033
    {
1034
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1035
	{
1036 1037
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1038
	}
1039
      else if (EQ (p->filter, Qt)