Commit | Line | Data |
---|---|---|
92d97f2c | 1 | /* Definitions for asynchronous process control in GNU Emacs. |
acaf905b | 2 | Copyright (C) 1985, 1994, 2001-2012 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 | |
3193acd2 DA |
34 | /* This structure records information about a subprocess |
35 | or network connection. */ | |
92d97f2c JB |
36 | |
37 | struct Lisp_Process | |
38 | { | |
b102ceb1 | 39 | struct vectorlike_header header; |
eab3844f | 40 | |
93103d17 | 41 | /* Name of subprocess terminal. */ |
4d2b044c | 42 | Lisp_Object tty_name; |
3193acd2 | 43 | |
92d97f2c | 44 | /* Name of this process */ |
4d2b044c | 45 | Lisp_Object name; |
3193acd2 | 46 | |
cfa955c2 KS |
47 | /* List of command arguments that this process was run with. |
48 | Is set to t for a stopped network process; nil otherwise. */ | |
4d2b044c | 49 | Lisp_Object command; |
3193acd2 | 50 | |
92d97f2c JB |
51 | /* (funcall FILTER PROC STRING) (if FILTER is non-nil) |
52 | to dispose of a bunch of chars from the process all at once */ | |
4d2b044c | 53 | Lisp_Object filter; |
3193acd2 | 54 | |
92d97f2c | 55 | /* (funcall SENTINEL PROCESS) when process state changes */ |
4d2b044c | 56 | Lisp_Object sentinel; |
3193acd2 | 57 | |
cfa955c2 KS |
58 | /* (funcall LOG SERVER CLIENT MESSAGE) when a server process |
59 | accepts a connection from a client. */ | |
4d2b044c | 60 | Lisp_Object log; |
3193acd2 | 61 | |
92d97f2c | 62 | /* Buffer that output is going to */ |
4d2b044c | 63 | Lisp_Object buffer; |
3193acd2 | 64 | |
d888760c GM |
65 | /* t if this is a real child process. For a network or serial |
66 | connection, it is a plist based on the arguments to | |
67 | make-network-process or make-serial-process. */ | |
3193acd2 | 68 | |
4d2b044c | 69 | Lisp_Object childp; |
3193acd2 | 70 | |
59be51d7 | 71 | /* Plist for programs to keep per-process state information, parameters, etc. */ |
4d2b044c | 72 | Lisp_Object plist; |
3193acd2 | 73 | |
d888760c | 74 | /* Symbol indicating the type of process: real, network, serial */ |
4d2b044c | 75 | Lisp_Object type; |
3193acd2 | 76 | |
92d97f2c | 77 | /* Marker set to end of last buffer-inserted output from this process */ |
4d2b044c | 78 | Lisp_Object mark; |
3193acd2 | 79 | |
92d97f2c JB |
80 | /* Symbol indicating status of process. |
81 | This may be a symbol: run, open, or closed. | |
82 | Or it may be a list, whose car is stop, exit or signal | |
83 | and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG) | |
84 | or (SIGNAL_NUMBER . COREDUMP_FLAG). */ | |
4d2b044c | 85 | Lisp_Object status; |
3193acd2 | 86 | |
3b92c4f5 | 87 | /* Coding-system for decoding the input from this process. */ |
4d2b044c | 88 | Lisp_Object decode_coding_system; |
3193acd2 | 89 | |
3b92c4f5 | 90 | /* Working buffer for decoding. */ |
4d2b044c | 91 | Lisp_Object decoding_buf; |
3193acd2 | 92 | |
3b92c4f5 | 93 | /* Coding-system for encoding the output to this process. */ |
4d2b044c | 94 | Lisp_Object encode_coding_system; |
3193acd2 | 95 | |
3b92c4f5 | 96 | /* Working buffer for encoding. */ |
4d2b044c | 97 | Lisp_Object encoding_buf; |
3193acd2 | 98 | |
20ca2e94 | 99 | /* Queue for storing waiting writes */ |
4d2b044c | 100 | Lisp_Object write_queue; |
6bfd98e7 | 101 | |
8af55556 | 102 | #ifdef HAVE_GNUTLS |
4d2b044c | 103 | Lisp_Object gnutls_cred_type; |
8af55556 TZ |
104 | #endif |
105 | ||
6bfd98e7 | 106 | /* After this point, there are no Lisp_Objects any more. */ |
60f0fb11 | 107 | /* alloc.c assumes that `pid' is the first such non-Lisp slot. */ |
6bfd98e7 SM |
108 | |
109 | /* Number of this process. | |
110 | allocate_process assumes this is the first non-Lisp_Object field. | |
d888760c GM |
111 | A value 0 is used for pseudo-processes such as network or serial |
112 | connections. */ | |
6bfd98e7 | 113 | pid_t pid; |
60f0fb11 SM |
114 | /* Descriptor by which we read from this process */ |
115 | int infd; | |
116 | /* Descriptor by which we write to this process */ | |
117 | int outfd; | |
118 | /* Event-count of last event in which this process changed status. */ | |
e4d81efc | 119 | EMACS_INT tick; |
60f0fb11 | 120 | /* Event-count of last such event reported. */ |
e4d81efc | 121 | EMACS_INT update_tick; |
60f0fb11 SM |
122 | /* Size of carryover in decoding. */ |
123 | int decoding_carryover; | |
124 | /* Hysteresis to try to read process output in larger blocks. | |
125 | On some systems, e.g. GNU/Linux, Emacs is seen as | |
126 | an interactive app also when reading process output, meaning | |
127 | that process output can be read in as little as 1 byte at a | |
d35af63c PE |
128 | time. Value is nanoseconds to delay reading output from |
129 | this process. Range is 0 .. 50 * 1000 * 1000. */ | |
60f0fb11 SM |
130 | int read_output_delay; |
131 | /* Should we delay reading output from this process. | |
132 | Initialized from `Vprocess_adaptive_read_buffering'. | |
133 | 0 = nil, 1 = t, 2 = other. */ | |
28545f7c | 134 | unsigned int adaptive_read_buffering : 2; |
60f0fb11 | 135 | /* Skip reading this process on next read. */ |
28545f7c | 136 | unsigned int read_output_skip : 1; |
60f0fb11 SM |
137 | /* Non-nil means kill silently if Emacs is exited. |
138 | This is the inverse of the `query-on-exit' flag. */ | |
28545f7c | 139 | unsigned int kill_without_query : 1; |
60f0fb11 | 140 | /* Non-nil if communicating through a pty. */ |
28545f7c | 141 | unsigned int pty_flag : 1; |
60f0fb11 SM |
142 | /* Flag to set coding-system of the process buffer from the |
143 | coding_system used to decode process output. */ | |
28545f7c | 144 | unsigned int inherit_coding_system_flag : 1; |
6bfd98e7 SM |
145 | /* Record the process status in the raw form in which it comes from `wait'. |
146 | This is to avoid consing in a signal handler. The `raw_status_new' | |
147 | flag indicates that `raw_status' contains a new status that still | |
148 | needs to be synced to `status'. */ | |
28545f7c | 149 | unsigned int raw_status_new : 1; |
6bfd98e7 | 150 | int raw_status; |
8af55556 TZ |
151 | |
152 | #ifdef HAVE_GNUTLS | |
153 | gnutls_initstage_t gnutls_initstage; | |
154 | gnutls_session_t gnutls_state; | |
8ed70bf3 LMI |
155 | gnutls_certificate_client_credentials gnutls_x509_cred; |
156 | gnutls_anon_client_credentials_t gnutls_anon_cred; | |
157 | int gnutls_log_level; | |
a18ecafa | 158 | int gnutls_handshakes_tried; |
df7fcaff | 159 | int gnutls_p; |
8af55556 | 160 | #endif |
92d97f2c JB |
161 | }; |
162 | ||
2ba993db RS |
163 | /* Every field in the preceding structure except for the first two |
164 | must be a Lisp_Object, for GC's sake. */ | |
165 | ||
925a6be7 | 166 | #define ChannelMask(n) (1 << (n)) |
92d97f2c | 167 | |
6a09a33b PE |
168 | /* Most code should use these functions to set Lisp fields in struct |
169 | process. */ | |
170 | ||
171 | PROCESS_INLINE void | |
172 | pset_childp (struct Lisp_Process *p, Lisp_Object val) | |
173 | { | |
174 | p->childp = val; | |
175 | } | |
176 | ||
177 | #ifdef HAVE_GNUTLS | |
178 | PROCESS_INLINE void | |
179 | pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val) | |
180 | { | |
181 | p->gnutls_cred_type = val; | |
182 | } | |
183 | #endif | |
184 | ||
e0f24100 | 185 | /* True if we are about to fork off a synchronous process or if we |
92d97f2c | 186 | are waiting for it. */ |
2f221583 | 187 | extern bool synch_process_alive; |
92d97f2c | 188 | |
8e6208c5 | 189 | /* Communicate exit status of sync process to from sigchld_handler |
7a04feb0 | 190 | to Fcall_process. */ |
7a04feb0 | 191 | |
92d97f2c | 192 | /* Nonzero => this is a string explaining death of synchronous subprocess. */ |
42ca4633 | 193 | extern const char *synch_process_death; |
92d97f2c | 194 | |
b0c681e2 | 195 | /* Nonzero => this is the signal number that terminated the subprocess. */ |
eb37b8fd | 196 | extern int synch_process_termsig; |
b0c681e2 | 197 | |
92d97f2c JB |
198 | /* If synch_process_death is zero, |
199 | this is exit code of synchronous subprocess. */ | |
200 | extern int synch_process_retcode; | |
201 | ||
5596b3bc RS |
202 | /* Nonzero means don't run process sentinels. This is used |
203 | when exiting. */ | |
204 | extern int inhibit_sentinels; | |
205 | ||
5bef3aec EZ |
206 | extern Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname; |
207 | extern Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime; | |
208 | extern Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs; | |
209 | extern Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtpgid, Qcstime; | |
82786952 | 210 | extern Lisp_Object Qtime, Qctime; |
955cbe7b | 211 | extern Lisp_Object QCspeed; |
3ef1d108 DN |
212 | extern Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven; |
213 | extern Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary; | |
5bef3aec | 214 | |
06e111a6 DN |
215 | extern Lisp_Object list_system_processes (void); |
216 | extern Lisp_Object system_process_attributes (Lisp_Object); | |
217 | ||
cb768704 J |
218 | extern void hold_keyboard_input (void); |
219 | extern void unhold_keyboard_input (void); | |
220 | extern int kbd_on_hold_p (void); | |
221 | ||
de1339b0 | 222 | typedef void (*fd_callback) (int fd, void *data); |
3fad2ad2 J |
223 | |
224 | extern void add_read_fd (int fd, fd_callback func, void *data); | |
225 | extern void delete_read_fd (int fd); | |
226 | extern void add_write_fd (int fd, fd_callback func, void *data); | |
227 | extern void delete_write_fd (int fd); | |
6a09a33b PE |
228 | |
229 | INLINE_HEADER_END |