process.c 190 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Asynchronous subprocess control for GNU Emacs.
2
   Copyright (C) 1985, 86, 87, 88, 93, 94, 95, 96, 98, 1999,
3
      2001, 2002, 2003 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

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
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
24 25
#include <signal.h>

Jim Blandy's avatar
Jim Blandy committed
26 27 28 29 30 31 32 33
/* This file is split into two parts by the following preprocessor
   conditional.  The 'then' clause contains all of the support for
   asynchronous subprocesses.  The 'else' clause contains stub
   versions of some of the asynchronous subprocess routines that are
   often called elsewhere in Emacs, so we don't have to #ifdef the
   sections that call them.  */


Jim Blandy's avatar
Jim Blandy committed
34 35 36 37 38 39 40 41
#ifdef subprocesses

#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>
Richard M. Stallman's avatar
Richard M. Stallman committed
42 43 44
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
45

46
#if defined(WINDOWSNT) || defined(UNIX98_PTYS)
47 48 49 50
#include <stdlib.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Jim Blandy's avatar
Jim Blandy committed
51 52 53 54 55
#ifdef HAVE_SOCKETS	/* TCP connection support, if kernel can do it */
#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
56 57 58
#ifdef NEED_NET_ERRNO_H
#include <net/errno.h>
#endif /* NEED_NET_ERRNO_H */
59 60

/* Are local (unix) sockets supported?  */
61
#if defined (HAVE_SYS_UN_H) && !defined (NO_SOCKETS_IN_FILE_SYSTEM)
62 63 64 65 66 67 68 69
#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
70 71
#endif /* HAVE_SOCKETS */

72
/* TERM is a poor-man's SLIP, used on GNU/Linux.  */
73 74 75 76
#ifdef TERM
#include <client.h>
#endif

77 78
/* On some systems, e.g. DGUX, inet_addr returns a 'struct in_addr'. */
#ifdef HAVE_BROKEN_INET_ADDR
79 80 81 82 83 84 85
#define IN_ADDR struct in_addr
#define NUMERIC_ADDR_ERROR (numeric_addr.s_addr == -1)
#else
#define IN_ADDR unsigned long
#define NUMERIC_ADDR_ERROR (numeric_addr == -1)
#endif

86
#if defined(BSD_SYSTEM) || defined(STRIDE)
Jim Blandy's avatar
Jim Blandy committed
87
#include <sys/ioctl.h>
88
#if !defined (O_NDELAY) && defined (HAVE_PTYS) && !defined(USG5)
Jim Blandy's avatar
Jim Blandy committed
89 90
#include <fcntl.h>
#endif /* HAVE_PTYS and no O_NDELAY */
91
#endif /* BSD_SYSTEM || STRIDE */
Jim Blandy's avatar
Jim Blandy committed
92

93 94 95 96
#ifdef BROKEN_O_NONBLOCK
#undef O_NONBLOCK
#endif /* BROKEN_O_NONBLOCK */

Jim Blandy's avatar
Jim Blandy committed
97 98 99 100 101 102 103
#ifdef NEED_BSDTTY
#include <bsdtty.h>
#endif

#ifdef IRIS
#include <sys/sysmacros.h>	/* for "minor" */
#endif /* not IRIS */
104

Dave Love's avatar
Dave Love committed
105 106 107
#ifdef HAVE_SYS_WAIT
#include <sys/wait.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
108 109

#include "systime.h"
110
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
111 112 113 114

#include "lisp.h"
#include "window.h"
#include "buffer.h"
115
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
116
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
117 118 119 120
#include "process.h"
#include "termhooks.h"
#include "termopts.h"
#include "commands.h"
121
#include "keyboard.h"
122
#include "frame.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
123
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
124
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
125
#include "composite.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
126
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
127

128
Lisp_Object Qprocessp;
129
Lisp_Object Qrun, Qstop, Qsignal;
130
Lisp_Object Qopen, Qclosed, Qconnect, Qfailed, Qlisten;
131 132
Lisp_Object Qlocal, Qdatagram;
Lisp_Object QCname, QCbuffer, QChost, QCservice, QCtype;
133
Lisp_Object QClocal, QCremote, QCcoding;
134
Lisp_Object QCserver, QCnowait, QCnoquery, QCstop;
135
Lisp_Object QCsentinel, QClog, QCoptions, QCplist;
Kim F. Storm's avatar
Kim F. Storm committed
136
Lisp_Object QCfilter_multibyte;
137
Lisp_Object Qlast_nonmenu_event;
138 139 140 141
/* QCfamily is declared and initialized in xfaces.c,
   QCfilter in keyboard.c.  */
