process.c 217 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>
23
#include <signal.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26
#include <stdio.h>
#include <errno.h>
#include <setjmp.h>
27
#include <sys/types.h>		/* Some typedefs are used in sys/file.h.  */
Jim Blandy's avatar
Jim Blandy committed
28 29
#include <sys/file.h>
#include <sys/stat.h>
30
#include <setjmp.h>
31

Richard M. Stallman's avatar
Richard M. Stallman committed
32
#include <unistd.h>
33 34
#include <fcntl.h>

35 36
#include "lisp.h"

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

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

/* Are local (unix) sockets supported?  */
46
#if defined (HAVE_SYS_UN_H)
47 48 49 50 51 52 53 54
#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
55 56

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

Juanma Barranquero's avatar
Juanma Barranquero committed
61
#if defined (HAVE_IFADDRS_H)
62 63 64 65
/* 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
66
#if defined (HAVE_NET_IF_DL_H)
67 68 69 70 71
#include <net/if_dl.h>
#endif

#endif

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

76 77 78 79 80 81
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

82 83 84 85
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
86 87 88 89
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

90 91
#endif	/* subprocesses */

Jim Blandy's avatar
Jim Blandy committed
92
#include "systime.h"
93
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
94 95

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

116
#if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
117
#include "xgselect.h"
118
#endif
119 120 121
#ifdef HAVE_NS
#include "nsterm.h"
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
122

123 124 125 126 127 128 129
/* 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

130 131 132 133 134 135 136 137 138 139 140 141 142 143
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;

144 145
#ifdef subprocesses

146
Lisp_Object Qprocessp;
147 148 149 150 151
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
152
#ifdef AF_INET6
153
static Lisp_Object Qipv6;
Kim F. Storm's avatar
Kim F. Storm committed
154
#endif
155 156
static Lisp_Object QCport, QCprocess;
Lisp_Object QCspeed;
157 158
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
159 160 161 162 163
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;
164 165 166 167
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

Jim Blandy's avatar
Jim Blandy committed
168 169
/* Qexit is declared and initialized in eval.c.  */

170 171 172 173 174
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

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 199 200 201 202 203 204 205 206 207 208
#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 */

209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
/* 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.  */

#ifdef BROKEN_DATAGRAM_SOCKETS
#undef DATAGRAM_SOCKETS
#else
#ifndef DATAGRAM_SOCKETS
#if defined (HAVE_SELECT) || defined (FIONREAD)
#if defined (HAVE_SENDTO) && defined (HAVE_RECVFROM) && defined (EMSGSIZE)
#define DATAGRAM_SOCKETS
#endif /* HAVE_SENDTO && HAVE_RECVFROM && EMSGSIZE */
#endif /* HAVE_SELECT || FIONREAD */
#endif /* DATAGRAM_SOCKETS */
#endif /* BROKEN_DATAGRAM_SOCKETS */

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

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

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

239 240
/* 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
241 242 243

static int process_output_delay_count;

244
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
245 246 247 248 249 250 251

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

252
static Lisp_Object Fget_process (Lisp_Object);
253
static void create_process (Lisp_Object, char **, Lisp_Object);
254
#ifdef SIGIO
255
static int keyboard_bit_set (SELECT_TYPE *);
256
#endif
257 258 259 260
static void deactivate_process (Lisp_Object);
static void status_notify (struct Lisp_Process *);
static int read_process_output (Lisp_Object, int);
static void create_pty (Lisp_Object);
261

262
/* If we support a window system, turn on the code to poll periodically
263
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
264
#if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
265 266 267
#define POLL_FOR_INPUT
#endif

268 269
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
270

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

static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

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

static SELECT_TYPE non_process_wait_mask;

283
/* Mask for selecting for write.  */
284

285
static SELECT_TYPE write_mask;
286

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

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

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

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

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

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

316
static int proc_buffered_char[MAXDESC];
317

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

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

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

338 339


340
static struct fd_callback_data
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
{
  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)
{
356
  eassert (fd < MAXDESC);
357 358 359 360 361 362 363 364 365 366 367 368
  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)
{
369
  eassert (fd < MAXDESC);
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
  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)
{
386
  eassert (fd < MAXDESC);
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
  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;

403
  eassert (fd < MAXDESC);
404 405 406 407 408 409 410 411 412 413 414 415 416 417
  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;
            }
418

419 420 421
    }
}

Jim Blandy's avatar
Jim Blandy committed
422 423 424 425

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

426
static Lisp_Object status_convert (int);
427

428
static void
429
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
430
{
431
  eassert (p->raw_status_new);
432
  p->status = status_convert (p->raw_status);
433
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
434 435
}

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

