Belle II Software light-2406-ragdoll
Environment.cc
1/**************************************************************************
2 * basf2 (Belle II Analysis Software Framework) *
3 * Author: The Belle II Collaboration *
4 * *
5 * See git log for contributors and copyright holders. *
6 * This file is licensed under LGPL-3.0, see LICENSE.md. *
7 **************************************************************************/
8
9#include <framework/core/Module.h>
10#include <framework/core/Path.h>
11#include <framework/core/Environment.h>
12#include <framework/core/ModuleManager.h>
13#include <framework/logging/LogConfig.h>
14#include <framework/core/InputController.h>
15#include <framework/datastore/StoreObjPtr.h>
16#include <framework/dataobjects/FileMetaData.h>
17
18#include <memory>
19#include <iostream>
20#include <cstdlib>
21#include <filesystem>
22
23using namespace Belle2;
24using namespace std;
25namespace fs = std::filesystem;
26
27
29{
30 static Environment instance;
31 return instance;
32}
33
34const list<string>& Environment::getModuleSearchPaths() const
35{
37}
38
40{
41 // for EventInfoSetter, -n is already taken into account
42 if (m_mcEvents != 0)
43 return m_mcEvents;
44
45 unsigned int numEventsFromInput = InputController::getNumEntriesToProcess();
46 unsigned int numEventsFromArgument = getNumberEventsOverride();
47 if (numEventsFromArgument != 0
48 && (numEventsFromInput == 0 || numEventsFromArgument < numEventsFromInput))
49 return numEventsFromArgument;
50 else
51 return numEventsFromInput;
52}
53
55{
57 if (fileMetaData) return fileMetaData->isMC();
58 return true;
59}
60
62{
63 m_realm = realm;
64 B2INFO("Execution realm: " << LogConfig::logRealmToString(realm));
65}
66
67std::string Environment::consumeOutputFileOverride(const std::string& module)
68{
69 std::string s{""};
70 if (!m_outputFileOverrideModule.empty()) {
71 B2WARNING("Module '" << module << "' requested to handle -o which has already been handled by '" << module << "', ignoring");
72 return s;
73 }
74 if (!m_outputFileOverride.empty()) {
76 std::swap(s, m_outputFileOverride);
77 }
78 return s;
79}
80
81//============================================================================
82// Private methods
83//============================================================================
84
86 m_numberProcesses(0),
87 m_steering(""),
88 m_numberEventsOverride(0),
89 m_inputFilesOverride(),
90 m_secondaryInputFilesOverride(),
91 m_entrySequencesOverride(),
92 m_outputFileOverride(""),
93 m_numberProcessesOverride(-1),
94 m_logLevelOverride(LogConfig::c_Default),
95 m_visualizeDataFlow(false),
96 m_noStats(false),
97 m_dryRun(false),
98 m_mcEvents(0),
99 m_run(-1),
100 m_experiment(-1),
101 m_runType(Const::c_Beam),
102 m_skipNEvents(0),
103 m_writeSimSteps(false)
104{
105 // Check for environment variables set by setuprel
106 const char* envarReleaseDir = getenv("BELLE2_RELEASE_DIR");
107 const char* envarLocalDir = getenv("BELLE2_LOCAL_DIR");
108 const char* envarAnalysisDir = getenv("BELLE2_ANALYSIS_DIR");
109 if (!envarReleaseDir and !envarLocalDir) {
110 B2FATAL("The basf2 environment is not set up. Please execute the 'setuprel' script first.");
111 }
112
113 //also set when just sourcing setup_belle2.sh (which is why we also check for local/release dir)
114 const char* envarSubDir = getenv("BELLE2_SUBDIR");
115 if (!envarSubDir) {
116 B2FATAL("The environment variable BELLE2_SUBDIR is not set. Please execute the 'setuprel' script first.");
117 }
118
119 const char* envarExtDir = getenv("BELLE2_EXTERNALS_DIR");
120 if (!envarExtDir) {
121 B2FATAL("The environment variable BELLE2_EXTERNALS_DIR is not set. Please execute the 'setuprel' script first.");
122 }
123
124 // add module directories for current build options, starting with the working directory on program startup
125 std::string added_dirs = fs::current_path().string();
127
128 if (envarAnalysisDir) {
129 const string analysisModules = (fs::path(envarAnalysisDir) / "modules" / envarSubDir).string();
131 added_dirs += " " + analysisModules;
132 }
133
134 if (envarLocalDir) {
135 const string localModules = (fs::path(envarLocalDir) / "modules" / envarSubDir).string();
137 added_dirs += " " + localModules;
138 }
139
140 if (envarReleaseDir) {
141 const string centralModules = (fs::path(envarReleaseDir) / "modules" / envarSubDir).string();
143 added_dirs += " " + centralModules;
144 }
145
146 if (ModuleManager::Instance().getAvailableModules().empty()) {
147 B2ERROR("No modules found! Did you forget to run 'scons'? Module paths added: " << added_dirs);
148 }
149
150 //set path to external software
151 setExternalsPath(envarExtDir);
152}
153
154Environment::~Environment() = default;
155
156
157// we know getFileNames is deprecated but we need it as long as --dry-run is available
158// so let's remove the warning for now ...
159#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
160
161void Environment::setJobInformation(const std::shared_ptr<Path>& path)
162{
163 const std::list<ModulePtr>& modules = path->buildModulePathList(true);
164
165 for (const ModulePtr& m : modules) {
166 if (m->hasProperties(Module::c_Input)) {
167 std::vector<std::string> inputFiles = m->getFileNames(false);
168 for (const string& file : inputFiles) {
169 m_jobInfoOutput += "INPUT FILE: " + file + "\n";
170 }
171 }
172 if (m->hasProperties(Module::c_Output)) {
173 std::vector<std::string> outputFiles = m->getFileNames(true);
174 for (const string& file : outputFiles) {
175 m_jobInfoOutput += "OUTPUT FILE: " + file + "\n";
176 }
177 }
178 }
179}
180
182{
183 cout << m_jobInfoOutput;
184}
This class provides a set of constants for the framework.
Definition: Const.h:34
@ c_Persistent
Object is available during entire execution time.
Definition: DataStore.h:60
This class stores all environment information required to run the framework, such as module or data f...
Definition: Environment.h:33
Environment()
Set up environment from standard BELLE2_ environment variables.
Definition: Environment.cc:85
std::string consumeOutputFileOverride(const std::string &moduleName)
Return overriden output file name, or "" if none was set.
Definition: Environment.cc:67
const std::list< std::string > & getModuleSearchPaths() const
Returns a list of file paths searched for module libraries.
Definition: Environment.cc:34
unsigned int getNumberOfEvents() const
Return the number of events, from either input or EventInfoSetter, or -n command line override (if le...
Definition: Environment.cc:39
bool isMC() const
Do we have generated, not real data?
Definition: Environment.cc:54
~Environment()
The Environment destructor.
std::string m_jobInfoOutput
Output for printJobInformation(), generated by setJobInformation().
Definition: Environment.h:406
void setRealm(LogConfig::ELogRealm realm)
Set the basf2 execution realm.
Definition: Environment.cc:61
void setJobInformation(const std::shared_ptr< Path > &path)
Set info from path executed by the framework.
Definition: Environment.cc:161
std::string m_outputFileOverride
Override name of output file for output module.
Definition: Environment.h:399
unsigned int m_mcEvents
counter for number of generated events.
Definition: Environment.h:410
void setExternalsPath(const std::string &externalsPath)
Sets the path which points to the externals directory of the framework.
Definition: Environment.h:54
std::string m_outputFileOverrideModule
Name of the module which consumed the output file Override if any was given.
Definition: Environment.h:400
void printJobInformation() const
Print information on input/output files in current steering file, used by –dry-run.
Definition: Environment.cc:181
LogConfig::ELogRealm m_realm
The realm in which basf2 is executed.
Definition: Environment.h:415
static Environment & Instance()
Static method to get a reference to the Environment instance.
Definition: Environment.cc:28
unsigned int getNumberEventsOverride() const
Returns number of events in run 1 for EventInfoSetter module, or 0 for no override.
Definition: Environment.h:67
static long getNumEntriesToProcess()
Necessary to make sure the ProgressModule shows reasonable output.
The LogConfig class.
Definition: LogConfig.h:22
static const char * logRealmToString(ELogRealm realm)
Converts a log realm type to a string.
Definition: LogConfig.cc:49
ELogRealm
Definition of the supported execution realms.
Definition: LogConfig.h:48
const std::list< std::string > & getModuleSearchPaths() const
Returns a reference to the list of the modules search filepaths.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
void addModuleSearchPath(const std::string &path)
Adds a new filepath to the list of filepaths which are searched for a requested module.
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:96
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43
Abstract base class for different kinds of events.
Definition: ClusterUtils.h:24
STL namespace.