merge from trunk
[emacs.git] / src / process.h
blobe8bafe689b13fc17c093170f21eb8484c7606625
1 /* Definitions for asynchronous process control in GNU Emacs.
2 Copyright (C) 1985, 1994, 2001-2013 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
9 (at 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 <http://www.gnu.org/licenses/>. */
19 #ifdef HAVE_SYS_TYPES_H
20 #include <sys/types.h>
21 #endif
23 #include <unistd.h>
25 #ifdef HAVE_GNUTLS
26 #include "gnutls.h"
27 #endif
29 INLINE_HEADER_BEGIN
30 #ifndef PROCESS_INLINE
31 # define PROCESS_INLINE INLINE
32 #endif
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. */
42 struct Lisp_Process
44 struct vectorlike_header header;
46 /* Name of subprocess terminal. */
47 Lisp_Object tty_name;
49 /* Name of this process */
50 Lisp_Object name;
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;
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;
60 /* (funcall SENTINEL PROCESS) when process state changes */
61 Lisp_Object sentinel;
63 /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
64 accepts a connection from a client. */
65 Lisp_Object log;
67 /* Buffer that output is going to */
68 Lisp_Object buffer;
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. */
74 Lisp_Object childp;
76 /* Plist for programs to keep per-process state information, parameters, etc. */
77 Lisp_Object plist;
79 /* Symbol indicating the type of process: real, network, serial */
80 Lisp_Object type;
82 /* Marker set to end of last buffer-inserted output from this process */
83 Lisp_Object mark;
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). */
90 Lisp_Object status;
92 /* Coding-system for decoding the input from this process. */
93 Lisp_Object decode_coding_system;
95 /* Working buffer for decoding. */
96 Lisp_Object decoding_buf;
98 /* Coding-system for encoding the output to this process. */
99 Lisp_Object encode_coding_system;
101 /* Working buffer for encoding. */
102 Lisp_Object encoding_buf;
104 /* Queue for storing waiting writes */
105 Lisp_Object write_queue;
107 #ifdef HAVE_GNUTLS
108 Lisp_Object gnutls_cred_type;
109 #endif
111 /* The thread a process is linked to, or nil for any thread. */
112 Lisp_Object thread;
114 /* After this point, there are no Lisp_Objects any more. */
115 /* alloc.c assumes that `pid' is the first such non-Lisp slot. */
117 /* Number of this process.
118 allocate_process assumes this is the first non-Lisp_Object field.
119 A value 0 is used for pseudo-processes such as network or serial
120 connections. */
121 pid_t pid;
122 /* Descriptor by which we read from this process */
123 int infd;
124 /* Descriptor by which we write to this process */
125 int outfd;
126 /* Descriptors that were created for this process and that need
127 closing. Unused entries are negative. */
128 int open_fd[PROCESS_OPEN_FDS];
129 /* Event-count of last event in which this process changed status. */
130 EMACS_INT tick;
131 /* Event-count of last such event reported. */
132 EMACS_INT update_tick;
133 /* Size of carryover in decoding. */
134 int decoding_carryover;
135 /* Hysteresis to try to read process output in larger blocks.
136 On some systems, e.g. GNU/Linux, Emacs is seen as
137 an interactive app also when reading process output, meaning
138 that process output can be read in as little as 1 byte at a
139 time. Value is nanoseconds to delay reading output from
140 this process. Range is 0 .. 50 * 1000 * 1000. */
141 int read_output_delay;
142 /* Should we delay reading output from this process.
143 Initialized from `Vprocess_adaptive_read_buffering'.
144 0 = nil, 1 = t, 2 = other. */
145 unsigned int adaptive_read_buffering : 2;
146 /* Skip reading this process on next read. */
147 unsigned int read_output_skip : 1;
148 /* Non-nil means kill silently if Emacs is exited.
149 This is the inverse of the `query-on-exit' flag. */
150 unsigned int kill_without_query : 1;
151 /* Non-nil if communicating through a pty. */
152 unsigned int pty_flag : 1;
153 /* Flag to set coding-system of the process buffer from the
154 coding_system used to decode process output. */
155 unsigned int inherit_coding_system_flag : 1;
156 /* Whether the process is alive, i.e., can be waited for. Running
157 processes can be waited for, but exited and fake processes cannot. */
158 unsigned int alive : 1;
159 /* Record the process status in the raw form in which it comes from `wait'.
160 This is to avoid consing in a signal handler. The `raw_status_new'
161 flag indicates that `raw_status' contains a new status that still
162 needs to be synced to `status'. */
163 unsigned int raw_status_new : 1;
164 int raw_status;
166 #ifdef HAVE_GNUTLS
167 gnutls_initstage_t gnutls_initstage;
168 gnutls_session_t gnutls_state;
169 gnutls_certificate_client_credentials gnutls_x509_cred;
170 gnutls_anon_client_credentials_t gnutls_anon_cred;
171 int gnutls_log_level;
172 int gnutls_handshakes_tried;
173 unsigned int gnutls_p : 1;
174 #endif
177 /* Every field in the preceding structure except for the first two
178 must be a Lisp_Object, for GC's sake. */
180 #define ChannelMask(n) (1 << (n))
182 /* Most code should use these functions to set Lisp fields in struct
183 process. */
185 PROCESS_INLINE void
186 pset_childp (struct Lisp_Process *p, Lisp_Object val)
188 p->childp = val;
191 #ifdef HAVE_GNUTLS
192 PROCESS_INLINE void
193 pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
195 p->gnutls_cred_type = val;
197 #endif
199 /* True means don't run process sentinels. This is used
200 when exiting. */
201 extern bool inhibit_sentinels;
203 extern Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname;
204 extern Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime;
205 extern Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
206 extern Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtpgid, Qcstime;
207 extern Lisp_Object Qtime, Qctime;
208 extern Lisp_Object QCspeed;
209 extern Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
210 extern Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
212 /* Exit statuses for GNU programs that exec other programs. */
213 enum
215 EXIT_CANCELED = 125, /* Internal error prior to exec attempt. */
216 EXIT_CANNOT_INVOKE = 126, /* Program located, but not usable. */
217 EXIT_ENOENT = 127 /* Could not find program to exec. */
220 /* Defined in callproc.c. */
222 extern void block_child_signal (void);
223 extern void unblock_child_signal (void);
224 extern Lisp_Object encode_current_directory (void);
225 extern void record_kill_process (struct Lisp_Process *, Lisp_Object);
227 /* Defined in sysdep.c. */
229 extern Lisp_Object list_system_processes (void);
230 extern Lisp_Object system_process_attributes (Lisp_Object);
232 /* Defined in process.c. */
234 extern void record_deleted_pid (pid_t, Lisp_Object);
235 extern void hold_keyboard_input (void);
236 extern void unhold_keyboard_input (void);
237 extern bool kbd_on_hold_p (void);
239 typedef void (*fd_callback) (int fd, void *data);
241 extern void add_read_fd (int fd, fd_callback func, void *data);
242 extern void delete_read_fd (int fd);
243 extern void add_write_fd (int fd, fd_callback func, void *data);
244 extern void delete_write_fd (int fd);
245 #ifdef NS_IMPL_GNUSTEP
246 extern void catch_child_signal (void);
247 #endif
249 extern void update_processes_for_thread_death (Lisp_Object);
251 INLINE_HEADER_END