process.c 209 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 149 150 151 152 153 154 155 156
Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname, Qtpgid;
Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime, Qcstime;
Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtime, Qctime;
Lisp_Object QCname, QCtype;

/* Non-zero if keyboard input is on hold, zero otherwise.  */

static int kbd_is_on_hold;

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

157 158
#ifdef subprocesses

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

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

/* 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
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
238 239 240 241 242 243 244

static int process_output_skip;

#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 int 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 265 266 267
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

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

static SELECT_TYPE non_process_wait_mask;

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

278
static SELECT_TYPE write_mask;
279

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

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

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

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

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

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

309
static int proc_buffered_char[MAXDESC];
310

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

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

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

410 411


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

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

491 492 493
    }
}

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

498
static Lisp_Object status_convert (int);
499

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  deactivate_process (proc);
}
717

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

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

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

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

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

774 775 776

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

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

783 784 785 786 787 788 789 790 791
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));

}

Jim Blandy's avatar
Jim Blandy committed
792
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
793 794 795
       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
796
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
797
{
798 799
  register struct Lisp_Process *p;

800
  process = get_process (process);
801 802
  p = XPROCESS (process);

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

      if (p->infd >= 0)
817
	{
818 819 820 821 822 823 824 825 826
	  /* 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)));

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

856 857
  if (STRINGP (process))
    process = Fget_process (process);
858
  else
859
    process = get_process (process);
860

861 862
  if (NILP (process))
    return process;
863

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

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

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

904
  CHECK_PROCESS (process);
905 906
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
907 908 909
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
910 911 912
       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
913
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
914
{
915
  CHECK_PROCESS (process);
916
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
917 918 919
}

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

931
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
932 933 934
       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
935
  (register Lisp_Object process)
936
{
937
  CHECK_PROCESS (process);
938
  return XPROCESS (process)->tty_name;
939 940
}

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

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

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
961 962 963
       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
964
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
965
{
966
  CHECK_PROCESS (process);
967
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
968 969 970
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
971 972
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
973
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
974
{