process.c 212 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-2011
  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>
23
#include <signal.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 27 28 29
#include <stdio.h>
#include <errno.h>
#include <setjmp.h>
#include <sys/types.h>		/* some typedefs are used in sys/file.h */
#include <sys/file.h>
#include <sys/stat.h>
30
#include <setjmp.h>
31 32 33
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
34

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

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

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

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

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

#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

66 67 68 69 70 71
#ifdef HAVE_RES_INIT
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
#endif

72 73 74 75
#ifdef HAVE_UTIL_H
#include <util.h>
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
76 77 78 79
#ifdef HAVE_PTY_H
#include <pty.h>
#endif

80 81
#endif	/* subprocesses */

82
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
83
#include "systime.h"
84
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
85 86 87

#include "window.h"
#include "buffer.h"
88
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
89
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
90
#include "process.h"
91
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
92 93 94
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
95
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
96
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
97
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
98
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
99
#include "atimer.h"
100 101 102
#include "sysselect.h"
#include "syssignal.h"
#include "syswait.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
103 104 105
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
106

107 108 109
#if defined (USE_GTK) || defined (HAVE_GCONF)
#include "xgselect.h"
#endif /* defined (USE_GTK) || defined (HAVE_GCONF) */
110 111 112
#ifdef HAVE_NS
#include "nsterm.h"
#endif
Dan Nicolaescu's avatar
Dan Nicolaescu committed
113

114 115 116 117 118 119 120 121 122 123 124 125 126 127
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;

128 129
#ifdef subprocesses

130
Lisp_Object Qprocessp;
Kim F. Storm's avatar
Kim F. Storm committed
131
Lisp_Object Qrun, Qstop, Qsignal;
132
Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
Stefan Monnier's avatar
Stefan Monnier committed
133
Lisp_Object Qlocal, Qipv4, Qdatagram, Qseqpacket;
134
Lisp_Object Qreal, Qnetwork, Qserial;
Kim F. Storm's avatar
Kim F. Storm committed
135 136 137
#ifdef AF_INET6
Lisp_Object Qipv6;
#endif
138 139 140
Lisp_Object QCport, QCspeed, QCprocess;
Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
141
Lisp_Object QCbuffer, QChost, QCservice;
142
Lisp_Object QClocal, QCremote, QCcoding;
143
Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
144
Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
145
Lisp_Object Qlast_nonmenu_event;
146 147 148 149
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

152 153 154 155 156
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

157 158 159 160
#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
161

162 163 164 165
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

166 167
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
168
/* Number of events of change of status of a process.  */
169
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
170
/* Number of events for which the user or sentinel has been notified.  */
171
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
172

173 174
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

175
/* Only W32 has this, it really means that select can't take write mask.  */
176 177
#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
178
#define SELECT_CANT_DO_WRITE_MASK
179 180 181 182 183 184 185 186 187 188 189 190 191 192
#else
#ifndef NON_BLOCKING_CONNECT
#ifdef HAVE_SELECT
#if defined (HAVE_GETPEERNAME) || defined (GNU_LINUX)
#if defined (O_NONBLOCK) || defined (O_NDELAY)
#if defined (EWOULDBLOCK) || defined (EINPROGRESS)
#define NON_BLOCKING_CONNECT
#endif /* EWOULDBLOCK || EINPROGRESS */
#endif /* O_NONBLOCK || O_NDELAY */
#endif /* HAVE_GETPEERNAME || GNU_LINUX */
#endif /* HAVE_SELECT */
#endif /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
/* Define DATAGRAM_SOCKETS if datagrams can be used safely on
   this system.  We need to read full packets, so we need a
   "non-destructive" select.  So we require either native select,
   or emulation of select using FIONREAD.  */

#ifdef BROKEN_DATAGRAM_SOCKETS
#undef DATAGRAM_SOCKETS
#else
#ifndef DATAGRAM_SOCKETS
#if defined (HAVE_SELECT) || defined (FIONREAD)
#if defined (HAVE_SENDTO) && defined (HAVE_RECVFROM) && defined (EMSGSIZE)
#define DATAGRAM_SOCKETS
#endif /* HAVE_SENDTO && HAVE_RECVFROM && EMSGSIZE */
#endif /* HAVE_SELECT || FIONREAD */
#endif /* DATAGRAM_SOCKETS */
#endif /* BROKEN_DATAGRAM_SOCKETS */

