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, closed, listen, or failed.
  87        Or it may be a pair (connect . ADDRINFOS) where ADDRINFOS is
  88        a list of remaining (PROTOCOL . ADDRINFO) pairs to try.
  89        Or it may be (failed ERR) where ERR is an integer, string or symbol.
  90        Or it may be a list, whose car is stop, exit or signal
  91        and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
  92        or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
  93     Lisp_Object status;
  94
  95     /* Coding-system for decoding the input from this process.  */
  96     Lisp_Object decode_coding_system;
  97
  98     /* Working buffer for decoding.  */
  99     Lisp_Object decoding_buf;
 100
 101     /* Coding-system for encoding the output to this process.  */
 102     Lisp_Object encode_coding_system;
 103
 104     /* Working buffer for encoding.  */
 105     Lisp_Object encoding_buf;
 106
 107     /* Queue for storing waiting writes.  */
 108     Lisp_Object write_queue;
 109
 110 #ifdef HAVE_GNUTLS
 111     Lisp_Object gnutls_cred_type;
 112     Lisp_Object gnutls_boot_parameters;
 113 #endif
 114
 115     /* Pipe process attached to the standard error of this process.  */
 116     Lisp_Object stderrproc;
 117
 118     /* After this point, there are no Lisp_Objects any more.  */
 119     /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
 120
 121     /* Number of this process.
 122        allocate_process assumes this is the first non-Lisp_Object field.
 123        A value 0 is used for pseudo-processes such as network or serial
 124        connections.  */
 125     pid_t pid;
 126     /* Descriptor by which we read from this process.  */
 127     int infd;
 128     /* Descriptor by which we write to this process.  */
 129     int outfd;
 130     /* Descriptors that were created for this process and that need
 131        closing.  Unused entries are negative.  */
 132     int open_fd[PROCESS_OPEN_FDS];
 133     /* Event-count of last event in which this process changed status.  */
 134     EMACS_INT tick;
 135     /* Event-count of last such event reported.  */
 136     EMACS_INT update_tick;
 137     /* Size of carryover in decoding.  */
 138     int decoding_carryover;
 139     /* Hysteresis to try to read process output in larger blocks.
 140        On some systems, e.g. GNU/Linux, Emacs is seen as
 141        an interactive app also when reading process output, meaning
 142        that process output can be read in as little as 1 byte at a
 143        time.  Value is nanoseconds to delay reading output from
 144        this process.  Range is 0 .. 50 * 1000 * 1000.  */
 145     int read_output_delay;
 146     /* Should we delay reading output from this process.
 147        Initialized from `Vprocess_adaptive_read_buffering'.
 148        0 = nil, 1 = t, 2 = other.  */
 149     unsigned int adaptive_read_buffering : 2;
 150     /* Skip reading this process on next read.  */
 151     bool_bf read_output_skip : 1;
 152     /* True means kill silently if Emacs is exited.
 153        This is the inverse of the `query-on-exit' flag.  */
 154     bool_bf kill_without_query : 1;
 155     /* True if communicating through a pty.  */
 156     bool_bf pty_flag : 1;
 157     /* Flag to set coding-system of the process buffer from the
 158        coding_system used to decode process output.  */
 159     bool_bf inherit_coding_system_flag : 1;
 160     /* Whether the process is alive, i.e., can be waited for.  Running
 161        processes can be waited for, but exited and fake processes cannot.  */
 162     bool_bf alive : 1;
 163     /* Record the process status in the raw form in which it comes from `wait'.
 164        This is to avoid consing in a signal handler.  The `raw_status_new'
 165        flag indicates that `raw_status' contains a new status that still
 166        needs to be synced to `status'.  */
 167     bool_bf raw_status_new : 1;
 168     /* Whether this is a nonblocking socket. */
 169     bool_bf is_non_blocking_client : 1;
 170     /* Whether this is a server or a client socket. */
 171     bool_bf is_server : 1;
 172     int raw_status;
 173     /* The length of the socket backlog. */
 174     int backlog;
 175     /* The port number. */
 176     int port;
 177     /* The socket type. */
 178     int socktype;
 179
 180 #ifdef HAVE_GETADDRINFO_A
 181     /* Whether the socket is waiting for response from an asynchronous
 182        DNS call. */
 183     struct gaicb *dns_request;
 184 #endif
 185
 186 #ifdef HAVE_GNUTLS
 187     gnutls_initstage_t gnutls_initstage;
 188     gnutls_session_t gnutls_state;
 189     gnutls_certificate_client_credentials gnutls_x509_cred;
 190     gnutls_anon_client_credentials_t gnutls_anon_cred;
 191     gnutls_x509_crt_t gnutls_certificate;
 192     unsigned int gnutls_peer_verification;
 193     unsigned int gnutls_extra_peer_verification;
 194     int gnutls_log_level;
 195     int gnutls_handshakes_tried;
 196     bool_bf gnutls_p : 1;
 197     bool_bf gnutls_complete_negotiation_p : 1;
 198 #endif
 199 };
 200
 201 /* Every field in the preceding structure except for the first two
 202    must be a Lisp_Object, for GC's sake.  */
 203
 204 #define ChannelMask(n) (1 << (n))
 205
 206 /* Most code should use these functions to set Lisp fields in struct
 207    process.  */
 208
 209 INLINE void
 210 pset_childp (struct Lisp_Process *p, Lisp_Object val)
 211 {
 212   p->childp = val;
 213 }
 214
 215 INLINE void
 216 pset_status (struct Lisp_Process *p, Lisp_Object val)
 217 {
 218   p->status = val;
 219 }
 220
 221 #ifdef HAVE_GNUTLS
 222 INLINE void
 223 pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
 224 {
 225   p->gnutls_cred_type = val;
 226 }
 227 #endif
 228
 229 /* True means don't run process sentinels.  This is used
 230    when exiting.  */
 231 extern bool inhibit_sentinels;
 232
 233 /* Exit statuses for GNU programs that exec other programs.  */
 234 enum
 235 {
 236   EXIT_CANCELED = 125, /* Internal error prior to exec attempt.  */
 237   EXIT_CANNOT_INVOKE = 126, /* Program located, but not usable.  */
 238   EXIT_ENOENT = 127 /* Could not find program to exec.  */
 239 };
 240
 241 /* Defined in callproc.c.  */
 242
 243 extern Lisp_Object encode_current_directory (void);
 244 extern void record_kill_process (struct Lisp_Process *, Lisp_Object);
 245
 246 /* Defined in sysdep.c.  */
 247
 248 extern Lisp_Object list_system_processes (void);
 249 extern Lisp_Object system_process_attributes (Lisp_Object);
 250
 251 /* Defined in process.c.  */
 252
 253 extern void record_deleted_pid (pid_t, Lisp_Object);
 254 struct sockaddr;
 255 extern Lisp_Object conv_sockaddr_to_lisp (struct sockaddr *, ptrdiff_t);
 256 extern void hold_keyboard_input (void);
 257 extern void unhold_keyboard_input (void);
 258 extern bool kbd_on_hold_p (void);
 259
 260 typedef void (*fd_callback) (int fd, void *data);
 261
 262 extern void add_read_fd (int fd, fd_callback func, void *data);
 263 extern void delete_read_fd (int fd);
 264 extern void add_write_fd (int fd, fd_callback func, void *data);
 265 extern void delete_write_fd (int fd);
 266 extern void catch_child_signal (void);
 267
 268 #ifdef WINDOWSNT
 269 extern Lisp_Object network_interface_list (void);
 270 extern Lisp_Object network_interface_info (Lisp_Object);
 271 #endif
 272
 273 extern Lisp_Object remove_slash_colon (Lisp_Object);
 274
 275 INLINE_HEADER_END
 276
 277 #endif /* EMACS_PROCESS_H */