process.c 217 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2

3
Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2012
4
  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>
Paul Eggert's avatar
Paul Eggert committed
23 24 25

#define PROCESS_INLINE EXTERN_INLINE

Jim Blandy's avatar
Jim Blandy committed
26 27
#include <stdio.h>
#include <errno.h>
28
#include <sys/types.h>		/* Some typedefs are used in sys/file.h.  */
Jim Blandy's avatar
Jim Blandy committed
29 30
#include <sys/file.h>
#include <sys/stat.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
31
#include <unistd.h>
32 33
#include <fcntl.h>

34 35
#include "lisp.h"

36 37 38
/* Only MS-DOS does not define `subprocesses'.  */
#ifdef subprocesses

Jim Blandy's avatar
Jim Blandy committed
39 40 41 42
#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
43 44

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

#include <sys/ioctl.h>
Juanma Barranquero's avatar
Juanma Barranquero committed
56
#if defined (HAVE_NET_IF_H)
57 58
#include <net/if.h>
#endif /* HAVE_NET_IF_H */
Jim Blandy's avatar
Jim Blandy committed
59

Juanma Barranquero's avatar
Juanma Barranquero committed
60
#if defined (HAVE_IFADDRS_H)
61 62 63 64
/* Must be after net/if.h */
#include <ifaddrs.h>

/* We only use structs from this header when we use getifaddrs.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
65
#if defined (HAVE_NET_IF_DL_H)
66 67 68 69 70
#include <net/if_dl.h>
#endif

#endif

Jim Blandy's avatar
Jim Blandy committed
71 72 73 74
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

Paul Eggert's avatar
Paul Eggert committed
75 76 77 78 79
#ifdef USG5_4
# include <sys/stream.h>
# include <sys/stropts.h>
#endif

80 81 82 83 84 85
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

86 87 88 89
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
90 91 92 93
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

94 95
#endif	/* subprocesses */

Jim Blandy's avatar
Jim Blandy committed
96
#include "systime.h"
97
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
98 99

#include "window.h"
100
#include "character.h"
101
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
102
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
103
#include "process.h"
104
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
105 106 107
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
108
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
109
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
110
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
111
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
112
#include "atimer.h"
113 114 115
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
116 117 118
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
119

120 121 122 123
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

124
#if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
125
#include "xgselect.h"
126
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
127

128 129 130 131 132 133 134 135
#ifndef WNOHANG
# undef waitpid
# define waitpid(pid, status, options) wait (status)
#endif
#ifndef WUNTRACED
# define WUNTRACED 0
#endif

136 137 138 139 140 141 142
/* Work around GCC 4.7.0 bug with strict overflow checking; see
   <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=52904>.
   These lines can be removed once the GCC bug is fixed.  */
#if (__GNUC__ == 4 && 3 <= __GNUC_MINOR__) || 4 < __GNUC__
# pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

143 144 145 146 147 148 149 150 151 152 153 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;
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 don't run process sentinels.  This is used
   when exiting.  */
int inhibit_sentinels;

157 158
#ifdef subprocesses

159
Lisp_Object Qprocessp;
160 161 162 163 164
static Lisp_Object Qrun, Qstop, Qsignal;
static Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
Lisp_Object Qlocal;
static Lisp_Object Qipv4, Qdatagram, Qseqpacket;
static Lisp_Object Qreal, Qnetwork, Qserial;
Kim F. Storm's avatar
Kim F. Storm committed
165
#ifdef AF_INET6
166
static Lisp_Object Qipv6;
Kim F. Storm's avatar
Kim F. Storm committed
167
#endif
168 169
static Lisp_Object QCport, QCprocess;
Lisp_Object QCspeed;
170 171
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
172 173 174 175 176
static Lisp_Object QCbuffer, QChost, QCservice;
static Lisp_Object QClocal, QCremote, QCcoding;
static Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
static Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
static Lisp_Object Qlast_nonmenu_event;
177

178 179 180 181
#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
182

183 184 185 186
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
187
/* Number of events of change of status of a process.  */
188
static EMACS_INT process_tick;
Jim Blandy's avatar
Jim Blandy committed
189
/* Number of events for which the user or sentinel has been notified.  */
190
static EMACS_INT update_tick;
Jim Blandy's avatar
Jim Blandy committed
191

192 193
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

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

212 213 214 215 216
/* 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.  */

