src/process.h

   1 /* Definitions for asynchronous process control in GNU Emacs.
   2    Copyright (C) 1985, 1994, 2001-2012  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 /* Most code should use these macros to set
  30    Lisp fields in struct Lisp_Process.  */
  31
  32 #define PSET(p, field, value) ((p)->field = (value))
  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     /* After this point, there are no Lisp_Objects any more.  */
 107     /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
 108
 109     /* Number of this process.
 110        allocate_process assumes this is the first non-Lisp_Object field.
 111        A value 0 is used for pseudo-processes such as network or serial
 112        connections.  */
 113     pid_t pid;
 114     /* Descriptor by which we read from this process */
 115     int infd;
 116     /* Descriptor by which we write to this process */
 117     int outfd;
 118     /* Event-count of last event in which this process changed status.  */
 119     EMACS_INT tick;
 120     /* Event-count of last such event reported.  */
 121     EMACS_INT update_tick;
 122     /* Size of carryover in decoding.  */
 123     int decoding_carryover;
 124     /* Hysteresis to try to read process output in larger blocks.
 125        On some systems, e.g. GNU/Linux, Emacs is seen as
 126        an interactive app also when reading process output, meaning
 127        that process output can be read in as little as 1 byte at a
 128        time.  Value is nanoseconds to delay reading output from
 129        this process.  Range is 0 .. 50 * 1000 * 1000.  */
 130     int read_output_delay;
 131     /* Should we delay reading output from this process.
 132        Initialized from `Vprocess_adaptive_read_buffering'.
 133        0 = nil, 1 = t, 2 = other.  */
 134     unsigned int adaptive_read_buffering : 2;
 135     /* Skip reading this process on next read.  */
 136     unsigned int read_output_skip : 1;
 137     /* Non-nil means kill silently if Emacs is exited.
 138        This is the inverse of the `query-on-exit' flag.  */
 139     unsigned int kill_without_query : 1;
 140     /* Non-nil if communicating through a pty.  */
 141     unsigned int pty_flag : 1;
 142     /* Flag to set coding-system of the process buffer from the
 143        coding_system used to decode process output.  */
 144     unsigned int inherit_coding_system_flag : 1;
 145     /* Record the process status in the raw form in which it comes from `wait'.
 146        This is to avoid consing in a signal handler.  The `raw_status_new'
 147        flag indicates that `raw_status' contains a new status that still
 148        needs to be synced to `status'.  */
 149     unsigned int raw_status_new : 1;
 150     int raw_status;
 151
 152 #ifdef HAVE_GNUTLS
 153     gnutls_initstage_t gnutls_initstage;
 154     gnutls_session_t gnutls_state;
 155     gnutls_certificate_client_credentials gnutls_x509_cred;
 156     gnutls_anon_client_credentials_t gnutls_anon_cred;
 157     int gnutls_log_level;
 158     int gnutls_handshakes_tried;
 159     int gnutls_p;
 160 #endif
 161 };
 162
 163 /* Every field in the preceding structure except for the first two
 164    must be a Lisp_Object, for GC's sake.  */
 165
 166 #define ChannelMask(n) (1 << (n))
 167
 168 /* True if we are about to fork off a synchronous process or if we
 169    are waiting for it.  */
 170 extern int synch_process_alive;
 171
 172 /* Communicate exit status of sync process to from sigchld_handler
 173    to Fcall_process.  */
 174
 175 /* Nonzero => this is a string explaining death of synchronous subprocess.  */
 176 extern const char *synch_process_death;
 177
 178 /* Nonzero => this is the signal number that terminated the subprocess.  */
 179 extern int synch_process_termsig;
 180
 181 /* If synch_process_death is zero,
 182    this is exit code of synchronous subprocess.  */
 183 extern int synch_process_retcode;
 184
 185 /* Nonzero means don't run process sentinels.  This is used
 186    when exiting.  */
 187 extern int inhibit_sentinels;
 188
 189 extern Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname;
 190 extern Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime;
 191 extern Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
 192 extern Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtpgid, Qcstime;
 193 extern Lisp_Object Qtime, Qctime;
 194 extern Lisp_Object QCspeed;
 195 extern Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
 196 extern Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
 197
 198 extern Lisp_Object list_system_processes (void);
 199 extern Lisp_Object system_process_attributes (Lisp_Object);
 200
 201 extern void hold_keyboard_input (void);
 202 extern void unhold_keyboard_input (void);
 203 extern int kbd_on_hold_p (void);
 204
 205 typedef void (*fd_callback)(int fd, void *data, int for_read);
 206
 207 extern void add_read_fd (int fd, fd_callback func, void *data);
 208 extern void delete_read_fd (int fd);
 209 extern void add_write_fd (int fd, fd_callback func, void *data);
 210 extern void delete_write_fd (int fd);