process.c 216 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3
		 1996, 1998, 1999, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
		 2005, 2006, 2007, 2008, 2009, 2010 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
#include <stdlib.h>
35

Richard M. Stallman's avatar
Richard M. Stallman committed
36 37 38
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
39 40
#include <fcntl.h>

41 42 43
/* Only MS-DOS does not define `subprocesses'.  */
#ifdef subprocesses

Jim Blandy's avatar
Jim Blandy committed
44 45 46 47
#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
48 49

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

Dan Nicolaescu's avatar
Dan Nicolaescu committed
60
#if defined(HAVE_SYS_IOCTL_H)
Jim Blandy's avatar
Jim Blandy committed
61
#include <sys/ioctl.h>
62 63 64
#if defined(HAVE_NET_IF_H)
#include <net/if.h>
#endif /* HAVE_NET_IF_H */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
65
#endif /* HAVE_SYS_IOCTL_H */
Jim Blandy's avatar
Jim Blandy committed
66 67 68 69 70

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

Dave Love's avatar
Dave Love committed
71 72 73
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
74

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

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

85 86
#endif	/* subprocesses */

87
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
88
#include "systime.h"
89
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
90 91 92

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

109 110 111
#if defined (USE_GTK) || defined (HAVE_GCONF)
#include "xgselect.h"
#endif /* defined (USE_GTK) || defined (HAVE_GCONF) */
112 113 114
#ifdef HAVE_NS
#include "nsterm.h"
#endif
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
extern int timers_run;

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 delete a process right away if it exits.  */
static int delete_exited_processes;

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

134 135
#ifdef subprocesses

136
Lisp_Object Qprocessp;
Kim F. Storm's avatar
Kim F. Storm committed
137
Lisp_Object Qrun, Qstop, Qsignal;
138
Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
Stefan Monnier's avatar
Stefan Monnier committed
139
Lisp_Object Qlocal, Qipv4, Qdatagram, Qseqpacket;
140
Lisp_Object Qreal, Qnetwork, Qserial;
Kim F. Storm's avatar
Kim F. Storm committed
141 142 143
#ifdef AF_INET6
Lisp_Object Qipv6;
#endif
144 145 146
Lisp_Object QCport, QCspeed, QCprocess;
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
147
Lisp_Object QCbuffer, QChost, QCservice;
148
Lisp_Object QClocal, QCremote, QCcoding;
149
Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
150
Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
151
Lisp_Object Qlast_nonmenu_event;
152 153 154 155
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

158 159 160 161 162
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

163 164 165 166
#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
167 168 169 170 171 172 173 174 175 176 177

/* Define first descriptor number available for subprocesses.  */
#define FIRST_PROC_DESC 3

/* Define SIGCHLD as an alias for SIGCLD.  There are many conditionals
   testing SIGCHLD.  */

#if !defined (SIGCHLD) && defined (SIGCLD)
#define SIGCHLD SIGCLD
#endif /* SIGCLD */

178
extern const char *get_operating_system_release (void);
179

180 181 182 183
/* From sysdep.c or w32.c  */
extern int serial_open (char *port);
extern void serial_configure (struct Lisp_Process *p, Lisp_Object contact);

184 185 186 187
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
188 189
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
190
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
191

192 193
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
194
/* Number of events of change of status of a process.  */
195
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
196
/* Number of events for which the user or sentinel has been notified.  */
197
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
198

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
#else
#ifndef NON_BLOCKING_CONNECT
#ifdef HAVE_SELECT
#if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
#if defined (O_NONBLOCK) || defined (O_NDELAY)
#if defined (EWOULDBLOCK) || defined (EINPROGRESS)
#define NON_BLOCKING_CONNECT
#endif /* EWOULDBLOCK || EINPROGRESS */
#endif /* O_NONBLOCK || O_NDELAY */
#endif /* HAVE_GETPEERNAME || GNU_LINUX */
#endif /* HAVE_SELECT */
#endif /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
/* 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
234 235 236 237
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
238 239 240 241 242 243 244 245 246 247 248
#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)

249 250
/* 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
251 252 253

static int process_output_delay_count;

254
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
255 256 257 258 259

static int process_output_skip;

/* Non-nil means to delay reading process output to improve buffering.
   A value of t means that delay is reset after each send, any other
260 261
   non-nil value does not reset the delay.  A value of nil disables
   adaptive read buffering completely.  */
