process.h 7.19 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Definitions for asynchronous process control in GNU Emacs.
2
   Copyright (C) 1985, 1994, 2001-2012  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5

This file is part of GNU Emacs.

6
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
7
it under the terms of the GNU General Public License as published by
8 9
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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/>.  */
Jim Blandy's avatar
Jim Blandy committed
18

Stefan Monnier's avatar
Stefan Monnier committed
19 20 21
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
Paul Eggert's avatar
Paul Eggert committed
22

Stefan Monnier's avatar
Stefan Monnier committed
23
#include <unistd.h>
Jim Blandy's avatar
Jim Blandy committed
24

Ted Zlatanov's avatar
Ted Zlatanov committed
25 26 27 28
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif

Paul Eggert's avatar
Paul Eggert committed
29 30 31 32
INLINE_HEADER_BEGIN
#ifndef PROCESS_INLINE
# define PROCESS_INLINE INLINE
#endif
33

34 35
/* This structure records information about a subprocess
   or network connection.  */
Jim Blandy's avatar
Jim Blandy committed
36 37 38

struct Lisp_Process
  {
39
    struct vectorlike_header header;
40

41
    /* Name of subprocess terminal.  */
42
    Lisp_Object tty_name;
43

Jim Blandy's avatar
Jim Blandy committed
44
    /* Name of this process */
45
    Lisp_Object name;
46

47 48
    /* List of command arguments that this process was run with.
       Is set to t for a stopped network process; nil otherwise. */
49
    Lisp_Object command;
50

Jim Blandy's avatar
Jim Blandy committed
51 52
    /* (funcall FILTER PROC STRING)  (if FILTER is non-nil)
       to dispose of a bunch of chars from the process all at once */
53
    Lisp_Object filter;
54

Jim Blandy's avatar
Jim Blandy committed
55
    /* (funcall SENTINEL PROCESS) when process state changes */
56
    Lisp_Object sentinel;
57

58 59
    /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
       accepts a connection from a client.  */
60
    Lisp_Object log;
61

Jim Blandy's avatar
Jim Blandy committed
62
    /* Buffer that output is going to */
63
    Lisp_Object buffer;
64

65 66 67
    /* t if this is a real child process.  For a network or serial
       connection, it is a plist based on the arguments to
       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

Jim Blandy's avatar
Jim Blandy committed
77
    /* Marker set to end of last buffer-inserted output from this process */
78
    Lisp_Object mark;
79

Jim Blandy's avatar
Jim Blandy committed
80 81 82 83 84
    /* Symbol indicating status of process.
       This may be a symbol: run, open, or closed.
       Or it may be a list, whose car is stop, exit or signal
       and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
       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

Ted Zlatanov's avatar
Ted Zlatanov committed
102
#ifdef HAVE_GNUTLS
103
    Lisp_Object gnutls_cred_type;
Ted Zlatanov's avatar
Ted Zlatanov committed
104 105
#endif

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 110

    /* Number of this process.
       allocate_process assumes this is the first non-Lisp_Object field.
111 112
       A value 0 is used for pseudo-processes such as network or serial
       connections.  */
113
    pid_t pid;
114 115 116 117 118
    /* Descriptor by which we read from this process */
    int infd;
    /* Descriptor by which we write to this process */
    int outfd;
    /* 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 123 124 125 126 127
    /* Size of carryover in decoding.  */
    int decoding_carryover;
    /* Hysteresis to try to read process output in larger blocks.
       On some systems, e.g. GNU/Linux, Emacs is seen as
       an interactive app also when reading process output, meaning
       that process output can be read in as little as 1 byte at a
128 129
       time.  Value is nanoseconds to delay reading output from
       this process.  Range is 0 .. 50 * 1000 * 1000.  */
130 131 132 133
    int read_output_delay;
    /* Should we delay reading output from this process.
       Initialized from `Vprocess_adaptive_read_buffering'.
       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 138
    /* Non-nil means kill silently if Emacs is exited.
       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 143
    /* Flag to set coding-system of the process buffer from the
       coding_system used to decode process output.  */
144
    unsigned int inherit_coding_system_flag : 1;
145 146 147
    /* Whether the process is alive, i.e., can be waited for.  Running
       processes can be waited for, but exited and fake processes cannot.  */
    unsigned int alive : 1;
148 149 150 151
    /* Record the process status in the raw form in which it comes from `wait'.
       This is to avoid consing in a signal handler.  The `raw_status_new'
       flag indicates that `raw_status' contains a new status that still
       needs to be synced to `status'.  */
152
    unsigned int raw_status_new : 1;
153
    int raw_status;
Ted Zlatanov's avatar
Ted Zlatanov committed
154 155 156 157

#ifdef HAVE_GNUTLS
    gnutls_initstage_t gnutls_initstage;
    gnutls_session_t gnutls_state;
158 159 160
    gnutls_certificate_client_credentials gnutls_x509_cred;
    gnutls_anon_client_credentials_t gnutls_anon_cred;
    int gnutls_log_level;
161
    int gnutls_handshakes_tried;
162
    int gnutls_p;
Ted Zlatanov's avatar
Ted Zlatanov committed
163
#endif
Jim Blandy's avatar
Jim Blandy committed
164 165
};

166 167 168
/* Every field in the preceding structure except for the first two
   must be a Lisp_Object, for GC's sake.  */

169
#define ChannelMask(n) (1 << (n))
Jim Blandy's avatar
Jim Blandy committed
170

Paul Eggert's avatar
Paul Eggert committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
/* Most code should use these functions to set Lisp fields in struct
   process.  */

PROCESS_INLINE void
pset_childp (struct Lisp_Process *p, Lisp_Object val)
{
  p->childp = val;
}

#ifdef HAVE_GNUTLS
PROCESS_INLINE void
pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
{
  p->gnutls_cred_type = val;
}
#endif

188 189 190 191
/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
extern int inhibit_sentinels;

192 193 194 195
extern Lisp_Object Qeuid, Qegid, Qcomm, Qstate, Qppid, Qpgrp, Qsess, Qttname;
extern Lisp_Object Qminflt, Qmajflt, Qcminflt, Qcmajflt, Qutime, Qstime;
extern Lisp_Object Qcutime, Qpri, Qnice, Qthcount, Qstart, Qvsize, Qrss, Qargs;
extern Lisp_Object Quser, Qgroup, Qetime, Qpcpu, Qpmem, Qtpgid, Qcstime;
Eli Zaretskii's avatar
Eli Zaretskii committed
196
extern Lisp_Object Qtime, Qctime;
197
extern Lisp_Object QCspeed;
198 199
extern Lisp_Object QCbytesize, QCstopbits, QCparity, Qodd, Qeven;
extern Lisp_Object QCflowcontrol, Qhw, Qsw, QCsummary;
200

201 202 203
extern Lisp_Object list_system_processes (void);
extern Lisp_Object system_process_attributes (Lisp_Object);

204 205 206 207
extern void hold_keyboard_input (void);
extern void unhold_keyboard_input (void);
extern int kbd_on_hold_p (void);

208
typedef void (*fd_callback) (int fd, void *data);
209 210 211 212 213

extern void add_read_fd (int fd, fd_callback func, void *data);
extern void delete_read_fd (int fd);
extern void add_write_fd (int fd, fd_callback func, void *data);
extern void delete_write_fd (int fd);
Paul Eggert's avatar
Paul Eggert committed
214 215

INLINE_HEADER_END