extern Lisp_Object QCfamily, QCfilter;

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

144 145 146 147 148
/* QCfamily is defined in xfaces.c.  */
extern Lisp_Object QCfamily;
/* QCfilter is defined in keyboard.c.  */
extern Lisp_Object QCfilter;

Jim Blandy's avatar
Jim Blandy committed
149
/* a process object is a network connection when its childp field is neither
150
   Qt nor Qnil but is instead a property list (KEY VAL ...).  */
Jim Blandy's avatar
Jim Blandy committed
151 152

#ifdef HAVE_SOCKETS
153
#define NETCONN_P(p) (GC_CONSP (XPROCESS (p)->childp))
154
#define NETCONN1_P(p) (GC_CONSP ((p)->childp))
Jim Blandy's avatar
Jim Blandy committed
155 156
#else
#define NETCONN_P(p) 0
157
#define NETCONN1_P(p) 0
Jim Blandy's avatar
Jim Blandy committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
#endif /* HAVE_SOCKETS */

/* Define first descriptor number available for subprocesses.  */
#ifdef VMS
#define FIRST_PROC_DESC 1
#else /* Not VMS */
#define FIRST_PROC_DESC 3
#endif

/* Define SIGCHLD as an alias for SIGCLD.  There are many conditionals
   testing SIGCHLD.  */

#if !defined (SIGCHLD) && defined (SIGCLD)
#define SIGCHLD SIGCLD
#endif /* SIGCLD */

#include "syssignal.h"

Richard M. Stallman's avatar
Richard M. Stallman committed
176
#include "syswait.h"
Jim Blandy's avatar
Jim Blandy committed
177

178 179
extern void set_waiting_for_input P_ ((EMACS_TIME *));

180
#ifndef USE_CRT_DLL
Roland McGrath's avatar
Roland McGrath committed
181
extern int errno;
182
#endif
Roland McGrath's avatar
Roland McGrath committed
183
#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
184
extern char *sys_errlist[];
Roland McGrath's avatar
Roland McGrath committed
185
#endif
Jim Blandy's avatar
Jim Blandy committed
186

187 188 189 190
#ifndef HAVE_H_ERRNO
extern int h_errno;
#endif

Jim Blandy's avatar
Jim Blandy committed
191 192
/* t means use pty, nil means use a pipe,
   maybe other values to come.  */
193
static Lisp_Object Vprocess_connection_type;
Jim Blandy's avatar
Jim Blandy committed
194 195 196 197 198 199 200

#ifdef SKTPAIR
#ifndef HAVE_SOCKETS
#include <sys/socket.h>
#endif
#endif /* SKTPAIR */

201 202
/* These next two vars are non-static since sysdep.c uses them in the
   emulation of `select'.  */
Jim Blandy's avatar
Jim Blandy committed
203
/* Number of events of change of status of a process.  */
204
int process_tick;
Jim Blandy's avatar
Jim Blandy committed
205
/* Number of events for which the user or sentinel has been notified.  */
206
int update_tick;
Jim Blandy's avatar
Jim Blandy committed
207

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
/* Define NON_BLOCKING_CONNECT if we can support non-blocking connects.  */

#ifdef BROKEN_NON_BLOCKING_CONNECT
#undef NON_BLOCKING_CONNECT
#else
#ifndef NON_BLOCKING_CONNECT
#ifdef HAVE_SOCKETS
#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 /* HAVE_SOCKETS */
#endif /* NON_BLOCKING_CONNECT */
#endif /* BROKEN_NON_BLOCKING_CONNECT */

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
/* 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
#ifdef HAVE_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 /* HAVE_SOCKETS */
#endif /* DATAGRAM_SOCKETS */
#endif /* BROKEN_DATAGRAM_SOCKETS */

247 248
#ifdef TERM
#undef NON_BLOCKING_CONNECT
249
#undef DATAGRAM_SOCKETS
250 251
#endif

252

253
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
254

