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

Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2011
  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 27 28 29
#include <stdio.h>
#include <errno.h>
#include <setjmp.h>
#include <sys/types.h>		/* some typedefs are used in sys/file.h */
#include <sys/file.h>
#include <sys/stat.h>
30
#include <setjmp.h>
31 32 33
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
34

Richard M. Stallman's avatar
Richard M. Stallman committed
35
#include <unistd.h>
36 37
#include <fcntl.h>

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

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

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

#include <sys/ioctl.h>
58 59 60
#if defined(HAVE_NET_IF_H)
#include <net/if.h>
#endif /* HAVE_NET_IF_H */
Jim Blandy's avatar
Jim Blandy committed
61 62 63 64 65

#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

66 67 68 69 70 71
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

72 73 74 75
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
76 77 78 79
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

80 81
#endif	/* subprocesses */

82
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
83
#include "systime.h"
84
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
85 86 87

#include "window.h"
#include "buffer.h"
88
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
89
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
90
#include "process.h"
91
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
92 93 94
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
95
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
96
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
97
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
98
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
99
#include "atimer.h"
100 101 102
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
103 104 105
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
106

107 108 109
#if defined (USE_GTK) || defined (HAVE_GCONF)
#include "xgselect.h"
#endif /* defined (USE_GTK) || defined (HAVE_GCONF) */
110 111 112
#ifdef HAVE_NS
#include "nsterm.h"
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
113

114 115 116 117 118 119 120 121 122 123 124 125 126 127
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;

128 129
#ifdef subprocesses

130 131 132 133 134 135
static Lisp_Object Qprocessp;
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
136
#ifdef AF_INET6
137
static Lisp_Object Qipv6;
Kim F. Storm's avatar
Kim F. Storm committed
138
#endif
139 140
static Lisp_Object QCport, QCprocess;
Lisp_Object QCspeed;
141 142
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
143 144 145 146 147
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;
148 149 150 151
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

154 155 156 157 158
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

159 160 161 162
#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
163

164 165 166 167
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

168 169
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
170
/* Number of events of change of status of a process.  */
171
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
172
/* Number of events for which the user or sentinel has been notified.  */
173
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
174

175 176
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

177
/* Only W32 has this, it really means that select can't take write mask.  */
178 179
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
180
#define SELECT_CANT_DO_WRITE_MASK
181 182 183 184 185 186 187 188 189 190 191 192 193 194
#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 */

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
/* 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
212 213 214 215
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
216 217 218 219 220 221 222 223 224 225 226
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#ifdef EMACS_HAS_USECS
#define ADAPTIVE_READ_BUFFERING
#endif
#endif

#ifdef ADAPTIVE_READ_BUFFERING
#define READ_OUTPUT_DELAY_INCREMENT 10000
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

227 228
/* 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
229 230 231

static int process_output_delay_count;

232
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
233 234 235 236 237 238 239

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

240
INFUN (Fget_process, 1);
241 242 243 244 245
static int keyboard_bit_set (SELECT_TYPE *);
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);
246

247
/* If we support a window system, turn on the code to poll periodically
248
   to detect C-g.  It isn't actually used when doing interrupt input.  */
249
#ifdef HAVE_WINDOW_SYSTEM
250 251 252
#define POLL_FOR_INPUT
#endif

253 254
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
255

256 257 258 259
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

260
/* Mask that excludes keyboard input descriptor(s).  */
261 262 263

static SELECT_TYPE non_keyboard_wait_mask;

264
/* Mask that excludes process input descriptor(s).  */
265 266 267

static SELECT_TYPE non_process_wait_mask;

268
/* Mask for selecting for write.  */
269

270
static SELECT_TYPE write_mask;
271

272
#ifdef NON_BLOCKING_CONNECT
273 274 275 276 277 278 279 280
/* 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;
281
#endif	/* NON_BLOCKING_CONNECT */
282

283 284 285
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

286 287
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
288

Jim Blandy's avatar
Jim Blandy committed
289
/* Indexed by descriptor, gives the process (if any) for that descriptor */
290
Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
291 292

/* Alist of elements (NAME . PROCESS) */
293
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
294 295 296 297 298 299 300

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

301 302
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
303

Karl Heuer's avatar
Karl Heuer committed
304
/* Table of `struct coding-system' for each process.  */
305 306
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
307

308 309 310 311 312 313 314
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
struct sockaddr_and_len {
  struct sockaddr *sa;
  int len;
} datagram_address[MAXDESC];
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
315
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
316 317 318 319 320
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403


struct fd_callback_data
{
  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)
{
  xassert (fd < MAXDESC);
  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)
{
  xassert (fd < MAXDESC);
  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)
{
  xassert (fd < MAXDESC);
  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;

  xassert (fd < MAXDESC);
  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;
            }
404

405 406 407
    }
}

Jim Blandy's avatar
Jim Blandy committed
408 409 410 411

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

412
static Lisp_Object status_convert (int);
413

414
static void
415
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
416
{
417
  eassert (p->raw_status_new);
418
  p->status = status_convert (p->raw_status);
419
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
420 421
}

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

425
static Lisp_Object
426
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
{
  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.  */

443
static void
444
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
445 446 447
{
  Lisp_Object tem;

448
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
449 450 451 452 453 454 455
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
456 457 458 459
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
460 461 462 463 464 465
      *coredump = !NILP (tem);
    }
}

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

466
static Lisp_Object
467
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
468
{
469
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
470 471 472 473 474 475 476 477
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
478
      char *signame;
479
      synchronize_system_messages_locale ();
480
      signame = strsignal (code);
481
      if (signame == 0)
482 483 484 485 486 487 488 489 490
	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));
