src/process.h

   1 /* Definitions for asynchronous process control in GNU Emacs.
   2    Copyright (C) 1985, 1994, 2001-2013 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 #ifndef PROCESS_INLINE
  31 # define PROCESS_INLINE INLINE
  32 #endif
  33
  34 /* This structure records information about a subprocess
  35    or network connection.  */
  36
  37 struct Lisp_Process
  38   {
  39     struct vectorlike_header header;
  40
  41     /* Name of subprocess terminal.  */
  42     Lisp_Object tty_name;
  43
  44     /* Name of this process */
  45     Lisp_Object name;
  46
  47     /* List of command arguments that this process was run with.
  48        Is set to t for a stopped network process; nil otherwise. */
  49     Lisp_Object command;
  50
  51     /* (funcall FILTER PROC STRING)  (if FILTER is non-nil)
  52        to dispose of a bunch of chars from the process all at once */
  53     Lisp_Object filter;
  54
  55     /* (funcall SENTINEL PROCESS) when process state changes */
  56     Lisp_Object sentinel;
  57
  58     /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
  59        accepts a connection from a client.  */
  60     Lisp_Object log;
  61
  62     /* Buffer that output is going to */
  63     Lisp_Object buffer;
  64
  65     /* t if this is a real child process.  For a network or serial
  66        connection, it is a plist based on the arguments to
  67        make-network-process or make-serial-process.  */
  68
  69     Lisp_Object childp;
  70
  71     /* Plist for programs to keep per-process state information, parameters, etc.  */
  72     Lisp_Object plist;
  73
  74     /* Symbol indicating the type of process: real, network, serial  */
  75     Lisp_Object type;
  76
  77     /* Marker set to end of last buffer-inserted output from this process */
  78     Lisp_Object mark;
  79
  80     /* Symbol indicating status of process.
  81        This may be a symbol: run, open, or closed.
  82        Or it may be a list, whose car is stop, exit or signal
  83        and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
  84        or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
  85     Lisp_Object status;
  86
  87     /* Coding-system for decoding the input from this process.  */
  88     Lisp_Object decode_coding_system;
  89
  90     /* Working buffer for decoding.  */
  91     Lisp_Object decoding_buf;
  92
  93     /* Coding-system for encoding the output to this process.  */
  94     Lisp_Object encode_coding_system;
  95
  96     /* Working buffer for encoding.  */
  97     Lisp_Object encoding_buf;
  98
  99     /* Queue for storing waiting writes */
 100     Lisp_Object write_queue;
 101
 102 #ifdef HAVE_GNUTLS
 103     Lisp_Object gnutls_cred_type;
 104 #endif
 105
 106     /* The thread a process is linked to, or nil for any thread.  */
 107     Lisp_Object thread;
 108
 109     /* After this point, there are no Lisp_Objects any more.  */
 110     /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
 111
 112     /* Number of this process.
 113        allocate_process assumes this is the first non-Lisp_Object field.
 114        A value 0 is used for pseudo-processes such as network or serial
 115        connections.  */
 116     pid_t pid;
 117     /* Descriptor by which we read from this process */
 118     int infd;
 119     /* Descriptor by which we write to this process */
 120     int outfd;
 121     /* Event-count of last event in which this process changed status.  */
 122     EMACS_INT tick;
 123     /* Event-count of last such event reported.  */
 124     EMACS_INT update_tick;
 125     /* Size of carryover in decoding.  */
 126     int decoding_carryover;
 127     /* Hysteresis to try to read process output in larger blocks.
 128        On some systems, e.g. GNU/Linux, Emacs is seen as
 129        an interactive app also when reading process output, meaning
 130        that process output can be read in as little as 1 byte at a
 131        time.  Value is nanoseconds to delay reading output from
 132        this process.  Range is 0 .. 50 * 1000 * 1000.  */
 133     int read_output_delay;
 134     /* Should we delay reading output from this process.
 135        Initialized from `Vprocess_adaptive_read_buffering'.
 136        0 = nil, 1 = t, 2 = other.  */
 137     unsigned int adaptive_read_buffering : 2;
 138     /* Skip reading this process on next read.  */
 139     unsigned int read_output_skip : 1;
 140     /* Non-nil means kill silently if Emacs is exited.
 141        This is the inverse of the `query-on-exit' flag.  */
 142     unsigned int kill_without_query : 1;
 143     /* Non-nil if communicating through a pty.  */
 144     unsigned int pty_flag : 1;
 145     /* Flag to set coding-system of the process buffer from the
 146        coding_system used to decode process output.  */
 147     unsigned int inherit_coding_system_flag : 1;
 148     /* Whether the process is alive, i.e., can be waited for.  Running
 149        processes can be waited for, but exited and fake processes cannot.  */
 150     unsigned int alive : 1;
 151     /* Record the process status in the raw form in which it comes from `wait'.
 152        This is to avoid consing in a signal handler.  The `raw_status_new'
 153        flag indicates that `raw_status' contains a new status that still
 154        needs to be synced to `status'.  */
 155     unsigned int raw_status_new : 1;
 156     int raw_status;
 157
 158 #ifdef HAVE_GNUTLS
 159     gnutls_initstage_t gnutls_initstage;
 160     gnutls_session_t gnutls_state;
 161     gnutls_certificate_client_credentials gnutls_x509_cred;
 162     gnutls_anon_client_credentials_t gnutls_anon_cred;
 163     int gnutls_log_level;
 164     int gnutls_handshakes_tried;
 165     unsigned int gnutls_p : 1;
 166 #endif
 167 };
 168
 169 /* Every field in the preceding structure except for the first two
 170    must be a Lisp_Object, for GC's sake.  */
 171
 172 #define ChannelMask(n) (1 << (n))
 173
 174 /* Most code should use these functions to set Lisp fields in struct
 175    process.  */
 176
 177 PROCESS_INLINE void
 178 pset_childp (struct Lisp_Process *p, Lisp_Object val)
 179 {
 180   p->childp = val;
 181 }
 182
 183 #ifdef HAVE_GNUTLS
 184 PROCESS_INLINE void
 185 pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
 186 {
 187   p->gnutls_cred_type = val;
 188 }
 189 #endif
 190
 191 /* True means don't run process sentinels.  This is used
 192    when exiting.  */
 193 extern bool inhibit_sentinels;
 194
 195 extern Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname;
 196 extern Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime;
 197 extern Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
 198 extern Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtpgid, Qcstime;
 199 extern Lisp_Object Qtime, Qctime;
 200 extern Lisp_Object QCspeed;
 201 extern Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
 202 extern Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
 203
 204 /* Defined in callproc.c.  */
 205
 206 extern void block_child_signal (void);
 207 extern void unblock_child_signal (void);
 208 extern void record_kill_process (struct Lisp_Process *);
 209
 210 /* Defined in process.c.  */
 211
 212 extern Lisp_Object list_system_processes (void);
 213 extern Lisp_Object system_process_attributes (Lisp_Object);
 214
 215 extern void hold_keyboard_input (void);
 216 extern void unhold_keyboard_input (void);
 217 extern bool kbd_on_hold_p (void);
 218
 219 typedef void (*fd_callback) (int fd, void *data);
 220
 221 extern void add_read_fd (int fd, fd_callback func, void *data);
 222 extern void delete_read_fd (int fd);
 223 extern void add_write_fd (int fd, fd_callback func, void *data);
 224 extern void delete_write_fd (int fd);
 225 #ifdef NS_IMPL_GNUSTEP
 226 extern void catch_child_signal (void);
 227 #endif
 228
 229 extern void update_processes_for_thread_death (Lisp_Object);
 230
 231 INLINE_HEADER_END