255 256
extern int keyboard_bit_set P_ ((SELECT_TYPE *));

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

263
/* Mask of bits indicating the descriptors that we wait for input on.  */
Jim Blandy's avatar
Jim Blandy committed
264

265 266
static SELECT_TYPE input_wait_mask;

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

static SELECT_TYPE non_keyboard_wait_mask;

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

static SELECT_TYPE non_process_wait_mask;

275 276 277 278 279 280 281 282 283
/* 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;

284 285 286
/* The largest descriptor currently in use for a process object.  */
static int max_process_desc;

287 288
/* The largest descriptor currently in use for keyboard input.  */
static int max_keyboard_desc;
Jim Blandy's avatar
Jim Blandy committed
289

290 291
/* Nonzero means delete a process right away if it exits.  */
static int delete_exited_processes;
Jim Blandy's avatar
Jim Blandy committed
292 293

/* Indexed by descriptor, gives the process (if any) for that descriptor */
294
Lisp_Object chan_process[MAXDESC];
Jim Blandy's avatar
Jim Blandy committed
295 296

/* Alist of elements (NAME . PROCESS) */
297
Lisp_Object Vprocess_alist;
Jim Blandy's avatar
Jim Blandy committed
298 299 300 301 302 303 304

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

305 306
/* Don't make static; need to access externally.  */
int proc_buffered_char[MAXDESC];
307

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

312 313 314 315 316 317 318
#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)
319
#define DATAGRAM_CONN_P(proc)	(PROCESSP (proc) && datagram_address[XINT (XPROCESS (proc)->infd)].sa != 0)
320 321 322 323 324
#else
#define DATAGRAM_CHAN_P(chan)	(0)
#define DATAGRAM_CONN_P(proc)	(0)
#endif

325
static Lisp_Object get_process ();
326
static void exec_sentinel ();
Richard M. Stallman's avatar
Richard M. Stallman committed
327

328
extern EMACS_TIME timer_check ();
329
extern int timers_run;
330

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

334
extern Lisp_Object Vfile_name_coding_system, Vdefault_file_name_coding_system;
335

336
#ifdef HAVE_PTYS
Dave Love's avatar
Dave Love committed
337 338 339
#ifdef HAVE_PTY_H
#include <pty.h>
#endif
340
/* The file name of the pty opened by allocate_pty.  */
341 342

static char pty_name[24];
343
#endif
Jim Blandy's avatar
Jim Blandy committed
344 345 346 347

/* Compute the Lisp form of the process status, p->status, from
   the numeric status that was returned by `wait'.  */

348 349
Lisp_Object status_convert ();

Andreas Schwab's avatar
Andreas Schwab committed
350
void
Jim Blandy's avatar
Jim Blandy committed
351 352 353 354 355 356 357 358 359 360
update_status (p)
     struct Lisp_Process *p;
{
  union { int i; WAITTYPE wt; } u;
  u.i = XFASTINT (p->raw_status_low) + (XFASTINT (p->raw_status_high) << 16);
  p->status = status_convert (u.wt);
  p->raw_status_low = Qnil;
  p->raw_status_high = Qnil;
}

361
/*  Convert a process status word in Unix format to
Jim Blandy's avatar
Jim Blandy committed
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
    the list that we use internally.  */

