process.c 218 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 28
#include <stdio.h>
#include <errno.h>
#include <setjmp.h>
29
#include <sys/types.h>		/* Some typedefs are used in sys/file.h.  */
Jim Blandy's avatar
Jim Blandy committed
30 31
#include <sys/file.h>
#include <sys/stat.h>
32
#include <setjmp.h>
33

Richard M. Stallman's avatar
Richard M. Stallman committed
34
#include <unistd.h>
35 36
#include <fcntl.h>

37 38
#include "lisp.h"

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

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

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

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

Juanma Barranquero's avatar
Juanma Barranquero committed
63
#if defined (HAVE_IFADDRS_H)
64 65 66 67
/* 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
68
#if defined (HAVE_NET_IF_DL_H)
69 70 71 72 73
#include <net/if_dl.h>
#endif

#endif

Jim Blandy's avatar
Jim Blandy committed
74 75 76 77
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

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

84 85 86 87
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

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

92 93
#endif	/* subprocesses */

Jim Blandy's avatar
Jim Blandy committed
94
#include "systime.h"
95
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
96 97

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

118 119 120 121
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

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

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

134 135 136 137 138 139 140
/* 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

141 142 143 144 145 146 147 148 149 150 151 152 153 154
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;

155 156
#ifdef subprocesses

157
Lisp_Object Qprocessp;
158 159 160 161 162
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
163
#ifdef AF_INET6
164
static Lisp_Object Qipv6;
Kim F. Storm's avatar
Kim F. Storm committed
165
#endif
166 167
static Lisp_Object QCport, QCprocess;
Lisp_Object QCspeed;
168 169
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
170 171 172 173 174
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;
175

176 177 178 179
#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
180

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

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

190 191
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

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

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
/* 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
227 228 229 230
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

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

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

240 241
/* 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
242 243 244

static int process_output_delay_count;

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

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

253
static void create_process (Lisp_Object, char **, Lisp_Object);
254
#ifdef SIGIO
255
static int keyboard_bit_set (SELECT_TYPE *);
256
#endif
257 258 259 260
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);
261

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

268 269
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
270

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

static SELECT_TYPE input_wait_mask;

275
/* Mask that excludes keyboard input descriptor(s).  */
276 277 278

static SELECT_TYPE non_keyboard_wait_mask;

279
/* Mask that excludes process input descriptor(s).  */
280 281 282

static SELECT_TYPE non_process_wait_mask;

283
/* Mask for selecting for write.  */
284

285
static SELECT_TYPE write_mask;
286

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

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

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

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

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

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

316
static int proc_buffered_char[MAXDESC];
317

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

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

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

Paul Eggert's avatar
Paul Eggert committed
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 418 419
/* 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;
}

420 421


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

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

501 502 503
    }
}

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

508
static Lisp_Object status_convert (int);
509

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

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

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

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

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

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

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

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

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

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

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

622 623 624 625 626
/* 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.  */

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

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
635
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
636 637 638 639 640 641 642 643 644 645
  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 */

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

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

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

709
  p = allocate_process ();
710 711
  /* 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
712 713
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
714

715 716 717 718
  /* 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
719

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

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

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

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

  deactivate_process (proc);
}
750

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

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

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

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

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

807 808 809 810

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

825
  process = get_process (process);
826 827
  p = XPROCESS (process);

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

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

891 892
  if (STRINGP (process))
    process = Fget_process (process);
893
  else
894
    process = get_process (process);
895

896 897
  if (NILP (process))
    return process;
898

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

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

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

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

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

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

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

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

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

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

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

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

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
1021
passed to the filter.
1022

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

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

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

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

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

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