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

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
23 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(HAVE_SYS_IOCTL_H)
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 /* HAVE_SYS_IOCTL_H */
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;
Stefan Monnier's avatar
Stefan Monnier committed
130
Lisp_Object Qlocal, Qipv4, Qdatagram, Qseqpacket;
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 199 200 201
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
202 203
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
204
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
205

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

213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
/* 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 */

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

Stefan Monnier's avatar
Stefan Monnier committed
252 253 254 255
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

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 292
static int keyboard_bit_set (SELECT_TYPE *);
static void deactivate_process (Lisp_Object);
static void status_notify (struct Lisp_Process *);
static int read_process_output (Lisp_Object, int);
static void create_pty (Lisp_Object);
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
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
302 303 304

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
402
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
403
{
404
  eassert (p->raw_status_new);
405
  p->status = status_convert (p->raw_status);
406
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
407 408
}

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

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

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

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

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

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

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

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

510 511 512 513 514
/* 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.  */

515
static int
516
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
517
{
Andreas Schwab's avatar
Andreas Schwab committed
518
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
519 520 521 522 523 524 525 526 527
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
528
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
529 530 531 532 533 534
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

535 536 537
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
538 539 540 541 542 543 544
	{
	  { /* 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;
545

546 547 548 549 550 551 552 553
	    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
554
	  }
555 556 557 558 559 560
#  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
	}
561
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
562 563 564 565 566 567 568 569

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

597
  p = allocate_process ();
598

599 600 601 602
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
603
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
604
  p->pty_flag = 0;
605
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
606 607
  p->status = Qrun;
  p->mark = Fmake_marker ();
608
  p->kill_without_query = 0;
Jim Blandy's avatar
Jim Blandy committed
609

Kenichi Handa's avatar
Kenichi Handa committed
610
#ifdef ADAPTIVE_READ_BUFFERING
611 612 613
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
614 615
#endif

Jim Blandy's avatar
Jim Blandy committed
616 617 618 619 620 621 622 623 624 625 626 627
  /* 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;
628
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
629 630 631 632
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

633
static void
634
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638 639 640 641 642
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
643 644 645 646

/* Setup coding systems of PROCESS.  */

void
647
setup_process_coding_systems (Lisp_Object process)
648 649
{
  struct Lisp_Process *p = XPROCESS (process);
650 651
  int inch = p->infd;
  int outch = p->outfd;
Kenichi Handa's avatar
Kenichi Handa committed
652
  Lisp_Object coding_system;
653

654 655 656
  if (inch < 0 || outch < 0)
    return;

657 658 659
  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
660
  coding_system = p->decode_coding_system;
661
  if (! NILP (p->filter))
662
    ;
663 664 665
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
Kenichi Handa's avatar
Kenichi Handa committed
666
	coding_system = raw_text_coding_system (coding_system);
667
    }
Kenichi Handa's avatar
Kenichi Handa committed
668
  setup_coding_system (coding_system, proc_decode_coding_system[inch]);
669 670 671 672 673 674 675

  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
676 677

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
678 679
       doc: /* Return t if OBJECT is a process.  */)
     (object)
680
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
681
{
682
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
683 684 685
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
686 687
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
688 689
     register Lisp_Object name;
{
690
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
691
    return name;
692
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
693 694 695 696
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
697 698 699
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
700
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
701 702 703
{
  register Lisp_Object buf, tail, proc;

704 705
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
706 707
  if (NILP (buf)) return Qnil;

708
  for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
709
    {
710
      proc = Fcdr (XCAR (tail));
711
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
712 713 714 715 716
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
717 718 719 720
/* 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
721

722
static Lisp_Object
723
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
724
{
725 726 727 728 729 730 731
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
732
	error ("Process %s does not exist", SDATA (name));
733 734 735
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
736
  else
737 738 739 740 741
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
742
    {
743
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
744
      if (NILP (proc))
745
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
746 747
    }
  else
748
    {
749
      CHECK_PROCESS (obj);
750 751 752
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
753 754
}

755 756 757 758 759 760 761 762 763 764

#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
765
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
766 767 768 769
       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)
770
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
771
{
772 773
  register struct Lisp_Process *p;

774
  process = get_process (process);
775 776
  p = XPROCESS (process);

777
  p->raw_status_new = 0;
778
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
779
    {
780
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
781
      p->tick = ++process_tick;
782
      status_notify (p);
783
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
784
    }
785
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
786
    {
787 788
#ifdef SIGCHLD
      Lisp_Object symbol;
789 790
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
791
      EMACS_INT pid = p->pid;
792 793

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

843 844
  if (STRINGP (process))
    process = Fget_process (process);
845
  else
846
    process = get_process (process);
847

848 849
  if (NILP (process))
    return process;
850

851
  p = XPROCESS (process);
852
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
853 854
    update_status (p);
  status = p->status;
855
  if (CONSP (status))
856
    status = XCAR (status);
857
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
858
    {
859
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
860
	status = Qclosed;
861 862 863 864
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
865 866 867 868 869 870
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
871 872 873
       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)
874
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
875
{
876
  CHECK_PROCESS (process);
877
  if (XPROCESS (process)->raw_status_new)
878 879
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
880
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
881 882 883 884
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
885
       doc: /* Return the process id of PROCESS.
886
This is the pid of the external process which PROCESS uses or talks to.
887 888
For a network connection, this value is nil.  */)
     (process)
889
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
890
{
891 892 893 894
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

895
  CHECK_PROCESS (process);
896 897
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
898 899 900
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
901 902 903 904
       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)
905
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
906
{
907
  CHECK_PROCESS (process);
908
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
909 910 911
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
912 913 914
       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.
915 916
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
917
     (process)
918
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
919
{
920
  CHECK_PROCESS (process);
921
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
922 923
}

924
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
925 926 927 928
       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)
929
     register Lisp_Object process;
930
{
931
  CHECK_PROCESS (process);
932
  return XPROCESS (process)->tty_name;
933 934
}

Jim Blandy's avatar
Jim Blandy committed
935
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
936 937 938
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
939
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
940
{
941 942
  struct Lisp_Process *p;

943
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
944
  if (!NILP (buffer))
945
    CHECK_BUFFER (buffer);
946 947
  p = XPROCESS (process);
  p->buffer = buffer;
948
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
949
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
950
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
951 952 953 954
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
955 956 957 958
       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)
959
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
960
{
961
  CHECK_PROCESS (process);
962
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
963 964 965
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
966 967 968
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
969
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
970
{
971
  CHECK_PROCESS (process);
972
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
973 974 975
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
976 977
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
978
A value of t means stop accepting output from the process.
979 980 981

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
982
passed to the filter.
983

984
The filter gets two arguments: the process and the string of output.
985 986 987 988 989 990
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').  */)
991
     (process, filter)
992
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
993
{
994
  struct Lisp_Process *p;
995

996
  CHECK_PROCESS (process);
997 998 999 1000 1001 1002 1003 1004 1005
  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 ...)  */
1006

1007
  if (p->infd >= 0)
1008
    {
1009
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1010
	{
1011 1012
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1013
	}
1014
      else if (EQ (p->filter, Qt)
1015 1016
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
1017
	{
1018 1019
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1020
	}
1021
    }
1022