process.h 7.69 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Definitions for asynchronous process control in GNU Emacs.
2
   Copyright (C) 1985, 1994, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
3
                 2005, 2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

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

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

Stefan Monnier's avatar
Stefan Monnier committed
20 21 22 23 24 25
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
26

Ted Zlatanov's avatar
Ted Zlatanov committed
27 28 29 30
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif

31 32 33 34 35
/* This structure records information about a subprocess
   or network connection.

   Every field in this structure except for the first two
   must be a Lisp_Object, for GC's sake.  */
Jim Blandy's avatar
Jim Blandy committed
36 37 38

struct Lisp_Process
  {
Stefan Monnier's avatar
Stefan Monnier committed
39
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
40
    struct Lisp_Vector *v_next;
41 42
    /* Name of subprocess terminal.  */
    Lisp_Object tty_name;
Jim Blandy's avatar
Jim Blandy committed
43 44
    /* Name of this process */
    Lisp_Object name;
45 46
    /* List of command arguments that this process was run with.
       Is set to t for a stopped network process; nil otherwise. */
Jim Blandy's avatar
Jim Blandy committed
47 48 49 50 51 52
    Lisp_Object command;
    /* (funcall FILTER PROC STRING)  (if FILTER is non-nil)
       to dispose of a bunch of chars from the process all at once */
    Lisp_Object filter;
    /* (funcall SENTINEL PROCESS) when process state changes */
    Lisp_Object sentinel;
53 54 55
    /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
       accepts a connection from a client.  */
    Lisp_Object log;
Jim Blandy's avatar
Jim Blandy committed
56 57
    /* Buffer that output is going to */
    Lisp_Object buffer;
58 59 60
    /* t if this is a real child process.  For a network or serial
       connection, it is a plist based on the arguments to
       make-network-process or make-serial-process.  */
Jim Blandy's avatar
Jim Blandy committed
61
    Lisp_Object childp;
62 63
    /* Plist for programs to keep per-process state information, parameters, etc.  */
    Lisp_Object plist;
64 65
    /* Symbol indicating the type of process: real, network, serial  */
    Lisp_Object type;
Jim Blandy's avatar
Jim Blandy committed
66 67 68 69 70 71 72 73
    /* Marker set to end of last buffer-inserted output from this process */
    Lisp_Object mark;
    /* Symbol indicating status of process.
       This may be a symbol: run, open, or closed.
       Or it may be a list, whose car is stop, exit or signal
       and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
       or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
    Lisp_Object status;
74 75 76 77 78 79 80 81
    /* Coding-system for decoding the input from this process.  */
    Lisp_Object decode_coding_system;
    /* Working buffer for decoding.  */
    Lisp_Object decoding_buf;
    /* Coding-system for encoding the output to this process.  */
    Lisp_Object encode_coding_system;
    /* Working buffer for encoding.  */
    Lisp_Object encoding_buf;
82

Ted Zlatanov's avatar
Ted Zlatanov committed
83 84 85 86
#ifdef HAVE_GNUTLS
    Lisp_Object gnutls_cred_type;
#endif

87
    /* After this point, there are no Lisp_Objects any more.  */
88
    /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
89 90 91

    /* Number of this process.
       allocate_process assumes this is the first non-Lisp_Object field.
92 93
       A value 0 is used for pseudo-processes such as network or serial
       connections.  */
94
    pid_t pid;
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
    /* Descriptor by which we read from this process */
    int infd;
    /* Descriptor by which we write to this process */
    int outfd;
    /* Event-count of last event in which this process changed status.  */
    int tick;
    /* Event-count of last such event reported.  */
    int update_tick;
    /* Size of carryover in decoding.  */
    int decoding_carryover;
    /* Hysteresis to try to read process output in larger blocks.
       On some systems, e.g. GNU/Linux, Emacs is seen as
       an interactive app also when reading process output, meaning
       that process output can be read in as little as 1 byte at a
       time.  Value is micro-seconds to delay reading output from
       this process.  Range is 0 .. 50000.  */
    int read_output_delay;
    /* Should we delay reading output from this process.
       Initialized from `Vprocess_adaptive_read_buffering'.
       0 = nil, 1 = t, 2 = other.  */
115
    unsigned int adaptive_read_buffering : 2;
116
    /* Skip reading this process on next read.  */
117
    unsigned int read_output_skip : 1;
118 119
    /* Non-nil means kill silently if Emacs is exited.
       This is the inverse of the `query-on-exit' flag.  */
120
    unsigned int kill_without_query : 1;
121
    /* Non-nil if communicating through a pty.  */
122
    unsigned int pty_flag : 1;
123 124
    /* Flag to set coding-system of the process buffer from the
       coding_system used to decode process output.  */
125
    unsigned int inherit_coding_system_flag : 1;
126 127 128 129
    /* Record the process status in the raw form in which it comes from `wait'.
       This is to avoid consing in a signal handler.  The `raw_status_new'
       flag indicates that `raw_status' contains a new status that still
       needs to be synced to `status'.  */
130
    unsigned int raw_status_new : 1;
131
    int raw_status;
Ted Zlatanov's avatar
Ted Zlatanov committed
132 133 134 135

#ifdef HAVE_GNUTLS
    gnutls_initstage_t gnutls_initstage;
    gnutls_session_t gnutls_state;
136 137 138
    gnutls_certificate_client_credentials gnutls_x509_cred;
    gnutls_anon_client_credentials_t gnutls_anon_cred;
    int gnutls_log_level;
139
    int gnutls_p;
Ted Zlatanov's avatar
Ted Zlatanov committed
140
#endif
Jim Blandy's avatar
Jim Blandy committed
141 142
};