Lisp_Object
status_convert (w)
     WAITTYPE w;
{
  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.  */

void
decode_status (l, symbol, code, coredump)
     Lisp_Object l;
     Lisp_Object *symbol;
     int *code;
     int *coredump;
{
  Lisp_Object tem;

392
  if (SYMBOLP (l))
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396 397 398 399
    {
      *symbol = l;
      *code = 0;
      *coredump = 0;
    }
  else
    {
400 401 402 403
      *symbol = XCAR (l);
      tem = XCDR (l);
      *code = XFASTINT (XCAR (tem));
      tem = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
404 405 406 407 408 409
      *coredump = !NILP (tem);
    }
}

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

410
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
411 412 413 414 415 416 417 418 419 420 421
status_message (status)
     Lisp_Object status;
{
  Lisp_Object symbol;
  int code, coredump;
  Lisp_Object string, string2;

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

  if (EQ (symbol, Qsignal) || EQ (symbol, Qstop))
    {
422
      char *signame;
423
      synchronize_system_messages_locale ();
424
      signame = strsignal (code);
425 426 427
      if (signame == 0)
	signame = "unknown";
      string = build_string (signame);
Jim Blandy's avatar
Jim Blandy committed
428
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
429
      SSET (string, 0, DOWNCASE (SREF (string, 0)));
Jim Blandy's avatar
Jim Blandy committed
430 431 432 433 434 435
      return concat2 (string, string2);
    }
  else if (EQ (symbol, Qexit))
    {
      if (code == 0)
	return build_string ("finished\n");
436
      string = Fnumber_to_string (make_number (code));
Jim Blandy's avatar
Jim Blandy committed
437
      string2 = build_string (coredump ? " (core dumped)\n" : "\n");
438 439
      return concat3 (build_string ("exited abnormally with code "),
		      string, string2);
Jim Blandy's avatar
Jim Blandy committed
440
    }
441 442 443 444
  else if (EQ (symbol, Qfailed))
    {
      string = Fnumber_to_string (make_number (code));
      string2 = build_string ("\n");
445 446
      return concat3 (build_string ("failed with code "),
		      string, string2);
447
    }
Jim Blandy's avatar
Jim Blandy committed
448 449 450 451 452 453
  else
    return Fcopy_sequence (Fsymbol_name (symbol));
}

#ifdef HAVE_PTYS

454 455 456 457 458
/* 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.  */

Jim Blandy's avatar
Jim Blandy committed
459 460 461
int
allocate_pty ()
{
Andreas Schwab's avatar
Andreas Schwab committed
462
  register int c, i;
Jim Blandy's avatar
Jim Blandy committed
463 464 465 466 467 468 469 470 471
  int fd;

#ifdef PTY_ITERATION
  PTY_ITERATION
#else
  for (c = FIRST_PTY_LETTER; c <= 'z'; c++)
    for (i = 0; i < 16; i++)
#endif
      {
472
	struct stat stb;	/* Used in some PTY_OPEN.  */
Jim Blandy's avatar
Jim Blandy committed
473 474 475 476 477 478
#ifdef PTY_NAME_SPRINTF
	PTY_NAME_SPRINTF
#else
	sprintf (pty_name, "/dev/pty%c%x", c, i);
#endif /* no PTY_NAME_SPRINTF */

479 480 481
#ifdef PTY_OPEN
	PTY_OPEN;
#else /* no PTY_OPEN */
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
	{
# ifdef IRIS
	  /* Unusual IRIS code */
	  *ptyv = emacs_open ("/dev/ptc", O_RDWR | O_NDELAY, 0);
	  if (fd < 0)
	    return -1;
	  if (fstat (fd, &stb) < 0)
	    return -1;
# else /* not IRIS */
	  { /* 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;
	    
	    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
506
	  }
507 508 509 510 511 512 513
#  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
# endif /* not IRIS */
	}
514
#endif /* no PTY_OPEN */
Jim Blandy's avatar
Jim Blandy committed
515 516 517 518 519 520 521 522 523 524 525 526 527

	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
            sprintf (pty_name, "/dev/tty%c%x", c, i);
#endif /* no PTY_TTY_NAME_SPRINTF */
#ifndef UNIPLUS
	    if (access (pty_name, 6) != 0)
	      {
528
		emacs_close (fd);
529
# if !defined(IRIS) && !defined(__sgi)
Jim Blandy's avatar
Jim Blandy committed
530
		continue;
531
# else
Jim Blandy's avatar
Jim Blandy committed
532
		return -1;
533
# endif /* IRIS */
Jim Blandy's avatar
Jim Blandy committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
	      }
#endif /* not UNIPLUS */
	    setup_pty (fd);
	    return fd;
	  }
      }
  return -1;
}
#endif /* HAVE_PTYS */

Lisp_Object
make_process (name)
     Lisp_Object name;
{
  register Lisp_Object val, tem, name1;
  register struct Lisp_Process *p;
  char suffix[10];
  register int i;

553
  p = allocate_process ();
554

555 556
  XSETINT (p->infd, -1);
  XSETINT (p->outfd, -1);
557 558 559
  XSETFASTINT (p->pid, 0);
  XSETFASTINT (p->tick, 0);
  XSETFASTINT (p->update_tick, 0);
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
  p->raw_status_low = Qnil;
  p->raw_status_high = Qnil;
  p->status = Qrun;
  p->mark = Fmake_marker ();

  /* 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;
577
  XSETPROCESS (val, p);
Jim Blandy's avatar
Jim Blandy committed
578 579 580 581
  Vprocess_alist = Fcons (Fcons (name, val), Vprocess_alist);
  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
582
void
Jim Blandy's avatar
Jim Blandy committed
583 584 585 586 587 588 589 590 591 592
remove_process (proc)
     register Lisp_Object proc;
{
  register Lisp_Object pair;

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

  deactivate_process (proc);
}
593 594 595 596 597 598 599 600 601 602

/* Setup coding systems of PROCESS.  */

void
setup_process_coding_systems (process)
     Lisp_Object process;
{
  struct Lisp_Process *p = XPROCESS (process);
  int inch = XINT (p->infd);
  int outch = XINT (p->outfd);
Kenichi Handa's avatar
Kenichi Handa committed
603
  Lisp_Object coding_system;
604

605 606 607
  if (inch < 0 || outch < 0)
    return;

608 609 610
  if (!proc_decode_coding_system[inch])
    proc_decode_coding_system[inch]
      = (struct coding_system *) xmalloc (sizeof (struct coding_system));
Kenichi Handa's avatar
Kenichi Handa committed
611
  coding_system = p->decode_coding_system;
612 613 614
  if (! NILP (p->filter))
    {
      if (NILP (p->filter_multibyte))
Kenichi Handa's avatar
Kenichi Handa committed
615
	coding_system = raw_text_coding_system (coding_system);
616 617 618 619
    }
  else if (BUFFERP (p->buffer))
    {
      if (NILP (XBUFFER (p->buffer)->enable_multibyte_characters))
Kenichi Handa's avatar
Kenichi Handa committed
620
	coding_system = raw_text_coding_system (coding_system);
621
    }
Kenichi Handa's avatar
Kenichi Handa committed
622
  setup_coding_system (coding_system, proc_decode_coding_system[inch]);
623 624 625 626 627 628 629

  if (!proc_encode_coding_system[outch])
    proc_encode_coding_system[outch]
      = (struct coding_system *) xmalloc (sizeof (struct coding_system));
  setup_coding_system (p->encode_coding_system,
		       proc_encode_coding_system[outch]);
}
Jim Blandy's avatar
Jim Blandy committed
630 631

DEFUN ("processp", Fprocessp, Sprocessp, 1, 1, 0,
632 633
       doc: /* Return t if OBJECT is a process.  */)
     (object)
634
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
635
{
636
  return PROCESSP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
637 638 639
}

DEFUN ("get-process", Fget_process, Sget_process, 1, 1, 0,
640 641
       doc: /* Return the process named NAME, or nil if there is none.  */)
     (name)
Jim Blandy's avatar
Jim Blandy committed
642 643
     register Lisp_Object name;
{
644
  if (PROCESSP (name))
Jim Blandy's avatar
Jim Blandy committed
645
    return name;
646
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
647 648 649 650
  return Fcdr (Fassoc (name, Vprocess_alist));
}

DEFUN ("get-buffer-process", Fget_buffer_process, Sget_buffer_process, 1, 1, 0,
651 652 653
       doc: /* Return the (or a) process associated with BUFFER.
BUFFER may be a buffer or the name of one.  */)
     (buffer)
654
     register Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
655 656 657
{
  register Lisp_Object buf, tail, proc;

658 659
  if (NILP (buffer)) return Qnil;
  buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
660 661 662 663 664
  if (NILP (buf)) return Qnil;

  for (tail = Vprocess_alist; !NILP (tail); tail = Fcdr (tail))
    {
      proc = Fcdr (Fcar (tail));
665
      if (PROCESSP (proc) && EQ (XPROCESS (proc)->buffer, buf))
Jim Blandy's avatar
Jim Blandy committed
666 667 668 669 670
	return proc;
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
671 672 673 674
/* 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
675

676
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
677 678 679
get_process (name)
     register Lisp_Object name;
{
680 681 682 683 684 685 686
  register Lisp_Object proc, obj;
  if (STRINGP (name))
    {
      obj = Fget_process (name);
      if (NILP (obj))
	obj = Fget_buffer (name);
      if (NILP (obj))
687
	error ("Process %s does not exist", SDATA (name));
688 689 690
    }
  else if (NILP (name))
    obj = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
691
  else
692 693 694 695 696
    obj = name;

  /* Now obj should be either a buffer object or a process object.
   */
  if (BUFFERP (obj))
Jim Blandy's avatar
Jim Blandy committed
697
    {
698
      proc = Fget_buffer_process (obj);
Jim Blandy's avatar
Jim Blandy committed
699
      if (NILP (proc))
700
	error ("Buffer %s has no process", SDATA (XBUFFER (obj)->name));
Jim Blandy's avatar
Jim Blandy committed
701 702
    }
  else
703
    {
704
      CHECK_PROCESS (obj);
705 706 707
      proc = obj;
    }
  return proc;
Jim Blandy's avatar
Jim Blandy committed
708 709 710
}

DEFUN ("delete-process", Fdelete_process, Sdelete_process, 1, 1, 0,
711 712 713 714
       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.  */)
     (process)
715
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
716
{
717 718 719 720
  process = get_process (process);
  XPROCESS (process)->raw_status_low = Qnil;
  XPROCESS (process)->raw_status_high = Qnil;
  if (NETCONN_P (process))
Jim Blandy's avatar
Jim Blandy committed
721
    {
722 723
      XPROCESS (process)->status = Fcons (Qexit, Fcons (make_number (0), Qnil));
      XSETINT (XPROCESS (process)->tick, ++process_tick);
Jim Blandy's avatar
Jim Blandy committed
724
    }
725
  else if (XINT (XPROCESS (process)->infd) >= 0)
Jim Blandy's avatar
Jim Blandy committed
726
    {
727
      Fkill_process (process, Qnil);
Jim Blandy's avatar
Jim Blandy committed
728
      /* Do this now, since remove_process will make sigchld_handler do nothing.  */
729
      XPROCESS (process)->status
Jim Blandy's avatar
Jim Blandy committed
730
	= Fcons (Qsignal, Fcons (make_number (SIGKILL), Qnil));
731
      XSETINT (XPROCESS (process)->tick, ++process_tick);
Jim Blandy's avatar
Jim Blandy committed
732 733
      status_notify ();
    }
734
  remove_process (process);
Jim Blandy's avatar
Jim Blandy committed
735 736 737 738
  return Qnil;
}

DEFUN ("process-status", Fprocess_status, Sprocess_status, 1, 1, 0,
739 740 741 742 743 744 745
       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.
746
listen -- for a network stream server that is listening.
747
closed -- for a network stream connection that is closed.
748 749
connect -- when waiting for a non-blocking connection to complete.
failed -- when a non-blocking connection has failed.
750 751 752 753
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.  */)
     (process)
754
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
755 756 757
{
  register struct Lisp_Process *p;
  register Lisp_Object status;
758

759 760
  if (STRINGP (process))
    process = Fget_process (process);
761
  else
762
    process = get_process (process);
763

764 765
  if (NILP (process))
    return process;
766

767
  p = XPROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
768 769 770
  if (!NILP (p->raw_status_low))
    update_status (p);
  status = p->status;
771
  if (CONSP (status))
772
    status = XCAR (status);
773
  if (NETCONN1_P (p))
Jim Blandy's avatar
Jim Blandy committed
774
    {
775
      if (EQ (status, Qexit))
Jim Blandy's avatar
Jim Blandy committed
776
	status = Qclosed;
777 778 779 780
      else if (EQ (p->command, Qt))
	status = Qstop;
      else if (EQ (status, Qrun))
	status = Qopen;
Jim Blandy's avatar
Jim Blandy committed
781 782 783 784 785 786
    }
  return status;
}

DEFUN ("process-exit-status", Fprocess_exit_status, Sprocess_exit_status,
       1, 1, 0,
787 788 789
       doc: /* Return the exit status of PROCESS or the signal number that killed it.
If PROCESS has not yet exited or died, return 0.  */)
     (process)
790
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
791
{
792
  CHECK_PROCESS (process);
793 794 795
  if (!NILP (XPROCESS (process)->raw_status_low))
    update_status (XPROCESS (process));
  if (CONSP (XPROCESS (process)->status))
796
    return XCAR (XCDR (XPROCESS (process)->status));
Jim Blandy's avatar
Jim Blandy committed
797 798 799 800
  return make_number (0);
}

DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
801 802 803 804
       doc: /* Return the process id of PROCESS.
This is the pid of the Unix process which PROCESS uses or talks to.
For a network connection, this value is nil.  */)
     (process)
805
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
806
{
807
  CHECK_PROCESS (process);
808
  return XPROCESS (process)->pid;
Jim Blandy's avatar
Jim Blandy committed
809 810 811
}

DEFUN ("process-name", Fprocess_name, Sprocess_name, 1, 1, 0,
812 813 814 815
       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.  */)
     (process)
816
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
817
{
818
  CHECK_PROCESS (process);
819
  return XPROCESS (process)->name;
Jim Blandy's avatar
Jim Blandy committed
820 821 822
}

DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
823 824 825 826 827
       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.
For a non-child channel, this is nil.  */)
     (process)
828
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
829
{
830
  CHECK_PROCESS (process);
831
  return XPROCESS (process)->command;
Jim Blandy's avatar
Jim Blandy committed
832 833
}

834
DEFUN ("process-tty-name", Fprocess_tty_name, Sprocess_tty_name, 1, 1, 0,
835 836 837 838
       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.  */)
     (process)
839
     register Lisp_Object process;
840
{
841
  CHECK_PROCESS (process);
842
  return XPROCESS (process)->tty_name;
843 844
}

Jim Blandy's avatar
Jim Blandy committed
845
DEFUN ("set-process-buffer", Fset_process_buffer, Sset_process_buffer,
846 847 848
       2, 2, 0,
       doc: /* Set buffer associated with PROCESS to BUFFER (a buffer, or nil).  */)
     (process, buffer)
849
     register Lisp_Object process, buffer;
Jim Blandy's avatar
Jim Blandy committed
850
{
851 852
  struct Lisp_Process *p;

853
  CHECK_PROCESS (process);
Jim Blandy's avatar
Jim Blandy committed
854
  if (!NILP (buffer))
855
    CHECK_BUFFER (buffer);
856 857 858 859
  p = XPROCESS (process);
  p->buffer = buffer;
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCbuffer, buffer);
860
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
861 862 863 864
  return buffer;
}

DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer,
865 866 867 868
       1, 1, 0,
       doc: /* Return the buffer PROCESS is associated with.
Output from PROCESS is inserted in this buffer unless PROCESS has a filter.  */)
     (process)
869
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
870
{
871
  CHECK_PROCESS (process);
872
  return XPROCESS (process)->buffer;
Jim Blandy's avatar
Jim Blandy committed
873 874 875
}

DEFUN ("process-mark", Fprocess_mark, Sprocess_mark,
876 877 878
       1, 1, 0,
       doc: /* Return the marker for the end of the last output from PROCESS.  */)
     (process)
879
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
880
{
881
  CHECK_PROCESS (process);
882
  return XPROCESS (process)->mark;
Jim Blandy's avatar
Jim Blandy committed
883 884 885
}

DEFUN ("set-process-filter", Fset_process_filter, Sset_process_filter,
886 887 888
       2, 2, 0,
       doc: /* Give PROCESS the filter function FILTER; nil means no filter.
t means stop accepting output from the process.
889 890 891

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
892
passed to the filter.
893

894
The filter gets two arguments: the process and the string of output.
895 896 897 898 899 900
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').  */)
901
     (process, filter)
902
     register Lisp_Object process, filter;
Jim Blandy's avatar
Jim Blandy committed
903
{
904
  struct Lisp_Process *p;
905

906
  CHECK_PROCESS (process);
907 908 909 910 911 912 913 914 915
  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 ...)  */
