src/process.h

   1 /* Definitions for asynchronous process control in GNU Emacs.
   2    Copyright (C) 1985, 1994, 2001, 2002, 2003, 2004,
   3                  2005, 2006, 2007, 2008, 2009, 2010, 2011  Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifdef HAVE_SYS_TYPES_H
  21 #include <sys/types.h>
  22 #endif
  23
  24 #include <unistd.h>
  25
  26 #ifdef HAVE_GNUTLS
  27 #include "gnutls.h"
  28 #endif
  29
  30 /* This structure records information about a subprocess
  31    or network connection.
  32
  33    Every field in this structure except for the first two
  34    must be a Lisp_Object, for GC's sake.  */
  35
  36 struct Lisp_Process
  37   {
  38     EMACS_UINT size;
  39     struct Lisp_Vector *v_next;
  40     /* Name of subprocess terminal.  */
  41     Lisp_Object tty_name;
  42     /* Name of this process */
  43     Lisp_Object name;
  44     /* List of command arguments that this process was run with.
  45        Is set to t for a stopped network process; nil otherwise. */
  46     Lisp_Object command;
  47     /* (funcall FILTER PROC STRING)  (if FILTER is non-nil)
  48        to dispose of a bunch of chars from the process all at once */
  49     Lisp_Object filter;
  50     /* (funcall SENTINEL PROCESS) when process state changes */
  51     Lisp_Object sentinel;
  52     /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
  53        accepts a connection from a client.  */
  54     Lisp_Object log;
  55     /* Buffer that output is going to */
  56     Lisp_Object buffer;
  57     /* t if this is a real child process.  For a network or serial
  58        connection, it is a plist based on the arguments to
  59        make-network-process or make-serial-process.  */
  60     Lisp_Object childp;
  61     /* Plist for programs to keep per-process state information, parameters, etc.  */
  62     Lisp_Object plist;
  63     /* Symbol indicating the type of process: real, network, serial  */
  64     Lisp_Object type;
  65     /* Marker set to end of last buffer-inserted output from this process */
  66     Lisp_Object mark;
  67     /* Symbol indicating status of process.
  68        This may be a symbol: run, open, or closed.
  69        Or it may be a list, whose car is stop, exit or signal
  70        and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
  71        or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
  72     Lisp_Object status;
  73     /* Coding-system for decoding the input from this process.  */
  74     Lisp_Object decode_coding_system;
  75     /* Working buffer for decoding.  */
  76     Lisp_Object decoding_buf;
  77     /* Coding-system for encoding the output to this process.  */
  78     Lisp_Object encode_coding_system;
  79     /* Working buffer for encoding.  */
  80     Lisp_Object encoding_buf;
  81
  82 #ifdef HAVE_GNUTLS
  83     Lisp_Object gnutls_cred_type;
  84 #endif
  85
  86     /* After this point, there are no Lisp_Objects any more.  */
  87     /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
  88
  89     /* Number of this process.
  90        allocate_process assumes this is the first non-Lisp_Object field.
  91        A value 0 is used for pseudo-processes such as network or serial
  92        connections.  */
  93     pid_t pid;
  94     /* Descriptor by which we read from this process */
  95     int infd;
  96     /* Descriptor by which we write to this process */
  97     int outfd;
  98     /* Event-count of last event in which this process changed status.  */
  99     int tick;
 100     /* Event-count of last such event reported.  */
 101     int update_tick;
 102     /* Size of carryover in decoding.  */
 103     int decoding_carryover;
 104     /* Hysteresis to try to read process output in larger blocks.
 105        On some systems, e.g. GNU/Linux, Emacs is seen as
 106        an interactive app also when reading process output, meaning
 107        that process output can be read in as little as 1 byte at a
 108        time.  Value is micro-seconds to delay reading output from
 109        this process.  Range is 0 .. 50000.  */
 110     int read_output_delay;
 111     /* Should we delay reading output from this process.
 112        Initialized from `Vprocess_adaptive_read_buffering'.
 113        0 = nil, 1 = t, 2 = other.  */
 114     unsigned int adaptive_read_buffering : 2;
 115     /* Skip reading this process on next read.  */
 116     unsigned int read_output_skip : 1;
 117     /* Non-nil means kill silently if Emacs is exited.
 118        This is the inverse of the `query-on-exit' flag.  */
 119     unsigned int kill_without_query : 1;
 120     /* Non-nil if communicating through a pty.  */
 121     unsigned int pty_flag : 1;
 122     /* Flag to set coding-system of the process buffer from the
 123        coding_system used to decode process output.  */
 124     unsigned int inherit_coding_system_flag : 1;
 125     /* Record the process status in the raw form in which it comes from `wait'.
 126        This is to avoid consing in a signal handler.  The `raw_status_new'
 127        flag indicates that `raw_status' contains a new status that still
 128        needs to be synced to `status'.  */
 129     unsigned int raw_status_new : 1;
 130     int raw_status;
 131
 132 #ifdef HAVE_GNUTLS
 133     gnutls_initstage_t gnutls_initstage;
 134     gnutls_session_t gnutls_state;
 135     gnutls_certificate_client_credentials gnutls_x509_cred;
 136     gnutls_anon_client_credentials_t gnutls_anon_cred;
 137     int gnutls_log_level;
 138     int gnutls_p;
 139 #endif
 140 };
 141
 142 /* Every field in the preceding structure except for the first two
 143    must be a Lisp_Object, for GC's sake.  */
 144
 145 #define ChannelMask(n) (1<<(n))
 146
 147 /* Indexed by descriptor, gives the process (if any) for that descriptor.  */
 148 extern Lisp_Object chan_process[];
 149
 150 /* Alist of elements (NAME . PROCESS).  */
 151 extern Lisp_Object Vprocess_alist;
 152
 153 /* True if we are about to fork off a synchronous process or if we
 154    are waiting for it.  */
 155 extern int synch_process_alive;
 156
 157 /* Communicate exit status of sync process to from sigchld_handler
 158    to Fcall_process.  */
 159
 160 /* Nonzero => this is a string explaining death of synchronous subprocess.  */
 161 extern const char *synch_process_death;
 162
 163 /* Nonzero => this is the signal number that terminated the subprocess.  */
 164 extern int synch_process_termsig;
 165
 166 /* If synch_process_death is zero,
 167    this is exit code of synchronous subprocess.  */
 168 extern int synch_process_retcode;
 169
 170 /* The name of the file open to get a null file, or a data sink.
 171    MS-DOS, and OS/2 redefine this.  */
 172 #ifndef NULL_DEVICE
 173 #define NULL_DEVICE "/dev/null"
 174 #endif
 175
 176 /* Nonzero means don't run process sentinels.  This is used
 177    when exiting.  */
 178 extern int inhibit_sentinels;
 179
 180 extern Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname;
 181 extern Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime;
 182 extern Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
 183 extern Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtpgid, Qcstime;
 184 extern Lisp_Object Qtime, Qctime;
 185 extern Lisp_Object QCport, QCspeed, QCprocess;
 186 extern Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
 187 extern Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
 188
 189 extern Lisp_Object list_system_processes (void);
 190 extern Lisp_Object system_process_attributes (Lisp_Object);
 191
 192 extern void hold_keyboard_input (void);
 193 extern void unhold_keyboard_input (void);
 194 extern int kbd_on_hold_p (void);
 195
 196 typedef void (*fd_callback)(int fd, void *data, int for_read);
 197
 198 extern void add_read_fd (int fd, fd_callback func, void *data);
 199 extern void delete_read_fd (int fd);
 200 extern void add_write_fd (int fd, fd_callback func, void *data);
 201 extern void delete_write_fd (int fd);
 202
 203 /* arch-tag: dffedfc4-d7bc-4b58-a26f-c16155449c72
 204    (do not change this comment) */