process.h 9.63 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-2018 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 <https://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
18

19 20 21
#ifndef EMACS_PROCESS_H
#define EMACS_PROCESS_H

Stefan Monnier's avatar
Stefan Monnier committed
22 23 24
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
Paul Eggert's avatar
Paul Eggert committed
25

Stefan Monnier's avatar
Stefan Monnier committed
26
#include <unistd.h>
Jim Blandy's avatar
Jim Blandy committed
27

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

Paul Eggert's avatar
Paul Eggert committed
32
INLINE_HEADER_BEGIN
33

34 35 36 37 38
/* Bound on number of file descriptors opened on behalf of a process,
   that need to be closed.  */

enum { PROCESS_OPEN_FDS = 6 };

39 40
/* This structure records information about a subprocess
   or network connection.  */
Jim Blandy's avatar
Jim Blandy committed
41 42 43

struct Lisp_Process
  {
44
    union vectorlike_header header;
45

46
    /* Name of subprocess terminal.  */
47
    Lisp_Object tty_name;
48

49
    /* Name of this process.  */
50
    Lisp_Object name;
51

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

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

60
    /* (funcall SENTINEL PROCESS) when process state changes.  */
61
    Lisp_Object sentinel;
62

63 64
    /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
       accepts a connection from a client.  */
65
    Lisp_Object log;
66

67
    /* Buffer that output is going to.  */
68
    Lisp_Object buffer;
69

70 71 72
    /* 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.  */
73

74
    Lisp_Object childp;
75

76
    /* Plist for programs to keep per-process state information, parameters, etc.  */
77
    Lisp_Object plist;
78

79
    /* Symbol indicating the type of process: real, network, serial.  */
80
    Lisp_Object type;
81

82
    /* Marker set to end of last buffer-inserted output from this process.  */
83
    Lisp_Object mark;
84

Jim Blandy's avatar
Jim Blandy committed
85
    /* Symbol indicating status of process.
86 87 88
       This may be a symbol: run, open, closed, listen, or failed.
       Or it may be a pair (connect . ADDRINFOS) where ADDRINFOS is
       a list of remaining (PROTOCOL . ADDRINFO) pairs to try.
89
       Or it may be (failed ERR) where ERR is an integer, string or symbol.
Jim Blandy's avatar
Jim Blandy committed
90 91 92
       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).  */
93
    Lisp_Object status;
94

95
    /* Coding-system for decoding the input from this process.  */
96
    Lisp_Object decode_coding_system;
97

98
    /* Working buffer for decoding.  */
99
    Lisp_Object decoding_buf;
100

101
    /* Coding-system for encoding the output to this process.  */
102
    Lisp_Object encode_coding_system;
103

104
    /* Working buffer for encoding.  */
105
    Lisp_Object encoding_buf;
106

107
    /* Queue for storing waiting writes.  */
108
    Lisp_Object write_queue;
109

Ted Zlatanov's avatar
Ted Zlatanov committed
110
#ifdef HAVE_GNUTLS
111
    Lisp_Object gnutls_cred_type;
112
    Lisp_Object gnutls_boot_parameters;
Ted Zlatanov's avatar
Ted Zlatanov committed
113 114
#endif

115 116 117
    /* Pipe process attached to the standard error of this process.  */
    Lisp_Object stderrproc;

Tom Tromey's avatar
Tom Tromey committed
118 119 120
    /* The thread a process is linked to, or nil for any thread.  */
    Lisp_Object thread;

121
    /* After this point, there are no Lisp_Objects any more.  */
122
    /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
123

124 125 126 127 128
    /* Process ID.  A positive value is a child process ID.
       Zero is for pseudo-processes such as network or serial connections,
       or for processes that have not been fully created yet.
       -1 is for a process that was not created successfully.
       -2 is for a pty with no process, e.g., for GDB.  */
129
    pid_t pid;
130
    /* Descriptor by which we read from this process.  */
131
    int infd;
132 133
    /* Byte-count modulo (UINTMAX_MAX + 1) for process output read from `infd'.  */
    uintmax_t nbytes_read;
134
    /* Descriptor by which we write to this process.  */
135
    int outfd;
136 137 138
    /* Descriptors that were created for this process and that need
       closing.  Unused entries are negative.  */
    int open_fd[PROCESS_OPEN_FDS];
139
    /* Event-count of last event in which this process changed status.  */
140
    EMACS_INT tick;
141
    /* Event-count of last such event reported.  */
142
    EMACS_INT update_tick;
143 144 145 146 147 148
    /* 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
149 150
       time.  Value is nanoseconds to delay reading output from
       this process.  Range is 0 .. 50 * 1000 * 1000.  */
151 152 153 154
    int read_output_delay;
    /* Should we delay reading output from this process.
       Initialized from `Vprocess_adaptive_read_buffering'.
       0 = nil, 1 = t, 2 = other.  */
155
    unsigned int adaptive_read_buffering : 2;
156
    /* Skip reading this process on next read.  */
157 158
    bool_bf read_output_skip : 1;
    /* True means kill silently if Emacs is exited.
159
       This is the inverse of the `query-on-exit' flag.  */
160 161 162
    bool_bf kill_without_query : 1;
    /* True if communicating through a pty.  */
    bool_bf pty_flag : 1;
163 164
    /* Flag to set coding-system of the process buffer from the
       coding_system used to decode process output.  */
165
    bool_bf inherit_coding_system_flag : 1;
166 167
    /* Whether the process is alive, i.e., can be waited for.  Running
       processes can be waited for, but exited and fake processes cannot.  */
168
    bool_bf alive : 1;
169 170 171 172
    /* 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'.  */
173
    bool_bf raw_status_new : 1;
174
    /* Whether this is a nonblocking socket. */
175
    bool_bf is_non_blocking_client : 1;
176
    /* Whether this is a server or a client socket. */
177
    bool_bf is_server : 1;
178
    int raw_status;
179
    /* The length of the socket backlog. */
180
    int backlog;
181
    /* The port number. */
182
    int port;
183
    /* The socket type. */
184
    int socktype;
Ted Zlatanov's avatar
Ted Zlatanov committed
185

186 187 188
#ifdef HAVE_GETADDRINFO_A
    /* Whether the socket is waiting for response from an asynchronous
       DNS call. */
189
    struct gaicb *dns_request;
190 191
#endif

Ted Zlatanov's avatar
Ted Zlatanov committed
192 193 194
#ifdef HAVE_GNUTLS
    gnutls_initstage_t gnutls_initstage;
    gnutls_session_t gnutls_state;
195 196
    gnutls_certificate_client_credentials gnutls_x509_cred;
    gnutls_anon_client_credentials_t gnutls_anon_cred;
197 198 199
    gnutls_x509_crt_t gnutls_certificate;
    unsigned int gnutls_peer_verification;
    unsigned int gnutls_extra_peer_verification;
200
    int gnutls_log_level;
201
    int gnutls_handshakes_tried;
202
    bool_bf gnutls_p : 1;
203
    bool_bf gnutls_complete_negotiation_p : 1;
Ted Zlatanov's avatar
Ted Zlatanov committed
204
#endif
Jim Blandy's avatar
Jim Blandy committed
205 206
};

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
INLINE bool
PROCESSP (Lisp_Object a)
{
  return PSEUDOVECTORP (a, PVEC_PROCESS);
}

