process.c 219 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
#include <signal.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 27 28 29
#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>
30
#include <setjmp.h>
31 32 33
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
34

Richard M. Stallman's avatar
Richard M. Stallman committed
35 36 37
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
38 39
#include <fcntl.h>

40 41 42
/* Only MS-DOS does not define `subprocesses'.  */
#ifdef subprocesses

Jim Blandy's avatar
Jim Blandy committed
43 44 45 46
#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
47 48

/* Are local (unix) sockets supported?  */
49
#if defined (HAVE_SYS_UN_H)
50 51 52 53 54 55 56 57
#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
58

Dan Nicolaescu's avatar
Dan Nicolaescu committed
59
#if defined(HAVE_SYS_IOCTL_H)
Jim Blandy's avatar
Jim Blandy committed
60
#include <sys/ioctl.h>
61 62 63
#if defined(HAVE_NET_IF_H)
#include <net/if.h>
#endif /* HAVE_NET_IF_H */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
64
#endif /* HAVE_SYS_IOCTL_H */
Jim Blandy's avatar
Jim Blandy committed
65 66 67 68 69

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

70 71 72 73 74 75
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

76 77 78 79
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
80 81 82 83
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

84 85
#endif	/* subprocesses */

86
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
87
#include "systime.h"
88
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
89 90 91

#include "window.h"
#include "buffer.h"
92
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
93
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
94
#include "process.h"
95
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
96 97 98
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
99
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
100
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
101
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
102
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
103
#include "atimer.h"
104 105 106
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
107 108 109
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
110

111 112 113
#if defined (USE_GTK) || defined (HAVE_GCONF)
#include "xgselect.h"
#endif /* defined (USE_GTK) || defined (HAVE_GCONF) */
114 115 116
#ifdef HAVE_NS
#include "nsterm.h"
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
117

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
extern int timers_run;

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;
Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
Lisp_Object QCname, QCtype;

/* Non-zero if keyboard input is on hold, zero otherwise.  */

static int kbd_is_on_hold;

/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;

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

137 138
#ifdef subprocesses

139
Lisp_Object Qprocessp;
Kim F. Storm's avatar
Kim F. Storm committed
140
Lisp_Object Qrun, Qstop, Qsignal;
141
Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
Stefan Monnier's avatar
Stefan Monnier committed
142
Lisp_Object Qlocal, Qipv4, Qdatagram, Qseqpacket;
143
Lisp_Object Qreal, Qnetwork, Qserial;
Kim F. Storm's avatar
Kim F. Storm committed
144 145 146
#ifdef AF_INET6
Lisp_Object Qipv6;
#endif
147 148 149
Lisp_Object QCport, QCspeed, QCprocess;
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
150
Lisp_Object QCbuffer, QChost, QCservice;
151
Lisp_Object QClocal, QCremote, QCcoding;
152
Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
153
Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
154
Lisp_Object Qlast_nonmenu_event;
155 156 157 158
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

161 162 163 164 165
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

166 167 168 169
#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
170 171 172 173

/* Define first descriptor number available for subprocesses.  */
#define FIRST_PROC_DESC 3

174
extern const char *get_operating_system_release (void);
175

176 177 178 179
/* From sysdep.c or w32.c  */
extern int serial_open (char *port);
extern void serial_configure (struct Lisp_Process *p, Lisp_Object contact);

180 181 182 183
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
184 185
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
186
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
187

188 189
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
190
/* Number of events of change of status of a process.  */
191
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
192
/* Number of events for which the user or sentinel has been notified.  */
193
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
194

195 196
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

197
/* Only W32 has this, it really means that select can't take write mask.  */
198 199
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
200
#define SELECT_CANT_DO_WRITE_MASK
201 202 203 204 205 206 207 208 209 210 211 212 213 214
#else
#ifndef NON_BLOCKING_CONNECT
#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 /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
/* 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
#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 /* DATAGRAM_SOCKETS */
#endif /* BROKEN_DATAGRAM_SOCKETS */

Stefan Monnier's avatar
Stefan Monnier committed
232 233 234 235
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
236 237 238 239 240 241 242 243 244 245 246
#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)

247 248
/* 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
249 250 251

static int process_output_delay_count;

252
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
253 254 255 256 257

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
258 259
   non-nil value does not reset the delay.  A value of nil disables
   adaptive read buffering completely.  */
Kenichi Handa's avatar
Kenichi Handa committed
260 261 262 263 264
static Lisp_Object Vprocess_adaptive_read_buffering;
#else
#define process_output_delay_count 0
#endif

265 266 267 268 269
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);
270