Stefan Monnier's avatar
Stefan Monnier committed
210 211 212 213
#if defined HAVE_LOCAL_SOCKETS && defined DATAGRAM_SOCKETS
# define HAVE_SEQPACKET
#endif

Kenichi Handa's avatar
Kenichi Handa committed
214 215 216 217 218 219 220 221 222 223 224
#if !defined (ADAPTIVE_READ_BUFFERING) && !defined (NO_ADAPTIVE_READ_BUFFERING)
#ifdef EMACS_HAS_USECS
#define ADAPTIVE_READ_BUFFERING
#endif
#endif

#ifdef ADAPTIVE_READ_BUFFERING
#define READ_OUTPUT_DELAY_INCREMENT 10000
#define READ_OUTPUT_DELAY_MAX       (READ_OUTPUT_DELAY_INCREMENT * 5)
#define READ_OUTPUT_DELAY_MAX_MAX   (READ_OUTPUT_DELAY_INCREMENT * 7)

225 226
/* 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
227 228 229

static int process_output_delay_count;

230
/* Non-zero if any process has non-nil read_output_skip.  */
Kenichi Handa's avatar
Kenichi Handa committed
231 232 233 234 235 236 237

static int process_output_skip;

#else
#define process_output_delay_count 0
#endif

238 239 240 241 242
static int keyboard_bit_set (SELECT_TYPE *);
static void deactivate_process (Lisp_Object);
static void status_notify (struct Lisp_Process *);
static int read_process_output (Lisp_Object, int);
static void create_pty (Lisp_Object);
243

244
/* If we support a window system, turn on the code to poll periodically
245
   to detect C-g.  It isn't actually used when doing interrupt input.  */
246
#ifdef HAVE_WINDOW_SYSTEM
247 248 249
#define POLL_FOR_INPUT
#endif

250 251
static Lisp_Object get_process (register Lisp_Object name);
static void exec_sentinel (Lisp_Object proc, Lisp_Object reason);
252

253 254 255 256
/* Mask of bits indicating the descriptors that we wait for input on.  */

static SELECT_TYPE input_wait_mask;

257
/* Mask that excludes keyboard input descriptor(s).  */
258 259 260

static SELECT_TYPE non_keyboard_wait_mask;

261
/* Mask that excludes process input descriptor(s).  */
262 263 264

static SELECT_TYPE non_process_wait_mask;

265
/* Mask for selecting for write.  */
266

267
static SELECT_TYPE write_mask;
268

269
#ifdef NON_BLOCKING_CONNECT
270 271 272 273 274 275 276 277
/* 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;
278
#endif	/* NON_BLOCKING_CONNECT */
279

280 281 282
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

283 284
/* The largest descriptor currently in use for input.  */
static int max_input_desc;
285

Jim Blandy's avatar
Jim Blandy committed
286
/* Indexed by descriptor, gives the process (if any) for that descriptor */
287
Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
288 289

/* Alist of elements (NAME . PROCESS) */
290
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
291 292 293 294 295 296 297

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

298 299
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
300

Karl Heuer's avatar
Karl Heuer committed
301
/* Table of `struct coding-system' for each process.  */
302 303
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
304

305 306 307 308 309 310 311
#ifdef DATAGRAM_SOCKETS
/* Table of `partner address' for datagram sockets.  */
struct sockaddr_and_len {
  struct sockaddr *sa;
  int len;
} datagram_address[MAXDESC];
#define DATAGRAM_CHAN_P(chan)	(datagram_address[chan].sa != 0)
312
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XPROCESS (proc)->infd].sa != 0)
313 314 315 316 317
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

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

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400


struct fd_callback_data
{
  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)
{
  xassert (fd < MAXDESC);
  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)
{
  xassert (fd < MAXDESC);
  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)
{
  xassert (fd < MAXDESC);
  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;

  xassert (fd < MAXDESC);
  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;
            }
401

402 403 404
    }
}

Jim Blandy's avatar
Jim Blandy committed
405 406 407 408

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

409
static Lisp_Object status_convert (int);
410

