process.h 8.17 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Definitions for asynchronous process control in GNU Emacs.
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 1985, 1994, 2001-2016 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5

This file is part of GNU Emacs.

6
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
7
it under the terms of the GNU General Public License as published by
8 9
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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/>.  */
Jim Blandy's avatar
Jim Blandy committed
18

19 20 21
#ifndef EMACS_PROCESS_H
#define EMACS_PROCESS_H

Stefan Monnier's avatar
Stefan Monnier committed
22 23 24
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
Paul Eggert's avatar
Paul Eggert committed
25

Stefan Monnier's avatar
Stefan Monnier committed
26
#include <unistd.h>
Jim Blandy's avatar
Jim Blandy committed
27

Ted Zlatanov's avatar
Ted Zlatanov committed
28 29 30 31
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif

Paul Eggert's avatar
Paul Eggert committed
32
INLINE_HEADER_BEGIN
33

34 35 36 37 38
/* Bound on number of file descriptors opened on behalf of a process,
   that need to be closed.  */

enum { PROCESS_OPEN_FDS = 6 };

39 40
/* This structure records information about a subprocess
   or network connection.  */
Jim Blandy's avatar
Jim Blandy committed
41 42 43

struct Lisp_Process
  {
44
    struct vectorlike_header header;
45

46
    /* Name of subprocess terminal.  */
47
    Lisp_Object tty_name;
48

49
    /* Name of this process.  */
50
    Lisp_Object name;
51

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;
55

Jim Blandy's avatar
Jim Blandy committed
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;
59

60
    /* (funcall SENTINEL PROCESS) when process state changes.  */
61
    Lisp_Object sentinel;
62

63 64
    /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
       accepts a connection from a client.  */
65
    Lisp_Object log;
66

67
    /* Buffer that output is going to.  */
68
    Lisp_Object buffer;
69

70 71 72
    /* t if this is a real child process.  For a network or serial
       connection, it is a plist based on the arguments to
       make-network-process or make-serial-process.  */
73

74
    Lisp_Object childp;
75

76
    /* Plist for programs to keep per-process state information, parameters, etc.  */
77
    Lisp_Object plist;
78

79
    /* Symbol indicating the type of process: real, network, serial.  */
80
    Lisp_Object type;
81

82
    /* Marker set to end of last buffer-inserted output from this process.  */
83
    Lisp_Object mark;
84

Jim Blandy's avatar
Jim Blandy committed
85 86 87 88 89
    /* Symbol indicating status of process.
       This may be a symbol: run, open, or closed.
       Or it may be a list, whose car is stop, exit or signal
       and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
       or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
90
    Lisp_Object status;
91

92
    /* Coding-system for decoding the input from this process.  */
93
    Lisp_Object decode_coding_system;
94

95
    /* Working buffer for decoding.  */
96
    Lisp_Object decoding_buf;
97

98
    /* Coding-system for encoding the output to this process.  */
99
    Lisp_Object encode_coding_system;
100

101
    /* Working buffer for encoding.  */
102
    Lisp_Object encoding_buf;
103

104
    /* Queue for storing waiting writes.  */
105
    Lisp_Object write_queue;
106

Ted Zlatanov's avatar
Ted Zlatanov committed
107
#ifdef HAVE_GNUTLS
108
    Lisp_Object gnutls_cred_type;
Ted Zlatanov's avatar
Ted Zlatanov committed
109 110
#endif

111 112 113
    /* Pipe process attached to the standard error of this process.  */
    Lisp_Object stderrproc;

114
    /* After this point, there are no Lisp_Objects any more.  */
115
    /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
116 117 118

    /* Number of this process.
       allocate_process assumes this is the first non-Lisp_Object field.
119 120
       A value 0 is used for pseudo-processes such as network or serial
       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 127 128
    /* Descriptors that were created for this process and that need
       closing.  Unused entries are negative.  */
    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 134 135 136 137 138
    /* Size of carryover in decoding.  */
    int decoding_carryover;
    /* Hysteresis to try to read process output in larger blocks.
       On some systems, e.g. GNU/Linux, Emacs is seen as
       an interactive app also when reading process output, meaning
       that process output can be read in as little as 1 byte at a
139 140
       time.  Value is nanoseconds to delay reading output from
       this process.  Range is 0 .. 50 * 1000 * 1000.  */
141 142 143 144
    int read_output_delay;
    /* Should we delay reading output from this process.
       Initialized from `Vprocess_adaptive_read_buffering'.
       0 = nil, 1 = t, 2 = other.  */
145
    unsigned int adaptive_read_buffering : 2;
146
    /* Skip reading this process on next read.  */
147 148
    bool_bf read_output_skip : 1;
    /* True means kill silently if Emacs is exited.
149
       This is the inverse of the `query-on-exit' flag.  */
150 151 152
    bool_bf kill_without_query : 1;
    /* True if communicating through a pty.  */
    bool_bf pty_flag : 1;
153 154
    /* Flag to set coding-system of the process buffer from the
       coding_system used to decode process output.  */
155
    bool_bf inherit_coding_system_flag : 1;
156 157
    /* Whether the process is alive, i.e., can be waited for.  Running
       processes can be waited for, but exited and fake processes cannot.  */
158
    bool_bf alive : 1;
159 160 161 162
    /* Record the process status in the raw form in which it comes from `wait'.
       This is to avoid consing in a signal handler.  The `raw_status_new'
       flag indicates that `raw_status' contains a new status that still
       needs to be synced to `status'.  */
163
    bool_bf raw_status_new : 1;
164 165
    bool_bf is_non_blocking_client : 1;
    bool_bf is_server : 1;
166
    int raw_status;
167 168 169 170
    int backlog;
    int port;
    int socktype;
    int ai_protocol;
Ted Zlatanov's avatar
Ted Zlatanov committed
171 172 173 174

#ifdef HAVE_GNUTLS
    gnutls_initstage_t gnutls_initstage;
    gnutls_session_t gnutls_state;
175 176
    gnutls_certificate_client_credentials gnutls_x509_cred;
    gnutls_anon_client_credentials_t gnutls_anon_cred;
177 178 179
    gnutls_x509_crt_t gnutls_certificate;
    unsigned int gnutls_peer_verification;
    unsigned int gnutls_extra_peer_verification;
180
    int gnutls_log_level;
181
    int gnutls_handshakes_tried;
182
    bool_bf gnutls_p : 1;
Ted Zlatanov's avatar
Ted Zlatanov committed
183
#endif
Jim Blandy's avatar
Jim Blandy committed
184 185
};

