Let VM control when or if to read env var options #955
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
Allow Options to be created with MMTK's built-in defaults without reading options from environment variables, and let the VM decide when to read options from environment variables. This will allow VMs to provide default options, override MMTK's default options, but can be overridden by environment variables. It will also allow VMs to completely disable the "MMTK_*" variables. For compatibility reasons, this PR does not change the default behavior of MMTKBuilder. MMTKBuilder::new will still read from environment variables, but the new constructor MMTKBuilder::new_no_env_vars will skip environment variables. Fixes: mmtk#636
qinsoon
reviewed
Sep 14, 2023
src/util/options.rs
Outdated
| // If we have env vars that start with MMTK_ and match any option (such as MMTK_STRESS_FACTOR), | ||
| // we set the option to its value (if it is a valid value). Otherwise, use the default value. | ||
| /// Create an `Options` instance with built-in default settings. | ||
| pub fn new() -> Self { |
There was a problem hiding this comment.
The public API changes include this function.
Added items to the public API
=============================
+pub fn mmtk::util::options::Options::new() -> Self
+pub fn mmtk::util::options::Options::read_env_var_settings(&mut self)
+pub fn mmtk::MMTKBuilder::new_no_env_vars() -> SelfBut this function does not need to public. The other two are fine.
There was a problem hiding this comment.
Done. I have made new() private.
Options still implements Default, so VMs can still instantiate it, although Options should usually be created by the MMTKBuilder.
There was a problem hiding this comment.
We probably don't want VMs to create Options either (they should create a builder which will create Options inside mmtk-core). I guess it was clippy that complains about Default, so we added Default. Anyway, no action is needed for this PR.
Note that Options::default() is still public.
qinsoon
added
the
PR-testing
wenyuzhao
approved these changes
Sep 15, 2023
wks
added a commit
to mmtk/mmtk-openjdk
that referenced
this pull request
Sep 21, 2023
This PR lets MMTk-side Options read environment variables for options after OpenJDK-side default options are applied. By doing this, environment variables like MMTK_THREADS are no longer ignored. Fixes: #242 This PR makes use of the change introduced in mmtk/mmtk-core#955
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.
Allow Options to be created with MMTK's built-in defaults without reading options from environment variables, and let the VM decide when to read options from environment variables.
This will allow VMs to provide default options, override MMTK's default options, but can be overridden by environment variables. It will also allow VMs to completely disable the "MMTK_*" variables.
For compatibility reasons, this PR does not change the default behavior of MMTKBuilder. MMTKBuilder::new will still read from environment variables, but the new constructor MMTKBuilder::new_no_env_vars will skip environment variables.
Fixes: #636