Paul Eggert's avatar
Paul Eggert committed
217 218 219 220 221 222 223
#ifndef BROKEN_DATAGRAM_SOCKETS
# if defined HAVE_SELECT || defined USABLE_FIONREAD
#  if defined HAVE_SENDTO && defined HAVE_RECVFROM && defined EMSGSIZE
#   define DATAGRAM_SOCKETS
#  endif
# endif
#endif
224

Stefan Monnier's avatar
Stefan Monnier committed
225 226 227 228
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
229 230 231 232 233
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#define ADAPTIVE_READ_BUFFERING
#endif

#ifdef ADAPTIVE_READ_BUFFERING
234
#define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
235 236 237
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

238 239
/* 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
240 241 242

static int process_output_delay_count;

243
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
244 245 246 247 248 249 250

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

251
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
252
#ifdef USABLE_SIGIO
253
static int keyboard_bit_set (SELECT_TYPE *);
254
#endif
255 256 257 258
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);
259

260
/* If we support a window system, turn on the code to poll periodically
261
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
262
#if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
263 264 265
#define POLL_FOR_INPUT
#endif

266 267
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
268

269 270 271 272
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

273
/* Mask that excludes keyboard input descriptor(s).  */
274 275 276

static SELECT_TYPE non_keyboard_wait_mask;

277
/* Mask that excludes process input descriptor(s).  */
278 279 280

static SELECT_TYPE non_process_wait_mask;

281
/* Mask for selecting for write.  */
282

283
static SELECT_TYPE write_mask;
284

285
#ifdef NON_BLOCKING_CONNECT
286 287 288 289 290 291 292 293
/* 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;
294
#endif	/* NON_BLOCKING_CONNECT */
295

296 297 298
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

299 300
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
301

Jim Blandy's avatar
Jim Blandy committed
302
/* Indexed by descriptor, gives the process (if any) for that descriptor */
303
static Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
304 305

/* Alist of elements (NAME . PROCESS) */
306
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
307 308 309 310 311 312 313

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

314
static int proc_buffered_char[MAXDESC];
315

Karl Heuer's avatar
Karl Heuer committed
316
/* Table of `struct coding-system' for each process.  */
317 318
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
319

320 321
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
322
static struct sockaddr_and_len {
323 324 325 326
  struct sockaddr *sa;
  int len;
} datagram_address[MAXDESC];
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
327
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
328 329 330 331 332
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

Paul Eggert's avatar
Paul Eggert committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 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
/* These setters are used only in this file, so they can be private.  */
static inline void
pset_buffer (struct Lisp_Process *p, Lisp_Object val)
{
  p->buffer = val;
}
static inline void
pset_command (struct Lisp_Process *p, Lisp_Object val)
{
  p->command = val;
}
static inline void
pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->decode_coding_system = val;
}
static inline void
pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->decoding_buf = val;
}
static inline void
pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->encode_coding_system = val;
}
static inline void
pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->encoding_buf = val;
}
static inline void
pset_filter (struct Lisp_Process *p, Lisp_Object val)
{
  p->filter = val;
}
static inline void
pset_log (struct Lisp_Process *p, Lisp_Object val)
{
  p->log = val;
}
static inline void
pset_mark (struct Lisp_Process *p, Lisp_Object val)
{
  p->mark = val;
}
static inline void
pset_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->name = val;
}
static inline void
pset_plist (struct Lisp_Process *p, Lisp_Object val)
{
  p->plist = val;
}
static inline void
pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
{
  p->sentinel = val;
}
static inline void
pset_status (struct Lisp_Process *p, Lisp_Object val)
{
  p->status = val;
}
static inline void
pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->tty_name = val;
}
static inline void
pset_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->type = val;
}
static inline void
pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
{
  p->write_queue = val;
}

418 419


420
static struct fd_callback_data
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
{
  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)
{
436
  eassert (fd < MAXDESC);
437 438 439 440 441 442 443 444 445 446 447 448
  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)
{
449
  eassert (fd < MAXDESC);
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
  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)
{
466
  eassert (fd < MAXDESC);
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
  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;

483
  eassert (fd < MAXDESC);
484 485 486 487 488 489 490 491 492 493 494 495 496 497
  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;
            }
498

499 500 501
    }
}

Jim Blandy's avatar
Jim Blandy committed
502 503 504 505

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

506
static Lisp_Object status_convert (int);
507

508
static void
509
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
510
{
511
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
512
  pset_status (p, status_convert (p->raw_status));
513
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
514 515
}

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

519
static Lisp_Object
520
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
521 522 523 524
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
525
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
526 527 528 529 530 531 532 533 534 535 536
				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.  */

