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