if_llatbl.h revision 286457
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 286457 2015-08-08 17:48:54Z 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; 60225698Skmacy void (*lle_free)(struct lltable *, 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 79186121Skmacy /* XXX af-private? */ 80186121Skmacy union { 81186121Skmacy struct callout ln_timer_ch; 82186121Skmacy struct callout la_timer; 83186121Skmacy } lle_timer; 84186121Skmacy /* NB: struct sockaddr must immediately follow */ 85186121Skmacy}; 86186121Skmacy 87186121Skmacy#define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock) 88186121Skmacy#define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock) 89186121Skmacy#define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock) 90186121Skmacy#define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock) 91186121Skmacy#define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 92186121Skmacy#define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock) 93186121Skmacy#define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 94186149Skmacy#define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock) 95186121Skmacy#define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED) 96186121Skmacy 97186121Skmacy#define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 98186121Skmacy 99186121Skmacy#define LLE_ADDREF(lle) do { \ 100186121Skmacy LLE_WLOCK_ASSERT(lle); \ 101186121Skmacy KASSERT((lle)->lle_refcnt >= 0, \ 102238990Sglebius ("negative refcnt %d on lle %p", \ 103238990Sglebius (lle)->lle_refcnt, (lle))); \ 104186121Skmacy (lle)->lle_refcnt++; \ 105186121Skmacy} while (0) 106238945Sglebius 107186121Skmacy#define LLE_REMREF(lle) do { \ 108186121Skmacy LLE_WLOCK_ASSERT(lle); \ 109238990Sglebius KASSERT((lle)->lle_refcnt > 0, \ 110238990Sglebius ("bogus refcnt %d on lle %p", \ 111238990Sglebius (lle)->lle_refcnt, (lle))); \ 112186121Skmacy (lle)->lle_refcnt--; \ 113186121Skmacy} while (0) 114186121Skmacy 115186121Skmacy#define LLE_FREE_LOCKED(lle) do { \ 116238990Sglebius if ((lle)->lle_refcnt == 1) \ 117238990Sglebius (lle)->lle_free((lle)->lle_tbl, (lle)); \ 118186121Skmacy else { \ 119238990Sglebius LLE_REMREF(lle); \ 120186121Skmacy LLE_WUNLOCK(lle); \ 121186121Skmacy } \ 122186121Skmacy /* guard against invalid refs */ \ 123238990Sglebius (lle) = NULL; \ 124186121Skmacy} while (0) 125186121Skmacy 126186121Skmacy#define LLE_FREE(lle) do { \ 127186121Skmacy LLE_WLOCK(lle); \ 128216859Sbz LLE_FREE_LOCKED(lle); \ 129186121Skmacy} while (0) 130186121Skmacy 131186121Skmacy 132186121Skmacy#define ln_timer_ch lle_timer.ln_timer_ch 133186121Skmacy#define la_timer lle_timer.la_timer 134186121Skmacy 135186121Skmacy/* XXX bad name */ 136186121Skmacy#define L3_ADDR(lle) ((struct sockaddr *)(&lle[1])) 137186121Skmacy#define L3_ADDR_LEN(lle) (((struct sockaddr *)(&lle[1]))->sa_len) 138186121Skmacy 139186121Skmacy#ifndef LLTBL_HASHTBL_SIZE 140186121Skmacy#define LLTBL_HASHTBL_SIZE 32 /* default 32 ? */ 141186121Skmacy#endif 142186121Skmacy 143186121Skmacy#ifndef LLTBL_HASHMASK 144186121Skmacy#define LLTBL_HASHMASK (LLTBL_HASHTBL_SIZE - 1) 145186121Skmacy#endif 146186121Skmacy 147286457Smelifarotypedef struct llentry *(llt_lookup_t)(struct lltable *, u_int flags, 148286457Smelifaro const struct sockaddr *l3addr); 149286457Smelifarotypedef struct llentry *(llt_create_t)(struct lltable *, u_int flags, 150286457Smelifaro const struct sockaddr *l3addr); 151286457Smelifarotypedef int (llt_delete_t)(struct lltable *, u_int flags, 152286457Smelifaro const struct sockaddr *l3addr); 153286457Smelifarotypedef void (llt_prefix_free_t)(struct lltable *, 154286457Smelifaro const struct sockaddr *prefix, const struct sockaddr *mask, u_int flags); 155286457Smelifarotypedef int (llt_dump_t)(struct lltable *, struct sysctl_req *); 156286457Smelifaro 157186121Skmacystruct lltable { 158186121Skmacy SLIST_ENTRY(lltable) llt_link; 159186121Skmacy struct llentries lle_head[LLTBL_HASHTBL_SIZE]; 160186121Skmacy int llt_af; 161186121Skmacy struct ifnet *llt_ifp; 162186121Skmacy 163286457Smelifaro llt_lookup_t *llt_lookup; 164286457Smelifaro llt_create_t *llt_create; 165286457Smelifaro llt_delete_t *llt_delete; 166286457Smelifaro llt_prefix_free_t *llt_prefix_free; 167286457Smelifaro llt_dump_t *llt_dump; 168186121Skmacy}; 169286457Smelifaro 170186121SkmacyMALLOC_DECLARE(M_LLTABLE); 171186121Skmacy 172186121Skmacy/* 173286457Smelifaro * LLentry flags 174186121Skmacy */ 175186121Skmacy#define LLE_DELETED 0x0001 /* entry must be deleted */ 176186121Skmacy#define LLE_STATIC 0x0002 /* entry is static */ 177186121Skmacy#define LLE_IFADDR 0x0004 /* entry is interface addr */ 178186121Skmacy#define LLE_VALID 0x0008 /* ll_addr is valid */ 179186121Skmacy#define LLE_PUB 0x0020 /* publish entry ??? */ 180238990Sglebius#define LLE_LINKED 0x0040 /* linked to lookup structure */ 181286457Smelifaro/* LLE request flags */ 182238945Sglebius#define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 183186121Skmacy 184186121Skmacy#define LLATBL_HASH(key, mask) \ 185186121Skmacy (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 186186121Skmacy 187186121Skmacystruct lltable *lltable_init(struct ifnet *, int); 188186121Skmacyvoid lltable_free(struct lltable *); 189238945Sglebiusvoid lltable_prefix_free(int, struct sockaddr *, 190238945Sglebius struct sockaddr *, u_int); 191213929Sbz#if 0 192186121Skmacyvoid lltable_drain(int); 193213929Sbz#endif 194186121Skmacyint lltable_sysctl_dumparp(int, struct sysctl_req *); 195186121Skmacy 196215207Sgnnsize_t llentry_free(struct llentry *); 197238989Sglebiusstruct llentry *llentry_alloc(struct ifnet *, struct lltable *, 198238989Sglebius struct sockaddr_storage *); 199186121Skmacy 200186121Skmacy/* 201186121Skmacy * Generic link layer address lookup function. 202186121Skmacy */ 203186121Skmacystatic __inline struct llentry * 204186121Skmacylla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 205186121Skmacy{ 206286457Smelifaro 207286457Smelifaro return (llt->llt_lookup(llt, flags, l3addr)); 208186121Skmacy} 209186121Skmacy 210286457Smelifarostatic __inline struct llentry * 211286457Smelifarolla_create(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 212286457Smelifaro{ 213286457Smelifaro 214286457Smelifaro return (llt->llt_create(llt, flags, l3addr)); 215286457Smelifaro} 216286457Smelifaro 217286457Smelifarostatic __inline int 218286457Smelifarolla_delete(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 219286457Smelifaro{ 220286457Smelifaro 221286457Smelifaro return (llt->llt_delete(llt, flags, l3addr)); 222286457Smelifaro} 223286457Smelifaro 224286457Smelifaro 225186121Skmacyint lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 226245924Snp 227245924Snp#include <sys/eventhandler.h> 228245924Snpenum { 229245924Snp LLENTRY_RESOLVED, 230245924Snp LLENTRY_TIMEDOUT, 231245924Snp LLENTRY_DELETED, 232245924Snp LLENTRY_EXPIRED, 233245924Snp}; 234245924Snptypedef void (*lle_event_fn)(void *, struct llentry *, int); 235245924SnpEVENTHANDLER_DECLARE(lle_event, lle_event_fn); 236186121Skmacy#endif /* _NET_IF_LLATBL_H_ */ 237