netstack3_ip/path_mtu.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//! Module for IP level paths' maximum transmission unit (PMTU) size
//! cache support.
use alloc::collections::HashMap;
use core::time::Duration;
use log::trace;
use net_types::ip::{GenericOverIp, Ip, IpAddress, IpVersionMarker, Mtu};
use netstack3_base::{
CoreTimerContext, HandleableTimer, Instant, InstantBindingsTypes, TimerBindingsTypes,
TimerContext,
};
/// Time between PMTU maintenance operations.
///
/// Maintenance operations are things like resetting cached PMTU data to force
/// restart PMTU discovery to detect increases in a PMTU.
///
/// 1 hour.
// TODO(ghanan): Make this value configurable by runtime options.
const MAINTENANCE_PERIOD: Duration = Duration::from_secs(3600);
/// Time for a PMTU value to be considered stale.
///
/// 3 hours.
// TODO(ghanan): Make this value configurable by runtime options.
const PMTU_STALE_TIMEOUT: Duration = Duration::from_secs(10800);
/// The timer ID for the path MTU cache.
#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, Hash, GenericOverIp)]
#[generic_over_ip(I, Ip)]
pub struct PmtuTimerId<I: Ip>(IpVersionMarker<I>);
/// The core context for the path MTU cache.
pub trait PmtuContext<I: Ip, BT: PmtuBindingsTypes> {
/// Calls a function with a mutable reference to the PMTU cache.
fn with_state_mut<O, F: FnOnce(&mut PmtuCache<I, BT>) -> O>(&mut self, cb: F) -> O;
}
/// The bindings types for path MTU discovery.
pub trait PmtuBindingsTypes: TimerBindingsTypes + InstantBindingsTypes {}
impl<BT> PmtuBindingsTypes for BT where BT: TimerBindingsTypes + InstantBindingsTypes {}
/// The bindings execution context for path MTU discovery.
trait PmtuBindingsContext: PmtuBindingsTypes + TimerContext {}
impl<BC> PmtuBindingsContext for BC where BC: PmtuBindingsTypes + TimerContext {}
/// A handler for incoming PMTU events.
///
/// `PmtuHandler` is intended to serve as the interface between ICMP the IP
/// layer, which holds the PMTU cache. In production, method calls are delegated
/// to a real [`PmtuCache`], while in testing, method calls may be delegated to
/// a fake implementation.
pub(crate) trait PmtuHandler<I: Ip, BC> {
/// Updates the PMTU between `src_ip` and `dst_ip` if `new_mtu` is less than
/// the current PMTU and does not violate the minimum MTU size requirements
/// for an IP.
fn update_pmtu_if_less(
&mut self,
bindings_ctx: &mut BC,
src_ip: I::Addr,
dst_ip: I::Addr,
new_mtu: Mtu,
);
/// Updates the PMTU between `src_ip` and `dst_ip` to the next lower
/// estimate from `from`.
fn update_pmtu_next_lower(
&mut self,
bindings_ctx: &mut BC,
src_ip: I::Addr,
dst_ip: I::Addr,
from: Mtu,
);
}
fn maybe_schedule_timer<BC: PmtuBindingsContext>(
bindings_ctx: &mut BC,
timer: &mut BC::Timer,
cache_is_empty: bool,
) {
// Only attempt to create the next maintenance task if we still have
// PMTU entries in the cache. If we don't, it would be a waste to
// schedule the timer. We will let the next creation of a PMTU entry
// create the timer.
if cache_is_empty {
return;
}
match bindings_ctx.scheduled_instant(timer) {
Some(scheduled_at) => {
let _: BC::Instant = scheduled_at;
// Timer already set, nothing to do.
}
None => {
// We only enter this match arm if a timer was not already set.
assert_eq!(bindings_ctx.schedule_timer(MAINTENANCE_PERIOD, timer), None)
}
}
}
fn handle_update_result<BC: PmtuBindingsContext>(
bindings_ctx: &mut BC,
timer: &mut BC::Timer,
result: Result<Option<Mtu>, Option<Mtu>>,
cache_is_empty: bool,
) {
// TODO(https://fxbug.dev/42174290): Do something with this `Result`.
let _: Result<_, _> = result.map(|ret| {
maybe_schedule_timer(bindings_ctx, timer, cache_is_empty);
ret
});
}
impl<I: Ip, BC: PmtuBindingsContext, CC: PmtuContext<I, BC>> PmtuHandler<I, BC> for CC {
fn update_pmtu_if_less(
&mut self,
bindings_ctx: &mut BC,
src_ip: I::Addr,
dst_ip: I::Addr,
new_mtu: Mtu,
) {
self.with_state_mut(|cache| {
let now = bindings_ctx.now();
let res = cache.update_pmtu_if_less(src_ip, dst_ip, new_mtu, now);
let is_empty = cache.is_empty();
handle_update_result(bindings_ctx, &mut cache.timer, res, is_empty);
})
}
fn update_pmtu_next_lower(
&mut self,
bindings_ctx: &mut BC,
src_ip: I::Addr,
dst_ip: I::Addr,
from: Mtu,
) {
self.with_state_mut(|cache| {
let now = bindings_ctx.now();
let res = cache.update_pmtu_next_lower(src_ip, dst_ip, from, now);
let is_empty = cache.is_empty();
handle_update_result(bindings_ctx, &mut cache.timer, res, is_empty);
})
}
}
impl<I: Ip, BC: PmtuBindingsContext, CC: PmtuContext<I, BC>> HandleableTimer<CC, BC>
for PmtuTimerId<I>
{
fn handle(self, core_ctx: &mut CC, bindings_ctx: &mut BC, _: BC::UniqueTimerId) {
let Self(IpVersionMarker { .. }) = self;
core_ctx.with_state_mut(|cache| {
let now = bindings_ctx.now();
cache.handle_timer(now);
let is_empty = cache.is_empty();
maybe_schedule_timer(bindings_ctx, &mut cache.timer, is_empty);
})
}
}
/// The key used to identify a path.
///
/// This is a tuple of (src_ip, dst_ip) as a path is only identified by the
/// source and destination addresses.
// TODO(ghanan): Should device play a part in the key-ing of a path?
#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
pub(crate) struct PmtuCacheKey<A: IpAddress>(A, A);
impl<A: IpAddress> PmtuCacheKey<A> {
fn new(src_ip: A, dst_ip: A) -> Self {
Self(src_ip, dst_ip)
}
}
/// IP layer PMTU cache data.
#[derive(Debug, PartialEq)]
pub(crate) struct PmtuCacheData<I> {
pmtu: Mtu,
last_updated: I,
}
impl<I: Instant> PmtuCacheData<I> {
/// Construct a new `PmtuCacheData`.
///
/// `last_updated` will be set to `now`.
fn new(pmtu: Mtu, now: I) -> Self {
Self { pmtu, last_updated: now }
}
}
/// A path MTU cache.
pub struct PmtuCache<I: Ip, BT: PmtuBindingsTypes> {
cache: HashMap<PmtuCacheKey<I::Addr>, PmtuCacheData<BT::Instant>>,
timer: BT::Timer,
}
impl<I: Ip, BC: PmtuBindingsTypes + TimerContext> PmtuCache<I, BC> {
pub(crate) fn new<CC: CoreTimerContext<PmtuTimerId<I>, BC>>(bindings_ctx: &mut BC) -> Self {
Self {
cache: Default::default(),
timer: CC::new_timer(bindings_ctx, PmtuTimerId::default()),
}
}
}
impl<I: Ip, BT: PmtuBindingsTypes> PmtuCache<I, BT> {
/// Gets the PMTU between `src_ip` and `dst_ip`.
pub fn get_pmtu(&self, src_ip: I::Addr, dst_ip: I::Addr) -> Option<Mtu> {
self.cache.get(&PmtuCacheKey::new(src_ip, dst_ip)).map(|x| x.pmtu)
}
/// Updates the PMTU between `src_ip` and `dst_ip` if `new_mtu` is less than
/// the current PMTU and does not violate the minimum MTU size requirements
/// for an IP.
fn update_pmtu_if_less(
&mut self,
src_ip: I::Addr,
dst_ip: I::Addr,
new_mtu: Mtu,
now: BT::Instant,
) -> Result<Option<Mtu>, Option<Mtu>> {
match self.get_pmtu(src_ip, dst_ip) {
// No PMTU exists so update.
None => self.update_pmtu(src_ip, dst_ip, new_mtu, now),
// A PMTU exists but it is greater than `new_mtu` so update.
Some(prev_mtu) if new_mtu < prev_mtu => self.update_pmtu(src_ip, dst_ip, new_mtu, now),
// A PMTU exists but it is less than or equal to `new_mtu` so no need to
// update.
Some(prev_mtu) => {
trace!("update_pmtu_if_less: Not updating the PMTU between src {} and dest {} to {:?}; is {:?}", src_ip, dst_ip, new_mtu, prev_mtu);
Ok(Some(prev_mtu))
}
}
}
/// Updates the PMTU between `src_ip` and `dst_ip` to the next lower
/// estimate from `from`.
///
/// Returns `Ok((a, b))` on successful update (a lower PMTU value, `b`,
/// exists that does not violate IP specific minimum MTU requirements and it
/// is less than the current PMTU estimate, `a`). Returns `Err(a)`
/// otherwise, where `a` is the same `a` as in the success case.
fn update_pmtu_next_lower(
&mut self,
src_ip: I::Addr,
dst_ip: I::Addr,
from: Mtu,
now: BT::Instant,
) -> Result<Option<Mtu>, Option<Mtu>> {
if let Some(next_pmtu) = next_lower_pmtu_plateau(from) {
trace!(
"update_pmtu_next_lower: Attempting to update PMTU between src {} and dest {} to {:?}",
src_ip,
dst_ip,
next_pmtu
);
self.update_pmtu_if_less(src_ip, dst_ip, next_pmtu, now)
} else {
// TODO(ghanan): Should we make sure the current PMTU value is set
// to the IP specific minimum MTU value?
trace!("update_pmtu_next_lower: Not updating PMTU between src {} and dest {} as there is no lower PMTU value from {:?}", src_ip, dst_ip, from);
Err(self.get_pmtu(src_ip, dst_ip))
}
}
/// Updates the PMTU between `src_ip` and `dst_ip` if `new_mtu` does not
/// violate IP-specific minimum MTU requirements.
///
/// Returns `Err(x)` if the `new_mtu` is less than the minimum MTU for an IP
/// where the same `x` is returned in the success case (`Ok(x)`). `x` is the
/// PMTU known by this `PmtuCache` before being updated. `x` will be `None`
/// if no PMTU is known, else `Some(y)` where `y` is the last estimate of
/// the PMTU.
fn update_pmtu(
&mut self,
src_ip: I::Addr,
dst_ip: I::Addr,
new_mtu: Mtu,
now: BT::Instant,
) -> Result<Option<Mtu>, Option<Mtu>> {
// New MTU must not be smaller than the minimum MTU for an IP.
if new_mtu < I::MINIMUM_LINK_MTU {
return Err(self.get_pmtu(src_ip, dst_ip));
}
Ok(self
.cache
.insert(PmtuCacheKey::new(src_ip, dst_ip), PmtuCacheData::new(new_mtu, now))
.map(|PmtuCacheData { pmtu, last_updated: _ }| pmtu))
}
fn handle_timer(&mut self, now: BT::Instant) {
// Make sure we expected this timer to fire.
assert!(!self.cache.is_empty());
// Remove all stale PMTU data to force restart the PMTU discovery
// process. This will be ok because the next time we try to send a
// packet to some node, we will update the PMTU with the first known
// potential PMTU (the first link's (connected to the node attempting
// PMTU discovery)) PMTU.
self.cache.retain(|_k, v| {
// TODO(ghanan): Add per-path options as per RFC 1981 section 5.3.
// Specifically, some links/paths may not need to have
// PMTU rediscovered as the PMTU will never change.
//
// TODO(ghanan): Consider not simply deleting all stale PMTU data as
// this may cause packets to be dropped every time the
// data seems to get stale when really it is still
// valid. Considering the use case, PMTU value changes
// may be infrequent so it may be enough to just use a
// long stale timer.
now.saturating_duration_since(v.last_updated) < PMTU_STALE_TIMEOUT
});
}
fn is_empty(&self) -> bool {
self.cache.is_empty()
}
}
/// Get next lower PMTU plateau value, if one exists.
fn next_lower_pmtu_plateau(start_mtu: Mtu) -> Option<Mtu> {
/// Common MTU values taken from [RFC 1191 section 7.1].
///
/// This list includes lower bounds of groups of common MTU values that are
/// relatively close to each other, sorted in descending order.
///
/// Note, the RFC does not actually include the value 1280 in the list of
/// plateau values, but we include it here because it is the minimum IPv6
/// MTU value and is not expected to be an uncommon value for MTUs.
///
/// This list MUST be sorted in descending order; methods such as
/// `next_lower_pmtu_plateau` assume `PMTU_PLATEAUS` has this property.
///
/// We use this list when estimating PMTU values when doing PMTU discovery
/// with IPv4 on paths with nodes that do not implement RFC 1191. This list
/// is useful as in practice, relatively few MTU values are in use.
///
/// [RFC 1191 section 7.1]: https://tools.ietf.org/html/rfc1191#section-7.1
const PMTU_PLATEAUS: [Mtu; 12] = [
Mtu::new(65535),
Mtu::new(32000),
Mtu::new(17914),
Mtu::new(8166),
Mtu::new(4352),
Mtu::new(2002),
Mtu::new(1492),
Mtu::new(1280),
Mtu::new(1006),
Mtu::new(508),
Mtu::new(296),
Mtu::new(68),
];
for i in 0..PMTU_PLATEAUS.len() {
let pmtu = PMTU_PLATEAUS[i];
if pmtu < start_mtu {
// Current PMTU is less than `start_mtu` and we know `PMTU_PLATEAUS`
// is sorted so this is the next best PMTU estimate.
return Some(pmtu);
}
}
None
}
#[cfg(test)]
#[macro_use]
pub(crate) mod testutil {
/// Implement the `PmtuHandler<$ip_version>` trait by just panicking.
macro_rules! impl_pmtu_handler {
($ty:ty, $ctx:ty, $ip_version:ident) => {
impl PmtuHandler<net_types::ip::$ip_version, $ctx> for $ty {
fn update_pmtu_if_less(
&mut self,
_ctx: &mut $ctx,
_src_ip: <net_types::ip::$ip_version as net_types::ip::Ip>::Addr,
_dst_ip: <net_types::ip::$ip_version as net_types::ip::Ip>::Addr,
_new_mtu: Mtu,
) {
unimplemented!()
}
fn update_pmtu_next_lower(
&mut self,
_ctx: &mut $ctx,
_src_ip: <net_types::ip::$ip_version as net_types::ip::Ip>::Addr,
_dst_ip: <net_types::ip::$ip_version as net_types::ip::Ip>::Addr,
_from: Mtu,
) {
unimplemented!()
}
}
};
}
}
#[cfg(test)]
mod tests {
use super::*;
use ip_test_macro::ip_test;
use net_types::{SpecifiedAddr, Witness};
use netstack3_base::testutil::{
assert_empty, FakeBindingsCtx, FakeCoreCtx, FakeInstant, FakeTimerCtxExt, TestIpExt,
};
use netstack3_base::{CtxPair, InstantContext, IntoCoreTimerCtx};
use test_case::test_case;
struct FakePmtuContext<I: Ip> {
cache: PmtuCache<I, FakeBindingsCtxImpl<I>>,
}
type FakeCtxImpl<I> = CtxPair<FakeCoreCtxImpl<I>, FakeBindingsCtxImpl<I>>;
type FakeCoreCtxImpl<I> = FakeCoreCtx<FakePmtuContext<I>, (), ()>;
type FakeBindingsCtxImpl<I> = FakeBindingsCtx<PmtuTimerId<I>, (), (), ()>;
impl<I: Ip> PmtuContext<I, FakeBindingsCtxImpl<I>> for FakeCoreCtxImpl<I> {
fn with_state_mut<O, F: FnOnce(&mut PmtuCache<I, FakeBindingsCtxImpl<I>>) -> O>(
&mut self,
cb: F,
) -> O {
cb(&mut self.state.cache)
}
}
fn new_context<I: Ip>() -> FakeCtxImpl<I> {
FakeCtxImpl::with_default_bindings_ctx(|bindings_ctx| {
FakeCoreCtxImpl::with_state(FakePmtuContext {
cache: PmtuCache::new::<IntoCoreTimerCtx>(bindings_ctx),
})
})
}
/// Get an IPv4 or IPv6 address within the same subnet as that of
/// `TEST_ADDRS_*`, but with the last octet set to `3`.
fn get_other_ip_address<I: TestIpExt>() -> SpecifiedAddr<I::Addr> {
I::get_other_ip_address(3)
}
impl<I: Ip, BT: PmtuBindingsTypes> PmtuCache<I, BT> {
/// Gets the last updated [`Instant`] when the PMTU between `src_ip` and
/// `dst_ip` was updated.
///
/// [`Instant`]: Instant
fn get_last_updated(&self, src_ip: I::Addr, dst_ip: I::Addr) -> Option<BT::Instant> {
self.cache.get(&PmtuCacheKey::new(src_ip, dst_ip)).map(|x| x.last_updated.clone())
}
}
#[test_case(Mtu::new(65536) => Some(Mtu::new(65535)))]
#[test_case(Mtu::new(65535) => Some(Mtu::new(32000)))]
#[test_case(Mtu::new(65534) => Some(Mtu::new(32000)))]
#[test_case(Mtu::new(32001) => Some(Mtu::new(32000)))]
#[test_case(Mtu::new(32000) => Some(Mtu::new(17914)))]
#[test_case(Mtu::new(31999) => Some(Mtu::new(17914)))]
#[test_case(Mtu::new(1281) => Some(Mtu::new(1280)))]
#[test_case(Mtu::new(1280) => Some(Mtu::new(1006)))]
#[test_case(Mtu::new(69) => Some(Mtu::new(68)))]
#[test_case(Mtu::new(68) => None)]
#[test_case(Mtu::new(67) => None)]
#[test_case(Mtu::new(0) => None)]
fn test_next_lower_pmtu_plateau(start: Mtu) -> Option<Mtu> {
next_lower_pmtu_plateau(start)
}
fn get_pmtu<I: Ip>(
core_ctx: &FakeCoreCtxImpl<I>,
src_ip: I::Addr,
dst_ip: I::Addr,
) -> Option<Mtu> {
core_ctx.state.cache.get_pmtu(src_ip, dst_ip)
}
fn get_last_updated<I: Ip>(
core_ctx: &FakeCoreCtxImpl<I>,
src_ip: I::Addr,
dst_ip: I::Addr,
) -> Option<FakeInstant> {
core_ctx.state.cache.get_last_updated(src_ip, dst_ip)
}
#[ip_test(I)]
fn test_ip_path_mtu_cache_ctx<I: TestIpExt>() {
let fake_config = I::TEST_ADDRS;
let FakeCtxImpl { mut core_ctx, mut bindings_ctx } = new_context::<I>();
// Nothing in the cache yet
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()),
None
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()),
None
);
let new_mtu1 = Mtu::new(u32::from(I::MINIMUM_LINK_MTU) + 50);
let start_time = bindings_ctx.now();
let duration = Duration::from_secs(1);
// Advance time to 1s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Update pmtu from local to remote. PMTU should be updated to
// `new_mtu1` and last updated instant should be updated to the start of
// the test + 1s.
PmtuHandler::update_pmtu_if_less(
&mut core_ctx,
&mut bindings_ctx,
fake_config.local_ip.get(),
fake_config.remote_ip.get(),
new_mtu1,
);
// Advance time to 2s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Make sure the update worked. PMTU should be updated to `new_mtu1` and
// last updated instant should be updated to the start of the test + 1s
// (when the update occurred.
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()).unwrap(),
new_mtu1
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get())
.unwrap(),
start_time + duration
);
let new_mtu2 = Mtu::new(u32::from(new_mtu1) - 1);
// Advance time to 3s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Updating again should return the last pmtu PMTU should be updated to
// `new_mtu2` and last updated instant should be updated to the start of
// the test + 3s.
PmtuHandler::update_pmtu_if_less(
&mut core_ctx,
&mut bindings_ctx,
fake_config.local_ip.get(),
fake_config.remote_ip.get(),
new_mtu2,
);
// Advance time to 4s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Make sure the update worked. PMTU should be updated to `new_mtu2` and
// last updated instant should be updated to the start of the test + 3s
// (when the update occurred).
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()).unwrap(),
new_mtu2
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get())
.unwrap(),
start_time + (duration * 3)
);
let new_mtu3 = Mtu::new(u32::from(new_mtu2) - 1);
// Advance time to 5s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Make sure update only if new PMTU is less than current (it is). PMTU
// should be updated to `new_mtu3` and last updated instant should be
// updated to the start of the test + 5s.
PmtuHandler::update_pmtu_if_less(
&mut core_ctx,
&mut bindings_ctx,
fake_config.local_ip.get(),
fake_config.remote_ip.get(),
new_mtu3,
);
// Advance time to 6s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Make sure the update worked. PMTU should be updated to `new_mtu3` and
// last updated instant should be updated to the start of the test + 5s
// (when the update occurred).
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()).unwrap(),
new_mtu3
);
let last_updated = start_time + (duration * 5);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get())
.unwrap(),
last_updated
);
let new_mtu4 = Mtu::new(u32::from(new_mtu3) + 50);
// Advance time to 7s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Make sure update only if new PMTU is less than current (it isn't)
PmtuHandler::update_pmtu_if_less(
&mut core_ctx,
&mut bindings_ctx,
fake_config.local_ip.get(),
fake_config.remote_ip.get(),
new_mtu4,
);
// Advance time to 8s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Make sure the update didn't work. PMTU and last updated should not
// have changed.
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()).unwrap(),
new_mtu3
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get())
.unwrap(),
last_updated
);
let low_mtu = Mtu::new(u32::from(I::MINIMUM_LINK_MTU) - 1);
// Advance time to 9s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Updating with MTU value less than the minimum MTU should fail.
PmtuHandler::update_pmtu_if_less(
&mut core_ctx,
&mut bindings_ctx,
fake_config.local_ip.get(),
fake_config.remote_ip.get(),
low_mtu,
);
// Advance time to 10s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Make sure the update didn't work. PMTU and last updated should not
// have changed.
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()).unwrap(),
new_mtu3
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get())
.unwrap(),
last_updated
);
}
#[ip_test(I)]
fn test_ip_pmtu_task<I: TestIpExt>() {
let fake_config = I::TEST_ADDRS;
let FakeCtxImpl { mut core_ctx, mut bindings_ctx } = new_context::<I>();
// Make sure there are no timers.
bindings_ctx.timers.assert_no_timers_installed();
let new_mtu1 = Mtu::new(u32::from(I::MINIMUM_LINK_MTU) + 50);
let start_time = bindings_ctx.now();
let duration = Duration::from_secs(1);
// Advance time to 1s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Update pmtu from local to remote. PMTU should be updated to
// `new_mtu1` and last updated instant should be updated to the start of
// the test + 1s.
PmtuHandler::update_pmtu_if_less(
&mut core_ctx,
&mut bindings_ctx,
fake_config.local_ip.get(),
fake_config.remote_ip.get(),
new_mtu1,
);
// Make sure a task got scheduled.
bindings_ctx.timers.assert_timers_installed([(
PmtuTimerId::default(),
FakeInstant::from(MAINTENANCE_PERIOD + Duration::from_secs(1)),
)]);
// Advance time to 2s.
assert_empty(bindings_ctx.trigger_timers_for(duration, &mut core_ctx));
// Make sure the update worked. PMTU should be updated to `new_mtu1` and
// last updated instant should be updated to the start of the test + 1s
// (when the update occurred.
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()).unwrap(),
new_mtu1
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get())
.unwrap(),
start_time + duration
);
// Advance time to 30mins.
assert_empty(bindings_ctx.trigger_timers_for(duration * 1798, &mut core_ctx));
// Update pmtu from local to another remote. PMTU should be updated to
// `new_mtu1` and last updated instant should be updated to the start of
// the test + 1s.
let other_ip = get_other_ip_address::<I>();
let new_mtu2 = Mtu::new(u32::from(I::MINIMUM_LINK_MTU) + 100);
PmtuHandler::update_pmtu_if_less(
&mut core_ctx,
&mut bindings_ctx,
fake_config.local_ip.get(),
other_ip.get(),
new_mtu2,
);
// Make sure there is still a task scheduled. (we know no timers got
// triggered because the `run_for` methods returned 0 so far).
bindings_ctx.timers.assert_timers_installed([(
PmtuTimerId::default(),
FakeInstant::from(MAINTENANCE_PERIOD + Duration::from_secs(1)),
)]);
// Make sure the update worked. PMTU should be updated to `new_mtu2` and
// last updated instant should be updated to the start of the test +
// 30mins + 2s (when the update occurred.
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), other_ip.get()).unwrap(),
new_mtu2
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), other_ip.get()).unwrap(),
start_time + (duration * 1800)
);
// Make sure first update is still in the cache.
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()).unwrap(),
new_mtu1
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get())
.unwrap(),
start_time + duration
);
// Advance time to 1hr + 1s. Should have triggered a timer.
bindings_ctx.trigger_timers_for_and_expect(
duration * 1801,
[PmtuTimerId::default()],
&mut core_ctx,
);
// Make sure none of the cache data has been marked as stale and
// removed.
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()).unwrap(),
new_mtu1
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get())
.unwrap(),
start_time + duration
);
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), other_ip.get()).unwrap(),
new_mtu2
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), other_ip.get()).unwrap(),
start_time + (duration * 1800)
);
// Should still have another task scheduled.
bindings_ctx.timers.assert_timers_installed([(
PmtuTimerId::default(),
FakeInstant::from(MAINTENANCE_PERIOD * 2 + Duration::from_secs(1)),
)]);
// Advance time to 3hr + 1s. Should have triggered 2 timers.
bindings_ctx.trigger_timers_for_and_expect(
duration * 7200,
[PmtuTimerId::default(), PmtuTimerId::default()],
&mut core_ctx,
);
// Make sure only the earlier PMTU data got marked as stale and removed.
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()),
None
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()),
None
);
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), other_ip.get()).unwrap(),
new_mtu2
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), other_ip.get()).unwrap(),
start_time + (duration * 1800)
);
// Should still have another task scheduled.
bindings_ctx.timers.assert_timers_installed([(
PmtuTimerId::default(),
FakeInstant::from(MAINTENANCE_PERIOD * 4 + Duration::from_secs(1)),
)]);
// Advance time to 4hr + 1s. Should have triggered 1 timers.
bindings_ctx.trigger_timers_for_and_expect(
duration * 3600,
[PmtuTimerId::default()],
&mut core_ctx,
);
// Make sure both PMTU data got marked as stale and removed.
assert_eq!(
get_pmtu(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()),
None
);
assert_eq!(
get_last_updated(&core_ctx, fake_config.local_ip.get(), fake_config.remote_ip.get()),
None
);
assert_eq!(get_pmtu(&core_ctx, fake_config.local_ip.get(), other_ip.get()), None);
assert_eq!(get_last_updated(&core_ctx, fake_config.local_ip.get(), other_ip.get()), None);
// Should not have a task scheduled since there is no more PMTU data.
bindings_ctx.timers.assert_no_timers_installed();
}
}