FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
map_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * map_api.c - vnet map api
4  *
5  * Copyright (c) 2016 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19 
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
22 
23 #include "map.h"
24 #include <vnet/api_errno.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/fib/fib_table.h>
27 #include <vnet/vnet_msg_enum.h>
28 
29 #define vl_typedefs /* define message structures */
30 #include <vnet/vnet_all_api_h.h>
31 #undef vl_typedefs
32 
33 #define vl_endianfun /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
35 #undef vl_endianfun
36 
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
39 #define vl_printfun
40 #include <vnet/vnet_all_api_h.h>
41 #undef vl_printfun
42 
44 
45 #define foreach_vpe_api_msg \
46 _(MAP_ADD_DOMAIN, map_add_domain) \
47 _(MAP_DEL_DOMAIN, map_del_domain) \
48 _(MAP_ADD_DEL_RULE, map_add_del_rule) \
49 _(MAP_DOMAIN_DUMP, map_domain_dump) \
50 _(MAP_RULE_DUMP, map_rule_dump) \
51 _(MAP_SUMMARY_STATS, map_summary_stats)
52 
53 static void
55 {
57  int rv = 0;
58  u32 index;
60  rv =
63  (ip6_address_t *) & mp->ip6_src,
65  mp->psid_offset, mp->psid_length, &index,
66  ntohs (mp->mtu), flags);
67 
68  /* *INDENT-OFF* */
69  REPLY_MACRO2(VL_API_MAP_ADD_DOMAIN_REPLY,
70  ({
71  rmp->index = ntohl(index);
72  }));
73  /* *INDENT-ON* */
74 }
75 
76 static void
78 {
79  vl_api_map_del_domain_reply_t *rmp;
80  int rv = 0;
81 
82  rv = map_delete_domain (ntohl (mp->index));
83 
84  REPLY_MACRO (VL_API_MAP_DEL_DOMAIN_REPLY);
85 }
86 
87 static void
89 {
90  vl_api_map_del_domain_reply_t *rmp;
91  int rv = 0;
92 
93  rv =
94  map_add_del_psid (ntohl (mp->index), ntohs (mp->psid),
95  (ip6_address_t *) mp->ip6_dst, mp->is_add);
96 
97  REPLY_MACRO (VL_API_MAP_ADD_DEL_RULE_REPLY);
98 }
99 
100 static void
102 {
104  map_main_t *mm = &map_main;
105  map_domain_t *d;
107 
108  if (pool_elts (mm->domains) == 0)
109  return;
110 
112  if (q == 0)
113  {
114  return;
115  }
116 
117  /* *INDENT-OFF* */
118  pool_foreach(d, mm->domains,
119  ({
120  /* Make sure every field is initiated (or don't skip the memset()) */
121  rmp = vl_msg_api_alloc (sizeof (*rmp));
122  rmp->_vl_msg_id = ntohs(VL_API_MAP_DOMAIN_DETAILS);
123  rmp->domain_index = htonl(d - mm->domains);
124  rmp->ea_bits_len = d->ea_bits_len;
125  rmp->psid_offset = d->psid_offset;
126  rmp->psid_length = d->psid_length;
127  clib_memcpy(rmp->ip4_prefix, &d->ip4_prefix, sizeof(rmp->ip4_prefix));
128  rmp->ip4_prefix_len = d->ip4_prefix_len;
129  clib_memcpy(rmp->ip6_prefix, &d->ip6_prefix, sizeof(rmp->ip6_prefix));
130  rmp->ip6_prefix_len = d->ip6_prefix_len;
131  clib_memcpy(rmp->ip6_src, &d->ip6_src, sizeof(rmp->ip6_src));
132  rmp->ip6_src_len = d->ip6_src_len;
133  rmp->mtu = htons(d->mtu);
134  rmp->is_translation = (d->flags & MAP_DOMAIN_TRANSLATION);
135  rmp->context = mp->context;
136 
137  vl_msg_api_send_shmem (q, (u8 *)&rmp);
138  }));
139  /* *INDENT-ON* */
140 }
141 
142 static void
144 {
146  u16 i;
147  ip6_address_t dst;
149  map_main_t *mm = &map_main;
150  u32 domain_index = ntohl (mp->domain_index);
151  map_domain_t *d;
152 
153  if (pool_elts (mm->domains) == 0)
154  return;
155 
156  d = pool_elt_at_index (mm->domains, domain_index);
157  if (!d || !d->rules)
158  {
159  return;
160  }
161 
163  if (q == 0)
164  {
165  return;
166  }
167 
168  for (i = 0; i < (0x1 << d->psid_length); i++)
169  {
170  dst = d->rules[i];
171  if (dst.as_u64[0] == 0 && dst.as_u64[1] == 0)
172  {
173  continue;
174  }
175  rmp = vl_msg_api_alloc (sizeof (*rmp));
176  memset (rmp, 0, sizeof (*rmp));
177  rmp->_vl_msg_id = ntohs (VL_API_MAP_RULE_DETAILS);
178  rmp->psid = htons (i);
179  clib_memcpy (rmp->ip6_dst, &dst, sizeof (rmp->ip6_dst));
180  rmp->context = mp->context;
181  vl_msg_api_send_shmem (q, (u8 *) & rmp);
182  }
183 }
184 
185 static void
187 {
191  int i, which;
192  u64 total_pkts[VLIB_N_RX_TX];
193  u64 total_bytes[VLIB_N_RX_TX];
194  map_main_t *mm = &map_main;
197 
198  if (!q)
199  return;
200 
201  rmp = vl_msg_api_alloc (sizeof (*rmp));
202  rmp->_vl_msg_id = ntohs (VL_API_MAP_SUMMARY_STATS_REPLY);
203  rmp->context = mp->context;
204  rmp->retval = 0;
205 
206  if (pool_elts (mm->domains) == 0)
207  {
208  rmp->retval = -1;
209  goto out;
210  }
211 
212  memset (total_pkts, 0, sizeof (total_pkts));
213  memset (total_bytes, 0, sizeof (total_bytes));
214 
216  vec_foreach (cm, mm->domain_counters)
217  {
218  which = cm - mm->domain_counters;
219 
220  for (i = 0; i < vlib_combined_counter_n_counters (cm); i++)
221  {
222  vlib_get_combined_counter (cm, i, &v);
223  total_pkts[which] += v.packets;
224  total_bytes[which] += v.bytes;
225  }
226  }
227 
229 
230  /* Note: in network byte order! */
232  clib_host_to_net_u64 (total_pkts[MAP_DOMAIN_COUNTER_RX]);
234  clib_host_to_net_u64 (total_bytes[MAP_DOMAIN_COUNTER_RX]);
236  clib_host_to_net_u64 (total_pkts[MAP_DOMAIN_COUNTER_TX]);
238  clib_host_to_net_u64 (total_bytes[MAP_DOMAIN_COUNTER_TX]);
239  rmp->total_bindings = clib_host_to_net_u64 (pool_elts (mm->domains));
240  rmp->total_ip4_fragments = 0; // Not yet implemented. Should be a simple counter.
242  clib_host_to_net_u64 (map_error_counter_get
243  (ip4_map_node.index, MAP_ERROR_ENCAP_SEC_CHECK));
245  clib_host_to_net_u64 (map_error_counter_get
246  (ip4_map_node.index, MAP_ERROR_DECAP_SEC_CHECK));
247 
248 out:
249  vl_msg_api_send_shmem (q, (u8 *) & rmp);
250 }
251 
252 /*
253  * vpe_api_hookup
254  * Add vpe's API message handlers to the table.
255  * vlib has alread mapped shared memory and
256  * added the client registration handlers.
257  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
258  */
259 #define vl_msg_name_crc_list
260 #include <vnet/vnet_all_api_h.h>
261 #undef vl_msg_name_crc_list
262 
263 static void
265 {
266 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
267  foreach_vl_msg_name_crc_map;
268 #undef _
269 }
270 
271 static clib_error_t *
273 {
274  api_main_t *am = &api_main;
275 
276 #define _(N,n) \
277  vl_msg_api_set_handlers(VL_API_##N, #n, \
278  vl_api_##n##_t_handler, \
279  vl_noop_handler, \
280  vl_api_##n##_t_endian, \
281  vl_api_##n##_t_print, \
282  sizeof(vl_api_##n##_t), 1);
284 #undef _
285 
286  /*
287  * Set up the (msg_name, crc, message-id) table
288  */
290 
291  return 0;
292 }
293 
295 
296 /*
297  * fd.io coding-style-patch-verification: ON
298  *
299  * Local Variables:
300  * eval: (c-set-style "gnu")
301  * End:
302  */
u8 psid_length
Definition: map.h:93
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:337
Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
Definition: map.api:82
int map_delete_domain(u32 map_domain_index)
Definition: map.c:220
map_main_t map_main
Definition: map.c:26
static void vl_api_map_domain_dump_t_handler(vl_api_map_domain_dump_t *mp)
Definition: map_api.c:101
#define foreach_vpe_api_msg
Definition: map_api.c:45
u64 as_u64[2]
Definition: ip6_packet.h:51
#define REPLY_MACRO2(t, body)
u64 map_error_counter_get(u32 node_index, map_error_t map_error)
Definition: map.c:1085
static void map_domain_counter_unlock(map_main_t *mm)
Definition: map.h:541
Combined counter to hold both packets and byte differences.
Definition: counter.h:139
vlib_node_registration_t ip4_map_node
(constructor) VLIB_REGISTER_NODE (ip4_map_node)
Definition: ip4_map.c:703
static void setup_message_id_table(api_main_t *am)
Definition: map_api.c:264
static void vl_api_map_add_del_rule_t_handler(vl_api_map_add_del_rule_t *mp)
Definition: map_api.c:88
static void vl_api_map_summary_stats_t_handler(vl_api_map_summary_stats_t *mp)
Definition: map_api.c:186
Get list of map domains.
Definition: map.api:96
static void vl_api_map_add_domain_t_handler(vl_api_map_add_domain_t *mp)
Definition: map_api.c:54
VLIB_API_INIT_FUNCTION(map_api_hookup)
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:438
vlib_combined_counter_main_t * domain_counters
Definition: map.h:232
ip6_address_t * rules
Definition: map.h:83
unsigned long u64
Definition: types.h:89
static void vl_api_map_del_domain_t_handler(vl_api_map_del_domain_t *mp)
Definition: map_api.c:77
void * vl_msg_api_alloc(int nbytes)
int map_add_del_psid(u32 map_domain_index, u16 psid, ip6_address_t *tep, u8 is_add)
Definition: map.c:264
Delete MAP domain.
Definition: map.api:66
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
counter_t packets
packet counter
Definition: counter.h:141
static void vl_api_map_rule_dump_t_handler(vl_api_map_rule_dump_t *mp)
Definition: map_api.c:143
#define v
Definition: acl.c:341
u32 vlib_combined_counter_n_counters(const vlib_combined_counter_main_t *cm)
The number of counters (not the number of per-thread counters)
Definition: counter.c:100
map_domain_t * domains
Definition: map.h:228
#define REPLY_MACRO(t)
static clib_error_t * map_api_hookup(vlib_main_t *vm)
Definition: map_api.c:272
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:198
api_main_t api_main
Definition: api_shared.c:35
static void vlib_get_combined_counter(const vlib_combined_counter_main_t *cm, u32 index, vlib_counter_t *result)
Get the value of a combined counter, never called in the speed path Scrapes the entire set of per-thr...
Definition: counter.h:250
vlib_main_t * vm
Definition: buffer.c:283
int map_create_domain(ip4_address_t *ip4_prefix, u8 ip4_prefix_len, ip6_address_t *ip6_prefix, u8 ip6_prefix_len, ip6_address_t *ip6_src, u8 ip6_src_len, u8 ea_bits_len, u8 psid_offset, u8 psid_length, u32 *map_domain_index, u16 mtu, u8 flags)
Definition: map.c:64
#define clib_memcpy(a, b, c)
Definition: string.h:75
Reply for map_summary_stats request.
Definition: map.api:152
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
static void map_domain_counter_lock(map_main_t *mm)
Definition: map.h:534
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
unsigned int u32
Definition: types.h:88
Request for a single block of summary stats.
Definition: map.api:138
Reply for MAP domain add.
Definition: map.api:54
counter_t bytes
byte counter
Definition: counter.h:142
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
A collection of combined counters.
Definition: counter.h:180
Add MAP domains.
Definition: map.api:32
#define vec_foreach(var, vec)
Vector iterator.
u32 flags
Definition: vhost-user.h:77
struct _unix_shared_memory_queue unix_shared_memory_queue_t
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128