src/process.h

   1 /* Definitions for asynchronous process control in GNU Emacs.
   2    Copyright (C) 1985, 1994, 2001-2016 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   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 (at
   9 your option) any later version.
  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
  17 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef EMACS_PROCESS_H
  20 #define EMACS_PROCESS_H
  21
  22 #ifdef HAVE_SYS_TYPES_H
  23 #include <sys/types.h>
  24 #endif
  25
  26 #include <unistd.h>
  27
  28 #ifdef HAVE_GNUTLS
  29 #include "gnutls.h"
  30 #endif
  31
  32 INLINE_HEADER_BEGIN
  33
  34 /* Bound on number of file descriptors opened on behalf of a process,
  35    that need to be closed.  */
  36
  37 enum { PROCESS_OPEN_FDS = 6 };
  38
  39 /* This structure records information about a subprocess
  40    or network connection.  */
  41
  42 struct Lisp_Process
  43   {
  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
  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     /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
  64        accepts a connection from a client.  */
  65     Lisp_Object log;
  66
  67     /* Buffer that output is going to.  */
  68     Lisp_Object buffer;
  69
  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.  */
  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
  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;
  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
 107 #ifdef HAVE_GNUTLS
 108     Lisp_Object gnutls_cred_type;
 109     Lisp_Object gnutls_boot_parameters;
 110 #endif
 111
 112     /* Pipe process attached to the standard error of this process.  */
 113     Lisp_Object stderrproc;
 114
 115     /* After this point, there are no Lisp_Objects any more.  */
 116     /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
 117
 118     /* Number of this process.
 119        allocate_process assumes this is the first non-Lisp_Object field.
 120        A value 0 is used for pseudo-processes such as network or serial
 121        connections.  */
 122     pid_t pid;
 123     /* Descriptor by which we read from this process.  */
 124     int infd;
 125     /* Descriptor by which we write to this process.  */
 126     int outfd;
 127     /* Descriptors that were created for this process and that need
 128        closing.  Unused entries are negative.  */
 129     int open_fd[PROCESS_OPEN_FDS];
 130     /* Event-count of last event in which this process changed status.  */
 131     EMACS_INT tick;
 132     /* Event-count of last such event reported.  */
 133     EMACS_INT update_tick;
 134     /* Size of carryover in decoding.  */
 135     int decoding_carryover;
 136     /* Hysteresis to try to read process output in larger blocks.
 137        On some systems, e.g. GNU/Linux, Emacs is seen as
 138        an interactive app also when reading process output, meaning
 139        that process output can be read in as little as 1 byte at a
 140        time.  Value is nanoseconds to delay reading output from
 141        this process.  Range is 0 .. 50 * 1000 * 1000.  */
 142     int read_output_delay;
 143     /* Should we delay reading output from this process.
 144        Initialized from `Vprocess_adaptive_read_buffering'.
 145        0 = nil, 1 = t, 2 = other.  */
 146     unsigned int adaptive_read_buffering : 2;
 147     /* Skip reading this process on next read.  */
 148     bool_bf read_output_skip : 1;
 149     /* True means kill silently if Emacs is exited.
 150        This is the inverse of the `query-on-exit' flag.  */
 151     bool_bf kill_without_query : 1;
 152     /* True if communicating through a pty.  */
 153     bool_bf pty_flag : 1;
 154     /* Flag to set coding-system of the process buffer from the
 155        coding_system used to decode process output.  */
 156     bool_bf inherit_coding_system_flag : 1;
 157     /* Whether the process is alive, i.e., can be waited for.  Running
 158        processes can be waited for, but exited and fake processes cannot.  */
 159     bool_bf alive : 1;
 160     /* Record the process status in the raw form in which it comes from `wait'.
 161        This is to avoid consing in a signal handler.  The `raw_status_new'
 162        flag indicates that `raw_status' contains a new status that still
 163        needs to be synced to `status'.  */
 164     bool_bf raw_status_new : 1;
 165     /* Whether this is a nonblocking socket. */
 166     bool_bf is_non_blocking_client : 1;
 167     /* Whether this is a server or a client socket. */
 168     bool_bf is_server : 1;
 169     int raw_status;
 170     /* The length of the socket backlog. */
 171     int backlog;
 172     /* The port number. */
 173     int port;
 174     /* The socket type. */
 175     int socktype;
 176     /* The socket protocol. */
 177     int ai_protocol;
 178
 179 #ifdef HAVE_GETADDRINFO_A
 180     /* Whether the socket is waiting for response from an asynchronous
 181        DNS call. */
 182     struct gaicb *dns_request;
 183 #endif
 184
 185 #ifdef HAVE_GNUTLS
 186     gnutls_initstage_t gnutls_initstage;
 187     gnutls_session_t gnutls_state;
 188     gnutls_certificate_client_credentials gnutls_x509_cred;
 189     gnutls_anon_client_credentials_t gnutls_anon_cred;
 190     gnutls_x509_crt_t gnutls_certificate;
 191     unsigned int gnutls_peer_verification;
 192     unsigned int gnutls_extra_peer_verification;
 193     int gnutls_log_level;
 194     int gnutls_handshakes_tried;
 195     bool_bf gnutls_p : 1;
 196     bool_bf gnutls_complete_negotiation_p : 1;
 197 #endif
 198 };
 199
 200 /* Every field in the preceding structure except for the first two
 201    must be a Lisp_Object, for GC's sake.  */
 202
 203 #define ChannelMask(n) (1 << (n))
 204
 205 /* Most code should use these functions to set Lisp fields in struct
 206    process.  */
 207
 208 INLINE void
 209 pset_childp (struct Lisp_Process *p, Lisp_Object val)
 210 {
 211   p->childp = val;
 212 }
 213
 214 INLINE void
 215 pset_status (struct Lisp_Process *p, Lisp_Object val)
 216 {
 217   p->status = val;
 218 }
 219
 220 #ifdef HAVE_GNUTLS
 221 INLINE void
 222 pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
 223 {
 224   p->gnutls_cred_type = val;
 225 }
 226 #endif
 227
 228 /* True means don't run process sentinels.  This is used
 229    when exiting.  */
 230 extern bool inhibit_sentinels;
 231
 232 /* Exit statuses for GNU programs that exec other programs.  */
 233 enum
 234 {
 235   EXIT_CANCELED = 125, /* Internal error prior to exec attempt.  */
 236   EXIT_CANNOT_INVOKE = 126, /* Program located, but not usable.  */
 237   EXIT_ENOENT = 127 /* Could not find program to exec.  */
 238 };
 239
 240 /* Defined in callproc.c.  */
 241
 242 extern Lisp_Object encode_current_directory (void);
 243 extern void record_kill_process (struct Lisp_Process *, Lisp_Object);
 244
 245 /* Defined in sysdep.c.  */
 246
 247 extern Lisp_Object list_system_processes (void);
 248 extern Lisp_Object system_process_attributes (Lisp_Object);
 249
 250 /* Defined in process.c.  */
 251
 252 extern void record_deleted_pid (pid_t, Lisp_Object);
 253 struct sockaddr;
 254 extern Lisp_Object conv_sockaddr_to_lisp (struct sockaddr *, ptrdiff_t);
 255 extern void hold_keyboard_input (void);
 256 extern void unhold_keyboard_input (void);
 257 extern bool kbd_on_hold_p (void);
 258
 259 typedef void (*fd_callback) (int fd, void *data);
 260
 261 extern void add_read_fd (int fd, fd_callback func, void *data);
 262 extern void delete_read_fd (int fd);
 263 extern void add_write_fd (int fd, fd_callback func, void *data);
 264 extern void delete_write_fd (int fd);
 265 extern void catch_child_signal (void);
 266
 267 #ifdef WINDOWSNT
 268 extern Lisp_Object network_interface_list (void);
 269 extern Lisp_Object network_interface_info (Lisp_Object);
 270 #endif
 271
 272 extern Lisp_Object remove_slash_colon (Lisp_Object);
 273
 274 INLINE_HEADER_END
 275
 276 #endif /* EMACS_PROCESS_H */