1 /* Definitions for asynchronous process control in GNU Emacs.
2 Copyright (C) 1985, 1994, 2001-2017 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or (at
9 your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 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/>. */
19 #ifndef EMACS_PROCESS_H
20 #define EMACS_PROCESS_H
22 #ifdef HAVE_SYS_TYPES_H
23 #include <sys/types.h>
34 /* Bound on number of file descriptors opened on behalf of a process,
35 that need to be closed. */
37 enum { PROCESS_OPEN_FDS
= 6 };
39 /* This structure records information about a subprocess
40 or network connection. */
44 union vectorlike_header header
;
46 /* Name of subprocess terminal. */
49 /* Name of this process. */
52 /* List of command arguments that this process was run with.
53 Is set to t for a stopped network process; nil otherwise. */
56 /* (funcall FILTER PROC STRING) (if FILTER is non-nil)
57 to dispose of a bunch of chars from the process all at once. */
60 /* (funcall SENTINEL PROCESS) when process state changes. */
63 /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
64 accepts a connection from a client. */
67 /* Buffer that output is going to. */
70 /* t if this is a real child process. For a network or serial
71 connection, it is a plist based on the arguments to
72 make-network-process or make-serial-process. */
76 /* Plist for programs to keep per-process state information, parameters, etc. */
79 /* Symbol indicating the type of process: real, network, serial. */
82 /* Marker set to end of last buffer-inserted output from this process. */
85 /* Symbol indicating status of process.
86 This may be a symbol: run, open, closed, listen, or failed.
87 Or it may be a pair (connect . ADDRINFOS) where ADDRINFOS is
88 a list of remaining (PROTOCOL . ADDRINFO) pairs to try.
89 Or it may be (failed ERR) where ERR is an integer, string or symbol.
90 Or it may be a list, whose car is stop, exit or signal
91 and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
92 or (SIGNAL_NUMBER . COREDUMP_FLAG). */
95 /* Coding-system for decoding the input from this process. */
96 Lisp_Object decode_coding_system
;
98 /* Working buffer for decoding. */
99 Lisp_Object decoding_buf
;
101 /* Coding-system for encoding the output to this process. */
102 Lisp_Object encode_coding_system
;
104 /* Working buffer for encoding. */
105 Lisp_Object encoding_buf
;
107 /* Queue for storing waiting writes. */
108 Lisp_Object write_queue
;
111 Lisp_Object gnutls_cred_type
;
112 Lisp_Object gnutls_boot_parameters
;
115 /* Pipe process attached to the standard error of this process. */
116 Lisp_Object stderrproc
;
118 /* The thread a process is linked to, or nil for any 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. */
124 /* Process ID. A positive value is a child process ID.
125 Zero is for pseudo-processes such as network or serial connections,
126 or for processes that have not been fully created yet.
127 -1 is for a process that was not created successfully.
128 -2 is for a pty with no process, e.g., for GDB. */
130 /* Descriptor by which we read from this process. */
132 /* Descriptor by which we write to this process. */
134 /* Descriptors that were created for this process and that need
135 closing. Unused entries are negative. */
136 int open_fd
[PROCESS_OPEN_FDS
];
137 /* Event-count of last event in which this process changed status. */
139 /* Event-count of last such event reported. */
140 EMACS_INT update_tick
;
141 /* Size of carryover in decoding. */
142 int decoding_carryover
;
143 /* Hysteresis to try to read process output in larger blocks.
144 On some systems, e.g. GNU/Linux, Emacs is seen as
145 an interactive app also when reading process output, meaning
146 that process output can be read in as little as 1 byte at a
147 time. Value is nanoseconds to delay reading output from
148 this process. Range is 0 .. 50 * 1000 * 1000. */
149 int read_output_delay
;
150 /* Should we delay reading output from this process.
151 Initialized from `Vprocess_adaptive_read_buffering'.
152 0 = nil, 1 = t, 2 = other. */
153 unsigned int adaptive_read_buffering
: 2;
154 /* Skip reading this process on next read. */
155 bool_bf read_output_skip
: 1;
156 /* True means kill silently if Emacs is exited.
157 This is the inverse of the `query-on-exit' flag. */
158 bool_bf kill_without_query
: 1;
159 /* True if communicating through a pty. */
160 bool_bf pty_flag
: 1;
161 /* Flag to set coding-system of the process buffer from the
162 coding_system used to decode process output. */
163 bool_bf inherit_coding_system_flag
: 1;
164 /* Whether the process is alive, i.e., can be waited for. Running
165 processes can be waited for, but exited and fake processes cannot. */
167 /* Record the process status in the raw form in which it comes from `wait'.
168 This is to avoid consing in a signal handler. The `raw_status_new'
169 flag indicates that `raw_status' contains a new status that still
170 needs to be synced to `status'. */
171 bool_bf raw_status_new
: 1;
172 /* Whether this is a nonblocking socket. */
173 bool_bf is_non_blocking_client
: 1;
174 /* Whether this is a server or a client socket. */
175 bool_bf is_server
: 1;
177 /* The length of the socket backlog. */
179 /* The port number. */
181 /* The socket type. */
184 #ifdef HAVE_GETADDRINFO_A
185 /* Whether the socket is waiting for response from an asynchronous
187 struct gaicb
*dns_request
;
191 gnutls_initstage_t gnutls_initstage
;
192 gnutls_session_t gnutls_state
;
193 gnutls_certificate_client_credentials gnutls_x509_cred
;
194 gnutls_anon_client_credentials_t gnutls_anon_cred
;
195 gnutls_x509_crt_t gnutls_certificate
;
196 unsigned int gnutls_peer_verification
;
197 unsigned int gnutls_extra_peer_verification
;
198 int gnutls_log_level
;
199 int gnutls_handshakes_tried
;
200 bool_bf gnutls_p
: 1;
201 bool_bf gnutls_complete_negotiation_p
: 1;
206 PROCESSP (Lisp_Object a
)
208 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
212 CHECK_PROCESS (Lisp_Object x
)
214 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
217 INLINE
struct Lisp_Process
*
218 XPROCESS (Lisp_Object a
)
220 eassert (PROCESSP (a
));
221 return XUNTAG (a
, Lisp_Vectorlike
);
224 /* Every field in the preceding structure except for the first two
225 must be a Lisp_Object, for GC's sake. */
227 #define ChannelMask(n) (1 << (n))
229 /* Most code should use these functions to set Lisp fields in struct
233 pset_childp (struct Lisp_Process
*p
, Lisp_Object val
)
239 pset_status (struct Lisp_Process
*p
, Lisp_Object val
)
246 pset_gnutls_cred_type (struct Lisp_Process
*p
, Lisp_Object val
)
248 p
->gnutls_cred_type
= val
;
252 /* True means don't run process sentinels. This is used
254 extern bool inhibit_sentinels
;
256 /* Exit statuses for GNU programs that exec other programs. */
259 EXIT_CANCELED
= 125, /* Internal error prior to exec attempt. */
260 EXIT_CANNOT_INVOKE
= 126, /* Program located, but not usable. */
261 EXIT_ENOENT
= 127 /* Could not find program to exec. */
264 /* Defined in callproc.c. */
266 extern Lisp_Object
encode_current_directory (void);
267 extern void record_kill_process (struct Lisp_Process
*, Lisp_Object
);
269 /* Defined in sysdep.c. */
271 extern Lisp_Object
list_system_processes (void);
272 extern Lisp_Object
system_process_attributes (Lisp_Object
);
274 /* Defined in process.c. */
276 extern void record_deleted_pid (pid_t
, Lisp_Object
);
278 extern Lisp_Object
conv_sockaddr_to_lisp (struct sockaddr
*, ptrdiff_t);
279 extern void hold_keyboard_input (void);
280 extern void unhold_keyboard_input (void);
281 extern bool kbd_on_hold_p (void);
283 typedef void (*fd_callback
) (int fd
, void *data
);
285 extern void add_read_fd (int fd
, fd_callback func
, void *data
);
286 extern void delete_read_fd (int fd
);
287 extern void add_write_fd (int fd
, fd_callback func
, void *data
);
288 extern void delete_write_fd (int fd
);
289 extern void catch_child_signal (void);
290 extern void restore_nofile_limit (void);
293 extern Lisp_Object
network_interface_list (void);
294 extern Lisp_Object
network_interface_info (Lisp_Object
);
297 extern Lisp_Object
remove_slash_colon (Lisp_Object
);
299 extern void update_processes_for_thread_death (Lisp_Object
);
303 #endif /* EMACS_PROCESS_H */