process.c 208 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
                 1996, 1998, 1999, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
any later version.

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22 23


24
#include <config.h>
25 26
#include <signal.h>

Jim Blandy's avatar
Jim Blandy committed
27 28 29 30 31 32 33 34
/* This file is split into two parts by the following preprocessor
   conditional.  The 'then' clause contains all of the support for
   asynchronous subprocesses.  The 'else' clause contains stub
   versions of some of the asynchronous subprocess routines that are
   often called elsewhere in Emacs, so we don't have to #ifdef the
   sections that call them.  */


Jim Blandy's avatar
Jim Blandy committed
35 36 37 38 39 40 41 42
#ifdef subprocesses

#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>
43 44 45
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
46 47 48
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
49

50
#if defined(WINDOWSNT) || defined(UNIX98_PTYS)
51 52 53 54
#include <stdlib.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Jim Blandy's avatar
Jim Blandy committed
55 56 57 58 59
#ifdef HAVE_SOCKETS	/* TCP connection support, if kernel can do it */
#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
60 61 62
#ifdef NEED_NET_ERRNO_H
#include <net/errno.h>
#endif /* NEED_NET_ERRNO_H */
63 64

/* Are local (unix) sockets supported?  */
65
#if defined (HAVE_SYS_UN_H) && !defined (NO_SOCKETS_IN_FILE_SYSTEM)
66 67 68 69 70 71 72 73
#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
74 75
#endif /* HAVE_SOCKETS */

76
/* TERM is a poor-man's SLIP, used on GNU/Linux.  */
77 78 79 80
#ifdef TERM
#include <client.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
81
/* On some systems, inet_addr returns a 'struct in_addr'. */
82
#ifdef HAVE_BROKEN_INET_ADDR
83 84 85 86 87 88 89
#define IN_ADDR struct in_addr
#define NUMERIC_ADDR_ERROR (numeric_addr.s_addr == -1)
#else
#define IN_ADDR unsigned long
#define NUMERIC_ADDR_ERROR (numeric_addr == -1)
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
90
#if defined(BSD_SYSTEM)
Jim Blandy's avatar
Jim Blandy committed
91
#include <sys/ioctl.h>
92
#if !defined (O_NDELAY) && defined (HAVE_PTYS) && !defined(USG5)
Jim Blandy's avatar
Jim Blandy committed
93 94
#include <fcntl.h>
#endif /* HAVE_PTYS and no O_NDELAY */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
95
#endif /* BSD_SYSTEM */
Jim Blandy's avatar
Jim Blandy committed
96

97 98 99 100
#ifdef BROKEN_O_NONBLOCK
#undef O_NONBLOCK
#endif /* BROKEN_O_NONBLOCK */

Jim Blandy's avatar
Jim Blandy committed
101 102 103 104
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

Kenichi Handa's avatar
Kenichi Handa committed
105 106 107 108 109 110 111 112 113 114 115
/* Can we use SIOCGIFCONF and/or SIOCGIFADDR */
#ifdef HAVE_SOCKETS
#if defined(HAVE_SYS_IOCTL_H) && defined(HAVE_NET_IF_H)
/* sys/ioctl.h may have been included already */
#ifndef SIOCGIFADDR
#include <sys/ioctl.h>
#endif
#include <net/if.h>
#endif
#endif

Jim Blandy's avatar
Jim Blandy committed
116 117 118
#ifdef IRIS
#include <sys/sysmacros.h>	/* for "minor" */
#endif /* not IRIS */
119

Dave Love's avatar
Dave Love committed
120 121 122
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
123

124 125 126 127 128 129
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

130
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
131
#include "systime.h"
132
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
133 134 135

#include "window.h"
#include "buffer.h"
136
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
137
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
138
#include "process.h"
139
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
140 141 142
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
143
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
144
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
145
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
146
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
147
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
148

149
Lisp_Object Qprocessp;
Kim F. Storm's avatar
Kim F. Storm committed
150
Lisp_Object Qrun, Qstop, Qsignal;
151
Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
Kim F. Storm's avatar
Kim F. Storm committed
152 153 154 155
Lisp_Object Qlocal, Qipv4, Qdatagram;
#ifdef AF_INET6
Lisp_Object Qipv6;
#endif
156
Lisp_Object QCname, QCbuffer, QChost, QCservice, QCtype;
157
Lisp_Object QClocal, QCremote, QCcoding;
158
Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
159
Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
Kim F. Storm's avatar
Kim F. Storm committed
160
Lisp_Object QCfilter_multibyte;
161
Lisp_Object Qlast_nonmenu_event;
162 163 164 165
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

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

