if_llatbl.h revision 186121
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 186121 2008-12-15 06:53:09Z kmacy $"); 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 44186121Skmacy/* 45186121Skmacy * Code referencing llentry must at least hold 46186121Skmacy * a shared lock 47186121Skmacy */ 48186121Skmacystruct llentry { 49186121Skmacy LIST_ENTRY(llentry) lle_next; 50186121Skmacy struct rwlock lle_lock; 51186121Skmacy struct lltable *lle_tbl; 52186121Skmacy struct llentries *lle_head; 53186121Skmacy struct mbuf *la_hold; 54186121Skmacy time_t la_expire; 55186121Skmacy uint16_t la_flags; 56186121Skmacy uint16_t la_asked; 57186121Skmacy uint16_t la_preempt; 58186121Skmacy uint16_t ln_byhint; 59186121Skmacy int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */ 60186121Skmacy uint16_t ln_router; 61186121Skmacy time_t ln_ntick; 62186121Skmacy int lle_refcnt; 63186121Skmacy 64186121Skmacy union { 65186121Skmacy uint64_t mac_aligned; 66186121Skmacy uint16_t mac16[3]; 67186121Skmacy } ll_addr; 68186121Skmacy 69186121Skmacy /* XXX af-private? */ 70186121Skmacy union { 71186121Skmacy struct callout ln_timer_ch; 72186121Skmacy struct callout la_timer; 73186121Skmacy } lle_timer; 74186121Skmacy /* NB: struct sockaddr must immediately follow */ 75186121Skmacy}; 76186121Skmacy 77186121Skmacy#define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock) 78186121Skmacy#define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock) 79186121Skmacy#define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock) 80186121Skmacy#define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock) 81186121Skmacy#define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 82186121Skmacy#define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock) 83186121Skmacy#define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 84186121Skmacy#define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED) 85186121Skmacy 86186121Skmacy#define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 87186121Skmacy 88186121Skmacy#define LLE_ADDREF(lle) do { \ 89186121Skmacy LLE_WLOCK_ASSERT(lle); \ 90186121Skmacy KASSERT((lle)->lle_refcnt >= 0, \ 91186121Skmacy ("negative refcnt %d", (lle)->lle_refcnt)); \ 92186121Skmacy (lle)->lle_refcnt++; \ 93186121Skmacy} while (0) 94186121Skmacy 95186121Skmacy#define LLE_REMREF(lle) do { \ 96186121Skmacy LLE_WLOCK_ASSERT(lle); \ 97186121Skmacy KASSERT((lle)->lle_refcnt > 1, \ 98186121Skmacy ("bogus refcnt %d", (lle)->lle_refcnt)); \ 99186121Skmacy (lle)->lle_refcnt--; \ 100186121Skmacy} while (0) 101186121Skmacy 102186121Skmacy#define LLE_FREE_LOCKED(lle) do { \ 103186121Skmacy if ((lle)->lle_refcnt <= 1) \ 104186121Skmacy (lle)->lle_tbl->llt_free((lle)->lle_tbl, (lle));\ 105186121Skmacy else { \ 106186121Skmacy (lle)->lle_refcnt--; \ 107186121Skmacy LLE_WUNLOCK(lle); \ 108186121Skmacy } \ 109186121Skmacy /* guard against invalid refs */ \ 110186121Skmacy lle = 0; \ 111186121Skmacy} while (0) 112186121Skmacy 113186121Skmacy#define LLE_FREE(lle) do { \ 114186121Skmacy LLE_WLOCK(lle); \ 115186121Skmacy if ((lle)->lle_refcnt <= 1) \ 116186121Skmacy (lle)->lle_tbl->llt_free((lle)->lle_tbl, (lle));\ 117186121Skmacy else { \ 118186121Skmacy (lle)->lle_refcnt--; \ 119186121Skmacy LLE_WUNLOCK(lle); \ 120186121Skmacy } \ 121186121Skmacy /* guard against invalid refs */ \ 122186121Skmacy lle = 0; \ 123186121Skmacy} while (0) 124186121Skmacy 125186121Skmacy 126186121Skmacy#define ln_timer_ch lle_timer.ln_timer_ch 127186121Skmacy#define la_timer lle_timer.la_timer 128186121Skmacy 129186121Skmacy/* XXX bad name */ 130186121Skmacy#define L3_ADDR(lle) ((struct sockaddr *)(&lle[1])) 131186121Skmacy#define L3_ADDR_LEN(lle) (((struct sockaddr *)(&lle[1]))->sa_len) 132186121Skmacy 133186121Skmacy#ifndef LLTBL_HASHTBL_SIZE 134186121Skmacy#define LLTBL_HASHTBL_SIZE 32 /* default 32 ? */ 135186121Skmacy#endif 136186121Skmacy 137186121Skmacy#ifndef LLTBL_HASHMASK 138186121Skmacy#define LLTBL_HASHMASK (LLTBL_HASHTBL_SIZE - 1) 139186121Skmacy#endif 140186121Skmacy 141186121Skmacystruct lltable { 142186121Skmacy SLIST_ENTRY(lltable) llt_link; 143186121Skmacy struct llentries lle_head[LLTBL_HASHTBL_SIZE]; 144186121Skmacy int llt_af; 145186121Skmacy struct ifnet *llt_ifp; 146186121Skmacy 147186121Skmacy struct llentry * (*llt_new)(const struct sockaddr *, u_int); 148186121Skmacy void (*llt_free)(struct lltable *, struct llentry *); 149186121Skmacy struct llentry * (*llt_lookup)(struct lltable *, u_int flags, 150186121Skmacy const struct sockaddr *l3addr); 151186121Skmacy int (*llt_rtcheck)(struct ifnet *, 152186121Skmacy const struct sockaddr *); 153186121Skmacy int (*llt_dump)(struct lltable *, 154186121Skmacy struct sysctl_req *); 155186121Skmacy}; 156186121SkmacyMALLOC_DECLARE(M_LLTABLE); 157186121Skmacy 158186121Skmacy/* 159186121Skmacy * flags to be passed to arplookup. 160186121Skmacy */ 161186121Skmacy#define LLE_DELETED 0x0001 /* entry must be deleted */ 162186121Skmacy#define LLE_STATIC 0x0002 /* entry is static */ 163186121Skmacy#define LLE_IFADDR 0x0004 /* entry is interface addr */ 164186121Skmacy#define LLE_VALID 0x0008 /* ll_addr is valid */ 165186121Skmacy#define LLE_PROXY 0x0010 /* proxy entry ??? */ 166186121Skmacy#define LLE_PUB 0x0020 /* publish entry ??? */ 167186121Skmacy#define LLE_DELETE 0x4000 /* delete on a lookup - match LLE_IFADDR */ 168186121Skmacy#define LLE_CREATE 0x8000 /* create on a lookup miss */ 169186121Skmacy#define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 170186121Skmacy 171186121Skmacy#define LLATBL_HASH(key, mask) \ 172186121Skmacy (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 173186121Skmacy 174186121Skmacystruct lltable *lltable_init(struct ifnet *, int); 175186121Skmacyvoid lltable_free(struct lltable *); 176186121Skmacyvoid lltable_drain(int); 177186121Skmacyint lltable_sysctl_dumparp(int, struct sysctl_req *); 178186121Skmacy 179186121Skmacyvoid llentry_free(struct llentry *); 180186121Skmacy 181186121Skmacy/* 182186121Skmacy * Generic link layer address lookup function. 183186121Skmacy */ 184186121Skmacystatic __inline struct llentry * 185186121Skmacylla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 186186121Skmacy{ 187186121Skmacy return llt->llt_lookup(llt, flags, l3addr); 188186121Skmacy} 189186121Skmacy 190186121Skmacyint lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 191186121Skmacy#endif /* _NET_IF_LLATBL_H_ */ 192