Repository navigation
COMP: Set the strict store-copy format with a configured header - #1982
Open
imikejackson wants to merge 2 commits into
Open
imikejackson wants to merge 2 commits into
imikejackson wants to merge 2 commits into
Conversation
* Add the cache option SIMPLNX_STORE_COPY_STRICT_FORMAT (default OFF). When ON, a store copy to a storage format that has no registered I/O manager fails instead of falling back to in-memory storage. * Generate simplnx/Common/StoreCopyConfig.hpp from the option. Only StoreCopyUtilities.cpp and the tests that check the behavior include it, so changing the option recompiles only those files. Before, an out-of-core build passed the macro as a PUBLIC compile definition to every file that uses simplnx. * Print the option in the configuration summary. * Move PlaceholderPlanManager into UnitTestCommon and register it for the HDF5-OOC format in the strict-mode tests, so the simplnx tests no longer include the out-of-core storage plugin and a simplnx-only build with the option ON compiles and runs them. Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
* Run include(CTest) before add_subdirectory(src/apps). BUILD_TESTING is defined by include(CTest), so the nxrunner tests and the nxrunner_pipeline_flush tests were registered only after a second configure of a new build directory. * Remove the enable_testing() call in src/apps, which the earlier include(CTest) makes redundant. Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
Author
|
/azp run |
|
Azure Pipelines: Successfully started running 1 pipeline(s). |
This file contains hidden or 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
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.
Summary
The strict store-copy format switch (
SIMPLNX_STORE_COPY_STRICT_FORMAT) was a compile definition that the out-of-core build added to thesimplnxtarget as PUBLIC, so it reached every file that uses simplnx. This pull request makes it a simplnx cache option that writes a small generated header, and fixes a CTest ordering bug found while testing it.SIMPLNX_STORE_COPY_STRICT_FORMAT(defaultOFF). WhenON, a store copy to a storage format with no registered I/O manager fails instead of falling back to in-memory storage. With the optionOFF, behavior is unchanged.simplnx/Common/StoreCopyConfig.hppwith#cmakedefine01. OnlyStoreCopyUtilities.cpp,DataArrayTest.cpp,MemorySafetyTest.cppandStorageFormatPlanTest.cppinclude it, so changing the option recompiles only those files. It is a separate header, not part ofSimplnxConfig.hpp, for that reason.PlaceholderPlanManagerintoUnitTestCommonand register it for theHDF5-OOCformat in the strict-mode test branches. The simplnx tests no longer include code from the private out-of-core storage plugin, and a simplnx-only build with the optionONnow compiles and runs them. Registration keeps an I/O manager that is already registered for that format.include(CTest)beforeadd_subdirectory(src/apps).BUILD_TESTINGcomes frominclude(CTest), so in a new build directory the first configure registered none of the nxrunner tests guarded byif(BUILD_TESTING)(the 7nxrunner_pipeline_flush_*tests,nxrunner OOC threshold preferences,nxrunner cache memory budget CLI). The redundantenable_testing()insrc/appsis removed.Merge order
DREAM3D-NX sets the new option from
DREAM3DNX_ENABLE_OOCbefore it adds simplnx: BlueQuartzSoftware/DREAM3DNX#1256. Merge that pull request first. If this one merged first, the generated header would define the switch as 0 in out-of-core builds and override the definition they pass today, so those builds would silently fall back to memory. After both merge, the out-of-core plugin stops passing the definition and requires the option instead.Test Plan
Release builds, macOS arm64,
ci-macos-arm64preset with the Python bindings off:OFF, rebased ondevelop(8cad1e8): fullctest -j 1: 4029/4029 passed.ON, simplnx only: fullctest -j 1: 3928/3928 passed, plus the 9 nxrunner tests 9/9. The 3 C8 finalizer tests exist only in non-strict builds.OFFandONafter the review fixes: DataArray, MemorySafety, StorageFormatPlan and placeholder tests: 317/317 each.git diff --check.Related Issue
Related to #1777 (this changes how the switch is set, not the unknown-format policy that issue decides)