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

3 4
Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2013 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 96
#include <c-ctype.h>
#include <sig2str.h>

97 98
#endif	/* subprocesses */

Jim Blandy's avatar
Jim Blandy committed
99
#include "systime.h"
100
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
101 102

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

123 124 125 126
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

127
#if defined (USE_GTK) || defined (HAVE_GCONF) || defined (HAVE_GSETTINGS)
128
#include "xgselect.h"
129
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
130

131 132 133 134 135
#ifdef WINDOWSNT
extern int sys_select (int, SELECT_TYPE *, SELECT_TYPE *, SELECT_TYPE *,
		       EMACS_TIME *, void *);
#endif

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

143 144 145 146 147 148
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;

149
/* True if keyboard input is on hold, zero otherwise.  */
150

151
static bool kbd_is_on_hold;
152 153 154

/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
155
bool inhibit_sentinels;
156

157 158
#ifdef subprocesses

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

178 179 180 181
#define NETCONN_P(p) (EQ (XPROCESS (p)->type, Qnetwork))
#define NETCONN1_P(p) (EQ (p->type, Qnetwork))
#define SERIALCONN_P(p) (EQ (XPROCESS (p)->type, Qserial))
#define SERIALCONN1_P(p) (EQ (p->type, Qserial))
Jim Blandy's avatar
Jim Blandy committed
182 183

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

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

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

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

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

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

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

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

static int process_output_delay_count;

237
/* True if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
238

239
static bool process_output_skip;
Kenichi Handa's avatar
Kenichi Handa committed
240 241 242 243 244

#else
#define process_output_delay_count 0
#endif

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

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

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

264
#ifdef NON_BLOCKING_CONNECT
265 266
/* Number of bits set in connect_wait_mask.  */
static int num_pending_connects;
267
#endif	/* NON_BLOCKING_CONNECT */
268

269 270 271
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

272 273
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
274

Jim Blandy's avatar
Jim Blandy committed
275
/* Indexed by descriptor, gives the process (if any) for that descriptor */
276
static Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
277 278

/* Alist of elements (NAME . PROCESS) */
279
static Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
280 281 282 283 284 285 286

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

287
static int proc_buffered_char[MAXDESC];
288

Karl Heuer's avatar
Karl Heuer committed
289
/* Table of `struct coding-system' for each process.  */
290 291
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
292

293 294
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
295
static struct sockaddr_and_len {
296 297 298 299
  struct sockaddr *sa;
  int len;
} datagram_address[MAXDESC];
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
300
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
301 302 303 304 305
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

Paul Eggert's avatar
Paul Eggert committed
306
/* These setters are used only in this file, so they can be private.  */
307
static void
Paul Eggert's avatar
Paul Eggert committed
308 309 310 311
pset_buffer (struct Lisp_Process *p, Lisp_Object val)
{
  p->buffer = val;
}
312
static void
Paul Eggert's avatar
Paul Eggert committed
313 314 315 316
pset_command (struct Lisp_Process *p, Lisp_Object val)
{
  p->command = val;
}
317
static void
Paul Eggert's avatar
Paul Eggert committed
318 319 320 321
pset_decode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->decode_coding_system = val;
}
322
static void
Paul Eggert's avatar
Paul Eggert committed
323 324 325 326
pset_decoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->decoding_buf = val;
}
327
static void
Paul Eggert's avatar
Paul Eggert committed
328 329 330 331
pset_encode_coding_system (struct Lisp_Process *p, Lisp_Object val)
{
  p->encode_coding_system = val;
}
332
static void
Paul Eggert's avatar
Paul Eggert committed
333 334 335 336
pset_encoding_buf (struct Lisp_Process *p, Lisp_Object val)
{
  p->encoding_buf = val;
}
337
static void
Paul Eggert's avatar
Paul Eggert committed
338 339 340 341
pset_filter (struct Lisp_Process *p, Lisp_Object val)
{
  p->filter = val;
}
342
static void
Paul Eggert's avatar
Paul Eggert committed
343 344 345 346
pset_log (struct Lisp_Process *p, Lisp_Object val)
{
  p->log = val;
}
347
static void
Paul Eggert's avatar
Paul Eggert committed
348 349 350 351
pset_mark (struct Lisp_Process *p, Lisp_Object val)
{
  p->mark = val;
}
352
static void
Tom Tromey's avatar
Tom Tromey committed
353 354 355 356
pset_thread (struct Lisp_Process *p, Lisp_Object val)
{
  p->thread = val;
}
Tom Tromey's avatar
Tom Tromey committed
357
static void
Paul Eggert's avatar
Paul Eggert committed
358 359 360 361
pset_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->name = val;
}
362
static void
Paul Eggert's avatar
Paul Eggert committed
363 364 365 366
pset_plist (struct Lisp_Process *p, Lisp_Object val)
{
  p->plist = val;
}
367
static void
Paul Eggert's avatar
Paul Eggert committed
368 369 370 371
pset_sentinel (struct Lisp_Process *p, Lisp_Object val)
{
  p->sentinel = val;
}
372
static void
Paul Eggert's avatar
Paul Eggert committed
373 374 375 376
pset_status (struct Lisp_Process *p, Lisp_Object val)
{
  p->status = val;
}
377
static void
Paul Eggert's avatar
Paul Eggert committed
378 379 380 381
pset_tty_name (struct Lisp_Process *p, Lisp_Object val)
{
  p->tty_name = val;
}
382
static void
Paul Eggert's avatar
Paul Eggert committed
383 384 385 386
pset_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->type = val;
}
387
static void
Paul Eggert's avatar
Paul Eggert committed
388 389 390 391 392
pset_write_queue (struct Lisp_Process *p, Lisp_Object val)
{
  p->write_queue = val;
}

