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
#include <stdlib.h>
35

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

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

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

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

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

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

Dave Love's avatar
Dave Love committed
71 72 73
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
74

75 76 77 78 79 80
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

81 82 83 84
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

85 86
#endif	/* subprocesses */

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

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

112 113 114
#if defined (USE_GTK) || defined (HAVE_GCONF)
#include "xgselect.h"
#endif /* defined (USE_GTK) || defined (HAVE_GCONF) */
115 116 117
#ifdef HAVE_NS
#include "nsterm.h"
#endif
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 174 175 176 177 178 179 180

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

181
extern const char *get_operating_system_release (void);
182

183 184 185 186
/* From sysdep.c or w32.c  */
extern int serial_open (char *port);
extern void serial_configure (struct Lisp_Process *p, Lisp_Object contact);

187 188 189 190
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
191 192
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
193
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
194

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

202 203
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

204
/* Only W32 has this, it really means that select can't take write mask.  */
205 206
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
207
#define SELECT_CANT_DO_WRITE_MASK
208 209 210 211 212 213 214 215 216 217 218 219 220 221
#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 */

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
/* 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
239 240 241 242
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

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

254 255
/* 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
256 257 258

static int process_output_delay_count;

259
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
260 261 262 263 264

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

272 273 274 275 276
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);
277

278
/* If we support a window system, turn on the code to poll periodically
279
   to detect C-g.  It isn't actually used when doing interrupt input.  */
280
#ifdef HAVE_WINDOW_SYSTEM
281 282 283
#define POLL_FOR_INPUT
#endif

284 285
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
286

287 288 289 290
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

291
/* Mask that excludes keyboard input descriptor(s).  */
292 293 294

static SELECT_TYPE non_keyboard_wait_mask;

295
/* Mask that excludes process input descriptor(s).  */
296 297 298

static SELECT_TYPE non_process_wait_mask;

299
/* Mask for selecting for write.  */
300

301
static SELECT_TYPE write_mask;
302

303
#ifdef NON_BLOCKING_CONNECT
304 305 306 307 308 309 310 311 312
/* 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;

313
#define IF_NON_BLOCKING_CONNECT(s) s
314
#else  /* NON_BLOCKING_CONNECT */
315
#define IF_NON_BLOCKING_CONNECT(s)
316
#endif	/* NON_BLOCKING_CONNECT */
317

318 319 320
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

321 322
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
323

Jim Blandy's avatar
Jim Blandy committed
324
/* Indexed by descriptor, gives the process (if any) for that descriptor */
325
Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
326 327

/* Alist of elements (NAME . PROCESS) */
328
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
329 330 331 332 333 334 335

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

336 337
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
338

Karl Heuer's avatar
Karl Heuer committed
339
/* Table of `struct coding-system' for each process.  */
340 341
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
342

343 344 345 346 347 348 349
#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)
350
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
351 352 353 354 355
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

359
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
360 361 362
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
363
/* The file name of the pty opened by allocate_pty.  */
364 365

static char pty_name[24];
366
#endif
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 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450


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
451 452 453 454

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

455
static Lisp_Object status_convert (int);
456

457
static void
458
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
459
{
460
  eassert (p->raw_status_new);
461
  p->status = status_convert (p->raw_status);
462
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
463 464
}

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

468
static Lisp_Object
469
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
{
  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.  */

486
static void
487
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
488 489 490
{
  Lisp_Object tem;

491
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
492 493 494 495 496 497 498
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
499 500 501 502
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
503 504 505 506 507 508
      *coredump = !NILP (tem);
    }
}

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

509
static Lisp_Object
510
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
511
{
512
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
513 514 515 516 517 518 519 520
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
521
      char *signame;
522
      synchronize_system_messages_locale ();
523
      signame = strsignal (code);
524
      if (signame == 0)
525 526 527 528 529 530 531 532 533
	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));
534
	  c1 = STRING_CHAR ((char *) SDATA (string));
535 536
	  c2 = DOWNCASE (c1);
	  if (c1 != c2)
537
	    Faset (string, make_number (0), make_number (c2));
538
	}
