blob: 8c9f834526664d72d3ca33fffa86c1e6061b8478 [file] [log] [blame]
Emeric Brun3bd697e2010-01-04 15:23:48 +01001/*
2 * include/proto/stick_table.h
3 * Functions for stick tables management.
4 *
5 * Copyright (C) 2009-2010 EXCELIANCE, Emeric Brun <ebrun@exceliance.fr>
Willy Tarreau08d5f982010-06-06 13:34:54 +02006 * Copyright (C) 2010 Willy Tarreau <w@1wt.eu>
Emeric Brun3bd697e2010-01-04 15:23:48 +01007 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation, version 2.1
11 * exclusively.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23#ifndef _PROTO_STICK_TABLE_H
24#define _PROTO_STICK_TABLE_H
25
Willy Tarreau888617d2010-06-20 09:11:39 +020026#include <common/errors.h>
Willy Tarreauf6efda12010-08-03 20:34:06 +020027#include <common/ticks.h>
28#include <common/time.h>
Emeric Brun3bd697e2010-01-04 15:23:48 +010029#include <types/stick_table.h>
30
Willy Tarreau68129b92010-06-06 16:06:52 +020031#define stktable_data_size(type) (sizeof(((union stktable_data*)0)->type))
32#define stktable_data_cast(ptr, type) ((union stktable_data*)(ptr))->type
33
Emeric Brun3bd697e2010-01-04 15:23:48 +010034struct stksess *stksess_new(struct stktable *t, struct stktable_key *key);
Willy Tarreau393379c2010-06-06 12:11:37 +020035void stksess_setkey(struct stktable *t, struct stksess *ts, struct stktable_key *key);
Emeric Brun3bd697e2010-01-04 15:23:48 +010036void stksess_free(struct stktable *t, struct stksess *ts);
Emeric Brun819fc6f2017-06-13 19:37:32 +020037int stksess_kill(struct stktable *t, struct stksess *ts, int decrefcount);
Emeric Brun3bd697e2010-01-04 15:23:48 +010038
39int stktable_init(struct stktable *t);
40int stktable_parse_type(char **args, int *idx, unsigned long *type, size_t *key_size);
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020041struct stksess *stktable_get_entry(struct stktable *table, struct stktable_key *key);
Emeric Brun819fc6f2017-06-13 19:37:32 +020042struct stksess *stktable_set_entry(struct stktable *table, struct stksess *nts);
43void stktable_touch_with_exp(struct stktable *t, struct stksess *ts, int decrefcount, int expire);
44void stktable_touch_remote(struct stktable *t, struct stksess *ts, int decrefcnt);
45void stktable_touch_local(struct stktable *t, struct stksess *ts, int decrefccount);
Willy Tarreauf16d2b82010-06-06 15:38:59 +020046struct stksess *stktable_lookup(struct stktable *t, struct stksess *ts);
47struct stksess *stktable_lookup_key(struct stktable *t, struct stktable_key *key);
Willy Tarreau1f7e9252010-06-20 12:27:21 +020048struct stksess *stktable_update_key(struct stktable *table, struct stktable_key *key);
Willy Tarreau8fed9032014-07-03 17:02:46 +020049struct stktable_key *smp_to_stkey(struct sample *smp, struct stktable *t);
Willy Tarreau192252e2015-04-04 01:47:55 +020050struct stktable_key *stktable_fetch_key(struct stktable *t, struct proxy *px, struct session *sess,
Willy Tarreau15e91e12015-04-04 00:52:09 +020051 struct stream *strm, unsigned int opt,
52 struct sample_expr *expr, struct sample *smp);
Emeric Brun819fc6f2017-06-13 19:37:32 +020053struct stkctr *smp_fetch_sc_stkctr(struct session *sess, struct stream *strm, const struct arg *args, const char *kw, struct stkctr *stkctr);
54struct stkctr *smp_create_src_stkctr(struct session *sess, struct stream *strm, const struct arg *args, const char *kw, struct stkctr *stkctr);
Willy Tarreau12785782012-04-27 21:37:17 +020055int stktable_compatible_sample(struct sample_expr *expr, unsigned long table_type);
Willy Tarreauedee1d62014-07-15 16:44:27 +020056int stktable_register_data_store(int idx, const char *name, int std_type, int arg_type);
Willy Tarreau08d5f982010-06-06 13:34:54 +020057int stktable_get_data_type(char *name);
Willy Tarreau3a925c12013-09-04 17:54:01 +020058int stktable_trash_oldest(struct stktable *t, int to_batch);
Emeric Brun819fc6f2017-06-13 19:37:32 +020059int __stksess_kill(struct stktable *t, struct stksess *ts);
Willy Tarreau08d5f982010-06-06 13:34:54 +020060
Willy Tarreau3b9c6e02010-07-18 08:04:30 +020061/* return allocation size for standard data type <type> */
62static inline int stktable_type_size(int type)
63{
64 switch(type) {
65 case STD_T_SINT:
66 case STD_T_UINT:
67 return sizeof(int);
68 case STD_T_ULL:
69 return sizeof(unsigned long long);
70 case STD_T_FRQP:
71 return sizeof(struct freq_ctr_period);
72 }
73 return 0;
74}
75
Willy Tarreau888617d2010-06-20 09:11:39 +020076/* reserve some space for data type <type>, and associate argument at <sa> if
77 * not NULL. Returns PE_NONE (0) if OK or an error code among :
78 * - PE_ENUM_OOR if <type> does not exist
79 * - PE_EXIST if <type> is already registered
Willy Tarreauac782882010-06-20 10:41:54 +020080 * - PE_ARG_NOT_USE if <sa> was provided but not expected
81 * - PE_ARG_MISSING if <sa> was expected but not provided
Willy Tarreau08d5f982010-06-06 13:34:54 +020082 */
Willy Tarreau888617d2010-06-20 09:11:39 +020083static inline int stktable_alloc_data_type(struct stktable *t, int type, const char *sa)
Willy Tarreau08d5f982010-06-06 13:34:54 +020084{
85 if (type >= STKTABLE_DATA_TYPES)
Willy Tarreau888617d2010-06-20 09:11:39 +020086 return PE_ENUM_OOR;
Willy Tarreau08d5f982010-06-06 13:34:54 +020087
88 if (t->data_ofs[type])
89 /* already allocated */
Willy Tarreau888617d2010-06-20 09:11:39 +020090 return PE_EXIST;
Emeric Brun3bd697e2010-01-04 15:23:48 +010091
Willy Tarreauac782882010-06-20 10:41:54 +020092 switch (stktable_data_types[type].arg_type) {
93 case ARG_T_NONE:
94 if (sa)
95 return PE_ARG_NOT_USED;
96 break;
97 case ARG_T_INT:
98 if (!sa)
99 return PE_ARG_MISSING;
100 t->data_arg[type].i = atoi(sa);
101 break;
102 case ARG_T_DELAY:
103 if (!sa)
104 return PE_ARG_MISSING;
105 sa = parse_time_err(sa, &t->data_arg[type].u, TIME_UNIT_MS);
106 if (sa)
107 return PE_ARG_INVC; /* invalid char */
108 break;
109 }
110
Willy Tarreau3b9c6e02010-07-18 08:04:30 +0200111 t->data_size += stktable_type_size(stktable_data_types[type].std_type);
Willy Tarreau08d5f982010-06-06 13:34:54 +0200112 t->data_ofs[type] = -t->data_size;
Willy Tarreau888617d2010-06-20 09:11:39 +0200113 return PE_NONE;
Willy Tarreau08d5f982010-06-06 13:34:54 +0200114}
Emeric Brun3bd697e2010-01-04 15:23:48 +0100115
Willy Tarreau68129b92010-06-06 16:06:52 +0200116/* return pointer for data type <type> in sticky session <ts> of table <t>, or
117 * NULL if either <ts> is NULL or the type is not stored.
118 */
119static inline void *stktable_data_ptr(struct stktable *t, struct stksess *ts, int type)
120{
121 if (type >= STKTABLE_DATA_TYPES)
122 return NULL;
123
124 if (!t->data_ofs[type]) /* type not stored */
125 return NULL;
126
127 if (!ts)
128 return NULL;
129
130 return (void *)ts + t->data_ofs[type];
131}
132
Willy Tarreauf6efda12010-08-03 20:34:06 +0200133/* kill an entry if it's expired and its ref_cnt is zero */
Emeric Brun819fc6f2017-06-13 19:37:32 +0200134static inline int __stksess_kill_if_expired(struct stktable *t, struct stksess *ts)
Willy Tarreauf6efda12010-08-03 20:34:06 +0200135{
Emeric Brunc89a5722010-09-23 18:11:05 +0200136 if (t->expire != TICK_ETERNITY && tick_is_expired(ts->expire, now_ms))
Emeric Brun819fc6f2017-06-13 19:37:32 +0200137 return __stksess_kill(t, ts);
138
139 return 0;
140}
141
142static inline int stksess_kill_if_expired(struct stktable *t, struct stksess *ts, int decrefcnt)
143{
144 int ret;
145
146 SPIN_LOCK(STK_TABLE_LOCK, &t->lock);
147
148 if (decrefcnt)
149 ts->ref_cnt--;
150
151 if (t->expire != TICK_ETERNITY && tick_is_expired(ts->expire, now_ms))
152 ret = __stksess_kill_if_expired(t, ts);
153
154 SPIN_UNLOCK(STK_TABLE_LOCK, &t->lock);
155
156 return ret;
Willy Tarreauf6efda12010-08-03 20:34:06 +0200157}
158
Willy Tarreau7698c902015-04-04 16:24:42 +0200159/* sets the stick counter's entry pointer */
160static inline void stkctr_set_entry(struct stkctr *stkctr, struct stksess *entry)
161{
162 stkctr->entry = caddr_from_ptr(entry, 0);
163}
164
165/* returns the entry pointer from a stick counter */
166static inline struct stksess *stkctr_entry(struct stkctr *stkctr)
167{
168 return caddr_to_ptr(stkctr->entry);
169}
170
171/* returns the two flags from a stick counter */
172static inline unsigned int stkctr_flags(struct stkctr *stkctr)
173{
174 return caddr_to_data(stkctr->entry);
175}
176
177/* sets up to two flags at a time on a composite address */
178static inline void stkctr_set_flags(struct stkctr *stkctr, unsigned int flags)
179{
180 stkctr->entry = caddr_set_flags(stkctr->entry, flags);
181}
182
183/* returns the two flags from a stick counter */
184static inline void stkctr_clr_flags(struct stkctr *stkctr, unsigned int flags)
185{
186 stkctr->entry = caddr_clr_flags(stkctr->entry, flags);
187}
188
Emeric Brun3bd697e2010-01-04 15:23:48 +0100189#endif /* _PROTO_STICK_TABLE_H */