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.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #ifndef _NET_IF_LLATBL_H_
31 #define _NET_IF_LLATBL_H_
33 #include <sys/_rwlock.h>
34 #include <netinet/in.h>
42 LIST_HEAD(llentries, llentry);
44 extern struct rwlock lltable_rwlock;
45 #define LLTABLE_RLOCK() rw_rlock(&lltable_rwlock)
46 #define LLTABLE_RUNLOCK() rw_runlock(&lltable_rwlock)
47 #define LLTABLE_WLOCK() rw_wlock(&lltable_rwlock)
48 #define LLTABLE_WUNLOCK() rw_wunlock(&lltable_rwlock)
49 #define LLTABLE_LOCK_ASSERT() rw_assert(&lltable_rwlock, RA_LOCKED)
52 * Code referencing llentry must at least hold
56 LIST_ENTRY(llentry) lle_next;
57 struct rwlock lle_lock;
58 struct lltable *lle_tbl;
59 struct llentries *lle_head;
60 void (*lle_free)(struct lltable *, struct llentry *);
62 int la_numheld; /* # of packets currently held */
68 int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */
76 uint8_t mac8[20]; /* IB needs 20 bytes. */
81 struct callout ln_timer_ch;
82 struct callout la_timer;
84 /* NB: struct sockaddr must immediately follow */
87 #define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock)
88 #define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock)
89 #define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock)
90 #define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock)
91 #define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock)
92 #define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock)
93 #define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK)
94 #define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock)
95 #define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED)
97 #define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1))
99 #define LLE_ADDREF(lle) do { \
100 LLE_WLOCK_ASSERT(lle); \
101 KASSERT((lle)->lle_refcnt >= 0, \
102 ("negative refcnt %d on lle %p", \
103 (lle)->lle_refcnt, (lle))); \
104 (lle)->lle_refcnt++; \
107 #define LLE_REMREF(lle) do { \
108 LLE_WLOCK_ASSERT(lle); \
109 KASSERT((lle)->lle_refcnt > 0, \
110 ("bogus refcnt %d on lle %p", \
111 (lle)->lle_refcnt, (lle))); \
112 (lle)->lle_refcnt--; \
115 #define LLE_FREE_LOCKED(lle) do { \
116 if ((lle)->lle_refcnt == 1) \
117 (lle)->lle_free((lle)->lle_tbl, (lle)); \
122 /* guard against invalid refs */ \
126 #define LLE_FREE(lle) do { \
128 LLE_FREE_LOCKED(lle); \
132 #define ln_timer_ch lle_timer.ln_timer_ch
133 #define la_timer lle_timer.la_timer
136 #define L3_ADDR(lle) ((struct sockaddr *)(&lle[1]))
137 #define L3_ADDR_LEN(lle) (((struct sockaddr *)(&lle[1]))->sa_len)
139 #ifndef LLTBL_HASHTBL_SIZE
140 #define LLTBL_HASHTBL_SIZE 32 /* default 32 ? */
143 #ifndef LLTBL_HASHMASK
144 #define LLTBL_HASHMASK (LLTBL_HASHTBL_SIZE - 1)
148 SLIST_ENTRY(lltable) llt_link;
149 struct llentries lle_head[LLTBL_HASHTBL_SIZE];
151 struct ifnet *llt_ifp;
153 void (*llt_prefix_free)(struct lltable *,
154 const struct sockaddr *prefix,
155 const struct sockaddr *mask,
157 struct llentry * (*llt_lookup)(struct lltable *, u_int flags,
158 const struct sockaddr *l3addr);
159 int (*llt_dump)(struct lltable *,
160 struct sysctl_req *);
162 MALLOC_DECLARE(M_LLTABLE);
165 * flags to be passed to arplookup.
167 #define LLE_DELETED 0x0001 /* entry must be deleted */
168 #define LLE_STATIC 0x0002 /* entry is static */
169 #define LLE_IFADDR 0x0004 /* entry is interface addr */
170 #define LLE_VALID 0x0008 /* ll_addr is valid */
171 #define LLE_PUB 0x0020 /* publish entry ??? */
172 #define LLE_LINKED 0x0040 /* linked to lookup structure */
173 #define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */
174 #define LLE_DELETE 0x4000 /* delete on a lookup - match LLE_IFADDR */
175 #define LLE_CREATE 0x8000 /* create on a lookup miss */
177 #define LLATBL_HASH(key, mask) \
178 (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask)
180 struct lltable *lltable_init(struct ifnet *, int);
181 void lltable_free(struct lltable *);
182 void lltable_prefix_free(int, struct sockaddr *,
183 struct sockaddr *, u_int);
185 void lltable_drain(int);
187 int lltable_sysctl_dumparp(int, struct sysctl_req *);
189 size_t llentry_free(struct llentry *);
190 struct llentry *llentry_alloc(struct ifnet *, struct lltable *,
191 struct sockaddr_storage *);
194 * Generic link layer address lookup function.
196 static __inline struct llentry *
197 lla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr)
199 return llt->llt_lookup(llt, flags, l3addr);
202 int lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *);
204 #include <sys/eventhandler.h>
211 typedef void (*lle_event_fn)(void *, struct llentry *, int);
212 EVENTHANDLER_DECLARE(lle_event, lle_event_fn);
213 #endif /* _NET_IF_LLATBL_H_ */