process.c 213 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2 3
   Copyright (C) 1985, 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

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 24
#include <signal.h>

Jim Blandy's avatar
Jim Blandy committed
25 26 27 28 29 30 31 32
/* 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
33 34 35 36 37 38 39 40
#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>
41 42 43
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
44 45 46
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
47

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

Jim Blandy's avatar
Jim Blandy committed
53 54 55 56 57
#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>
58 59

/* Are local (unix) sockets supported?  */
60
#if defined (HAVE_SYS_UN_H)
61 62 63 64 65 66 67 68
#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
69 70
#endif /* HAVE_SOCKETS */

Dan Nicolaescu's avatar
Dan Nicolaescu committed
71
#if defined(BSD_SYSTEM)
Jim Blandy's avatar
Jim Blandy committed
72
#include <sys/ioctl.h>
73
#if !defined (O_NDELAY) && defined (HAVE_PTYS) && !defined(USG5)
Jim Blandy's avatar
Jim Blandy committed
74 75
#include <fcntl.h>
#endif /* HAVE_PTYS and no O_NDELAY */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
76
#endif /* BSD_SYSTEM */
Jim Blandy's avatar
Jim Blandy committed
77 78 79 80 81

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

Kenichi Handa's avatar
Kenichi Handa committed
82 83 84 85 86 87 88 89 90 91 92
/* 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

Dave Love's avatar
Dave Love committed
93 94 95
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
96

97 98 99 100 101 102
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

103
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
104
#include "systime.h"
105
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
106 107 108

#include "window.h"
#include "buffer.h"
109
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
110
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
111
#include "process.h"
112
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
113 114 115
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
116
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
117
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
118
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
119
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
120
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
121

122
Lisp_Object Qprocessp;
Kim F. Storm's avatar
Kim F. Storm committed
123
Lisp_Object Qrun, Qstop, Qsignal;
124
Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
Kim F. Storm's avatar
Kim F. Storm committed
125
Lisp_Object Qlocal, Qipv4, Qdatagram;
126
Lisp_Object Qreal, Qnetwork, Qserial;
Kim F. Storm's avatar
Kim F. Storm committed
127 128 129
#ifdef AF_INET6
Lisp_Object Qipv6;
#endif
130 131 132
Lisp_Object QCport, QCspeed, QCprocess;
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
133
Lisp_Object QCname, QCbuffer, QChost, QCservice, QCtype;
134
Lisp_Object QClocal, QCremote, QCcoding;
135
Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
136
Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
137
Lisp_Object Qlast_nonmenu_event;
138 139 140 141
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

144 145 146 147 148
/* 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
149
#ifdef HAVE_SOCKETS
150 151 152 153
#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
154 155
#else
#define NETCONN_P(p) 0
156
#define NETCONN1_P(p) 0
157 158
#define SERIALCONN_P(p) 0
#define SERIALCONN1_P(p) 0
Jim Blandy's avatar
Jim Blandy committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172
#endif /* HAVE_SOCKETS */

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

#include "syssignal.h"

Richard M. Stallman's avatar
Richard M. Stallman committed
173
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
174

175
extern char *get_operating_system_release ();
176

177 178 179 180 181 182 183 184 185 186 187
/* Serial processes require termios or Windows.  */
#if defined (HAVE_TERMIOS) || defined (WINDOWSNT)
#define HAVE_SERIAL
#endif

#ifdef HAVE_SERIAL
/* From sysdep.c or w32.c  */
extern int serial_open (char *port);
extern void serial_configure (struct Lisp_Process *p, Lisp_Object contact);
#endif

188
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
189
extern int errno;
190
#endif
Jim Blandy's avatar
Jim Blandy committed
191

192 193 194 195
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
196 197
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
198
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
199

200 201
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
202
/* Number of events of change of status of a process.  */
203
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
204
/* Number of events for which the user or sentinel has been notified.  */
205
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
206

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

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
/* 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 */

Kenichi Handa's avatar
Kenichi Handa committed
246 247 248 249 250 251 252 253 254 255 256
#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)

