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  *
 131  * @returns 0 on success, non-zero value otherwise.
 132  */
 133 int nat64_db_init (nat64_db_t * db);
 134
 135 /**
 136  * @brief Create new NAT64 BIB entry.
 137  *
 138  * @param db NAT64 DB.
 139  * @param in_addr Inside IPv6 address.
 140  * @param out_addr Outside IPv4 address.
 141  * @param in_port Inside port number.
 142  * @param out_port Outside port number.
 143  * @param fib_index FIB index.
 144  * @param proto L4 protocol.
 145  * @param is_static 1 if static, 0 if dynamic.
 146  *
 147  * @returns BIB entry on success, 0 otherwise.
 148  */
 149 nat64_db_bib_entry_t *nat64_db_bib_entry_create (nat64_db_t * db,
 150                                                  ip6_address_t * in_addr,
 151                                                  ip4_address_t * out_addr,
 152                                                  u16 in_port, u16 out_port,
 153                                                  u32 fib_index,
 154                                                  u8 proto, u8 is_static);
 155
 156 /**
 157  * @brief Free NAT64 BIB entry.
 158  *
 159  * @param db NAT64 DB.
 160  * @param bibe BIB entry.
 161  */
 162 void nat64_db_bib_entry_free (nat64_db_t * db, nat64_db_bib_entry_t * bibe);
 163
 164 /**
 165  * @brief Call back function when walking NAT64 BIB, non-zero
 166  * return value stop walk.
 167  */
 168 typedef int (*nat64_db_bib_walk_fn_t) (nat64_db_bib_entry_t * bibe,
 169                                        void *ctx);
 170 /**
 171  * @brief Walk NAT64 BIB.
 172  *
 173  * @param db NAT64 DB.
 174  * @param proto BIB L4 protocol:
 175  *  - 255 all BIBs
 176  *  - 6 TCP BIB
 177  *  - 17 UDP BIB
 178  *  - 1/58 ICMP BIB
 179  *  - otherwise "unknown" protocol BIB
 180  * @param fn The function to invoke on each entry visited.
 181  * @param ctx A context passed in the visit function.
 182  */
 183 void nat64_db_bib_walk (nat64_db_t * db, u8 proto,
 184                         nat64_db_bib_walk_fn_t fn, void *ctx);
 185
 186 /**
 187  * @brief Find NAT64 BIB entry.
 188  *
 189  * @param db NAT64 DB.
 190  * @param addr IP address.
 191  * @param port Port number.
 192  * @param proto L4 protocol.
 193  * @param fib_index FIB index.
 194  * @param is_ip6 1 if find by IPv6 (inside) address, 0 by IPv4 (outside).
 195  *
 196  * @return BIB entry if found.
 197  */
 198 nat64_db_bib_entry_t *nat64_db_bib_entry_find (nat64_db_t * db,
 199                                                ip46_address_t * addr,
 200                                                u16 port,
 201                                                u8 proto,
 202                                                u32 fib_index, u8 is_ip6);
 203
 204 /**
 205  * @brief Get BIB entry by index and protocol.
 206  *
 207  * @param db NAT64 DB.
 208  * @param proto L4 protocol.
 209  * @param bibe_index BIB entry index.
 210  *
 211  * @return BIB entry if found.
 212  */
 213 nat64_db_bib_entry_t *nat64_db_bib_entry_by_index (nat64_db_t * db,
 214                                                    u8 proto, u32 bibe_index);
 215 /**
 216  * @brief Create new NAT64 session table entry.
 217  *
 218  * @param db NAT64 DB.
 219  * @param bibe Corresponding BIB entry.
 220  * @param in_r_addr Inside IPv6 address of the remote host.
 221  * @param out_r_addr Outside IPv4 address of the remote host.
 222  * @param r_port Remote host port number.
 223  *
 224  * @returns BIB entry on success, 0 otherwise.
 225  */
 226 nat64_db_st_entry_t *nat64_db_st_entry_create (nat64_db_t * db,
 227                                                nat64_db_bib_entry_t * bibe,
 228                                                ip6_address_t * in_r_addr,
 229                                                ip4_address_t * out_r_addr,
 230                                                u16 r_port);
 231
 232 /**
 233  * @brief Free NAT64 session table entry.
 234  *
 235  * @param db NAT64 DB.
 236  * @param ste Session table entry.
 237  */
 238 void nat64_db_st_entry_free (nat64_db_t * db, nat64_db_st_entry_t * ste);
 239
 240 /**
 241  * @brief Find NAT64 session table entry.
 242  *
 243  * @param db NAT64 DB.
 244  * @param l_addr Local host address.
 245  * @param r_addr Remote host address.
 246  * @param l_port Local host port number.
 247  * @param r_port Remote host port number.
 248  * @param proto L4 protocol.
 249  * @param fib_index FIB index.
 250  * @param is_ip6 1 if find by IPv6 (inside) address, 0 by IPv4 (outside).
 251  *
 252  * @return BIB entry if found.
 253  */
 254 nat64_db_st_entry_t *nat64_db_st_entry_find (nat64_db_t * db,
 255                                              ip46_address_t * l_addr,
 256                                              ip46_address_t * r_addr,
 257                                              u16 l_port, u16 r_port,
 258                                              u8 proto,
 259                                              u32 fib_index, u8 is_ip6);
 260
 261 /**
 262  * @brief Call back function when walking NAT64 session table, non-zero
 263  * return value stop walk.
 264  */
 265 typedef int (*nat64_db_st_walk_fn_t) (nat64_db_st_entry_t * ste, void *ctx);
 266
 267 /**
 268  * @brief Walk NAT64 session table.
 269  *
 270  * @param db NAT64 DB.
 271  * @param proto L4 protocol:
 272  *  - 255 all session tables
 273  *  - 6 TCP session table
 274  *  - 17 UDP session table
 275  *  - 1/58 ICMP session table
 276  *  - otherwise "unknown" protocol session table
 277  * @param fn The function to invoke on each entry visited.
 278  * @param ctx A context passed in the visit function.
 279  */
 280 void nat64_db_st_walk (nat64_db_t * db, u8 proto,
 281                        nat64_db_st_walk_fn_t fn, void *ctx);
 282
 283 /**
 284  * @brief Free expired session entries in session tables.
 285  *
 286  * @param db NAT64 DB.
 287  * @param now Current time.
 288  */
 289 void nad64_db_st_free_expired (nat64_db_t * db, u32 now);
 290
 291 /**
 292  * @brief Free sessions using specific outside address.
 293  *
 294  * @param db NAT64 DB.
 295  * @param out_addr Outside address to match.
 296  */
 297 void nat64_db_free_out_addr (nat64_db_t * db, ip4_address_t * out_addr);
 298
 299 #endif /* __included_nat64_db_h__ */
 300
 301 /*
 302  * fd.io coding-style-patch-verification: ON
 303  *
 304  * Local Variables:
 305  * eval: (c-set-style "gnu")
 306  * End:
 307  */