Jim Blandy's avatar
Jim Blandy committed
173
/* a process object is a network connection when its childp field is neither
174
   Qt nor Qnil but is instead a property list (KEY VAL ...).  */
Jim Blandy's avatar
Jim Blandy committed
175 176

#ifdef HAVE_SOCKETS
177 178
#define NETCONN_P(p) (CONSP (XPROCESS (p)->childp))
#define NETCONN1_P(p) (CONSP ((p)->childp))
Jim Blandy's avatar
Jim Blandy committed
179 180
#else
#define NETCONN_P(p) 0
181
#define NETCONN1_P(p) 0
Jim Blandy's avatar
Jim Blandy committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
#endif /* HAVE_SOCKETS */

/* Define first descriptor number available for subprocesses.  */
#ifdef VMS
#define FIRST_PROC_DESC 1
#else /* Not VMS */
#define FIRST_PROC_DESC 3
#endif

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

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

#include "syssignal.h"

Richard M. Stallman's avatar
Richard M. Stallman committed
200
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
201

202
extern char *get_operating_system_release ();
203

204
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
205
extern int errno;
206
#endif
Roland McGrath's avatar
Roland McGrath committed
207
#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
208
extern char *sys_errlist[];
Roland McGrath's avatar
Roland McGrath committed
209
#endif
Jim Blandy's avatar
Jim Blandy committed
210

211 212 213 214
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
215 216
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
217
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
218 219 220 221 222 223 224

#ifdef SKTPAIR
#ifndef HAVE_SOCKETS
#include <sys/socket.h>
#endif
#endif /* SKTPAIR */

225 226
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
227
/* Number of events of change of status of a process.  */
228
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
229
/* Number of events for which the user or sentinel has been notified.  */
230
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
231

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
/* 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_SOCKETS
#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 /* HAVE_SOCKETS */
#endif /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
/* 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
#ifdef HAVE_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 /* HAVE_SOCKETS */
#endif /* DATAGRAM_SOCKETS */
#endif /* BROKEN_DATAGRAM_SOCKETS */

271 272
#ifdef TERM
#undef NON_BLOCKING_CONNECT
273
#undef DATAGRAM_SOCKETS
274 275
#endif

Kenichi Handa's avatar
Kenichi Handa committed
276 277 278 279 280 281 282 283 284 285 286
#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)

287 288
/* 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
289 290 291

static int process_output_delay_count;

292
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
293 294 295 296 297

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
298 299
   non-nil value does not reset the delay.  A value of nil disables
   adaptive read buffering completely.  */
Kenichi Handa's avatar
Kenichi Handa committed
300 301 302 303 304
static Lisp_Object Vprocess_adaptive_read_buffering;
#else
#define process_output_delay_count 0
#endif

305

306
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
307

308 309 310 311
static int keyboard_bit_set P_ ((SELECT_TYPE *));
static void deactivate_process P_ ((Lisp_Object));
static void status_notify P_ ((struct Lisp_Process *));
static int read_process_output P_ ((Lisp_Object, int));
312

313
/* If we support a window system, turn on the code to poll periodically
314
   to detect C-g.  It isn't actually used when doing interrupt input.  */
315
#ifdef HAVE_WINDOW_SYSTEM
316 317 318
#define POLL_FOR_INPUT
#endif

319 320 321 322 323 324
static Lisp_Object get_process ();
static void exec_sentinel ();

extern EMACS_TIME timer_check ();
extern int timers_run;

325
/* Mask of bits indicating the descriptors that we wait for input on.  */
Jim Blandy's avatar
Jim Blandy committed
326

327 328
static SELECT_TYPE input_wait_mask;

329
/* Mask that excludes keyboard input descriptor(s).  */
330 331 332

static SELECT_TYPE non_keyboard_wait_mask;

333
/* Mask that excludes process input descriptor(s).  */
334 335 336

static SELECT_TYPE non_process_wait_mask;

337 338 339 340
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

341
#ifdef NON_BLOCKING_CONNECT
342 343 344 345 346 347 348 349 350
/* 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;

351 352 353 354 355
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

356 357 358
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

359 360
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
361

362 363 364
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

365 366
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
367 368

/* Indexed by descriptor, gives the process (if any) for that descriptor */
369
Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
370 371