257 258
/* 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
259 260 261

static int process_output_delay_count;

262
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
263 264 265 266 267

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
268 269
   non-nil value does not reset the delay.  A value of nil disables
   adaptive read buffering completely.  */
Kenichi Handa's avatar
Kenichi Handa committed
270 271 272 273 274
static Lisp_Object Vprocess_adaptive_read_buffering;
#else
#define process_output_delay_count 0
#endif

275

276
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
277

278 279 280 281
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));
282

283
/* If we support a window system, turn on the code to poll periodically
284
   to detect C-g.  It isn't actually used when doing interrupt input.  */
285
#ifdef HAVE_WINDOW_SYSTEM
286 287 288
#define POLL_FOR_INPUT
#endif

289 290 291 292 293 294
static Lisp_Object get_process ();
static void exec_sentinel ();

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

297 298
static SELECT_TYPE input_wait_mask;

299
/* Mask that excludes keyboard input descriptor(s).  */
300 301 302

static SELECT_TYPE non_keyboard_wait_mask;

303
/* Mask that excludes process input descriptor(s).  */
304 305 306

static SELECT_TYPE non_process_wait_mask;

307 308 309 310
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

311
#ifdef NON_BLOCKING_CONNECT
312 313 314 315 316 317 318 319 320
/* 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;

321 322 323 324 325
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

326 327 328
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

329 330
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
331

332 333 334
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

335 336
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
337 338

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

/* Alist of elements (NAME . PROCESS) */
342
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
343 344 345 346 347 348 349

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

350 351
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
352

Karl Heuer's avatar
Karl Heuer committed
353
/* Table of `struct coding-system' for each process.  */
354 355
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
356

357 358 359 360 361 362 363
#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)
364
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
365 366 367 368 369
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

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

377
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
378 379 380
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
381
/* The file name of the pty opened by allocate_pty.  */
382 383

static char pty_name[24];
384
#endif
Jim Blandy's avatar
Jim Blandy committed
385 386 387 388

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

389
static Lisp_Object status_convert (int);
390

391
static void
Jim Blandy's avatar
Jim Blandy committed
392 393 394
update_status (p)
     struct Lisp_Process *p;
{
395
  eassert (p->raw_status_new);
396
  p->status = status_convert (p->raw_status);
397
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
398 399
}

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

403
static Lisp_Object
404
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
{
  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.  */

421
static void
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425 426 427 428 429
decode_status (l, symbol, code, coredump)
     Lisp_Object l;
     Lisp_Object *symbol;
     int *code;
     int *coredump;
{
  Lisp_Object tem;

430
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
431 432 433 434 435 436 437
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
438 439 440 441
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
442 443 444 445 446 447
      *coredump = !NILP (tem);
    }
}

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

448 449 450
static Lisp_Object
status_message (p)
     struct Lisp_Process *p;
Jim Blandy's avatar
Jim Blandy committed
451
{
452
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
453 454 455 456 457 458 459 460
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
461
      char *signame;
462
      synchronize_system_messages_locale ();
463
      signame = strsignal (code);
464 465 466
      if (signame == 0)
	signame = "unknown";
      string = build_string (signame);
Jim Blandy's avatar
Jim Blandy committed
467
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
468
      SSET (string, 0, DOWNCASE (SREF (string, 0)));
Jim Blandy's avatar
Jim Blandy committed
469 470 471 472
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
473 474
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
475 476
      if (code == 0)
	return build_string ("finished\n");
477
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
478
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
479 480
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
481
    }
482 483 484 485
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
486 487
      return concat3 (build_string ("failed with code "),
		      string, string2);
488
    }
Jim Blandy's avatar
Jim Blandy committed
489 490 491 492 493 494
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

495 496 497 498 499
/* 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.  */

500
static int
Jim Blandy's avatar
Jim Blandy committed
501 502
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
503
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
504 505 506 507 508 509 510 511 512
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
513
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
514 515 516 517 518 519
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

