src/process.h

   1 /* Definitions for asynchronous process control in GNU Emacs.
   2    Copyright (C) 1985, 1994, 2001-2015 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
   9 (at 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 #ifdef HAVE_SYS_TYPES_H
  20 #include <sys/types.h>
  21 #endif
  22
  23 #include <unistd.h>
  24
  25 #ifdef HAVE_GNUTLS
  26 #include "gnutls.h"
  27 #endif
  28
  29 INLINE_HEADER_BEGIN
  30
  31 /* Bound on number of file descriptors opened on behalf of a process,
  32    that need to be closed.  */
  33
  34 enum { PROCESS_OPEN_FDS = 6 };
  35
  36 /* This structure records information about a subprocess
  37    or network connection.  */
  38
  39 struct Lisp_Process
  40   {
  41     struct vectorlike_header header;
  42
  43     /* Name of subprocess terminal.  */
  44     Lisp_Object tty_name;
  45
  46     /* Name of this process */
  47     Lisp_Object name;
  48
  49     /* List of command arguments that this process was run with.
  50        Is set to t for a stopped network process; nil otherwise. */
  51     Lisp_Object command;
  52
  53     /* (funcall FILTER PROC STRING)  (if FILTER is non-nil)
  54        to dispose of a bunch of chars from the process all at once */
  55     Lisp_Object filter;
  56
  57     /* (funcall SENTINEL PROCESS) when process state changes */
  58     Lisp_Object sentinel;
  59
  60     /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
  61        accepts a connection from a client.  */
  62     Lisp_Object log;
  63
  64     /* Buffer that output is going to */
  65     Lisp_Object buffer;
  66
  67     /* t if this is a real child process.  For a network or serial
  68        connection, it is a plist based on the arguments to
  69        make-network-process or make-serial-process.  */
  70
  71     Lisp_Object childp;
  72
  73     /* Plist for programs to keep per-process state information, parameters, etc.  */
  74     Lisp_Object plist;
  75
  76     /* Symbol indicating the type of process: real, network, serial  */
  77     Lisp_Object type;
  78
  79     /* Marker set to end of last buffer-inserted output from this process */
  80     Lisp_Object mark;
  81
  82     /* Symbol indicating status of process.
  83        This may be a symbol: run, open, or closed.
  84        Or it may be a list, whose car is stop, exit or signal
  85        and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
  86        or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
  87     Lisp_Object status;
  88
  89     /* Coding-system for decoding the input from this process.  */
  90     Lisp_Object decode_coding_system;
  91
  92     /* Working buffer for decoding.  */
  93     Lisp_Object decoding_buf;
  94
  95     /* Coding-system for encoding the output to this process.  */
  96     Lisp_Object encode_coding_system;
  97
  98     /* Working buffer for encoding.  */
  99     Lisp_Object encoding_buf;
 100
 101     /* Queue for storing waiting writes */
 102     Lisp_Object write_queue;
 103
 104 #ifdef HAVE_GNUTLS
 105     Lisp_Object gnutls_cred_type;
 106 #endif
 107
 108     /* Pipe process attached to the standard error of this process.  */
 109     Lisp_Object stderrproc;
 110
 111     /* After this point, there are no Lisp_Objects any more.  */
 112     /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
 113
 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
 117        connections.  */
 118     pid_t pid;
 119     /* Descriptor by which we read from this process */
 120     int infd;
 121     /* Descriptor by which we write to this process */
 122     int outfd;
 123     /* Descriptors that were created for this process and that need
 124        closing.  Unused entries are negative.  */
 125     int open_fd[PROCESS_OPEN_FDS];
 126     /* Event-count of last event in which this process changed status.  */
 127     EMACS_INT tick;
 128     /* Event-count of last such event reported.  */
 129     EMACS_INT update_tick;
 130     /* Size of carryover in decoding.  */
 131     int decoding_carryover;
 132     /* Hysteresis to try to read process output in larger blocks.
 133        On some systems, e.g. GNU/Linux, Emacs is seen as
 134        an interactive app also when reading process output, meaning
 135        that process output can be read in as little as 1 byte at a
 136        time.  Value is nanoseconds to delay reading output from
 137        this process.  Range is 0 .. 50 * 1000 * 1000.  */
 138     int read_output_delay;
 139     /* Should we delay reading output from this process.
 140        Initialized from `Vprocess_adaptive_read_buffering'.
 141        0 = nil, 1 = t, 2 = other.  */
 142     unsigned int adaptive_read_buffering : 2;
 143     /* Skip reading this process on next read.  */
 144     bool_bf read_output_skip : 1;
 145     /* True means kill silently if Emacs is exited.
 146        This is the inverse of the `query-on-exit' flag.  */
 147     bool_bf kill_without_query : 1;
 148     /* True if communicating through a pty.  */
 149     bool_bf pty_flag : 1;
 150     /* Flag to set coding-system of the process buffer from the
 151        coding_system used to decode process output.  */
 152     bool_bf inherit_coding_system_flag : 1;
 153     /* Whether the process is alive, i.e., can be waited for.  Running
 154        processes can be waited for, but exited and fake processes cannot.  */
 155     bool_bf alive : 1;
 156     /* Record the process status in the raw form in which it comes from `wait'.
 157        This is to avoid consing in a signal handler.  The `raw_status_new'
 158        flag indicates that `raw_status' contains a new status that still
 159        needs to be synced to `status'.  */
 160     bool_bf raw_status_new : 1;
 161     int raw_status;
 162
 163 #ifdef HAVE_GNUTLS
 164     gnutls_initstage_t gnutls_initstage;
 165     gnutls_session_t gnutls_state;
 166     gnutls_certificate_client_credentials gnutls_x509_cred;
 167     gnutls_anon_client_credentials_t gnutls_anon_cred;
 168     gnutls_x509_crt_t gnutls_certificate;
 169     unsigned int gnutls_peer_verification;
 170     unsigned int gnutls_extra_peer_verification;
 171     int gnutls_log_level;
 172     int gnutls_handshakes_tried;
 173     bool_bf gnutls_p : 1;
 174 #endif
 175 };
 176
 177 /* Every field in the preceding structure except for the first two
 178    must be a Lisp_Object, for GC's sake.  */
 179
 180 #define ChannelMask(n) (1 << (n))
 181
 182 /* Most code should use these functions to set Lisp fields in struct
 183    process.  */
 184
 185 INLINE void
 186 pset_childp (struct Lisp_Process *p, Lisp_Object val)
 187 {
 188   p->childp = val;
 189 }
 190
 191 #ifdef HAVE_GNUTLS
 192 INLINE void
 193 pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
 194 {
 195   p->gnutls_cred_type = val;
 196 }
 197 #endif
 198
 199 /* True means don't run process sentinels.  This is used
 200    when exiting.  */
 201 extern bool inhibit_sentinels;
 202
 203 /* Exit statuses for GNU programs that exec other programs.  */
 204 enum
 205 {
 206   EXIT_CANCELED = 125, /* Internal error prior to exec attempt.  */
 207   EXIT_CANNOT_INVOKE = 126, /* Program located, but not usable.  */
 208   EXIT_ENOENT = 127 /* Could not find program to exec.  */
 209 };
 210
 211 /* Defined in callproc.c.  */
 212
 213 extern Lisp_Object encode_current_directory (void);
 214 extern void record_kill_process (struct Lisp_Process *, Lisp_Object);
 215
 216 /* Defined in sysdep.c.  */
 217
 218 extern Lisp_Object list_system_processes (void);
 219 extern Lisp_Object system_process_attributes (Lisp_Object);
 220
 221 /* Defined in process.c.  */
 222
 223 extern void record_deleted_pid (pid_t, Lisp_Object);
 224 struct sockaddr;
 225 extern Lisp_Object conv_sockaddr_to_lisp (struct sockaddr *, int);
 226 extern void hold_keyboard_input (void);
 227 extern void unhold_keyboard_input (void);
 228 extern bool kbd_on_hold_p (void);
 229
 230 typedef void (*fd_callback) (int fd, void *data);
 231
 232 extern void add_read_fd (int fd, fd_callback func, void *data);
 233 extern void delete_read_fd (int fd);
 234 extern void add_write_fd (int fd, fd_callback func, void *data);
 235 extern void delete_write_fd (int fd);
 236 extern void catch_child_signal (void);
 237
 238 #ifdef WINDOWSNT
 239 extern Lisp_Object network_interface_list (void);
 240 extern Lisp_Object network_interface_info (Lisp_Object);
 241 #endif
 242
 243 extern Lisp_Object remove_slash_colon (Lisp_Object);
 244
 245 INLINE_HEADER_END