process.c 228 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,
4
		 2005, 2006, 2007, 2008, 2009 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
#include <setjmp.h>
42 43 44
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
45 46 47
#ifdef STDC_HEADERS
#include <stdlib.h>
#endif
48

Richard M. Stallman's avatar
Richard M. Stallman committed
49 50 51
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
52 53
#include <fcntl.h>

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

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
83 84 85 86 87 88 89 90 91 92 93
/* 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
94 95 96
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
97

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

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

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

123 124 125 126
#if defined (USE_GTK) || defined (HAVE_GCONF)
#include "xgselect.h"
#endif /* defined (USE_GTK) || defined (HAVE_GCONF) */

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

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

149 150 151 152 153
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

154 155 156
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;
157
Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
158

Jim Blandy's avatar
Jim Blandy committed
159
#ifdef HAVE_SOCKETS
160 161 162 163
#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
164 165
#else
#define NETCONN_P(p) 0
166
#define NETCONN1_P(p) 0
167 168
#define SERIALCONN_P(p) 0
#define SERIALCONN1_P(p) 0
Jim Blandy's avatar
Jim Blandy committed
169 170 171 172 173 174 175 176 177 178 179 180 181 182
#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
183
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
184

185
extern char *get_operating_system_release ();
186

187 188 189 190 191 192 193 194 195 196 197
/* 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

198
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
199
extern int errno;
200
#endif
Jim Blandy's avatar
Jim Blandy committed
201

202 203 204 205
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
206 207
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
208
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
209

210 211
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
212
/* Number of events of change of status of a process.  */
213
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
214
/* Number of events for which the user or sentinel has been notified.  */
215
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
216

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
/* 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 */

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
/* 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
256 257 258 259 260 261 262 263 264 265 266
#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)

267 268
/* 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
269 270 271

static int process_output_delay_count;

272
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
273 274 275 276 277

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
278 279
   non-nil value does not reset the delay.  A value of nil disables
   adaptive read buffering completely.  */
Kenichi Handa's avatar
Kenichi Handa committed
280 281 282 283 284
static Lisp_Object Vprocess_adaptive_read_buffering;
#else
#define process_output_delay_count 0
#endif

285

286
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
287

288 289 290 291
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));
Nick Roberts's avatar
Nick Roberts committed
292
static void create_pty P_ ((Lisp_Object));
293

294
/* If we support a window system, turn on the code to poll periodically
295
   to detect C-g.  It isn't actually used when doing interrupt input.  */
296
#ifdef HAVE_WINDOW_SYSTEM
297 298 299
#define POLL_FOR_INPUT
#endif

300 301 302 303 304
static Lisp_Object get_process ();
static void exec_sentinel ();

extern int timers_run;

305
/* Mask of bits indicating the descriptors that we wait for input on.  */
Jim Blandy's avatar
Jim Blandy committed
306

307 308
static SELECT_TYPE input_wait_mask;

309
/* Mask that excludes keyboard input descriptor(s).  */
310 311 312

static SELECT_TYPE non_keyboard_wait_mask;

313
/* Mask that excludes process input descriptor(s).  */
314 315 316

static SELECT_TYPE non_process_wait_mask;

317 318 319 320
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

321
#ifdef NON_BLOCKING_CONNECT
322 323 324 325 326 327 328 329 330
/* 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;

331 332 333 334 335
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

336 337 338
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

339 340
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
341

342 343 344
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

345 346
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
347 348

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

/* Alist of elements (NAME . PROCESS) */
352
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
353 354 355 356 357 358 359

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

360 361
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
362

Karl Heuer's avatar
Karl Heuer committed
363
/* Table of `struct coding-system' for each process.  */
364 365
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
366

367 368 369 370 371 372 373
#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)
374
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
375 376 377 378 379
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

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

387
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
388 389 390
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
391
/* The file name of the pty opened by allocate_pty.  */
392 393

static char pty_name[24];
394
#endif
Jim Blandy's avatar
Jim Blandy committed
395 396 397 398

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

399
static Lisp_Object status_convert (int);
400

401
static void
Jim Blandy's avatar
Jim Blandy committed
402 403 404
update_status (p)
     struct Lisp_Process *p;
{
405
  eassert (p->raw_status_new);
406
  p->status = status_convert (p->raw_status);
407
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
408 409
}

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