491
	  c1 = STRING_CHAR (SDATA (string));
492
	  c2 = downcase (c1);
493
	  if (c1 != c2)
494
	    Faset (string, make_number (0), make_number (c2));
495
	}
Jim Blandy's avatar
Jim Blandy committed
496 497 498 499 500
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
501 502
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
503 504
      if (code == 0)
	return build_string ("finished\n");
505
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
506
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
507 508
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
509
    }
510 511 512 513
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
514 515
      return concat3 (build_string ("failed with code "),
		      string, string2);
516
    }
Jim Blandy's avatar
Jim Blandy committed
517 518 519 520 521 522
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

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

526 527 528 529 530
/* 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.  */

531
static int
532
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
533 534 535 536 537 538
{
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
539
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
540 541 542 543 544 545 546 547 548 549
  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 */

550 551 552
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
553 554 555 556 557 558 559
	{
	  { /* 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;
560
	    struct stat stb;
561

562 563 564 565 566 567 568 569
	    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
570
	  }
571 572 573 574 575 576
#  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
	}
577
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
578 579 580 581 582 583 584 585

	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
586
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
587 588 589
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
590
		emacs_close (fd);
591
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
592
		continue;
593
# else
Jim Blandy's avatar
Jim Blandy committed
594
		return -1;
595
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
596 597 598 599 600 601 602 603 604
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

605
static Lisp_Object
606
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
607 608 609 610 611 612
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

613
  p = allocate_process ();
614

615 616 617 618
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
619
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
620
  p->pty_flag = 0;
621
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
622 623
  p->status = Qrun;
  p->mark = Fmake_marker ();
624
  p->kill_without_query = 0;
Jim Blandy's avatar
Jim Blandy committed
625

Kenichi Handa's avatar
Kenichi Handa committed
626
#ifdef ADAPTIVE_READ_BUFFERING
627 628 629
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
630 631
#endif

Ted Zlatanov's avatar
Ted Zlatanov committed
632 633
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
634
  p->gnutls_log_level = 0;
635
  p->gnutls_p = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
636 637
#endif

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

655
static void
656
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
657 658 659 660 661 662 663 664
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
665

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

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

Jim Blandy's avatar
Jim Blandy committed
684 685 686 687
/* 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
688

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

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

722 723 724 725 726 727 728 729 730 731

#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
732
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
733 734 735
       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
736
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
737
{
738 739
  register struct Lisp_Process *p;

740
  process = get_process (process);
741 742
  p = XPROCESS (process);

743
  p->raw_status_new = 0;
744
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
745
    {
746
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
747
      p->tick = ++process_tick;
748
      status_notify (p);
749
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
750
    }
751
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
752
    {
753 754
#ifdef SIGCHLD
      Lisp_Object symbol;
755 756
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
757
      EMACS_INT pid = p->pid;
758 759

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

808 809
  if (STRINGP (process))
    process = Fget_process (process);
810
  else
811
    process = get_process (process);
812

813 814
  if (NILP (process))
    return process;
815

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

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

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

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 897
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
898
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
899
{
900 901
  struct Lisp_Process *p;

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

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

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

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

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

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

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

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

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

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
987 988 989
       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
990
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
991
{
992
  CHECK_PROCESS (process);
993
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
994 995 996
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
997 998 999 1000
       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
1001
  (register Lisp_Object process, Lisp_Object sentinel)
Jim Blandy's avatar
Jim Blandy committed
1002
{
Kenichi Handa's avatar
Kenichi Handa committed
1003 1004
  struct Lisp_Process *p;

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

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

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1015 1016 1017
       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
1018
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1019
{
1020
  CHECK_PROCESS (process);
1021
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1022 1023
}

1024
DEFUN ("set-process-window-size", Fset_process_window_size,
1025 1026
       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
1027
  (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1028
{
1029 1030 1031
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
1032

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

1041
DEFUN ("set-process-inherit-coding-system-flag",
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
       Fset_process_inherit_coding_system_flag,
       Sset_process_inherit_coding_system_flag, 2, 2, 0,
       doc: /* Determine whether buffer of PROCESS will inherit coding-system.
If the second argument FLAG is non-nil, then the variable
`buffer-file-coding-system' of the buffer associated with PROCESS
will be bound to the value of the coding system used to decode
the process output.

This is useful when the coding system specified for the process buffer
leaves either the character code conversion or the end-of-line conversion
unspecified, or if the coding system used to decode the process output
is more appropriate for saving the process buffer.

Binding the variable `inherit-process-coding-system' to non-nil before
starting the process is an alternative way of setting the inherit flag
for the process which will run.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1058
  (register Lisp_Object process, Lisp_Object flag)
1059
{
1060
  CHECK_PROCESS (process);
1061
  XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1062 1063 1064
  return flag;
}

1065 1066 1067 1068
DEFUN ("set-process-query-on-exit-flag",
       Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
       2, 2, 0,
       doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1069
If the second argument FLAG is non-nil, Emacs will query the user before
1070
exiting or killing a buffer if PROCESS is running.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1071
  (register Lisp_Object process, Lisp_Object flag)
Jim Blandy's avatar
Jim Blandy committed
1072
{
1073
  CHECK_PROCESS (process);
1074
  XPROCESS (process)->kill_without_query = NILP (flag);
1075
  return flag;
Jim Blandy's avatar
Jim Blandy committed
1076
}
1077

1078 1079
DEFUN ("process-query-on-exit-flag",
       Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1080
       1, 1, 0,
1081
       doc: /* Return the current value of query-on-exit flag for PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed