Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 1 | /* |
Willy Tarreau | 5b15447 | 2009-12-21 20:11:07 +0100 | [diff] [blame] | 2 | * include/types/session.h |
| 3 | * This file defines everything related to sessions. |
| 4 | * |
Willy Tarreau | 4de9149 | 2010-01-22 19:10:05 +0100 | [diff] [blame] | 5 | * Copyright (C) 2000-2010 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 5b15447 | 2009-12-21 20:11:07 +0100 | [diff] [blame] | 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 | */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 21 | |
| 22 | #ifndef _TYPES_SESSION_H |
| 23 | #define _TYPES_SESSION_H |
| 24 | |
| 25 | |
| 26 | #include <sys/time.h> |
| 27 | #include <unistd.h> |
| 28 | #include <netinet/in.h> |
| 29 | #include <arpa/inet.h> |
| 30 | |
Willy Tarreau | e3ba5f0 | 2006-06-29 18:54:54 +0200 | [diff] [blame] | 31 | #include <common/config.h> |
Willy Tarreau | 2dd0d47 | 2006-06-29 17:53:05 +0200 | [diff] [blame] | 32 | #include <common/mini-clist.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 33 | |
Willy Tarreau | c7e4238 | 2012-08-24 19:22:53 +0200 | [diff] [blame] | 34 | #include <types/channel.h> |
William Lallemand | 82fe75c | 2012-10-23 10:25:10 +0200 | [diff] [blame] | 35 | #include <types/compression.h> |
William Lallemand | 08289f1 | 2012-10-31 11:19:18 +0100 | [diff] [blame] | 36 | |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 37 | #include <types/obj_type.h> |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 38 | #include <types/proto_http.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 39 | #include <types/proxy.h> |
| 40 | #include <types/queue.h> |
| 41 | #include <types/server.h> |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 42 | #include <types/stream_interface.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 43 | #include <types/task.h> |
Emeric Brun | b982a3d | 2010-01-04 15:45:53 +0100 | [diff] [blame] | 44 | #include <types/stick_table.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 45 | |
| 46 | |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 47 | /* various session flags, bits values 0x01 to 0x100 (shift 0) */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 48 | #define SN_DIRECT 0x00000001 /* connection made on the server matching the client cookie */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 49 | #define SN_ASSIGNED 0x00000002 /* no need to assign a server to this session */ |
| 50 | #define SN_ADDR_SET 0x00000004 /* this session's server address has been set */ |
| 51 | #define SN_BE_ASSIGNED 0x00000008 /* a backend was assigned. Conns are accounted. */ |
Willy Tarreau | 5b15447 | 2009-12-21 20:11:07 +0100 | [diff] [blame] | 52 | |
Willy Tarreau | 4de9149 | 2010-01-22 19:10:05 +0100 | [diff] [blame] | 53 | #define SN_FORCE_PRST 0x00000010 /* force persistence here, even if server is down */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 54 | #define SN_MONITOR 0x00000020 /* this session comes from a monitoring system */ |
Willy Tarreau | 1e62de6 | 2008-11-11 20:20:02 +0100 | [diff] [blame] | 55 | #define SN_CURR_SESS 0x00000040 /* a connection is currently being counted on the server */ |
Willy Tarreau | 2542b53 | 2012-08-31 16:01:23 +0200 | [diff] [blame] | 56 | #define SN_INITIALIZED 0x00000080 /* the session was fully initialized */ |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 57 | #define SN_REDISP 0x00000100 /* set if this session was redispatched from one server to another */ |
Willy Tarreau | 541b5c2 | 2008-01-06 23:34:21 +0100 | [diff] [blame] | 58 | #define SN_CONN_TAR 0x00000200 /* set if this session is turning around before reconnecting */ |
Willy Tarreau | 21d2af3 | 2008-02-14 20:25:24 +0100 | [diff] [blame] | 59 | #define SN_REDIRECTABLE 0x00000400 /* set if this session is redirectable (GET or HEAD) */ |
Willy Tarreau | d0f06fc | 2009-11-30 12:19:56 +0100 | [diff] [blame] | 60 | #define SN_TUNNEL 0x00000800 /* tunnel-mode session, nothing to catch after data */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 61 | |
Willy Tarreau | a2a64e9 | 2011-09-07 23:01:56 +0200 | [diff] [blame] | 62 | /* session termination conditions, bits values 0x1000 to 0x7000 (0-9 shift 12) */ |
Willy Tarreau | 570f221 | 2013-06-10 16:42:09 +0200 | [diff] [blame] | 63 | #define SN_ERR_NONE 0x00000000 /* normal end of request */ |
| 64 | #define SN_ERR_LOCAL 0x00001000 /* the proxy locally processed this request => not an error */ |
| 65 | #define SN_ERR_CLITO 0x00002000 /* client time-out */ |
| 66 | #define SN_ERR_CLICL 0x00003000 /* client closed (read/write error) */ |
| 67 | #define SN_ERR_SRVTO 0x00004000 /* server time-out, connect time-out */ |
| 68 | #define SN_ERR_SRVCL 0x00005000 /* server closed (connect/read/write error) */ |
| 69 | #define SN_ERR_PRXCOND 0x00006000 /* the proxy decided to close (deny...) */ |
| 70 | #define SN_ERR_RESOURCE 0x00007000 /* the proxy encountered a lack of a local resources (fd, mem, ...) */ |
| 71 | #define SN_ERR_INTERNAL 0x00008000 /* the proxy encountered an internal error */ |
| 72 | #define SN_ERR_DOWN 0x00009000 /* the proxy killed a session because the backend became unavailable */ |
| 73 | #define SN_ERR_KILLED 0x0000a000 /* the proxy killed a session because it was asked to do so */ |
| 74 | #define SN_ERR_UP 0x0000b000 /* the proxy killed a session because a preferred backend became available */ |
| 75 | #define SN_ERR_MASK 0x0000f000 /* mask to get only session error flags */ |
| 76 | #define SN_ERR_SHIFT 12 /* bit shift */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 77 | |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 78 | /* session state at termination, bits values 0x10000 to 0x70000 (0-7 shift 16) */ |
| 79 | #define SN_FINST_R 0x00010000 /* session ended during client request */ |
| 80 | #define SN_FINST_C 0x00020000 /* session ended during server connect */ |
| 81 | #define SN_FINST_H 0x00030000 /* session ended during server headers */ |
| 82 | #define SN_FINST_D 0x00040000 /* session ended during data phase */ |
| 83 | #define SN_FINST_L 0x00050000 /* session ended while pushing last data to client */ |
| 84 | #define SN_FINST_Q 0x00060000 /* session ended while waiting in queue for a server slot */ |
| 85 | #define SN_FINST_T 0x00070000 /* session ended tarpitted */ |
| 86 | #define SN_FINST_MASK 0x00070000 /* mask to get only final session state flags */ |
| 87 | #define SN_FINST_SHIFT 16 /* bit shift */ |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 88 | |
Simon Horman | 752dc4a | 2011-06-21 14:34:59 +0900 | [diff] [blame] | 89 | #define SN_IGNORE_PRST 0x00080000 /* ignore persistence */ |
Willy Tarreau | d5ca9ab | 2013-05-28 17:40:25 +0200 | [diff] [blame] | 90 | |
| 91 | #define SN_COMP_READY 0x00100000 /* the compression is initialized */ |
Willy Tarreau | 3634624 | 2014-02-24 18:26:30 +0100 | [diff] [blame] | 92 | #define SN_SRV_REUSED 0x00200000 /* the server-side connection was reused */ |
Cyril Bonté | 47fdd8e | 2010-04-25 00:00:51 +0200 | [diff] [blame] | 93 | |
Willy Tarreau | 7c669d7 | 2008-06-20 15:04:11 +0200 | [diff] [blame] | 94 | /* |
| 95 | * Note: some session flags have dependencies : |
| 96 | * - SN_DIRECT cannot exist without SN_ASSIGNED, because a server is |
| 97 | * immediately assigned when SN_DIRECT is determined. Both must be cleared |
| 98 | * when clearing SN_DIRECT (eg: redispatch). |
| 99 | * - ->srv has no meaning without SN_ASSIGNED and must not be checked without |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 100 | * it. ->target may be used to check previous ->srv after a failed connection attempt. |
Willy Tarreau | 7c669d7 | 2008-06-20 15:04:11 +0200 | [diff] [blame] | 101 | * - a session being processed has srv_conn set. |
| 102 | * - srv_conn might remain after SN_DIRECT has been reset, but the assigned |
| 103 | * server should eventually be released. |
| 104 | */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 105 | struct session { |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 106 | int flags; /* some flags describing the session */ |
Willy Tarreau | 2518db4 | 2013-12-06 22:01:11 +0100 | [diff] [blame] | 107 | unsigned int uniq_id; /* unique ID used for the traces */ |
Willy Tarreau | f8a49ea | 2013-10-14 21:32:07 +0200 | [diff] [blame] | 108 | enum obj_type *target; /* target to use for this session ; for mini-sess: incoming connection */ |
Willy Tarreau | 109e95a | 2012-10-13 11:22:24 +0200 | [diff] [blame] | 109 | |
Willy Tarreau | 7421efb | 2012-07-02 15:11:27 +0200 | [diff] [blame] | 110 | struct channel *req; /* request buffer */ |
| 111 | struct channel *rep; /* response buffer */ |
Willy Tarreau | 109e95a | 2012-10-13 11:22:24 +0200 | [diff] [blame] | 112 | |
| 113 | struct proxy *fe; /* the proxy this session depends on for the client side */ |
| 114 | struct proxy *be; /* the proxy this session depends on for the server side */ |
| 115 | |
| 116 | struct listener *listener; /* the listener by which the request arrived */ |
Willy Tarreau | 7c669d7 | 2008-06-20 15:04:11 +0200 | [diff] [blame] | 117 | struct server *srv_conn; /* session already has a slot on a server and is not in queue */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 118 | struct pendconn *pend_pos; /* if not NULL, points to the position in the pending queue */ |
Willy Tarreau | 109e95a | 2012-10-13 11:22:24 +0200 | [diff] [blame] | 119 | |
Willy Tarreau | b326fcc | 2007-03-03 13:54:32 +0100 | [diff] [blame] | 120 | struct http_txn txn; /* current HTTP transaction being processed. Should become a list. */ |
Emeric Brun | b982a3d | 2010-01-04 15:45:53 +0100 | [diff] [blame] | 121 | |
Willy Tarreau | 109e95a | 2012-10-13 11:22:24 +0200 | [diff] [blame] | 122 | struct task *task; /* the task associated with this session */ |
| 123 | struct list list; /* position in global sessions list */ |
| 124 | struct list by_srv; /* position in server session list */ |
| 125 | struct list back_refs; /* list of users tracking this session */ |
Willy Tarreau | bf883e0 | 2014-11-25 21:10:35 +0100 | [diff] [blame] | 126 | struct list buffer_wait; /* position in the list of sessions waiting for a buffer */ |
Willy Tarreau | 109e95a | 2012-10-13 11:22:24 +0200 | [diff] [blame] | 127 | |
Emeric Brun | b982a3d | 2010-01-04 15:45:53 +0100 | [diff] [blame] | 128 | struct { |
| 129 | struct stksess *ts; |
| 130 | struct stktable *table; |
Emeric Brun | b982a3d | 2010-01-04 15:45:53 +0100 | [diff] [blame] | 131 | } store[8]; /* tracked stickiness values to store */ |
| 132 | int store_count; |
Willy Tarreau | 2518db4 | 2013-12-06 22:01:11 +0100 | [diff] [blame] | 133 | /* 4 unused bytes here */ |
Willy Tarreau | 5612328 | 2010-08-06 19:06:56 +0200 | [diff] [blame] | 134 | |
Willy Tarreau | b4c8493 | 2013-07-23 19:15:30 +0200 | [diff] [blame] | 135 | struct stkctr stkctr[MAX_SESS_STKCTR]; /* stick counters */ |
Emeric Brun | b982a3d | 2010-01-04 15:45:53 +0100 | [diff] [blame] | 136 | |
Willy Tarreau | 109e95a | 2012-10-13 11:22:24 +0200 | [diff] [blame] | 137 | struct stream_interface si[2]; /* client and server stream interfaces */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 138 | struct { |
| 139 | int logwait; /* log fields waiting to be collected : LW_* */ |
Willy Tarreau | abcd514 | 2013-06-11 17:18:02 +0200 | [diff] [blame] | 140 | int level; /* log level to force + 1 if > 0, -1 = no log */ |
Willy Tarreau | b7f694f | 2008-06-22 17:18:02 +0200 | [diff] [blame] | 141 | struct timeval accept_date; /* date of the accept() in user date */ |
| 142 | struct timeval tv_accept; /* date of the accept() in internal date (monotonic) */ |
Willy Tarreau | 7008987 | 2008-06-13 21:12:51 +0200 | [diff] [blame] | 143 | struct timeval tv_request; /* date the request arrives, {0,0} if never occurs */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 144 | long t_queue; /* delay before the session gets out of the connect queue, -1 if never occurs */ |
| 145 | long t_connect; /* delay before the connect() to the server succeeds, -1 if never occurs */ |
| 146 | long t_data; /* delay before the first data byte from the server ... */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 147 | unsigned long t_close; /* total session duration */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 148 | unsigned long srv_queue_size; /* number of sessions waiting for a connect slot on this server at accept() time (in direct assignment) */ |
| 149 | unsigned long prx_queue_size; /* overall number of sessions waiting for a connect slot on this instance at accept() time */ |
Willy Tarreau | 35d66b0 | 2007-01-02 00:28:21 +0100 | [diff] [blame] | 150 | long long bytes_in; /* number of bytes transferred from the client to the server */ |
| 151 | long long bytes_out; /* number of bytes transferred from the server to the client */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 152 | } logs; |
Willy Tarreau | 0cac36f | 2008-11-30 20:44:17 +0100 | [diff] [blame] | 153 | void (*do_log)(struct session *s); /* the function to call in order to log (or NULL) */ |
| 154 | void (*srv_error)(struct session *s, /* the function to call upon unrecoverable server errors (or NULL) */ |
| 155 | struct stream_interface *si); |
William Lallemand | 8b52bb3 | 2012-11-16 18:06:41 +0100 | [diff] [blame] | 156 | struct comp_ctx *comp_ctx; /* HTTP compression context */ |
William Lallemand | 82fe75c | 2012-10-23 10:25:10 +0200 | [diff] [blame] | 157 | struct comp_algo *comp_algo; /* HTTP compression algorithm if not NULL */ |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 158 | char *unique_id; /* custom unique ID */ |
Thierry FOURNIER | bc4c1ac | 2015-02-25 13:36:14 +0100 | [diff] [blame] | 159 | |
| 160 | /* These two pointers are used to resume the execution of the rule lists. */ |
| 161 | struct list *current_rule_list; /* this is used to store the current executed rule list. */ |
| 162 | struct list *current_rule; /* this is used to store the current rule to be resumed. */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 163 | }; |
| 164 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 165 | #endif /* _TYPES_SESSION_H */ |
| 166 | |
| 167 | /* |
| 168 | * Local variables: |
| 169 | * c-indent-level: 8 |
| 170 | * c-basic-offset: 8 |
| 171 | * End: |
| 172 | */ |