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>
30 #ifndef PROCESS_INLINE
31 # define PROCESS_INLINE INLINE
34 /* This structure records information about a subprocess
35 or network connection. */
39 struct vectorlike_header header
;
41 /* Name of subprocess terminal. */
44 /* Name of this process */
47 /* List of command arguments that this process was run with.
48 Is set to t for a stopped network process; nil otherwise. */
51 /* (funcall FILTER PROC STRING) (if FILTER is non-nil)
52 to dispose of a bunch of chars from the process all at once */
55 /* (funcall SENTINEL PROCESS) when process state changes */
58 /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
59 accepts a connection from a client. */
62 /* Buffer that output is going to */
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. */
71 /* Plist for programs to keep per-process state information, parameters, etc. */
74 /* Symbol indicating the type of process: real, network, serial */
77 /* Marker set to end of last buffer-inserted output from this process */
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). */
87 /* Coding-system for decoding the input from this process. */
88 Lisp_Object decode_coding_system
;
90 /* Working buffer for decoding. */
91 Lisp_Object decoding_buf
;
93 /* Coding-system for encoding the output to this process. */
94 Lisp_Object encode_coding_system
;
96 /* Working buffer for encoding. */
97 Lisp_Object encoding_buf
;
99 /* Queue for storing waiting writes */
100 Lisp_Object write_queue
;
103 Lisp_Object gnutls_cred_type
;
106 /* After this point, there are no Lisp_Objects any more. */
107 /* alloc.c assumes that `pid' is the first such non-Lisp slot. */
109 /* Number of this process.
110 allocate_process assumes this is the first non-Lisp_Object field.
111 A value 0 is used for pseudo-processes such as network or serial
114 /* Descriptor by which we read from this process */
116 /* Descriptor by which we write to this process */
118 /* Event-count of last event in which this process changed status. */
120 /* Event-count of last such event reported. */
121 EMACS_INT update_tick
;
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
128 time. Value is nanoseconds to delay reading output from
129 this process. Range is 0 .. 50 * 1000 * 1000. */
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. */
134 unsigned int adaptive_read_buffering
: 2;
135 /* Skip reading this process on next read. */
136 unsigned int read_output_skip
: 1;
137 /* Non-nil means kill silently if Emacs is exited.
138 This is the inverse of the `query-on-exit' flag. */
139 unsigned int kill_without_query
: 1;
140 /* Non-nil if communicating through a pty. */
141 unsigned int pty_flag
: 1;
142 /* Flag to set coding-system of the process buffer from the
143 coding_system used to decode process output. */
144 unsigned int inherit_coding_system_flag
: 1;
145 /* Whether the process is alive, i.e., can be waited for. Running
146 processes can be waited for, but exited and fake processes cannot. */
147 unsigned int alive
: 1;
148 /* Record the process status in the raw form in which it comes from `wait'.
149 This is to avoid consing in a signal handler. The `raw_status_new'
150 flag indicates that `raw_status' contains a new status that still
151 needs to be synced to `status'. */
152 unsigned int raw_status_new
: 1;
156 gnutls_initstage_t gnutls_initstage
;
157 gnutls_session_t gnutls_state
;
158 gnutls_certificate_client_credentials gnutls_x509_cred
;
159 gnutls_anon_client_credentials_t gnutls_anon_cred
;
160 int gnutls_log_level
;
161 int gnutls_handshakes_tried
;
162 unsigned int gnutls_p
: 1;
166 /* Every field in the preceding structure except for the first two
167 must be a Lisp_Object, for GC's sake. */
169 #define ChannelMask(n) (1 << (n))
171 /* Most code should use these functions to set Lisp fields in struct
175 pset_childp (struct Lisp_Process
*p
, Lisp_Object val
)
182 pset_gnutls_cred_type (struct Lisp_Process
*p
, Lisp_Object val
)
184 p
->gnutls_cred_type
= val
;
188 /* True means don't run process sentinels. This is used
190 extern bool inhibit_sentinels
;
192 extern Lisp_Object Qeuid
, Qegid
, Qcomm
, Qstate
, Qppid
, Qpgrp
, Qsess
, Qttname
;
193 extern Lisp_Object Qminflt
, Qmajflt
, Qcminflt
, Qcmajflt
, Qutime
, Qstime
;
194 extern Lisp_Object Qcutime
, Qpri
, Qnice
, Qthcount
, Qstart
, Qvsize
, Qrss
, Qargs
;
195 extern Lisp_Object Quser
, Qgroup
, Qetime
, Qpcpu
, Qpmem
, Qtpgid
, Qcstime
;
196 extern Lisp_Object Qtime
, Qctime
;
197 extern Lisp_Object QCspeed
;
198 extern Lisp_Object QCbytesize
, QCstopbits
, QCparity
, Qodd
, Qeven
;
199 extern Lisp_Object QCflowcontrol
, Qhw
, Qsw
, QCsummary
;
201 /* Defined in callproc.c. */
203 extern void block_child_signal (void);
204 extern void unblock_child_signal (void);
205 extern void record_kill_process (struct Lisp_Process
*);
207 /* Defined in process.c. */
209 extern Lisp_Object
list_system_processes (void);
210 extern Lisp_Object
system_process_attributes (Lisp_Object
);
212 extern void hold_keyboard_input (void);
213 extern void unhold_keyboard_input (void);
214 extern bool kbd_on_hold_p (void);
216 typedef void (*fd_callback
) (int fd
, void *data
);
218 extern void add_read_fd (int fd
, fd_callback func
, void *data
);
219 extern void delete_read_fd (int fd
);
220 extern void add_write_fd (int fd
, fd_callback func
, void *data
);
221 extern void delete_write_fd (int fd
);
222 extern void catch_child_signal (void);