Peano
Loading...
Searching...
No Matches
UserInterface.cpp
Go to the documentation of this file.
1#include "UserInterface.h"
2
3#include "tarch/multicore/Core.h"
4#include "tarch/multicore/Task.h"
5#include "tarch/accelerator/Device.h"
6#include "tarch/mpi/Rank.h"
7
8#include "tarch/logging/LogFilter.h"
9#include "tarch/logging/LogFilterFileReader.h"
10
11#include "peano4/peano.h"
12
13namespace {
14 tarch::logging::Log _log( "swift2" );
15
16 bool enableDynamicLoadBalancing = true;
17}
18
19
20bool swift2::commandlinesettings::enableDynamicLoadBalancing() {
21 return ::enableDynamicLoadBalancing;
22}
23
24
25void swift2::setDefaultLogStatements() {
26 tarch::logging::LogFilter::getInstance().clearFilterList();
27 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
28 tarch::logging::LogFilter::FilterListEntry::TargetInfo,
29 tarch::logging::LogFilter::FilterListEntry::AnyRank,
30 "",
31 tarch::logging::LogFilter::FilterListEntry::WhiteListEntry,
32 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
33 ));
34 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
35 tarch::logging::LogFilter::FilterListEntry::TargetTrace,
36 tarch::logging::LogFilter::FilterListEntry::AnyRank,
37 "",
38 tarch::logging::LogFilter::FilterListEntry::WhiteListEntry,
39 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
40 ));
41 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
42 tarch::logging::LogFilter::FilterListEntry::TargetDebug,
43 tarch::logging::LogFilter::FilterListEntry::AnyRank,
44 "",
45 tarch::logging::LogFilter::FilterListEntry::WhiteListEntry,
46 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
47 ));
48
49 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
50 tarch::logging::LogFilter::FilterListEntry::TargetDebug,
51 tarch::logging::LogFilter::FilterListEntry::AnyRank,
52 "peano4",
53 tarch::logging::LogFilter::FilterListEntry::BlackListEntry,
54 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
55 ));
56 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
57 tarch::logging::LogFilter::FilterListEntry::TargetTrace,
58 tarch::logging::LogFilter::FilterListEntry::AnyRank,
59 "peano4",
60 tarch::logging::LogFilter::FilterListEntry::BlackListEntry,
61 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
62 ));
63 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
64 tarch::logging::LogFilter::FilterListEntry::TargetInfo,
65 tarch::logging::LogFilter::FilterListEntry::AnyRank,
66 "peano4",
67 tarch::logging::LogFilter::FilterListEntry::WhiteListEntry,
68 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
69 ));
70
71 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
72 tarch::logging::LogFilter::FilterListEntry::TargetDebug,
73 tarch::logging::LogFilter::FilterListEntry::AnyRank,
74 "tarch",
75 tarch::logging::LogFilter::FilterListEntry::BlackListEntry,
76 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
77 ));
78 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
79 tarch::logging::LogFilter::FilterListEntry::TargetTrace,
80 tarch::logging::LogFilter::FilterListEntry::AnyRank,
81 "tarch",
82 tarch::logging::LogFilter::FilterListEntry::BlackListEntry,
83 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
84 ));
85 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
86 tarch::logging::LogFilter::FilterListEntry::TargetInfo,
87 tarch::logging::LogFilter::FilterListEntry::AnyRank,
88 "tarch",
89 tarch::logging::LogFilter::FilterListEntry::WhiteListEntry,
90 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
91 ));
92
93 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
94 tarch::logging::LogFilter::FilterListEntry::TargetDebug,
95 tarch::logging::LogFilter::FilterListEntry::AnyRank,
96 "swift2",
97 tarch::logging::LogFilter::FilterListEntry::BlackListEntry,
98 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
99 ));
100 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
101 tarch::logging::LogFilter::FilterListEntry::TargetTrace,
102 tarch::logging::LogFilter::FilterListEntry::AnyRank,
103 "swift2",
104 tarch::logging::LogFilter::FilterListEntry::BlackListEntry,
105 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
106 ));
107 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
108 tarch::logging::LogFilter::FilterListEntry::TargetInfo,
109 tarch::logging::LogFilter::FilterListEntry::AnyRank,
110 "swift2",
111 tarch::logging::LogFilter::FilterListEntry::WhiteListEntry,
112 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
113 ));
114
115 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
116 tarch::logging::LogFilter::FilterListEntry::TargetDebug,
117 tarch::logging::LogFilter::FilterListEntry::AnyRank,
118 "toolbox",
119 tarch::logging::LogFilter::FilterListEntry::BlackListEntry,
120 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
121 ));
122 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
123 tarch::logging::LogFilter::FilterListEntry::TargetTrace,
124 tarch::logging::LogFilter::FilterListEntry::AnyRank,
125 "toolbox",
126 tarch::logging::LogFilter::FilterListEntry::BlackListEntry,
127 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
128 ));
129 tarch::logging::LogFilter::getInstance().addFilterListEntry( tarch::logging::LogFilter::FilterListEntry(
130 tarch::logging::LogFilter::FilterListEntry::TargetInfo,
131 tarch::logging::LogFilter::FilterListEntry::AnyRank,
132 "toolbox",
133 tarch::logging::LogFilter::FilterListEntry::WhiteListEntry,
134 tarch::logging::LogFilter::FilterListEntry::AlwaysOn
135 ));
136}
137
138
139void swift2::printUsage(char** argv) {
140 std::cout << "Usage: ./" << argv[0] << " [options]" << std::endl <<
141"SWIFT 2 - an experimental rewrite of SPH With Inter-dependent Fine-grained Tasking \n\
142Original code: https://swift.dur.ac.uk/ \n\
143\n \
144Options: \n\
145 -h, --help Display help on commandline options. \n\
146 --threads no Specify how many threads to use (per rank). Option \n\
147 has no meaning if code base has not been \n\
148 translated with shared memory support. Not all \n\
149 runtimes allow you to set the thread count via the \n\
150 code. \n\
151 --gpus filter Specify which GPUs to use. Option has no meaning \n\
152 if code base has not been translated with gpu \n\
153 support. Pass in comma-separated list (3,4,9) to \n\
154 select which GPUs to use. If argument is empty, ExaHyPE \n\
155 may use all GPUs. If you want to use all GPUs, hand \n\
156 in all as argument. \n\
157 --log-filter-file file Specify which log filter file to use. Default file \n\
158 is exahype.log-filter \n\
159 --timeout t Set timeout. t is given in seconds and can be 0 to \n\
160 switch timeouts off. \n\
161 --threading-model t Set threading model. \n\
162 --dynamic-load-balancing [on|off] Disable or enable dynamic load balancing. Pass \n\
163 either on or off. The default is on. \n\
164\n\n\n\
165" << std::endl;
166}
167
168
169bool swift2::parseCommandLineArguments(int argc, char** argv) {
170 if (
171 (argc==2 and std::string(argv[1]).compare( "--help" )!=std::string::npos)
172 or
173 (argc==2 and std::string(argv[1]).compare( "-h" )!=std::string::npos)
174 or
175 (argc%2!=1)
176 ) {{
177 printUsage(argv);
178 return false;
179 }}
180
181 std::string logFilterFile = "swift2.log-filter";
182 int cores = tarch::multicore::Core::UseDefaultNumberOfThreads;
183 std::set<int> gpuDevices;
184
185 for (int argument=1; argument<argc; argument+=2) {
186 std::string select = argv[argument];
187
188 if ( select.compare( "--threads" ) ==0 ) {
189 cores = std::atoi(argv[argument+1]);
190 logInfo( "parseCommandLineArguments(...)", "manually reset number of used cores to " << cores );
191 }
192 else if ( select.compare( "--gpus" ) ==0 ) {
193 std::string specifier = argv[argument+1];
194 std::string delimiter = ",";
195 if ( specifier.compare( "all" ) ==0 ) {
196 logInfo( "parseCommandLineArguments(...)", "enable all devices" );
197 }
198 else if (specifier.find( delimiter ) == std::string::npos) {
199 int gpu = std::atoi(specifier.c_str());
200 gpuDevices.insert(gpu);
201 logInfo( "parseCommandLineArguments(...)", "enable only GPU " << gpu );
202 }
203 else {
204 size_t pos = 0;
205 std::string token;
206 while ((pos = specifier.find(delimiter)) != std::string::npos) {
207 token = specifier.substr(0, pos);
208 int gpu = std::atoi(token.c_str());
209 gpuDevices.insert(gpu);
210 specifier.erase(0, pos + delimiter.length());
211 }
212
213 logInfo( "parseCommandLineArguments(...)", "manually set GPU filter with " << gpuDevices.size() << " devices enabled" );
214 }
215 }
216 else if ( select.compare( "--log-filter-file" ) == 0 ) {
217 logFilterFile = argv[argument+1];
218 }
219 else if ( select.compare( "--timeout" ) == 0 ) {
220 int timeout = std::atoi(argv[argument+1]);
221 tarch::mpi::Rank::getInstance().setDeadlockTimeOut( timeout );
222 logInfo( "parseCommandLineArguments(...)", "manually set timeout to " << timeout );
223 }
224 else if ( select.compare( "--dynamic-load-balancing" ) == 0 ) {
225 std::string value = argv[argument+1];
226 if (value==std::string("on")) {
227 enableDynamicLoadBalancing = true;
228 }
229 else if (value==std::string("off")) {
230 enableDynamicLoadBalancing = false;
231 }
232 else {
233 logError( "parseCommandLineArguments(...)", "load balancing value has to be on or off. Value had been " << value );
234 return false;
235 }
236 }
237 else {
238 printUsage(argv);
239 return false;
240 }
241 }
242
243 tarch::multicore::Core::getInstance().configure( cores );
244 tarch::accelerator::Device::getInstance().configure( gpuDevices );
245
246 if ( not tarch::logging::LogFilterFileReader::parsePlainTextFile( logFilterFile ) ) {
247 logWarning( "main()", "no exahype.log-filter file found or file has been corrupted. Use default logging configuration" );
248 setDefaultLogStatements();
249 }
250
251 return true;
252}
253
logError
#define logError(methodName, logMacroMessageStream)
Wrapper macro around tarch::tarch::logging::Log to improve logging.
Definition Log.h:464
logWarning
#define logWarning(methodName, logMacroMessageStream)
Wrapper macro around tarch::tarch::logging::Log to improve logging.
Definition Log.h:440
logInfo
#define logInfo(methodName, logMacroMessageStream)
Wrapper macro around tarch::tarch::logging::Log to improve logging.
Definition Log.h:411
tarch::accelerator::Device::getInstance
static Device & getInstance()
tarch::accelerator::Device::configure
void configure(const std::set< int > &devicesToUse={})
tarch::logging::LogFilterFileReader::parsePlainTextFile
static bool parsePlainTextFile(const std::string &filename)
Tries to parse a simple text file where each line contains an entry.
Definition LogFilterFileReader.cpp:103
tarch::logging::LogFilter::addFilterListEntry
void addFilterListEntry(const FilterListEntry &entry)
Add one filter list entry.
Definition LogFilter.cpp:196
tarch::logging::LogFilter::getInstance
static LogFilter & getInstance()
Definition LogFilter.cpp:109
tarch::logging::Log
Log Device.
Definition Log.h:516
tarch::mpi::Rank::setDeadlockTimeOut
void setDeadlockTimeOut(int valueInSeconds)
Set deadlock time out.
Definition Rank.cpp:566
tarch::mpi::Rank::getInstance
static Rank & getInstance()
This operation returns the singleton instance.
Definition Rank.cpp:539
tarch::multicore::Core::UseDefaultNumberOfThreads
static constexpr int UseDefaultNumberOfThreads
The default is what the system management typically gives you.
Definition Core.h:69
tarch::multicore::Core::getInstance
static Core & getInstance()
Definition Core.cpp:56
tarch::multicore::Core::configure
void configure(int numberOfThreads=UseDefaultNumberOfThreads)
Configure the whole node, i.e.
Definition Core.cpp:61
_log
tarch::logging::Log _log("exahype2::fv")
swift2::commandlinesettings::enableDynamicLoadBalancing
bool enableDynamicLoadBalancing()
Find out if user has enabled dynamic load balancing or not.
Definition UserInterface.cpp:20
swift2::setDefaultLogStatements
void setDefaultLogStatements()
Definition UserInterface.cpp:25
swift2::parseCommandLineArguments
bool parseCommandLineArguments(int argc, char **argv)
Definition UserInterface.cpp:169
swift2::printUsage
void printUsage(char **argv)
Definition UserInterface.cpp:139
tarch::logging::LogFilter::FilterListEntry
Represents one entry of the filter list.
Definition LogFilter.h:30
tarch::logging::LogFilter::FilterListEntry::TargetTrace
static const std::string TargetTrace
Definition LogFilter.h:36
tarch::logging::LogFilter::FilterListEntry::TargetDebug
static const std::string TargetDebug
Definition LogFilter.h:35
tarch::logging::LogFilter::FilterListEntry::TargetInfo
static const std::string TargetInfo
Definition LogFilter.h:34
tarch::logging::LogFilter::FilterListEntry::AlwaysOn
static const std::string AlwaysOn
Definition LogFilter.h:39