186 187 188
/* Every field in the preceding structure except for the first two
   must be a Lisp_Object, for GC's sake.  */

189
#define ChannelMask(n) (1 << (n))
Jim Blandy's avatar
Jim Blandy committed
190

Paul Eggert's avatar
Paul Eggert committed
191 192 193
/* Most code should use these functions to set Lisp fields in struct
   process.  */

Paul Eggert's avatar
Paul Eggert committed
194
INLINE void
Paul Eggert's avatar
Paul Eggert committed
195 196 197 198 199 200
pset_childp (struct Lisp_Process *p, Lisp_Object val)
{
  p->childp = val;
}

#ifdef HAVE_GNUTLS
Paul Eggert's avatar
Paul Eggert committed
201
INLINE void
Paul Eggert's avatar
Paul Eggert committed
202 203 204 205 206 207
pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->gnutls_cred_type = val;
}
#endif

208
/* True means don't run process sentinels.  This is used
209
   when exiting.  */
210
extern bool inhibit_sentinels;
211

212 213 214 215 216 217 218 219
/* Exit statuses for GNU programs that exec other programs.  */
enum
{
  EXIT_CANCELED = 125, /* Internal error prior to exec attempt.  */
  EXIT_CANNOT_INVOKE = 126, /* Program located, but not usable.  */
  EXIT_ENOENT = 127 /* Could not find program to exec.  */
};

220 221
/* Defined in callproc.c.  */

222
extern Lisp_Object encode_current_directory (void);
223
extern void record_kill_process (struct Lisp_Process *, Lisp_Object);
224

225
/* Defined in sysdep.c.  */
226

227 228 229
extern Lisp_Object list_system_processes (void);
extern Lisp_Object system_process_attributes (Lisp_Object);

230 231 232
/* Defined in process.c.  */

extern void record_deleted_pid (pid_t, Lisp_Object);
233 234
struct sockaddr;
extern Lisp_Object conv_sockaddr_to_lisp (struct sockaddr *, int);
235 236
extern void hold_keyboard_input (void);
extern void unhold_keyboard_input (void);
237
extern bool kbd_on_hold_p (void);
238

239
typedef void (*fd_callback) (int fd, void *data);
240 241 242 243 244

extern void add_read_fd (int fd, fd_callback func, void *data);
extern void delete_read_fd (int fd);
extern void add_write_fd (int fd, fd_callback func, void *data);
extern void delete_write_fd (int fd);
245
extern void catch_child_signal (void);
Paul Eggert's avatar
Paul Eggert committed
246

247
#ifdef WINDOWSNT
248 249
extern Lisp_Object network_interface_list (void);
extern Lisp_Object network_interface_info (Lisp_Object);
250
#endif
251

252
extern Lisp_Object remove_slash_colon (Lisp_Object);
253

Paul Eggert's avatar
Paul Eggert committed
254
INLINE_HEADER_END
255 256

#endif /* EMACS_PROCESS_H */