271
/* If we support a window system, turn on the code to poll periodically
272
   to detect C-g.  It isn't actually used when doing interrupt input.  */
273
#ifdef HAVE_WINDOW_SYSTEM
274 275 276
#define POLL_FOR_INPUT
#endif

277 278
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
279

280 281 282 283
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

284
/* Mask that excludes keyboard input descriptor(s).  */
285 286 287

static SELECT_TYPE non_keyboard_wait_mask;

288
/* Mask that excludes process input descriptor(s).  */
289 290 291

static SELECT_TYPE non_process_wait_mask;

292
/* Mask for selecting for write.  */
293

294
static SELECT_TYPE write_mask;
295

296
#ifdef NON_BLOCKING_CONNECT
297 298 299 300 301 302 303 304 305
/* 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;

306
#define IF_NON_BLOCKING_CONNECT(s) s
307
#else  /* NON_BLOCKING_CONNECT */
308
#define IF_NON_BLOCKING_CONNECT(s)
309
#endif	/* NON_BLOCKING_CONNECT */
310

311 312 313
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

314 315
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
316

Jim Blandy's avatar
Jim Blandy committed
317
/* Indexed by descriptor, gives the process (if any) for that descriptor */
318
Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
319 320

/* Alist of elements (NAME . PROCESS) */
321
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
322 323 324 325 326 327 328

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

329 330
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
331

Karl Heuer's avatar
Karl Heuer committed
332
/* Table of `struct coding-system' for each process.  */
333 334
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
335

336 337 338 339 340 341 342
#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)
343
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
344 345 346 347 348
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435


struct fd_callback_data
{
  fd_callback func;
  void *data;
#define FOR_READ  1
#define FOR_WRITE 2
  int condition; /* mask of the defines above.  */
} fd_callback_info[MAXDESC];


/* Add a file descriptor FD to be monitored for when read is possible.
   When read is possible, call FUNC with argument DATA.  */

void
add_read_fd (int fd, fd_callback func, void *data)
{
  xassert (fd < MAXDESC);
  add_keyboard_wait_descriptor (fd);

  fd_callback_info[fd].func = func;
  fd_callback_info[fd].data = data;
  fd_callback_info[fd].condition |= FOR_READ;
}

/* Stop monitoring file descriptor FD for when read is possible.  */

void
delete_read_fd (int fd)
{
  xassert (fd < MAXDESC);
  delete_keyboard_wait_descriptor (fd);

  fd_callback_info[fd].condition &= ~FOR_READ;
  if (fd_callback_info[fd].condition == 0)
    {
      fd_callback_info[fd].func = 0;
      fd_callback_info[fd].data = 0;
    }
}

/* Add a file descriptor FD to be monitored for when write is possible.
   When write is possible, call FUNC with argument DATA.  */

void
add_write_fd (int fd, fd_callback func, void *data)
{
  xassert (fd < MAXDESC);
  FD_SET (fd, &write_mask);
  if (fd > max_input_desc)
    max_input_desc = fd;

  fd_callback_info[fd].func = func;
  fd_callback_info[fd].data = data;
  fd_callback_info[fd].condition |= FOR_WRITE;
}

/* Stop monitoring file descriptor FD for when write is possible.  */

void
delete_write_fd (int fd)
{
  int lim = max_input_desc;

  xassert (fd < MAXDESC);
  FD_CLR (fd, &write_mask);
  fd_callback_info[fd].condition &= ~FOR_WRITE;
  if (fd_callback_info[fd].condition == 0)
    {
      fd_callback_info[fd].func = 0;
      fd_callback_info[fd].data = 0;

      if (fd == max_input_desc)
        for (fd = lim; fd >= 0; fd--)
          if (FD_ISSET (fd, &input_wait_mask) || FD_ISSET (fd, &write_mask))
            {
              max_input_desc = fd;
              break;
            }
      
    }
}

Jim Blandy's avatar
Jim Blandy committed
436 437 438 439

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

440
static Lisp_Object status_convert (int);
441

442
static void
443
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
444
{
445
  eassert (p->raw_status_new);
446
  p->status = status_convert (p->raw_status);
447
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
448 449
}

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

453
static Lisp_Object
454
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
{
  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.  */

471
static void
472
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
473 474 475
{
  Lisp_Object tem;

476
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
477 478 479 480 481 482 483
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
484 485 486 487
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
488 489 490 491 492 493
      *coredump = !NILP (tem);
    }
}

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

494
static Lisp_Object
495
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
496
{
497
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
498 499 500 501 502 503 504 505
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
506
      char *signame;
507
      synchronize_system_messages_locale ();
508
      signame = strsignal (code);
509
      if (signame == 0)
510 511 512 513 514 515 516 517 518
	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));
