process.h 8.19 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Definitions for asynchronous process control in GNU Emacs.
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 1985, 1994, 2001-2015 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5

This file is part of GNU Emacs.

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

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

Stefan Monnier's avatar
Stefan Monnier committed
19 20 21
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
Paul Eggert's avatar
Paul Eggert committed
22

Stefan Monnier's avatar
Stefan Monnier committed
23
#include <unistd.h>
Jim Blandy's avatar
Jim Blandy committed
24

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

Paul Eggert's avatar
Paul Eggert committed
29
INLINE_HEADER_BEGIN
30

31 32 33 34 35
/* Bound on number of file descriptors opened on behalf of a process,
   that need to be closed.  */

enum { PROCESS_OPEN_FDS = 6 };

36 37
/* This structure records information about a subprocess
   or network connection.  */
Jim Blandy's avatar
Jim Blandy committed
38 39 40

struct Lisp_Process
  {
41
    struct vectorlike_header header;
42

43
    /* Name of subprocess terminal.  */
44
    Lisp_Object tty_name;
45

Jim Blandy's avatar
Jim Blandy committed
46
    /* Name of this process */
47
    Lisp_Object name;
48

49 50
    /* List of command arguments that this process was run with.
       Is set to t for a stopped network process; nil otherwise. */
51
    Lisp_Object command;
52

Jim Blandy's avatar
Jim Blandy committed
53 54
    /* (funcall FILTER PROC STRING)  (if FILTER is non-nil)
       to dispose of a bunch of chars from the process all at once */
55
    Lisp_Object filter;
56

Jim Blandy's avatar
Jim Blandy committed
57
    /* (funcall SENTINEL PROCESS) when process state changes */
58
    Lisp_Object sentinel;
59

60 61
    /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
       accepts a connection from a client.  */
62
    Lisp_Object log;
63

Jim Blandy's avatar
Jim Blandy committed
64
    /* Buffer that output is going to */
65
    Lisp_Object buffer;
66

67 68 69
    /* 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.  */
70

71
    Lisp_Object childp;
72

73
    /* Plist for programs to keep per-process state information, parameters, etc.  */
74
    Lisp_Object plist;
75

76
    /* Symbol indicating the type of process: real, network, serial  */
77
    Lisp_Object type;
78

Jim Blandy's avatar
Jim Blandy committed
79
    /* Marker set to end of last buffer-inserted output from this process */
80
    Lisp_Object mark;
81

Jim Blandy's avatar
Jim Blandy committed
82 83 84 85 86
    /* 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).  */
87
    Lisp_Object status;
88

89
    /* Coding-system for decoding the input from this process.  */
90
    Lisp_Object decode_coding_system;
91

92
    /* Working buffer for decoding.  */
93
    Lisp_Object decoding_buf;
94

95
    /* Coding-system for encoding the output to this process.  */
96
    Lisp_Object encode_coding_system;
97

98
    /* Working buffer for encoding.  */
99
    Lisp_Object encoding_buf;
100

101
    /* Queue for storing waiting writes */
102
    Lisp_Object write_queue;
103

Ted Zlatanov's avatar
Ted Zlatanov committed
104
#ifdef HAVE_GNUTLS
105
    Lisp_Object gnutls_cred_type;
Ted Zlatanov's avatar
Ted Zlatanov committed
106 107
#endif

108
    /* After this point, there are no Lisp_Objects any more.  */
109
    /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
110 111 112

    /* Number of this process.
       allocate_process assumes this is the first non-Lisp_Object field.
113 114
       A value 0 is used for pseudo-processes such as network or serial
       connections.  */
115
    pid_t pid;
116 117 118 119
    /* Descriptor by which we read from this process */
    int infd;
    /* Descriptor by which we write to this process */
    int outfd;
120 121 122
    /* Descriptors that were created for this process and that need
       closing.  Unused entries are negative.  */
    int open_fd[PROCESS_OPEN_FDS];
123
    /* Event-count of last event in which this process changed status.  */
124
    EMACS_INT tick;
125
    /* Event-count of last such event reported.  */
126
    EMACS_INT update_tick;
127 128 129 130 131 132
    /* 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
133 134
       time.  Value is nanoseconds to delay reading output from
       this process.  Range is 0 .. 50 * 1000 * 1000.  */
135 136 137 138
    int read_output_delay;
    /* Should we delay reading output from this process.
       Initialized from `Vprocess_adaptive_read_buffering'.
       0 = nil, 1 = t, 2 = other.  */
139
    unsigned int adaptive_read_buffering : 2;
140
    /* Skip reading this process on next read.  */
141 142
    bool_bf read_output_skip : 1;
    /* True means kill silently if Emacs is exited.
143
       This is the inverse of the `query-on-exit' flag.  */
144 145 146
    bool_bf kill_without_query : 1;
    /* True if communicating through a pty.  */
    bool_bf pty_flag : 1;
147 148
    /* Flag to set coding-system of the process buffer from the
       coding_system used to decode process output.  */
149
    bool_bf inherit_coding_system_flag : 1;
150 151
    /* Whether the process is alive, i.e., can be waited for.  Running
       processes can be waited for, but exited and fake processes cannot.  */
152
    bool_bf alive : 1;
153 154 155 156
    /* 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'.  */
157
    bool_bf raw_status_new : 1;
158
    int raw_status;
Ted Zlatanov's avatar
Ted Zlatanov committed
159 160 161 162

#ifdef HAVE_GNUTLS
    gnutls_initstage_t gnutls_initstage;
    gnutls_session_t gnutls_state;
163 164
    gnutls_certificate_client_credentials gnutls_x509_cred;
    gnutls_anon_client_credentials_t gnutls_anon_cred;
165 166 167
    gnutls_x509_crt_t gnutls_certificate;
    unsigned int gnutls_peer_verification;
    unsigned int gnutls_extra_peer_verification;
168
    int gnutls_log_level;
169
    int gnutls_handshakes_tried;
170
    bool_bf gnutls_p : 1;
Ted Zlatanov's avatar
Ted Zlatanov committed
171
#endif
Jim Blandy's avatar
Jim Blandy committed
172 173
};

