1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (c) 2014-2015 Timo Teräs
14 DEFINE_MTYPE_STATIC(NHRPD
, NHRP_CACHE
, "NHRP cache entry");
15 DEFINE_MTYPE_STATIC(NHRPD
, NHRP_CACHE_CONFIG
, "NHRP cache config entry");
17 unsigned long nhrp_cache_counts
[NHRP_CACHE_NUM_TYPES
];
19 const char *const nhrp_cache_type_str
[] = {
20 [NHRP_CACHE_INVALID
] = "invalid",
21 [NHRP_CACHE_INCOMPLETE
] = "incomplete",
22 [NHRP_CACHE_NEGATIVE
] = "negative",
23 [NHRP_CACHE_CACHED
] = "cached",
24 [NHRP_CACHE_DYNAMIC
] = "dynamic",
25 [NHRP_CACHE_NHS
] = "nhs",
26 [NHRP_CACHE_STATIC
] = "static",
27 [NHRP_CACHE_LOCAL
] = "local",
30 static unsigned int nhrp_cache_protocol_key(const void *peer_data
)
32 const struct nhrp_cache
*p
= peer_data
;
33 return sockunion_hash(&p
->remote_addr
);
36 static bool nhrp_cache_protocol_cmp(const void *cache_data
,
39 const struct nhrp_cache
*a
= cache_data
;
40 const struct nhrp_cache
*b
= key_data
;
42 return sockunion_same(&a
->remote_addr
, &b
->remote_addr
);
45 static void *nhrp_cache_alloc(void *data
)
47 struct nhrp_cache
*p
, *key
= data
;
49 p
= XMALLOC(MTYPE_NHRP_CACHE
, sizeof(struct nhrp_cache
));
51 *p
= (struct nhrp_cache
){
52 .cur
.type
= NHRP_CACHE_INVALID
,
53 .new.type
= NHRP_CACHE_INVALID
,
54 .remote_addr
= key
->remote_addr
,
57 NOTIFIER_LIST_INITIALIZER(&p
->notifier_list
),
59 nhrp_cache_counts
[p
->cur
.type
]++;
64 static void nhrp_cache_free(struct nhrp_cache
*c
)
66 struct nhrp_interface
*nifp
= c
->ifp
->info
;
68 debugf(NHRP_DEBUG_COMMON
, "Deleting cache entry");
69 nhrp_cache_counts
[c
->cur
.type
]--;
70 notifier_call(&c
->notifier_list
, NOTIFY_CACHE_DELETE
);
71 assert(!notifier_active(&c
->notifier_list
));
72 hash_release(nifp
->cache_hash
, c
);
73 THREAD_OFF(c
->t_timeout
);
74 THREAD_OFF(c
->t_auth
);
75 XFREE(MTYPE_NHRP_CACHE
, c
);
78 static unsigned int nhrp_cache_config_protocol_key(const void *peer_data
)
80 const struct nhrp_cache_config
*p
= peer_data
;
81 return sockunion_hash(&p
->remote_addr
);
84 static bool nhrp_cache_config_protocol_cmp(const void *cache_data
,
87 const struct nhrp_cache_config
*a
= cache_data
;
88 const struct nhrp_cache_config
*b
= key_data
;
90 if (!sockunion_same(&a
->remote_addr
, &b
->remote_addr
))
97 static void *nhrp_cache_config_alloc(void *data
)
99 struct nhrp_cache_config
*p
, *key
= data
;
101 p
= XCALLOC(MTYPE_NHRP_CACHE_CONFIG
, sizeof(struct nhrp_cache_config
));
103 *p
= (struct nhrp_cache_config
){
104 .remote_addr
= key
->remote_addr
,
110 void nhrp_cache_config_free(struct nhrp_cache_config
*c
)
112 struct nhrp_interface
*nifp
= c
->ifp
->info
;
114 hash_release(nifp
->cache_config_hash
, c
);
115 XFREE(MTYPE_NHRP_CACHE_CONFIG
, c
);
118 struct nhrp_cache_config
*nhrp_cache_config_get(struct interface
*ifp
,
119 union sockunion
*remote_addr
,
122 struct nhrp_interface
*nifp
= ifp
->info
;
123 struct nhrp_cache_config key
;
125 if (!nifp
->cache_config_hash
) {
126 nifp
->cache_config_hash
=
127 hash_create(nhrp_cache_config_protocol_key
,
128 nhrp_cache_config_protocol_cmp
,
129 "NHRP Config Cache");
130 if (!nifp
->cache_config_hash
)
133 key
.remote_addr
= *remote_addr
;
136 return hash_get(nifp
->cache_config_hash
, &key
,
137 create
? nhrp_cache_config_alloc
: NULL
);
140 static void do_nhrp_cache_free(struct hash_bucket
*hb
,
141 void *arg
__attribute__((__unused__
)))
143 struct nhrp_cache
*c
= hb
->data
;
148 static void do_nhrp_cache_config_free(struct hash_bucket
*hb
,
149 void *arg
__attribute__((__unused__
)))
151 struct nhrp_cache_config
*cc
= hb
->data
;
153 nhrp_cache_config_free(cc
);
156 void nhrp_cache_interface_del(struct interface
*ifp
)
158 struct nhrp_interface
*nifp
= ifp
->info
;
160 debugf(NHRP_DEBUG_COMMON
, "Cleaning up undeleted cache entries (%lu)",
161 nifp
->cache_hash
? nifp
->cache_hash
->count
: 0);
163 if (nifp
->cache_hash
) {
164 hash_iterate(nifp
->cache_hash
, do_nhrp_cache_free
, NULL
);
165 hash_free(nifp
->cache_hash
);
168 if (nifp
->cache_config_hash
) {
169 hash_iterate(nifp
->cache_config_hash
, do_nhrp_cache_config_free
,
171 hash_free(nifp
->cache_config_hash
);
175 struct nhrp_cache
*nhrp_cache_get(struct interface
*ifp
,
176 union sockunion
*remote_addr
, int create
)
178 struct nhrp_interface
*nifp
= ifp
->info
;
179 struct nhrp_cache key
;
181 if (!nifp
->cache_hash
) {
183 hash_create(nhrp_cache_protocol_key
,
184 nhrp_cache_protocol_cmp
, "NHRP Cache");
185 if (!nifp
->cache_hash
)
189 key
.remote_addr
= *remote_addr
;
192 return hash_get(nifp
->cache_hash
, &key
,
193 create
? nhrp_cache_alloc
: NULL
);
196 static void nhrp_cache_do_free(struct thread
*t
)
198 struct nhrp_cache
*c
= THREAD_ARG(t
);
204 static void nhrp_cache_do_timeout(struct thread
*t
)
206 struct nhrp_cache
*c
= THREAD_ARG(t
);
209 if (c
->cur
.type
!= NHRP_CACHE_INVALID
)
210 nhrp_cache_update_binding(c
, c
->cur
.type
, -1, NULL
, 0, NULL
,
214 static void nhrp_cache_update_route(struct nhrp_cache
*c
)
217 struct nhrp_peer
*p
= c
->cur
.peer
;
218 struct nhrp_interface
*nifp
;
220 if (!sockunion2hostprefix(&c
->remote_addr
, &pfx
))
223 if (p
&& nhrp_peer_check(p
, 1)) {
224 if (sockunion_family(&c
->cur
.remote_nbma_natoa
) != AF_UNSPEC
) {
225 /* remote_nbma_natoa is already set. Therefore, binding
226 * should be updated to this value and not vc's remote
229 debugf(NHRP_DEBUG_COMMON
,
230 "cache (remote_nbma_natoa set): Update binding for %pSU dev %s from (deleted) peer.vc.nbma %pSU to %pSU",
231 &c
->remote_addr
, p
->ifp
->name
,
232 &p
->vc
->remote
.nbma
, &c
->cur
.remote_nbma_natoa
);
234 netlink_update_binding(p
->ifp
, &c
->remote_addr
,
235 &c
->cur
.remote_nbma_natoa
);
237 /* update binding to peer->vc->remote->nbma */
238 debugf(NHRP_DEBUG_COMMON
,
239 "cache (remote_nbma_natoa unspec): Update binding for %pSU dev %s from (deleted) to peer.vc.nbma %pSU",
240 &c
->remote_addr
, p
->ifp
->name
,
241 &p
->vc
->remote
.nbma
);
243 netlink_update_binding(p
->ifp
, &c
->remote_addr
,
244 &p
->vc
->remote
.nbma
);
247 nhrp_route_announce(1, c
->cur
.type
, &pfx
, c
->ifp
, NULL
,
249 if (c
->cur
.type
>= NHRP_CACHE_DYNAMIC
) {
250 nhrp_route_update_nhrp(&pfx
, c
->ifp
);
251 c
->nhrp_route_installed
= 1;
252 } else if (c
->nhrp_route_installed
) {
253 nhrp_route_update_nhrp(&pfx
, NULL
);
254 c
->nhrp_route_installed
= 0;
256 if (!c
->route_installed
) {
257 notifier_call(&c
->notifier_list
, NOTIFY_CACHE_UP
);
258 c
->route_installed
= 1;
261 /* debug the reason for peer check fail */
264 debugf(NHRP_DEBUG_COMMON
,
265 "cache (peer check failed: online?%d requested?%d ipsec?%d)",
266 p
->online
, p
->requested
,
267 nifp
->ipsec_profile
? 1 : 0);
269 debugf(NHRP_DEBUG_COMMON
,
270 "cache (peer check failed: no p)");
272 if (c
->nhrp_route_installed
) {
273 nhrp_route_update_nhrp(&pfx
, NULL
);
274 c
->nhrp_route_installed
= 0;
276 if (c
->route_installed
) {
277 assert(sockunion2hostprefix(&c
->remote_addr
, &pfx
));
278 notifier_call(&c
->notifier_list
, NOTIFY_CACHE_DOWN
);
279 nhrp_route_announce(0, c
->cur
.type
, &pfx
, NULL
, NULL
,
281 c
->route_installed
= 0;
286 static void nhrp_cache_peer_notifier(struct notifier_block
*n
,
289 struct nhrp_cache
*c
=
290 container_of(n
, struct nhrp_cache
, peer_notifier
);
294 nhrp_cache_update_route(c
);
296 case NOTIFY_PEER_DOWN
:
297 case NOTIFY_PEER_IFCONFIG_CHANGED
:
298 notifier_call(&c
->notifier_list
, NOTIFY_CACHE_DOWN
);
299 nhrp_cache_update_binding(c
, c
->cur
.type
, -1, NULL
, 0, NULL
,
302 case NOTIFY_PEER_NBMA_CHANGING
:
303 if (c
->cur
.type
== NHRP_CACHE_DYNAMIC
)
304 c
->cur
.peer
->vc
->abort_migration
= 1;
309 static void nhrp_cache_reset_new(struct nhrp_cache
*c
)
311 THREAD_OFF(c
->t_auth
);
312 if (notifier_list_anywhere(&c
->newpeer_notifier
))
313 nhrp_peer_notify_del(c
->new.peer
, &c
->newpeer_notifier
);
314 nhrp_peer_unref(c
->new.peer
);
315 memset(&c
->new, 0, sizeof(c
->new));
316 c
->new.type
= NHRP_CACHE_INVALID
;
319 static void nhrp_cache_update_timers(struct nhrp_cache
*c
)
321 THREAD_OFF(c
->t_timeout
);
323 switch (c
->cur
.type
) {
324 case NHRP_CACHE_INVALID
:
326 thread_add_timer_msec(master
, nhrp_cache_do_free
, c
, 10,
329 case NHRP_CACHE_INCOMPLETE
:
330 case NHRP_CACHE_NEGATIVE
:
331 case NHRP_CACHE_CACHED
:
332 case NHRP_CACHE_DYNAMIC
:
334 case NHRP_CACHE_STATIC
:
335 case NHRP_CACHE_LOCAL
:
336 case NHRP_CACHE_NUM_TYPES
:
338 thread_add_timer(master
, nhrp_cache_do_timeout
, c
,
339 c
->cur
.expires
- monotime(NULL
),
345 static void nhrp_cache_authorize_binding(struct nhrp_reqid
*r
, void *arg
)
347 struct nhrp_cache
*c
= container_of(r
, struct nhrp_cache
, eventid
);
348 char buf
[3][SU_ADDRSTRLEN
];
350 debugf(NHRP_DEBUG_COMMON
, "cache: %s %pSU: %s", c
->ifp
->name
,
351 &c
->remote_addr
, (const char *)arg
);
353 nhrp_reqid_free(&nhrp_event_reqid
, r
);
355 if (arg
&& strcmp(arg
, "accept") == 0) {
357 netlink_update_binding(c
->cur
.peer
->ifp
,
358 &c
->remote_addr
, NULL
);
359 nhrp_peer_notify_del(c
->cur
.peer
, &c
->peer_notifier
);
360 nhrp_peer_unref(c
->cur
.peer
);
362 nhrp_cache_counts
[c
->cur
.type
]--;
363 nhrp_cache_counts
[c
->new.type
]++;
365 c
->cur
.peer
= nhrp_peer_ref(c
->cur
.peer
);
366 nhrp_cache_reset_new(c
);
368 nhrp_peer_notify_add(c
->cur
.peer
, &c
->peer_notifier
,
369 nhrp_cache_peer_notifier
);
371 if (sockunion_family(&c
->cur
.remote_nbma_natoa
) != AF_UNSPEC
) {
372 debugf(NHRP_DEBUG_COMMON
,
373 "cache: update binding for %pSU dev %s from (deleted) peer.vc.nbma %s to %pSU",
374 &c
->remote_addr
, c
->ifp
->name
,
375 (c
->cur
.peer
? sockunion2str(
376 &c
->cur
.peer
->vc
->remote
.nbma
, buf
[1],
379 &c
->cur
.remote_nbma_natoa
);
382 netlink_update_binding(
383 c
->cur
.peer
->ifp
, &c
->remote_addr
,
384 &c
->cur
.remote_nbma_natoa
);
387 nhrp_cache_update_route(c
);
388 notifier_call(&c
->notifier_list
, NOTIFY_CACHE_BINDING_CHANGE
);
390 nhrp_cache_reset_new(c
);
393 nhrp_cache_update_timers(c
);
396 static void nhrp_cache_do_auth_timeout(struct thread
*t
)
398 struct nhrp_cache
*c
= THREAD_ARG(t
);
400 nhrp_cache_authorize_binding(&c
->eventid
, (void *)"timeout");
403 static void nhrp_cache_newpeer_notifier(struct notifier_block
*n
,
406 struct nhrp_cache
*c
=
407 container_of(n
, struct nhrp_cache
, newpeer_notifier
);
411 if (nhrp_peer_check(c
->new.peer
, 1)) {
412 evmgr_notify("authorize-binding", c
,
413 nhrp_cache_authorize_binding
);
414 thread_add_timer(master
, nhrp_cache_do_auth_timeout
, c
,
418 case NOTIFY_PEER_DOWN
:
419 case NOTIFY_PEER_IFCONFIG_CHANGED
:
420 nhrp_cache_reset_new(c
);
425 int nhrp_cache_update_binding(struct nhrp_cache
*c
, enum nhrp_cache_type type
,
426 int holding_time
, struct nhrp_peer
*p
,
427 uint32_t mtu
, union sockunion
*nbma_oa
,
428 union sockunion
*nbma_claimed
)
430 char buf
[2][SU_ADDRSTRLEN
];
432 if (c
->cur
.type
> type
|| c
->new.type
> type
) {
438 switch (sockunion_family(&c
->remote_addr
)) {
440 if (mtu
< 576 || mtu
>= 1500)
442 /* Opennhrp announces nbma mtu, but we use protocol mtu.
443 * This heuristic tries to fix up it. */
445 mtu
= (mtu
& -16) - 80;
452 sockunion2str(&c
->cur
.remote_nbma_natoa
, buf
[0], sizeof(buf
[0]));
454 sockunion2str(nbma_oa
, buf
[1], sizeof(buf
[1]));
456 nhrp_cache_reset_new(c
);
457 if (c
->cur
.type
== type
&& c
->cur
.peer
== p
&& c
->cur
.mtu
== mtu
) {
458 debugf(NHRP_DEBUG_COMMON
,
459 "cache: same type %u, updating expiry and changing nbma addr from %s to %s",
460 type
, buf
[0], nbma_oa
? buf
[1] : "(NULL)");
461 if (holding_time
> 0)
462 c
->cur
.expires
= monotime(NULL
) + holding_time
;
465 c
->cur
.remote_nbma_natoa
= *nbma_oa
;
467 memset(&c
->cur
.remote_nbma_natoa
, 0,
468 sizeof(c
->cur
.remote_nbma_natoa
));
471 c
->cur
.remote_nbma_claimed
= *nbma_claimed
;
473 memset(&c
->cur
.remote_nbma_claimed
, 0,
474 sizeof(c
->cur
.remote_nbma_claimed
));
478 debugf(NHRP_DEBUG_COMMON
,
479 "cache: new type %u/%u, or peer %s, or mtu %u/%u, nbma %s --> %s (map %d)",
480 c
->cur
.type
, type
, (c
->cur
.peer
== p
) ? "same" : "diff",
481 c
->cur
.mtu
, mtu
, buf
[0], nbma_oa
? buf
[1] : "(NULL)",
486 c
->new.holding_time
= holding_time
;
488 c
->new.remote_nbma_natoa
= *nbma_oa
;
491 c
->new.remote_nbma_claimed
= *nbma_claimed
;
493 if (holding_time
> 0)
494 c
->new.expires
= monotime(NULL
) + holding_time
;
495 else if (holding_time
< 0)
496 nhrp_cache_reset_new(c
);
498 if (c
->new.type
== NHRP_CACHE_INVALID
499 || c
->new.type
>= NHRP_CACHE_STATIC
|| c
->map
) {
500 nhrp_cache_authorize_binding(&c
->eventid
,
503 nhrp_peer_notify_add(c
->new.peer
, &c
->newpeer_notifier
,
504 nhrp_cache_newpeer_notifier
);
505 nhrp_cache_newpeer_notifier(&c
->newpeer_notifier
,
507 thread_add_timer(master
, nhrp_cache_do_auth_timeout
, c
,
511 nhrp_cache_update_timers(c
);
516 void nhrp_cache_set_used(struct nhrp_cache
*c
, int used
)
520 notifier_call(&c
->notifier_list
, NOTIFY_CACHE_USED
);
523 struct nhrp_cache_iterator_ctx
{
524 void (*cb
)(struct nhrp_cache
*, void *);
528 struct nhrp_cache_config_iterator_ctx
{
529 void (*cb
)(struct nhrp_cache_config
*, void *);
533 static void nhrp_cache_iterator(struct hash_bucket
*b
, void *ctx
)
535 struct nhrp_cache_iterator_ctx
*ic
= ctx
;
536 ic
->cb(b
->data
, ic
->ctx
);
539 static void nhrp_cache_config_iterator(struct hash_bucket
*b
, void *ctx
)
541 struct nhrp_cache_config_iterator_ctx
*ic
= ctx
;
542 ic
->cb(b
->data
, ic
->ctx
);
545 void nhrp_cache_foreach(struct interface
*ifp
,
546 void (*cb
)(struct nhrp_cache
*, void *), void *ctx
)
548 struct nhrp_interface
*nifp
= ifp
->info
;
549 struct nhrp_cache_iterator_ctx ic
= {
550 .cb
= cb
, .ctx
= ctx
,
553 if (nifp
->cache_hash
)
554 hash_iterate(nifp
->cache_hash
, nhrp_cache_iterator
, &ic
);
557 void nhrp_cache_config_foreach(struct interface
*ifp
,
558 void (*cb
)(struct nhrp_cache_config
*, void *), void *ctx
)
560 struct nhrp_interface
*nifp
= ifp
->info
;
561 struct nhrp_cache_config_iterator_ctx ic
= {
562 .cb
= cb
, .ctx
= ctx
,
565 if (nifp
->cache_config_hash
)
566 hash_iterate(nifp
->cache_config_hash
, nhrp_cache_config_iterator
, &ic
);
569 void nhrp_cache_notify_add(struct nhrp_cache
*c
, struct notifier_block
*n
,
572 notifier_add(n
, &c
->notifier_list
, fn
);
575 void nhrp_cache_notify_del(struct nhrp_cache
*c
, struct notifier_block
*n
)
577 notifier_del(n
, &c
->notifier_list
);