Jim Blandy's avatar
Jim Blandy committed
539 540 541 542 543
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
544 545
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
546 547
      if (code == 0)
	return build_string ("finished\n");
548
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
549
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
550 551
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
552
    }
553 554 555 556
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
557 558
      return concat3 (build_string ("failed with code "),
		      string, string2);
559
    }
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563 564 565
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

566 567 568 569 570
/* 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.  */

571
static int
572
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
573
{
Andreas Schwab's avatar
Andreas Schwab committed
574
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
575 576 577 578 579 580 581 582 583
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
584
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
585 586 587 588 589 590
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

591 592 593
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
594 595 596 597 598 599 600
	{
	  { /* 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;
601

602 603 604 605 606 607 608 609
	    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
610
	  }
611 612 613 614 615 616
#  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
	}
617
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
618 619 620 621 622 623 624 625

	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
626
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
627 628 629
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
630
		emacs_close (fd);
631
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
632
		continue;
633
# else
Jim Blandy's avatar
Jim Blandy committed
634
		return -1;
635
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
636 637 638 639 640 641 642 643 644
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

645
static Lisp_Object
646
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
647 648 649 650 651 652
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

653
  p = allocate_process ();
654

655 656 657 658
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
659
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
660
  p->pty_flag = 0;
661
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
662 663
  p->status = Qrun;
  p->mark = Fmake_marker ();
664
  p->kill_without_query = 0;
Jim Blandy's avatar
Jim Blandy committed
665

Kenichi Handa's avatar
Kenichi Handa committed
666
#ifdef ADAPTIVE_READ_BUFFERING
667 668 669
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
670 671
#endif

Ted Zlatanov's avatar
Ted Zlatanov committed
672 673
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
674
  p->gnutls_log_level = 0;
675
  p->gnutls_p = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
676 677
#endif

Jim Blandy's avatar
Jim Blandy committed
678 679 680 681 682 683 684 685 686 687 688 689
  /* 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;
690
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
691 692 693 694
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

695
static void
696
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
697 698 699 700 701 702 703 704
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
705

Jim Blandy's avatar
Jim Blandy committed
706 707

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
708
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
709
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
710
{
711
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
712 713 714
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
715
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
716
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
717
{
718
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
719
    return name;
720
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
721 722 723
  return Fcdr (Fassoc (name, Vprocess_alist));
}

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

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

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

762 763 764 765 766 767 768 769 770 771

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

780
  process = get_process (process);
781 782
  p = XPROCESS (process);

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

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

848 849
  if (STRINGP (process))
    process = Fget_process (process);
850
  else
851
    process = get_process (process);
852

853 854
  if (NILP (process))
    return process;
855

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

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

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

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

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

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

925
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
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
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
938
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
939
{
940 941
  struct Lisp_Process *p;

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

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

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

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

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
979
passed to the filter.
980

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

992
  CHECK_PROCESS (process);
993 994 995 996 997 998 999 1000 1001
  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 ...)  */
1002

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

1019
  p->filter = filter;
1020
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
1021
    p->childp = Fplist_put (p->childp, QCfilter, filter);
1022
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1023 1024 1025 1026
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1027 1028 1029
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1030
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1031
{
1032
  CHECK_PROCESS (process);
1033
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1034 1035 1036
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1037 1038 1039 1040
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1041
  (register Lisp_Object process, Lisp_Object sentinel)
Jim Blandy's avatar
Jim Blandy committed
1042
{
Kenichi Handa's avatar
Kenichi Handa committed
1043 1044
  struct Lisp_Process *p;

1045
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1046 1047 1048
  p = XPROCESS (process);

  p->sentinel = sentinel;
1049
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
1050
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1051 1052 1053 1054
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1055 1056 1057
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1058
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1059
{
1060
  CHECK_PROCESS (process);
1061
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1062 1063
}

1064
DEFUN ("set-process-window-size", Fset_process_window_size,
1065 1066
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1067
  (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1068
{
1069 1070 1071
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
1072

1073 1074
  if (XPROCESS (process)->infd < 0
      || set_window_size (XPROCESS (process)->infd,
1075
			  XINT (height), XINT (width)) <= 0)