mozim 0.3.2

DHCP Client Library
Documentation
// SPDX-License-Identifier: Apache-2.0

use std::time::Duration;

use super::{
    time::MIN_REBIND_RENEW_WAIT_TIME, DhcpV4Message, DhcpV4MessageType,
    DhcpV4Socket,
};
use crate::{DhcpError, DhcpV4Client, DhcpV4State, ErrorKind};

impl DhcpV4Client {
    // RFC 2131, section 4.4.5 Reacquisition and expiration
    //      In both RENEWING and REBINDING states, if the client receives no
    //      response to its DHCPREQUEST message, the client SHOULD wait
    //      one-half of the remaining time until T2 (in RENEWING state) and
    //      one-half of the remaining lease time (in REBINDING state), down to
    //      a minimum of 60 seconds, before retransmitting the DHCPREQUEST
    //      message.
    //
    // In practice, if there is less than 60 seconds till T2 expired, we should
    // only wait the T2 remaining time.
    //
    // Return `Duration::ZERO` if T2 expired.
    fn renew_max_wait_time(&self) -> Result<Duration, DhcpError> {
        if let Some(t2) = self.t2_timer.as_ref() {
            let remains = t2.remains()?;
            if remains.is_zero() {
                Ok(Duration::ZERO)
            } else {
                Ok(std::cmp::min(
                    remains,
                    std::cmp::max(remains / 2, MIN_REBIND_RENEW_WAIT_TIME),
                ))
            }
        } else {
            Err(DhcpError::new(
                ErrorKind::Bug,
                format!(
                    "gen_renew_max_wait_time() invoked without T2 timer: \
                     {self:?}"
                ),
            ))
        }
    }

    // Unicast DHCPREQUEST to DHCP server
    pub(crate) async fn renew(&mut self) -> Result<(), DhcpError> {
        loop {
            let max_wait_time = self.renew_max_wait_time()?;

            if max_wait_time.is_zero() {
                log::debug!("DHCP lease T2 expired, entering rebinding state");
                self.state = DhcpV4State::Rebinding;
                self.retry_count = 0;
                return Ok(());
            }

            match tokio::time::timeout(max_wait_time, self._renew()).await {
                Ok(Ok(())) => return Ok(()),
                Ok(Err(e)) => {
                    if max_wait_time < MIN_REBIND_RENEW_WAIT_TIME {
                        log::info!(
                            "Renew failed with {e}, will fallback to \
                             rebinding in {} seconds",
                            max_wait_time.as_secs()
                        );
                    } else {
                        log::info!(
                            "Retrying on error {e} after {} seconds",
                            max_wait_time.as_secs()
                        );
                    }
                    // We assume the failure is instant, so will not consider
                    // the time elapsed.
                    tokio::time::sleep(max_wait_time).await;
                }
                Err(_) => {
                    log::info!(
                        "Timeout({}s) on waiting DHCP server DHCPACK reply \
                         for DHCPREQUEST renew, retrying",
                        max_wait_time.as_secs(),
                    );
                    self.retry_count += 1;
                }
            }
        }
    }

    async fn _renew(&mut self) -> Result<(), DhcpError> {
        let lease = match self.lease.as_ref() {
            Some(l) => l,
            None => {
                log::error!(
                    "BUG: Got empty lease but in DhcpV4State::Renewing, \
                     rollback to DhcpV4State::InitReboot"
                );
                self.state = DhcpV4State::InitReboot;
                return Ok(());
            }
        };
        let dhcp_msg = DhcpV4Message::new_renew(self.xid, &self.config, lease);
        let xid = self.xid;
        let udp_socket = self.get_udp_socket_or_init().await?;

        log::debug!("Sending unicast DHCPREQUEST for renew");

        udp_socket.send(&dhcp_msg.to_dhcp_packet()?).await?;
        log::debug!("Waiting server reply with DHCPACK");
        loop {
            match udp_socket
                .recv_dhcp_lease(DhcpV4MessageType::Ack, xid)
                .await
            {
                Ok(Some(l)) => {
                    self.done(l)?;
                    return Ok(());
                }
                Ok(None) => (),
                Err(e) => {
                    log::info!("Ignoring invalid DHCP package: {e}");
                }
            };
        }
    }
}