Kenichi Handa's avatar
Kenichi Handa committed
262 263 264 265 266
static Lisp_Object Vprocess_adaptive_read_buffering;
#else
#define process_output_delay_count 0
#endif

267 268 269 270 271
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);
272

273
/* If we support a window system, turn on the code to poll periodically
274
   to detect C-g.  It isn't actually used when doing interrupt input.  */
275
#ifdef HAVE_WINDOW_SYSTEM
276 277 278
#define POLL_FOR_INPUT
#endif

279 280
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
281

282 283 284 285
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

286
/* Mask that excludes keyboard input descriptor(s).  */
287 288 289

static SELECT_TYPE non_keyboard_wait_mask;

290
/* Mask that excludes process input descriptor(s).  */
291 292 293

static SELECT_TYPE non_process_wait_mask;

294 295 296 297
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

298
#ifdef NON_BLOCKING_CONNECT
299 300 301 302 303 304 305 306 307
/* 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;

308
#define IF_NON_BLOCKING_CONNECT(s) s
309
#else  /* NON_BLOCKING_CONNECT */
310
#define IF_NON_BLOCKING_CONNECT(s)
311
#endif	/* NON_BLOCKING_CONNECT */
312

313 314 315
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

316 317
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
318

319 320 321
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

Jim Blandy's avatar
Jim Blandy committed
322
/* Indexed by descriptor, gives the process (if any) for that descriptor */
323
Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
324 325

/* Alist of elements (NAME . PROCESS) */
326
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
327 328 329 330 331 332 333

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

334 335
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
336

Karl Heuer's avatar
Karl Heuer committed
337
/* Table of `struct coding-system' for each process.  */
338 339
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
340

341 342 343 344 345 346 347
#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)
348
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
349 350 351 352 353
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

357
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
358 359 360
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
361
/* The file name of the pty opened by allocate_pty.  */
362 363

static char pty_name[24];
364
#endif
Jim Blandy's avatar
Jim Blandy committed
365 366 367 368

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

369
static Lisp_Object status_convert (int);
370

371
static void
372
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
373
{
374
  eassert (p->raw_status_new);
375
  p->status = status_convert (p->raw_status);
376
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
377 378
}

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

382
static Lisp_Object
383
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
{
  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.  */

400
static void
401
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
402 403 404
{
  Lisp_Object tem;

405
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409 410 411 412
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
413 414 415 416
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
417 418 419 420 421 422
      *coredump = !NILP (tem);
    }
}

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

423
static Lisp_Object
424
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
425
{
426
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430 431 432 433 434
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
435
      char *signame;
436
      synchronize_system_messages_locale ();
437
      signame = strsignal (code);
438
      if (signame == 0)
439 440 441 442 443 444 445 446 447
	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));
448
	  c1 = STRING_CHAR ((char *) SDATA (string));
449 450
	  c2 = DOWNCASE (c1);
	  if (c1 != c2)
451
	    Faset (string, make_number (0), make_number (c2));
452
	}
Jim Blandy's avatar
Jim Blandy committed
453 454 455 456 457
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
458 459
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
460 461
      if (code == 0)
	return build_string ("finished\n");
462
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
463
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
464 465
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
466
    }
467 468 469 470
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
471 472
      return concat3 (build_string ("failed with code "),
		      string, string2);
473
    }
Jim Blandy's avatar
Jim Blandy committed
474 475 476 477 478 479
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

480 481 482 483 484
/* 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.  */