916

917
  if (XINT (p->infd) >= 0)
918
    {
919
      if (EQ (filter, Qt) && !EQ (p->status, Qlisten))
920 921 922 923
	{
	  FD_CLR (XINT (p->infd), &input_wait_mask);
	  FD_CLR (XINT (p->infd), &non_keyboard_wait_mask);
	}
924 925
      else if (EQ (p->filter, Qt)
	       && !EQ (p->command, Qt)) /* Network process not stopped. */
926 927 928 929
	{
	  FD_SET (XINT (p->infd), &input_wait_mask);
	  FD_SET (XINT (p->infd), &non_keyboard_wait_mask);
	}
930
    }
931

932
  p->filter = filter;
933 934
  if (NETCONN1_P (p))
    p->childp = Fplist_put (p->childp, QCfilter, filter);
935
  setup_process_coding_systems (process);
Jim Blandy's avatar
Jim Blandy committed
936 937 938 939
  return filter;
}

DEFUN ("process-filter", Fprocess_filter, Sprocess_filter,
940 941 942 943
       1, 1, 0,
       doc: /* Returns the filter function of PROCESS; nil if none.
See `set-process-filter' for more info on filter functions.  */)
     (process)
944
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
945
{
946
  CHECK_PROCESS (process);
947
  return XPROCESS (process)->filter;
Jim Blandy's avatar
Jim Blandy committed
948 949 950
}

