Commit | Line | Data |
---|---|---|
92d97f2c | 1 | /* Definitions for asynchronous process control in GNU Emacs. |
ab422c4d | 2 | Copyright (C) 1985, 1994, 2001-2013 Free Software Foundation, Inc. |
92d97f2c JB |
3 | |
4 | This file is part of GNU Emacs. | |
5 | ||
b9b1cc14 | 6 | GNU Emacs is free software: you can redistribute it and/or modify |
92d97f2c | 7 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
8 | the Free Software Foundation, either version 3 of the License, or |
9 | (at your option) any later version. | |
92d97f2c JB |
10 | |
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. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
b9b1cc14 | 17 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
92d97f2c | 18 | |
a9ec7317 SM |
19 | #ifdef HAVE_SYS_TYPES_H |
20 | #include <sys/types.h> | |
21 | #endif | |
4004364e | 22 | |
a9ec7317 | 23 | #include <unistd.h> |
92d97f2c | 24 | |
8af55556 TZ |
25 | #ifdef HAVE_GNUTLS |
26 | #include "gnutls.h" | |
27 | #endif | |
28 | ||
6a09a33b PE |
29 | INLINE_HEADER_BEGIN |
30 | #ifndef PROCESS_INLINE | |
31 | # define PROCESS_INLINE INLINE | |
32 | #endif | |
2ba993db | 33 | |
94fcd171 PE |
34 | /* Bound on number of file descriptors opened on behalf of a process, |
35 | that need to be closed. */ | |
36 | ||
37 | enum { PROCESS_OPEN_FDS = 6 }; | |
38 | ||
3193acd2 DA |
39 | /* This structure records information about a subprocess |
40 | or network connection. */ | |
92d97f2c JB |
41 | |
42 | struct Lisp_Process | |
43 | { | |
b102ceb1 | 44 | struct vectorlike_header header; |
eab3844f | 45 | |
93103d17 | 46 | /* Name of subprocess terminal. */ |
4d2b044c | 47 | Lisp_Object tty_name; |
3193acd2 | 48 | |
92d97f2c | 49 | /* Name of this process */ |
4d2b044c | 50 | Lisp_Object name; |
3193acd2 | 51 | |
cfa955c2 KS |
52 | /* List of command arguments that this process was run with. |
53 | Is set to t for a stopped network process; nil otherwise. */ | |
4d2b044c | 54 | Lisp_Object command; |
3193acd2 | 55 | |
92d97f2c JB |
56 | /* (funcall FILTER PROC STRING) (if FILTER is non-nil) |
57 | to dispose of a bunch of chars from the process all at once */ | |
4d2b044c | 58 | Lisp_Object filter; |
3193acd2 | 59 | |
92d97f2c | 60 | /* (funcall SENTINEL PROCESS) when process state changes */ |
4d2b044c | 61 | Lisp_Object sentinel; |
3193acd2 | 62 | |
cfa955c2 KS |
63 | /* (funcall LOG SERVER CLIENT MESSAGE) when a server process |
64 | accepts a connection from a client. */ | |
4d2b044c | 65 | Lisp_Object log; |
3193acd2 | 66 | |
92d97f2c | 67 | /* Buffer that output is going to */ |
4d2b044c | 68 | Lisp_Object buffer; |
3193acd2 | 69 | |
d888760c GM |
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. */ | |
3193acd2 | 73 | |
4d2b044c | 74 | Lisp_Object childp; |
3193acd2 | 75 | |
59be51d7 | 76 | /* Plist for programs to keep per-process state information, parameters, etc. */ |
4d2b044c | 77 | Lisp_Object plist; |
3193acd2 | 78 | |
d888760c | 79 | /* Symbol indicating the type of process: real, network, serial */ |
4d2b044c | 80 | Lisp_Object type; |
3193acd2 | 81 | |
92d97f2c | 82 | /* Marker set to end of last buffer-inserted output from this process */ |
4d2b044c | 83 | Lisp_Object mark; |
3193acd2 | 84 | |
92d97f2c JB |
85 | /* Symbol indicating status of process. |
86 | This may be a symbol: run, open, or closed. | |
87 | Or it may be a list, whose car is stop, exit or signal | |
88 | and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG) | |
89 | or (SIGNAL_NUMBER . COREDUMP_FLAG). */ | |
4d2b044c | 90 | Lisp_Object status; |
3193acd2 | 91 | |
3b92c4f5 | 92 | /* Coding-system for decoding the input from this process. */ |
4d2b044c | 93 | Lisp_Object decode_coding_system; |
3193acd2 | 94 | |
3b92c4f5 | 95 | /* Working buffer for decoding. */ |
4d2b044c | 96 | Lisp_Object decoding_buf; |
3193acd2 | 97 | |
3b92c4f5 | 98 | /* Coding-system for encoding the output to this process. */ |
4d2b044c | 99 | Lisp_Object encode_coding_system; |
3193acd2 | 100 | |
3b92c4f5 | 101 | /* Working buffer for encoding. */ |
4d2b044c | 102 | Lisp_Object encoding_buf; |
3193acd2 | 103 | |
20ca2e94 | 104 | /* Queue for storing waiting writes */ |
4d2b044c | 105 | Lisp_Object write_queue; |
6bfd98e7 | 106 | |
8af55556 | 107 | #ifdef HAVE_GNUTLS |
4d2b044c | 108 | Lisp_Object gnutls_cred_type; |
8af55556 TZ |
109 | #endif |
110 | ||
6bfd98e7 | 111 | /* After this point, there are no Lisp_Objects any more. */ |
60f0fb11 | 112 | /* alloc.c assumes that `pid' is the first such non-Lisp slot. */ |
6bfd98e7 SM |
113 | |
114 | /* Number of this process. | |
115 | allocate_process assumes this is the first non-Lisp_Object field. | |
d888760c GM |
116 | A value 0 is used for pseudo-processes such as network or serial |
117 | connections. */ | |
6bfd98e7 | 118 | pid_t pid; |
60f0fb11 SM |
119 | /* Descriptor by which we read from this process */ |
120 | int infd; | |
121 | /* Descriptor by which we write to this process */ | |
122 | int outfd; | |
94fcd171 PE |
123 | /* Descriptors that were created for this process and that need |
124 | closing. Unused entries are negative. */ | |
125 | int open_fd[PROCESS_OPEN_FDS]; | |
60f0fb11 | 126 | /* Event-count of last event in which this process changed status. */ |
e4d81efc | 127 | EMACS_INT tick; |
60f0fb11 | 128 | /* Event-count of last such event reported. */ |
e4d81efc | 129 | EMACS_INT update_tick; |
60f0fb11 SM |
130 | /* Size of carryover in decoding. */ |
131 | int decoding_carryover; | |
132 | /* Hysteresis to try to read process output in larger blocks. | |
133 | On some systems, e.g. GNU/Linux, Emacs is seen as | |
134 | an interactive app also when reading process output, meaning | |
135 | that process output can be read in as little as 1 byte at a | |
d35af63c PE |
136 | time. Value is nanoseconds to delay reading output from |
137 | this process. Range is 0 .. 50 * 1000 * 1000. */ | |
60f0fb11 SM |
138 | int read_output_delay; |
139 | /* Should we delay reading output from this process. | |
140 | Initialized from `Vprocess_adaptive_read_buffering'. | |
141 | 0 = nil, 1 = t, 2 = other. */ | |
28545f7c | 142 | unsigned int adaptive_read_buffering : 2; |
60f0fb11 | 143 | /* Skip reading this process on next read. */ |
28545f7c | 144 | unsigned int read_output_skip : 1; |
60f0fb11 SM |
145 | /* Non-nil means kill silently if Emacs is exited. |
146 | This is the inverse of the `query-on-exit' flag. */ | |
28545f7c | 147 | unsigned int kill_without_query : 1; |
60f0fb11 | 148 | /* Non-nil if communicating through a pty. */ |
28545f7c | 149 | unsigned int pty_flag : 1; |
60f0fb11 SM |
150 | /* Flag to set coding-system of the process buffer from the |
151 | coding_system used to decode process output. */ | |
28545f7c | 152 | unsigned int inherit_coding_system_flag : 1; |
0b3d4a47 PE |
153 | /* Whether the process is alive, i.e., can be waited for. Running |
154 | processes can be waited for, but exited and fake processes cannot. */ | |
155 | unsigned int alive : 1; | |
6bfd98e7 SM |
156 | /* Record the process status in the raw form in which it comes from `wait'. |
157 | This is to avoid consing in a signal handler. The `raw_status_new' | |
158 | flag indicates that `raw_status' contains a new status that still | |
159 | needs to be synced to `status'. */ | |
28545f7c | 160 | unsigned int raw_status_new : 1; |
6bfd98e7 | 161 | int raw_status; |
8af55556 TZ |
162 | |
163 | #ifdef HAVE_GNUTLS | |
164 | gnutls_initstage_t gnutls_initstage; | |
165 | gnutls_session_t gnutls_state; | |
8ed70bf3 LMI |
166 | gnutls_certificate_client_credentials gnutls_x509_cred; |
167 | gnutls_anon_client_credentials_t gnutls_anon_cred; | |
168 | int gnutls_log_level; | |
a18ecafa | 169 | int gnutls_handshakes_tried; |
0bce5d9e | 170 | unsigned int gnutls_p : 1; |
8af55556 | 171 | #endif |
92d97f2c JB |
172 | }; |
173 | ||
2ba993db RS |
174 | /* Every field in the preceding structure except for the first two |
175 | must be a Lisp_Object, for GC's sake. */ | |
176 | ||
925a6be7 | 177 | #define ChannelMask(n) (1 << (n)) |
92d97f2c | 178 | |
6a09a33b PE |
179 | /* Most code should use these functions to set Lisp fields in struct |
180 | process. */ | |
181 | ||
182 | PROCESS_INLINE void | |
183 | pset_childp (struct Lisp_Process *p, Lisp_Object val) | |
184 | { | |
185 | p->childp = val; | |
186 | } | |
187 | ||
188 | #ifdef HAVE_GNUTLS | |
189 | PROCESS_INLINE void | |
190 | pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val) | |
191 | { | |
192 | p->gnutls_cred_type = val; | |
193 | } | |
194 | #endif | |
195 | ||
0bce5d9e | 196 | /* True means don't run process sentinels. This is used |
5596b3bc | 197 | when exiting. */ |
0bce5d9e | 198 | extern bool inhibit_sentinels; |
5596b3bc | 199 | |
5bef3aec EZ |
200 | extern Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname; |
201 | extern Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime; | |
202 | extern Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs; | |
203 | extern Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtpgid, Qcstime; | |
82786952 | 204 | extern Lisp_Object Qtime, Qctime; |
955cbe7b | 205 | extern Lisp_Object QCspeed; |
3ef1d108 DN |
206 | extern Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven; |
207 | extern Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary; | |
5bef3aec | 208 | |
4ebbdd67 PE |
209 | /* Exit statuses for GNU programs that exec other programs. */ |
210 | enum | |
211 | { | |
212 | EXIT_CANCELED = 125, /* Internal error prior to exec attempt. */ | |
213 | EXIT_CANNOT_INVOKE = 126, /* Program located, but not usable. */ | |
214 | EXIT_ENOENT = 127 /* Could not find program to exec. */ | |
215 | }; | |
216 | ||
35fb8050 PE |
217 | /* Defined in callproc.c. */ |
218 | ||
c7041908 PE |
219 | extern void block_child_signal (void); |
220 | extern void unblock_child_signal (void); | |
c365c355 | 221 | extern Lisp_Object encode_current_directory (void); |
94fcd171 | 222 | extern void record_kill_process (struct Lisp_Process *, Lisp_Object); |
35fb8050 | 223 | |
94fcd171 | 224 | /* Defined in sysdep.c. */ |
35fb8050 | 225 | |
06e111a6 DN |
226 | extern Lisp_Object list_system_processes (void); |
227 | extern Lisp_Object system_process_attributes (Lisp_Object); | |
228 | ||
94fcd171 PE |
229 | /* Defined in process.c. */ |
230 | ||
231 | extern void record_deleted_pid (pid_t, Lisp_Object); | |
cb768704 J |
232 | extern void hold_keyboard_input (void); |
233 | extern void unhold_keyboard_input (void); | |
0bce5d9e | 234 | extern bool kbd_on_hold_p (void); |
cb768704 | 235 | |
de1339b0 | 236 | typedef void (*fd_callback) (int fd, void *data); |
3fad2ad2 J |
237 | |
238 | extern void add_read_fd (int fd, fd_callback func, void *data); | |
239 | extern void delete_read_fd (int fd); | |
240 | extern void add_write_fd (int fd, fd_callback func, void *data); | |
241 | extern void delete_write_fd (int fd); | |
dae2f5ef | 242 | #ifdef NS_IMPL_GNUSTEP |
c0342369 | 243 | extern void catch_child_signal (void); |
dae2f5ef | 244 | #endif |
6a09a33b PE |
245 | |
246 | INLINE_HEADER_END |