FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
nat_affinity.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /**
16  * @file
17  * @brief NAT plugin client-IP based session affinity for load-balancing
18  */
19 
20 #ifndef __included_nat_affinity_h__
21 #define __included_nat_affinity_h__
22 
23 #include <vnet/ip/ip.h>
24 #include <vppinfra/bihash_16_8.h>
25 #include <vppinfra/dlist.h>
26 
27 typedef struct
28 {
29  union
30  {
31  struct
32  {
35  /* align by making this 4 octets even though its a 1 octet field */
37  /* align by making this 4 octets even though its a 2 octets field */
39  };
40  u64 as_u64[2];
41  };
43 
44 /* *INDENT-OFF* */
45 typedef CLIB_PACKED(struct
46 {
48  u32 sticky_time;
49  u32 ref_cnt;
50  u32 per_service_index;
51  u8 backend_index;
52  f64 expire;
53 }) nat_affinity_t;
54 /* *INDENT-ON* */
55 
56 typedef struct
57 {
58  nat_affinity_t *affinity_pool;
59  clib_bihash_16_8_t affinity_hash;
64 
66 
67 /**
68  * @brief Get new affinity per service list head index.
69  *
70  * @returns new affinity per service list head index.
71  */
73 
74 /**
75  * @brief Flush all service affinity data.
76  *
77  * @param affinity_per_service_list_head_index Per sevice list head index.
78  */
79 void nat_affinity_flush_service (u32 affinity_per_service_list_head_index);
80 
81 /**
82  * @brief Initialize NAT client-IP based affinity.
83  *
84  * @param vm vlib main.
85  *
86  * @return error code.
87  */
89 
90 /**
91  * @brief Find service backend index for client-IP and take a reference
92  * counting lock.
93  *
94  * @param client_addr Client IP address.
95  * @param service_addr Service IP address.
96  * @param proto IP protocol number.
97  * @param service_port Service L4 port number.
98  * @param backend_index Service backend index for client-IP if found.
99  *
100  * @return 0 on success, non-zero value otherwise.
101  */
103  ip4_address_t service_addr, u8 proto,
104  u16 service_port, u8 * backend_index);
105 
106 /**
107  * @brief Create affinity record and take reference counting lock.
108  * @param client_addr Client IP address.
109  * @param service_addr Service IP address.
110  * @param proto IP protocol number.
111  * @param service_port Service L4 port number.
112  * @param backend_index Service backend index for client-IP.
113  * @param sticky_time Affinity sticky time in seconds.
114  * @param affinity_per_service_list_head_index Per sevice list head index.
115  *
116  * @return 0 on success, non-zero value otherwise.
117  */
119  ip4_address_t service_addr, u8 proto,
120  u16 service_port, u8 backend_index,
121  u32 sticky_time,
122  u32 affinity_per_service_list_head_index);
123 /**
124  * @brief Release a reference counting lock for affinity.
125  *
126  * @param client_addr Client IP address.
127  * @param service_addr Service IP address.
128  * @param proto IP protocol number.
129  */
130 void nat_affinity_unlock (ip4_address_t client_addr,
131  ip4_address_t service_addr, u8 proto,
132  u16 service_port);
133 
134 #endif /* __included_nat_affinity_h__ */
135 
136 /*
137  * fd.io coding-style-patch-verification: ON
138  *
139  * Local Variables:
140  * eval: (c-set-style "gnu")
141  * End:
142  */
int nat_affinity_create_and_lock(ip4_address_t client_addr, ip4_address_t service_addr, u8 proto, u16 service_port, u8 backend_index, u32 sticky_time, u32 affinity_per_service_list_head_index)
Create affinity record and take reference counting lock.
Definition: nat_affinity.c:191
ip4_address_t client_addr
Definition: nat_affinity.h:34
u64 as_u64
Definition: bihash_doc.h:63
unsigned long u64
Definition: types.h:89
dlist_elt_t * list_pool
Definition: nat_affinity.h:61
void nat_affinity_unlock(ip4_address_t client_addr, ip4_address_t service_addr, u8 proto, u16 service_port)
Release a reference counting lock for affinity.
Definition: nat_affinity.c:242
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
ip4_address_t service_addr
Definition: nat_affinity.h:33
clib_bihash_16_8_t affinity_hash
Definition: nat_affinity.h:59
vlib_main_t * vlib_main
Definition: nat_affinity.h:62
unsigned int u32
Definition: types.h:88
nat_affinity_main_t nat_affinity_main
Definition: nat_affinity.c:23
clib_spinlock_t affinity_lock
Definition: nat_affinity.h:60
void nat_affinity_flush_service(u32 affinity_per_service_list_head_index)
Flush all service affinity data.
Definition: nat_affinity.c:97
unsigned short u16
Definition: types.h:57
nat_affinity_t * affinity_pool
Definition: nat_affinity.h:58
vlib_main_t * vm
Definition: buffer.c:294
u32 nat_affinity_get_per_service_list_head_index(void)
Get new affinity per service list head index.
Definition: nat_affinity.c:81
clib_error_t * nat_affinity_init(vlib_main_t *vm)
Initialize NAT client-IP based affinity.
Definition: nat_affinity.c:47
typedef CLIB_PACKED(struct{nat_affinity_key_t key;u32 sticky_time;u32 ref_cnt;u32 per_service_index;u8 backend_index;f64 expire;}) nat_affinity_t
int nat_affinity_find_and_lock(ip4_address_t client_addr, ip4_address_t service_addr, u8 proto, u16 service_port, u8 *backend_index)
Find service backend index for client-IP and take a reference counting lock.
Definition: nat_affinity.c:127