537
static void
538
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
539 540 541
{
  Lisp_Object tem;

542
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
543 544 545 546 547 548 549
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
550 551 552 553
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
554 555 556 557 558 559
      *coredump = !NILP (tem);
    }
}

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

560
static Lisp_Object
561
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
562
{
563
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
564 565 566 567 568 569 570 571
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
572
      char *signame;
573
      synchronize_system_messages_locale ();
574
      signame = strsignal (code);
575
      if (signame == 0)
576 577 578 579 580
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

581
	  string = build_unibyte_string (signame);
582 583 584
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
585
	  c1 = STRING_CHAR (SDATA (string));
586
	  c2 = downcase (c1);
587
	  if (c1 != c2)
588
	    Faset (string, make_number (0), make_number (c2));
589
	}
Jim Blandy's avatar
Jim Blandy committed
590 591 592 593 594
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
595 596
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
597 598
      if (code == 0)
	return build_string ("finished\n");
599
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
600
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
601 602
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
603
    }
604 605 606 607
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
608 609
      return concat3 (build_string ("failed with code "),
		      string, string2);
610
    }
Jim Blandy's avatar
Jim Blandy committed
611 612 613 614 615 616
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

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

620 621 622 623 624
/* 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.  */

625
static int
626
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630 631 632
{
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
633
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
634 635 636 637 638 639 640 641 642 643
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

644 645 646
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
647 648 649 650 651 652 653
	{
	  { /* 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;
654
	    struct stat stb;
655

656 657 658 659 660 661 662 663
	    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
664
	  }
665 666 667 668 669 670
#  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
	}
671
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
672 673 674 675 676 677 678 679

	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
680
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
681 682 683
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
684
		emacs_close (fd);
685
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
686
		continue;
687
# else
Jim Blandy's avatar
Jim Blandy committed
688
		return -1;
689
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
690 691 692 693 694 695 696 697 698
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

699
static Lisp_Object
700
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
701 702 703
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
704 705
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
706

707
  p = allocate_process ();
708 709
  /* Initialize Lisp data.  Note that allocate_process initializes all
     Lisp data to nil, so do it only for slots which should not be nil.  */
Paul Eggert's avatar
Paul Eggert committed
710 711
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
712

713 714 715 716
  /* Initialize non-Lisp data.  Note that allocate_process zeroes out all
     non-Lisp data, so do it only for slots which should not be zero.  */
  p->infd = -1;
  p->outfd = -1;
Kenichi Handa's avatar
Kenichi Handa committed
717

Ted Zlatanov's avatar
Ted Zlatanov committed
718 719 720 721
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

Jim Blandy's avatar
Jim Blandy committed
722 723 724 725 726 727 728
  /* 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;
729
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
730 731
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
732
  pset_name (p, name);
733
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
734 735 736 737
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

738
static void
739
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
740 741 742 743 744 745 746 747
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
748

Jim Blandy's avatar
Jim Blandy committed
749 750

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
751
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
752
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
753
{
754
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
755 756 757
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
758
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
759
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
760
{
761
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
762
    return name;
763
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
764 765 766
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
767 768 769 770
/* 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
771

772
static Lisp_Object
773
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
774
{
775 776 777 778 779 780 781
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
782
	error ("Process %s does not exist", SDATA (name));
783 784 785
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
786
  else
787 788 789 790 791
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
792
    {
793
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
794
      if (NILP (proc))
Tom Tromey's avatar
Tom Tromey committed
795
	error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
796 797
    }
  else
798
    {
799
      CHECK_PROCESS (obj);
800 801 802
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
803 804
}

805 806 807 808

#ifdef SIGCHLD
/* Fdelete_process promises to immediately forget about the process, but in
   reality, Emacs needs to remember those processes until they have been
809
   treated by the SIGCHLD handler; otherwise this handler would consider the
810 811 812 813 814
   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
815
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
816 817 818
       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
819
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
820
{
821 822
  register struct Lisp_Process *p;

823
  process = get_process (process);
824 825
  p = XPROCESS (process);

826
  p->raw_status_new = 0;
827
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
828
    {
Paul Eggert's avatar
Paul Eggert committed
829
      pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
830
      p->tick = ++process_tick;
831
      status_notify (p);
832
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
833
    }
834
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
835
    {
836 837
#ifdef SIGCHLD
      Lisp_Object symbol;
838
      pid_t pid = p->pid;
839 840

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
841
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
842 843 844 845 846
				/* 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);
847 848 849
      symbol = p->status;
      if (CONSP (p->status))
	symbol = XCAR (p->status);
850
      if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
851 852
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
853 854 855 856
      else
#endif
	{
	  Fkill_process (process, Qnil);
857 858
	  /* Do this now, since remove_process will make the
	     SIGCHLD handler do nothing.  */
Paul Eggert's avatar
Paul Eggert committed
859
	  pset_status (p, Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil)));
860
	  p->tick = ++process_tick;
861
	  status_notify (p);
862
	  redisplay_preserve_echo_area (13);
863
	}
