if_llatbl.h revision 186149
117721Speter/* 217721Speter * Copyright (c) 2004 Luigi Rizzo, Alessandro Cerri. All rights reserved. 317721Speter * Copyright (c) 2004-2008 Qing Li. All rights reserved. 417721Speter * Copyright (c) 2008 Kip Macy. All rights reserved. 517721Speter * 617721Speter * Redistribution and use in source and binary forms, with or without 717721Speter * modification, are permitted provided that the following conditions 817721Speter * are met: 917721Speter * 1. Redistributions of source code must retain the above copyright 1017721Speter * notice, this list of conditions and the following disclaimer. 1117721Speter * 2. Redistributions in binary form must reproduce the above copyright 1217721Speter * notice, this list of conditions and the following disclaimer in the 1317721Speter * documentation and/or other materials provided with the distribution. 1417721Speter * 1517721Speter * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1617721Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1717721Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1817721Speter * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 1917721Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2017721Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2117721Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2217721Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2317721Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2417721Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2517721Speter * SUCH DAMAGE. 2617721Speter */ 2717721Speter#include <sys/cdefs.h> 2817721Speter__FBSDID("$FreeBSD: head/sys/net/if_llatbl.h 186149 2008-12-16 00:20:15Z kmacy $"); 2917721Speter 3017721Speter#ifndef _NET_IF_LLATBL_H_ 3117721Speter#define _NET_IF_LLATBL_H_ 3217721Speter 3317721Speter#include <sys/_rwlock.h> 3417721Speter#include <netinet/in.h> 3517721Speter 3617721Speterstruct ifnet; 3717721Speterstruct sysctl_req; 3817721Speterstruct rt_msghdr; 3917721Speterstruct rt_addrinfo; 4017721Speter 4117721Speterstruct llentry; 4217721SpeterLIST_HEAD(llentries, llentry); 4317721Speter 4417721Speter/* 4517721Speter * Code referencing llentry must at least hold 4617721Speter * a shared lock 4717721Speter */ 4817721Speterstruct llentry { 4917721Speter LIST_ENTRY(llentry) lle_next; 5017721Speter struct rwlock lle_lock; 5117721Speter struct lltable *lle_tbl; 5217721Speter struct llentries *lle_head; 5317721Speter struct mbuf *la_hold; 5417721Speter time_t la_expire; 5517721Speter uint16_t la_flags; 5617721Speter uint16_t la_asked; 5717721Speter uint16_t la_preempt; 5817721Speter uint16_t ln_byhint; 5917721Speter int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */ 6017721Speter uint16_t ln_router; 6117721Speter time_t ln_ntick; 6217721Speter int lle_refcnt; 6317721Speter 6417721Speter union { 6517721Speter uint64_t mac_aligned; 6617721Speter uint16_t mac16[3]; 6717721Speter } ll_addr; 6817721Speter 6917721Speter /* XXX af-private? */ 7017721Speter union { 7117721Speter struct callout ln_timer_ch; 7217721Speter struct callout la_timer; 7317721Speter } lle_timer; 7417721Speter /* NB: struct sockaddr must immediately follow */ 7517721Speter}; 7617721Speter 7717721Speter#define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock) 7817721Speter#define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock) 7917721Speter#define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock) 8017721Speter#define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock) 8117721Speter#define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 8217721Speter#define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock) 8317721Speter#define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 8417721Speter#define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock) 8517721Speter#define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED) 8617721Speter 8717721Speter#define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 8817721Speter 8917721Speter#define LLE_ADDREF(lle) do { \ 9017721Speter LLE_WLOCK_ASSERT(lle); \ 9117721Speter KASSERT((lle)->lle_refcnt >= 0, \ 9217721Speter ("negative refcnt %d", (lle)->lle_refcnt)); \ 9317721Speter (lle)->lle_refcnt++; \ 9417721Speter} while (0) 9517721Speter 9617721Speter#define LLE_REMREF(lle) do { \ 9717721Speter LLE_WLOCK_ASSERT(lle); \ 9817721Speter KASSERT((lle)->lle_refcnt > 1, \ 9917721Speter ("bogus refcnt %d", (lle)->lle_refcnt)); \ 10017721Speter (lle)->lle_refcnt--; \ 10117721Speter} while (0) 10217721Speter 10317721Speter#define LLE_FREE_LOCKED(lle) do { \ 10417721Speter if ((lle)->lle_refcnt <= 1) \ 10517721Speter (lle)->lle_tbl->llt_free((lle)->lle_tbl, (lle));\ 10617721Speter else { \ 10717721Speter (lle)->lle_refcnt--; \ 10817721Speter LLE_WUNLOCK(lle); \ 10917721Speter } \ 11017721Speter /* guard against invalid refs */ \ 11117721Speter lle = 0; \ 11217721Speter} while (0) 11317721Speter 11417721Speter#define LLE_FREE(lle) do { \ 11517721Speter LLE_WLOCK(lle); \ 11617721Speter if ((lle)->lle_refcnt <= 1) \ 11717721Speter (lle)->lle_tbl->llt_free((lle)->lle_tbl, (lle));\ 11817721Speter else { \ 11917721Speter (lle)->lle_refcnt--; \ 12017721Speter LLE_WUNLOCK(lle); \ 12117721Speter } \ 12217721Speter /* guard against invalid refs */ \ 12317721Speter lle = NULL; \ 12417721Speter} while (0) 12517721Speter 12617721Speter 12717721Speter#define ln_timer_ch lle_timer.ln_timer_ch 12817721Speter#define la_timer lle_timer.la_timer 12917721Speter 13017721Speter/* XXX bad name */ 13117721Speter#define L3_ADDR(lle) ((struct sockaddr *)(&lle[1])) 13217721Speter#define L3_ADDR_LEN(lle) (((struct sockaddr *)(&lle[1]))->sa_len) 13317721Speter 13417721Speter#ifndef LLTBL_HASHTBL_SIZE 13517721Speter#define LLTBL_HASHTBL_SIZE 32 /* default 32 ? */ 13617721Speter#endif 13717721Speter 13817721Speter#ifndef LLTBL_HASHMASK 13917721Speter#define LLTBL_HASHMASK (LLTBL_HASHTBL_SIZE - 1) 14017721Speter#endif 14117721Speter 14217721Speterstruct lltable { 14317721Speter SLIST_ENTRY(lltable) llt_link; 14417721Speter struct llentries lle_head[LLTBL_HASHTBL_SIZE]; 14517721Speter int llt_af; 14617721Speter struct ifnet *llt_ifp; 14717721Speter 14817721Speter struct llentry * (*llt_new)(const struct sockaddr *, u_int); 14917721Speter void (*llt_free)(struct lltable *, struct llentry *); 15017721Speter struct llentry * (*llt_lookup)(struct lltable *, u_int flags, 15117721Speter const struct sockaddr *l3addr); 15217721Speter int (*llt_rtcheck)(struct ifnet *, 15317721Speter const struct sockaddr *); 15417721Speter int (*llt_dump)(struct lltable *, 15517721Speter struct sysctl_req *); 15617721Speter}; 15717721SpeterMALLOC_DECLARE(M_LLTABLE); 15817721Speter 15917721Speter/* 16017721Speter * flags to be passed to arplookup. 16117721Speter */ 16217721Speter#define LLE_DELETED 0x0001 /* entry must be deleted */ 16317721Speter#define LLE_STATIC 0x0002 /* entry is static */ 16417721Speter#define LLE_IFADDR 0x0004 /* entry is interface addr */ 16517721Speter#define LLE_VALID 0x0008 /* ll_addr is valid */ 16617721Speter#define LLE_PROXY 0x0010 /* proxy entry ??? */ 16717721Speter#define LLE_PUB 0x0020 /* publish entry ??? */ 16817721Speter#define LLE_DELETE 0x4000 /* delete on a lookup - match LLE_IFADDR */ 16917721Speter#define LLE_CREATE 0x8000 /* create on a lookup miss */ 17017721Speter#define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 17117721Speter 17217721Speter#define LLATBL_HASH(key, mask) \ 17317721Speter (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 17417721Speter 17517721Speterstruct lltable *lltable_init(struct ifnet *, int); 17617721Spetervoid lltable_free(struct lltable *); 17717721Spetervoid lltable_drain(int); 17817721Speterint lltable_sysctl_dumparp(int, struct sysctl_req *); 17917721Speter 18017721Spetervoid llentry_free(struct llentry *); 18117721Speter 18217721Speter/* 18317721Speter * Generic link layer address lookup function. 18417721Speter */ 18517721Speterstatic __inline struct llentry * 18617721Speterlla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 18717721Speter{ 18817721Speter return llt->llt_lookup(llt, flags, l3addr); 18917721Speter} 19017721Speter 19117721Speterint lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 19217721Speter#endif /* _NET_IF_LLATBL_H_ */ 19317721Speter