[draft] make using volatile config explicit #32558
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As described in this issue: cilium#32557 Access to a subset of fields in *DaemonConfig is dangerous as they are not finalized until runtime. This makes access to those fields explicit by putting them behind a call to Volatile() - as well as any derived config function (i.e. anything that uses a 'volatile' field). This is intended to clearly distinguish daemon config that is not finalized until newDaemon is complete. In subsequent commits we will hook functionality into the Volatile function to check for improper usage. Signed-off-by: Tom Hadlaw <tom.hadlaw@isovalent.co
Accessing any fields/functions under the Volatile() api for *DaemonConfig inside Populate (but not via the Lifecycle) is risky as those fields are not finalized until the completion of newDaemon. For each call to (*DaemonConfig).Volatile(), this walks the call stack and looks to see if the config was accessed from inside a hive Invoke or Provide which would indicate unsafe usage. Signed-off-by: Tom Hadlaw <tom.hadlaw@isovalent.com>
maintainer-s-little-helper
bot
added
the
dont-merge/needs-release-note-label
3 tasks
tommyp1ckles
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please ensure your pull request adheres to the following guidelines:
description and a
Fixes: #XXXline if the commit addresses a particularGitHub issue.
Fixes: <commit-id>tag, thenplease add the commit author[s] as reviewer[s] to this issue.
Fixes: #issue-number