process.c 211 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
#ifdef WINDOWSNT
extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
		       EMACS_TIME *, void *);
#endif

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

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

154 155
#ifdef subprocesses

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

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

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

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

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

191
/* Only W32 has this, it really means that select can't take write mask.  */
192 193
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
194
#define SELECT_CANT_DO_WRITE_MASK
195 196 197 198 199 200 201 202 203 204 205 206
#else
#ifndef NON_BLOCKING_CONNECT
#ifdef HAVE_SELECT
#if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
#if defined (EWOULDBLOCK) || defined (EINPROGRESS)
#define NON_BLOCKING_CONNECT
#endif /* EWOULDBLOCK || EINPROGRESS */
#endif /* HAVE_GETPEERNAME || GNU_LINUX */
#endif /* HAVE_SELECT */
#endif /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

207 208 209 210 211
/* 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
212 213 214 215 216 217 218
#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
219

Stefan Monnier's avatar
Stefan Monnier committed
220 221 222 223
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
224 225 226 227 228
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#define ADAPTIVE_READ_BUFFERING
#endif

#ifdef ADAPTIVE_READ_BUFFERING
229
#define READ_OUTPUT_DELAY_INCREMENT (EMACS_TIME_RESOLUTION / 100)
Kenichi Handa's avatar
Kenichi Handa committed
230 231 232
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

233 234
/* 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
235 236 237

static int process_output_delay_count;

238
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
239 240 241 242 243 244 245

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

246
static void create_process (Lisp_Object, char **, Lisp_Object);
Paul Eggert's avatar
Paul Eggert committed
247
#ifdef USABLE_SIGIO
248
static int keyboard_bit_set (SELECT_TYPE *);
249
#endif
250 251 252
static void deactivate_process (Lisp_Object);
static void status_notify (struct Lisp_Process *);
static int read_process_output (Lisp_Object, int);
253
static void handle_child_signal (int);
254
static void create_pty (Lisp_Object);
255

256
/* If we support a window system, turn on the code to poll periodically
257
   to detect C-g.  It isn't actually used when doing interrupt input.  */
258
#ifdef HAVE_WINDOW_SYSTEM
259 260 261
#define POLL_FOR_INPUT
#endif

262 263
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
264

265 266 267 268
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

269
/* Mask that excludes keyboard input descriptor(s).  */
270 271 272

static SELECT_TYPE non_keyboard_wait_mask;

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

static SELECT_TYPE non_process_wait_mask;

277
/* Mask for selecting for write.  */
278

279
static SELECT_TYPE write_mask;
280

281
#ifdef NON_BLOCKING_CONNECT
282 283 284 285 286 287 288 289
/* 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;
290
#endif	/* NON_BLOCKING_CONNECT */
291

292 293 294
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

295 296
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
297

Jim Blandy's avatar
Jim Blandy committed
298
/* Indexed by descriptor, gives the process (if any) for that descriptor */
299
static Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
300 301

/* Alist of elements (NAME . PROCESS) */
302
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
303 304 305 306 307 308 309

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

310
static int proc_buffered_char[MAXDESC];
311

Karl Heuer's avatar
Karl Heuer committed
312
/* Table of `struct coding-system' for each process.  */
313 314
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
315

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

Paul Eggert's avatar
Paul Eggert committed
329
/* These setters are used only in this file, so they can be private.  */
330
static void
Paul Eggert's avatar
Paul Eggert committed
331 332 333 334
pset_buffer (struct Lisp_Process *p, Lisp_Object val)
{
  p->buffer = val;
}
335
static void
Paul Eggert's avatar
Paul Eggert committed
336 337 338 339
pset_command (struct Lisp_Process *p, Lisp_Object val)
{
  p->command = val;
}
340
static void
Paul Eggert's avatar
Paul Eggert committed
341 342 343 344
pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->decode_coding_system = val;
}
345
static void
Paul Eggert's avatar
Paul Eggert committed
346 347 348 349
pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->decoding_buf = val;
}
350
static void
Paul Eggert's avatar
Paul Eggert committed
351 352 353 354
pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->encode_coding_system = val;
}
355
static void
Paul Eggert's avatar
Paul Eggert committed
356 357 358 359
pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->encoding_buf = val;
}
360
static void
Paul Eggert's avatar
Paul Eggert committed
361 362 363 364
pset_filter (struct Lisp_Process *p, Lisp_Object val)
{
  p->filter = val;
}
365
static void
Paul Eggert's avatar
Paul Eggert committed
366 367 368 369
pset_log (struct Lisp_Process *p, Lisp_Object val)
{
  p->log = val;
}
370
static void
Paul Eggert's avatar
Paul Eggert committed
371 372 373 374
pset_mark (struct Lisp_Process *p, Lisp_Object val)
{
  p->mark = val;
}
375
static void
Paul Eggert's avatar
Paul Eggert committed
376 377 378 379
pset_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->name = val;
}
380
static void
Paul Eggert's avatar
Paul Eggert committed
381 382 383 384
pset_plist (struct Lisp_Process *p, Lisp_Object val)
{
  p->plist = val;
}
385
static void
Paul Eggert's avatar
Paul Eggert committed
386 387 388 389
pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
{
  p->sentinel = val;
}
390
static void
Paul Eggert's avatar
Paul Eggert committed
391 392 393 394
pset_status (struct Lisp_Process *p, Lisp_Object val)
{
  p->status = val;
}
395
static void
Paul Eggert's avatar
Paul Eggert committed
396 397 398 399
pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->tty_name = val;
}
400
static void
Paul Eggert's avatar
Paul Eggert committed
401 402 403 404
pset_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->type = val;
}
405
static void
Paul Eggert's avatar
Paul Eggert committed
406 407 408 409 410
pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
{
  p->write_queue = val;
}

