2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2004 Luigi Rizzo, Alessandro Cerri. All rights reserved.
5 * Copyright (c) 2004-2008 Qing Li. All rights reserved.
6 * Copyright (c) 2008 Kip Macy. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #ifndef _NET_IF_LLATBL_H_
33 #define _NET_IF_LLATBL_H_
35 #include <sys/_eventhandler.h>
36 #include <sys/_rwlock.h>
37 #include <netinet/in.h>
38 #include <sys/epoch.h>
46 CK_LIST_HEAD(llentries, llentry);
48 #define LLE_MAX_LINKHDR 24 /* Full IB header */
50 * Code referencing llentry must at least hold
54 CK_LIST_ENTRY(llentry) lle_next;
57 struct in6_addr addr6;
59 char r_linkdata[LLE_MAX_LINKHDR]; /* L2 data */
60 uint8_t r_hdrlen; /* length for LL header */
61 uint8_t r_family; /* Upper layer proto family */
63 uint16_t r_flags; /* LLE runtime flags */
64 uint16_t r_skip_req; /* feedback from fast path */
66 struct lltable *lle_tbl;
67 struct llentries *lle_head;
68 void (*lle_free)(struct llentry *);
70 int la_numheld; /* # of packets currently held */
75 int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */
78 time_t lle_remtime; /* Real time remaining */
79 time_t lle_hittime; /* Time when r_skip_req was unset */
81 char *ll_addr; /* link-layer address */
82 CK_SLIST_HEAD(llentry_children_head,llentry) lle_children; /* child encaps */
83 CK_SLIST_ENTRY(llentry) lle_child_next; /* child encaps */
84 struct llentry *lle_parent; /* parent for a child */
86 CK_LIST_ENTRY(llentry) lle_chain; /* chain of deleted items */
87 struct callout lle_timer;
88 struct rwlock lle_lock;
90 struct epoch_context lle_epoch_ctx;
93 #define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock)
94 #define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock)
95 #define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock)
96 #define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock)
97 #define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock)
98 #define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock)
99 #define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK)
100 #define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock)
101 #define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED)
103 #define LLE_REQ_INIT(lle) mtx_init(&(lle)->req_mtx, "lle req", \
105 #define LLE_REQ_DESTROY(lle) mtx_destroy(&(lle)->req_mtx)
106 #define LLE_REQ_LOCK(lle) mtx_lock(&(lle)->req_mtx)
107 #define LLE_REQ_UNLOCK(lle) mtx_unlock(&(lle)->req_mtx)
109 #define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1))
111 #define LLE_SF(_fam, _flags) (((_flags) & 0xFFFF) | ((_fam) << 16))
113 #define LLE_ADDREF(lle) do { \
114 LLE_WLOCK_ASSERT(lle); \
115 KASSERT((lle)->lle_refcnt >= 0, \
116 ("negative refcnt %d on lle %p", \
117 (lle)->lle_refcnt, (lle))); \
118 (lle)->lle_refcnt++; \
121 #define LLE_REMREF(lle) do { \
122 LLE_WLOCK_ASSERT(lle); \
123 KASSERT((lle)->lle_refcnt > 0, \
124 ("bogus refcnt %d on lle %p", \
125 (lle)->lle_refcnt, (lle))); \
126 (lle)->lle_refcnt--; \
129 #define LLE_FREE_LOCKED(lle) do { \
130 if ((lle)->lle_refcnt == 1) \
131 (lle)->lle_free(lle); \
136 /* guard against invalid refs */ \
140 #define LLE_FREE(lle) do { \
142 LLE_FREE_LOCKED(lle); \
145 typedef struct llentry *(llt_lookup_t)(struct lltable *, u_int flags,
146 const struct sockaddr *l3addr);
147 typedef struct llentry *(llt_alloc_t)(struct lltable *, u_int flags,
148 const struct sockaddr *l3addr);
149 typedef void (llt_delete_t)(struct lltable *, struct llentry *);
150 typedef void (llt_prefix_free_t)(struct lltable *,
151 const struct sockaddr *addr, const struct sockaddr *mask, u_int flags);
152 typedef int (llt_dump_entry_t)(struct lltable *, struct llentry *,
153 struct sysctl_req *);
154 typedef uint32_t (llt_hash_t)(const struct llentry *, uint32_t);
155 typedef int (llt_match_prefix_t)(const struct sockaddr *,
156 const struct sockaddr *, u_int, struct llentry *);
157 typedef void (llt_free_entry_t)(struct lltable *, struct llentry *);
158 typedef void (llt_fill_sa_entry_t)(const struct llentry *, struct sockaddr *);
159 typedef void (llt_free_tbl_t)(struct lltable *);
160 typedef int (llt_link_entry_t)(struct lltable *, struct llentry *);
161 typedef int (llt_unlink_entry_t)(struct llentry *);
162 typedef void (llt_mark_used_t)(struct llentry *);
164 typedef int (llt_foreach_cb_t)(struct lltable *, struct llentry *, void *);
165 typedef int (llt_foreach_entry_t)(struct lltable *, llt_foreach_cb_t *, void *);
168 SLIST_ENTRY(lltable) llt_link;
173 struct llentries *lle_head;
174 struct ifnet *llt_ifp;
176 llt_lookup_t *llt_lookup;
177 llt_alloc_t *llt_alloc_entry;
178 llt_delete_t *llt_delete_entry;
179 llt_prefix_free_t *llt_prefix_free;
180 llt_dump_entry_t *llt_dump_entry;
181 llt_hash_t *llt_hash;
182 llt_match_prefix_t *llt_match_prefix;
183 llt_free_entry_t *llt_free_entry;
184 llt_foreach_entry_t *llt_foreach_entry;
185 llt_link_entry_t *llt_link_entry;
186 llt_unlink_entry_t *llt_unlink_entry;
187 llt_fill_sa_entry_t *llt_fill_sa_entry;
188 llt_free_tbl_t *llt_free_tbl;
189 llt_mark_used_t *llt_mark_used;
192 MALLOC_DECLARE(M_LLTABLE);
197 #define LLE_DELETED 0x0001 /* entry must be deleted */
198 #define LLE_STATIC 0x0002 /* entry is static */
199 #define LLE_IFADDR 0x0004 /* entry is interface addr */
200 #define LLE_VALID 0x0008 /* ll_addr is valid */
201 #define LLE_REDIRECT 0x0010 /* installed by redirect; has host rtentry */
202 #define LLE_PUB 0x0020 /* publish entry ??? */
203 #define LLE_LINKED 0x0040 /* linked to lookup structure */
204 #define LLE_CHILD 0x0080 /* Child LLE storing different AF encap */
205 /* LLE request flags */
206 #define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */
207 #define LLE_UNLOCKED 0x4000 /* return lle unlocked */
208 #define LLE_ADDRONLY 0x4000 /* return lladdr instead of full header */
209 #define LLE_CREATE 0x8000 /* hint to avoid lle lookup */
211 /* LLE flags used by fastpath code */
212 #define RLLE_VALID 0x0001 /* entry is valid */
213 #define RLLE_IFADDR LLE_IFADDR /* entry is ifaddr */
215 #define LLATBL_HASH(key, mask) \
216 (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask)
218 struct lltable *lltable_allocate_htbl(uint32_t hsize);
219 void lltable_free(struct lltable *);
220 void lltable_link(struct lltable *llt);
221 void lltable_prefix_free(int, struct sockaddr *,
222 struct sockaddr *, u_int);
223 int lltable_sysctl_dumparp(int, struct sysctl_req *);
225 size_t llentry_free(struct llentry *);
227 /* helper functions */
228 size_t lltable_drop_entry_queue(struct llentry *);
229 void lltable_set_entry_addr(struct ifnet *ifp, struct llentry *lle,
230 const char *linkhdr, size_t linkhdrsize, int lladdr_off);
231 int lltable_try_set_entry_addr(struct ifnet *ifp, struct llentry *lle,
232 const char *linkhdr, size_t linkhdrsize, int lladdr_off);
234 int lltable_calc_llheader(struct ifnet *ifp, int family, char *lladdr,
235 char *buf, size_t *bufsize, int *lladdr_off);
236 void lltable_update_ifaddr(struct lltable *llt);
237 struct llentry *lltable_alloc_entry(struct lltable *llt, u_int flags,
238 const struct sockaddr *l4addr);
239 void lltable_free_entry(struct lltable *llt, struct llentry *lle);
240 int lltable_delete_addr(struct lltable *llt, u_int flags,
241 const struct sockaddr *l3addr);
242 int lltable_link_entry(struct lltable *llt, struct llentry *lle);
243 int lltable_unlink_entry(struct lltable *llt, struct llentry *lle);
244 void lltable_link_child_entry(struct llentry *parent_lle, struct llentry *child_lle);
245 void lltable_unlink_child_entry(struct llentry *child_lle);
246 void lltable_fill_sa_entry(const struct llentry *lle, struct sockaddr *sa);
247 struct ifnet *lltable_get_ifp(const struct lltable *llt);
248 int lltable_get_af(const struct lltable *llt);
250 bool lltable_acquire_wlock(struct ifnet *ifp, struct llentry *lle);
252 int lltable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f,
255 * Generic link layer address lookup function.
257 static __inline struct llentry *
258 lla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr)
261 return (llt->llt_lookup(llt, flags, l3addr));
264 void llentry_request_feedback(struct llentry *lle);
265 void llentry_mark_used(struct llentry *lle);
266 time_t llentry_get_hittime(struct llentry *lle);
269 * Notify the LLE code that the entry was used by datapath.
272 llentry_provide_feedback(struct llentry *lle)
275 if (__predict_true(lle->r_skip_req == 0))
277 llentry_mark_used(lle);
279 struct llentry *llentry_lookup_family(struct llentry *lle, int family);
281 int lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *);
289 typedef void (*lle_event_fn)(void *, struct llentry *, int);
290 EVENTHANDLER_DECLARE(lle_event, lle_event_fn);
291 #endif /* _NET_IF_LLATBL_H_ */