src/vnet/ip/ip_types.h

   1 /*
   2  * Copyright (c) 2019 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 #ifndef __IP_TYPES_H__
  17 #define __IP_TYPES_H__
  18
  19 #include <vnet/fib/fib_types.h>
  20
  21 typedef enum ip_address_family_t_
  22 {
  23   AF_IP4,
  24   AF_IP6,
  25 } __clib_packed ip_address_family_t;
  26
  27 #define N_AF (AF_IP6+1)
  28
  29 extern uword unformat_ip_address_family (unformat_input_t * input,
  30                                          va_list * args);
  31 extern u8 *format_ip_address_family (u8 * s, va_list * args);
  32
  33 #define FOR_EACH_IP_ADDRESS_FAMILY(_af) \
  34   for (_af = AF_IP4; _af <= AF_IP6; _af++)
  35
  36 extern vnet_link_t ip_address_family_to_link_type (ip_address_family_t af);
  37 extern fib_protocol_t ip_address_family_to_fib_proto (ip_address_family_t af);
  38 extern ip_address_family_t ip_address_family_from_fib_proto (fib_protocol_t
  39                                                              fp);
  40
  41 typedef enum ip_sub_address_family_t_
  42 {
  43   SAFI_UNICAST,
  44   SAFI_MULTICAST,
  45 } __clib_packed ip_sub_address_family_t;
  46
  47 #define N_SAFI (SAFI_MULTICAST+1)
  48
  49 extern uword unformat_ip_sub_address_family (unformat_input_t * input,
  50                                              va_list * args);
  51 extern u8 *format_ip_sub_address_family (u8 * s, va_list * args);
  52
  53 #define FOR_EACH_IP_ADDRESS_SUB_FAMILY(_safi) \
  54   for (_safi = SAFI_UNICAST; _safi <= SAFI_MULTICAST; _safi++)
  55
  56 #define u8_ptr_add(ptr, index) (((u8 *)ptr) + index)
  57 #define u16_net_add(u, val) clib_host_to_net_u16(clib_net_to_host_u16(u) + (val))
  58
  59 /**
  60  * Locations in the IP switch path where features can be applied
  61  */
  62 #define foreach_ip_feature_location                 \
  63   _(INPUT, "input")                                 \
  64   _(OUTPUT, "output")                               \
  65   _(LOCAL, "local")                                 \
  66   _(PUNT, "punt")                                   \
  67   _(DROP, "drop")                                   \
  68
  69 typedef enum ip_feature_location_t_
  70 {
  71 #define _(a,b) IP_FEATURE_##a,
  72   foreach_ip_feature_location
  73 #undef _
  74 } __clib_packed ip_feature_location_t;
  75
  76 #define N_IP_FEATURE_LOCATIONS (IP_FEATURE_DROP+1)
  77
  78 typedef struct ip_address
  79 {
  80   ip46_address_t ip;
  81   ip_address_family_t version;
  82 } __clib_packed ip_address_t;
  83
  84 #define IP_ADDRESS_V4_ALL_0S {.ip.ip4.as_u32 = 0, .version = AF_IP4}
  85 #define IP_ADDRESS_V6_ALL_0S {.ip.ip6.as_u64 = {0, 0}, .version = AF_IP6}
  86 #define ip_address_initializer IP_ADDRESS_V6_ALL_0S
  87
  88 #define ip_addr_46(_a) (_a)->ip
  89 #define ip_addr_v4(_a) (_a)->ip.ip4
  90 #define ip_addr_v6(_a) (_a)->ip.ip6
  91 #define ip_addr_version(_a) (_a)->version
  92
  93 extern u8 *ip_addr_bytes (ip_address_t * ip);
  94
  95 extern bool ip_address_is_zero (const ip_address_t * ip);
  96 extern int ip_address_cmp (const ip_address_t * ip1,
  97                            const ip_address_t * ip2);
  98 extern void ip_address_copy (ip_address_t * dst, const ip_address_t * src);
  99 extern void ip_address_copy_addr (void *dst, const ip_address_t * src);
 100 extern void ip_address_set (ip_address_t *dst, const void *src,
 101                             ip_address_family_t version);
 102 extern u16 ip_address_size (const ip_address_t * a);
 103 extern u16 ip_version_to_size (ip_address_family_t af);
 104 extern u8 *format_ip_address (u8 * s, va_list * args);
 105 extern uword unformat_ip_address (unformat_input_t * input, va_list * args);
 106 extern fib_protocol_t ip_address_to_46 (const ip_address_t * addr,
 107                                         ip46_address_t * a);
 108 extern void ip_address_from_46 (const ip46_address_t * a,
 109                                 fib_protocol_t fproto, ip_address_t * addr);
 110 extern void ip_address_increment (ip_address_t * ip);
 111 extern void ip_address_reset (ip_address_t * ip);
 112
 113 typedef struct ip_prefix
 114 {
 115   ip_address_t addr;
 116   u8 len;
 117 } __clib_packed ip_prefix_t;
 118
 119 #define ip_prefix_addr(_a) (_a)->addr
 120 #define ip_prefix_version(_a) ip_addr_version(&ip_prefix_addr(_a))
 121 #define ip_prefix_len(_a) (_a)->len
 122 #define ip_prefix_v4(_a) ip_addr_v4(&ip_prefix_addr(_a))
 123 #define ip_prefix_v6(_a) ip_addr_v6(&ip_prefix_addr(_a))
 124
 125 extern int ip_prefix_cmp (const ip_prefix_t *p1, const ip_prefix_t *p2);
 126 extern void ip_prefix_normalize (ip_prefix_t * a);
 127
 128 extern void ip_address_to_fib_prefix (const ip_address_t * addr,
 129                                       fib_prefix_t * prefix);
 130 extern void ip_address_to_prefix (const ip_address_t *addr,
 131                                   ip_prefix_t *prefix);
 132 extern void ip_prefix_to_fib_prefix (const ip_prefix_t * ipp,
 133                                      fib_prefix_t * fibp);
 134 extern u8 *format_ip_prefix (u8 * s, va_list * args);
 135 extern uword unformat_ip_prefix (unformat_input_t * input, va_list * args);
 136
 137 extern bool ip_prefix_validate (const ip_prefix_t * ip);
 138 extern void ip4_address_normalize (ip4_address_t * ip4, u8 preflen);
 139 extern void ip6_address_normalize (ip6_address_t * ip6, u8 preflen);
 140 extern void ip4_preflen_to_mask (u8 pref_len, ip4_address_t * ip);
 141 extern u32 ip4_mask_to_preflen (ip4_address_t * mask);
 142 extern void ip4_prefix_max_address_host_order (ip4_address_t * ip, u8 plen,
 143                                                ip4_address_t * res);
 144 extern void ip6_prefix_max_address_host_order (ip6_address_t * ip, u8 plen,
 145                                                ip6_address_t * res);
 146 extern void ip6_preflen_to_mask (u8 pref_len, ip6_address_t * mask);
 147 extern u32 ip6_mask_to_preflen (ip6_address_t * mask);
 148
 149 #endif /* __IP_TYPES_H__ */
 150
 151 /*
 152  * fd.io coding-style-patch-verification: ON
 153  *
 154  * Local Variables:
 155  * eval: (c-set-style "gnu")
 156  * End:
 157  */