1 /* Definitions for asynchronous process control in GNU Emacs.
2 Copyright (C) 1985, 1994, 2001-2012 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>
29 /* Most code should use these macros to access Lisp fields in
30 struct Lisp_Process. PGET should not be used as lvalue. */
32 #define PGET(p, field) \
33 (eassert (offsetof (struct Lisp_Process, field ## _) \
34 < offsetof (struct Lisp_Process, pid)), \
35 ((p)->INTERNAL_FIELD (field)))
37 #define PSET(p, field, value) ((p)->INTERNAL_FIELD (field) = (value))
39 /* This structure records information about a subprocess
40 or network connection. */
44 struct vectorlike_header header
;
46 /* Name of subprocess terminal. */
47 Lisp_Object
INTERNAL_FIELD (tty_name
);
49 /* Name of this process */
50 Lisp_Object
INTERNAL_FIELD (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
INTERNAL_FIELD (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
INTERNAL_FIELD (filter
);
60 /* (funcall SENTINEL PROCESS) when process state changes */
61 Lisp_Object
INTERNAL_FIELD (sentinel
);
63 /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
64 accepts a connection from a client. */
65 Lisp_Object
INTERNAL_FIELD (log
);
67 /* Buffer that output is going to */
68 Lisp_Object
INTERNAL_FIELD (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
INTERNAL_FIELD (childp
);
76 /* Plist for programs to keep per-process state information, parameters, etc. */
77 Lisp_Object
INTERNAL_FIELD (plist
);
79 /* Symbol indicating the type of process: real, network, serial */
80 Lisp_Object
INTERNAL_FIELD (type
);
82 /* Marker set to end of last buffer-inserted output from this process */
83 Lisp_Object
INTERNAL_FIELD (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
INTERNAL_FIELD (status
);
92 /* Coding-system for decoding the input from this process. */
93 Lisp_Object
INTERNAL_FIELD (decode_coding_system
);
95 /* Working buffer for decoding. */
96 Lisp_Object
INTERNAL_FIELD (decoding_buf
);
98 /* Coding-system for encoding the output to this process. */
99 Lisp_Object
INTERNAL_FIELD (encode_coding_system
);
101 /* Working buffer for encoding. */
102 Lisp_Object
INTERNAL_FIELD (encoding_buf
);
104 /* Queue for storing waiting writes */
105 Lisp_Object
INTERNAL_FIELD (write_queue
);
108 Lisp_Object
INTERNAL_FIELD (gnutls_cred_type
);
111 /* After this point, there are no Lisp_Objects any more. */
112 /* alloc.c assumes that `pid' is the first such non-Lisp slot. */
114 /* Number of this process.
115 allocate_process assumes this is the first non-Lisp_Object field.
116 A value 0 is used for pseudo-processes such as network or serial
119 /* Descriptor by which we read from this process */
121 /* Descriptor by which we write to this process */
123 /* Event-count of last event in which this process changed status. */
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 unsigned int read_output_skip
: 1;
142 /* Non-nil means kill silently if Emacs is exited.
143 This is the inverse of the `query-on-exit' flag. */
144 unsigned int kill_without_query
: 1;
145 /* Non-nil if communicating through a pty. */
146 unsigned int pty_flag
: 1;
147 /* Flag to set coding-system of the process buffer from the
148 coding_system used to decode process output. */
149 unsigned int inherit_coding_system_flag
: 1;
150 /* Record the process status in the raw form in which it comes from `wait'.
151 This is to avoid consing in a signal handler. The `raw_status_new'
152 flag indicates that `raw_status' contains a new status that still
153 needs to be synced to `status'. */
154 unsigned int raw_status_new
: 1;
158 gnutls_initstage_t gnutls_initstage
;
159 gnutls_session_t gnutls_state
;
160 gnutls_certificate_client_credentials gnutls_x509_cred
;
161 gnutls_anon_client_credentials_t gnutls_anon_cred
;
162 int gnutls_log_level
;
163 int gnutls_handshakes_tried
;
168 /* Every field in the preceding structure except for the first two
169 must be a Lisp_Object, for GC's sake. */
171 #define ChannelMask(n) (1 << (n))
173 /* True if we are about to fork off a synchronous process or if we
174 are waiting for it. */
175 extern int synch_process_alive
;
177 /* Communicate exit status of sync process to from sigchld_handler
180 /* Nonzero => this is a string explaining death of synchronous subprocess. */
181 extern const char *synch_process_death
;
183 /* Nonzero => this is the signal number that terminated the subprocess. */
184 extern int synch_process_termsig
;
186 /* If synch_process_death is zero,
187 this is exit code of synchronous subprocess. */
188 extern int synch_process_retcode
;
190 /* Nonzero means don't run process sentinels. This is used
192 extern int inhibit_sentinels
;
194 extern Lisp_Object Qeuid
, Qegid
, Qcomm
, Qstate
, Qppid
, Qpgrp
, Qsess
, Qttname
;
195 extern Lisp_Object Qminflt
, Qmajflt
, Qcminflt
, Qcmajflt
, Qutime
, Qstime
;
196 extern Lisp_Object Qcutime
, Qpri
, Qnice
, Qthcount
, Qstart
, Qvsize
, Qrss
, Qargs
;
197 extern Lisp_Object Quser
, Qgroup
, Qetime
, Qpcpu
, Qpmem
, Qtpgid
, Qcstime
;
198 extern Lisp_Object Qtime
, Qctime
;
199 extern Lisp_Object QCspeed
;
200 extern Lisp_Object QCbytesize
, QCstopbits
, QCparity
, Qodd
, Qeven
;
201 extern Lisp_Object QCflowcontrol
, Qhw
, Qsw
, QCsummary
;
203 extern Lisp_Object
list_system_processes (void);
204 extern Lisp_Object
system_process_attributes (Lisp_Object
);
206 extern void hold_keyboard_input (void);
207 extern void unhold_keyboard_input (void);
208 extern int kbd_on_hold_p (void);
210 typedef void (*fd_callback
)(int fd
, void *data
, int for_read
);
212 extern void add_read_fd (int fd
, fd_callback func
, void *data
);
213 extern void delete_read_fd (int fd
);
214 extern void add_write_fd (int fd
, fd_callback func
, void *data
);
215 extern void delete_write_fd (int fd
);