if_llatbl.h revision 213929
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 213929 2010-10-16 18:42:09Z bz $"); 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 44196535Srwatsonextern 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; 60186121Skmacy struct mbuf *la_hold; 61186121Skmacy time_t la_expire; 62186121Skmacy uint16_t la_flags; 63186121Skmacy uint16_t la_asked; 64186121Skmacy uint16_t la_preempt; 65186121Skmacy uint16_t ln_byhint; 66186121Skmacy int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */ 67186121Skmacy uint16_t ln_router; 68186121Skmacy time_t ln_ntick; 69186121Skmacy int lle_refcnt; 70186121Skmacy 71186121Skmacy union { 72186121Skmacy uint64_t mac_aligned; 73186121Skmacy uint16_t mac16[3]; 74186121Skmacy } ll_addr; 75186121Skmacy 76186121Skmacy /* XXX af-private? */ 77186121Skmacy union { 78186121Skmacy struct callout ln_timer_ch; 79186121Skmacy struct callout la_timer; 80186121Skmacy } lle_timer; 81186121Skmacy /* NB: struct sockaddr must immediately follow */ 82186121Skmacy}; 83186121Skmacy 84186121Skmacy#define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock) 85186121Skmacy#define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock) 86186121Skmacy#define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock) 87186121Skmacy#define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock) 88186121Skmacy#define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 89186121Skmacy#define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock) 90186121Skmacy#define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 91186149Skmacy#define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock) 92186121Skmacy#define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED) 93186121Skmacy 94186121Skmacy#define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 95186121Skmacy 96186121Skmacy#define LLE_ADDREF(lle) do { \ 97186121Skmacy LLE_WLOCK_ASSERT(lle); \ 98186121Skmacy KASSERT((lle)->lle_refcnt >= 0, \ 99186121Skmacy ("negative refcnt %d", (lle)->lle_refcnt)); \ 100186121Skmacy (lle)->lle_refcnt++; \ 101186121Skmacy} while (0) 102186121Skmacy 103186121Skmacy#define LLE_REMREF(lle) do { \ 104186121Skmacy LLE_WLOCK_ASSERT(lle); \ 105186121Skmacy KASSERT((lle)->lle_refcnt > 1, \ 106186121Skmacy ("bogus refcnt %d", (lle)->lle_refcnt)); \ 107186121Skmacy (lle)->lle_refcnt--; \ 108186121Skmacy} while (0) 109186121Skmacy 110186121Skmacy#define LLE_FREE_LOCKED(lle) do { \ 111186121Skmacy if ((lle)->lle_refcnt <= 1) \ 112186121Skmacy (lle)->lle_tbl->llt_free((lle)->lle_tbl, (lle));\ 113186121Skmacy else { \ 114186121Skmacy (lle)->lle_refcnt--; \ 115186121Skmacy LLE_WUNLOCK(lle); \ 116186121Skmacy } \ 117186121Skmacy /* guard against invalid refs */ \ 118186121Skmacy lle = 0; \ 119186121Skmacy} while (0) 120186121Skmacy 121186121Skmacy#define LLE_FREE(lle) do { \ 122186121Skmacy LLE_WLOCK(lle); \ 123186121Skmacy if ((lle)->lle_refcnt <= 1) \ 124186121Skmacy (lle)->lle_tbl->llt_free((lle)->lle_tbl, (lle));\ 125186121Skmacy else { \ 126186121Skmacy (lle)->lle_refcnt--; \ 127186121Skmacy LLE_WUNLOCK(lle); \ 128186121Skmacy } \ 129186121Skmacy /* guard against invalid refs */ \ 130186149Skmacy lle = NULL; \ 131186121Skmacy} while (0) 132186121Skmacy 133186121Skmacy 134186121Skmacy#define ln_timer_ch lle_timer.ln_timer_ch 135186121Skmacy#define la_timer lle_timer.la_timer 136186121Skmacy 137186121Skmacy/* XXX bad name */ 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 149186121Skmacystruct lltable { 150186121Skmacy SLIST_ENTRY(lltable) llt_link; 151186121Skmacy struct llentries lle_head[LLTBL_HASHTBL_SIZE]; 152186121Skmacy int llt_af; 153186121Skmacy struct ifnet *llt_ifp; 154186121Skmacy 155186121Skmacy struct llentry * (*llt_new)(const struct sockaddr *, u_int); 156186121Skmacy void (*llt_free)(struct lltable *, struct llentry *); 157192476Sqingli void (*llt_prefix_free)(struct lltable *, 158192476Sqingli const struct sockaddr *prefix, 159192476Sqingli const struct sockaddr *mask); 160186121Skmacy struct llentry * (*llt_lookup)(struct lltable *, u_int flags, 161186121Skmacy const struct sockaddr *l3addr); 162201282Sqingli int (*llt_rtcheck)(struct ifnet *, u_int flags, 163186121Skmacy const struct sockaddr *); 164186121Skmacy int (*llt_dump)(struct lltable *, 165186121Skmacy struct sysctl_req *); 166186121Skmacy}; 167186121SkmacyMALLOC_DECLARE(M_LLTABLE); 168186121Skmacy 169186121Skmacy/* 170186121Skmacy * flags to be passed to arplookup. 171186121Skmacy */ 172186121Skmacy#define LLE_DELETED 0x0001 /* entry must be deleted */ 173186121Skmacy#define LLE_STATIC 0x0002 /* entry is static */ 174186121Skmacy#define LLE_IFADDR 0x0004 /* entry is interface addr */ 175186121Skmacy#define LLE_VALID 0x0008 /* ll_addr is valid */ 176186121Skmacy#define LLE_PROXY 0x0010 /* proxy entry ??? */ 177186121Skmacy#define LLE_PUB 0x0020 /* publish entry ??? */ 178186121Skmacy#define LLE_DELETE 0x4000 /* delete on a lookup - match LLE_IFADDR */ 179186121Skmacy#define LLE_CREATE 0x8000 /* create on a lookup miss */ 180186121Skmacy#define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 181186121Skmacy 182186121Skmacy#define LLATBL_HASH(key, mask) \ 183186121Skmacy (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 184186121Skmacy 185186121Skmacystruct lltable *lltable_init(struct ifnet *, int); 186186121Skmacyvoid lltable_free(struct lltable *); 187192476Sqinglivoid lltable_prefix_free(int, struct sockaddr *, 188192476Sqingli struct sockaddr *); 189213929Sbz#if 0 190186121Skmacyvoid lltable_drain(int); 191213929Sbz#endif 192186121Skmacyint lltable_sysctl_dumparp(int, struct sysctl_req *); 193186121Skmacy 194186121Skmacyvoid llentry_free(struct llentry *); 195191154Skmacyint llentry_update(struct llentry **, struct lltable *, 196205066Skmacy struct sockaddr_storage *, struct ifnet *); 197186121Skmacy 198186121Skmacy/* 199186121Skmacy * Generic link layer address lookup function. 200186121Skmacy */ 201186121Skmacystatic __inline struct llentry * 202186121Skmacylla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 203186121Skmacy{ 204186121Skmacy return llt->llt_lookup(llt, flags, l3addr); 205186121Skmacy} 206186121Skmacy 207186121Skmacyint lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 208186121Skmacy#endif /* _NET_IF_LLATBL_H_ */ 209