393 394


395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
enum fd_bits
{
  /* Read from file descriptor.  */
  FOR_READ = 1,
  /* Write to file descriptor.  */
  FOR_WRITE = 2,
  /* This descriptor refers to a keyboard.  Only valid if FOR_READ is
     set.  */
  KEYBOARD_FD = 4,
  /* This descriptor refers to a process.  */
  PROCESS_FD = 8,
  /* A non-blocking connect.  Only valid if FOR_WRITE is set.  */
  NON_BLOCKING_CONNECT_FD = 16
};

410
static struct fd_callback_data
411 412 413
{
  fd_callback func;
  void *data;
414 415
  /* Flags from enum fd_bits.  */
  int flags;
Tom Tromey's avatar
Tom Tromey committed
416 417 418 419 420 421 422
  /* If this fd is locked to a certain thread, this points to it.
     Otherwise, this is NULL.  If an fd is locked to a thread, then
     only that thread is permitted to wait on it.  */
  struct thread_state *thread;
  /* If this fd is currently being selected on by a thread, this
     points to the thread.  Otherwise it is NULL.  */
  struct thread_state *waiting_thread;
423 424 425 426 427 428 429 430 431
} 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)
{
432
  eassert (fd < MAXDESC);
433 434 435 436
  add_keyboard_wait_descriptor (fd);

  fd_callback_info[fd].func = func;
  fd_callback_info[fd].data = data;
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
}

void
add_non_keyboard_read_fd (int fd)
{
  eassert (fd >= 0 && fd < MAXDESC);
  eassert (fd_callback_info[fd].func == NULL);
  fd_callback_info[fd].flags |= FOR_READ;
  if (fd > max_input_desc)
    max_input_desc = fd;
}

void
add_process_read_fd (int fd)
{
  add_non_keyboard_read_fd (fd);
  fd_callback_info[fd].flags |= PROCESS_FD;
454 455 456 457 458 459 460
}

/* Stop monitoring file descriptor FD for when read is possible.  */

