process.c 230 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(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;
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
#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 */

Stefan Monnier's avatar
Stefan Monnier committed
256 257 258 259
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
260 261 262 263 264 265 266 267 268 269 270
#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)

271 272
/* 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
273 274 275

static int process_output_delay_count;

276
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
277 278 279 280 281

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

289

290
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
291

292 293 294 295
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
296
static void create_pty P_ ((Lisp_Object));
297

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

304 305 306 307 308
static Lisp_Object get_process ();
static void exec_sentinel ();

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

311 312
static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

317
/* Mask that excludes process input descriptor(s).  */
318 319 320

static SELECT_TYPE non_process_wait_mask;

321 322 323 324
/* Mask for the gpm mouse input descriptor.  */

static SELECT_TYPE gpm_wait_mask;

325
#ifdef NON_BLOCKING_CONNECT
326 327 328 329 330 331 332 333 334
/* 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;

335 336 337 338 339
#define IF_NON_BLOCKING_CONNECT(s) s
#else
#define IF_NON_BLOCKING_CONNECT(s)
#endif

340 341 342
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

343 344
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
345

346 347 348
/* The largest descriptor currently in use for gpm mouse input.  */
static int max_gpm_desc;

349 350 351
/* Non-zero if keyboard input is on hold, zero otherwise.  */
static int kbd_is_on_hold;

352 353
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
354 355

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

/* Alist of elements (NAME . PROCESS) */
359
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
360 361 362 363 364 365 366

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

367 368
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
369

Karl Heuer's avatar
Karl Heuer committed
370
/* Table of `struct coding-system' for each process.  */
371 372
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
373

374 375 376 377 378 379 380
#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)
381
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
382 383 384 385 386
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

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

394
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
395 396 397
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
398
/* The file name of the pty opened by allocate_pty.  */
399 400

static char pty_name[24];
401
#endif
Jim Blandy's avatar
Jim Blandy committed
402 403 404 405

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

406
static Lisp_Object status_convert (int);
407

408
static void
Jim Blandy's avatar
Jim Blandy committed
409 410 411
update_status (p)
     struct Lisp_Process *p;
{
412
  eassert (p->raw_status_new);
413
  p->status = status_convert (p->raw_status);
414
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
415 416
}

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

420
static Lisp_Object
421
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
{
  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.  */

438
static void
Jim Blandy's avatar
Jim Blandy committed
439 440 441 442 443 444 445 446
decode_status (l, symbol, code, coredump)
     Lisp_Object l;
     Lisp_Object *symbol;
     int *code;
     int *coredump;
{
  Lisp_Object tem;

447
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
448 449 450 451 452 453 454
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
455 456 457 458
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
459 460 461 462 463 464
      *coredump = !NILP (tem);
    }
}

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

465 466 467
static Lisp_Object
status_message (p)
     struct Lisp_Process *p;
Jim Blandy's avatar
Jim Blandy committed
468
{
469
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
470 471 472 473 474 475 476 477
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

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

523 524 525 526 527
/* 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.  */

528
static int
Jim Blandy's avatar
Jim Blandy committed
529 530
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
531
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538 539 540
  int fd;

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

548 549 550
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
551 552 553 554 555 556 557
	{
	  { /* 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;
558

559 560 561 562 563 564 565 566
	    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
567
	  }
568 569 570 571 572 573
#  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
	}
574
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
575 576 577 578 579 580 581 582

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

611
  p = allocate_process ();
612

613 614 615 616
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
617
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
618
  p->pty_flag = 0;
619
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
620 621
  p->status = Qrun;
  p->mark = Fmake_marker ();
622
  p->kill_without_query = 0;
Jim Blandy's avatar
Jim Blandy committed
623

Kenichi Handa's avatar
Kenichi Handa committed
624
#ifdef ADAPTIVE_READ_BUFFERING
625 626 627
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
628 629
#endif

Jim Blandy's avatar
Jim Blandy committed
630 631 632 633 634 635 636 637 638 639 640 641
  /* 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;
642
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
643 644 645 646
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

647
static void
Jim Blandy's avatar
Jim Blandy committed
648 649 650 651 652 653 654 655 656 657
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);
}
658 659 660 661 662 663 664 665

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
666 667
  int inch = p->infd;
  int outch = p->outfd;
Kenichi Handa's avatar
Kenichi Handa committed
668
  Lisp_Object coding_system;
669

670 671 672
  if (inch < 0 || outch < 0)
    return;

673 674 675
  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
676
  coding_system = p->decode_coding_system;
677
  if (! NILP (p->filter))
678
    ;
679 680 681
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
Kenichi Handa's avatar
Kenichi Handa committed
682
	coding_system = raw_text_coding_system (coding_system);
683
    }
Kenichi Handa's avatar
Kenichi Handa committed
684
  setup_coding_system (coding_system, proc_decode_coding_system[inch]);
685 686 687 688 689 690 691

  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
692 693

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
694 695
       doc: /* Return t if OBJECT is a process.  */)
     (object)
696
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
697
{
698
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
699 700 701
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
702 703
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
704 705
     register Lisp_Object name;
{
706
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
707
    return name;
708
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
709 710 711 712
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
713 714 715
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
716
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
717 718 719
{
  register Lisp_Object buf, tail, proc;

720 721
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
722 723
  if (NILP (buf)) return Qnil;

724
  for (tail = Vprocess_alist; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
725
    {
726
      proc = Fcdr (XCAR (tail));
727
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
728 729 730 731 732
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
733 734 735 736
/* 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
737

738
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
739 740 741
get_process (name)
     register Lisp_Object name;
{
742 743 744 745 746 747 748
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
749
	error ("Process %s does not exist", SDATA (name));
750 751 752
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
753
  else
754 755 756 757 758
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
759
    {
760
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
761
      if (NILP (proc))
762
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
763 764
    }
  else
765
    {
766
      CHECK_PROCESS (obj);
767 768 769
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
770 771
}

772 773 774 775 776 777 778 779 780 781

#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
782
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
783 784 785 786
       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)
787
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
788
{
789 790
  register struct Lisp_Process *p;

791
  process = get_process (process);
792 793
  p = XPROCESS (process);

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

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

860 861
  if (STRINGP (process))
    process = Fget_process (process);
862
  else
863
    process = get_process (process);
864

865 866
  if (NILP (process))
    return process;
867

868
  p = XPROCESS (process);
869
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
870 871
    update_status (p);
  status = p->status;
872
  if (CONSP (status))
873
    status = XCAR (status);
874
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
875
    {
876
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
877
	status = Qclosed;
878 879 880 881
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
882 883 884 885 886 887
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
888 889 890
       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)
891
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
892
{
893
  CHECK_PROCESS (process);
894
  if (XPROCESS (process)->raw_status_new)
895 896
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
897
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
898 899 900 901
  return make_number (0);
}

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

912
  CHECK_PROCESS (process);
913 914
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
915 916 917
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
918 919 920 921
       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)
922
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
923
{
924
  CHECK_PROCESS (process);
925
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
926 927 928
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
929 930 931
       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.
932 933
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
934
     (process)
935
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
936
{
937
  CHECK_PROCESS (process);
938
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
939 940
}

941
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
942 943 944 945
       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)
946
     register Lisp_Object process;
947
{
948
  CHECK_PROCESS (process);
949
  return XPROCESS (process)->tty_name;
950 951
}

Jim Blandy's avatar
Jim Blandy committed
952
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
953 954 955
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
956
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
957
{
958 959
  struct Lisp_Process *p;

960
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
961
  if (!NILP (buffer))
962
    CHECK_BUFFER (buffer);
963 964
  p = XPROCESS (process);
  p->buffer = buffer;
965
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
966
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
967
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
968 969 970 971
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
972 973 974 975
       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)
976
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
977
{
978
  CHECK_PROCESS (process);
979
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
980 981 982
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
983 984 985
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
986
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
987
{
988
  CHECK_PROCESS (process);
989
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
990 991 992
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
993 994
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
995
A value of t means stop accepting output from the process.
996 997 998

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
999
passed to the filter.
1000

1001
The filter gets two arguments: the process and the string of output.
1002 1003 1004 1005 1006 1007
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').  */)
1008
     (process, filter)
1009
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
1010
{
1011
  struct Lisp_Process *p;
1012

1013
  CHECK_PROCESS (process);
1014 1015 1016 1017 1018 1019 1020 1021 1022
  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 ...)  */
1023

1024
  if (p->infd >= 0)
1025
    {
1026
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1027
	{
1028 1029
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1030
	}
1031
      else if (EQ (p->filter, Qt)
1032 1033
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
1034
	{
1035 1036
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1037
	}
1038
    }
1039

1040
  p->filter = filter;
1041
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
1042
    p->childp = Fplist_put (p->childp, QCfilter, filter);
1043
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1044 1045 1046 1047
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1048 1049 1050 1051
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
     (process)
1052
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
1053
{
1054
  CHECK_PROCESS (process);
1055
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1056 1057 1058
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1059 1060 1061 1062 1063
       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)
1064
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
1065
{
Kenichi Handa's avatar
Kenichi Handa committed
1066 1067
  struct Lisp_Process *p;

1068
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1069 1070 1071
  p = XPROCESS (process);

  p->sentinel = sentinel;