174 175 176
/* Every field in the preceding structure except for the first two
   must be a Lisp_Object, for GC's sake.  */

177
#define ChannelMask(n) (1 << (n))
Jim Blandy's avatar
Jim Blandy committed
178

Paul Eggert's avatar
Paul Eggert committed
179 180 181
/* Most code should use these functions to set Lisp fields in struct
   process.  */

Paul Eggert's avatar
Paul Eggert committed
182
INLINE void
Paul Eggert's avatar
Paul Eggert committed
183 184 185 186 187 188
pset_childp (struct Lisp_Process *p, Lisp_Object val)
{
  p->childp = val;
}

#ifdef HAVE_GNUTLS
Paul Eggert's avatar
Paul Eggert committed
189
INLINE void
Paul Eggert's avatar
Paul Eggert committed
190 191 192 193 194 195
pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->gnutls_cred_type = val;
}
#endif

196
/* True means don't run process sentinels.  This is used
197
   when exiting.  */
198
extern bool inhibit_sentinels;
199

200 201 202 203 204 205 206 207
/* Exit statuses for GNU programs that exec other programs.  */
enum
{
  EXIT_CANCELED = 125, /* Internal error prior to exec attempt.  */
  EXIT_CANNOT_INVOKE = 126, /* Program located, but not usable.  */
  EXIT_ENOENT = 127 /* Could not find program to exec.  */
};

208 209
/* Defined in callproc.c.  */

210
extern Lisp_Object encode_current_directory (void);
211
extern void record_kill_process (struct Lisp_Process *, Lisp_Object);
212

213
/* Defined in sysdep.c.  */
214

215 216 217
extern Lisp_Object list_system_processes (void);
extern Lisp_Object system_process_attributes (Lisp_Object);

218 219 220
/* Defined in process.c.  */

extern void record_deleted_pid (pid_t, Lisp_Object);
221 222
struct sockaddr;
extern Lisp_Object conv_sockaddr_to_lisp (struct sockaddr *, int);
223 224
extern void hold_keyboard_input (void);
extern void unhold_keyboard_input (void);
225
extern bool kbd_on_hold_p (void);
226

227
typedef void (*fd_callback) (int fd, void *data);
228 229 230 231 232

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);
233
extern void catch_child_signal (void);
Paul Eggert's avatar
Paul Eggert committed
234

235
#ifdef WINDOWSNT
236 237
extern Lisp_Object network_interface_list (void);
extern Lisp_Object network_interface_info (Lisp_Object);
238
#endif
239

240 241 242 243 244 245 246 247 248 249 250 251 252
/* If program file NAME starts with /: for quoting a magic
   name, remove that, preserving the multibyteness of NAME.  */

INLINE Lisp_Object
remove_slash_colon (Lisp_Object name)
{
  return
    ((SBYTES (name) > 2 && SREF (name, 0) == '/' && SREF (name, 1) == ':')
     ? make_specified_string (SSDATA (name) + 2, SCHARS (name) - 2,
			      SBYTES (name) - 2, STRING_MULTIBYTE (name))
     : name);
}

Paul Eggert's avatar
Paul Eggert committed
253
INLINE_HEADER_END