411
static void
412
update_status (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
413
{
414
  eassert (p->raw_status_new);
415
  p->status = status_convert (p->raw_status);
416
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
417 418
}

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

422
static Lisp_Object
423
status_convert (int w)
Jim Blandy's avatar
Jim Blandy committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
{
  if (WIFSTOPPED (w))
    return Fcons (Qstop, Fcons (make_number (WSTOPSIG (w)), Qnil));
  else if (WIFEXITED (w))
    return Fcons (Qexit, Fcons (make_number (WRETCODE (w)),
				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.  */

440
static void
441
decode_status (Lisp_Object l, Lisp_Object *symbol, int *code, int *coredump)
Jim Blandy's avatar
Jim Blandy committed
442 443 444
{
  Lisp_Object tem;

445
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449 450 451 452
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
453 454 455 456
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460 461 462
      *coredump = !NILP (tem);
    }
}

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

463
static Lisp_Object
464
status_message (struct Lisp_Process *p)
Jim Blandy's avatar
Jim Blandy committed
465
{
466
  Lisp_Object status = p->status;
Jim Blandy's avatar
Jim Blandy committed
467 468 469 470 471 472 473 474
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
475
      char *signame;
476
      synchronize_system_messages_locale ();
477
      signame = strsignal (code);
478
      if (signame == 0)
479 480 481 482 483 484 485 486 487
	string = build_string ("unknown");
      else
	{
	  int c1, c2;

	  string = make_unibyte_string (signame, strlen (signame));
	  if (! NILP (Vlocale_coding_system))
	    string = (code_convert_string_norecord
		      (string, Vlocale_coding_system, 0));
488
	  c1 = STRING_CHAR (SDATA (string));
489
	  c2 = downcase (c1);
490
	  if (c1 != c2)
491
	    Faset (string, make_number (0), make_number (c2));
492
	}
Jim Blandy's avatar
Jim Blandy committed
493 494 495 496 497
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
498 499
      if (NETCONN1_P (p))
	return build_string (code == 0 ? "deleted\n" : "connection broken by remote peer\n");
Jim Blandy's avatar
Jim Blandy committed
500 501
      if (code == 0)
	return build_string ("finished\n");
502
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
503
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
504 505
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
506
    }
507 508 509 510
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
511 512
      return concat3 (build_string ("failed with code "),
		      string, string2);
513
    }
Jim Blandy's avatar
Jim Blandy committed
514 515 516 517 518 519
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

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

523 524 525 526 527
/* 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.  */

528
static int
529
allocate_pty (void)
Jim Blandy's avatar
Jim Blandy committed
530 531 532 533 534 535
{
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
536
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
537 538 539 540 541 542 543 544 545 546
  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 */

547 548 549
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
550 551 552 553 554 555 556
	{
	  { /* Some systems name their pseudoterminals so that there are gaps in
	       the usual sequence - for example, on HP9000/S700 systems, there
	       are no pseudoterminals with names ending in 'f'.  So we wait for
	       three failures in a row before deciding that we've reached the
	       end of the ptys.  */
	    int failed_count = 0;
557
	    struct stat stb;
558

559 560 561 562 563 564 565 566
	    if (stat (pty_name, &stb) < 0)
	      {
		failed_count++;
		if (failed_count >= 3)
		  return -1;
	      }
	    else
	      failed_count = 0;
Jim Blandy's avatar
Jim Blandy committed
567
	  }
568 569 570 571 572 573
#  ifdef O_NONBLOCK
	  fd = emacs_open (pty_name, O_RDWR | O_NONBLOCK, 0);
#  else
	  fd = emacs_open (pty_name, O_RDWR | O_NDELAY, 0);
#  endif
	}
574
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
575 576 577 578 579 580 581 582

	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
583
	    sprintf (pty_name, "/dev/tty%c%x", c, i);
Jim Blandy's avatar
Jim Blandy committed
584 585 586
#endif /* no PTY_TTY_NAME_SPRINTF */
	    if (access (pty_name, 6) != 0)
	      {
587
		emacs_close (fd);
588
# ifndef __sgi
Jim Blandy's avatar
Jim Blandy committed
589
		continue;
590
# else
Jim Blandy's avatar
Jim Blandy committed
591
		return -1;
592
# endif /* __sgi */
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596 597 598 599 600 601
	      }
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

602
static Lisp_Object
603
make_process (Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
604 605 606 607 608 609
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

610
  p = allocate_process ();
611

612 613 614 615
  p->infd = -1;
  p->outfd = -1;
  p->tick = 0;
  p->update_tick = 0;
616
  p->pid = 0;
Miles Bader's avatar
Miles Bader committed
617
  p->pty_flag = 0;
618
  p->raw_status_new = 0;
Jim Blandy's avatar
Jim Blandy committed
619 620
  p->status = Qrun;
  p->mark = Fmake_marker ();
621
  p->kill_without_query = 0;
Jim Blandy's avatar
Jim Blandy committed
622

Kenichi Handa's avatar
Kenichi Handa committed
623
#ifdef ADAPTIVE_READ_BUFFERING
624 625 626
  p->adaptive_read_buffering = 0;
  p->read_output_delay = 0;
  p->read_output_skip = 0;
Kenichi Handa's avatar
Kenichi Handa committed
627 628
#endif

Ted Zlatanov's avatar
Ted Zlatanov committed
629 630
#ifdef HAVE_GNUTLS
  p->gnutls_initstage = GNUTLS_STAGE_EMPTY;
631
  p->gnutls_log_level = 0;
632
  p->gnutls_p = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
633 634
#endif

Jim Blandy's avatar
Jim Blandy committed
635 636 637 638 639 640 641 642 643 644 645 646
  /* 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;
      sprintf (suffix, "<%d>", i);
      name1 = concat2 (name, build_string (suffix));
    }
  name = name1;
  p->name = name;
647
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
648 649 650 651
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

652
static void
653
remove_process (register Lisp_Object proc)
Jim Blandy's avatar
Jim Blandy committed
654 655 656 657 658 659 660 661
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
662

Jim Blandy's avatar
Jim Blandy committed
663 664

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
665
       doc: /* Return t if OBJECT is a process.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
666
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
667
{
668
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
669 670 671
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
672
       doc: /* Return the process named NAME, or nil if there is none.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
673
  (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
674
{
675
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
676
    return name;
677
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
678 679 680
  return Fcdr (Fassoc (name, Vprocess_alist));
}

Jim Blandy's avatar
Jim Blandy committed
681 682 683 684
/* 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
685

686
static Lisp_Object
687
get_process (register Lisp_Object name)
Jim Blandy's avatar
Jim Blandy committed
688
{
689 690 691 692 693 694 695
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
696
	error ("Process %s does not exist", SDATA (name));
697 698 699
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
700
  else
701 702 703 704 705
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
706
    {
707
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
708
      if (NILP (proc))
Tom Tromey's avatar
Tom Tromey committed
709
	error ("Buffer %s has no process", SDATA (BVAR (XBUFFER (obj), name)));
Jim Blandy's avatar
Jim Blandy committed
710 711
    }
  else
712
    {
713
      CHECK_PROCESS (obj);
714 715 716
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
717 718
}

719 720 721 722 723 724 725 726 727 728

#ifdef SIGCHLD
/* Fdelete_process promises to immediately forget about the process, but in
   reality, Emacs needs to remember those processes until they have been
   treated by sigchld_handler; otherwise this handler would consider the
   process as being synchronous and say that the synchronous process is
   dead.  */
static Lisp_Object deleted_pid_list;
#endif

Jim Blandy's avatar
Jim Blandy committed
729
DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
730 731 732
       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
733
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
734
{
735 736
  register struct Lisp_Process *p;

737
  process = get_process (process);
738 739
  p = XPROCESS (process);

740
  p->raw_status_new = 0;
741
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
742
    {
743
      p->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
744
      p->tick = ++process_tick;
745
      status_notify (p);
746
      redisplay_preserve_echo_area (13);
Jim Blandy's avatar
Jim Blandy committed
747
    }
748
  else if (p->infd >= 0)
Jim Blandy's avatar
Jim Blandy committed
749
    {
750 751
#ifdef SIGCHLD
      Lisp_Object symbol;
752 753
      /* Assignment to EMACS_INT stops GCC whining about limited range
	 of data type.  */
754
      EMACS_INT pid = p->pid;
755 756

      /* No problem storing the pid here, as it is still in Vprocess_alist.  */
757
      deleted_pid_list = Fcons (make_fixnum_or_float (pid),
758 759 760 761 762 763 764 765 766
				/* GC treated elements set to nil.  */
				Fdelq (Qnil, deleted_pid_list));
      /* If the process has already signaled, remove it from the list.  */
      if (p->raw_status_new)
	update_status (p);
      symbol = p->status;
      if (CONSP (p->status))
	symbol = XCAR (p->status);
      if (EQ (symbol, Qsignal) || EQ (symbol, Qexit))
767 768
	deleted_pid_list
	  = Fdelete (make_fixnum_or_float (pid), deleted_pid_list);
769 770 771 772 773 774 775
      else
#endif
	{
	  Fkill_process (process, Qnil);
	  /* Do this now, since remove_process will make sigchld_handler do nothing.  */
	  p->status
	    = Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
776
	  p->tick = ++process_tick;
777
	  status_notify (p);
778
	  redisplay_preserve_echo_area (13);
779
	}
Jim Blandy's avatar
Jim Blandy committed
780
    }
781
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
782 783 784 785
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
786 787 788 789 790 791 792
       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.
793
listen -- for a network stream server that is listening.
794
closed -- for a network stream connection that is closed.
795 796
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
797 798 799
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
800
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
801 802 803
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
804

805 806
  if (STRINGP (process))
    process = Fget_process (process);
807
  else
808
    process = get_process (process);
809

810 811
  if (NILP (process))
    return process;
812

813
  p = XPROCESS (process);
814
  if (p->raw_status_new)
Jim Blandy's avatar
Jim Blandy committed
815 816
    update_status (p);
  status = p->status;
817
  if (CONSP (status))
818
    status = XCAR (status);
819
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
820
    {
821
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
822
	status = Qclosed;
823 824 825 826
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
827 828 829 830 831 832
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
833 834
       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
835
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
836
{
837
  CHECK_PROCESS (process);
838
  if (XPROCESS (process)->raw_status_new)
839 840
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
841
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
842 843 844 845
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
846
       doc: /* Return the process id of PROCESS.
847
This is the pid of the external process which PROCESS uses or talks to.
848
For a network connection, this value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
849
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
850
{
851 852 853 854
  /* Assignment to EMACS_INT stops GCC whining about limited range of
     data type.  */
  EMACS_INT pid;

855
  CHECK_PROCESS (process);
856 857
  pid = XPROCESS (process)->pid;
  return (pid ? make_fixnum_or_float (pid) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
858 859 860
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
861 862 863
       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
864
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
865
{
866
  CHECK_PROCESS (process);
867
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
868 869 870
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
871 872 873
       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.
874 875
For a network or serial process, this is nil (process is running) or t
\(process is stopped).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
876
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
877
{
878
  CHECK_PROCESS (process);
879
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
880 881
}

882
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
883 884 885
       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
886
  (register Lisp_Object process)
887
{
888
  CHECK_PROCESS (process);
889
  return XPROCESS (process)->tty_name;
890 891
}

Jim Blandy's avatar
Jim Blandy committed
892
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
893 894
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
895
  (register Lisp_Object process, Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
896
{
897 898
  struct Lisp_Process *p;

899
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
900
  if (!NILP (buffer))
901
    CHECK_BUFFER (buffer);
902 903
  p = XPROCESS (process);
  p->buffer = buffer;
904
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
905
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
906
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
907 908 909 910
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
911 912 913
       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
914
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
915
{
916
  CHECK_PROCESS (process);
917
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
918 919 920
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
921 922
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
923
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
924
{
925
  CHECK_PROCESS (process);
926
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
927 928 929
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
930 931
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
932
A value of t means stop accepting output from the process.
933 934 935

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
936
passed to the filter.
937

938
The filter gets two arguments: the process and the string of output.
939 940 941 942 943 944
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
945
  (register Lisp_Object process, Lisp_Object filter)
Jim Blandy's avatar
Jim Blandy committed
946
{
947
  struct Lisp_Process *p;
948

949
  CHECK_PROCESS (process);
950 951 952 953 954 955 956 957 958
  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 ...)  */
959

960
  if (p->infd >= 0)
961
    {
962
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
963
	{
964 965
	  FD_CLR (p->infd, &input_wait_mask);
	  FD_CLR (p->infd, &non_keyboard_wait_mask);
966
	}
967
      else if (EQ (p->filter, Qt)
968 969
	       /* Network or serial process not stopped:  */
	       && !EQ (p->command, Qt))
970
	{
971 972
	  FD_SET (p->infd, &input_wait_mask);
	  FD_SET (p->infd, &non_keyboard_wait_mask);
973
	}
974
    }
975

976
  p->filter = filter;
977
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
978
    p->childp = Fplist_put (p->childp, QCfilter, filter);
979
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
980 981 982 983
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
984 985 986
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
987
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
988
{
989
  CHECK_PROCESS (process);
990
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
991 992 993
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
994 995 996 997
       2, 2, 0,
       doc: /* Give PROCESS the sentinel SENTINEL; nil for none.
The sentinel is called as a function when the process changes state.
It gets two arguments: the process, and a string describing the change.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
998
  (register Lisp_Object process, Lisp_Object sentinel)
Jim Blandy's avatar
Jim Blandy committed
999
{
Kenichi Handa's avatar
Kenichi Handa committed
1000 1001
  struct Lisp_Process *p;

1002
  CHECK_PROCESS (process);
Kenichi Handa's avatar
Kenichi Handa committed
1003 1004 1005
  p = XPROCESS (process);

  p->sentinel = sentinel;
1006
  if (NETCONN1_P (p) || SERIALCONN1_P (p))
Kenichi Handa's avatar
Kenichi Handa committed
1007
    p->childp = Fplist_put (p->childp, QCsentinel, sentinel);
Jim Blandy's avatar
Jim Blandy committed
1008 1009 1010 1011
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
1012 1013 1014
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1015
  (register Lisp_Object process)
Jim Blandy's avatar
Jim Blandy committed
1016
{
1017
  CHECK_PROCESS (process);
1018
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
1019 1020
}

1021
DEFUN ("set-process-window-size", Fset_process_window_size,
1022 1023
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1024
  (register Lisp_Object process, Lisp_Object height, Lisp_Object width)
1025
{
1026 1027 1028
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
1029

1030 1031
  if (XPROCESS (process)->infd < 0
      || set_window_size (XPROCESS (process)->infd,
1032
			  XINT (height), XINT (width)) <= 0)
1033 1034 1035 1036 1037
    return Qnil;
  else
    return Qt;
}

1038
DEFUN ("set-process-inherit-coding-system-flag",
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
       Fset_process_inherit_coding_system_flag,
       Sset_process_inherit_coding_system_flag, 2, 2, 0,
       doc: /* Determine whether buffer of PROCESS will inherit coding-system.
If the second argument FLAG is non-nil, then the variable
`buffer-file-coding-system' of the buffer associated with PROCESS
will be bound to the value of the coding system used to decode
the process output.

This is useful when the coding system specified for the process buffer
leaves either the character code conversion or the end-of-line conversion
unspecified, or if the coding system used to decode the process output
is more appropriate for saving the process buffer.

Binding the variable `inherit-process-coding-system' to non-nil before
starting the process is an alternative way of setting the inherit flag
for the process which will run.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1055
  (register Lisp_Object process, Lisp_Object flag)
1056
{
1057
  CHECK_PROCESS (process);
1058
  XPROCESS (process)->inherit_coding_system_flag = !NILP (flag);
1059 1060 1061
  return flag;
}

1062 1063 1064 1065
DEFUN ("set-process-query-on-exit-flag",
       Fset_process_query_on_exit_flag, Sset_process_query_on_exit_flag,
       2, 2, 0,
       doc: /* Specify if query is needed for PROCESS when Emacs is exited.
1066
If the second argument FLAG is non-nil, Emacs will query the user before
1067
exiting or killing a buffer if PROCESS is running.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1068
  (register Lisp_Object process, Lisp_Object flag)
Jim Blandy's avatar
Jim Blandy committed
1069
{
1070
  CHECK_PROCESS (process);
1071
  XPROCESS (process)->kill_without_query = NILP (flag);
1072
  return flag;
Jim Blandy's avatar
Jim Blandy committed
1073
}
1074

1075