| 1 | /* Definitions for asynchronous process control in GNU Emacs. |
| 2 | Copyright (C) 1985, 1994, 2001-2014 Free Software Foundation, Inc. |
| 3 | |
| 4 | This file is part of GNU Emacs. |
| 5 | |
| 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 |
| 9 | (at your option) any later version. |
| 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 |
| 17 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 18 | |
| 19 | #ifdef HAVE_SYS_TYPES_H |
| 20 | #include <sys/types.h> |
| 21 | #endif |
| 22 | |
| 23 | #include <unistd.h> |
| 24 | |
| 25 | #ifdef HAVE_GNUTLS |
| 26 | #include "gnutls.h" |
| 27 | #endif |
| 28 | |
| 29 | INLINE_HEADER_BEGIN |
| 30 | |
| 31 | /* Bound on number of file descriptors opened on behalf of a process, |
| 32 | that need to be closed. */ |
| 33 | |
| 34 | enum { PROCESS_OPEN_FDS = 6 }; |
| 35 | |
| 36 | /* This structure records information about a subprocess |
| 37 | or network connection. */ |
| 38 | |
| 39 | struct Lisp_Process |
| 40 | { |
| 41 | struct vectorlike_header header; |
| 42 | |
| 43 | /* Name of subprocess terminal. */ |
| 44 | Lisp_Object tty_name; |
| 45 | |
| 46 | /* Name of this process */ |
| 47 | Lisp_Object name; |
| 48 | |
| 49 | /* List of command arguments that this process was run with. |
| 50 | Is set to t for a stopped network process; nil otherwise. */ |
| 51 | Lisp_Object command; |
| 52 | |
| 53 | /* (funcall FILTER PROC STRING) (if FILTER is non-nil) |
| 54 | to dispose of a bunch of chars from the process all at once */ |
| 55 | Lisp_Object filter; |
| 56 | |
| 57 | /* (funcall SENTINEL PROCESS) when process state changes */ |
| 58 | Lisp_Object sentinel; |
| 59 | |
| 60 | /* (funcall LOG SERVER CLIENT MESSAGE) when a server process |
| 61 | accepts a connection from a client. */ |
| 62 | Lisp_Object log; |
| 63 | |
| 64 | /* Buffer that output is going to */ |
| 65 | Lisp_Object buffer; |
| 66 | |
| 67 | /* t if this is a real child process. For a network or serial |
| 68 | connection, it is a plist based on the arguments to |
| 69 | 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 | |
| 79 | /* Marker set to end of last buffer-inserted output from this process */ |
| 80 | Lisp_Object mark; |
| 81 | |
| 82 | /* Symbol indicating status of process. |
| 83 | This may be a symbol: run, open, or closed. |
| 84 | Or it may be a list, whose car is stop, exit or signal |
| 85 | and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG) |
| 86 | 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 | |
| 104 | #ifdef HAVE_GNUTLS |
| 105 | Lisp_Object gnutls_cred_type; |
| 106 | #endif |
| 107 | |
| 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 | /* Number of this process. |
| 112 | allocate_process assumes this is the first non-Lisp_Object field. |
| 113 | A value 0 is used for pseudo-processes such as network or serial |
| 114 | connections. */ |
| 115 | pid_t pid; |
| 116 | /* Descriptor by which we read from this process */ |
| 117 | int infd; |
| 118 | /* Descriptor by which we write to this process */ |
| 119 | int outfd; |
| 120 | /* Descriptors that were created for this process and that need |
| 121 | closing. Unused entries are negative. */ |
| 122 | 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 | /* Size of carryover in decoding. */ |
| 128 | int decoding_carryover; |
| 129 | /* Hysteresis to try to read process output in larger blocks. |
| 130 | On some systems, e.g. GNU/Linux, Emacs is seen as |
| 131 | an interactive app also when reading process output, meaning |
| 132 | that process output can be read in as little as 1 byte at a |
| 133 | time. Value is nanoseconds to delay reading output from |
| 134 | this process. Range is 0 .. 50 * 1000 * 1000. */ |
| 135 | int read_output_delay; |
| 136 | /* Should we delay reading output from this process. |
| 137 | Initialized from `Vprocess_adaptive_read_buffering'. |
| 138 | 0 = nil, 1 = t, 2 = other. */ |
| 139 | unsigned int adaptive_read_buffering : 2; |
| 140 | /* Skip reading this process on next read. */ |
| 141 | bool_bf read_output_skip : 1; |
| 142 | /* True means kill silently if Emacs is exited. |
| 143 | This is the inverse of the `query-on-exit' flag. */ |
| 144 | bool_bf kill_without_query : 1; |
| 145 | /* True if communicating through a pty. */ |
| 146 | bool_bf pty_flag : 1; |
| 147 | /* Flag to set coding-system of the process buffer from the |
| 148 | coding_system used to decode process output. */ |
| 149 | bool_bf inherit_coding_system_flag : 1; |
| 150 | /* Whether the process is alive, i.e., can be waited for. Running |
| 151 | processes can be waited for, but exited and fake processes cannot. */ |
| 152 | bool_bf alive : 1; |
| 153 | /* Record the process status in the raw form in which it comes from `wait'. |
| 154 | This is to avoid consing in a signal handler. The `raw_status_new' |
| 155 | flag indicates that `raw_status' contains a new status that still |
| 156 | needs to be synced to `status'. */ |
| 157 | bool_bf raw_status_new : 1; |
| 158 | int raw_status; |
| 159 | |
| 160 | #ifdef HAVE_GNUTLS |
| 161 | gnutls_initstage_t gnutls_initstage; |
| 162 | gnutls_session_t gnutls_state; |
| 163 | gnutls_certificate_client_credentials gnutls_x509_cred; |
| 164 | gnutls_anon_client_credentials_t gnutls_anon_cred; |
| 165 | int gnutls_log_level; |
| 166 | int gnutls_handshakes_tried; |
| 167 | bool_bf gnutls_p : 1; |
| 168 | #endif |
| 169 | }; |
| 170 | |
| 171 | /* Every field in the preceding structure except for the first two |
| 172 | must be a Lisp_Object, for GC's sake. */ |
| 173 | |
| 174 | #define ChannelMask(n) (1 << (n)) |
| 175 | |
| 176 | /* Most code should use these functions to set Lisp fields in struct |
| 177 | process. */ |
| 178 | |
| 179 | INLINE void |
| 180 | pset_childp (struct Lisp_Process *p, Lisp_Object val) |
| 181 | { |
| 182 | p->childp = val; |
| 183 | } |
| 184 | |
| 185 | #ifdef HAVE_GNUTLS |
| 186 | INLINE void |
| 187 | pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val) |
| 188 | { |
| 189 | p->gnutls_cred_type = val; |
| 190 | } |
| 191 | #endif |
| 192 | |
| 193 | /* True means don't run process sentinels. This is used |
| 194 | when exiting. */ |
| 195 | extern bool inhibit_sentinels; |
| 196 | |
| 197 | extern Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname; |
| 198 | extern Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime; |
| 199 | extern Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs; |
| 200 | extern Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtpgid, Qcstime; |
| 201 | extern Lisp_Object Qtime, Qctime; |
| 202 | extern Lisp_Object QCspeed; |
| 203 | extern Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven; |
| 204 | extern Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary; |
| 205 | |
| 206 | /* Exit statuses for GNU programs that exec other programs. */ |
| 207 | enum |
| 208 | { |
| 209 | EXIT_CANCELED = 125, /* Internal error prior to exec attempt. */ |
| 210 | EXIT_CANNOT_INVOKE = 126, /* Program located, but not usable. */ |
| 211 | EXIT_ENOENT = 127 /* Could not find program to exec. */ |
| 212 | }; |
| 213 | |
| 214 | /* Defined in callproc.c. */ |
| 215 | |
| 216 | extern Lisp_Object encode_current_directory (void); |
| 217 | extern void record_kill_process (struct Lisp_Process *, Lisp_Object); |
| 218 | |
| 219 | /* Defined in sysdep.c. */ |
| 220 | |
| 221 | extern Lisp_Object list_system_processes (void); |
| 222 | extern Lisp_Object system_process_attributes (Lisp_Object); |
| 223 | |
| 224 | /* Defined in process.c. */ |
| 225 | |
| 226 | extern void record_deleted_pid (pid_t, Lisp_Object); |
| 227 | struct sockaddr; |
| 228 | extern Lisp_Object conv_sockaddr_to_lisp (struct sockaddr *, int); |
| 229 | extern void hold_keyboard_input (void); |
| 230 | extern void unhold_keyboard_input (void); |
| 231 | extern bool kbd_on_hold_p (void); |
| 232 | |
| 233 | typedef void (*fd_callback) (int fd, void *data); |
| 234 | |
| 235 | extern void add_read_fd (int fd, fd_callback func, void *data); |
| 236 | extern void delete_read_fd (int fd); |
| 237 | extern void add_write_fd (int fd, fd_callback func, void *data); |
| 238 | extern void delete_write_fd (int fd); |
| 239 | extern void catch_child_signal (void); |
| 240 | |
| 241 | #ifdef WINDOWSNT |
| 242 | extern Lisp_Object network_interface_list (void); |
| 243 | extern Lisp_Object network_interface_info (Lisp_Object); |
| 244 | #endif |
| 245 | |
| 246 | INLINE_HEADER_END |