xref: /dpdk/lib/fib/rte_fib6.c (revision e9fd1ebf981f361844aea9ec94e17f4bda5e1479) 
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2018 Vladimir Medvedkin <medvedkinv@gmail.com>
3  * Copyright(c) 2019 Intel Corporation
4  */
5 
6 #include <stdint.h>
7 #include <string.h>
8 #include <sys/queue.h>
9 
10 #include <rte_eal_memconfig.h>
11 #include <rte_tailq.h>
12 #include <rte_errno.h>
13 #include <rte_log.h>
14 #include <rte_malloc.h>
15 #include <rte_string_fns.h>
16 
17 #include <rte_rib6.h>
18 #include <rte_fib6.h>
19 
20 #include "trie.h"
21 #include "fib_log.h"
22 
23 TAILQ_HEAD(rte_fib6_list, rte_tailq_entry);
24 static struct rte_tailq_elem rte_fib6_tailq = {
25 	.name = "RTE_FIB6",
26 };
27 EAL_REGISTER_TAILQ(rte_fib6_tailq)
28 
29 /* Maximum length of a FIB name. */
30 #define FIB6_NAMESIZE	64
31 
32 #if defined(RTE_LIBRTE_FIB_DEBUG)
33 #define FIB6_RETURN_IF_TRUE(cond, retval) do {		\
34 	if (cond)					\
35 		return retval;				\
36 } while (0)
37 #else
38 #define FIB6_RETURN_IF_TRUE(cond, retval)
39 #endif
40 
41 struct rte_fib6 {
42 	char			name[FIB6_NAMESIZE];
43 	enum rte_fib6_type	type;	/**< Type of FIB struct */
44 	struct rte_rib6		*rib;	/**< RIB helper datastructure */
45 	void			*dp;	/**< pointer to the dataplane struct*/
46 	rte_fib6_lookup_fn_t	lookup;	/**< FIB lookup function */
47 	rte_fib6_modify_fn_t	modify; /**< modify FIB datastructure */
48 	uint64_t		def_nh;
49 };
50 
51 static void
52 dummy_lookup(void *fib_p, uint8_t ips[][RTE_FIB6_IPV6_ADDR_SIZE],
53 	uint64_t *next_hops, const unsigned int n)
54 {
55 	unsigned int i;
56 	struct rte_fib6 *fib = fib_p;
57 	struct rte_rib6_node *node;
58 
59 	for (i = 0; i < n; i++) {
60 		node = rte_rib6_lookup(fib->rib, ips[i]);
61 		if (node != NULL)
62 			rte_rib6_get_nh(node, &next_hops[i]);
63 		else
64 			next_hops[i] = fib->def_nh;
65 	}
66 }
67 
68 static int
69 dummy_modify(struct rte_fib6 *fib, const uint8_t ip[RTE_FIB6_IPV6_ADDR_SIZE],
70 	uint8_t depth, uint64_t next_hop, int op)
71 {
72 	struct rte_rib6_node *node;
73 	if ((fib == NULL) || (depth > RTE_FIB6_MAXDEPTH))
74 		return -EINVAL;
75 
76 	node = rte_rib6_lookup_exact(fib->rib, ip, depth);
77 
78 	switch (op) {
79 	case RTE_FIB6_ADD:
80 		if (node == NULL)
81 			node = rte_rib6_insert(fib->rib, ip, depth);
82 		if (node == NULL)
83 			return -rte_errno;
84 		return rte_rib6_set_nh(node, next_hop);
85 	case RTE_FIB6_DEL:
86 		if (node == NULL)
87 			return -ENOENT;
88 		rte_rib6_remove(fib->rib, ip, depth);
89 		return 0;
90 	}
91 	return -EINVAL;
92 }
93 
94 static int
95 init_dataplane(struct rte_fib6 *fib, __rte_unused int socket_id,
96 	struct rte_fib6_conf *conf)
97 {
98 	char dp_name[sizeof(void *)];
99 
100 	snprintf(dp_name, sizeof(dp_name), "%p", fib);
101 	switch (conf->type) {
102 	case RTE_FIB6_DUMMY:
103 		fib->dp = fib;
104 		fib->lookup = dummy_lookup;
105 		fib->modify = dummy_modify;
106 		return 0;
107 	case RTE_FIB6_TRIE:
108 		fib->dp = trie_create(dp_name, socket_id, conf);
109 		if (fib->dp == NULL)
110 			return -rte_errno;
111 		fib->lookup = trie_get_lookup_fn(fib->dp, RTE_FIB6_LOOKUP_DEFAULT);
112 		fib->modify = trie_modify;
113 		return 0;
114 	default:
115 		return -EINVAL;
116 	}
117 	return 0;
118 }
119 
120 int
121 rte_fib6_add(struct rte_fib6 *fib, const uint8_t ip[RTE_FIB6_IPV6_ADDR_SIZE],
122 	uint8_t depth, uint64_t next_hop)
123 {
124 	if ((fib == NULL) || (ip == NULL) || (fib->modify == NULL) ||
125 			(depth > RTE_FIB6_MAXDEPTH))
126 		return -EINVAL;
127 	return fib->modify(fib, ip, depth, next_hop, RTE_FIB6_ADD);
128 }
129 
130 int
131 rte_fib6_delete(struct rte_fib6 *fib, const uint8_t ip[RTE_FIB6_IPV6_ADDR_SIZE],
132 	uint8_t depth)
133 {
134 	if ((fib == NULL) || (ip == NULL) || (fib->modify == NULL) ||
135 			(depth > RTE_FIB6_MAXDEPTH))
136 		return -EINVAL;
137 	return fib->modify(fib, ip, depth, 0, RTE_FIB6_DEL);
138 }
139 
140 int
141 rte_fib6_lookup_bulk(struct rte_fib6 *fib,
142 	uint8_t ips[][RTE_FIB6_IPV6_ADDR_SIZE],
143 	uint64_t *next_hops, int n)
144 {
145 	FIB6_RETURN_IF_TRUE((fib == NULL) || (ips == NULL) ||
146 		(next_hops == NULL) || (fib->lookup == NULL), -EINVAL);
147 	fib->lookup(fib->dp, ips, next_hops, n);
148 	return 0;
149 }
150 
151 struct rte_fib6 *
152 rte_fib6_create(const char *name, int socket_id, struct rte_fib6_conf *conf)
153 {
154 	char mem_name[FIB6_NAMESIZE];
155 	int ret;
156 	struct rte_fib6 *fib = NULL;
157 	struct rte_rib6 *rib = NULL;
158 	struct rte_tailq_entry *te;
159 	struct rte_fib6_list *fib_list;
160 	struct rte_rib6_conf rib_conf;
161 
162 	/* Check user arguments. */
163 	if ((name == NULL) || (conf == NULL) || (conf->max_routes < 0) ||
164 			(conf->type > RTE_FIB6_TRIE)) {
165 		rte_errno = EINVAL;
166 		return NULL;
167 	}
168 
169 	rib_conf.ext_sz = conf->rib_ext_sz;
170 	rib_conf.max_nodes = conf->max_routes * 2;
171 
172 	rib = rte_rib6_create(name, socket_id, &rib_conf);
173 	if (rib == NULL) {
174 		FIB_LOG(ERR,
175 			"Can not allocate RIB %s", name);
176 		return NULL;
177 	}
178 
179 	snprintf(mem_name, sizeof(mem_name), "FIB6_%s", name);
180 	fib_list = RTE_TAILQ_CAST(rte_fib6_tailq.head, rte_fib6_list);
181 
182 	rte_mcfg_tailq_write_lock();
183 
184 	/* guarantee there's no existing */
185 	TAILQ_FOREACH(te, fib_list, next) {
186 		fib = (struct rte_fib6 *)te->data;
187 		if (strncmp(name, fib->name, FIB6_NAMESIZE) == 0)
188 			break;
189 	}
190 	fib = NULL;
191 	if (te != NULL) {
192 		rte_errno = EEXIST;
193 		goto exit;
194 	}
195 
196 	/* allocate tailq entry */
197 	te = rte_zmalloc("FIB_TAILQ_ENTRY", sizeof(*te), 0);
198 	if (te == NULL) {
199 		FIB_LOG(ERR,
200 			"Can not allocate tailq entry for FIB %s", name);
201 		rte_errno = ENOMEM;
202 		goto exit;
203 	}
204 
205 	/* Allocate memory to store the FIB data structures. */
206 	fib = rte_zmalloc_socket(mem_name,
207 		sizeof(struct rte_fib6), RTE_CACHE_LINE_SIZE, socket_id);
208 	if (fib == NULL) {
209 		FIB_LOG(ERR, "FIB %s memory allocation failed", name);
210 		rte_errno = ENOMEM;
211 		goto free_te;
212 	}
213 
214 	rte_strlcpy(fib->name, name, sizeof(fib->name));
215 	fib->rib = rib;
216 	fib->type = conf->type;
217 	fib->def_nh = conf->default_nh;
218 	ret = init_dataplane(fib, socket_id, conf);
219 	if (ret < 0) {
220 		FIB_LOG(ERR,
221 			"FIB dataplane struct %s memory allocation failed",
222 			name);
223 		rte_errno = -ret;
224 		goto free_fib;
225 	}
226 
227 	te->data = (void *)fib;
228 	TAILQ_INSERT_TAIL(fib_list, te, next);
229 
230 	rte_mcfg_tailq_write_unlock();
231 
232 	return fib;
233 
234 free_fib:
235 	rte_free(fib);
236 free_te:
237 	rte_free(te);
238 exit:
239 	rte_mcfg_tailq_write_unlock();
240 	rte_rib6_free(rib);
241 
242 	return NULL;
243 }
244 
245 struct rte_fib6 *
246 rte_fib6_find_existing(const char *name)
247 {
248 	struct rte_fib6 *fib = NULL;
249 	struct rte_tailq_entry *te;
250 	struct rte_fib6_list *fib_list;
251 
252 	fib_list = RTE_TAILQ_CAST(rte_fib6_tailq.head, rte_fib6_list);
253 
254 	rte_mcfg_tailq_read_lock();
255 	TAILQ_FOREACH(te, fib_list, next) {
256 		fib = (struct rte_fib6 *) te->data;
257 		if (strncmp(name, fib->name, FIB6_NAMESIZE) == 0)
258 			break;
259 	}
260 	rte_mcfg_tailq_read_unlock();
261 
262 	if (te == NULL) {
263 		rte_errno = ENOENT;
264 		return NULL;
265 	}
266 
267 	return fib;
268 }
269 
270 static void
271 free_dataplane(struct rte_fib6 *fib)
272 {
273 	switch (fib->type) {
274 	case RTE_FIB6_DUMMY:
275 		return;
276 	case RTE_FIB6_TRIE:
277 		trie_free(fib->dp);
278 	default:
279 		return;
280 	}
281 }
282 
283 void
284 rte_fib6_free(struct rte_fib6 *fib)
285 {
286 	struct rte_tailq_entry *te;
287 	struct rte_fib6_list *fib_list;
288 
289 	if (fib == NULL)
290 		return;
291 
292 	fib_list = RTE_TAILQ_CAST(rte_fib6_tailq.head, rte_fib6_list);
293 
294 	rte_mcfg_tailq_write_lock();
295 
296 	/* find our tailq entry */
297 	TAILQ_FOREACH(te, fib_list, next) {
298 		if (te->data == (void *)fib)
299 			break;
300 	}
301 	if (te != NULL)
302 		TAILQ_REMOVE(fib_list, te, next);
303 
304 	rte_mcfg_tailq_write_unlock();
305 
306 	free_dataplane(fib);
307 	rte_rib6_free(fib->rib);
308 	rte_free(fib);
309 	rte_free(te);
310 }
311 
312 void *
313 rte_fib6_get_dp(struct rte_fib6 *fib)
314 {
315 	return (fib == NULL) ? NULL : fib->dp;
316 }
317 
318 struct rte_rib6 *
319 rte_fib6_get_rib(struct rte_fib6 *fib)
320 {
321 	return (fib == NULL) ? NULL : fib->rib;
322 }
323 
324 int
325 rte_fib6_select_lookup(struct rte_fib6 *fib,
326 	enum rte_fib6_lookup_type type)
327 {
328 	rte_fib6_lookup_fn_t fn;
329 
330 	switch (fib->type) {
331 	case RTE_FIB6_TRIE:
332 		fn = trie_get_lookup_fn(fib->dp, type);
333 		if (fn == NULL)
334 			return -EINVAL;
335 		fib->lookup = fn;
336 		return 0;
337 	default:
338 		return -EINVAL;
339 	}
340 }
341