/* Alist of elements (NAME . PROCESS) */
372
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
373 374 375 376 377 378 379

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

380 381
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
382

Karl Heuer's avatar
Karl Heuer committed
383
/* Table of `struct coding-system' for each process.  */
384 385
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
386

387 388 389 390 391 392 393
#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)
394
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
395 396 397 398 399
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

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

407
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
408 409 410
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
411
/* The file name of the pty opened by allocate_pty.  */
412 413

static char pty_name[24];
414
#endif
Jim Blandy's avatar
Jim Blandy committed
415 416 417 418

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

419
static Lisp_Object status_convert ();
420

421
static void
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425
update_status (p)
     struct Lisp_Process *p;
{
  union { int i; WAITTYPE wt; } u;
426 427
  eassert (p->raw_status_new);
  u.i = p->raw_status;
Jim Blandy's avatar
Jim Blandy committed
428
  p->status = status_convert (u.wt);
429
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
430 431
}

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

435
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
status_convert (w)
     WAITTYPE w;
{
  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.  */

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

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

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

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

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
494
      char *signame;
495
      synchronize_system_messages_locale ();
496
      signame = strsignal (code);
497 498 499
      if (signame == 0)
	signame = "unknown";
      string = build_string (signame);
Jim Blandy's avatar
Jim Blandy committed
500
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
501
      SSET (string, 0, DOWNCASE (SREF (string, 0)));
Jim Blandy's avatar
Jim Blandy committed
502 503 504 505
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
506 507
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
508 509
      if (code == 0)
	return build_string ("finished\n");
510
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
511
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
512 513
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
514
    }
515 516 517 518
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
519 520
      return concat3 (build_string ("failed with code "),
		      string, string2);
521
    }
Jim Blandy's avatar
Jim Blandy committed
522 523 524 525 526 527
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

528 529 530 531 532
/* 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.  */

533
static int
Jim Blandy's avatar
Jim Blandy committed
534 535
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
536
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
537 538 539 540 541 542 543 544 545
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
546
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551 552
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

553 554 555
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
	{
# ifdef IRIS
	  /* Unusual IRIS code */
	  *ptyv = emacs_open ("/dev/ptc", O_RDWR | O_NDELAY, 0);
	  if (fd < 0)
	    return -1;
	  if (fstat (fd, &stb) < 0)
	    return -1;
# else /* not IRIS */
	  { /* 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;
571

572 573 574 575 576 577 578 579
	    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
580
	  }
581 582 583 584 585 586 587
#  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
# endif /* not IRIS */
	}
588
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
589 590 591 592 593 594 595 596 597 598 599 600

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

625
  p = allocate_process ();
626

627 628 629 630
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
631
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
632
  p->pty_flag = 0;
633
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
634 635 636
  p->status = Qrun;
  p->mark = Fmake_marker ();

Kenichi Handa's avatar
Kenichi Handa committed
637
#ifdef ADAPTIVE_READ_BUFFERING
638 639 640
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
641 642
#endif

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

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

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

  deactivate_process (proc);
}
671 672 673 674 675 676 677 678

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
679 680
  int inch = p->infd;
  int outch = p->outfd;
Kenichi Handa's avatar
Kenichi Handa committed
681
  Lisp_Object coding_system;
682

683 684 685
  if (inch < 0 || outch < 0)
    return;

686 687 688
  if (!proc_decode_coding_system[inch])
    proc_decode_coding_system[inch]
      = (struct coding_system *) xmalloc (sizeof (struct coding_system));
Kenichi Handa's avatar
Kenichi Handa committed
689
  coding_system = p->decode_coding_system;
690 691
  if (! NILP (p->filter))
    {
692
      if (!p->filter_multibyte)
Kenichi Handa's avatar
Kenichi Handa committed
693
	coding_system = raw_text_coding_system (coding_system);
694 695 696 697
    }
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
Kenichi Handa's avatar
Kenichi Handa committed
698
	coding_system = raw_text_coding_system (coding_system);
699
    }
Kenichi Handa's avatar
Kenichi Handa committed
700
  setup_coding_system (coding_system, proc_decode_coding_system[inch]);
701 702 703 704 705 706 707

  if (!proc_encode_coding_system[outch])
    proc_encode_coding_system[outch]
      = (struct coding_system *) xmalloc (sizeof (struct coding_system));
  setup_coding_system (p->encode_coding_system,
		       proc_encode_coding_system[outch]);
}
Jim Blandy's avatar
Jim Blandy committed
708 709

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
710 711
       doc: /* Return t if OBJECT is a process.  */)
     (object)
