if_llatbl.h revision 1.5
1 /* $NetBSD: if_llatbl.h,v 1.5 2015/11/05 06:50:51 ozaki-r Exp $ */ 2 /* 3 * Copyright (c) 2004 Luigi Rizzo, Alessandro Cerri. All rights reserved. 4 * Copyright (c) 2004-2008 Qing Li. All rights reserved. 5 * Copyright (c) 2008 Kip Macy. All rights reserved. 6 * Copyright (c) 2015 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 */ 30 #include <sys/cdefs.h> 31 32 #ifndef _NET_IF_LLATBL_H_ 33 #define _NET_IF_LLATBL_H_ 34 35 #if defined(_KERNEL_OPT) 36 #include "opt_gateway.h" 37 #endif 38 39 #include <sys/rwlock.h> 40 #ifdef GATEWAY 41 #include <sys/mutex.h> 42 #endif 43 44 #include <netinet/in.h> 45 46 struct ifnet; 47 struct sysctl_req; 48 struct rt_msghdr; 49 struct rt_addrinfo; 50 51 struct llentry; 52 LIST_HEAD(llentries, llentry); 53 54 extern krwlock_t lltable_rwlock; 55 #define LLTABLE_RLOCK() rw_enter(&lltable_rwlock, RW_READER) 56 #define LLTABLE_RUNLOCK() rw_exit(&lltable_rwlock) 57 #define LLTABLE_WLOCK() rw_enter(&lltable_rwlock, RW_WRITER) 58 #define LLTABLE_WUNLOCK() rw_exit(&lltable_rwlock) 59 #define LLTABLE_LOCK_ASSERT() KASSERT(rw_lock_held(&lltable_rwlock)) 60 61 /* 62 * Code referencing llentry must at least hold 63 * a shared lock 64 */ 65 struct llentry { 66 LIST_ENTRY(llentry) lle_next; 67 union { 68 struct in_addr addr4; 69 struct in6_addr addr6; 70 } r_l3addr; 71 union { 72 uint64_t mac_aligned; 73 uint16_t mac16[3]; 74 uint8_t mac8[20]; /* IB needs 20 bytes. */ 75 } ll_addr; 76 uint32_t spare0; 77 uint64_t spare1; 78 79 struct lltable *lle_tbl; 80 struct llentries *lle_head; 81 void (*lle_free)(struct llentry *); 82 struct mbuf *la_hold; 83 int la_numheld; /* # of packets currently held */ 84 time_t la_expire; 85 uint16_t la_flags; 86 uint16_t la_asked; 87 uint16_t la_preempt; 88 uint16_t ln_byhint; 89 int16_t ln_state; /* IPv6 has ND6_LLINFO_NOSTATE == -2 */ 90 uint16_t ln_router; 91 time_t ln_ntick; 92 int lle_refcnt; 93 94 LIST_ENTRY(llentry) lle_chain; /* chain of deleted items */ 95 struct callout lle_timer; 96 #ifdef GATEWAY 97 kmutex_t lle_lock; 98 #else 99 krwlock_t lle_lock; 100 #endif 101 102 #ifdef __NetBSD__ 103 #define la_timer lle_timer 104 struct rtentry *la_rt; 105 void *la_opaque; /* For tokenring */ 106 #endif 107 }; 108 109 110 #if 0 111 #define LLE_LOCK_TRACE(t, lle) aprint_normal( \ 112 "%s:%d: LOCK(" #t "): lle=%p\n", \ 113 __func__, __LINE__, (lle)) 114 #else 115 #define LLE_LOCK_TRACE(t, lle) do {} while (0) 116 #endif 117 118 #ifdef GATEWAY 119 #define LLE_WLOCK(lle) do { \ 120 LLE_LOCK_TRACE(WL, (lle)); \ 121 mutex_enter(&(lle)->lle_lock); \ 122 } while (0) 123 #define LLE_RLOCK(lle) do { \ 124 LLE_LOCK_TRACE(RL, (lle)); \ 125 mutex_enter(&(lle)->lle_lock); \ 126 } while (0) 127 #define LLE_WUNLOCK(lle) do { \ 128 LLE_LOCK_TRACE(WU, (lle)); \ 129 mutex_exit(&(lle)->lle_lock); \ 130 } while (0) 131 #define LLE_RUNLOCK(lle) do { \ 132 LLE_LOCK_TRACE(RU, (lle)); \ 133 mutex_exit(&(lle)->lle_lock); \ 134 } while (0) 135 #define LLE_DOWNGRADE(lle) do {} while (0) 136 #define LLE_TRY_UPGRADE(lle) (1) 137 #define LLE_LOCK_INIT(lle) mutex_init(&(lle)->lle_lock, MUTEX_DEFAULT, \ 138 IPL_NET) 139 #define LLE_LOCK_DESTROY(lle) mutex_destroy(&(lle)->lle_lock) 140 #define LLE_WLOCK_ASSERT(lle) KASSERT(mutex_owned(&(lle)->lle_lock)) 141 142 #else /* GATEWAY */ 143 #define LLE_WLOCK(lle) do { \ 144 LLE_LOCK_TRACE(WL, (lle)); \ 145 rw_enter(&(lle)->lle_lock, RW_WRITER); \ 146 } while (0) 147 #define LLE_RLOCK(lle) do { \ 148 LLE_LOCK_TRACE(RL, (lle)); \ 149 rw_enter(&(lle)->lle_lock, RW_READER); \ 150 } while (0) 151 #define LLE_WUNLOCK(lle) do { \ 152 LLE_LOCK_TRACE(WU, (lle)); \ 153 rw_exit(&(lle)->lle_lock); \ 154 } while (0) 155 #define LLE_RUNLOCK(lle) do { \ 156 LLE_LOCK_TRACE(RU, (lle)); \ 157 rw_exit(&(lle)->lle_lock); \ 158 } while (0) 159 #define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 160 #define LLE_TRY_UPGRADE(lle) rw_tryupgrade(&(lle)->lle_lock) 161 #ifdef __FreeBSD__ 162 #define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 163 #else /* XXX */ 164 #define LLE_LOCK_INIT(lle) rw_init(&(lle)->lle_lock) 165 #endif 166 #define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock) 167 #define LLE_WLOCK_ASSERT(lle) KASSERT(rw_write_held(&(lle)->lle_lock)) 168 #endif /* GATEWAY */ 169 170 #define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 171 172 #if 0 173 #define LLE_REF_TRACE(t, n) aprint_normal("%s:%d: REF(" #t "): refcnt=%d\n", \ 174 __func__, __LINE__, (n)) 175 #else 176 #define LLE_REF_TRACE(t, n) do {} while (0) 177 #endif 178 179 #define LLE_ADDREF(lle) do { \ 180 LLE_WLOCK_ASSERT(lle); \ 181 LLE_REF_TRACE(ADD, (lle)->lle_refcnt); \ 182 KASSERTMSG((lle)->lle_refcnt >= 0, \ 183 "negative refcnt %d on lle %p", \ 184 (lle)->lle_refcnt, (lle)); \ 185 (lle)->lle_refcnt++; \ 186 } while (0) 187 188 #define LLE_REMREF(lle) do { \ 189 LLE_WLOCK_ASSERT(lle); \ 190 LLE_REF_TRACE(REM, (lle)->lle_refcnt); \ 191 KASSERTMSG((lle)->lle_refcnt > 0, \ 192 "bogus refcnt %d on lle %p", \ 193 (lle)->lle_refcnt, (lle)); \ 194 (lle)->lle_refcnt--; \ 195 if ((lle)->lle_refcnt == 0) \ 196 LLE_REF_TRACE(ZERO, (lle)->lle_refcnt); \ 197 } while (0) 198 199 #define LLE_FREE_LOCKED(lle) do { \ 200 if ((lle)->lle_refcnt == 1) \ 201 (lle)->lle_free(lle); \ 202 else { \ 203 LLE_REMREF(lle); \ 204 LLE_WUNLOCK(lle); \ 205 } \ 206 /* guard against invalid refs */ \ 207 (lle) = NULL; \ 208 } while (0) 209 210 #define LLE_FREE(lle) do { \ 211 LLE_WLOCK(lle); \ 212 LLE_FREE_LOCKED(lle); \ 213 } while (0) 214 215 216 typedef struct llentry *(llt_lookup_t)(struct lltable *, u_int flags, 217 const struct sockaddr *l3addr); 218 typedef struct llentry *(llt_create_t)(struct lltable *, u_int flags, 219 const struct sockaddr *l3addr); 220 typedef int (llt_delete_t)(struct lltable *, u_int flags, 221 const struct sockaddr *l3addr); 222 typedef void (llt_prefix_free_t)(struct lltable *, 223 const struct sockaddr *prefix, const struct sockaddr *mask, u_int flags); 224 typedef int (llt_dump_entry_t)(struct lltable *, struct llentry *, 225 struct sysctl_req *); 226 typedef uint32_t (llt_hash_t)(const struct llentry *, uint32_t); 227 typedef int (llt_match_prefix_t)(const struct sockaddr *, 228 const struct sockaddr *, u_int, struct llentry *); 229 typedef void (llt_free_entry_t)(struct lltable *, struct llentry *); 230 typedef void (llt_fill_sa_entry_t)(const struct llentry *, struct sockaddr *); 231 typedef void (llt_free_tbl_t)(struct lltable *); 232 typedef void (llt_link_entry_t)(struct lltable *, struct llentry *); 233 typedef void (llt_unlink_entry_t)(struct llentry *); 234 235 typedef int (llt_foreach_cb_t)(struct lltable *, struct llentry *, void *); 236 typedef int (llt_foreach_entry_t)(struct lltable *, llt_foreach_cb_t *, void *); 237 238 struct lltable { 239 SLIST_ENTRY(lltable) llt_link; 240 int llt_af; 241 int llt_hsize; 242 struct llentries *lle_head; 243 struct ifnet *llt_ifp; 244 245 llt_lookup_t *llt_lookup; 246 llt_create_t *llt_create; 247 llt_delete_t *llt_delete; 248 llt_prefix_free_t *llt_prefix_free; 249 llt_dump_entry_t *llt_dump_entry; 250 llt_hash_t *llt_hash; 251 llt_match_prefix_t *llt_match_prefix; 252 llt_free_entry_t *llt_free_entry; 253 llt_foreach_entry_t *llt_foreach_entry; 254 llt_link_entry_t *llt_link_entry; 255 llt_unlink_entry_t *llt_unlink_entry; 256 llt_fill_sa_entry_t *llt_fill_sa_entry; 257 llt_free_tbl_t *llt_free_tbl; 258 }; 259 260 MALLOC_DECLARE(M_LLTABLE); 261 262 /* 263 * LLentry flags 264 */ 265 #define LLE_DELETED 0x0001 /* entry must be deleted */ 266 #define LLE_STATIC 0x0002 /* entry is static */ 267 #define LLE_IFADDR 0x0004 /* entry is interface addr */ 268 #define LLE_VALID 0x0008 /* ll_addr is valid */ 269 #define LLE_PUB 0x0020 /* publish entry ??? */ 270 #define LLE_LINKED 0x0040 /* linked to lookup structure */ 271 /* LLE request flags */ 272 #define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 273 274 #define LLATBL_HASH(key, mask) \ 275 (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 276 277 void lltableinit(void); 278 279 struct lltable *lltable_allocate_htbl(uint32_t hsize); 280 void lltable_free(struct lltable *); 281 void lltable_link(struct lltable *llt); 282 void lltable_prefix_free(int, struct sockaddr *, 283 struct sockaddr *, u_int); 284 void lltable_drain(int); 285 int lltable_sysctl_dumparp(int, struct sysctl_req *); 286 287 size_t llentry_free(struct llentry *); 288 struct llentry *llentry_alloc(struct ifnet *, struct lltable *, 289 struct sockaddr_storage *); 290 291 /* helper functions */ 292 size_t lltable_drop_entry_queue(struct llentry *); 293 294 struct llentry *lltable_create_lle(struct lltable *llt, u_int flags, 295 const void *paddr); 296 void lltable_link_entry(struct lltable *llt, struct llentry *lle); 297 void lltable_unlink_entry(struct lltable *llt, struct llentry *lle); 298 void lltable_fill_sa_entry(const struct llentry *lle, struct sockaddr *sa); 299 struct ifnet *lltable_get_ifp(const struct lltable *llt); 300 int lltable_get_af(const struct lltable *llt); 301 302 int lltable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f, 303 void *farg); 304 /* 305 * Generic link layer address lookup function. 306 */ 307 static __inline struct llentry * 308 lla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 309 { 310 311 return (llt->llt_lookup(llt, flags, l3addr)); 312 } 313 314 static __inline struct llentry * 315 lla_create(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 316 { 317 318 return (llt->llt_create(llt, flags, l3addr)); 319 } 320 321 static __inline int 322 lla_delete(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 323 { 324 325 return (llt->llt_delete(llt, flags, l3addr)); 326 } 327 328 329 int lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 330 331 #endif /* _NET_IF_LLATBL_H_ */ 332
Indexes created Sun Sep 28 07:09:56 GMT 2025