if_llatbl.h revision 286577
1186121Skmacy/* 2186121Skmacy * Copyright (c) 2004 Luigi Rizzo, Alessandro Cerri. All rights reserved. 3186121Skmacy * Copyright (c) 2004-2008 Qing Li. All rights reserved. 4186121Skmacy * Copyright (c) 2008 Kip Macy. All rights reserved. 5186121Skmacy * 6186121Skmacy * Redistribution and use in source and binary forms, with or without 7186121Skmacy * modification, are permitted provided that the following conditions 8186121Skmacy * are met: 9186121Skmacy * 1. Redistributions of source code must retain the above copyright 10186121Skmacy * notice, this list of conditions and the following disclaimer. 11186121Skmacy * 2. Redistributions in binary form must reproduce the above copyright 12186121Skmacy * notice, this list of conditions and the following disclaimer in the 13186121Skmacy * documentation and/or other materials provided with the distribution. 14186121Skmacy * 15186121Skmacy * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16186121Skmacy * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17186121Skmacy * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18186121Skmacy * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 19186121Skmacy * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20186121Skmacy * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21186121Skmacy * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22186121Skmacy * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23186121Skmacy * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24186121Skmacy * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25186121Skmacy * SUCH DAMAGE. 26186121Skmacy */ 27186121Skmacy#include <sys/cdefs.h> 28186121Skmacy__FBSDID("$FreeBSD: head/sys/net/if_llatbl.h 286577 2015-08-10 12:03:59Z melifaro $"); 29186121Skmacy 30186121Skmacy#ifndef _NET_IF_LLATBL_H_ 31186121Skmacy#define _NET_IF_LLATBL_H_ 32186121Skmacy 33186121Skmacy#include <sys/_rwlock.h> 34186121Skmacy#include <netinet/in.h> 35186121Skmacy 36186121Skmacystruct ifnet; 37186121Skmacystruct sysctl_req; 38186121Skmacystruct rt_msghdr; 39186121Skmacystruct rt_addrinfo; 40186121Skmacy 41186121Skmacystruct llentry; 42186121SkmacyLIST_HEAD(llentries, llentry); 43186121Skmacy 44250300Sandreextern struct rwlock lltable_rwlock; 45196535Srwatson#define LLTABLE_RLOCK() rw_rlock(&lltable_rwlock) 46196535Srwatson#define LLTABLE_RUNLOCK() rw_runlock(&lltable_rwlock) 47196535Srwatson#define LLTABLE_WLOCK() rw_wlock(&lltable_rwlock) 48196535Srwatson#define LLTABLE_WUNLOCK() rw_wunlock(&lltable_rwlock) 49196535Srwatson#define LLTABLE_LOCK_ASSERT() rw_assert(&lltable_rwlock, RA_LOCKED) 50196535Srwatson 51186121Skmacy/* 52186121Skmacy * Code referencing llentry must at least hold 53186121Skmacy * a shared lock 54186121Skmacy */ 55186121Skmacystruct llentry { 56186121Skmacy LIST_ENTRY(llentry) lle_next; 57186121Skmacy struct rwlock lle_lock; 58186121Skmacy struct lltable *lle_tbl; 59186121Skmacy struct llentries *lle_head; 60286577Smelifaro void (*lle_free)(struct llentry *); 61186121Skmacy struct mbuf *la_hold; 62238945Sglebius int la_numheld; /* # of packets currently held */ 63186121Skmacy time_t la_expire; 64238945Sglebius uint16_t la_flags; 65186121Skmacy uint16_t la_asked; 66186121Skmacy uint16_t la_preempt; 67186121Skmacy uint16_t ln_byhint; 68186121Skmacy int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */ 69238945Sglebius uint16_t ln_router; 70186121Skmacy time_t ln_ntick; 71186121Skmacy int lle_refcnt; 72238945Sglebius 73186121Skmacy union { 74186121Skmacy uint64_t mac_aligned; 75186121Skmacy uint16_t mac16[3]; 76219819Sjeff uint8_t mac8[20]; /* IB needs 20 bytes. */ 77186121Skmacy } ll_addr; 78186121Skmacy 79286577Smelifaro LIST_ENTRY(llentry) lle_chain; /* chain of deleted items */ 80186121Skmacy /* XXX af-private? */ 81186121Skmacy union { 82186121Skmacy struct callout ln_timer_ch; 83186121Skmacy struct callout la_timer; 84186121Skmacy } lle_timer; 85186121Skmacy /* NB: struct sockaddr must immediately follow */ 86186121Skmacy}; 87186121Skmacy 88186121Skmacy#define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock) 89186121Skmacy#define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock) 90186121Skmacy#define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock) 91186121Skmacy#define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock) 92186121Skmacy#define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 93186121Skmacy#define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock) 94186121Skmacy#define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 95186149Skmacy#define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock) 96186121Skmacy#define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED) 97186121Skmacy 98186121Skmacy#define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 99186121Skmacy 100186121Skmacy#define LLE_ADDREF(lle) do { \ 101186121Skmacy LLE_WLOCK_ASSERT(lle); \ 102186121Skmacy KASSERT((lle)->lle_refcnt >= 0, \ 103238990Sglebius ("negative refcnt %d on lle %p", \ 104238990Sglebius (lle)->lle_refcnt, (lle))); \ 105186121Skmacy (lle)->lle_refcnt++; \ 106186121Skmacy} while (0) 107238945Sglebius 108186121Skmacy#define LLE_REMREF(lle) do { \ 109186121Skmacy LLE_WLOCK_ASSERT(lle); \ 110238990Sglebius KASSERT((lle)->lle_refcnt > 0, \ 111238990Sglebius ("bogus refcnt %d on lle %p", \ 112238990Sglebius (lle)->lle_refcnt, (lle))); \ 113186121Skmacy (lle)->lle_refcnt--; \ 114186121Skmacy} while (0) 115186121Skmacy 116186121Skmacy#define LLE_FREE_LOCKED(lle) do { \ 117238990Sglebius if ((lle)->lle_refcnt == 1) \ 118286577Smelifaro (lle)->lle_free(lle); \ 119186121Skmacy else { \ 120238990Sglebius LLE_REMREF(lle); \ 121186121Skmacy LLE_WUNLOCK(lle); \ 122186121Skmacy } \ 123186121Skmacy /* guard against invalid refs */ \ 124238990Sglebius (lle) = NULL; \ 125186121Skmacy} while (0) 126186121Skmacy 127186121Skmacy#define LLE_FREE(lle) do { \ 128186121Skmacy LLE_WLOCK(lle); \ 129216859Sbz LLE_FREE_LOCKED(lle); \ 130186121Skmacy} while (0) 131186121Skmacy 132186121Skmacy 133186121Skmacy#define ln_timer_ch lle_timer.ln_timer_ch 134186121Skmacy#define la_timer lle_timer.la_timer 135186121Skmacy 136186121Skmacy/* XXX bad name */ 137286577Smelifaro#define L3_CADDR(lle) ((const struct sockaddr *)(&lle[1])) 138186121Skmacy#define L3_ADDR(lle) ((struct sockaddr *)(&lle[1])) 139186121Skmacy#define L3_ADDR_LEN(lle) (((struct sockaddr *)(&lle[1]))->sa_len) 140186121Skmacy 141186121Skmacy#ifndef LLTBL_HASHTBL_SIZE 142186121Skmacy#define LLTBL_HASHTBL_SIZE 32 /* default 32 ? */ 143186121Skmacy#endif 144186121Skmacy 145186121Skmacy#ifndef LLTBL_HASHMASK 146186121Skmacy#define LLTBL_HASHMASK (LLTBL_HASHTBL_SIZE - 1) 147186121Skmacy#endif 148186121Skmacy 149286457Smelifarotypedef struct llentry *(llt_lookup_t)(struct lltable *, u_int flags, 150286457Smelifaro const struct sockaddr *l3addr); 151286457Smelifarotypedef struct llentry *(llt_create_t)(struct lltable *, u_int flags, 152286457Smelifaro const struct sockaddr *l3addr); 153286457Smelifarotypedef int (llt_delete_t)(struct lltable *, u_int flags, 154286457Smelifaro const struct sockaddr *l3addr); 155286457Smelifarotypedef void (llt_prefix_free_t)(struct lltable *, 156286457Smelifaro const struct sockaddr *prefix, const struct sockaddr *mask, u_int flags); 157286577Smelifarotypedef int (llt_dump_entry_t)(struct lltable *, struct llentry *, 158286577Smelifaro struct sysctl_req *); 159286577Smelifarotypedef uint32_t (llt_hash_t)(const struct llentry *, uint32_t); 160286577Smelifarotypedef int (llt_match_prefix_t)(const struct sockaddr *, 161286577Smelifaro const struct sockaddr *, u_int, struct llentry *); 162286577Smelifarotypedef void (llt_free_entry_t)(struct lltable *, struct llentry *); 163286577Smelifarotypedef void (llt_fill_sa_entry_t)(const struct llentry *, struct sockaddr *); 164286577Smelifarotypedef void (llt_link_entry_t)(struct lltable *, struct llentry *); 165286577Smelifarotypedef void (llt_unlink_entry_t)(struct llentry *); 166286457Smelifaro 167286577Smelifarotypedef int (llt_foreach_cb_t)(struct lltable *, struct llentry *, void *); 168286577Smelifarotypedef int (llt_foreach_entry_t)(struct lltable *, llt_foreach_cb_t *, void *); 169286577Smelifaro 170186121Skmacystruct lltable { 171186121Skmacy SLIST_ENTRY(lltable) llt_link; 172186121Skmacy struct llentries lle_head[LLTBL_HASHTBL_SIZE]; 173186121Skmacy int llt_af; 174186121Skmacy struct ifnet *llt_ifp; 175186121Skmacy 176286457Smelifaro llt_lookup_t *llt_lookup; 177286457Smelifaro llt_create_t *llt_create; 178286457Smelifaro llt_delete_t *llt_delete; 179286457Smelifaro llt_prefix_free_t *llt_prefix_free; 180286577Smelifaro llt_dump_entry_t *llt_dump_entry; 181286577Smelifaro llt_hash_t *llt_hash; 182286577Smelifaro llt_match_prefix_t *llt_match_prefix; 183286577Smelifaro llt_free_entry_t *llt_free_entry; 184286577Smelifaro llt_foreach_entry_t *llt_foreach_entry; 185286577Smelifaro llt_link_entry_t *llt_link_entry; 186286577Smelifaro llt_unlink_entry_t *llt_unlink_entry; 187286577Smelifaro llt_fill_sa_entry_t *llt_fill_sa_entry; 188186121Skmacy}; 189286457Smelifaro 190186121SkmacyMALLOC_DECLARE(M_LLTABLE); 191186121Skmacy 192186121Skmacy/* 193286457Smelifaro * LLentry flags 194186121Skmacy */ 195186121Skmacy#define LLE_DELETED 0x0001 /* entry must be deleted */ 196186121Skmacy#define LLE_STATIC 0x0002 /* entry is static */ 197186121Skmacy#define LLE_IFADDR 0x0004 /* entry is interface addr */ 198186121Skmacy#define LLE_VALID 0x0008 /* ll_addr is valid */ 199186121Skmacy#define LLE_PUB 0x0020 /* publish entry ??? */ 200238990Sglebius#define LLE_LINKED 0x0040 /* linked to lookup structure */ 201286457Smelifaro/* LLE request flags */ 202238945Sglebius#define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 203186121Skmacy 204186121Skmacy#define LLATBL_HASH(key, mask) \ 205186121Skmacy (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 206186121Skmacy 207186121Skmacystruct lltable *lltable_init(struct ifnet *, int); 208186121Skmacyvoid lltable_free(struct lltable *); 209238945Sglebiusvoid lltable_prefix_free(int, struct sockaddr *, 210238945Sglebius struct sockaddr *, u_int); 211213929Sbz#if 0 212186121Skmacyvoid lltable_drain(int); 213213929Sbz#endif 214186121Skmacyint lltable_sysctl_dumparp(int, struct sysctl_req *); 215186121Skmacy 216215207Sgnnsize_t llentry_free(struct llentry *); 217238989Sglebiusstruct llentry *llentry_alloc(struct ifnet *, struct lltable *, 218238989Sglebius struct sockaddr_storage *); 219186121Skmacy 220286577Smelifaro/* helper functions */ 221286577Smelifarosize_t lltable_drop_entry_queue(struct llentry *); 222286577Smelifaro 223286577Smelifarostruct llentry *lltable_create_lle(struct lltable *llt, u_int flags, 224286577Smelifaro const void *paddr); 225286577Smelifarovoid lltable_link_entry(struct lltable *llt, struct llentry *lle); 226286577Smelifarovoid lltable_unlink_entry(struct lltable *llt, struct llentry *lle); 227286577Smelifarovoid lltable_fill_sa_entry(const struct llentry *lle, struct sockaddr *sa); 228286577Smelifarostruct ifnet *lltable_get_ifp(const struct lltable *llt); 229286577Smelifaroint lltable_get_af(const struct lltable *llt); 230286577Smelifaro 231286577Smelifaroint lltable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f, 232286577Smelifaro void *farg); 233186121Skmacy/* 234186121Skmacy * Generic link layer address lookup function. 235186121Skmacy */ 236186121Skmacystatic __inline struct llentry * 237186121Skmacylla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 238186121Skmacy{ 239286457Smelifaro 240286457Smelifaro return (llt->llt_lookup(llt, flags, l3addr)); 241186121Skmacy} 242186121Skmacy 243286457Smelifarostatic __inline struct llentry * 244286457Smelifarolla_create(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 245286457Smelifaro{ 246286457Smelifaro 247286457Smelifaro return (llt->llt_create(llt, flags, l3addr)); 248286457Smelifaro} 249286457Smelifaro 250286457Smelifarostatic __inline int 251286457Smelifarolla_delete(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 252286457Smelifaro{ 253286457Smelifaro 254286457Smelifaro return (llt->llt_delete(llt, flags, l3addr)); 255286457Smelifaro} 256286457Smelifaro 257286457Smelifaro 258186121Skmacyint lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 259245924Snp 260245924Snp#include <sys/eventhandler.h> 261245924Snpenum { 262245924Snp LLENTRY_RESOLVED, 263245924Snp LLENTRY_TIMEDOUT, 264245924Snp LLENTRY_DELETED, 265245924Snp LLENTRY_EXPIRED, 266245924Snp}; 267245924Snptypedef void (*lle_event_fn)(void *, struct llentry *, int); 268245924SnpEVENTHANDLER_DECLARE(lle_event, lle_event_fn); 269186121Skmacy#endif /* _NET_IF_LLATBL_H_ */ 270