2010-01-04 14:23:48 +00:00
|
|
|
/*
|
|
|
|
* include/proto/stick_table.h
|
|
|
|
* Functions for stick tables management.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2009-2010 EXCELIANCE, Emeric Brun <ebrun@exceliance.fr>
|
2010-06-06 11:34:54 +00:00
|
|
|
* Copyright (C) 2010 Willy Tarreau <w@1wt.eu>
|
2010-01-04 14:23:48 +00:00
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
|
|
* exclusively.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
* License along with this library; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _PROTO_STICK_TABLE_H
|
|
|
|
#define _PROTO_STICK_TABLE_H
|
|
|
|
|
2010-06-20 07:11:39 +00:00
|
|
|
#include <common/errors.h>
|
2010-08-03 18:34:06 +00:00
|
|
|
#include <common/ticks.h>
|
|
|
|
#include <common/time.h>
|
2010-01-04 14:23:48 +00:00
|
|
|
#include <types/stick_table.h>
|
|
|
|
|
2010-06-06 14:06:52 +00:00
|
|
|
#define stktable_data_size(type) (sizeof(((union stktable_data*)0)->type))
|
|
|
|
#define stktable_data_cast(ptr, type) ((union stktable_data*)(ptr))->type
|
|
|
|
|
2010-01-04 14:23:48 +00:00
|
|
|
struct stksess *stksess_new(struct stktable *t, struct stktable_key *key);
|
2010-06-06 10:11:37 +00:00
|
|
|
void stksess_setkey(struct stktable *t, struct stksess *ts, struct stktable_key *key);
|
2010-01-04 14:23:48 +00:00
|
|
|
void stksess_free(struct stktable *t, struct stksess *ts);
|
2017-06-13 17:37:32 +00:00
|
|
|
int stksess_kill(struct stktable *t, struct stksess *ts, int decrefcount);
|
2010-01-04 14:23:48 +00:00
|
|
|
|
|
|
|
int stktable_init(struct stktable *t);
|
|
|
|
int stktable_parse_type(char **args, int *idx, unsigned long *type, size_t *key_size);
|
2010-06-14 19:04:55 +00:00
|
|
|
struct stksess *stktable_get_entry(struct stktable *table, struct stktable_key *key);
|
2017-06-13 17:37:32 +00:00
|
|
|
struct stksess *stktable_set_entry(struct stktable *table, struct stksess *nts);
|
|
|
|
void stktable_touch_with_exp(struct stktable *t, struct stksess *ts, int decrefcount, int expire);
|
|
|
|
void stktable_touch_remote(struct stktable *t, struct stksess *ts, int decrefcnt);
|
|
|
|
void stktable_touch_local(struct stktable *t, struct stksess *ts, int decrefccount);
|
2010-06-06 13:38:59 +00:00
|
|
|
struct stksess *stktable_lookup(struct stktable *t, struct stksess *ts);
|
|
|
|
struct stksess *stktable_lookup_key(struct stktable *t, struct stktable_key *key);
|
2010-06-20 10:27:21 +00:00
|
|
|
struct stksess *stktable_update_key(struct stktable *table, struct stktable_key *key);
|
2014-07-03 15:02:46 +00:00
|
|
|
struct stktable_key *smp_to_stkey(struct sample *smp, struct stktable *t);
|
2015-04-03 23:47:55 +00:00
|
|
|
struct stktable_key *stktable_fetch_key(struct stktable *t, struct proxy *px, struct session *sess,
|
2015-04-03 22:52:09 +00:00
|
|
|
struct stream *strm, unsigned int opt,
|
|
|
|
struct sample_expr *expr, struct sample *smp);
|
2017-06-13 17:37:32 +00:00
|
|
|
struct stkctr *smp_fetch_sc_stkctr(struct session *sess, struct stream *strm, const struct arg *args, const char *kw, struct stkctr *stkctr);
|
|
|
|
struct stkctr *smp_create_src_stkctr(struct session *sess, struct stream *strm, const struct arg *args, const char *kw, struct stkctr *stkctr);
|
2012-04-27 19:37:17 +00:00
|
|
|
int stktable_compatible_sample(struct sample_expr *expr, unsigned long table_type);
|
2014-07-15 14:44:27 +00:00
|
|
|
int stktable_register_data_store(int idx, const char *name, int std_type, int arg_type);
|
2010-06-06 11:34:54 +00:00
|
|
|
int stktable_get_data_type(char *name);
|
2013-09-04 15:54:01 +00:00
|
|
|
int stktable_trash_oldest(struct stktable *t, int to_batch);
|
2017-06-13 17:37:32 +00:00
|
|
|
int __stksess_kill(struct stktable *t, struct stksess *ts);
|
2010-01-04 14:23:48 +00:00
|
|
|
|
2010-07-18 06:04:30 +00:00
|
|
|
/* return allocation size for standard data type <type> */
|
|
|
|
static inline int stktable_type_size(int type)
|
|
|
|
{
|
|
|
|
switch(type) {
|
|
|
|
case STD_T_SINT:
|
|
|
|
case STD_T_UINT:
|
|
|
|
return sizeof(int);
|
|
|
|
case STD_T_ULL:
|
|
|
|
return sizeof(unsigned long long);
|
|
|
|
case STD_T_FRQP:
|
|
|
|
return sizeof(struct freq_ctr_period);
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2010-06-20 07:11:39 +00:00
|
|
|
/* reserve some space for data type <type>, and associate argument at <sa> if
|
|
|
|
* not NULL. Returns PE_NONE (0) if OK or an error code among :
|
|
|
|
* - PE_ENUM_OOR if <type> does not exist
|
|
|
|
* - PE_EXIST if <type> is already registered
|
2010-06-20 08:41:54 +00:00
|
|
|
* - PE_ARG_NOT_USE if <sa> was provided but not expected
|
|
|
|
* - PE_ARG_MISSING if <sa> was expected but not provided
|
2010-06-06 11:34:54 +00:00
|
|
|
*/
|
2010-06-20 07:11:39 +00:00
|
|
|
static inline int stktable_alloc_data_type(struct stktable *t, int type, const char *sa)
|
2010-06-06 11:34:54 +00:00
|
|
|
{
|
|
|
|
if (type >= STKTABLE_DATA_TYPES)
|
2010-06-20 07:11:39 +00:00
|
|
|
return PE_ENUM_OOR;
|
2010-06-06 11:34:54 +00:00
|
|
|
|
|
|
|
if (t->data_ofs[type])
|
|
|
|
/* already allocated */
|
2010-06-20 07:11:39 +00:00
|
|
|
return PE_EXIST;
|
2010-06-06 11:34:54 +00:00
|
|
|
|
2010-06-20 08:41:54 +00:00
|
|
|
switch (stktable_data_types[type].arg_type) {
|
|
|
|
case ARG_T_NONE:
|
|
|
|
if (sa)
|
|
|
|
return PE_ARG_NOT_USED;
|
|
|
|
break;
|
|
|
|
case ARG_T_INT:
|
|
|
|
if (!sa)
|
|
|
|
return PE_ARG_MISSING;
|
|
|
|
t->data_arg[type].i = atoi(sa);
|
|
|
|
break;
|
|
|
|
case ARG_T_DELAY:
|
|
|
|
if (!sa)
|
|
|
|
return PE_ARG_MISSING;
|
|
|
|
sa = parse_time_err(sa, &t->data_arg[type].u, TIME_UNIT_MS);
|
|
|
|
if (sa)
|
|
|
|
return PE_ARG_INVC; /* invalid char */
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
2010-07-18 06:04:30 +00:00
|
|
|
t->data_size += stktable_type_size(stktable_data_types[type].std_type);
|
2010-06-06 11:34:54 +00:00
|
|
|
t->data_ofs[type] = -t->data_size;
|
2010-06-20 07:11:39 +00:00
|
|
|
return PE_NONE;
|
2010-06-06 11:34:54 +00:00
|
|
|
}
|
2010-01-04 14:23:48 +00:00
|
|
|
|
2018-09-20 09:06:33 +00:00
|
|
|
/* return pointer for data type <type> in sticky session <ts> of table <t>, all
|
|
|
|
* of which must exist (otherwise use stktable_data_ptr() if unsure).
|
|
|
|
*/
|
|
|
|
static inline void *__stktable_data_ptr(struct stktable *t, struct stksess *ts, int type)
|
|
|
|
{
|
|
|
|
return (void *)ts + t->data_ofs[type];
|
|
|
|
}
|
|
|
|
|
2010-06-06 14:06:52 +00:00
|
|
|
/* return pointer for data type <type> in sticky session <ts> of table <t>, or
|
|
|
|
* NULL if either <ts> is NULL or the type is not stored.
|
|
|
|
*/
|
|
|
|
static inline void *stktable_data_ptr(struct stktable *t, struct stksess *ts, int type)
|
|
|
|
{
|
|
|
|
if (type >= STKTABLE_DATA_TYPES)
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
if (!t->data_ofs[type]) /* type not stored */
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
if (!ts)
|
|
|
|
return NULL;
|
|
|
|
|
2018-09-20 09:06:33 +00:00
|
|
|
return __stktable_data_ptr(t, ts, type);
|
2010-06-06 14:06:52 +00:00
|
|
|
}
|
|
|
|
|
2010-08-03 18:34:06 +00:00
|
|
|
/* kill an entry if it's expired and its ref_cnt is zero */
|
2017-06-13 17:37:32 +00:00
|
|
|
static inline int __stksess_kill_if_expired(struct stktable *t, struct stksess *ts)
|
2010-08-03 18:34:06 +00:00
|
|
|
{
|
2010-09-23 16:11:05 +00:00
|
|
|
if (t->expire != TICK_ETERNITY && tick_is_expired(ts->expire, now_ms))
|
2017-06-13 17:37:32 +00:00
|
|
|
return __stksess_kill(t, ts);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2017-10-31 14:45:42 +00:00
|
|
|
static inline void stksess_kill_if_expired(struct stktable *t, struct stksess *ts, int decrefcnt)
|
2017-06-13 17:37:32 +00:00
|
|
|
{
|
2017-11-07 09:42:54 +00:00
|
|
|
HA_SPIN_LOCK(STK_TABLE_LOCK, &t->lock);
|
2017-06-13 17:37:32 +00:00
|
|
|
|
|
|
|
if (decrefcnt)
|
|
|
|
ts->ref_cnt--;
|
|
|
|
|
|
|
|
if (t->expire != TICK_ETERNITY && tick_is_expired(ts->expire, now_ms))
|
2017-10-31 14:45:42 +00:00
|
|
|
__stksess_kill_if_expired(t, ts);
|
2017-06-13 17:37:32 +00:00
|
|
|
|
2017-11-07 09:42:54 +00:00
|
|
|
HA_SPIN_UNLOCK(STK_TABLE_LOCK, &t->lock);
|
2010-08-03 18:34:06 +00:00
|
|
|
}
|
|
|
|
|
2015-04-04 14:24:42 +00:00
|
|
|
/* sets the stick counter's entry pointer */
|
|
|
|
static inline void stkctr_set_entry(struct stkctr *stkctr, struct stksess *entry)
|
|
|
|
{
|
|
|
|
stkctr->entry = caddr_from_ptr(entry, 0);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* returns the entry pointer from a stick counter */
|
|
|
|
static inline struct stksess *stkctr_entry(struct stkctr *stkctr)
|
|
|
|
{
|
|
|
|
return caddr_to_ptr(stkctr->entry);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* returns the two flags from a stick counter */
|
|
|
|
static inline unsigned int stkctr_flags(struct stkctr *stkctr)
|
|
|
|
{
|
|
|
|
return caddr_to_data(stkctr->entry);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* sets up to two flags at a time on a composite address */
|
|
|
|
static inline void stkctr_set_flags(struct stkctr *stkctr, unsigned int flags)
|
|
|
|
{
|
|
|
|
stkctr->entry = caddr_set_flags(stkctr->entry, flags);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* returns the two flags from a stick counter */
|
|
|
|
static inline void stkctr_clr_flags(struct stkctr *stkctr, unsigned int flags)
|
|
|
|
{
|
|
|
|
stkctr->entry = caddr_clr_flags(stkctr->entry, flags);
|
|
|
|
}
|
|
|
|
|
2010-01-04 14:23:48 +00:00
|
|
|
#endif /* _PROTO_STICK_TABLE_H */
|