DEFUN ("set-process-sentinel", Fset_process_sentinel, Sset_process_sentinel,
951 952 953 954 955
       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.  */)
     (process, sentinel)
956
     register Lisp_Object process, sentinel;
Jim Blandy's avatar
Jim Blandy committed
957
{
958
  CHECK_PROCESS (process);
959
  XPROCESS (process)->sentinel = sentinel;
Jim Blandy's avatar
Jim Blandy committed
960 961 962 963
  return sentinel;
}

DEFUN ("process-sentinel", Fprocess_sentinel, Sprocess_sentinel,
964 965 966 967
       1, 1, 0,
       doc: /* Return the sentinel of PROCESS; nil if none.
See `set-process-sentinel' for more info on sentinels.  */)
     (process)
968
     register Lisp_Object process;
Jim Blandy's avatar
Jim Blandy committed
969
{
970
  CHECK_PROCESS (process);
971
  return XPROCESS (process)->sentinel;
Jim Blandy's avatar
Jim Blandy committed
972 973
}

974
DEFUN ("set-process-window-size", Fset_process_window_size,
975 976 977
       Sset_process_window_size, 3, 3, 0,
       doc: /* Tell PROCESS that it has logical window size HEIGHT and WIDTH.  */)
     (process, height, width)
978
     register Lisp_Object process, height, width;