519
	  c1 = STRING_CHAR ((char *) SDATA (string));
520 521
	  c2 = DOWNCASE (c1);
	  if (c1 != c2)
522
	    Faset (string, make_number (0), make_number (c2));
523
	}
Jim Blandy's avatar
Jim Blandy committed
524 525 526 527 528
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
529 530
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
531 532
      if (code == 0)
	return build_string ("finished\n");
533
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
534
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
535 536
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
537
    }
538 539 540 541
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
542 543
      return concat3 (build_string ("failed with code "),
		      string, string2);
544
    }
Jim Blandy's avatar
Jim Blandy committed
545 546 547 548 549 550
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

Dan Nicolaescu's avatar
Dan Nicolaescu committed
551 552 553
/* The file name of the pty opened by allocate_pty.  */
static char pty_name[24];

554 555 556 557 558
/* 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.  */

559
static int
560
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
561
{
Andreas Schwab's avatar
Andreas Schwab committed
562
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
563 564 565 566 567 568 569 570 571
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
572
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
573 574 575 576 577 578
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

579 580 581
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
582 583 584 585 586 587 588
	{
	  { /* 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;
589

590 591 592 593 594 595 596 597
	    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
598
	  }
599 600 601 602 603 604
#  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
	}
605
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
606 607 608 609 610 611 612 613

	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
614
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
615 616 617
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
618
		emacs_close (fd);
619
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
620
		continue;
621
# else
Jim Blandy's avatar
Jim Blandy committed
622
		return -1;
623
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
624 625 626 627 628 629 630 631 632
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

633
static Lisp_Object
634
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638 639 640
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

641
  p = allocate_process ();
642

643 644 645 646
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
647
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
648
  p->pty_flag = 0;
649
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
650 651
  p->status = Qrun;
  p->mark = Fmake_marker ();
652
  p->kill_without_query = 0;
Jim Blandy's avatar
Jim Blandy committed
653

Kenichi Handa's avatar
Kenichi Handa committed
654
#ifdef ADAPTIVE_READ_BUFFERING
655 656 657
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
658 659
#endif

Ted Zlatanov's avatar
Ted Zlatanov committed
660 661
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
662
  p->gnutls_log_level = 0;
663
  p->gnutls_p = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
664 665
#endif

Jim Blandy's avatar
Jim Blandy committed
666 667 668 669 670 671 672 673 674 675 676 677
  /* 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;
678
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
679 680 681 682
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

683
static void
684
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
685 686 687 688 689 690 691 692
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
693

Jim Blandy's avatar
Jim Blandy committed
694 695

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
696
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
697
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
698
{
699
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
700 701 702
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
703
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
704
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
705
{
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
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
712 713 714 715
/* 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
716

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

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

750 751 752 753 754 755 756 757 758 759

#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
760
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
761 762 763
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
764
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
765
{
766 767
  register struct Lisp_Process *p;

768
  process = get_process (process);
769 770
  p = XPROCESS (process);

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

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

836 837
  if (STRINGP (process))
    process = Fget_process (process);
838
  else
839
    process = get_process (process);
840

841 842
  if (NILP (process))
    return process;
843

844
  p = XPROCESS (process);
845
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
846 847
    update_status (p);
  status = p->status;
848
  if (CONSP (status))
849
    status = XCAR (status);
850
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
851
    {
852
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
853
	status = Qclosed;
854 855 856 857
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
858 859 860 861 862 863
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
864 865
       doc: /* Return the exit status of PROCESS or the signal number that killed it.
If PROCESS has not yet exited or died, return 0.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
866
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
867
{
868
  CHECK_PROCESS (process);
869
  if (XPROCESS (process)->raw_status_new)
870 871
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
872
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
873 874 875 876
  return make_number (0);
}

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

886
  CHECK_PROCESS (process);
887 888
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
889 890 891
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
892 893 894
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
895
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
896
{
897
  CHECK_PROCESS (process);
898
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
899 900 901
}

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

913
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
914 915 916
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
917
  (register Lisp_Object process)
918
{
919
  CHECK_PROCESS (process);
920
  return XPROCESS (process)->tty_name;
921 922
}

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

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

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
942 943 944
       1, 1, 0,
       doc: /* Return the buffer PROCESS is associated with.
Output from PROCESS is inserted in this buffer unless PROCESS has a filter.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
945
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
946
{
947
  CHECK_PROCESS (process);
948
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
949 950 951
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
952 953
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
954
  (register Lisp_Object process)