712
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
713
{
714
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
715 716 717
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
718 719
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
720 721
     register Lisp_Object name;
{
722
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
723
    return name;
724
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
725 726 727 728
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
729 730 731
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
732
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
733 734 735
{
  register Lisp_Object buf, tail, proc;

736 737
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
738 739
  if (NILP (buf)) return Qnil;

740
  for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
741
    {
742
      proc = Fcdr (XCAR (tail));
743
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
744 745 746 747 748
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
749 750 751 752
/* 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
753

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

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
775
    {
776
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
777
      if (NILP (proc))
778
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
779 780
    }
  else
781
    {
782
      CHECK_PROCESS (obj);
783 784 785
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
786 787
}

788 789 790 791 792 793 794 795 796 797

#ifdef SIGCHLD
/* Fdelete_process promises to immediately forget about the process, but in
   reality, Emacs needs to remember those processes until they have been
   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
798
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
799 800 801 802
       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.  */)
     (process)
803
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
804
{
805 806
  register struct Lisp_Process *p;

807
  process = get_process (process);
808 809
  p = XPROCESS (process);

810
  p->raw_status_new = 0;
811
  if (NETCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
812
    {
813
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
814
      p->tick = ++process_tick;
815
      status_notify (p);
Jim Blandy's avatar
Jim Blandy committed
816
    }
817
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
818
    {
819 820
#ifdef SIGCHLD
      Lisp_Object symbol;
821 822
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
823
      EMACS_INT pid = p->pid;
824 825

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

874 875
  if (STRINGP (process))
    process = Fget_process (process);
876
  else
877
    process = get_process (process);
878

879 880
  if (NILP (process))
    return process;
881

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

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
902 903 904
       doc: /* Return the exit status of PROCESS or the signal number that killed it.
If PROCESS has not yet exited or died, return 0.  */)
     (process)
905
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
906
{
907
  CHECK_PROCESS (process);
908
  if (XPROCESS (process)->raw_status_new)
909 910
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
911
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
912 913 914 915
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
916
       doc: /* Return the process id of PROCESS.
917
This is the pid of the external process which PROCESS uses or talks to.
918 919
For a network connection, this value is nil.  */)
     (process)
920
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
921
{
922 923 924 925
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

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

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

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
943 944 945 946 947
       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.
For a non-child channel, this is nil.  */)
     (process)
948
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
949
{
950
  CHECK_PROCESS (process);
951
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
952 953
}

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

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

973
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
974
  if (!NILP (buffer))
975
    CHECK_BUFFER (buffer);
976 977 978 979
  p = XPROCESS (process);
  p->buffer = buffer;
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
980
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
981 982 983 984
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
985 986 987 988
       1, 1, 0,
       doc: /* Return the buffer PROCESS is associated with.
Output from PROCESS is inserted in this buffer unless PROCESS has a filter.  */)
     (process)
989
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
990
{
991
  CHECK_PROCESS (process);
992
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
993 994 995
}

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

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

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
1012
passed to the filter.
1013

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

1026
  CHECK_PROCESS (process);
1027 1028 1029 1030 1031 1032 1033 1034 1035
  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 ...)  */
1036

1037
  if (p->infd >= 0)
1038
    {
1039
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1040
	{
1041 1042
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1043
	}
1044 1045
      else if (EQ (p->filter, Qt)
	       && !EQ (p->command, Qt)) /* Network process not stopped. */
1046
	{
1047 1048
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1049
	}
1050
    }
1051

1052
  p->filter = filter;
1053 1054
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCfilter, filter);
1055
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1056 1057 1058 1059
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1060 1061 1062 1063
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
     (process)
1064
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1065
{
1066
  CHECK_PROCESS (process);
1067
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1068 1069 1070
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1071 1072 1073 1074 1075
       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.  */)
     (process, sentinel)
1076
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
1077
{
Kenichi Handa's avatar
Kenichi Handa committed
1078 1079
  struct Lisp_Process *p;

1080
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1081 1082 1083 1084 1085
  p = XPROCESS (process);

  p->sentinel = sentinel;
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1086 1087 1088 1089
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1090 1091 1092 1093
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
     (process)
1094
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1095
{
1096
  CHECK_PROCESS (process);
1097
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1098 1099
}

1100
DEFUN ("set-process-window-size", Fset_process_window_size,