411 412


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

476
  eassert (fd < MAXDESC);
477 478 479 480 481 482 483 484 485 486 487 488 489 490
  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;
            }
491

492 493 494
    }
}

Jim Blandy's avatar
Jim Blandy committed
495 496 497 498

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

499
static Lisp_Object status_convert (int);
500

501
static void
502
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
503
{
504
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
505
  pset_status (p, status_convert (p->raw_status));
506
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
507 508
}

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

512
static Lisp_Object
513
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
514 515 516 517
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
518
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
519 520 521 522 523 524 525 526 527 528 529
				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.  */

530
static void
531
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
532 533 534
{
  Lisp_Object tem;

535
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
536 537 538 539 540 541 542
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
543 544 545 546
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551 552
      *coredump = !NILP (tem);
    }
}

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

553
static Lisp_Object
554
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
555
{
556
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
557 558 559 560 561 562 563 564
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
565
      char const *signame;
566
      synchronize_system_messages_locale ();
567
      signame = strsignal (code);
568
      if (signame == 0)
569 570 571 572 573
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

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

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

613 614 615 616 617
/* 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.  */

618
static int
619
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
620 621 622 623 624 625
{
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
626
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630 631 632 633 634 635 636
  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 */

637 638 639
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
640
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
641
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
642 643 644 645 646 647 648 649

	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
650
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
651
#endif /* no PTY_TTY_NAME_SPRINTF */
652
	    if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
Jim Blandy's avatar
Jim Blandy committed
653
	      {
654
		emacs_close (fd);
655
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
656
		continue;
657
# else
Jim Blandy's avatar
Jim Blandy committed
658
		return -1;
659
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
660 661 662 663 664 665 666 667 668
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

669
static Lisp_Object
670
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
671 672 673
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
674 675
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
676

677
  p = allocate_process ();
678 679
  /* 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
680 681
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Jim Blandy's avatar
Jim Blandy committed
682

683 684 685 686
  /* 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
687

Ted Zlatanov's avatar
Ted Zlatanov committed
688 689 690 691
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

Jim Blandy's avatar
Jim Blandy committed
692 693 694 695 696 697 698
  /* 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;
699
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
700 701
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
702
  pset_name (p, name);
703
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
704 705 706 707
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

708
static void
709
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
710 711 712 713 714 715 716 717
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
718

Jim Blandy's avatar
Jim Blandy committed
719 720

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
721
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
722
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
723
{
724
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
725 726 727
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
728
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
729
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
730
{
731
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
732
    return name;
733
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
734 735 736
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
737 738 739 740
/* 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
741

742
static Lisp_Object
743
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
744
{
745 746 747 748 749 750 751
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
752
	error ("Process %s does not exist", SDATA (name));
753 754 755
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
756
  else
757 758 759 760 761
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
762
    {
763
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
764
      if (NILP (proc))
Tom Tromey's avatar
Tom Tromey committed
765
	error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
766 767
    }
  else
768
    {
769
      CHECK_PROCESS (obj);
770 771 772
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
773 774
}

775 776 777 778

#ifdef SIGCHLD
/* Fdelete_process promises to immediately forget about the process, but in
   reality, Emacs needs to remember those processes until they have been
779
   treated by the SIGCHLD handler and waitpid has been invoked on them;
780 781 782
   otherwise they might fill up the kernel's process table.

   Some processes created by call-process are also put onto this list.  */
783 784 785
static Lisp_Object deleted_pid_list;
#endif

786 787 788 789 790 791 792 793 794 795 796
void
record_deleted_pid (pid_t pid)
{
#ifdef SIGCHLD
  deleted_pid_list = Fcons (make_fixnum_or_float (pid),
			    /* GC treated elements set to nil.  */
			    Fdelq (Qnil, deleted_pid_list));

#endif
}

Jim Blandy's avatar
Jim Blandy committed
797
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
798 799 800
       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
801
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
802
{
803 804
  register struct Lisp_Process *p;

805
  process = get_process (process);
806 807
  p = XPROCESS (process);

808
  p->raw_status_new = 0;
809
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
810
    {
Paul Eggert's avatar
Paul Eggert committed
811
      pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
812
      p->tick = ++process_tick;
813
      status_notify (p);
814
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
815
    }
816
  else
Jim Blandy's avatar
Jim Blandy committed
817
    {
818 819 820 821
      if (p->alive)
	record_kill_process (p);

      if (p->infd >= 0)
822
	{
823 824 825 826 827 828 829 830 831
	  /* Update P's status, since record_kill_process will make the
	     SIGCHLD handler update deleted_pid_list, not *P.  */
	  Lisp_Object symbol;
	  if (p->raw_status_new)
	    update_status (p);
	  symbol = CONSP (p->status) ? XCAR (p->status) : p->status;
	  if (! (EQ (symbol, Qsignal) || EQ (symbol, Qexit)))
	    pset_status (p, list2 (Qsignal, make_number (SIGKILL)));

832
	  p->tick = ++process_tick;
833
	  status_notify (p);
834
	  redisplay_preserve_echo_area (13);
835
	}
Jim Blandy's avatar
Jim Blandy committed
836
    }
837
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
838 839 840 841
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
842 843 844 845 846 847 848
       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.
849
listen -- for a network stream server that is listening.
850
closed -- for a network stream connection that is closed.
851 852
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
853 854 855
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
856
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
857 858 859
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
860

861 862
  if (STRINGP (process))
    process = Fget_process (process);
863
  else
864
    process = get_process (process);
865

866 867
  if (NILP (process))
    return process;
868

869
  p = XPROCESS (process);
870
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
871
    update_status (p);
872
  status = p->status;
873
  if (CONSP (status))
874
    status = XCAR (status);
875
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
876
    {
877
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
878
	status = Qclosed;
879
      else if (EQ (p->command, Qt))
880 881 882
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
883 884 885 886 887 888
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
889 890
       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
891
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
892
{
893
  CHECK_PROCESS (process);
894
  if (XPROCESS (process)->raw_status_new)
895
    update_status (XPROCESS (process));
896 897
  if (CONSP (XPROCESS (process)->status))
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
898 899 900 901
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
902
       doc: /* Return the process id of PROCESS.
903
This is the pid of the external process which PROCESS uses or talks to.
904
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
905
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
906
{
907
  pid_t pid;
908

909
  CHECK_PROCESS (process);
910 911
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
912 913 914
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
915 916 917
       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
918
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
919
{
920
  CHECK_PROCESS (process);
921
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
922 923 924
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
925 926 927
       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.
928 929
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
930
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
931
{
932
  CHECK_PROCESS (process);
933
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
934 935
}

936
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
937 938 939
       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
940
  (register Lisp_Object process)
941
{
942
  CHECK_PROCESS (process);
943
  return XPROCESS (process)->tty_name;
944 945
}

Jim Blandy's avatar
Jim Blandy committed
946
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
947
       2, 2, 0,
948 949
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
Return BUFFER.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
950
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
951
{
952 953
  struct Lisp_Process *p;

954
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
955
  if (!NILP (buffer))
956
    CHECK_BUFFER (buffer);
957
  p = XPROCESS (process);
Paul Eggert's avatar
Paul Eggert committed
958
  pset_buffer (p, buffer);
959
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Paul Eggert's avatar
Paul Eggert committed
960
    pset_childp (p, Fplist_put (p->childp, QCbuffer, buffer));
961
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
962 963 964 965
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
966 967 968
       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
969
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
970
{
971
  CHECK_PROCESS (process);
972
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
973 974 975
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
976 977
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
978
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
979
{
980
  CHECK_PROCESS (process);
981
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
982 983 984
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
985 986
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
987
A value of t means stop accepting output from the process.
988 989 990

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
991
passed to the filter.
992

993
The filter gets two arguments: the process and the string of output.
994 995 996 997 998 999
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
1000
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
1001
{
1002
  struct Lisp_Process *p;
1003

1004
  CHECK_PROCESS (process);
1005 1006 1007 1008 1009 1010 1011 1012 1013
  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 ...)  */
1014

1015
  if (p->infd >= 0)
1016
    {
1017
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
1018
	{
1019 1020
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
1021
	}
1022
      else if (EQ (p->filter, Qt)
1023
	       /* Network or serial process not stopped:  */
1024
	       && !EQ (p->command, Qt))
1025
	{
1026 1027
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
1028
	}
1029
    }
1030

Paul Eggert's avatar
Paul Eggert committed
1031
  pset_filter (p, filter);
1032
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Paul Eggert's avatar