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