439
static Lisp_Object
440
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
    return Fcons (Qexit, Fcons (make_number (WRETCODE (w)),
				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.  */

457
static void
458
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
459 460 461
{
  Lisp_Object tem;

462
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
463 464 465 466 467 468 469
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
470 471 472 473
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
474 475 476 477 478 479
      *coredump = !NILP (tem);
    }
}

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

480
static Lisp_Object
481
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
482
{
483
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
484 485 486 487 488 489 490 491
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
492
      char *signame;
493
      synchronize_system_messages_locale ();
494
      signame = strsignal (code);
495
      if (signame == 0)
496 497 498 499 500 501 502 503 504
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

	  string = make_unibyte_string (signame, strlen (signame));
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
505
	  c1 = STRING_CHAR (SDATA (string));
506
	  c2 = downcase (c1);
507
	  if (c1 != c2)
508
	    Faset (string, make_number (0), make_number (c2));
509
	}
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513 514
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
515 516
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
517 518
      if (code == 0)
	return build_string ("finished\n");
519
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
520
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
521 522
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
523
    }
524 525 526 527
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
528 529
      return concat3 (build_string ("failed with code "),
		      string, string2);
530
    }
Jim Blandy's avatar
Jim Blandy committed
531 532 533 534 535 536
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

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

540 541 542 543 544
/* 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.  */

545
static int
546
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551 552
{
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
553
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
554 555 556 557 558 559 560 561 562 563
  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 */

564 565 566
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
567 568 569 570 571 572 573
	{
	  { /* Some systems name their pseudoterminals so that there are gaps in
	       the usual sequence - for example, on HP9000/S700 systems, there
	       are no pseudoterminals with names ending in 'f'.  So we wait for
	       three failures in a row before deciding that we've reached the
	       end of the ptys.  */
	    int failed_count = 0;
574
	    struct stat stb;
575

576 577 578 579 580 581 582 583
	    if (stat (pty_name, &stb) < 0)
	      {
		failed_count++;
		if (failed_count >= 3)
		  return -1;
	      }
	    else
	      failed_count = 0;
Jim Blandy's avatar
Jim Blandy committed
584
	  }
585 586 587 588 589 590
#  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
	}
591
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
592 593 594 595 596 597 598 599

	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
600
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
601 602 603
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
604
		emacs_close (fd);
605
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
606
		continue;
607
# else
Jim Blandy's avatar
Jim Blandy committed
608
		return -1;
609
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
610 611 612 613 614 615 616 617 618
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

619
static Lisp_Object
620
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
621 622 623
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
624 625
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
626

627
  p = allocate_process ();
628 629
  /* Initialize Lisp data.  Note that allocate_process initializes all
     Lisp data to nil, so do it only for slots which should not be nil.  */
Jim Blandy's avatar
Jim Blandy committed
630 631 632
  p->status = Qrun;
  p->mark = Fmake_marker ();

633 634 635 636
  /* 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
637

Ted Zlatanov's avatar
Ted Zlatanov committed
638 639 640 641
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

Jim Blandy's avatar
Jim Blandy committed
642 643 644 645 646 647 648
  /* 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;
649
      sprintf (suffix, "<%"pMd">", i);
Jim Blandy's avatar
Jim Blandy committed
650 651 652 653
      name1 = concat2 (name, build_string (suffix));
    }
  name = name1;
  p->name = name;
654
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
655 656 657 658
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

659
static void
660
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
661 662 663 664 665 666 667 668
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
669

Jim Blandy's avatar
Jim Blandy committed
670 671

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
672
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
673
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
674
{
675
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
676 677 678
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
679
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
680
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
681
{
682
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
683
    return name;
684
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
685 686 687
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
688 689 690 691
/* 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
692

693
static Lisp_Object
694
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
695
{
696 697 698 699 700 701 702
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
703
	error ("Process %s does not exist", SDATA (name));
704 705 706
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
707
  else
708 709 710 711 712
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
713
    {
714
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
715
      if (NILP (proc))
Tom Tromey's avatar
Tom Tromey committed
716
	error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
717 718
    }
  else
719
    {
720
      CHECK_PROCESS (obj);
721 722 723
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
724 725
}

726 727 728 729 730 731 732 733 734 735

#ifdef SIGCHLD
/* Fdelete_process promises to immediately forget about the process, but in
   reality, Emacs needs to remember those processes until they have been
   treated by sigchld_handler; otherwise this handler would consider the
   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
736
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
737 738 739
       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
740
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
741
{
742 743
  register struct Lisp_Process *p;

744
  process = get_process (process);
745 746
  p = XPROCESS (process);

747
  p->raw_status_new = 0;
748
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
749
    {
750
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
751
      p->tick = ++process_tick;
752
      status_notify (p);
753
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
754
    }
755
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
756
    {
757 758
#ifdef SIGCHLD
      Lisp_Object symbol;
759
      pid_t pid = p->pid;
760 761

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
762
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
763 764 765 766 767 768 769 770 771
				/* 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);
      symbol = p->status;
      if (CONSP (p->status))
	symbol = XCAR (p->status);
      if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
772 773
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
774 775 776 777 778 779 780
      else
#endif
	{
	  Fkill_process (process, Qnil);
	  /* Do this now, since remove_process will make sigchld_handler do nothing.  */
	  p->status
	    = Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
781
	  p->tick = ++process_tick;
782
	  status_notify (p);
783
	  redisplay_preserve_echo_area (13);
784
	}
