if_llatbl.h revision 219819
1/* 2 * Copyright (c) 2004 Luigi Rizzo, Alessandro Cerri. All rights reserved. 3 * Copyright (c) 2004-2008 Qing Li. All rights reserved. 4 * Copyright (c) 2008 Kip Macy. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27#include <sys/cdefs.h> 28__FBSDID("$FreeBSD: head/sys/net/if_llatbl.h 219819 2011-03-21 09:40:01Z jeff $"); 29 30#ifndef _NET_IF_LLATBL_H_ 31#define _NET_IF_LLATBL_H_ 32 33#include "opt_ofed.h" 34 35#include <sys/_rwlock.h> 36#include <netinet/in.h> 37 38struct ifnet; 39struct sysctl_req; 40struct rt_msghdr; 41struct rt_addrinfo; 42 43struct llentry; 44LIST_HEAD(llentries, llentry); 45 46extern struct rwlock lltable_rwlock; 47#define LLTABLE_RLOCK() rw_rlock(&lltable_rwlock) 48#define LLTABLE_RUNLOCK() rw_runlock(&lltable_rwlock) 49#define LLTABLE_WLOCK() rw_wlock(&lltable_rwlock) 50#define LLTABLE_WUNLOCK() rw_wunlock(&lltable_rwlock) 51#define LLTABLE_LOCK_ASSERT() rw_assert(&lltable_rwlock, RA_LOCKED) 52 53/* 54 * Code referencing llentry must at least hold 55 * a shared lock 56 */ 57struct llentry { 58 LIST_ENTRY(llentry) lle_next; 59 struct rwlock lle_lock; 60 struct lltable *lle_tbl; 61 struct llentries *lle_head; 62 struct mbuf *la_hold; 63 int la_numheld; /* # of packets currently held */ 64 time_t la_expire; 65 uint16_t la_flags; 66 uint16_t la_asked; 67 uint16_t la_preempt; 68 uint16_t ln_byhint; 69 int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */ 70 uint16_t ln_router; 71 time_t ln_ntick; 72 int lle_refcnt; 73 74 union { 75 uint64_t mac_aligned; 76 uint16_t mac16[3]; 77#ifdef OFED 78 uint8_t mac8[20]; /* IB needs 20 bytes. */ 79#endif 80 } ll_addr; 81 82 /* XXX af-private? */ 83 union { 84 struct callout ln_timer_ch; 85 struct callout la_timer; 86 } lle_timer; 87 /* NB: struct sockaddr must immediately follow */ 88}; 89 90#define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock) 91#define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock) 92#define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock) 93#define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock) 94#define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 95#define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock) 96#define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 97#define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock) 98#define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED) 99 100#define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 101 102#define LLE_ADDREF(lle) do { \ 103 LLE_WLOCK_ASSERT(lle); \ 104 KASSERT((lle)->lle_refcnt >= 0, \ 105 ("negative refcnt %d", (lle)->lle_refcnt)); \ 106 (lle)->lle_refcnt++; \ 107} while (0) 108 109#define LLE_REMREF(lle) do { \ 110 LLE_WLOCK_ASSERT(lle); \ 111 KASSERT((lle)->lle_refcnt > 1, \ 112 ("bogus refcnt %d", (lle)->lle_refcnt)); \ 113 (lle)->lle_refcnt--; \ 114} while (0) 115 116#define LLE_FREE_LOCKED(lle) do { \ 117 if ((lle)->lle_refcnt <= 1) \ 118 (lle)->lle_tbl->llt_free((lle)->lle_tbl, (lle));\ 119 else { \ 120 (lle)->lle_refcnt--; \ 121 LLE_WUNLOCK(lle); \ 122 } \ 123 /* guard against invalid refs */ \ 124 lle = NULL; \ 125} while (0) 126 127#define LLE_FREE(lle) do { \ 128 LLE_WLOCK(lle); \ 129 LLE_FREE_LOCKED(lle); \ 130} while (0) 131 132 133#define ln_timer_ch lle_timer.ln_timer_ch 134#define la_timer lle_timer.la_timer 135 136/* XXX bad name */ 137#define L3_ADDR(lle) ((struct sockaddr *)(&lle[1])) 138#define L3_ADDR_LEN(lle) (((struct sockaddr *)(&lle[1]))->sa_len) 139 140#ifndef LLTBL_HASHTBL_SIZE 141#define LLTBL_HASHTBL_SIZE 32 /* default 32 ? */ 142#endif 143 144#ifndef LLTBL_HASHMASK 145#define LLTBL_HASHMASK (LLTBL_HASHTBL_SIZE - 1) 146#endif 147 148struct lltable { 149 SLIST_ENTRY(lltable) llt_link; 150 struct llentries lle_head[LLTBL_HASHTBL_SIZE]; 151 int llt_af; 152 struct ifnet *llt_ifp; 153 154 struct llentry * (*llt_new)(const struct sockaddr *, u_int); 155 void (*llt_free)(struct lltable *, struct llentry *); 156 void (*llt_prefix_free)(struct lltable *, 157 const struct sockaddr *prefix, 158 const struct sockaddr *mask); 159 struct llentry * (*llt_lookup)(struct lltable *, u_int flags, 160 const struct sockaddr *l3addr); 161 int (*llt_rtcheck)(struct ifnet *, u_int flags, 162 const struct sockaddr *); 163 int (*llt_dump)(struct lltable *, 164 struct sysctl_req *); 165}; 166MALLOC_DECLARE(M_LLTABLE); 167 168/* 169 * flags to be passed to arplookup. 170 */ 171#define LLE_DELETED 0x0001 /* entry must be deleted */ 172#define LLE_STATIC 0x0002 /* entry is static */ 173#define LLE_IFADDR 0x0004 /* entry is interface addr */ 174#define LLE_VALID 0x0008 /* ll_addr is valid */ 175#define LLE_PROXY 0x0010 /* proxy entry ??? */ 176#define LLE_PUB 0x0020 /* publish entry ??? */ 177#define LLE_DELETE 0x4000 /* delete on a lookup - match LLE_IFADDR */ 178#define LLE_CREATE 0x8000 /* create on a lookup miss */ 179#define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 180 181#define LLATBL_HASH(key, mask) \ 182 (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 183 184struct lltable *lltable_init(struct ifnet *, int); 185void lltable_free(struct lltable *); 186void lltable_prefix_free(int, struct sockaddr *, 187 struct sockaddr *); 188#if 0 189void lltable_drain(int); 190#endif 191int lltable_sysctl_dumparp(int, struct sysctl_req *); 192 193size_t llentry_free(struct llentry *); 194int llentry_update(struct llentry **, struct lltable *, 195 struct sockaddr_storage *, struct ifnet *); 196 197/* 198 * Generic link layer address lookup function. 199 */ 200static __inline struct llentry * 201lla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 202{ 203 return llt->llt_lookup(llt, flags, l3addr); 204} 205 206int lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 207#endif /* _NET_IF_LLATBL_H_ */ 208