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

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

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

38 39
#include "lisp.h"

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

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

/* Are local (unix) sockets supported?  */
49
#if defined (HAVE_SYS_UN_H)
50 51 52 53 54 55 56 57
#if !defined (AF_LOCAL) && defined (AF_UNIX)
#define AF_LOCAL AF_UNIX
#endif
#ifdef AF_LOCAL
#define HAVE_LOCAL_SOCKETS
#include <sys/un.h>
#endif
#endif
Jim Blandy's avatar
Jim Blandy committed
58 59

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

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

#endif

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

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

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

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

93 94
#endif	/* subprocesses */

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

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

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

126 127 128 129 130 131 132
/* 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

133 134 135 136 137 138 139 140 141 142 143 144 145 146
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;

147 148
#ifdef subprocesses

149
Lisp_Object Qprocessp;
150 151 152 153 154
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
155
#ifdef AF_INET6
156
static Lisp_Object Qipv6;
Kim F. Storm's avatar
Kim F. Storm committed
157
#endif
158 159
static Lisp_Object QCport, QCprocess;
Lisp_Object QCspeed;
160 161
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
162 163 164 165 166
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;
167 168 169 170
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

173 174 175 176 177
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

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 217 218 219 220 221 222 223 224 225 226 227 228
/* 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
229 230 231 232
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

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

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

242 243
/* 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
244 245 246

static int process_output_delay_count;

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

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

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

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

270 271
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
272

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

static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

281
/* Mask that excludes process input descriptor(s).  */
282 283 284

static SELECT_TYPE non_process_wait_mask;

285
/* Mask for selecting for write.  */
286

287
static SELECT_TYPE write_mask;
288

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

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

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

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

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

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

318
static int proc_buffered_char[MAXDESC];
319

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

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

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

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

422 423


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

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

503 504 505
    }
}

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

510
static Lisp_Object status_convert (int);
511

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

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

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

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

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

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

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

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

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

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

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

624 625 626 627 628
/* 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.  */

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

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

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

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

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

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

717 718 719 720
  /* 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
721

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

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

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

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

  deactivate_process (proc);
}
752

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

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

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

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

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

809 810 811 812 813 814 815 816 817 818

#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
819
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
820 821 822
       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
823
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
824
{
825 826
  register struct Lisp_Process *p;

827
  process = get_process (process);
828 829
  p = XPROCESS (process);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1024
The filter gets two arguments: the process and the string of output.