Jim Blandy's avatar
Jim Blandy committed
864
    }
865
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
866 867 868 869
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
870 871 872 873 874 875 876
       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.
877
listen -- for a network stream server that is listening.
878
closed -- for a network stream connection that is closed.
879 880
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
881 882 883
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
884
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
885 886 887
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
888

889 890
  if (STRINGP (process))
    process = Fget_process (process);
891
  else
892
    process = get_process (process);
893

894 895
  if (NILP (process))
    return process;
896

897
  p = XPROCESS (process);
898
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
899
    update_status (p);
900
  status = p->status;
901
  if (CONSP (status))
902
    status = XCAR (status);
903
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
904
    {
905
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
906
	status = Qclosed;
907
      else if (EQ (p->command, Qt))
908 909 910
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
911 912 913 914 915 916
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
917 918
       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
919
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
920
{
921
  CHECK_PROCESS (process);
922
  if (XPROCESS (process)->raw_status_new)
923
    update_status (XPROCESS (process));
924 925
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
926 927 928 929
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
930
       doc: /* Return the process id of PROCESS.
931
This is the pid of the external process which PROCESS uses or talks to.
932
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
933
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
934
{
935
  pid_t pid;
936

937
  CHECK_PROCESS (process);
938 939
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
940 941 942
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
943 944 945
       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
946
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
947
{
948
  CHECK_PROCESS (process);
949
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
950 951 952
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
953 954 955
       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.
956 957
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
958
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
959
{
960
  CHECK_PROCESS (process);
961
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
962 963
}

964
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
965 966 967
       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
968
  (register Lisp_Object process)
969
{
970
  CHECK_PROCESS (process);
971
  return XPROCESS (process)->tty_name;
972 973
}

Jim Blandy's avatar
Jim Blandy committed
974
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
975
       2, 2, 0,
976 977
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
978
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
979
{
980 981
  struct Lisp_Process *p;

982
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
983
  if (!NILP (buffer))
984
    CHECK_BUFFER (buffer);
985
  p = XPROCESS (process);
Paul Eggert's avatar
Paul Eggert committed
986
  pset_buffer (p, buffer);
987
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Paul Eggert's avatar
Paul Eggert committed
988
    pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
989
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
990 991 992 993
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
994 995 996
       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
997
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
998
{
999
  CHECK_PROCESS (process);
1000
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
1001 1002 1003
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
1004 1005
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1006
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1007
{
1008
  CHECK_PROCESS (process);
1009
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
1013 1014
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
1015
A value of t means stop accepting output from the process.
1016 1017 1018

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
1019
passed to the filter.
1020

1021
The filter gets two arguments: the process and the string of output.
1022 1023 1024 1025 1026 1027
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
1028
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
1029
{
1030
  struct Lisp_Process *p;
1031

1032
  CHECK_PROCESS (process);
1033 1034 1035 1036 1037 1038 1039 1040 1041
  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 ...)  */
1042

1043
  if (p->infd >= 0)
1044
    {
1045
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1046
	{
1047 1048
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1049
	}
1050
      else if (EQ (p->filter, Qt)
1051
	       /* Network or serial process not stopped:  */
1052
	       && !EQ (p->command, Qt))
1053
	{
1054 1055
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1056
	}
1057
    }
1058

Paul Eggert's avatar
Paul Eggert committed
1059
  pset_filter (p, filter);
1060
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Paul Eggert's avatar
Paul Eggert committed
1061
    pset_childp (p, Fplist_put (p->childp, QCfilter, filter));
1062
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
1063 1064 1065 1066
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
1067 1068 1069
       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
1070
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1071
{
1072
  CHECK_PROCESS (process);
1073
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
1074 1075 1076
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
1077 1078 1079 1080
       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
1081
  (register Lisp_Object process, Lisp_Object sentinel)
Jim Blandy's avatar
Jim Blandy committed
1082
{