979
{
980 981 982
  CHECK_PROCESS (process);
  CHECK_NATNUM (height);
  CHECK_NATNUM (width);
983

984
  if (XINT (XPROCESS (process)->infd) < 0
985 986
      || set_window_size (XINT (XPROCESS (process)->infd),
			  XINT (height), XINT (width)) <= 0)
987 988 989 990 991
    return Qnil;
  else
    return Qt;
}

992
DEFUN ("set-process-inherit-coding-system-flag",
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
       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.  */)
     (process, flag)
1010 1011
     register Lisp_Object process, flag;
{
1012
  CHECK_PROCESS (process);
1013
  XPROCESS (process)->inherit_coding_system_flag = flag;
1014 1015 1016 1017
  return flag;
}

DEFUN ("process-inherit-coding-system-flag",
1018 1019 1020 1021 1022 1023 1024
       Fprocess_inherit_coding_system_flag, Sprocess_inherit_coding_system_flag,
       1, 1, 0,
       doc: /* Return the value of inherit-coding-system flag for PROCESS.
If this flag is t, `buffer-file-coding-system' of the buffer
associated with PROCESS will inherit the coding system used to decode
the process output.  */)
     (process)
1025 1026
     register Lisp_Object process;
{
1027
  CHECK_PROCESS (process);
1028
  return XPROCESS (process)->inherit_coding_system_flag;
1029 1030
}

1031 1032 1033 1034 1035 1036 1037 1038
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.
If the second argument FLAG is non-nil, emacs will query the user before
exiting if PROCESS is running.  */)
     (process, flag)
     register Lisp_Object process, flag;
Jim Blandy's avatar
Jim Blandy committed
1039
{
1040
  CHECK_PROCESS (process);
1041 1042
  XPROCESS (process)->kill_without_query = Fnull (flag);
  return flag;
Jim Blandy's avatar
Jim Blandy committed
1043
}
1044

1045 1046
DEFUN ("process-query-on-exit-flag",
       Fprocess_query_on_exit_flag, Sprocess_query_on_exit_flag,
1047
       1, 1, 0,
1048
       doc: /* Return the current value of query on exit flag for PROCESS.  */)
1049