From b19a5f5fcefb1549a53313bd164b8ae698eb6e5c Mon Sep 17 00:00:00 2001 From: Anton Alkin Date: Thu, 19 Nov 2026 10:45:01 +0100 Subject: [PATCH 1/2] DPL: First step in making inputs/outputs optional Adds `enabled` boolean data member to Input- and OutputSpec, complete with serialization, export/import test, and backward compatibility test. The goal is to allow the topology construction in the future to skip disabled inputs and outputs without pruning the lists, by using filtered ranges. This will lift the requirement to provide the full configuration to each executable in analysis workflows, for example, as the inputs can be re-enabled when a particular process switch is found to be true in the final configuration. --- Framework/Core/include/Framework/InputSpec.h | 4 ++ Framework/Core/include/Framework/OutputSpec.h | 3 + .../Core/src/WorkflowSerializationHelpers.cxx | 35 +++++++++ .../Core/test/test_WorkflowSerialization.cxx | 71 +++++++++++++++++++ 4 files changed, 113 insertions(+) diff --git a/Framework/Core/include/Framework/InputSpec.h b/Framework/Core/include/Framework/InputSpec.h index 9be95e6853da2..bc2cb165b8751 100644 --- a/Framework/Core/include/Framework/InputSpec.h +++ b/Framework/Core/include/Framework/InputSpec.h @@ -72,6 +72,10 @@ struct InputSpec { enum Lifetime lifetime; + /// Whether the input is enabled. Disabled inputs are optional inputs + /// which are not going to be used. + bool enabled = true; + /// A set of configurables which can be used to customise the InputSpec. std::vector metadata; diff --git a/Framework/Core/include/Framework/OutputSpec.h b/Framework/Core/include/Framework/OutputSpec.h index e92792faa6b14..093f9a2e18073 100644 --- a/Framework/Core/include/Framework/OutputSpec.h +++ b/Framework/Core/include/Framework/OutputSpec.h @@ -36,6 +36,9 @@ struct OutputSpec { std::variant matcher; #endif enum Lifetime lifetime = Lifetime::Timeframe; + /// Whether the output is enabled. Disabled outputs are optional outputs + /// which are not going to be produced. + bool enabled = true; /// Build a fully qualified tuple for the OutputSpec OutputSpec(OutputLabel const& inBinding, header::DataOrigin inOrigin, header::DataDescription inDescription, diff --git a/Framework/Core/src/WorkflowSerializationHelpers.cxx b/Framework/Core/src/WorkflowSerializationHelpers.cxx index f0d4df7ec0d0b..9601a3bb5f6a1 100644 --- a/Framework/Core/src/WorkflowSerializationHelpers.cxx +++ b/Framework/Core/src/WorkflowSerializationHelpers.cxx @@ -66,6 +66,7 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, IN_INPUT_DESCRIPTION_REF, IN_INPUT_SUBSPEC_REF, IN_INPUT_LIFETIME, + IN_INPUT_ENABLED, IN_INPUT_STARTTIME, IN_INPUT_MATCHER, IN_INPUT_MATCHER_OPERATION, @@ -78,6 +79,7 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, IN_OUTPUT_DESCRIPTION, IN_OUTPUT_SUBSPEC, IN_OUTPUT_LIFETIME, + IN_OUTPUT_ENABLED, IN_OUTPUT_OPTIONS, IN_OPTION, IN_OPTION_NAME, @@ -192,6 +194,9 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, case State::IN_INPUT_LIFETIME: s << "IN_INPUT_LIFETIME"; break; + case State::IN_INPUT_ENABLED: + s << "IN_INPUT_ENABLED"; + break; case State::IN_INPUT_STARTTIME: s << "IN_INPUT_STARTTIME"; break; @@ -216,6 +221,9 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, case State::IN_OUTPUT_LIFETIME: s << "IN_OUTPUT_LIFETIME"; break; + case State::IN_OUTPUT_ENABLED: + s << "IN_OUTPUT_ENABLED"; + break; case State::IN_OUTPUT_OPTIONS: s << "IN_OUTPUT_OPTIONS"; break; @@ -371,6 +379,9 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, } else { dataProcessors.back().inputs.push_back(InputSpec({binding}, std::move(*matcher), lifetime, inputOptions)); } + dataProcessors.back().inputs.back().enabled = enabled; + // "enabled" is optional in the JSON, so reset to the default + enabled = true; inputMatcherNodes.clear(); inputOptions.clear(); @@ -434,6 +445,9 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, } else { dataProcessors.back().outputs.push_back(OutputSpec({binding}, {origin, description}, lifetime, outputOptions)); } + dataProcessors.back().outputs.back().enabled = enabled; + // "enabled" is optional in the JSON, so reset to the default + enabled = true; outputOptions.clear(); outputHasSubSpec = false; } else if (in(State::IN_OPTION)) { @@ -649,6 +663,8 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, push(State::IN_INPUT_STARTTIME); } else if (in(State::IN_INPUT) && strncmp(str, "lifetime", length) == 0) { push(State::IN_INPUT_LIFETIME); + } else if (in(State::IN_INPUT) && strncmp(str, "enabled", length) == 0) { + push(State::IN_INPUT_ENABLED); } else if (in(State::IN_INPUT) && strncmp(str, "starttime", length) == 0) { push(State::IN_INPUT_STARTTIME); } else if (in(State::IN_INPUT) && strncmp(str, "metadata", length) == 0) { @@ -664,6 +680,8 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, outputHasSubSpec = true; } else if (in(State::IN_OUTPUT) && strncmp(str, "lifetime", length) == 0) { push(State::IN_OUTPUT_LIFETIME); + } else if (in(State::IN_OUTPUT) && strncmp(str, "enabled", length) == 0) { + push(State::IN_OUTPUT_ENABLED); } else if (in(State::IN_OUTPUT) && strncmp(str, "metadata", length) == 0) { push(State::IN_OUTPUT_OPTIONS); } else if (in(State::IN_DATAPROCESSOR) && strncmp(str, "name", length) == 0) { @@ -848,6 +866,18 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, return true; } + bool Bool(bool b) + { + O2_SIGNPOST_EVENT_EMIT(workflow_importer, _o2_signpost_id_t{(int64_t)states.size()}, "import", "Bool(%s)", b ? "true" : "false"); + if (in(State::IN_INPUT_ENABLED)) { + enabled = b; + } else if (in(State::IN_OUTPUT_ENABLED)) { + enabled = b; + } + pop(); + return true; + } + bool Int(int i) { O2_SIGNPOST_EVENT_EMIT(workflow_importer, _o2_signpost_id_t{(int64_t)states.size()}, "import", "Int(%d)", i); @@ -918,6 +948,7 @@ struct WorkflowImporter : public rapidjson::BaseReaderHandler, size_t subspec; size_t ref; Lifetime lifetime; + bool enabled = true; std::string metadatumKey; std::string metadatumValue; std::string optionName; @@ -1117,6 +1148,8 @@ void WorkflowSerializationHelpers::dump(std::ostream& out, } w.Key("lifetime"); w.Uint((int)input.lifetime); + w.Key("enabled"); + w.Bool(input.enabled); if (input.metadata.empty() == false) { w.Key("metadata"); w.StartArray(); @@ -1166,6 +1199,8 @@ void WorkflowSerializationHelpers::dump(std::ostream& out, } w.Key("lifetime"); w.Uint((int)output.lifetime); + w.Key("enabled"); + w.Bool(output.enabled); if (output.metadata.empty() == false) { w.Key("metadata"); w.StartArray(); diff --git a/Framework/Core/test/test_WorkflowSerialization.cxx b/Framework/Core/test/test_WorkflowSerialization.cxx index 8d2ca579c0ede..745704796bdbc 100644 --- a/Framework/Core/test/test_WorkflowSerialization.cxx +++ b/Framework/Core/test/test_WorkflowSerialization.cxx @@ -12,6 +12,7 @@ #include "Framework/WorkflowSpec.h" #include "../src/WorkflowSerializationHelpers.h" #include +#include using namespace o2::framework; @@ -169,3 +170,73 @@ TEST_CASE("TestInputOutputSpecMetadata") REQUIRE(wso[0].outputs[0].metadata[0] == wsi[0].outputs[0].metadata[0]); REQUIRE(wso[0].outputs[0].metadata[1] == wsi[0].outputs[0].metadata[1]); } + +TEST_CASE("TestInputOutputSpecEnabled") +{ + InputSpec i1{"i1", "TST", "INPUT1", 0}; + InputSpec i2{"i2", "TST", "INPUT2", 1}; + i2.enabled = false; + // wildcard on subspec, imported via the DataDescriptorMatcher path + InputSpec i3{"i3", ConcreteDataTypeMatcher{"TST", "INPUT3"}}; + i3.enabled = false; + OutputSpec o1{OutputLabel{"o1"}, "TST", "OUTPUT1", 0}; + OutputSpec o2{OutputLabel{"o2"}, ConcreteDataTypeMatcher{"TST", "OUTPUT2"}}; + o2.enabled = false; + OutputSpec o3{OutputLabel{"o3"}, "TST", "OUTPUT3", 3}; + o3.enabled = false; + + WorkflowSpec wso{ + DataProcessorSpec{ + .name = "S1", + .inputs = {i1, i2, i3}, + .outputs = {o1, o2, o3}}}; + + std::vector dataProcessorInfoOut{ + {.name = "S1", .executable = "test_Framework_test_SerializationWorkflow"}, + }; + CommandInfo commandInfoOut{"o2-dpl-workflow -b"}; + + std::ostringstream firstDump; + WorkflowSerializationHelpers::dump(firstDump, wso, dataProcessorInfoOut, commandInfoOut); + + std::vector dataProcessorInfoIn{}; + CommandInfo commandInfoIn; + std::istringstream is; + is.str(firstDump.str()); + WorkflowSpec wsi; + REQUIRE(WorkflowSerializationHelpers::import(is, wsi, dataProcessorInfoIn, commandInfoIn)); + + REQUIRE(wsi.size() == 1); + REQUIRE(wsi[0].inputs.size() == wso[0].inputs.size()); + REQUIRE(wsi[0].outputs.size() == wso[0].outputs.size()); + for (size_t i = 0; i < wso[0].inputs.size(); ++i) { + REQUIRE(wsi[0].inputs[i].enabled == wso[0].inputs[i].enabled); + } + for (size_t i = 0; i < wso[0].outputs.size(); ++i) { + REQUIRE(wsi[0].outputs[i].enabled == wso[0].outputs[i].enabled); + } + + std::ostringstream secondDump; + WorkflowSerializationHelpers::dump(secondDump, wsi, dataProcessorInfoIn, commandInfoIn); + REQUIRE(firstDump.str() == secondDump.str()); + + // Backward compatibility: a JSON without the "enabled" key + // must import everything as enabled. + auto legacy = std::regex_replace(firstDump.str(), std::regex(R"(,\s*"enabled":\s*(true|false))"), ""); + REQUIRE(legacy.find("\"enabled\"") == std::string::npos); + std::istringstream lis; + lis.str(legacy); + WorkflowSpec wsl; + std::vector dataProcessorInfoLegacy{}; + CommandInfo commandInfoLegacy; + REQUIRE(WorkflowSerializationHelpers::import(lis, wsl, dataProcessorInfoLegacy, commandInfoLegacy)); + REQUIRE(wsl.size() == 1); + REQUIRE(wsl[0].inputs.size() == wso[0].inputs.size()); + REQUIRE(wsl[0].outputs.size() == wso[0].outputs.size()); + for (auto const& input : wsl[0].inputs) { + REQUIRE(input.enabled); + } + for (auto const& output : wsl[0].outputs) { + REQUIRE(output.enabled); + } +} From d1a4d05b7a0703e57c575763e9120cc298889d03 Mon Sep 17 00:00:00 2001 From: Anton Alkin Date: Thu, 19 Nov 2026 12:30:55 +0100 Subject: [PATCH 2/2] fix DDS test --- .../Core/test/test_FrameworkDataFlowToDDS.cxx | 48 ++++++++++++------- 1 file changed, 32 insertions(+), 16 deletions(-) diff --git a/Framework/Core/test/test_FrameworkDataFlowToDDS.cxx b/Framework/Core/test/test_FrameworkDataFlowToDDS.cxx index dd3b2eb80d253..bb89eb6d12a27 100644 --- a/Framework/Core/test/test_FrameworkDataFlowToDDS.cxx +++ b/Framework/Core/test/test_FrameworkDataFlowToDDS.cxx @@ -169,14 +169,16 @@ TEST_CASE("TestDDS") "origin": "TST", "description": "A1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true }, { "binding": "TST/A2/0", "origin": "TST", "description": "A2", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "options": [], @@ -195,7 +197,8 @@ TEST_CASE("TestDDS") "origin": "TST", "description": "A1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "outputs": [ @@ -204,7 +207,8 @@ TEST_CASE("TestDDS") "origin": "TST", "description": "B1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "options": [], @@ -223,7 +227,8 @@ TEST_CASE("TestDDS") "origin": "TST", "description": "A2", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "outputs": [ @@ -232,7 +237,8 @@ TEST_CASE("TestDDS") "origin": "TST", "description": "C1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "options": [], @@ -251,14 +257,16 @@ TEST_CASE("TestDDS") "origin": "TST", "description": "B1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true }, { "binding": "y", "origin": "TST", "description": "C1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "outputs": [], @@ -434,14 +442,16 @@ TEST_CASE("TestDDSExpendable") "origin": "TST", "description": "A1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true }, { "binding": "TST/A2/0", "origin": "TST", "description": "A2", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "options": [], @@ -460,7 +470,8 @@ TEST_CASE("TestDDSExpendable") "origin": "TST", "description": "A1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "outputs": [ @@ -469,7 +480,8 @@ TEST_CASE("TestDDSExpendable") "origin": "TST", "description": "B1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "options": [], @@ -488,7 +500,8 @@ TEST_CASE("TestDDSExpendable") "origin": "TST", "description": "A2", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "outputs": [ @@ -497,7 +510,8 @@ TEST_CASE("TestDDSExpendable") "origin": "TST", "description": "C1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "options": [], @@ -516,14 +530,16 @@ TEST_CASE("TestDDSExpendable") "origin": "TST", "description": "B1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true }, { "binding": "y", "origin": "TST", "description": "C1", "subspec": 0, - "lifetime": 0 + "lifetime": 0, + "enabled": true } ], "outputs": [],