SylvanSettings.cpp

Go to the documentation of this file.

#include "storm/settings/modules/SylvanSettings.h"
 
#include "storm/settings/SettingsManager.h"
#include "storm/utility/OsDetection.h"
 
#include "storm/settings/Argument.h"
#include "storm/settings/ArgumentBuilder.h"
#include "storm/settings/Option.h"
#include "storm/settings/OptionBuilder.h"
#include "storm/utility/threads.h"
 
namespace storm {
namespace settings {
namespace modules {
 
const std::string SylvanSettings::moduleName = "sylvan";
const std::string SylvanSettings::maximalMemoryOptionName = "maxmem";
const std::string SylvanSettings::threadCountOptionName = "threads";
 
SylvanSettings::SylvanSettings() : ModuleSettings(moduleName) {
    this->addOption(storm::settings::OptionBuilder(moduleName, maximalMemoryOptionName, true, "Sets the upper bound of memory available to Sylvan in MB.")
                        .setIsAdvanced()
                        .addArgument(storm::settings::ArgumentBuilder::createUnsignedIntegerArgument("value", "The memory available to Sylvan.")
                                         .setDefaultValueUnsignedInteger(4096)
                                         .build())
                        .build());
    this->addOption(storm::settings::OptionBuilder(moduleName, threadCountOptionName, true, "Sets the number of threads used by Sylvan.")
                        .setIsAdvanced()
                        .addArgument(storm::settings::ArgumentBuilder::createUnsignedIntegerArgument(
                                         "value", "The number of threads available to Sylvan (0 means 'auto-detect').")
                                         .build())
                        .build());
}
 
uint_fast64_t SylvanSettings::getMaximalMemory() const {
    return this->getOption(maximalMemoryOptionName).getArgumentByName("value").getValueAsUnsignedInteger();
}
 
bool SylvanSettings::isNumberOfThreadsSet() const {
    return this->getOption(threadCountOptionName).getArgumentByName("value").getHasBeenSet();
}
 
uint_fast64_t SylvanSettings::getNumberOfThreads() const {
    if (isNumberOfThreadsSet()) {
        auto numberFromSettings = this->getOption(threadCountOptionName).getArgumentByName("value").getValueAsUnsignedInteger();
        if (numberFromSettings != 0u) {
            return numberFromSettings;
        }
    }
    // Automatic detection
#ifdef APPLE_SILICON
    // Prevents issues with multi-threaded execution on Apple Silicon
    return 1u;
#else
    return std::max(1u, storm::utility::getNumberOfThreads());
#endif
}
 
bool SylvanSettings::check() const {
    if (isNumberOfThreadsSet()) {
        auto const autoDetectThreads = std::max(1u, storm::utility::getNumberOfThreads());
        auto const numberFromSettings = getNumberOfThreads();
#ifdef APPLE_SILICON
        STORM_LOG_WARN_COND(numberFromSettings <= 1,
                            "Sylvan does not properly work for multiple threads on Apple Silicon. We recommend limiting the number of threads to 1.");
#endif
        STORM_LOG_WARN_COND(numberFromSettings <= autoDetectThreads, "Setting the number of sylvan threads to "
                                                                         << numberFromSettings << " which exceeds the recommended number for your system ("
                                                                         << autoDetectThreads << ").");
    }
    return true;
}
 
}  // namespace modules
}  // namespace settings
}  // namespace storm