src/plugins/nat/nat64_db.h

   1 /*
   2  * Copyright (c) 2017 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 NAT64 DB
  18  */
  19 #ifndef __included_nat64_db_h__
  20 #define __included_nat64_db_h__
  21
  22 #include <vppinfra/bihash_24_8.h>
  23 #include <vppinfra/bihash_48_8.h>
  24 #include <nat/nat.h>
  25
  26
  27 typedef struct
  28 {
  29   union
  30   {
  31     struct
  32     {
  33       ip46_address_t addr;
  34       u32 fib_index;
  35       u16 port;
  36       u8 proto;
  37       u8 rsvd;
  38     };
  39     u64 as_u64[3];
  40   };
  41 } nat64_db_bib_entry_key_t;
  42
  43 /* *INDENT-OFF* */
  44 typedef CLIB_PACKED(struct
  45 {
  46   ip6_address_t in_addr;
  47   u16 in_port;
  48   ip4_address_t out_addr;
  49   u16 out_port;
  50   u32 fib_index;
  51   u32 ses_num;
  52   u8 proto;
  53   u8 is_static;
  54 }) nat64_db_bib_entry_t;
  55 /* *INDENT-ON* */
  56
  57 typedef struct
  58 {
  59   /* BIBs */
  60 /* *INDENT-OFF* */
  61 #define _(N, i, n, s) \
  62   nat64_db_bib_entry_t *_##n##_bib;
  63   foreach_snat_protocol
  64 #undef _
  65 /* *INDENT-ON* */
  66   nat64_db_bib_entry_t *_unk_proto_bib;
  67
  68   /* BIB lookup */
  69   clib_bihash_24_8_t in2out;
  70   clib_bihash_24_8_t out2in;
  71 } nat64_db_bib_t;
  72
  73 typedef struct
  74 {
  75   union
  76   {
  77     struct
  78     {
  79       ip46_address_t l_addr;
  80       ip46_address_t r_addr;
  81       u32 fib_index;
  82       u16 l_port;
  83       u16 r_port;
  84       u8 proto;
  85       u8 rsvd[7];
  86     };
  87     u64 as_u64[6];
  88   };
  89 } nat64_db_st_entry_key_t;
  90
  91 /* *INDENT-OFF* */
  92 typedef CLIB_PACKED(struct
  93 {
  94   ip6_address_t in_r_addr;
  95   ip4_address_t out_r_addr;
  96   u16 r_port;
  97   u32 bibe_index;
  98   u32 expire;
  99   u8 proto;
 100   u8 tcp_state;
 101 }) nat64_db_st_entry_t;
 102 /* *INDENT-ON* */
 103
 104 typedef struct
 105 {
 106   /* session tables */
 107 /* *INDENT-OFF* */
 108 #define _(N, i, n, s) \
 109   nat64_db_st_entry_t *_##n##_st;
 110   foreach_snat_protocol
 111 #undef _
 112 /* *INDENT-ON* */
 113   nat64_db_st_entry_t *_unk_proto_st;
 114
 115   /* session lookup */
 116   clib_bihash_48_8_t in2out;
 117   clib_bihash_48_8_t out2in;
 118 } nat64_db_st_t;
 119
 120 typedef struct
 121 {
 122   nat64_db_bib_t bib;
 123   nat64_db_st_t st;
 124 } nat64_db_t;
 125
 126 /**
 127  * @brief Initialize NAT64 DB.
 128  *
 129  * @param db NAT64 DB.
 130  * @param bib_buckets Number of BIB hash buckets.
 131  * @param bib_memory_size Memory size of BIB hash.
 132  * @param st_buckets Number of session table hash buckets.
 133  * @param st_memory_size Memory size of session table hash.
 134  *
 135  * @returns 0 on success, non-zero value otherwise.
 136  */
 137 int nat64_db_init (nat64_db_t * db, u32 bib_buckets, u32 bib_memory_size,
 138                    u32 st_buckets, u32 st_memory_size);
 139
 140 /**
 141  * @brief Create new NAT64 BIB entry.
 142  *
 143  * @param db NAT64 DB.
 144  * @param in_addr Inside IPv6 address.
 145  * @param out_addr Outside IPv4 address.
 146  * @param in_port Inside port number.
 147  * @param out_port Outside port number.
 148  * @param fib_index FIB index.
 149  * @param proto L4 protocol.
 150  * @param is_static 1 if static, 0 if dynamic.
 151  *
 152  * @returns BIB entry on success, 0 otherwise.
 153  */
 154 nat64_db_bib_entry_t *nat64_db_bib_entry_create (nat64_db_t * db,
 155                                                  ip6_address_t * in_addr,
 156                                                  ip4_address_t * out_addr,
 157                                                  u16 in_port, u16 out_port,
 158                                                  u32 fib_index,
 159                                                  u8 proto, u8 is_static);
 160
 161 /**
 162  * @brief Free NAT64 BIB entry.
 163  *
 164  * @param db NAT64 DB.
 165  * @param bibe BIB entry.
 166  */
 167 void nat64_db_bib_entry_free (nat64_db_t * db, nat64_db_bib_entry_t * bibe);
 168
 169 /**
 170  * @brief Call back function when walking NAT64 BIB, non-zero
 171  * return value stop walk.
 172  */
 173 typedef int (*nat64_db_bib_walk_fn_t) (nat64_db_bib_entry_t * bibe,
 174                                        void *ctx);
 175 /**
 176  * @brief Walk NAT64 BIB.
 177  *
 178  * @param db NAT64 DB.
 179  * @param proto BIB L4 protocol:
 180  *  - 255 all BIBs
 181  *  - 6 TCP BIB
 182  *  - 17 UDP BIB
 183  *  - 1/58 ICMP BIB
 184  *  - otherwise "unknown" protocol BIB
 185  * @param fn The function to invoke on each entry visited.
 186  * @param ctx A context passed in the visit function.
 187  */
 188 void nat64_db_bib_walk (nat64_db_t * db, u8 proto,
 189                         nat64_db_bib_walk_fn_t fn, void *ctx);
 190
 191 /**
 192  * @brief Find NAT64 BIB entry.
 193  *
 194  * @param db NAT64 DB.
 195  * @param addr IP address.
 196  * @param port Port number.
 197  * @param proto L4 protocol.
 198  * @param fib_index FIB index.
 199  * @param is_ip6 1 if find by IPv6 (inside) address, 0 by IPv4 (outside).
 200  *
 201  * @return BIB entry if found.
 202  */
 203 nat64_db_bib_entry_t *nat64_db_bib_entry_find (nat64_db_t * db,
 204                                                ip46_address_t * addr,
 205                                                u16 port,
 206                                                u8 proto,
 207                                                u32 fib_index, u8 is_ip6);
 208
 209 /**
 210  * @brief Get BIB entry by index and protocol.
 211  *
 212  * @param db NAT64 DB.
 213  * @param proto L4 protocol.
 214  * @param bibe_index BIB entry index.
 215  *
 216  * @return BIB entry if found.
 217  */
 218 nat64_db_bib_entry_t *nat64_db_bib_entry_by_index (nat64_db_t * db,
 219                                                    u8 proto, u32 bibe_index);
 220 /**
 221  * @brief Create new NAT64 session table entry.
 222  *
 223  * @param db NAT64 DB.
 224  * @param bibe Corresponding BIB entry.
 225  * @param in_r_addr Inside IPv6 address of the remote host.
 226  * @param out_r_addr Outside IPv4 address of the remote host.
 227  * @param r_port Remote host port number.
 228  *
 229  * @returns BIB entry on success, 0 otherwise.
 230  */
 231 nat64_db_st_entry_t *nat64_db_st_entry_create (nat64_db_t * db,
 232                                                nat64_db_bib_entry_t * bibe,
 233                                                ip6_address_t * in_r_addr,
 234                                                ip4_address_t * out_r_addr,
 235                                                u16 r_port);
 236
 237 /**
 238  * @brief Free NAT64 session table entry.
 239  *
 240  * @param db NAT64 DB.
 241  * @param ste Session table entry.
 242  */
 243 void nat64_db_st_entry_free (nat64_db_t * db, nat64_db_st_entry_t * ste);
 244
 245 /**
 246  * @brief Find NAT64 session table entry.
 247  *
 248  * @param db NAT64 DB.
 249  * @param l_addr Local host address.
 250  * @param r_addr Remote host address.
 251  * @param l_port Local host port number.
 252  * @param r_port Remote host port number.
 253  * @param proto L4 protocol.
 254  * @param fib_index FIB index.
 255  * @param is_ip6 1 if find by IPv6 (inside) address, 0 by IPv4 (outside).
 256  *
 257  * @return BIB entry if found.
 258  */
 259 nat64_db_st_entry_t *nat64_db_st_entry_find (nat64_db_t * db,
 260                                              ip46_address_t * l_addr,
 261                                              ip46_address_t * r_addr,
 262                                              u16 l_port, u16 r_port,
 263                                              u8 proto,
 264                                              u32 fib_index, u8 is_ip6);
 265
 266 /**
 267  * @brief Call back function when walking NAT64 session table, non-zero
 268  * return value stop walk.
 269  */
 270 typedef int (*nat64_db_st_walk_fn_t) (nat64_db_st_entry_t * ste, void *ctx);
 271
 272 /**
 273  * @brief Walk NAT64 session table.
 274  *
 275  * @param db NAT64 DB.
 276  * @param proto L4 protocol:
 277  *  - 255 all session tables
 278  *  - 6 TCP session table
 279  *  - 17 UDP session table
 280  *  - 1/58 ICMP session table
 281  *  - otherwise "unknown" protocol session table
 282  * @param fn The function to invoke on each entry visited.
 283  * @param ctx A context passed in the visit function.
 284  */
 285 void nat64_db_st_walk (nat64_db_t * db, u8 proto,
 286                        nat64_db_st_walk_fn_t fn, void *ctx);
 287
 288 /**
 289  * @brief Free expired session entries in session tables.
 290  *
 291  * @param db NAT64 DB.
 292  * @param now Current time.
 293  */
 294 void nad64_db_st_free_expired (nat64_db_t * db, u32 now);
 295
 296 /**
 297  * @brief Free sessions using specific outside address.
 298  *
 299  * @param db NAT64 DB.
 300  * @param out_addr Outside address to match.
 301  */
 302 void nat64_db_free_out_addr (nat64_db_t * db, ip4_address_t * out_addr);
 303
 304 /*
 305  * @brief Get ST entry index.
 306  *
 307  * @param db NAT64 DB.
 308  * @param ste ST entry.
 309  *
 310  * @return ST entry index on success, ~0 otherwise.
 311  */
 312 u32 nat64_db_st_entry_get_index (nat64_db_t * db, nat64_db_st_entry_t * ste);
 313
 314 /**
 315  * @brief Get ST entry by index and protocol.
 316  *
 317  * @param db NAT64 DB.
 318  * @param proto L4 protocol.
 319  * @param bibe_index ST entry index.
 320  *
 321  * @return BIB entry if found.
 322  */
 323 nat64_db_st_entry_t *nat64_db_st_entry_by_index (nat64_db_t * db,
 324                                                  u8 proto, u32 ste_index);
 325 #endif /* __included_nat64_db_h__ */
 326
 327 /*
 328  * fd.io coding-style-patch-verification: ON
 329  *
 330  * Local Variables:
 331  * eval: (c-set-style "gnu")
 332  * End:
 333  */