void
delete_read_fd (int fd)
{
461
  eassert (fd < MAXDESC);
462 463
  delete_keyboard_wait_descriptor (fd);

464
  if (fd_callback_info[fd].flags == 0)
465 466 467 468 469 470 471 472 473 474 475 476
    {
      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)
{
477
  eassert (fd < MAXDESC);
478 479 480 481 482
  if (fd > max_input_desc)
    max_input_desc = fd;

  fd_callback_info[fd].func = func;
  fd_callback_info[fd].data = data;
483 484 485 486 487 488 489 490 491 492 493 494 495
  fd_callback_info[fd].flags |= FOR_WRITE;
}

void
add_non_blocking_write_fd (int fd)
{
  eassert (fd >= 0 && fd < MAXDESC);
  eassert (fd_callback_info[fd].func == NULL);

  fd_callback_info[fd].flags |= FOR_WRITE | NON_BLOCKING_CONNECT_FD;
  if (fd > max_input_desc)
    max_input_desc = fd;
  ++num_pending_connects;
496 497 498 499 500 501 502 503 504
}

/* Stop monitoring file descriptor FD for when write is possible.  */

void
delete_write_fd (int fd)
{
  int lim = max_input_desc;

505
  eassert (fd < MAXDESC);
506 507 508 509 510 511 512
  if ((fd_callback_info[fd].flags & NON_BLOCKING_CONNECT_FD) != 0)
    {
      if (--num_pending_connects < 0)
	abort ();
    }
  fd_callback_info[fd].flags &= ~(FOR_WRITE | NON_BLOCKING_CONNECT_FD);
  if (fd_callback_info[fd].flags == 0)
513 514 515 516 517
    {
      fd_callback_info[fd].func = 0;
      fd_callback_info[fd].data = 0;

      if (fd == max_input_desc)
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
	{
	  for (fd = max_input_desc; fd >= 0; --fd)
	    {
	      if (fd_callback_info[fd].flags != 0)
		{
		  max_input_desc = fd;
		  break;
		}
	    }
	}
    }
}

static void
compute_input_wait_mask (SELECT_TYPE *mask)
{
  int fd;
535

536 537 538
  FD_ZERO (mask);
  for (fd = 0; fd < max (max_process_desc, max_input_desc); ++fd)
    {
Tom Tromey's avatar
Tom Tromey committed
539 540 541 542 543 544
      if (fd_callback_info[fd].thread != NULL
	  && fd_callback_info[fd].thread != current_thread)
	continue;
      if (fd_callback_info[fd].waiting_thread != NULL
	  && fd_callback_info[fd].waiting_thread != current_thread)
	continue;
545
      if ((fd_callback_info[fd].flags & FOR_READ) != 0)
Tom Tromey's avatar
Tom Tromey committed
546 547 548 549
	{
	  FD_SET (fd, mask);
	  fd_callback_info[fd].waiting_thread = current_thread;
	}
550 551 552
    }
}

553 554 555 556 557 558 559 560
static void
compute_non_process_wait_mask (SELECT_TYPE *mask)
{
  int fd;

  FD_ZERO (mask);
  for (fd = 0; fd < max (max_process_desc, max_input_desc); ++fd)
    {
Tom Tromey's avatar
Tom Tromey committed
561 562 563 564 565 566
      if (fd_callback_info[fd].thread != NULL
	  && fd_callback_info[fd].thread != current_thread)
	continue;
      if (fd_callback_info[fd].waiting_thread != NULL
	  && fd_callback_info[fd].waiting_thread != current_thread)
	continue;
567 568
      if ((fd_callback_info[fd].flags & FOR_READ) != 0
	  && (fd_callback_info[fd].flags & PROCESS_FD) == 0)
Tom Tromey's avatar
Tom Tromey committed
569 570 571 572
	{
	  FD_SET (fd, mask);
	  fd_callback_info[fd].waiting_thread = current_thread;
	}
573 574 575 576 577 578 579 580 581 582 583
    }
}

static void
compute_non_keyboard_wait_mask (SELECT_TYPE *mask)
{
  int fd;

  FD_ZERO (mask);
  for (fd = 0; fd < max (max_process_desc, max_input_desc); ++fd)
    {
Tom Tromey's avatar
Tom Tromey committed
584 585 586 587 588 589
      if (fd_callback_info[fd].thread != NULL
	  && fd_callback_info[fd].thread != current_thread)
	continue;
      if (fd_callback_info[fd].waiting_thread != NULL
	  && fd_callback_info[fd].waiting_thread != current_thread)
	continue;
590 591
      if ((fd_callback_info[fd].flags & FOR_READ) != 0
	  && (fd_callback_info[fd].flags & KEYBOARD_FD) == 0)
Tom Tromey's avatar
Tom Tromey committed
592 593 594 595
	{
	  FD_SET (fd, mask);
	  fd_callback_info[fd].waiting_thread = current_thread;
	}
596 597 598 599 600 601 602 603 604 605 606
    }
}

static void
compute_write_mask (SELECT_TYPE *mask)
{
  int fd;

  FD_ZERO (mask);
  for (fd = 0; fd < max (max_process_desc, max_input_desc); ++fd)
    {
Tom Tromey's avatar
Tom Tromey committed
607 608 609 610 611 612
      if (fd_callback_info[fd].thread != NULL
	  && fd_callback_info[fd].thread != current_thread)
	continue;
      if (fd_callback_info[fd].waiting_thread != NULL
	  && fd_callback_info[fd].waiting_thread != current_thread)
	continue;
613
      if ((fd_callback_info[fd].flags & FOR_WRITE) != 0)
Tom Tromey's avatar
Tom Tromey committed
614 615 616 617
	{
	  FD_SET (fd, mask);
	  fd_callback_info[fd].waiting_thread = current_thread;
	}
618 619 620
    }
}

Tom Tromey's avatar
Tom Tromey committed
621 622 623 624
static void
clear_waiting_thread_info (void)
{
  int fd;
625

Tom Tromey's avatar
Tom Tromey committed
626 627 628 629 630 631
  for (fd = 0; fd < max (max_process_desc, max_input_desc); ++fd)
    {
      if (fd_callback_info[fd].waiting_thread == current_thread)
	fd_callback_info[fd].waiting_thread = NULL;
    }
}
632

Jim Blandy's avatar
Jim Blandy committed
633 634 635 636

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

637
static Lisp_Object status_convert (int);
638

639
static void
640
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
641
{
642
  eassert (p->raw_status_new);
Paul Eggert's avatar
Paul Eggert committed
643
  pset_status (p, status_convert (p->raw_status));
644
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
645 646
}

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

650
static Lisp_Object
651
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
652 653 654 655
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
Paul Eggert's avatar
Paul Eggert committed
656
    return Fcons (Qexit, Fcons (make_number (WEXITSTATUS (w)),
Jim Blandy's avatar
Jim Blandy committed
657 658 659 660 661 662 663 664 665 666 667
				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.  */

668
static void
669
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, bool *coredump)
Jim Blandy's avatar
Jim Blandy committed
670 671 672
{
  Lisp_Object tem;

673
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
674 675 676 677 678 679 680
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
681 682 683 684
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
685 686 687 688 689 690
      *coredump = !NILP (tem);
    }
}

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

691
static Lisp_Object
692
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
693
{
694
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
695
  Lisp_Object symbol;
696 697
  int code;
  bool coredump;
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701 702 703
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
704
      char const *signame;
705
      synchronize_system_messages_locale ();
706
      signame = strsignal (code);
707
      if (signame == 0)
708 709 710 711 712
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

713
	  string = build_unibyte_string (signame);
714 715 716
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
717
	  c1 = STRING_CHAR (SDATA (string));
718
	  c2 = downcase (c1);
719
	  if (c1 != c2)
720
	    Faset (string, make_number (0), make_number (c2));
721
	}
Jim Blandy's avatar
Jim Blandy committed
722 723 724 725 726
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
727 728
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
729 730
      if (code == 0)
	return build_string ("finished\n");
731
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
732
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
733 734
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
735
    }
