Skip to content

dhcp_proxy: set timeout_sender only if required #1263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2025

Conversation

flouthoc
Copy link
Collaborator

@flouthoc flouthoc commented May 28, 2025

When --activity-timeout 0 there should be no reason to push messages on activity_timeout_tx as activity_timeout_rx is not receving any messages as a result all the messages pushed are just stuck in queue, resulting in no available capacity when queue becomes full.

Closes: #1262

Summary by Sourcery

Disable resetting the inactivity timer when it’s configured as zero to avoid filling the activity timeout channel and causing queue overflows.

Bug Fixes:

  • Only invoke reset on the inactivity timer when the timeout is non-zero, preventing stuck messages in the channel when the timer is disabled.

Enhancements:

  • Add an inactivity_timeout field to the DHCP proxy service to track the configured timeout duration.

Copy link

sourcery-ai bot commented May 28, 2025

Reviewer's Guide

This PR introduces an inactivity_timeout in NetavarkProxyService and wraps the reset_inactivity_timeout call in a zero-check to prevent queuing timer resets when the timeout is disabled.

Sequence diagram for conditional timer reset in get_lease

sequenceDiagram
    participant Client
    participant NPS as NetavarkProxyService
    participant TC as TimerChannel (activity_timeout_tx)

    Client->>+NPS: get_lease(request)
    NPS->>NPS: Read self.inactivity_timeout
    alt inactivity_timeout is not zero
        NPS->>NPS: self.reset_inactivity_timeout()
        NPS->>TC: Send reset signal
    end
    NPS-->>-Client: NetavarkLease / Status
Loading

File-Level Changes

Change Details Files
Add inactivity_timeout field to the proxy service
  • Declared inactivity_timeout of type Duration in NetavarkProxyService
  • Initialized inactivity_timeout when constructing the service
src/commands/dhcp_proxy.rs
Guard reset_inactivity_timeout behind non-zero timeout check
  • Wrapped self.reset_inactivity_timeout() call in if !self.inactivity_timeout.is_zero()
  • Ensured no timer reset messages are sent when inactivity_timeout is zero
src/commands/dhcp_proxy.rs

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @flouthoc - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@flouthoc flouthoc requested review from Luap99, baude and mheon May 28, 2025 18:12
@@ -55,6 +55,8 @@ struct NetavarkProxyService<W: Write + Clear> {
cache: Arc<Mutex<LeaseCache<W>>>,
// the timeout for the dora operation
dora_timeout: u32,
// inactivity_timeout duration in seconds
inactivity_timeout: Duration,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be cleaner to wrap timeout_sender in an Option<> and then the option is set to None when the timeout is zero?
Looking at the code there should not be a reason to create the channel at all when the timeout is zero I think.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be cleaner to wrap timeout_sender in an Option<> and then the option is set to None when the timeout is zero?

Yes we can do this.

Looking at the code there should not be a reason to create the channel at all when the timeout is zero I think.

Sounds like a good idea, let me see if we can do this.

@flouthoc flouthoc changed the title dhcp_proxy,teardown: don't attempt to reset timer which is not active dhcp_proxy: set timeout_sender only if required May 28, 2025
@flouthoc
Copy link
Collaborator Author

@Luap99 WDYT about this patch, could you give it a quick try.

When `--activity-timeout 0` there should be no reason to push messages
on `activity_timeout_tx` as `activity_timeout_rx` is not receving any
messages as a result all the messages pushed are just stuck in queue,
resulting in `no available capacity` when queue becomes full.

Closes: containers#1262

Signed-off-by: flouthoc <[email protected]>
@baude
Copy link
Member

baude commented May 29, 2025

LGTM

@flouthoc
Copy link
Collaborator Author

This should also close #1024

Copy link
Member

@Luap99 Luap99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

Copy link
Contributor

openshift-ci bot commented May 30, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: flouthoc, Luap99, sourcery-ai[bot]

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-bot openshift-merge-bot bot merged commit 7be5e4d into containers:main May 30, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dhcp-proxy error message in logs
3 participants