520 521 522
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
523 524 525 526 527 528 529
	{
	  { /* 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;
530

531 532 533 534 535 536 537 538
	    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
539
	  }
540 541 542 543 544 545
#  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
	}
546
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551 552 553 554 555 556 557 558

	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)
	      {
559
		emacs_close (fd);
560
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
561
		continue;
562
# else
Jim Blandy's avatar
Jim Blandy committed
563
		return -1;
564
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
565 566 567 568 569 570 571 572 573
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

574
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
575 576 577 578 579 580 581 582
make_process (name)
     Lisp_Object name;
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

583
  p = allocate_process ();
584

585 586 587 588
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
589
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
590
  p->pty_flag = 0;
591
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
592 593 594
  p->status = Qrun;
  p->mark = Fmake_marker ();

Kenichi Handa's avatar
Kenichi Handa committed
595
#ifdef ADAPTIVE_READ_BUFFERING
596 597 598
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
599 600
#endif

Jim Blandy's avatar
Jim Blandy committed
601 602 603 604 605 606 607 608 609 610 611 612
  /* 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;
613
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
614 615 616 617
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

618
static void
Jim Blandy's avatar
Jim Blandy committed
619 620 621 622 623 624 625 626 627 628
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);
}
629 630 631 632 633 634 635 636

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
637 638
  int inch = p->infd;
  int outch = p->outfd;
Kenichi Handa's avatar
Kenichi Handa committed
639
  Lisp_Object coding_system;
640

641 642 643
  if (inch < 0 || outch < 0)
    return;

644 645 646
  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
647
  coding_system = p->decode_coding_system;
648
  if (! NILP (p->filter))
649
    ;
650 651 652
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
Kenichi Handa's avatar
Kenichi Handa committed
653
	coding_system = raw_text_coding_system (coding_system);
654
    }
Kenichi Handa's avatar
Kenichi Handa committed
655
  setup_coding_system (coding_system, proc_decode_coding_system[inch]);
656 657 658 659 660 661 662

  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
663 664

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
665 666
       doc: /* Return t if OBJECT is a process.  */)
     (object)
667
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
668
{
669
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
670 671 672
}

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

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
684 685 686
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
687
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
688 689 690
{
  register Lisp_Object buf, tail, proc;

691 692
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
693 694
  if (NILP (buf)) return Qnil;

695
  for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
696
    {
697
      proc = Fcdr (XCAR (tail));
698
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
699 700 701 702 703
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
704 705 706 707
/* 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
708

709
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
710 711 712
get_process (name)
     register Lisp_Object name;
{
713 714 715 716 717 718 719
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
720
	error ("Process %s does not exist", SDATA (name));
721 722 723
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
724
  else
725 726 727 728 729
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
730
    {
731
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
732
      if (NILP (proc))
733
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
734 735
    }
  else
736
    {
737
      CHECK_PROCESS (obj);
738 739 740
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
741 742
}

743 744 745 746 747 748 749 750 751 752

#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
753
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
754 755 756 757
       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)
758
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
759
{
760 761
  register struct Lisp_Process *p;

762
  process = get_process (process);
763 764
  p = XPROCESS (process);

765
  p->raw_status_new = 0;
766
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
767
    {
768
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
769
      p->tick = ++process_tick;
770
      status_notify (p);
Jim Blandy's avatar
Jim Blandy committed
771
    }
772
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
773
    {
774 775
#ifdef SIGCHLD
      Lisp_Object symbol;
776 777
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
778
      EMACS_INT pid = p->pid;
779 780

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
781
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
782 783 784 785 786 787 788 789 790
				/* 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))
791 792
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
793 794 795 796 797 798 799
      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));
800
	  p->tick = ++process_tick;
801 802
	  status_notify (p);
	}
Jim Blandy's avatar
Jim Blandy committed
803
    }
804
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
805 806 807 808
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
809 810 811 812 813 814 815
       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.
816
listen -- for a network stream server that is listening.
817
closed -- for a network stream connection that is closed.
818 819
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
820 821 822 823
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)
824
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
825 826 827
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
828

829 830
  if (STRINGP (process))
    process = Fget_process (process);
831
  else
832
    process = get_process (process);
833

834 835
  if (NILP (process))
    return process;
836

837
  p = XPROCESS (process);
838
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
839 840
    update_status (p);
  status = p->status;
841
  if (CONSP (status))
842
    status = XCAR (status);
843
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
844
    {
845
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
846
	status = Qclosed;
847 848 849 850
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
851 852 853 854 855 856
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
857 858 859
       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)
860
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
861
{
862
  CHECK_PROCESS (process);
863
  if (XPROCESS (process)->raw_status_new)
864 865
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
866
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
867 868 869 870
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
871
       doc: /* Return the process id of PROCESS.
872
This is the pid of the external process which PROCESS uses or talks to.
873 874
For a network connection, this value is nil.  */)
     (process)
875
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
876
{
877 878 879 880
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

881
  CHECK_PROCESS (process);
882 883
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
884 885 886
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
887 888 889 890
       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)
891
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
892
{
893
  CHECK_PROCESS (process);
894
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
895 896 897
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
898 899 900
       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.
901 902
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
903
     (process)
904
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
905
{
906
  CHECK_PROCESS (process);
907
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
908 909
}

910
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
911 912 913 914
       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)
915
     register Lisp_Object process;
916
{
917
  CHECK_PROCESS (process);
918
  return XPROCESS (process)->tty_name;
919 920
}

Jim Blandy's avatar
Jim Blandy committed
921
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
922 923 924
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
925
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
926
{
927 928
  struct Lisp_Process *p;

929
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
930
  if (!NILP (buffer))
931
    CHECK_BUFFER (buffer);
932 933
  p = XPROCESS (process);
  p->buffer = buffer;
934
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
935
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
936
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
937 938 939 940
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
941 942 943 944
       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)
945
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
946
{
947
  CHECK_PROCESS (process);
948
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
949 950 951
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
952 953 954
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
955
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
956
{
957
  CHECK_PROCESS (process);
958
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
959 960 961
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
962 963
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
964
A value of t means stop accepting output from the process.
965 966 967

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
968
passed to the filter.
969

970
The filter gets two arguments: the process and the string of output.
971 972 973 974 975 976
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').  */)
977
     (process, filter)
978
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
979
{
980
  struct Lisp_Process *p;
981

982
  CHECK_PROCESS (process);
983 984 985 986 987 988 989 990 991
  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 ...)  */
992

993
  if (p->infd >= 0)
994
    {
995
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
996
	{
997 998
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
999
	}
1000
      else if (EQ (p->filter, Qt)
1001 1002
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
1003
	{
1004 1005
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1006
	}
1007
    }
1008

1009
  p->filter = filter;
1010
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
1011
    p->childp = Fplist_put (p->childp, QCfilter, filter);
1012
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1013 1014 1015 1016
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1017 1018 1019 1020
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
     (process)
1021
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1022
{
1023
  CHECK_PROCESS (process);
1024
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1025 1026 1027
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1028 1029 1030 1031 1032
       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)
1033
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
1034
{
Kenichi Handa's avatar
Kenichi Handa committed
1035 1036
  struct Lisp_Process *p;

1037
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1038 1039 1040
  p = XPROCESS (process);

  p->sentinel = sentinel;
1041
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
1042
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1043 1044 1045 1046
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1047 1048 1049 1050
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
     (process)
1051
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1052
{
1053
  CHECK_PROCESS (process);
1054
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1055 1056
}

1057
DEFUN ("set-process-window-size", Fset_process_window_size,
1058 1059 1060
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
     (process, height, width)
1061
     register Lisp_Object process, height, width;
1062
{
1063 1064 1065
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
1066

1067 1068
  if (XPROCESS (process)->infd < 0
      || set_window_size (XPROCESS (process)->infd,
1069
			  XINT (height), XINT (width)) <= 0)
1070 1071 1072 1073 1074
    return Qnil;
  else
    return Qt;
}

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