2 * Copyright (c) 2020 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __CNAT_TRANSLATION_H__
17 #define __CNAT_TRANSLATION_H__
19 #include <cnat/cnat_types.h>
20 #include <vnet/ip/ip_types.h>
21 #include <vppinfra/bihash_8_8.h>
24 * Counters for each translation
26 extern vlib_combined_counter_main_t cnat_translation_counters;
29 * Data used to track an EP in the FIB
31 typedef struct cnat_ep_trk_t_
34 * The EP being tracked
36 cnat_endpoint_t ct_ep[VLIB_N_DIR];
39 * The FIB entry for the EP
41 fib_node_index_t ct_fei;
44 * The sibling on the entry's child list
49 * The forwarding contributed by the entry
54 * Allows to disable if not resolved yet
59 typedef enum cnat_translation_flag_t_
61 /* Do allocate a source port */
62 CNAT_TRANSLATION_FLAG_ALLOCATE_PORT = (1 << 0),
63 /* Has this translation been satcked ?
64 * this allow not being called twice when
65 * with more then FIB_PATH_LIST_POPULAR backends */
66 CNAT_TRANSLATION_STACKED = (1 << 1),
67 } cnat_translation_flag_t;
72 CNAT_RESOLV_ADDR_BACKEND,
73 CNAT_RESOLV_ADDR_SNAT,
74 CNAT_RESOLV_ADDR_TRANSLATION,
75 CNAT_ADDR_N_RESOLUTIONS,
76 } cnat_addr_resol_type_t;
79 * Entry used to account for a translation's backend
80 * waiting for address resolution
82 typedef struct addr_resolution_t_
85 * The interface index to resolve
89 * ip4 or ip6 resolution
91 ip_address_family_t af;
93 * The cnat_addr_resolution_t
95 cnat_addr_resol_type_t type;
107 * A Translation represents the translation of a VEP to one of a set
108 * of real server addresses
110 typedef struct cnat_translation_t_
113 * Linkage into the FIB graph
118 * The LB used to forward to the backends
123 * The Virtual end point
125 cnat_endpoint_t ct_vip;
128 * The vector of tracked back-ends
130 cnat_ep_trk_t *ct_paths;
133 * The ip protocol for the translation
135 ip_protocol_t ct_proto;
138 * The client object this translation belongs on
139 * INDEX_INVALID if vip is unresolved
144 * Own index (if copied for trace)
152 } cnat_translation_t;
154 extern cnat_translation_t *cnat_translation_pool;
156 extern u8 *format_cnat_translation (u8 * s, va_list * args);
159 * create or update a translation
161 * @param vip The Virtual Endpoint
162 * @param ip_proto The ip protocol to translate
163 * @param backends the backends to choose from
165 * @return the ID of the translation. used to delete and gather stats
167 extern u32 cnat_translation_update (cnat_endpoint_t * vip,
168 ip_protocol_t ip_proto,
169 cnat_endpoint_tuple_t *
173 * Delete a translation
175 * @param id the ID as returned from the create
177 extern int cnat_translation_delete (u32 id);
180 * Callback function invoked during a walk of all translations
182 typedef walk_rc_t (*cnat_translation_walk_cb_t) (index_t index, void *ctx);
185 * Walk/visit each of the translations
187 extern void cnat_translation_walk (cnat_translation_walk_cb_t cb, void *ctx);
190 * Purge all the trahslations
192 extern int cnat_translation_purge (void);
195 * Add an address resolution request
197 extern void cnat_translation_watch_addr (index_t cti, u64 opaque,
198 cnat_endpoint_t * ep,
199 cnat_addr_resol_type_t type);
202 * Cleanup matching addr resolution requests
204 extern void cnat_translation_unwatch_addr (u32 cti,
205 cnat_addr_resol_type_t type);
208 * Data plane functions
210 extern clib_bihash_8_8_t cnat_translation_db;
212 static_always_inline cnat_translation_t *
213 cnat_translation_get (index_t cti)
215 return (pool_elt_at_index (cnat_translation_pool, cti));
218 static_always_inline cnat_translation_t *
219 cnat_find_translation (index_t cti, u16 port, ip_protocol_t proto)
221 clib_bihash_kv_8_8_t bkey, bvalue;
225 key = ((u64) proto << 24) | port;
226 key = key << 32 | (u32) cti;
229 rv = clib_bihash_search_inline_2_8_8 (&cnat_translation_db, &bkey, &bvalue);
231 return (pool_elt_at_index (cnat_translation_pool, bvalue.value));
237 * fd.io coding-style-patch-verification: ON
240 * eval: (c-set-style "gnu")