blob: 941e2ff72d1c129911e91481b6dc20e864c96718 [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
Willy Tarreau07115412012-10-29 21:56:59 +010034extern struct stktable_key *static_table_key;
Willy Tarreau41883e22010-06-06 17:39:30 +020035
Emeric Brun3bd697e2010-01-04 15:23:48 +010036struct stksess *stksess_new(struct stktable *t, struct stktable_key *key);
Willy Tarreau393379c2010-06-06 12:11:37 +020037void stksess_setkey(struct stktable *t, struct stksess *ts, struct stktable_key *key);
Emeric Brun3bd697e2010-01-04 15:23:48 +010038void stksess_free(struct stktable *t, struct stksess *ts);
Willy Tarreauf6efda12010-08-03 20:34:06 +020039void stksess_kill(struct stktable *t, struct stksess *ts);
Emeric Brun3bd697e2010-01-04 15:23:48 +010040
41int stktable_init(struct stktable *t);
42int stktable_parse_type(char **args, int *idx, unsigned long *type, size_t *key_size);
Willy Tarreau9ba2dcc2010-06-14 21:04:55 +020043struct stksess *stktable_get_entry(struct stktable *table, struct stktable_key *key);
Emeric Brun85e77c72010-09-23 18:16:52 +020044struct stksess *stktable_store(struct stktable *t, struct stksess *ts, int local);
Frédéric Lécaille523cc9e2016-10-12 17:30:30 +020045struct stksess *stktable_store_with_exp(struct stktable *t, struct stksess *ts,
46 int local, int expire);
47struct stksess *stktable_touch_with_exp(struct stktable *t, struct stksess *ts,
48 int local, int expire);
Emeric Brun85e77c72010-09-23 18:16:52 +020049struct stksess *stktable_touch(struct stktable *t, struct stksess *ts, int local);
Willy Tarreauf16d2b82010-06-06 15:38:59 +020050struct stksess *stktable_lookup(struct stktable *t, struct stksess *ts);
51struct stksess *stktable_lookup_key(struct stktable *t, struct stktable_key *key);
Willy Tarreau1f7e9252010-06-20 12:27:21 +020052struct stksess *stktable_update_key(struct stktable *table, struct stktable_key *key);
Willy Tarreau8fed9032014-07-03 17:02:46 +020053struct stktable_key *smp_to_stkey(struct sample *smp, struct stktable *t);
Willy Tarreau192252e2015-04-04 01:47:55 +020054struct stktable_key *stktable_fetch_key(struct stktable *t, struct proxy *px, struct session *sess,
Willy Tarreau15e91e12015-04-04 00:52:09 +020055 struct stream *strm, unsigned int opt,
56 struct sample_expr *expr, struct sample *smp);
Willy Tarreau12785782012-04-27 21:37:17 +020057int stktable_compatible_sample(struct sample_expr *expr, unsigned long table_type);
Willy Tarreauedee1d62014-07-15 16:44:27 +020058int stktable_register_data_store(int idx, const char *name, int std_type, int arg_type);
Willy Tarreau08d5f982010-06-06 13:34:54 +020059int stktable_get_data_type(char *name);
Willy Tarreau3a925c12013-09-04 17:54:01 +020060int stktable_trash_oldest(struct stktable *t, int to_batch);
Willy Tarreau08d5f982010-06-06 13:34:54 +020061
Willy Tarreau3b9c6e02010-07-18 08:04:30 +020062/* return allocation size for standard data type <type> */
63static inline int stktable_type_size(int type)
64{
65 switch(type) {
66 case STD_T_SINT:
67 case STD_T_UINT:
68 return sizeof(int);
69 case STD_T_ULL:
70 return sizeof(unsigned long long);
71 case STD_T_FRQP:
72 return sizeof(struct freq_ctr_period);
73 }
74 return 0;
75}
76
Willy Tarreau888617d2010-06-20 09:11:39 +020077/* reserve some space for data type <type>, and associate argument at <sa> if
78 * not NULL. Returns PE_NONE (0) if OK or an error code among :
79 * - PE_ENUM_OOR if <type> does not exist
80 * - PE_EXIST if <type> is already registered
Willy Tarreauac782882010-06-20 10:41:54 +020081 * - PE_ARG_NOT_USE if <sa> was provided but not expected
82 * - PE_ARG_MISSING if <sa> was expected but not provided
Willy Tarreau08d5f982010-06-06 13:34:54 +020083 */
Willy Tarreau888617d2010-06-20 09:11:39 +020084static inline int stktable_alloc_data_type(struct stktable *t, int type, const char *sa)
Willy Tarreau08d5f982010-06-06 13:34:54 +020085{
86 if (type >= STKTABLE_DATA_TYPES)
Willy Tarreau888617d2010-06-20 09:11:39 +020087 return PE_ENUM_OOR;
Willy Tarreau08d5f982010-06-06 13:34:54 +020088
89 if (t->data_ofs[type])
90 /* already allocated */
Willy Tarreau888617d2010-06-20 09:11:39 +020091 return PE_EXIST;
Emeric Brun3bd697e2010-01-04 15:23:48 +010092
Willy Tarreauac782882010-06-20 10:41:54 +020093 switch (stktable_data_types[type].arg_type) {
94 case ARG_T_NONE:
95 if (sa)
96 return PE_ARG_NOT_USED;
97 break;
98 case ARG_T_INT:
99 if (!sa)
100 return PE_ARG_MISSING;
101 t->data_arg[type].i = atoi(sa);
102 break;
103 case ARG_T_DELAY:
104 if (!sa)
105 return PE_ARG_MISSING;
106 sa = parse_time_err(sa, &t->data_arg[type].u, TIME_UNIT_MS);
107 if (sa)
108 return PE_ARG_INVC; /* invalid char */
109 break;
110 }
111
Willy Tarreau3b9c6e02010-07-18 08:04:30 +0200112 t->data_size += stktable_type_size(stktable_data_types[type].std_type);
Willy Tarreau08d5f982010-06-06 13:34:54 +0200113 t->data_ofs[type] = -t->data_size;
Willy Tarreau888617d2010-06-20 09:11:39 +0200114 return PE_NONE;
Willy Tarreau08d5f982010-06-06 13:34:54 +0200115}
Emeric Brun3bd697e2010-01-04 15:23:48 +0100116
Willy Tarreau68129b92010-06-06 16:06:52 +0200117/* return pointer for data type <type> in sticky session <ts> of table <t>, or
118 * NULL if either <ts> is NULL or the type is not stored.
119 */
120static inline void *stktable_data_ptr(struct stktable *t, struct stksess *ts, int type)
121{
122 if (type >= STKTABLE_DATA_TYPES)
123 return NULL;
124
125 if (!t->data_ofs[type]) /* type not stored */
126 return NULL;
127
128 if (!ts)
129 return NULL;
130
131 return (void *)ts + t->data_ofs[type];
132}
133
Willy Tarreauf6efda12010-08-03 20:34:06 +0200134/* kill an entry if it's expired and its ref_cnt is zero */
135static inline void stksess_kill_if_expired(struct stktable *t, struct stksess *ts)
136{
Emeric Brunc89a5722010-09-23 18:11:05 +0200137 if (t->expire != TICK_ETERNITY && tick_is_expired(ts->expire, now_ms))
Willy Tarreauf6efda12010-08-03 20:34:06 +0200138 stksess_kill(t, ts);
139}
140
Willy Tarreau7698c902015-04-04 16:24:42 +0200141/* sets the stick counter's entry pointer */
142static inline void stkctr_set_entry(struct stkctr *stkctr, struct stksess *entry)
143{
144 stkctr->entry = caddr_from_ptr(entry, 0);
145}
146
147/* returns the entry pointer from a stick counter */
148static inline struct stksess *stkctr_entry(struct stkctr *stkctr)
149{
150 return caddr_to_ptr(stkctr->entry);
151}
152
153/* returns the two flags from a stick counter */
154static inline unsigned int stkctr_flags(struct stkctr *stkctr)
155{
156 return caddr_to_data(stkctr->entry);
157}
158
159/* sets up to two flags at a time on a composite address */
160static inline void stkctr_set_flags(struct stkctr *stkctr, unsigned int flags)
161{
162 stkctr->entry = caddr_set_flags(stkctr->entry, flags);
163}
164
165/* returns the two flags from a stick counter */
166static inline void stkctr_clr_flags(struct stkctr *stkctr, unsigned int flags)
167{
168 stkctr->entry = caddr_clr_flags(stkctr->entry, flags);
169}
170
Emeric Brun3bd697e2010-01-04 15:23:48 +0100171#endif /* _PROTO_STICK_TABLE_H */