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_
35 #include <sys/_rwlock.h>
36 #include <netinet/in.h>
44 LIST_HEAD(llentries, llentry);
46 extern 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)
54 * Code referencing llentry must at least hold
58 LIST_ENTRY(llentry) lle_next;
59 struct rwlock lle_lock;
60 struct lltable *lle_tbl;
61 struct llentries *lle_head;
62 void (*lle_free)(struct lltable *, struct llentry *);
64 int la_numheld; /* # of packets currently held */
70 int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */
79 uint8_t mac8[20]; /* IB needs 20 bytes. */
85 struct callout ln_timer_ch;
86 struct callout la_timer;
88 /* NB: struct sockaddr must immediately follow */
91 #define LLE_WLOCK(lle) rw_wlock(&(lle)->lle_lock)
92 #define LLE_RLOCK(lle) rw_rlock(&(lle)->lle_lock)
93 #define LLE_WUNLOCK(lle) rw_wunlock(&(lle)->lle_lock)
94 #define LLE_RUNLOCK(lle) rw_runlock(&(lle)->lle_lock)
95 #define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock)
96 #define LLE_TRY_UPGRADE(lle) rw_try_upgrade(&(lle)->lle_lock)
97 #define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK)
98 #define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock)
99 #define LLE_WLOCK_ASSERT(lle) rw_assert(&(lle)->lle_lock, RA_WLOCKED)
101 #define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1))
103 #define LLE_ADDREF(lle) do { \
104 LLE_WLOCK_ASSERT(lle); \
105 KASSERT((lle)->lle_refcnt >= 0, \
106 ("negative refcnt %d", (lle)->lle_refcnt)); \
107 (lle)->lle_refcnt++; \
110 #define LLE_REMREF(lle) do { \
111 LLE_WLOCK_ASSERT(lle); \
112 KASSERT((lle)->lle_refcnt > 1, \
113 ("bogus refcnt %d", (lle)->lle_refcnt)); \
114 (lle)->lle_refcnt--; \
117 #define LLE_FREE_LOCKED(lle) do { \
118 if ((lle)->lle_refcnt <= 1) \
119 (lle)->lle_tbl->llt_free((lle)->lle_tbl, (lle));\
121 (lle)->lle_refcnt--; \
124 /* guard against invalid refs */ \
128 #define LLE_FREE(lle) do { \
130 LLE_FREE_LOCKED(lle); \
134 #define ln_timer_ch lle_timer.ln_timer_ch
135 #define la_timer lle_timer.la_timer
138 #define L3_ADDR(lle) ((struct sockaddr *)(&lle[1]))
139 #define L3_ADDR_LEN(lle) (((struct sockaddr *)(&lle[1]))->sa_len)
141 #ifndef LLTBL_HASHTBL_SIZE
142 #define LLTBL_HASHTBL_SIZE 32 /* default 32 ? */
145 #ifndef LLTBL_HASHMASK
146 #define LLTBL_HASHMASK (LLTBL_HASHTBL_SIZE - 1)
150 SLIST_ENTRY(lltable) llt_link;
151 struct llentries lle_head[LLTBL_HASHTBL_SIZE];
153 struct ifnet *llt_ifp;
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,
160 struct llentry * (*llt_lookup)(struct lltable *, u_int flags,
161 const struct sockaddr *l3addr);
162 int (*llt_dump)(struct lltable *,
163 struct sysctl_req *);
165 MALLOC_DECLARE(M_LLTABLE);
168 * flags to be passed to arplookup.
170 #define LLE_DELETED 0x0001 /* entry must be deleted */
171 #define LLE_STATIC 0x0002 /* entry is static */
172 #define LLE_IFADDR 0x0004 /* entry is interface addr */
173 #define LLE_VALID 0x0008 /* ll_addr is valid */
174 #define LLE_PROXY 0x0010 /* proxy entry ??? */
175 #define LLE_PUB 0x0020 /* publish entry ??? */
176 #define LLE_DELETE 0x4000 /* delete on a lookup - match LLE_IFADDR */
177 #define LLE_CREATE 0x8000 /* create on a lookup miss */
178 #define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */
180 #define LLATBL_HASH(key, mask) \
181 (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask)
183 struct lltable *lltable_init(struct ifnet *, int);
184 void lltable_free(struct lltable *);
185 void lltable_prefix_free(int, struct sockaddr *,
186 struct sockaddr *, u_int);
188 void lltable_drain(int);
190 int lltable_sysctl_dumparp(int, struct sysctl_req *);
192 size_t llentry_free(struct llentry *);
193 int llentry_update(struct llentry **, struct lltable *,
194 struct sockaddr_storage *, struct ifnet *);
197 * Generic link layer address lookup function.
199 static __inline struct llentry *
200 lla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr)
202 return llt->llt_lookup(llt, flags, l3addr);
205 int lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *);
206 #endif /* _NET_IF_LLATBL_H_ */