blob: f597d5977892678bcb866334c188f14dc6df2e94 [file] [log] [blame]
Willy TARREAU3dc06442006-06-15 21:48:13 +02001/*
Willy Tarreau81f9aa32010-06-01 17:45:26 +02002 * include/proto/session.h
3 * This file defines everything related to sessions.
4 *
5 * Copyright (C) 2000-2010 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 */
Willy TARREAU3dc06442006-06-15 21:48:13 +020021
Willy Tarreaubaaee002006-06-26 02:48:02 +020022#ifndef _PROTO_SESSION_H
23#define _PROTO_SESSION_H
24
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020025#include <common/config.h>
Willy Tarreauc6ca1a02007-05-13 19:43:47 +020026#include <common/memory.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020027#include <types/session.h>
Willy Tarreau91c43d72010-06-20 11:19:22 +020028#include <proto/freq_ctr.h>
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020029#include <proto/stick_table.h>
Willy TARREAU3dc06442006-06-15 21:48:13 +020030
Willy Tarreauc6ca1a02007-05-13 19:43:47 +020031extern struct pool_head *pool2_session;
Willy Tarreauf54f8bd2008-11-23 19:53:55 +010032extern struct list sessions;
Willy Tarreauc6ca1a02007-05-13 19:43:47 +020033
Willy Tarreaubc174aa2012-11-19 16:10:32 +010034extern struct data_cb sess_conn_cb;
35
Willy Tarreau81f9aa32010-06-01 17:45:26 +020036int session_accept(struct listener *l, int cfd, struct sockaddr_storage *addr);
Willy Tarreaubaaee002006-06-26 02:48:02 +020037
Willy Tarreauc6ca1a02007-05-13 19:43:47 +020038/* perform minimal intializations, report 0 in case of error, 1 if OK. */
39int init_session();
Willy Tarreaubaaee002006-06-26 02:48:02 +020040
Willy Tarreaua2a64e92011-09-07 23:01:56 +020041/* kill a session and set the termination flags to <why> (one of SN_ERR_*) */
42void session_shutdown(struct session *session, int why);
Simon Hormandec5be42011-06-08 09:19:07 +090043
Krzysztof Piotr Oledzki583bc962007-11-24 22:12:47 +010044void session_process_counters(struct session *s);
Willy Tarreau7c669d72008-06-20 15:04:11 +020045void sess_change_server(struct session *sess, struct server *newsrv);
Willy Tarreau26c25062009-03-08 09:38:41 +010046struct task *process_session(struct task *t);
Willy Tarreau84455332009-03-15 22:34:05 +010047void default_srv_error(struct session *s, struct stream_interface *si);
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020048int parse_track_counters(char **args, int *arg,
49 int section_type, struct proxy *curpx,
50 struct track_ctr_prm *prm,
Willy Tarreau0a3dd742012-05-08 19:47:01 +020051 struct proxy *defpx, char **err);
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020052
53/* Remove the refcount from the session to the tracked counters, and clear the
54 * pointer to ensure this is only performed once. The caller is responsible for
55 * ensuring that the pointer is valid first.
56 */
57static inline void session_store_counters(struct session *s)
58{
Willy Tarreauf059a0f2010-08-03 16:29:52 +020059 void *ptr;
Willy Tarreau20d46a52012-12-09 15:55:40 +010060 int i;
Willy Tarreauf059a0f2010-08-03 16:29:52 +020061
Willy Tarreaub4c84932013-07-23 19:15:30 +020062 for (i = 0; i < MAX_SESS_STKCTR; i++) {
Willy Tarreau20d46a52012-12-09 15:55:40 +010063 if (!s->stkctr[i].entry)
64 continue;
65 ptr = stktable_data_ptr(s->stkctr[i].table, s->stkctr[i].entry, STKTABLE_DT_CONN_CUR);
Willy Tarreauf059a0f2010-08-03 16:29:52 +020066 if (ptr)
67 stktable_data_cast(ptr, conn_cur)--;
Willy Tarreau20d46a52012-12-09 15:55:40 +010068 s->stkctr[i].entry->ref_cnt--;
69 stksess_kill_if_expired(s->stkctr[i].table, s->stkctr[i].entry);
70 s->stkctr[i].entry = NULL;
Willy Tarreau38285c12010-06-18 16:35:43 +020071 }
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020072}
73
Willy Tarreauf059a0f2010-08-03 16:29:52 +020074/* Remove the refcount from the session counters tracked only by the backend if
75 * any, and clear the pointer to ensure this is only performed once. The caller
76 * is responsible for ensuring that the pointer is valid first.
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020077 */
Willy Tarreauf059a0f2010-08-03 16:29:52 +020078static inline void session_stop_backend_counters(struct session *s)
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020079{
Willy Tarreauf059a0f2010-08-03 16:29:52 +020080 void *ptr;
Willy Tarreau20d46a52012-12-09 15:55:40 +010081 int i;
Willy Tarreaue3487932010-06-18 21:03:20 +020082
Willy Tarreaud5ca9ab2013-05-28 17:40:25 +020083 if (likely(!(s->flags & SN_BE_TRACK_ANY)))
Willy Tarreauf059a0f2010-08-03 16:29:52 +020084 return;
Willy Tarreaue3487932010-06-18 21:03:20 +020085
Willy Tarreaub4c84932013-07-23 19:15:30 +020086 for (i = 0; i < MAX_SESS_STKCTR; i++) {
Willy Tarreau20d46a52012-12-09 15:55:40 +010087 if (!s->stkctr[i].entry)
88 continue;
Willy Tarreau0a4838c2010-08-06 20:11:05 +020089
Willy Tarreaube4a3ef2013-06-17 15:04:07 +020090 if (!(s->flags & (SN_BE_TRACK_SC0 << i)))
Willy Tarreau20d46a52012-12-09 15:55:40 +010091 continue;
92
Willy Tarreau20d46a52012-12-09 15:55:40 +010093 ptr = stktable_data_ptr(s->stkctr[i].table, s->stkctr[i].entry, STKTABLE_DT_CONN_CUR);
Willy Tarreau0a4838c2010-08-06 20:11:05 +020094 if (ptr)
95 stktable_data_cast(ptr, conn_cur)--;
Willy Tarreau20d46a52012-12-09 15:55:40 +010096 s->stkctr[i].entry->ref_cnt--;
97 stksess_kill_if_expired(s->stkctr[i].table, s->stkctr[i].entry);
98 s->stkctr[i].entry = NULL;
Willy Tarreau0a4838c2010-08-06 20:11:05 +020099 }
Willy Tarreaud5ca9ab2013-05-28 17:40:25 +0200100 s->flags &= ~SN_BE_TRACK_ANY;
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200101}
Willy Tarreaue3487932010-06-18 21:03:20 +0200102
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200103/* Increase total and concurrent connection count for stick entry <ts> of table
104 * <t>. The caller is responsible for ensuring that <t> and <ts> are valid
105 * pointers, and for calling this only once per connection.
106 */
107static inline void session_start_counters(struct stktable *t, struct stksess *ts)
108{
109 void *ptr;
Willy Tarreau91c43d72010-06-20 11:19:22 +0200110
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200111 ptr = stktable_data_ptr(t, ts, STKTABLE_DT_CONN_CUR);
112 if (ptr)
113 stktable_data_cast(ptr, conn_cur)++;
114
115 ptr = stktable_data_ptr(t, ts, STKTABLE_DT_CONN_CNT);
116 if (ptr)
117 stktable_data_cast(ptr, conn_cnt)++;
118
119 ptr = stktable_data_ptr(t, ts, STKTABLE_DT_CONN_RATE);
120 if (ptr)
121 update_freq_ctr_period(&stktable_data_cast(ptr, conn_rate),
122 t->data_arg[STKTABLE_DT_CONN_RATE].u, 1);
123 if (tick_isset(t->expire))
124 ts->expire = tick_add(now_ms, MS_TO_TICKS(t->expire));
125}
126
Willy Tarreau20d46a52012-12-09 15:55:40 +0100127/* Enable tracking of session counters as <stkctr> on stksess <ts>. The caller is
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200128 * responsible for ensuring that <t> and <ts> are valid pointers. Some controls
129 * are performed to ensure the state can still change.
130 */
Willy Tarreau20d46a52012-12-09 15:55:40 +0100131static inline void session_track_stkctr(struct stkctr *ctr, struct stktable *t, struct stksess *ts)
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200132{
Willy Tarreau20d46a52012-12-09 15:55:40 +0100133 if (ctr->entry)
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200134 return;
135
136 ts->ref_cnt++;
Willy Tarreau20d46a52012-12-09 15:55:40 +0100137 ctr->table = t;
138 ctr->entry = ts;
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200139 session_start_counters(t, ts);
140}
141
Willy Tarreauda7ff642010-06-23 11:44:09 +0200142/* Increase the number of cumulated HTTP requests in the tracked counters */
143static void inline session_inc_http_req_ctr(struct session *s)
144{
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200145 void *ptr;
Willy Tarreau20d46a52012-12-09 15:55:40 +0100146 int i;
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200147
Willy Tarreaub4c84932013-07-23 19:15:30 +0200148 for (i = 0; i < MAX_SESS_STKCTR; i++) {
Willy Tarreau20d46a52012-12-09 15:55:40 +0100149 if (!s->stkctr[i].entry)
150 continue;
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200151
Willy Tarreau20d46a52012-12-09 15:55:40 +0100152 ptr = stktable_data_ptr(s->stkctr[i].table, s->stkctr[i].entry, STKTABLE_DT_HTTP_REQ_CNT);
Willy Tarreauda7ff642010-06-23 11:44:09 +0200153 if (ptr)
154 stktable_data_cast(ptr, http_req_cnt)++;
155
Willy Tarreau20d46a52012-12-09 15:55:40 +0100156 ptr = stktable_data_ptr(s->stkctr[i].table, s->stkctr[i].entry, STKTABLE_DT_HTTP_REQ_RATE);
Willy Tarreauda7ff642010-06-23 11:44:09 +0200157 if (ptr)
158 update_freq_ctr_period(&stktable_data_cast(ptr, http_req_rate),
Willy Tarreau20d46a52012-12-09 15:55:40 +0100159 s->stkctr[i].table->data_arg[STKTABLE_DT_HTTP_REQ_RATE].u, 1);
Willy Tarreauda7ff642010-06-23 11:44:09 +0200160 }
161}
162
Willy Tarreau5d5b5d82012-12-09 12:00:04 +0100163/* Increase the number of cumulated HTTP requests in the backend's tracked counters */
164static void inline session_inc_be_http_req_ctr(struct session *s)
165{
166 void *ptr;
Willy Tarreau20d46a52012-12-09 15:55:40 +0100167 int i;
Willy Tarreau5d5b5d82012-12-09 12:00:04 +0100168
Willy Tarreaud5ca9ab2013-05-28 17:40:25 +0200169 if (likely(!(s->flags & SN_BE_TRACK_ANY)))
Willy Tarreau5d5b5d82012-12-09 12:00:04 +0100170 return;
171
Willy Tarreaub4c84932013-07-23 19:15:30 +0200172 for (i = 0; i < MAX_SESS_STKCTR; i++) {
Willy Tarreau20d46a52012-12-09 15:55:40 +0100173 if (!s->stkctr[i].entry)
174 continue;
Willy Tarreau5d5b5d82012-12-09 12:00:04 +0100175
Willy Tarreaube4a3ef2013-06-17 15:04:07 +0200176 if (!(s->flags & (SN_BE_TRACK_SC0 << i)))
Willy Tarreau20d46a52012-12-09 15:55:40 +0100177 continue;
178
179 ptr = stktable_data_ptr(s->stkctr[i].table, s->stkctr[i].entry, STKTABLE_DT_HTTP_REQ_CNT);
Willy Tarreau5d5b5d82012-12-09 12:00:04 +0100180 if (ptr)
181 stktable_data_cast(ptr, http_req_cnt)++;
182
Willy Tarreau20d46a52012-12-09 15:55:40 +0100183 ptr = stktable_data_ptr(s->stkctr[i].table, s->stkctr[i].entry, STKTABLE_DT_HTTP_REQ_RATE);
Willy Tarreau5d5b5d82012-12-09 12:00:04 +0100184 if (ptr)
185 update_freq_ctr_period(&stktable_data_cast(ptr, http_req_rate),
Willy Tarreau20d46a52012-12-09 15:55:40 +0100186 s->stkctr[i].table->data_arg[STKTABLE_DT_HTTP_REQ_RATE].u, 1);
Willy Tarreau5d5b5d82012-12-09 12:00:04 +0100187 }
188}
189
Willy Tarreauda7ff642010-06-23 11:44:09 +0200190/* Increase the number of cumulated failed HTTP requests in the tracked
191 * counters. Only 4xx requests should be counted here so that we can
192 * distinguish between errors caused by client behaviour and other ones.
193 * Note that even 404 are interesting because they're generally caused by
194 * vulnerability scans.
195 */
196static void inline session_inc_http_err_ctr(struct session *s)
197{
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200198 void *ptr;
Willy Tarreau20d46a52012-12-09 15:55:40 +0100199 int i;
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200200
Willy Tarreaub4c84932013-07-23 19:15:30 +0200201 for (i = 0; i < MAX_SESS_STKCTR; i++) {
Willy Tarreau20d46a52012-12-09 15:55:40 +0100202 if (!s->stkctr[i].entry)
203 continue;
Willy Tarreauf059a0f2010-08-03 16:29:52 +0200204
Willy Tarreau20d46a52012-12-09 15:55:40 +0100205 ptr = stktable_data_ptr(s->stkctr[i].table, s->stkctr[i].entry, STKTABLE_DT_HTTP_ERR_CNT);
Willy Tarreauda7ff642010-06-23 11:44:09 +0200206 if (ptr)
207 stktable_data_cast(ptr, http_err_cnt)++;
208
Willy Tarreau20d46a52012-12-09 15:55:40 +0100209 ptr = stktable_data_ptr(s->stkctr[i].table, s->stkctr[i].entry, STKTABLE_DT_HTTP_ERR_RATE);
Willy Tarreauda7ff642010-06-23 11:44:09 +0200210 if (ptr)
211 update_freq_ctr_period(&stktable_data_cast(ptr, http_err_rate),
Willy Tarreau20d46a52012-12-09 15:55:40 +0100212 s->stkctr[i].table->data_arg[STKTABLE_DT_HTTP_ERR_RATE].u, 1);
Willy Tarreauda7ff642010-06-23 11:44:09 +0200213 }
214}
215
Simon Hormanaf514952011-06-21 14:34:57 +0900216static void inline session_add_srv_conn(struct session *sess, struct server *srv)
217{
218 sess->srv_conn = srv;
219 LIST_ADD(&srv->actconns, &sess->by_srv);
220}
221
222static void inline session_del_srv_conn(struct session *sess)
223{
224 if (!sess->srv_conn)
225 return;
226
227 sess->srv_conn = NULL;
228 LIST_DEL(&sess->by_srv);
229}
230
Willy Tarreau9bd0d742011-07-20 00:17:39 +0200231static void inline session_init_srv_conn(struct session *sess)
232{
233 sess->srv_conn = NULL;
234 LIST_INIT(&sess->by_srv);
235}
236
Willy Tarreaubaaee002006-06-26 02:48:02 +0200237#endif /* _PROTO_SESSION_H */
Willy TARREAU3dc06442006-06-15 21:48:13 +0200238
Willy Tarreaubaaee002006-06-26 02:48:02 +0200239/*
240 * Local variables:
241 * c-indent-level: 8
242 * c-basic-offset: 8
243 * End:
244 */