INLINE void
CHECK_PROCESS (Lisp_Object x)
{
  CHECK_TYPE (PROCESSP (x), Qprocessp, x);
}

INLINE struct Lisp_Process *
XPROCESS (Lisp_Object a)
{
  eassert (PROCESSP (a));
223
  return XUNTAG (a, Lisp_Vectorlike, struct Lisp_Process);
224 225
}

226 227 228
/* Every field in the preceding structure except for the first two
   must be a Lisp_Object, for GC's sake.  */

229
#define ChannelMask(n) (1 << (n))
Jim Blandy's avatar
Jim Blandy committed
230

Paul Eggert's avatar
Paul Eggert committed
231 232 233
/* Most code should use these functions to set Lisp fields in struct
   process.  */

Paul Eggert's avatar
Paul Eggert committed
234
INLINE void
Paul Eggert's avatar
Paul Eggert committed
235 236 237 238 239
pset_childp (struct Lisp_Process *p, Lisp_Object val)
{
  p->childp = val;
}

Lars Ingebrigtsen's avatar
Lars Ingebrigtsen committed
240 241 242 243 244 245
INLINE void
pset_status (struct Lisp_Process *p, Lisp_Object val)
{
  p->status = val;
}

Paul Eggert's avatar
Paul Eggert committed
246
#ifdef HAVE_GNUTLS
Paul Eggert's avatar
Paul Eggert committed
247
INLINE void
Paul Eggert's avatar
Paul Eggert committed
248 249 250 251 252 253
pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->gnutls_cred_type = val;
}
#endif

254
/* True means don't run process sentinels.  This is used
255
   when exiting.  */
256
extern bool inhibit_sentinels;
257

258 259 260 261 262 263 264 265
/* 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.  */
};

266 267
/* Defined in callproc.c.  */

268
extern Lisp_Object encode_current_directory (void);
269
extern void record_kill_process (struct Lisp_Process *, Lisp_Object);
270

271
/* Defined in sysdep.c.  */
272

273 274 275
extern Lisp_Object list_system_processes (void);
extern Lisp_Object system_process_attributes (Lisp_Object);

276 277 278
/* Defined in process.c.  */

extern void record_deleted_pid (pid_t, Lisp_Object);
279
struct sockaddr;
280
extern Lisp_Object conv_sockaddr_to_lisp (struct sockaddr *, ptrdiff_t);
281 282
extern void hold_keyboard_input (void);
extern void unhold_keyboard_input (void);
283
extern bool kbd_on_hold_p (void);
284

285
typedef void (*fd_callback) (int fd, void *data);
286 287 288 289 290

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);
291
extern void catch_child_signal (void);
292
extern void restore_nofile_limit (void);
Paul Eggert's avatar
Paul Eggert committed
293

294
#ifdef WINDOWSNT
295 296
extern Lisp_Object network_interface_list (void);
extern Lisp_Object network_interface_info (Lisp_Object);
297
#endif
298

299
extern Lisp_Object remove_slash_colon (Lisp_Object);
300

Tom Tromey's avatar
Tom Tromey committed
301
extern void update_processes_for_thread_death (Lisp_Object);
Tom Tromey's avatar
Tom Tromey committed
302

Paul Eggert's avatar
Paul Eggert committed
303
INLINE_HEADER_END
304 305

#endif /* EMACS_PROCESS_H */