413
static Lisp_Object
414
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
{
  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.  */

431
static void
Jim Blandy's avatar
Jim Blandy committed
432 433 434 435 436 437 438 439
decode_status (l, symbol, code, coredump)
     Lisp_Object l;
     Lisp_Object *symbol;
     int *code;
     int *coredump;
{
  Lisp_Object tem;

440
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
441 442 443 444 445 446 447
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
448 449 450 451
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
452 453 454 455 456 457
      *coredump = !NILP (tem);
    }
}

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

458 459 460
static Lisp_Object
status_message (p)
     struct Lisp_Process *p;
Jim Blandy's avatar
Jim Blandy committed
461
{
462
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
463 464 465 466 467 468 469 470
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

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

516 517 518 519 520
/* 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.  */

521
static int
Jim Blandy's avatar
Jim Blandy committed
522 523
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
524
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
525 526 527 528 529 530 531 532 533
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
534
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
535 536 537 538 539 540
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

541 542 543
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
544 545 546 547 548 549 550
	{
	  { /* 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;
551

552 553 554 555 556 557 558 559
	    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
560
	  }
561 562 563 564 565 566
#  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
	}
567
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
568 569 570 571 572 573 574 575

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

604
  p = allocate_process ();
605

606 607 608 609
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
610
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
611
  p->pty_flag = 0;
612
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
613 614
  p->status = Qrun;
  p->mark = Fmake_marker ();
615
  p->kill_without_query = 0;
Jim Blandy's avatar
Jim Blandy committed
616

Kenichi Handa's avatar
Kenichi Handa committed
617
#ifdef ADAPTIVE_READ_BUFFERING
618 619 620
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
621 622
#endif

Jim Blandy's avatar
Jim Blandy committed
623 624 625 626 627 628 629 630 631 632 633 634
  /* 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;
635
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
636 637 638 639
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

640
static void
Jim Blandy's avatar
Jim Blandy committed
641 642 643 644 645 646 647 648 649 650
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);
}
651 652 653 654 655 656 657 658

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
659 660
  int inch = p->infd;
  int outch = p->outfd;
Kenichi Handa's avatar
Kenichi Handa committed
661
  Lisp_Object coding_system;
662

663 664 665
  if (inch < 0 || outch < 0)
    return;

666 667 668
  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
669
  coding_system = p->decode_coding_system;
670
  if (! NILP (p->filter))
671
    ;
672 673 674
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
Kenichi Handa's avatar
Kenichi Handa committed
675
	coding_system = raw_text_coding_system (coding_system);
676
    }
Kenichi Handa's avatar
Kenichi Handa committed
677
  setup_coding_system (coding_system, proc_decode_coding_system[inch]);
678 679 680 681 682 683 684

  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
685 686

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
687 688
       doc: /* Return t if OBJECT is a process.  */)
     (object)
689
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
690
{
691
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
692 693 694
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
695 696
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
697 698
     register Lisp_Object name;
{
699
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
700
    return name;
701
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
702 703 704 705
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
706 707 708
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
709
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
710 711 712
{
  register Lisp_Object buf, tail, proc;

713 714
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
715 716
  if (NILP (buf)) return Qnil;

717
  for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
718
    {
719
      proc = Fcdr (XCAR (tail));
720
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
721 722 723 724 725
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
726 727 728 729
/* 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
730

731
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
732 733 734
get_process (name)
     register Lisp_Object name;
{
735 736 737 738 739 740 741
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
742
	error ("Process %s does not exist", SDATA (name));
743 744 745
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
746
  else
747 748 749 750 751
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
752
    {
753
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
754
      if (NILP (proc))
755
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
756 757
    }
  else
758
    {
759
      CHECK_PROCESS (obj);
760 761 762
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
763 764
}

765 766 767 768 769 770 771 772 773 774

#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
775
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
776 777 778 779
       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)
780
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
781
{
782 783
  register struct Lisp_Process *p;

784
  process = get_process (process);
785 786
  p = XPROCESS (process);

787
  p->raw_status_new = 0;
788
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
789
    {
790
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
791
      p->tick = ++process_tick;
792
      status_notify (p);
793
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
794
    }
795
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
796
    {
797 798
#ifdef SIGCHLD
      Lisp_Object symbol;
799 800
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
801
      EMACS_INT pid = p->pid;
802 803

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
804
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
805 806 807 808 809 810 811 812 813
				/* 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))
814 815
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
816 817 818 819 820 821 822
      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));
823
	  p->tick = ++process_tick;
824
	  status_notify (p);
825
	  redisplay_preserve_echo_area (13);
826
	}
Jim Blandy's avatar
Jim Blandy committed
827
    }
828
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
829 830 831 832
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
833 834 835 836 837 838 839
       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.
840
listen -- for a network stream server that is listening.
841
closed -- for a network stream connection that is closed.
842 843
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
844 845 846 847
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)
848
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
849 850 851
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
852

853 854
  if (STRINGP (process))
    process = Fget_process (process);
855
  else
856
    process = get_process (process);
857

858 859
  if (NILP (process))
    return process;
860

861
  p = XPROCESS (process);
862
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
863 864
    update_status (p);
  status = p->status;
865
  if (CONSP (status))
866
    status = XCAR (status);
867
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
868
    {
869
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
870
	status = Qclosed;
871 872 873 874
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
875 876 877 878 879 880
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
881 882 883
       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)
884
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
885
{
886
  CHECK_PROCESS (process);
887
  if (XPROCESS (process)->raw_status_new)
888 889
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
890
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
891 892 893 894
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
895
       doc: /* Return the process id of PROCESS.
896
This is the pid of the external process which PROCESS uses or talks to.
897 898
For a network connection, this value is nil.  */)
     (process)
899
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
900
{
901 902 903 904
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

905
  CHECK_PROCESS (process);
906 907
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
908 909 910
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
911 912 913 914
       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)
915
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
916
{
917
  CHECK_PROCESS (process);
918
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
919 920 921
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
922 923 924
       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.
925 926
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
927
     (process)
928
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
929
{
930
  CHECK_PROCESS (process);
931
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
932 933
}

934
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
935 936 937 938
       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)
939
     register Lisp_Object process;
940
{
941
  CHECK_PROCESS (process);
942
  return XPROCESS (process)->tty_name;
943 944
}

Jim Blandy's avatar
Jim Blandy committed
945
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
946 947 948
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
949
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
950
{
951 952
  struct Lisp_Process *p;

953
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
954
  if (!NILP (buffer))
955
    CHECK_BUFFER (buffer);
956 957
  p = XPROCESS (process);
  p->buffer = buffer;
958
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
959
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
960
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
961 962 963 964
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
965 966 967 968
       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)
969
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
970
{
971
  CHECK_PROCESS (process);
972
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
973 974 975
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
976 977 978
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
979
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
980
{
981
  CHECK_PROCESS (process);
982
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
983 984 985
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
986 987
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
988
A value of t means stop accepting output from the process.
989 990 991

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
992
passed to the filter.
993

994
The filter gets two arguments: the process and the string of output.
995 996 997 998 999 1000
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').  */)
1001
     (process, filter)
1002
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
1003
{
1004
  struct Lisp_Process *p;
1005

1006
  CHECK_PROCESS (process);
1007 1008 1009 1010 1011 1012 1013 1014 1015
  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 ...)  */
1016

1017
  if (p->infd >= 0)
1018
    {
1019
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1020
	{
1021 1022
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1023
	}
1024
      else if (EQ (p->filter, Qt)
1025 1026
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
1027
	{
1028 1029
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1030
	}
1031
    }
1032

1033
  p->filter = filter;
1034
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
1035
    p->childp = Fplist_put (p->childp, QCfilter, filter);
1036
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1037 1038 1039 1040
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1041 1042 1043 1044
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
     (process)
1045
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1046
{
1047
  CHECK_PROCESS (process);
1048
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1049 1050 1051
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1052 1053 1054 1055 1056
       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)
1057
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
1058
{
Kenichi Handa's avatar
Kenichi Handa committed
1059 1060
  struct Lisp_Process *p;

1061
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1062 1063 1064
  p = XPROCESS (process);

  p->sentinel = sentinel;
1065
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
1066
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1067 1068 1069 1070
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,