1fe267a55SPedro F. Giffuni /*- 2fe267a55SPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3fe267a55SPedro F. Giffuni * 482f39c91SKip Macy * Copyright (c) 2004 Luigi Rizzo, Alessandro Cerri. All rights reserved. 582f39c91SKip Macy * Copyright (c) 2004-2008 Qing Li. All rights reserved. 682f39c91SKip Macy * Copyright (c) 2008 Kip Macy. All rights reserved. 782f39c91SKip Macy * 882f39c91SKip Macy * Redistribution and use in source and binary forms, with or without 982f39c91SKip Macy * modification, are permitted provided that the following conditions 1082f39c91SKip Macy * are met: 1182f39c91SKip Macy * 1. Redistributions of source code must retain the above copyright 1282f39c91SKip Macy * notice, this list of conditions and the following disclaimer. 1382f39c91SKip Macy * 2. Redistributions in binary form must reproduce the above copyright 1482f39c91SKip Macy * notice, this list of conditions and the following disclaimer in the 1582f39c91SKip Macy * documentation and/or other materials provided with the distribution. 1682f39c91SKip Macy * 1782f39c91SKip Macy * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1882f39c91SKip Macy * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1982f39c91SKip Macy * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2082f39c91SKip Macy * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 2182f39c91SKip Macy * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2282f39c91SKip Macy * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2382f39c91SKip Macy * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2482f39c91SKip Macy * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2582f39c91SKip Macy * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2682f39c91SKip Macy * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2782f39c91SKip Macy * SUCH DAMAGE. 2882f39c91SKip Macy */ 2982f39c91SKip Macy #include <sys/cdefs.h> 3082f39c91SKip Macy __FBSDID("$FreeBSD$"); 3182f39c91SKip Macy 3282f39c91SKip Macy #ifndef _NET_IF_LLATBL_H_ 3382f39c91SKip Macy #define _NET_IF_LLATBL_H_ 3482f39c91SKip Macy 3582f39c91SKip Macy #include <sys/_rwlock.h> 3682f39c91SKip Macy #include <netinet/in.h> 3782f39c91SKip Macy 3882f39c91SKip Macy struct ifnet; 3982f39c91SKip Macy struct sysctl_req; 4082f39c91SKip Macy struct rt_msghdr; 4182f39c91SKip Macy struct rt_addrinfo; 4282f39c91SKip Macy struct llentry; 4382f39c91SKip Macy LIST_HEAD(llentries, llentry); 4482f39c91SKip Macy 454fb3a820SAlexander V. Chernikov #define LLE_MAX_LINKHDR 24 /* Full IB header */ 4682f39c91SKip Macy /* 4782f39c91SKip Macy * Code referencing llentry must at least hold 4882f39c91SKip Macy * a shared lock 4982f39c91SKip Macy */ 5082f39c91SKip Macy struct llentry { 5182f39c91SKip Macy LIST_ENTRY(llentry) lle_next; 52314294deSAlexander V. Chernikov union { 53314294deSAlexander V. Chernikov struct in_addr addr4; 54314294deSAlexander V. Chernikov struct in6_addr addr6; 55314294deSAlexander V. Chernikov } r_l3addr; 564fb3a820SAlexander V. Chernikov char r_linkdata[LLE_MAX_LINKHDR]; /* L2 data */ 574fb3a820SAlexander V. Chernikov uint8_t r_hdrlen; /* length for LL header */ 584fb3a820SAlexander V. Chernikov uint8_t spare0[3]; 59f8aee88fSAlexander V. Chernikov uint16_t r_flags; /* LLE runtime flags */ 60f8aee88fSAlexander V. Chernikov uint16_t r_skip_req; /* feedback from fast path */ 61314294deSAlexander V. Chernikov 6282f39c91SKip Macy struct lltable *lle_tbl; 6382f39c91SKip Macy struct llentries *lle_head; 6411cdad98SAlexander V. Chernikov void (*lle_free)(struct llentry *); 6582f39c91SKip Macy struct mbuf *la_hold; 66e162ea60SGeorge V. Neville-Neil int la_numheld; /* # of packets currently held */ 6782f39c91SKip Macy time_t la_expire; 6882f39c91SKip Macy uint16_t la_flags; 6982f39c91SKip Macy uint16_t la_asked; 7082f39c91SKip Macy uint16_t la_preempt; 7182f39c91SKip Macy int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */ 7282f39c91SKip Macy uint16_t ln_router; 7382f39c91SKip Macy time_t ln_ntick; 7412cb7521SAlexander V. Chernikov time_t lle_remtime; /* Real time remaining */ 7512cb7521SAlexander V. Chernikov time_t lle_hittime; /* Time when r_skip_req was unset */ 7682f39c91SKip Macy int lle_refcnt; 774fb3a820SAlexander V. Chernikov char *ll_addr; /* link-layer address */ 7882f39c91SKip Macy 7911cdad98SAlexander V. Chernikov LIST_ENTRY(llentry) lle_chain; /* chain of deleted items */ 800447c136SAlexander V. Chernikov struct callout lle_timer; 81314294deSAlexander V. Chernikov struct rwlock lle_lock; 82f8aee88fSAlexander V. Chernikov struct mtx req_mtx; 8382f39c91SKip Macy }; 8482f39c91SKip Macy 8582f39c91SKip Macy #define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock) 8682f39c91SKip Macy #define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock) 8782f39c91SKip Macy #define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock) 8882f39c91SKip Macy #define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock) 8982f39c91SKip Macy #define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 9082f39c91SKip Macy #define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock) 9182f39c91SKip Macy #define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 928a61a4eeSKip Macy #define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock) 9382f39c91SKip Macy #define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED) 9482f39c91SKip Macy 95f8aee88fSAlexander V. Chernikov #define LLE_REQ_INIT(lle) mtx_init(&(lle)->req_mtx, "lle req", \ 96f8aee88fSAlexander V. Chernikov NULL, MTX_DEF) 97f8aee88fSAlexander V. Chernikov #define LLE_REQ_DESTROY(lle) mtx_destroy(&(lle)->req_mtx) 98f8aee88fSAlexander V. Chernikov #define LLE_REQ_LOCK(lle) mtx_lock(&(lle)->req_mtx) 99f8aee88fSAlexander V. Chernikov #define LLE_REQ_UNLOCK(lle) mtx_unlock(&(lle)->req_mtx) 100f8aee88fSAlexander V. Chernikov 10182f39c91SKip Macy #define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 10282f39c91SKip Macy 10382f39c91SKip Macy #define LLE_ADDREF(lle) do { \ 10482f39c91SKip Macy LLE_WLOCK_ASSERT(lle); \ 10582f39c91SKip Macy KASSERT((lle)->lle_refcnt >= 0, \ 106ea537929SGleb Smirnoff ("negative refcnt %d on lle %p", \ 107ea537929SGleb Smirnoff (lle)->lle_refcnt, (lle))); \ 10882f39c91SKip Macy (lle)->lle_refcnt++; \ 10982f39c91SKip Macy } while (0) 110ea50c13eSGleb Smirnoff 11182f39c91SKip Macy #define LLE_REMREF(lle) do { \ 11282f39c91SKip Macy LLE_WLOCK_ASSERT(lle); \ 113ea537929SGleb Smirnoff KASSERT((lle)->lle_refcnt > 0, \ 114ea537929SGleb Smirnoff ("bogus refcnt %d on lle %p", \ 115ea537929SGleb Smirnoff (lle)->lle_refcnt, (lle))); \ 11682f39c91SKip Macy (lle)->lle_refcnt--; \ 11782f39c91SKip Macy } while (0) 11882f39c91SKip Macy 11982f39c91SKip Macy #define LLE_FREE_LOCKED(lle) do { \ 120ea537929SGleb Smirnoff if ((lle)->lle_refcnt == 1) \ 12111cdad98SAlexander V. Chernikov (lle)->lle_free(lle); \ 12282f39c91SKip Macy else { \ 123ea537929SGleb Smirnoff LLE_REMREF(lle); \ 12482f39c91SKip Macy LLE_WUNLOCK(lle); \ 12582f39c91SKip Macy } \ 12682f39c91SKip Macy /* guard against invalid refs */ \ 127ea537929SGleb Smirnoff (lle) = NULL; \ 12882f39c91SKip Macy } while (0) 12982f39c91SKip Macy 13082f39c91SKip Macy #define LLE_FREE(lle) do { \ 13182f39c91SKip Macy LLE_WLOCK(lle); \ 132962be6dfSBjoern A. Zeeb LLE_FREE_LOCKED(lle); \ 13382f39c91SKip Macy } while (0) 13482f39c91SKip Macy 135b4b1367aSAlexander V. Chernikov typedef struct llentry *(llt_lookup_t)(struct lltable *, u_int flags, 136b4b1367aSAlexander V. Chernikov const struct sockaddr *l3addr); 1375a255516SAlexander V. Chernikov typedef struct llentry *(llt_alloc_t)(struct lltable *, u_int flags, 138b4b1367aSAlexander V. Chernikov const struct sockaddr *l3addr); 1393e7a2321SAlexander V. Chernikov typedef void (llt_delete_t)(struct lltable *, struct llentry *); 140b4b1367aSAlexander V. Chernikov typedef void (llt_prefix_free_t)(struct lltable *, 1413e7a2321SAlexander V. Chernikov const struct sockaddr *addr, const struct sockaddr *mask, u_int flags); 14211cdad98SAlexander V. Chernikov typedef int (llt_dump_entry_t)(struct lltable *, struct llentry *, 14311cdad98SAlexander V. Chernikov struct sysctl_req *); 14411cdad98SAlexander V. Chernikov typedef uint32_t (llt_hash_t)(const struct llentry *, uint32_t); 14511cdad98SAlexander V. Chernikov typedef int (llt_match_prefix_t)(const struct sockaddr *, 14611cdad98SAlexander V. Chernikov const struct sockaddr *, u_int, struct llentry *); 14711cdad98SAlexander V. Chernikov typedef void (llt_free_entry_t)(struct lltable *, struct llentry *); 14811cdad98SAlexander V. Chernikov typedef void (llt_fill_sa_entry_t)(const struct llentry *, struct sockaddr *); 14941cb42a6SAlexander V. Chernikov typedef void (llt_free_tbl_t)(struct lltable *); 15011cdad98SAlexander V. Chernikov typedef void (llt_link_entry_t)(struct lltable *, struct llentry *); 15111cdad98SAlexander V. Chernikov typedef void (llt_unlink_entry_t)(struct llentry *); 15211cdad98SAlexander V. Chernikov 15311cdad98SAlexander V. Chernikov typedef int (llt_foreach_cb_t)(struct lltable *, struct llentry *, void *); 15411cdad98SAlexander V. Chernikov typedef int (llt_foreach_entry_t)(struct lltable *, llt_foreach_cb_t *, void *); 155b4b1367aSAlexander V. Chernikov 15682f39c91SKip Macy struct lltable { 15782f39c91SKip Macy SLIST_ENTRY(lltable) llt_link; 15882f39c91SKip Macy int llt_af; 15941cb42a6SAlexander V. Chernikov int llt_hsize; 16041cb42a6SAlexander V. Chernikov struct llentries *lle_head; 16182f39c91SKip Macy struct ifnet *llt_ifp; 16282f39c91SKip Macy 163b4b1367aSAlexander V. Chernikov llt_lookup_t *llt_lookup; 1645a255516SAlexander V. Chernikov llt_alloc_t *llt_alloc_entry; 1653e7a2321SAlexander V. Chernikov llt_delete_t *llt_delete_entry; 166b4b1367aSAlexander V. Chernikov llt_prefix_free_t *llt_prefix_free; 16711cdad98SAlexander V. Chernikov llt_dump_entry_t *llt_dump_entry; 16811cdad98SAlexander V. Chernikov llt_hash_t *llt_hash; 16911cdad98SAlexander V. Chernikov llt_match_prefix_t *llt_match_prefix; 17011cdad98SAlexander V. Chernikov llt_free_entry_t *llt_free_entry; 17111cdad98SAlexander V. Chernikov llt_foreach_entry_t *llt_foreach_entry; 17211cdad98SAlexander V. Chernikov llt_link_entry_t *llt_link_entry; 17311cdad98SAlexander V. Chernikov llt_unlink_entry_t *llt_unlink_entry; 17411cdad98SAlexander V. Chernikov llt_fill_sa_entry_t *llt_fill_sa_entry; 17541cb42a6SAlexander V. Chernikov llt_free_tbl_t *llt_free_tbl; 17682f39c91SKip Macy }; 177b4b1367aSAlexander V. Chernikov 17882f39c91SKip Macy MALLOC_DECLARE(M_LLTABLE); 17982f39c91SKip Macy 18082f39c91SKip Macy /* 181e362cf0eSAlexander V. Chernikov * LLentry flags 18282f39c91SKip Macy */ 18382f39c91SKip Macy #define LLE_DELETED 0x0001 /* entry must be deleted */ 18482f39c91SKip Macy #define LLE_STATIC 0x0002 /* entry is static */ 18582f39c91SKip Macy #define LLE_IFADDR 0x0004 /* entry is interface addr */ 18682f39c91SKip Macy #define LLE_VALID 0x0008 /* ll_addr is valid */ 18717a03656SEric van Gyzen #define LLE_REDIRECT 0x0010 /* installed by redirect; has host rtentry */ 18882f39c91SKip Macy #define LLE_PUB 0x0020 /* publish entry ??? */ 189ea537929SGleb Smirnoff #define LLE_LINKED 0x0040 /* linked to lookup structure */ 190b4b1367aSAlexander V. Chernikov /* LLE request flags */ 191ea50c13eSGleb Smirnoff #define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 192f8aee88fSAlexander V. Chernikov #define LLE_UNLOCKED 0x4000 /* return lle unlocked */ 1934fb3a820SAlexander V. Chernikov #define LLE_ADDRONLY 0x4000 /* return lladdr instead of full header */ 1944fb3a820SAlexander V. Chernikov #define LLE_CREATE 0x8000 /* hint to avoid lle lookup */ 195f8aee88fSAlexander V. Chernikov 196f8aee88fSAlexander V. Chernikov /* LLE flags used by fastpath code */ 197f8aee88fSAlexander V. Chernikov #define RLLE_VALID 0x0001 /* entry is valid */ 198f8aee88fSAlexander V. Chernikov #define RLLE_IFADDR LLE_IFADDR /* entry is ifaddr */ 19982f39c91SKip Macy 20082f39c91SKip Macy #define LLATBL_HASH(key, mask) \ 20182f39c91SKip Macy (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 20282f39c91SKip Macy 20341cb42a6SAlexander V. Chernikov struct lltable *lltable_allocate_htbl(uint32_t hsize); 20482f39c91SKip Macy void lltable_free(struct lltable *); 20541cb42a6SAlexander V. Chernikov void lltable_link(struct lltable *llt); 206c9d763bfSQing Li void lltable_prefix_free(int, struct sockaddr *, 2075b84dc78SQing Li struct sockaddr *, u_int); 208fc2bfb32SBjoern A. Zeeb #if 0 20982f39c91SKip Macy void lltable_drain(int); 210fc2bfb32SBjoern A. Zeeb #endif 21182f39c91SKip Macy int lltable_sysctl_dumparp(int, struct sysctl_req *); 21282f39c91SKip Macy 213e162ea60SGeorge V. Neville-Neil size_t llentry_free(struct llentry *); 214b1d86af7SGleb Smirnoff struct llentry *llentry_alloc(struct ifnet *, struct lltable *, 215b1d86af7SGleb Smirnoff struct sockaddr_storage *); 21682f39c91SKip Macy 21711cdad98SAlexander V. Chernikov /* helper functions */ 21811cdad98SAlexander V. Chernikov size_t lltable_drop_entry_queue(struct llentry *); 219ddd208f7SAlexander V. Chernikov void lltable_set_entry_addr(struct ifnet *ifp, struct llentry *lle, 2204fb3a820SAlexander V. Chernikov const char *linkhdr, size_t linkhdrsize, int lladdr_off); 22112cb7521SAlexander V. Chernikov int lltable_try_set_entry_addr(struct ifnet *ifp, struct llentry *lle, 2224fb3a820SAlexander V. Chernikov const char *linkhdr, size_t linkhdrsize, int lladdr_off); 22311cdad98SAlexander V. Chernikov 2244fb3a820SAlexander V. Chernikov int lltable_calc_llheader(struct ifnet *ifp, int family, char *lladdr, 2254fb3a820SAlexander V. Chernikov char *buf, size_t *bufsize, int *lladdr_off); 2264fb3a820SAlexander V. Chernikov void lltable_update_ifaddr(struct lltable *llt); 2275a255516SAlexander V. Chernikov struct llentry *lltable_alloc_entry(struct lltable *llt, u_int flags, 2285a255516SAlexander V. Chernikov const struct sockaddr *l4addr); 2295a255516SAlexander V. Chernikov void lltable_free_entry(struct lltable *llt, struct llentry *lle); 2303e7a2321SAlexander V. Chernikov int lltable_delete_addr(struct lltable *llt, u_int flags, 2313e7a2321SAlexander V. Chernikov const struct sockaddr *l3addr); 23211cdad98SAlexander V. Chernikov void lltable_link_entry(struct lltable *llt, struct llentry *lle); 23311cdad98SAlexander V. Chernikov void lltable_unlink_entry(struct lltable *llt, struct llentry *lle); 23411cdad98SAlexander V. Chernikov void lltable_fill_sa_entry(const struct llentry *lle, struct sockaddr *sa); 23511cdad98SAlexander V. Chernikov struct ifnet *lltable_get_ifp(const struct lltable *llt); 23611cdad98SAlexander V. Chernikov int lltable_get_af(const struct lltable *llt); 23711cdad98SAlexander V. Chernikov 23811cdad98SAlexander V. Chernikov int lltable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f, 23911cdad98SAlexander V. Chernikov void *farg); 24082f39c91SKip Macy /* 24182f39c91SKip Macy * Generic link layer address lookup function. 24282f39c91SKip Macy */ 24382f39c91SKip Macy static __inline struct llentry * 24482f39c91SKip Macy lla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 24582f39c91SKip Macy { 246b4b1367aSAlexander V. Chernikov 247e362cf0eSAlexander V. Chernikov return (llt->llt_lookup(llt, flags, l3addr)); 24882f39c91SKip Macy } 24982f39c91SKip Macy 25082f39c91SKip Macy int lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 2514364ec08SNavdeep Parhar 2524364ec08SNavdeep Parhar #include <sys/eventhandler.h> 2534364ec08SNavdeep Parhar enum { 2544364ec08SNavdeep Parhar LLENTRY_RESOLVED, 2554364ec08SNavdeep Parhar LLENTRY_TIMEDOUT, 2564364ec08SNavdeep Parhar LLENTRY_DELETED, 2574364ec08SNavdeep Parhar LLENTRY_EXPIRED, 2584364ec08SNavdeep Parhar }; 2594364ec08SNavdeep Parhar typedef void (*lle_event_fn)(void *, struct llentry *, int); 2604364ec08SNavdeep Parhar EVENTHANDLER_DECLARE(lle_event, lle_event_fn); 26182f39c91SKip Macy #endif /* _NET_IF_LLATBL_H_ */ 262