485
static int
486
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
487
{
Andreas Schwab's avatar
Andreas Schwab committed
488
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
489 490 491 492 493 494 495 496 497
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
498
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
499 500 501 502 503 504
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

505 506 507
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
508 509 510 511 512 513 514
	{
	  { /* 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;
515

516 517 518 519 520 521 522 523
	    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
524
	  }
525 526 527 528 529 530
#  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
	}
531
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538 539

	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
540
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
541 542 543
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
544
		emacs_close (fd);
545
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
546
		continue;
547
# else
Jim Blandy's avatar
Jim Blandy committed
548
		return -1;
549
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
550 551 552 553 554 555 556 557 558
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

559
static Lisp_Object
560
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
561 562 563 564 565 566
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

567
  p = allocate_process ();
568

569 570 571 572
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
573
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
574
  p->pty_flag = 0;
575
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
576 577
  p->status = Qrun;
  p->mark = Fmake_marker ();
578
  p->kill_without_query = 0;
Jim Blandy's avatar
Jim Blandy committed
579

Kenichi Handa's avatar
Kenichi Handa committed
580
#ifdef ADAPTIVE_READ_BUFFERING
581 582 583
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
584 585
#endif

Jim Blandy's avatar
Jim Blandy committed
586 587 588 589 590 591 592 593 594 595 596 597
  /* 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;
598
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
599 600 601 602
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

603
static void
604
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
605 606 607 608 609 610 611 612
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
613

Jim Blandy's avatar
Jim Blandy committed
614 615

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
616
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
617
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
618
{
619
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
620 621 622
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
623
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
624
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
625
{
626
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
627
    return name;
628
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
629 630 631
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
632 633 634 635
/* 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
636

637
static Lisp_Object
638
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
639
{
640 641 642 643 644 645 646
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
647
	error ("Process %s does not exist", SDATA (name));
648 649 650
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
651
  else
652 653 654 655 656
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
657
    {
658
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
659
      if (NILP (proc))
660
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
661 662
    }
  else
663
    {
664
      CHECK_PROCESS (obj);
665 666 667
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
668 669
}

670 671 672 673 674 675 676 677 678 679

#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
680
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
681 682 683
       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
684
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
685
{
686 687
  register struct Lisp_Process *p;

688
  process = get_process (process);
689 690
  p = XPROCESS (process);

691
  p->raw_status_new = 0;
692
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
693
    {
694
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
695
      p->tick = ++process_tick;
696
      status_notify (p);
697
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
698
    }
699
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
700
    {
701 702
#ifdef SIGCHLD
      Lisp_Object symbol;
703 704
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
705
      EMACS_INT pid = p->pid;
706 707

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
708
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
709 710 711 712 713 714 715 716 717
				/* 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))
718 719
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
720 721 722 723 724 725 726
      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));
727
	  p->tick = ++process_tick;
728
	  status_notify (p);
729
	  redisplay_preserve_echo_area (13);
730
	}
Jim Blandy's avatar
Jim Blandy committed
731
    }
732
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
733 734 735 736
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
737 738 739 740 741 742 743
       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.
744
listen -- for a network stream server that is listening.
745
closed -- for a network stream connection that is closed.
746 747
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
748 749 750
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
751
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
752 753 754
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
755

756 757
  if (STRINGP (process))
    process = Fget_process (process);
758
  else
759
    process = get_process (process);
760

761 762
  if (NILP (process))
    return process;
763

764
  p = XPROCESS (process);
765
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
766 767
    update_status (p);
  status = p->status;
768
  if (CONSP (status))
769
    status = XCAR (status);
770
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
771
    {
772
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
773
	status = Qclosed;
774 775 776 777
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
778 779 780 781 782 783
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
784 785
       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
786
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
787
{
788
  CHECK_PROCESS (process);
789
  if (XPROCESS (process)->raw_status_new)
790 791
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
792
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
793 794 795 796
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
797
       doc: /* Return the process id of PROCESS.
798
This is the pid of the external process which PROCESS uses or talks to.
799
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
800
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
801
{
802 803 804 805
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

806
  CHECK_PROCESS (process);
807 808
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
809 810 811
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
812 813 814
       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
815
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
816
{
817
  CHECK_PROCESS (process);
818
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
819 820 821
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
822 823 824
       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.
825 826
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
827
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
828
{
829
  CHECK_PROCESS (process);
830
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
831 832
}

833
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
834 835 836
       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
837
  (register Lisp_Object process)
838
{
839
  CHECK_PROCESS (process);
840
  return XPROCESS (process)->tty_name;
841 842
}

Jim Blandy's avatar
Jim Blandy committed
843
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
844 845
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
846
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
847
{
848 849
  struct Lisp_Process *p;

850
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
851
  if (!NILP (buffer))
852
    CHECK_BUFFER (buffer);
853 854
  p = XPROCESS (process);
  p->buffer = buffer;
855
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
856
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
857
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
858 859 860 861
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
862 863 864
       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
865
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
866
{
867
  CHECK_PROCESS (process);
868
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
869 870 871
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
872 873
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
874
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
875
{
876
  CHECK_PROCESS (process);
877
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
878 879 880
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
881 882
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
883
A value of t means stop accepting output from the process.
884 885 886

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
887
passed to the filter.
888

889
The filter gets two arguments: the process and the string of output.
890 891 892 893 894 895
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
896
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
897
{
898
  struct Lisp_Process *p;
899

900
  CHECK_PROCESS (process);
901 902 903 904 905 906 907 908 909
  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 ...)  */
910

911
  if (p->infd >= 0)
912
    {
913
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
914
	{
915 916
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
917
	}
918
      else if (EQ (p->filter, Qt)
919 920
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
921
	{
922 923
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
924
	}
925
    }
926

927
  p->filter = filter;
928
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
929
    p->childp = Fplist_put (p->childp, QCfilter, filter);
930
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
931 932 933 934
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
935 936 937
       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
938
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
939
{
940
  CHECK_PROCESS (process);
941
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
942 943 944
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
945 946 947 948
       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
949
  (register Lisp_Object process, Lisp_Object sentinel)
Jim Blandy's avatar
Jim Blandy committed
950
{
Kenichi Handa's avatar
Kenichi Handa committed
951 952
  struct Lisp_Process *p;

953
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
954 955 956
  p = XPROCESS (process);

  p->sentinel = sentinel;
957
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
958
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
963 964 965
       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
966
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
967
{
968
  CHECK_PROCESS (process);
969
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
970 971
}

972
DEFUN ("set-process-window-size", Fset_process_window_size,
973 974
       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
975
  (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
976
{
977 978 979
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
980

981 982
  if (XPROCESS (process)->infd < 0
      || set_window_size (XPROCESS (process)->infd,
983
			  XINT (height), XINT (width)) <= 0)
984 985 986 987 988
    return Qnil;
  else
    return Qt;
}

989
DEFUN ("set-process-inherit-coding-system-flag",
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
       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
1006
  (register Lisp_Object process, Lisp_Object flag)
1007
{
1008
  CHECK_PROCESS (process);
1009
  XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1010 1011 1012
  return flag;
}

1013 1014 1015 1016
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.
1017
If the second argument FLAG is non-nil, Emacs will query the user before
1018
exiting or killing a buffer if PROCESS is running.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1019
  (register Lisp_Object process, Lisp_Object flag)
Jim Blandy's avatar
Jim Blandy committed
1020
{
1021
  CHECK_PROCESS (process);
1022
  XPROCESS (process)->kill_without_query = NILP (flag);
1023
  return flag;
Jim Blandy's avatar
Jim Blandy committed
1024
}
1025

1026 1027
DEFUN ("process-query-on-exit-flag",
       Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1028
       1, 1, 0,
1029
       doc: /* Return the current value of query-on-exit flag for PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1030
  (register Lisp_Object process)
Richard M. Stallman's avatar