Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 1 | /* |
| 2 | * include/types/stick_table.h |
| 3 | * Macros, variables and structures for stick tables management. |
| 4 | * |
| 5 | * Copyright (C) 2009-2010 EXCELIANCE, Emeric Brun <ebrun@exceliance.fr> |
Willy Tarreau | 08d5f98 | 2010-06-06 13:34:54 +0200 | [diff] [blame] | 6 | * Copyright (C) 2010 Willy Tarreau <w@1wt.eu> |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 7 | * |
| 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 _TYPES_STICK_TABLE_H |
| 24 | #define _TYPES_STICK_TABLE_H |
| 25 | |
| 26 | #include <sys/socket.h> |
| 27 | #include <netinet/in.h> |
| 28 | |
| 29 | #include <ebtree.h> |
| 30 | #include <ebmbtree.h> |
| 31 | #include <eb32tree.h> |
| 32 | #include <common/memory.h> |
| 33 | |
| 34 | /* stick table key types */ |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 35 | enum { |
| 36 | STKTABLE_TYPE_IP = 0, /* table key is ipv4 */ |
| 37 | STKTABLE_TYPE_INTEGER, /* table key is unsigned 32bit integer */ |
| 38 | STKTABLE_TYPE_STRING, /* table key is a null terminated string */ |
| 39 | STKTABLE_TYPES /* Number of types, must always be last */ |
| 40 | }; |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 41 | |
Willy Tarreau | 08d5f98 | 2010-06-06 13:34:54 +0200 | [diff] [blame] | 42 | /* The types of extra data we can store in a stick table */ |
| 43 | enum { |
Willy Tarreau | 69b870f | 2010-06-06 14:30:13 +0200 | [diff] [blame] | 44 | STKTABLE_DT_CONN_CUM, /* cumulated number of connections */ |
Willy Tarreau | 08d5f98 | 2010-06-06 13:34:54 +0200 | [diff] [blame] | 45 | STKTABLE_DATA_TYPES /* Number of data types, must always be last */ |
| 46 | }; |
| 47 | |
| 48 | /* stick_table extra data. This is mainly used for casting or size computation */ |
| 49 | union stktable_data { |
Willy Tarreau | 69b870f | 2010-06-06 14:30:13 +0200 | [diff] [blame] | 50 | unsigned int conn_cum; |
Willy Tarreau | 08d5f98 | 2010-06-06 13:34:54 +0200 | [diff] [blame] | 51 | }; |
| 52 | |
| 53 | #define stktable_data_size(type) (sizeof(((union stktable_data*)0)->type)) |
| 54 | #define stktable_data_cast(ptr, type) ((union stktable_data*)(ptr))->type |
| 55 | |
| 56 | /* known data types */ |
| 57 | struct stktable_data_type { |
| 58 | const char *name; /* name of the data type */ |
| 59 | int data_length; /* length of this type, or 0 if variable (eg: string) */ |
| 60 | }; |
| 61 | |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 62 | /* stick table key type flags */ |
| 63 | #define STK_F_CUSTOM_KEYSIZE 0x00000001 /* this table's key size is configurable */ |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 64 | |
| 65 | /* stick table keyword type */ |
| 66 | struct stktable_type { |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 67 | const char *kw; /* keyword string */ |
| 68 | int flags; /* type flags */ |
| 69 | size_t default_size; /* default key size */ |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 70 | }; |
| 71 | |
Willy Tarreau | 393379c | 2010-06-06 12:11:37 +0200 | [diff] [blame] | 72 | /* Sticky session. |
| 73 | * Any additional data related to the stuck session is installed *before* |
| 74 | * stksess (with negative offsets). This allows us to run variable-sized |
| 75 | * keys and variable-sized data without making use of intermediate pointers. |
| 76 | */ |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 77 | struct stksess { |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 78 | int sid; /* id of server to use for this session */ |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 79 | unsigned int expire; /* session expiration date */ |
Willy Tarreau | 86257dc | 2010-06-06 12:57:10 +0200 | [diff] [blame] | 80 | struct eb32_node exp; /* ebtree node used to hold the session in expiration tree */ |
| 81 | struct ebmb_node key; /* ebtree node used to hold the session in table */ |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 82 | /* WARNING! do not put anything after <keys>, it's used by the key */ |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 83 | }; |
| 84 | |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 85 | /* stick table */ |
| 86 | struct stktable { |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 87 | struct eb_root keys; /* head of sticky session tree */ |
| 88 | struct eb_root exps; /* head of sticky session expiration tree */ |
| 89 | struct pool_head *pool; /* pool used to allocate sticky sessions */ |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 90 | struct task *exp_task; /* expiration task */ |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 91 | unsigned long type; /* type of table (determines key format) */ |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 92 | size_t key_size; /* size of a key, maximum size in case of string */ |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 93 | unsigned int size; /* maximum number of sticky sessions in table */ |
| 94 | unsigned int current; /* number of sticky sessions currently in table */ |
| 95 | int nopurge; /* if non-zero, don't purge sticky sessions when full */ |
| 96 | int exp_next; /* next expiration date (ticks) */ |
| 97 | int expire; /* time to live for sticky sessions (milliseconds) */ |
Willy Tarreau | 393379c | 2010-06-06 12:11:37 +0200 | [diff] [blame] | 98 | int data_size; /* the size of the data that is prepended *before* stksess */ |
Willy Tarreau | 08d5f98 | 2010-06-06 13:34:54 +0200 | [diff] [blame] | 99 | int data_ofs[STKTABLE_DATA_TYPES]; /* negative offsets of present data types, or 0 if absent */ |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 100 | }; |
| 101 | |
Willy Tarreau | 08d5f98 | 2010-06-06 13:34:54 +0200 | [diff] [blame] | 102 | struct stktable_data_type stktable_data_types[STKTABLE_DATA_TYPES]; |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 103 | |
Emeric Brun | 3bd697e | 2010-01-04 15:23:48 +0100 | [diff] [blame] | 104 | /* stick table key data */ |
| 105 | union stktable_key_data { |
| 106 | struct in_addr ip; /* used to store an ip key */ |
| 107 | uint32_t integer; /* used to store an integer key */ |
| 108 | char buf[BUFSIZE]; /* used to store a null terminated string key */ |
| 109 | }; |
| 110 | |
| 111 | /* stick table key */ |
| 112 | struct stktable_key { |
| 113 | void *key; /* pointer on key buffer */ |
| 114 | size_t key_len; /* data len to read in buff in case of null terminated string */ |
| 115 | union stktable_key_data data; /* data */ |
| 116 | }; |
| 117 | |
| 118 | #endif /* _TYPES_STICK_TABLE_H */ |
| 119 | |