143 144 145
/* Every field in the preceding structure except for the first two
   must be a Lisp_Object, for GC's sake.  */

Jim Blandy's avatar
Jim Blandy committed
146 147
#define ChannelMask(n) (1<<(n))

148
/* Indexed by descriptor, gives the process (if any) for that descriptor.  */
149
extern Lisp_Object chan_process[];
150 151 152 153

/* Alist of elements (NAME . PROCESS).  */
extern Lisp_Object Vprocess_alist;

Glenn Morris's avatar
Glenn Morris committed
154
/* True if we are about to fork off a synchronous process or if we
Jim Blandy's avatar
Jim Blandy committed
155 156 157
   are waiting for it.  */
extern int synch_process_alive;

Karl Heuer's avatar
Karl Heuer committed
158
/* Communicate exit status of sync process to from sigchld_handler
Jim Blandy's avatar
Jim Blandy committed
159 160
   to Fcall_process.  */

Jim Blandy's avatar
Jim Blandy committed
161
/* Nonzero => this is a string explaining death of synchronous subprocess.  */
162
extern const char *synch_process_death;
Jim Blandy's avatar
Jim Blandy committed
163

164
/* Nonzero => this is the signal number that terminated the subprocess.  */
165
extern int synch_process_termsig;
166

Jim Blandy's avatar
Jim Blandy committed
167 168 169 170
/* If synch_process_death is zero,
   this is exit code of synchronous subprocess.  */
extern int synch_process_retcode;

171
/* The name of the file open to get a null file, or a data sink.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
172
   MS-DOS, and OS/2 redefine this.  */
173 174 175
#ifndef NULL_DEVICE
#define NULL_DEVICE "/dev/null"
#endif
Miles Bader's avatar
Miles Bader committed
176

177 178 179 180
/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
extern int inhibit_sentinels;

181 182 183 184
extern Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname;
extern Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime;
extern Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
extern Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtpgid, Qcstime;
Eli Zaretskii's avatar
Eli Zaretskii committed
185
extern Lisp_Object Qtime, Qctime;
186 187 188
extern Lisp_Object QCport, QCspeed, QCprocess;
extern Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
extern Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
189

190 191 192
extern Lisp_Object list_system_processes (void);
extern Lisp_Object system_process_attributes (Lisp_Object);

193 194 195 196
extern void hold_keyboard_input (void);
extern void unhold_keyboard_input (void);
extern int kbd_on_hold_p (void);

197 198 199 200 201 202 203
typedef void (*fd_callback)(int fd, void *data, int for_read);

extern void add_read_fd (int fd, fd_callback func, void *data);
extern void delete_read_fd (int fd);
extern void add_write_fd (int fd, fd_callback func, void *data);
extern void delete_write_fd (int fd);

Miles Bader's avatar
Miles Bader committed
204 205
/* arch-tag: dffedfc4-d7bc-4b58-a26f-c16155449c72
   (do not change this comment) */