if_llatbl.h revision 225698
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 225698 2011-09-20 20:27:26Z kmacy $"); 29186121Skmacy 30186121Skmacy#ifndef _NET_IF_LLATBL_H_ 31186121Skmacy#define _NET_IF_LLATBL_H_ 32186121Skmacy 33219819Sjeff#include "opt_ofed.h" 34219819Sjeff 35186121Skmacy#include <sys/_rwlock.h> 36186121Skmacy#include <netinet/in.h> 37186121Skmacy 38186121Skmacystruct ifnet; 39186121Skmacystruct sysctl_req; 40186121Skmacystruct rt_msghdr; 41186121Skmacystruct rt_addrinfo; 42186121Skmacy 43186121Skmacystruct llentry; 44186121SkmacyLIST_HEAD(llentries, llentry); 45186121Skmacy 46196535Srwatsonextern struct rwlock lltable_rwlock; 47196535Srwatson#define LLTABLE_RLOCK() rw_rlock(&lltable_rwlock) 48196535Srwatson#define LLTABLE_RUNLOCK() rw_runlock(&lltable_rwlock) 49196535Srwatson#define LLTABLE_WLOCK() rw_wlock(&lltable_rwlock) 50196535Srwatson#define LLTABLE_WUNLOCK() rw_wunlock(&lltable_rwlock) 51196535Srwatson#define LLTABLE_LOCK_ASSERT() rw_assert(&lltable_rwlock, RA_LOCKED) 52196535Srwatson 53186121Skmacy/* 54186121Skmacy * Code referencing llentry must at least hold 55186121Skmacy * a shared lock 56186121Skmacy */ 57186121Skmacystruct llentry { 58186121Skmacy LIST_ENTRY(llentry) lle_next; 59186121Skmacy struct rwlock lle_lock; 60186121Skmacy struct lltable *lle_tbl; 61186121Skmacy struct llentries *lle_head; 62225698Skmacy void (*lle_free)(struct lltable *, struct llentry *); 63186121Skmacy struct mbuf *la_hold; 64215207Sgnn int la_numheld; /* # of packets currently held */ 65186121Skmacy time_t la_expire; 66186121Skmacy uint16_t la_flags; 67186121Skmacy uint16_t la_asked; 68186121Skmacy uint16_t la_preempt; 69186121Skmacy uint16_t ln_byhint; 70186121Skmacy int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */ 71186121Skmacy uint16_t ln_router; 72186121Skmacy time_t ln_ntick; 73186121Skmacy int lle_refcnt; 74186121Skmacy 75186121Skmacy union { 76186121Skmacy uint64_t mac_aligned; 77186121Skmacy uint16_t mac16[3]; 78219819Sjeff#ifdef OFED 79219819Sjeff uint8_t mac8[20]; /* IB needs 20 bytes. */ 80219819Sjeff#endif 81186121Skmacy } ll_addr; 82186121Skmacy 83186121Skmacy /* XXX af-private? */ 84186121Skmacy union { 85186121Skmacy struct callout ln_timer_ch; 86186121Skmacy struct callout la_timer; 87186121Skmacy } lle_timer; 88186121Skmacy /* NB: struct sockaddr must immediately follow */ 89186121Skmacy}; 90186121Skmacy 91186121Skmacy#define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock) 92186121Skmacy#define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock) 93186121Skmacy#define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock) 94186121Skmacy#define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock) 95186121Skmacy#define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 96186121Skmacy#define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock) 97186121Skmacy#define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 98186149Skmacy#define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock) 99186121Skmacy#define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED) 100186121Skmacy 101186121Skmacy#define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 102186121Skmacy 103186121Skmacy#define LLE_ADDREF(lle) do { \ 104186121Skmacy LLE_WLOCK_ASSERT(lle); \ 105186121Skmacy KASSERT((lle)->lle_refcnt >= 0, \ 106186121Skmacy ("negative refcnt %d", (lle)->lle_refcnt)); \ 107186121Skmacy (lle)->lle_refcnt++; \ 108186121Skmacy} while (0) 109186121Skmacy 110186121Skmacy#define LLE_REMREF(lle) do { \ 111186121Skmacy LLE_WLOCK_ASSERT(lle); \ 112186121Skmacy KASSERT((lle)->lle_refcnt > 1, \ 113186121Skmacy ("bogus refcnt %d", (lle)->lle_refcnt)); \ 114186121Skmacy (lle)->lle_refcnt--; \ 115186121Skmacy} while (0) 116186121Skmacy 117186121Skmacy#define LLE_FREE_LOCKED(lle) do { \ 118186121Skmacy if ((lle)->lle_refcnt <= 1) \ 119186121Skmacy (lle)->lle_tbl->llt_free((lle)->lle_tbl, (lle));\ 120186121Skmacy else { \ 121186121Skmacy (lle)->lle_refcnt--; \ 122186121Skmacy LLE_WUNLOCK(lle); \ 123186121Skmacy } \ 124186121Skmacy /* guard against invalid refs */ \ 125216859Sbz lle = NULL; \ 126186121Skmacy} while (0) 127186121Skmacy 128186121Skmacy#define LLE_FREE(lle) do { \ 129186121Skmacy LLE_WLOCK(lle); \ 130216859Sbz LLE_FREE_LOCKED(lle); \ 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 void (*llt_free)(struct lltable *, struct llentry *); 156192476Sqingli void (*llt_prefix_free)(struct lltable *, 157192476Sqingli const struct sockaddr *prefix, 158222143Sqingli const struct sockaddr *mask, 159222143Sqingli u_int flags); 160186121Skmacy struct llentry * (*llt_lookup)(struct lltable *, u_int flags, 161186121Skmacy const struct sockaddr *l3addr); 162186121Skmacy int (*llt_dump)(struct lltable *, 163186121Skmacy struct sysctl_req *); 164186121Skmacy}; 165186121SkmacyMALLOC_DECLARE(M_LLTABLE); 166186121Skmacy 167186121Skmacy/* 168186121Skmacy * flags to be passed to arplookup. 169186121Skmacy */ 170186121Skmacy#define LLE_DELETED 0x0001 /* entry must be deleted */ 171186121Skmacy#define LLE_STATIC 0x0002 /* entry is static */ 172186121Skmacy#define LLE_IFADDR 0x0004 /* entry is interface addr */ 173186121Skmacy#define LLE_VALID 0x0008 /* ll_addr is valid */ 174186121Skmacy#define LLE_PROXY 0x0010 /* proxy entry ??? */ 175186121Skmacy#define LLE_PUB 0x0020 /* publish entry ??? */ 176186121Skmacy#define LLE_DELETE 0x4000 /* delete on a lookup - match LLE_IFADDR */ 177186121Skmacy#define LLE_CREATE 0x8000 /* create on a lookup miss */ 178186121Skmacy#define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 179186121Skmacy 180186121Skmacy#define LLATBL_HASH(key, mask) \ 181186121Skmacy (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 182186121Skmacy 183186121Skmacystruct lltable *lltable_init(struct ifnet *, int); 184186121Skmacyvoid lltable_free(struct lltable *); 185192476Sqinglivoid lltable_prefix_free(int, struct sockaddr *, 186222143Sqingli struct sockaddr *, u_int); 187213929Sbz#if 0 188186121Skmacyvoid lltable_drain(int); 189213929Sbz#endif 190186121Skmacyint lltable_sysctl_dumparp(int, struct sysctl_req *); 191186121Skmacy 192215207Sgnnsize_t llentry_free(struct llentry *); 193191154Skmacyint llentry_update(struct llentry **, struct lltable *, 194205066Skmacy struct sockaddr_storage *, struct ifnet *); 195186121Skmacy 196186121Skmacy/* 197186121Skmacy * Generic link layer address lookup function. 198186121Skmacy */ 199186121Skmacystatic __inline struct llentry * 200186121Skmacylla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 201186121Skmacy{ 202186121Skmacy return llt->llt_lookup(llt, flags, l3addr); 203186121Skmacy} 204186121Skmacy 205186121Skmacyint lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 206186121Skmacy#endif /* _NET_IF_LLATBL_H_ */ 207