736 737 738 739
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
740 741
      return concat3 (build_string ("failed with code "),
		      string, string2);
742
    }
Jim Blandy's avatar
Jim Blandy committed
743 744 745 746 747 748
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

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

752 753 754 755 756
/* 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.  */

757
static int
758
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
759 760 761 762 763 764
{
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
765
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
766 767 768 769 770 771 772 773 774 775
  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 */

776 777 778
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
779
	fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
780
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
781 782 783 784 785 786 787 788

	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
789
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
790
#endif /* no PTY_TTY_NAME_SPRINTF */
791
	    if (faccessat (AT_FDCWD, pty_name, R_OK | W_OK, AT_EACCESS) != 0)
Jim Blandy's avatar
Jim Blandy committed
792
	      {
793
		emacs_close (fd);
794
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
795
		continue;
796
# else
Jim Blandy's avatar
Jim Blandy committed
797
		return -1;
798
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
799 800 801 802 803 804 805 806 807
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

808
static Lisp_Object
809
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
810 811 812
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
813 814
  char suffix[sizeof "<>" + INT_STRLEN_BOUND (printmax_t)];
  printmax_t i;
Jim Blandy's avatar
Jim Blandy committed
815

816
  p = allocate_process ();
817 818
  /* 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
819 820
  pset_status (p, Qrun);
  pset_mark (p, Fmake_marker ());
Tom Tromey's avatar
Tom Tromey committed
821
  pset_thread (p, Fcurrent_thread ());
Jim Blandy's avatar
Jim Blandy committed
822

823 824 825 826
  /* 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
827

Ted Zlatanov's avatar
Ted Zlatanov committed
828 829 830 831
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
#endif

Jim Blandy's avatar
Jim Blandy committed
832 833 834 835 836 837 838
  /* 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;
839
      name1 = concat2 (name, make_formatted_string (suffix, "<%"pMd">", i));
Jim Blandy's avatar
Jim Blandy committed
840 841
    }
  name = name1;
Paul Eggert's avatar
Paul Eggert committed
842
  pset_name (p, name);
843
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
844 845 846 847
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

848
static void
849
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
850 851 852 853 854 855 856 857
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
858

Tom Tromey's avatar
Tom Tromey committed
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
void
update_processes_for_thread_death (Lisp_Object dying_thread)
{
  Lisp_Object pair;

  for (pair = Vprocess_alist; !NILP (pair); pair = XCDR (pair))
    {
      Lisp_Object process = XCDR (XCAR (pair));
      if (EQ (XPROCESS (process)->thread, dying_thread))
	{
	  struct Lisp_Process *proc = XPROCESS (process);

	  proc->thread = Qnil;
	  if (proc->infd >= 0)
	    fd_callback_info[proc->infd].thread = NULL;
	  if (proc->outfd >= 0)
	    fd_callback_info[proc->outfd].thread = NULL;
	}
    }
}

Jim Blandy's avatar
Jim Blandy committed
880 881

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
882
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
883
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
884
{
885
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
886 887 888
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
889
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
890
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
891
{
892
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
893
    return name;
894
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
895 896 897
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
898 899 900 901
/* 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
902

903
static Lisp_Object
904
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
905
{
906 907 908 909 910 911 912
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
913
	error ("Process %s does not exist", SDATA (name));
914 915 916
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
917
  else
918 919 920 921 922
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
923
    {
924
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
925
      if (NILP (proc))
Tom Tromey's avatar
Tom Tromey committed
926
	error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
927 928
    }
  else
929
    {
930
      CHECK_PROCESS (obj);
931 932 933
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
934 935
}

936 937 938

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

   Some processes created by call-process are also put onto this list.  */
943 944
static Lisp_Object deleted_pid_list;

945 946 947 948 949 950 951 952
void
record_deleted_pid (pid_t pid)
{
  deleted_pid_list = Fcons (make_fixnum_or_float (pid),
			    /* GC treated elements set to nil.  */
			    Fdelq (Qnil, deleted_pid_list));

}
953

Jim Blandy's avatar
Jim Blandy committed
954
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
955 956 957
       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
958
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
959
{
960 961
  register struct Lisp_Process *p;

962
  process = get_process (process);
963 964
  p = XPROCESS (process);

965
  p->raw_status_new = 0;
966
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
967
    {
Paul Eggert's avatar
Paul Eggert committed
968
      pset_status (p, Fcons (Qexit, Fcons (make_number (0), Qnil)));
969
      p->tick = ++process_tick;
970
      status_notify (p);
971
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
972
    }
973
  else
Jim Blandy's avatar
Jim Blandy committed
974
    {
975 976 977 978
      if (p->alive)
	record_kill_process (p);

      if (p->infd >= 0)
979
	{
980 981 982 983 984 985 986 987 988
	  /* 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)));

989
	  p->tick = ++process_tick;
990
	  status_notify (p);
991
	  redisplay_preserve_echo_area (13);
992
	}
Jim Blandy's avatar
Jim Blandy committed
993
    }
994
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
995 996 997 998
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
999 1000 1001 1002 1003 1004 1005
       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.
1006
listen -- for a network stream server that is listening.
1007
closed -- for a network stream connection that is closed.
1008 1009
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
1010 1011 1012
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
1013
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1014 1015 1016
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
1017

1018 1019
  if (STRINGP (process))
    process = Fget_process (process);
1020
  else
1021
    process = get_process (process);
1022

1023 1024
  if (NILP (process))
    return process;
1025

1026
  p = XPROCESS (process);
1027
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
1028
    update_status (p);
1029
  status = p->status;
1030
  if (CONSP (status))
1031
    status = XCAR (status);
1032
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
1033
    {
1034
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
1035
	status = Qclosed;
1036
      else if (EQ (p->command, Qt))
1037 1038 1039
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
1040 1041 1042 1043 1044 1045
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
1046 1047
       doc: /* Return the exit status of PROCESS or the signal number that killed it.
If PROCESS has not yet exited or died, return 0.  */)