src/plugins/nat/lib/lib.h

   1 /*
   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:
   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 port/address allocation lib
  18  */
  19 #ifndef included_nat_lib_h__
  20 #define included_nat_lib_h__
  21
  22 #include <vlibapi/api.h>
  23
  24 /* NAT API Configuration flags */
  25 #define foreach_nat_config_flag \
  26   _(0x01, IS_TWICE_NAT)         \
  27   _(0x02, IS_SELF_TWICE_NAT)    \
  28   _(0x04, IS_OUT2IN_ONLY)       \
  29   _(0x08, IS_ADDR_ONLY)         \
  30   _(0x10, IS_OUTSIDE)           \
  31   _(0x20, IS_INSIDE)            \
  32   _(0x40, IS_STATIC)            \
  33   _(0x80, IS_EXT_HOST_VALID)
  34
  35 typedef enum nat_config_flags_t_
  36 {
  37 #define _(n,f) NAT_API_##f = n,
  38   foreach_nat_config_flag
  39 #undef _
  40 } nat_config_flags_t;
  41
  42 #define foreach_nat_counter _ (tcp) _ (udp) _ (icmp) _ (other) _ (drops)
  43
  44 #define foreach_nat_error                      \
  45   _ (VALUE_EXIST, -1, "Value already exists")  \
  46   _ (NO_SUCH_ENTRY, -2, "No such entry")       \
  47   _ (UNKNOWN_PROTOCOL, -3, "Unknown protocol") \
  48   _ (OUT_OF_TRANSLATIONS, -4, "Out of translations")
  49
  50 typedef enum
  51 {
  52 #define _(N, i, s) NAT_ERROR_##N = i,
  53   foreach_nat_error
  54 #undef _
  55 } nat_error_t;
  56
  57 #define foreach_nat_protocol   \
  58   _ (OTHER, 0, other, "other") \
  59   _ (UDP, 1, udp, "udp")       \
  60   _ (TCP, 2, tcp, "tcp")       \
  61   _ (ICMP, 3, icmp, "icmp")
  62
  63 typedef enum
  64 {
  65 #define _(N, i, n, s) NAT_PROTOCOL_##N = i,
  66   foreach_nat_protocol
  67 #undef _
  68 } nat_protocol_t;
  69
  70 /* default protocol timeouts */
  71 #define NAT_UDP_TIMEOUT 300
  72 #define NAT_TCP_TRANSITORY_TIMEOUT 240
  73 #define NAT_TCP_ESTABLISHED_TIMEOUT 7440
  74 #define NAT_ICMP_TIMEOUT 60
  75
  76 typedef struct
  77 {
  78   struct
  79   {
  80     u32 established;
  81     u32 transitory;
  82   } tcp;
  83
  84   u32 udp;
  85   u32 icmp;
  86
  87 } nat_timeouts_t;
  88
  89 static_always_inline void
  90 nat_reset_timeouts (nat_timeouts_t * timeouts)
  91 {
  92   timeouts->udp = NAT_UDP_TIMEOUT;
  93   timeouts->tcp.established = NAT_TCP_ESTABLISHED_TIMEOUT;
  94   timeouts->tcp.transitory = NAT_TCP_TRANSITORY_TIMEOUT;
  95   timeouts->icmp = NAT_ICMP_TIMEOUT;
  96 }
  97
  98 static_always_inline u32
  99 nat_session_get_timeout (nat_timeouts_t *timeouts, nat_protocol_t proto,
 100                          u8 state)
 101 {
 102   switch (proto)
 103     {
 104     case NAT_PROTOCOL_ICMP:
 105       return timeouts->icmp;
 106     case NAT_PROTOCOL_UDP:
 107       return timeouts->udp;
 108     case NAT_PROTOCOL_TCP:
 109       {
 110         if (state)
 111           return timeouts->tcp.transitory;
 112         else
 113           return timeouts->tcp.established;
 114       }
 115     default:
 116       return timeouts->udp;
 117     }
 118   return 0;
 119 }
 120
 121 static_always_inline u32
 122 nat_calc_bihash_buckets (u32 n_elts)
 123 {
 124   n_elts = n_elts / 2.5;
 125   u64 lower_pow2 = 1;
 126   while (lower_pow2 * 2 < n_elts)
 127     {
 128       lower_pow2 = 2 * lower_pow2;
 129     }
 130   u64 upper_pow2 = 2 * lower_pow2;
 131   if ((upper_pow2 - n_elts) < (n_elts - lower_pow2))
 132     {
 133       if (upper_pow2 <= UINT32_MAX)
 134         {
 135           return upper_pow2;
 136         }
 137     }
 138   return lower_pow2;
 139 }
 140
 141 u8 *format_nat_protocol (u8 *s, va_list *args);
 142
 143 uword unformat_nat_protocol (unformat_input_t *input, va_list *args);
 144
 145 #endif /* included_nat_lib_h__ */
 146 /*
 147  * fd.io coding-style-patch-verification: ON
 148  *
 149  * Local Variables:
 150  * eval: (c-set-style "gnu")
 151  * End:
 152  */