if_llatbl.h revision 1.6
1 /* $NetBSD: if_llatbl.h,v 1.6 2015/11/25 06:21:26 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 #define ln_timer_ch lle_timer 105 #define ln_expire la_expire 106 #define ln_asked la_asked 107 #define ln_hold la_hold 108 struct rtentry *la_rt; 109 #define ln_rt la_rt 110 void *la_opaque; /* For tokenring */ 111 #endif 112 }; 113 114 115 #if 0 116 #define LLE_LOCK_TRACE(t, lle) aprint_normal( \ 117 "%s:%d: LOCK(" #t "): lle=%p\n", \ 118 __func__, __LINE__, (lle)) 119 #else 120 #define LLE_LOCK_TRACE(t, lle) do {} while (0) 121 #endif 122 123 #ifdef GATEWAY 124 #define LLE_WLOCK(lle) do { \ 125 LLE_LOCK_TRACE(WL, (lle)); \ 126 mutex_enter(&(lle)->lle_lock); \ 127 } while (0) 128 #define LLE_RLOCK(lle) do { \ 129 LLE_LOCK_TRACE(RL, (lle)); \ 130 mutex_enter(&(lle)->lle_lock); \ 131 } while (0) 132 #define LLE_WUNLOCK(lle) do { \ 133 LLE_LOCK_TRACE(WU, (lle)); \ 134 mutex_exit(&(lle)->lle_lock); \ 135 } while (0) 136 #define LLE_RUNLOCK(lle) do { \ 137 LLE_LOCK_TRACE(RU, (lle)); \ 138 mutex_exit(&(lle)->lle_lock); \ 139 } while (0) 140 #define LLE_DOWNGRADE(lle) do {} while (0) 141 #define LLE_TRY_UPGRADE(lle) (1) 142 #define LLE_LOCK_INIT(lle) mutex_init(&(lle)->lle_lock, MUTEX_DEFAULT, \ 143 IPL_NET) 144 #define LLE_LOCK_DESTROY(lle) mutex_destroy(&(lle)->lle_lock) 145 #define LLE_WLOCK_ASSERT(lle) KASSERT(mutex_owned(&(lle)->lle_lock)) 146 147 #else /* GATEWAY */ 148 #define LLE_WLOCK(lle) do { \ 149 LLE_LOCK_TRACE(WL, (lle)); \ 150 rw_enter(&(lle)->lle_lock, RW_WRITER); \ 151 } while (0) 152 #define LLE_RLOCK(lle) do { \ 153 LLE_LOCK_TRACE(RL, (lle)); \ 154 rw_enter(&(lle)->lle_lock, RW_READER); \ 155 } while (0) 156 #define LLE_WUNLOCK(lle) do { \ 157 LLE_LOCK_TRACE(WU, (lle)); \ 158 rw_exit(&(lle)->lle_lock); \ 159 } while (0) 160 #define LLE_RUNLOCK(lle) do { \ 161 LLE_LOCK_TRACE(RU, (lle)); \ 162 rw_exit(&(lle)->lle_lock); \ 163 } while (0) 164 #define LLE_DOWNGRADE(lle) rw_downgrade(&(lle)->lle_lock) 165 #define LLE_TRY_UPGRADE(lle) rw_tryupgrade(&(lle)->lle_lock) 166 #ifdef __FreeBSD__ 167 #define LLE_LOCK_INIT(lle) rw_init_flags(&(lle)->lle_lock, "lle", RW_DUPOK) 168 #else /* XXX */ 169 #define LLE_LOCK_INIT(lle) rw_init(&(lle)->lle_lock) 170 #endif 171 #define LLE_LOCK_DESTROY(lle) rw_destroy(&(lle)->lle_lock) 172 #define LLE_WLOCK_ASSERT(lle) KASSERT(rw_write_held(&(lle)->lle_lock)) 173 #endif /* GATEWAY */ 174 175 #define LLE_IS_VALID(lle) (((lle) != NULL) && ((lle) != (void *)-1)) 176 177 #if 0 178 #define LLE_REF_TRACE(t, n) aprint_normal("%s:%d: REF(" #t "): refcnt=%d\n", \ 179 __func__, __LINE__, (n)) 180 #else 181 #define LLE_REF_TRACE(t, n) do {} while (0) 182 #endif 183 184 #define LLE_ADDREF(lle) do { \ 185 LLE_WLOCK_ASSERT(lle); \ 186 LLE_REF_TRACE(ADD, (lle)->lle_refcnt); \ 187 KASSERTMSG((lle)->lle_refcnt >= 0, \ 188 "negative refcnt %d on lle %p", \ 189 (lle)->lle_refcnt, (lle)); \ 190 (lle)->lle_refcnt++; \ 191 } while (0) 192 193 #define LLE_REMREF(lle) do { \ 194 LLE_WLOCK_ASSERT(lle); \ 195 LLE_REF_TRACE(REM, (lle)->lle_refcnt); \ 196 KASSERTMSG((lle)->lle_refcnt > 0, \ 197 "bogus refcnt %d on lle %p", \ 198 (lle)->lle_refcnt, (lle)); \ 199 (lle)->lle_refcnt--; \ 200 if ((lle)->lle_refcnt == 0) \ 201 LLE_REF_TRACE(ZERO, (lle)->lle_refcnt); \ 202 } while (0) 203 204 #define LLE_FREE_LOCKED(lle) do { \ 205 if ((lle)->lle_refcnt == 1) \ 206 (lle)->lle_free(lle); \ 207 else { \ 208 LLE_REMREF(lle); \ 209 LLE_WUNLOCK(lle); \ 210 } \ 211 /* guard against invalid refs */ \ 212 (lle) = NULL; \ 213 } while (0) 214 215 #define LLE_FREE(lle) do { \ 216 LLE_WLOCK(lle); \ 217 LLE_FREE_LOCKED(lle); \ 218 } while (0) 219 220 221 typedef struct llentry *(llt_lookup_t)(struct lltable *, u_int flags, 222 const struct sockaddr *l3addr); 223 typedef struct llentry *(llt_create_t)(struct lltable *, u_int flags, 224 const struct sockaddr *l3addr); 225 typedef int (llt_delete_t)(struct lltable *, u_int flags, 226 const struct sockaddr *l3addr); 227 typedef void (llt_prefix_free_t)(struct lltable *, 228 const struct sockaddr *prefix, const struct sockaddr *mask, u_int flags); 229 typedef int (llt_dump_entry_t)(struct lltable *, struct llentry *, 230 struct sysctl_req *); 231 typedef uint32_t (llt_hash_t)(const struct llentry *, uint32_t); 232 typedef int (llt_match_prefix_t)(const struct sockaddr *, 233 const struct sockaddr *, u_int, struct llentry *); 234 typedef void (llt_free_entry_t)(struct lltable *, struct llentry *); 235 typedef void (llt_fill_sa_entry_t)(const struct llentry *, struct sockaddr *); 236 typedef void (llt_free_tbl_t)(struct lltable *); 237 typedef void (llt_link_entry_t)(struct lltable *, struct llentry *); 238 typedef void (llt_unlink_entry_t)(struct llentry *); 239 240 typedef int (llt_foreach_cb_t)(struct lltable *, struct llentry *, void *); 241 typedef int (llt_foreach_entry_t)(struct lltable *, llt_foreach_cb_t *, void *); 242 243 struct lltable { 244 SLIST_ENTRY(lltable) llt_link; 245 int llt_af; 246 int llt_hsize; 247 struct llentries *lle_head; 248 unsigned int llt_lle_count; 249 struct ifnet *llt_ifp; 250 251 llt_lookup_t *llt_lookup; 252 llt_create_t *llt_create; 253 llt_delete_t *llt_delete; 254 llt_prefix_free_t *llt_prefix_free; 255 llt_dump_entry_t *llt_dump_entry; 256 llt_hash_t *llt_hash; 257 llt_match_prefix_t *llt_match_prefix; 258 llt_free_entry_t *llt_free_entry; 259 llt_foreach_entry_t *llt_foreach_entry; 260 llt_link_entry_t *llt_link_entry; 261 llt_unlink_entry_t *llt_unlink_entry; 262 llt_fill_sa_entry_t *llt_fill_sa_entry; 263 llt_free_tbl_t *llt_free_tbl; 264 }; 265 266 MALLOC_DECLARE(M_LLTABLE); 267 268 /* 269 * LLentry flags 270 */ 271 #define LLE_DELETED 0x0001 /* entry must be deleted */ 272 #define LLE_STATIC 0x0002 /* entry is static */ 273 #define LLE_IFADDR 0x0004 /* entry is interface addr */ 274 #define LLE_VALID 0x0008 /* ll_addr is valid */ 275 #define LLE_PUB 0x0020 /* publish entry ??? */ 276 #define LLE_LINKED 0x0040 /* linked to lookup structure */ 277 /* LLE request flags */ 278 #define LLE_EXCLUSIVE 0x2000 /* return lle xlocked */ 279 280 #define LLATBL_HASH(key, mask) \ 281 (((((((key >> 8) ^ key) >> 8) ^ key) >> 8) ^ key) & mask) 282 283 void lltableinit(void); 284 285 struct lltable *lltable_allocate_htbl(uint32_t hsize); 286 void lltable_free(struct lltable *); 287 void lltable_link(struct lltable *llt); 288 void lltable_prefix_free(int, struct sockaddr *, 289 struct sockaddr *, u_int); 290 void lltable_drain(int); 291 void lltable_purge_entries(struct lltable *); 292 int lltable_sysctl_dumparp(int, struct sysctl_req *); 293 294 size_t llentry_free(struct llentry *); 295 struct llentry *llentry_alloc(struct ifnet *, struct lltable *, 296 struct sockaddr_storage *); 297 298 /* helper functions */ 299 size_t lltable_drop_entry_queue(struct llentry *); 300 301 struct llentry *lltable_create_lle(struct lltable *llt, u_int flags, 302 const void *paddr); 303 void lltable_link_entry(struct lltable *llt, struct llentry *lle); 304 void lltable_unlink_entry(struct lltable *llt, struct llentry *lle); 305 void lltable_fill_sa_entry(const struct llentry *lle, struct sockaddr *sa); 306 struct ifnet *lltable_get_ifp(const struct lltable *llt); 307 int lltable_get_af(const struct lltable *llt); 308 309 static inline unsigned int 310 lltable_get_entry_count(struct lltable *llt) 311 { 312 return llt->llt_lle_count; 313 } 314 315 int lltable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f, 316 void *farg); 317 /* 318 * Generic link layer address lookup function. 319 */ 320 static __inline struct llentry * 321 lla_lookup(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 322 { 323 324 return (llt->llt_lookup(llt, flags, l3addr)); 325 } 326 327 static __inline struct llentry * 328 lla_create(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 329 { 330 331 return (llt->llt_create(llt, flags, l3addr)); 332 } 333 334 static __inline int 335 lla_delete(struct lltable *llt, u_int flags, const struct sockaddr *l3addr) 336 { 337 338 return (llt->llt_delete(llt, flags, l3addr)); 339 } 340 341 342 int lla_rt_output(struct rt_msghdr *, struct rt_addrinfo *); 343 344 #endif /* _NET_IF_LLATBL_H_ */ 345
Indexes created Fri Sep 26 20:09:58 GMT 2025