ip: Replace Sematics for Interface IP addresses
[vpp.git] / src / vnet / ip / ip.c
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 #include <vnet/ip/ip.h>
17 #include <vnet/fib/fib_table.h>
18
19 u8
20 ip_is_zero (ip46_address_t * ip46_address, u8 is_ip4)
21 {
22   if (is_ip4)
23     return (ip46_address->ip4.as_u32 == 0);
24   else
25     return (ip46_address->as_u64[0] == 0 && ip46_address->as_u64[1] == 0);
26 }
27
28 u8
29 ip_is_local_host (ip46_address_t * ip46_address, u8 is_ip4)
30 {
31   if (is_ip4)
32     return (ip46_address->ip4.as_u8[0] == 127);
33   else
34     return (ip46_address->as_u64[0] == 0 &&
35             clib_net_to_host_u64 (ip46_address->as_u64[1]) == 1);
36 }
37
38 u8
39 ip4_is_local_host (ip4_address_t * ip4_address)
40 {
41   return (ip4_address->as_u8[0] == 127);
42 }
43
44 u8
45 ip6_is_local_host (ip6_address_t * ip6_address)
46 {
47   return (ip6_address->as_u64[0] == 0 &&
48           clib_net_to_host_u64 (ip6_address->as_u64[1]) == 1);
49 }
50
51 /**
52  * Checks that an ip is local to the requested fib
53  */
54 u8
55 ip_is_local (u32 fib_index, ip46_address_t * ip46_address, u8 is_ip4)
56 {
57   fib_node_index_t fei;
58   fib_entry_flag_t flags;
59   fib_prefix_t prefix;
60
61   /* Check if requester is local */
62   if (is_ip4)
63     {
64       prefix.fp_len = 32;
65       prefix.fp_proto = FIB_PROTOCOL_IP4;
66     }
67   else
68     {
69       prefix.fp_len = 128;
70       prefix.fp_proto = FIB_PROTOCOL_IP6;
71     }
72
73   clib_memcpy_fast (&prefix.fp_addr, ip46_address, sizeof (ip46_address_t));
74   fei = fib_table_lookup (fib_index, &prefix);
75   flags = fib_entry_get_flags (fei);
76
77   return (flags & FIB_ENTRY_FLAG_LOCAL);
78 }
79
80 void
81 ip_copy (ip46_address_t * dst, ip46_address_t * src, u8 is_ip4)
82 {
83   if (is_ip4)
84     dst->ip4.as_u32 = src->ip4.as_u32;
85   else
86     clib_memcpy_fast (&dst->ip6, &src->ip6, sizeof (ip6_address_t));
87 }
88
89 void
90 ip_set (ip46_address_t * dst, void *src, u8 is_ip4)
91 {
92   if (is_ip4)
93     dst->ip4.as_u32 = ((ip4_address_t *) src)->as_u32;
94   else
95     clib_memcpy_fast (&dst->ip6, (ip6_address_t *) src,
96                       sizeof (ip6_address_t));
97 }
98
99 u8 *
100 format_ip_address_family (u8 * s, va_list * args)
101 {
102   ip_address_family_t af = va_arg (*args, int); // int promo ip_address_family_t);
103
104   switch (af)
105     {
106     case AF_IP4:
107       return (format (s, "ip4"));
108     case AF_IP6:
109       return (format (s, "ip6"));
110     }
111
112   return (format (s, "unknown"));
113 }
114
115 uword
116 unformat_ip_address_family (unformat_input_t * input, va_list * args)
117 {
118   ip_address_family_t *af = va_arg (*args, ip_address_family_t *);
119
120   if (unformat (input, "ip4") || unformat (input, "ipv4") ||
121       unformat (input, "IP4") || unformat (input, "IPv4"))
122     {
123       *af = AF_IP4;
124       return (1);
125     }
126   else if (unformat (input, "ip6") || unformat (input, "ipv6") ||
127            unformat (input, "IP6") || unformat (input, "IPv6"))
128     {
129       *af = AF_IP6;
130       return (1);
131     }
132   return (0);
133 }
134
135 u8 *
136 format_ip_dscp (u8 * s, va_list * va)
137 {
138   ip_dscp_t dscp = va_arg (*va, u32);   // int promotion of u8
139
140   switch (dscp)
141     {
142 #define _(n,v)                                                  \
143     case IP_DSCP_##v:                                           \
144       return (format (s, "%s", #v));
145       foreach_ip_dscp
146 #undef _
147     }
148
149   return (format (s, "unknown"));
150 }
151
152 u8 *
153 format_ip_ecn (u8 * s, va_list * va)
154 {
155   ip_ecn_t ecn = va_arg (*va, u32);     // int promotion of u8
156
157   switch (ecn)
158     {
159 #define _(n,v)                                                  \
160     case IP_ECN_##v:                                           \
161       return (format (s, "%s", #v));
162       foreach_ip_ecn
163 #undef _
164     }
165
166   return (format (s, "unknown"));
167 }
168
169 /*
170  * fd.io coding-style-patch-verification: ON
171  *
172  * Local Variables:
173  * eval: (c-set-style "gnu")
174  * End:
175  */