1 /* 2 * include/types/stream.h 3 * This file defines everything related to streams. 4 * 5 * Copyright (C) 2000-2015 Willy Tarreau - w@1wt.eu 6 * 7 * This library is free software; you can redistribute it and/or 8 * modify it under the terms of the GNU Lesser General Public 9 * License as published by the Free Software Foundation, version 2.1 10 * exclusively. 11 * 12 * This library 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 GNU 15 * Lesser General Public License for more details. 16 * 17 * You should have received a copy of the GNU Lesser General Public 18 * License along with this library; if not, write to the Free Software 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 20 */ 21 22 #ifndef _TYPES_STREAM_H 23 #define _TYPES_STREAM_H 24 25 26 #include <sys/time.h> 27 #include <unistd.h> 28 #include <netinet/in.h> 29 #include <arpa/inet.h> 30 31 #include <common/config.h> 32 #include <common/mini-clist.h> 33 34 #include <types/channel.h> 35 #include <types/filters.h> 36 #include <types/hlua.h> 37 #include <types/obj_type.h> 38 #include <types/proto_http.h> 39 #include <types/proxy.h> 40 #include <types/queue.h> 41 #include <types/server.h> 42 #include <types/session.h> 43 #include <types/stream_interface.h> 44 #include <types/task.h> 45 #include <types/stick_table.h> 46 #include <types/vars.h> 47 48 /* Various Stream Flags, bits values 0x01 to 0x100 (shift 0) */ 49 #define SF_DIRECT 0x00000001 /* connection made on the server matching the client cookie */ 50 #define SF_ASSIGNED 0x00000002 /* no need to assign a server to this stream */ 51 #define SF_ADDR_SET 0x00000004 /* this stream's server address has been set */ 52 #define SF_BE_ASSIGNED 0x00000008 /* a backend was assigned. Conns are accounted. */ 53 54 #define SF_FORCE_PRST 0x00000010 /* force persistence here, even if server is down */ 55 #define SF_MONITOR 0x00000020 /* this stream comes from a monitoring system */ 56 #define SF_CURR_SESS 0x00000040 /* a connection is currently being counted on the server */ 57 #define SF_INITIALIZED 0x00000080 /* the stream was fully initialized */ 58 #define SF_REDISP 0x00000100 /* set if this stream was redispatched from one server to another */ 59 #define SF_CONN_TAR 0x00000200 /* set if this stream is turning around before reconnecting */ 60 #define SF_REDIRECTABLE 0x00000400 /* set if this stream is redirectable (GET or HEAD) */ 61 #define SF_TUNNEL 0x00000800 /* tunnel-mode stream, nothing to catch after data */ 62 63 /* stream termination conditions, bits values 0x1000 to 0x7000 (0-9 shift 12) */ 64 #define SF_ERR_NONE 0x00000000 /* normal end of request */ 65 #define SF_ERR_LOCAL 0x00001000 /* the proxy locally processed this request => not an error */ 66 #define SF_ERR_CLITO 0x00002000 /* client time-out */ 67 #define SF_ERR_CLICL 0x00003000 /* client closed (read/write error) */ 68 #define SF_ERR_SRVTO 0x00004000 /* server time-out, connect time-out */ 69 #define SF_ERR_SRVCL 0x00005000 /* server closed (connect/read/write error) */ 70 #define SF_ERR_PRXCOND 0x00006000 /* the proxy decided to close (deny...) */ 71 #define SF_ERR_RESOURCE 0x00007000 /* the proxy encountered a lack of a local resources (fd, mem, ...) */ 72 #define SF_ERR_INTERNAL 0x00008000 /* the proxy encountered an internal error */ 73 #define SF_ERR_DOWN 0x00009000 /* the proxy killed a stream because the backend became unavailable */ 74 #define SF_ERR_KILLED 0x0000a000 /* the proxy killed a stream because it was asked to do so */ 75 #define SF_ERR_UP 0x0000b000 /* the proxy killed a stream because a preferred backend became available */ 76 #define SF_ERR_CHK_PORT 0x0000c000 /* no port could be found for a health check. TODO: check SF_ERR_SHIFT */ 77 #define SF_ERR_MASK 0x0000f000 /* mask to get only stream error flags */ 78 #define SF_ERR_SHIFT 12 /* bit shift */ 79 80 /* stream state at termination, bits values 0x10000 to 0x70000 (0-7 shift 16) */ 81 #define SF_FINST_R 0x00010000 /* stream ended during client request */ 82 #define SF_FINST_C 0x00020000 /* stream ended during server connect */ 83 #define SF_FINST_H 0x00030000 /* stream ended during server headers */ 84 #define SF_FINST_D 0x00040000 /* stream ended during data phase */ 85 #define SF_FINST_L 0x00050000 /* stream ended while pushing last data to client */ 86 #define SF_FINST_Q 0x00060000 /* stream ended while waiting in queue for a server slot */ 87 #define SF_FINST_T 0x00070000 /* stream ended tarpitted */ 88 #define SF_FINST_MASK 0x00070000 /* mask to get only final stream state flags */ 89 #define SF_FINST_SHIFT 16 /* bit shift */ 90 91 #define SF_IGNORE_PRST 0x00080000 /* ignore persistence */ 92 93 #define SF_SRV_REUSED 0x00100000 /* the server-side connection was reused */ 94 95 /* some external definitions */ 96 struct strm_logs { 97 int logwait; /* log fields waiting to be collected : LW_* */ 98 int level; /* log level to force + 1 if > 0, -1 = no log */ 99 struct timeval accept_date; /* date of the stream's accept() in user date */ 100 struct timeval tv_accept; /* date of the stream's accept() in internal date (monotonic) */ 101 long t_handshake; /* hanshake duration, -1 if never occurs */ 102 long t_idle; /* idle duration, -1 if never occurs */ 103 struct timeval tv_request; /* date the request arrives, {0,0} if never occurs */ 104 long t_queue; /* delay before the stream gets out of the connect queue, -1 if never occurs */ 105 long t_connect; /* delay before the connect() to the server succeeds, -1 if never occurs */ 106 long t_data; /* delay before the first data byte from the server ... */ 107 unsigned long t_close; /* total stream duration */ 108 unsigned long srv_queue_size; /* number of streams waiting for a connect slot on this server at accept() time (in direct assignment) */ 109 unsigned long prx_queue_size; /* overall number of streams waiting for a connect slot on this instance at accept() time */ 110 long long bytes_in; /* number of bytes transferred from the client to the server */ 111 long long bytes_out; /* number of bytes transferred from the server to the client */ 112 }; 113 114 struct stream { 115 int flags; /* some flags describing the stream */ 116 unsigned int uniq_id; /* unique ID used for the traces */ 117 enum obj_type *target; /* target to use for this stream */ 118 119 struct channel req; /* request channel */ 120 struct channel res; /* response channel */ 121 122 struct proxy *be; /* the proxy this stream depends on for the server side */ 123 124 struct session *sess; /* the session this stream is attached to */ 125 126 struct server *srv_conn; /* stream already has a slot on a server and is not in queue */ 127 struct pendconn *pend_pos; /* if not NULL, points to the position in the pending queue */ 128 129 struct http_txn *txn; /* current HTTP transaction being processed. Should become a list. */ 130 131 struct task *task; /* the task associated with this stream */ 132 unsigned short pending_events; /* the pending events not yet processed by the stream. 133 * This is a bit field of TASK_WOKEN_* */ 134 135 struct list list; /* position in global streams list */ 136 struct list by_srv; /* position in server stream list */ 137 struct list back_refs; /* list of users tracking this stream */ 138 struct buffer_wait buffer_wait; /* position in the list of objects waiting for a buffer */ 139 140 struct { 141 struct stksess *ts; 142 struct stktable *table; 143 } store[8]; /* tracked stickiness values to store */ 144 int store_count; 145 /* 4 unused bytes here */ 146 147 struct stkctr stkctr[MAX_SESS_STKCTR]; /* content-aware stick counters */ 148 149 struct strm_flt strm_flt; /* current state of filters active on this stream */ 150 151 char **req_cap; /* array of captures from the request (may be NULL) */ 152 char **res_cap; /* array of captures from the response (may be NULL) */ 153 struct vars vars_txn; /* list of variables for the txn scope. */ 154 struct vars vars_reqres; /* list of variables for the request and resp scope. */ 155 156 struct stream_interface si[2]; /* client and server stream interfaces */ 157 struct strm_logs logs; /* logs for this stream */ 158 159 void (*do_log)(struct stream *s); /* the function to call in order to log (or NULL) */ 160 void (*srv_error)(struct stream *s, /* the function to call upon unrecoverable server errors (or NULL) */ 161 struct stream_interface *si); 162 163 char *unique_id; /* custom unique ID */ 164 165 /* These two pointers are used to resume the execution of the rule lists. */ 166 struct list *current_rule_list; /* this is used to store the current executed rule list. */ 167 void *current_rule; /* this is used to store the current rule to be resumed. */ 168 struct hlua hlua; /* lua runtime context */ 169 }; 170 171 #endif /* _TYPES_STREAM_H */ 172 173 /* 174 * Local variables: 175 * c-indent-level: 8 176 * c-basic-offset: 8 177 * End: 178 */ 179