process.c 213 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
/* 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

140 141 142 143 144 145 146 147 148 149 150 151 152 153
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;

154 155
#ifdef subprocesses

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

175 176 177 178
#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
179

180 181 182 183
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

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

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

191
/* Only W32 has this, it really means that select can't take write mask.  */
192 193
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
194
#define SELECT_CANT_DO_WRITE_MASK
195 196 197 198
#else
#ifndef NON_BLOCKING_CONNECT
#ifdef HAVE_SELECT
#if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
199
#if O_NONBLOCK || O_NDELAY
200 201 202 203 204 205 206 207 208
#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 */

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

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

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

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

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

static int process_output_delay_count;

240
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
241 242 243 244 245 246 247

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

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

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

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

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

static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

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

static SELECT_TYPE non_process_wait_mask;

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

281
static SELECT_TYPE write_mask;
282

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

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

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

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

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

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

312
static int proc_buffered_char[MAXDESC];
313

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

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

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

413 414


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

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

494 495 496
    }
}

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

501
static Lisp_Object status_convert (int);
502

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

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

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

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

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

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

555
static Lisp_Object
556
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
557
{
558
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
559 560 561 562 563 564 565 566
  Lisp_Object symbol;
  int code, coredump;
  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
	{
643
#  if O_NONBLOCK
644 645 646 647 648
	  fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
#  else
	  fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
#  endif
	}
649
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
650 651 652 653 654 655 656 657

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

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

691 692 693 694
  /* 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
695

Ted Zlatanov's avatar
Ted Zlatanov committed
696 697 698 699
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

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

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

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

  deactivate_process (proc);
}
726

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

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

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

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

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

783 784 785 786

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

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

800
  process = get_process (process);
801 802
  p = XPROCESS (process);

803
  p->raw_status_new = 0;
804
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
805
    {
Paul Eggert's avatar
Paul Eggert committed
806
      pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
807
      p->tick = ++process_tick;
808
      status_notify (p);
809
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
810
    }
811
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
812
    {
813 814
#ifdef SIGCHLD
      Lisp_Object symbol;
815
      pid_t pid = p->pid;
816 817

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
818
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
819 820 821 822 823
				/* 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);
824 825 826
      symbol = p->status;
      if (CONSP (p->status))
	symbol = XCAR (p->status);
827
      if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
828 829
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
830 831 832 833
      else
#endif
	{
	  Fkill_process (process, Qnil);
834 835
	  /* Do this now, since remove_process will make the
	     SIGCHLD handler do nothing.  */
Paul Eggert's avatar
Paul Eggert committed
836
	  pset_status (p, Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil)));
837
	  p->tick = ++process_tick;
838
	  status_notify (p);
839
	  redisplay_preserve_echo_area (13);
840
	}
Jim Blandy's avatar
Jim Blandy committed
841
    }
842
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
843 844 845 846
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
847 848 849 850 851 852 853
       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.
854
listen -- for a network stream server that is listening.
855
closed -- for a network stream connection that is closed.
856 857
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
858 859 860
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
861
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
862 863 864
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
865

866 867
  if (STRINGP (process))
    process = Fget_process (process);
868
  else
869
    process = get_process (process);
870

871 872
  if (NILP (process))
    return process;
873

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

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

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

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

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

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
930 931 932
       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.
933 934
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
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)->command;
Jim Blandy's avatar
Jim Blandy committed
939 940
}

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

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

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

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

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

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
990 991
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
992
A value of t means stop accepting output from the process.
993 994 995

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
996
passed to the filter.
997

998
The filter gets two arguments: the process and the string of output.
999 1000 1001 1002 1003 1004
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
1005
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
1006
{
1007
  struct Lisp_Process *p;
1008

1009
  CHECK_PROCESS (process);
1010 1011 1012 1013 1014 1015 1016 1017 1018
  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 ...)  */
1019

1020
  if (p->infd >= 0)
1021
    {
1022
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1023
	{
1024 1025
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1026
	}
1027
      else if (EQ (p->filter, Qt)