Jim Blandy's avatar
Jim Blandy committed
785
    }
786
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
787 788 789 790
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
791 792 793 794 795 796 797
       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.
798
listen -- for a network stream server that is listening.
799
closed -- for a network stream connection that is closed.
800 801
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
802 803 804
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
805
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
806 807 808
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
809

810 811
  if (STRINGP (process))
    process = Fget_process (process);
812
  else
813
    process = get_process (process);
814

815 816
  if (NILP (process))
    return process;
817

818
  p = XPROCESS (process);
819
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
820 821
    update_status (p);
  status = p->status;
822
  if (CONSP (status))
823
    status = XCAR (status);
824
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
825
    {
826
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
827
	status = Qclosed;
828 829 830 831
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
832 833 834 835 836 837
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
838 839
       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
840
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
841
{
842
  CHECK_PROCESS (process);
843
  if (XPROCESS (process)->raw_status_new)
844 845
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
846
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
847 848 849 850
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
851
       doc: /* Return the process id of PROCESS.
852
This is the pid of the external process which PROCESS uses or talks to.
853
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
854
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
855
{
856
  pid_t pid;
857

858
  CHECK_PROCESS (process);
859 860
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
861 862 863
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
864 865 866
       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
867
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
868
{
869
  CHECK_PROCESS (process);
870
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
871 872 873
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
874 875 876
       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.
877 878
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
879
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
880
{
881
  CHECK_PROCESS (process);
882
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
883 884
}

885
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
886 887 888
       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
889
  (register Lisp_Object process)
890
{
891
  CHECK_PROCESS (process);
892
  return XPROCESS (process)->tty_name;
893 894
}

Jim Blandy's avatar
Jim Blandy committed
895
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
896
       2, 2, 0,
897 898
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
899
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
900
{
901 902
  struct Lisp_Process *p;

903
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
904
  if (!NILP (buffer))
905
    CHECK_BUFFER (buffer);
906 907
  p = XPROCESS (process);
  p->buffer = buffer;
908
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
909
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
910
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
911 912 913 914
  return buffer;
}

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

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
925 926
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
927
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
928
{
929
  CHECK_PROCESS (process);
930
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
931 932 933
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
934 935
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
936
A value of t means stop accepting output from the process.
937 938 939

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
940
passed to the filter.
941

942
The filter gets two arguments: the process and the string of output.
943 944 945 946 947 948
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
949
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
950
{
951
  struct Lisp_Process *p;
952

953
  CHECK_PROCESS (process);
954 955 956 957 958 959 960 961 962
  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 ...)  */
963

964
  if (p->infd >= 0)
965
    {
966
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
967
	{
968 969
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
970
	}
971
      else if (EQ (p->filter, Qt)
972 973
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
974
	{
975 976
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
977
	}
978
    }
979

980
  p->filter = filter;
981
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
982
    p->childp = Fplist_put (p->childp, QCfilter, filter);
983
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
984 985 986 987
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
988 989 990
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
991
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
992
{
993
  CHECK_PROCESS (process);
994
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
995 996 997
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
998 999 1000 1001
       2, 2, 0,
       doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
The sentinel is called as a function when the process changes state.
It gets two arguments: the process, and a string describing the change.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1002
  (register Lisp_Object process, Lisp_Object sentinel)
Jim Blandy's avatar
Jim Blandy committed
1003
{
Kenichi Handa's avatar
Kenichi Handa committed
1004 1005
  struct Lisp_Process *p;

1006
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1007 1008 1009
  p = XPROCESS (process);

  p->sentinel = sentinel;
1010
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
1011
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014 1015
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1016 1017 1018
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1019
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1020
{
1021
  CHECK_PROCESS (process);
1022
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1023 1024
}

1025
DEFUN ("set-process-window-size", Fset_process_window_size,
1026 1027
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1028
  (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1029
{
1030
  CHECK_PROCESS (process);
1031 1032
  CHECK_RANGED_INTEGER (0, height, INT_MAX);
  CHECK_RANGED_INTEGER (0, width, INT_MAX);
1033

1034 1035
  if (XPROCESS (process)->infd < 0
      || set_window_size (XPROCESS (process)->infd,
1036
			  XINT (height), XINT (width)) <= 0)
1037 1038 1039 1040 1041
    return Qnil;
  else
    return Qt;
}

1042
DEFUN ("set-process-inherit-coding-system-flag",