#ifndef STORM_UTILITY_CLI_H_ #define STORM_UTILITY_CLI_H_ #include #include #include #include #include #include #include "storm-config.h" // Includes for the linked libraries and versions header. #ifdef STORM_HAVE_INTELTBB # include "tbb/tbb_stddef.h" #endif #ifdef STORM_HAVE_GLPK # include "glpk.h" #endif #ifdef STORM_HAVE_GUROBI # include "gurobi_c.h" #endif #ifdef STORM_HAVE_Z3 # include "z3.h" #endif #ifdef STORM_HAVE_MSAT # include "mathsat.h" #endif #ifdef STORM_HAVE_CUDA #include #include #endif #include "log4cplus/logger.h" #include "log4cplus/loggingmacros.h" #include "log4cplus/consoleappender.h" #include "log4cplus/fileappender.h" log4cplus::Logger logger; log4cplus::Logger printer; // Headers that provide auxiliary functionality. #include "src/utility/storm-version.h" #include "src/utility/OsDetection.h" #include "src/settings/SettingsManager.h" // Headers related to parsing. #include "src/parser/AutoParser.h" #include "src/parser/PrismParser.h" #include "src/parser/FormulaParser.h" // Formula headers. #include "src/logic/Formulas.h" // Model headers. #include "src/models/ModelBase.h" #include "src/models/sparse/Model.h" #include "src/models/symbolic/Model.h" // Headers of builders. #include "src/builder/ExplicitPrismModelBuilder.h" #include "src/builder/DdPrismModelBuilder.h" // Headers for model processing. #include "src/storage/DeterministicModelBisimulationDecomposition.h" // Headers for model checking. #include "src/modelchecker/prctl/SparseDtmcPrctlModelChecker.h" #include "src/modelchecker/reachability/SparseDtmcEliminationModelChecker.h" #include "src/modelchecker/prctl/SparseMdpPrctlModelChecker.h" #include "src/modelchecker/csl/SparseCtmcCslModelChecker.h" #include "src/modelchecker/prctl/HybridDtmcPrctlModelChecker.h" #include "src/modelchecker/csl/HybridCtmcCslModelChecker.h" #include "src/modelchecker/results/ExplicitQualitativeCheckResult.h" #include "src/modelchecker/results/SymbolicQualitativeCheckResult.h" // Headers for counterexample generation. #include "src/counterexamples/MILPMinimalLabelSetGenerator.h" #include "src/counterexamples/SMTMinimalCommandSetGenerator.h" // Headers related to exception handling. #include "src/exceptions/InvalidStateException.h" #include "src/exceptions/InvalidArgumentException.h" #include "src/exceptions/InvalidSettingsException.h" #include "src/exceptions/InvalidTypeException.h" #include "src/exceptions/NotImplementedException.h" namespace storm { namespace utility { namespace cli { /*! * Initializes the logging framework and sets up logging to console. */ void initializeLogger() { logger = log4cplus::Logger::getInstance(LOG4CPLUS_TEXT("main")); log4cplus::SharedAppenderPtr consoleLogAppender(new log4cplus::ConsoleAppender()); consoleLogAppender->setName("mainConsoleAppender"); consoleLogAppender->setLayout(std::auto_ptr(new log4cplus::PatternLayout("%-5p - %D{%H:%M:%S} (%r ms) - %b:%L: %m%n"))); logger.addAppender(consoleLogAppender); auto loglevel = storm::settings::debugSettings().isTraceSet() ? log4cplus::TRACE_LOG_LEVEL : storm::settings::debugSettings().isDebugSet() ? log4cplus::DEBUG_LOG_LEVEL : log4cplus::WARN_LOG_LEVEL; logger.setLogLevel(loglevel); consoleLogAppender->setThreshold(loglevel); } /*! * Performs some necessary initializations. */ void setUp() { initializeLogger(); std::cout.precision(10); } /*! * Performs some necessary clean-up. */ void cleanUp() { // Intentionally left empty. } /*! * Sets up the logging to file. */ void initializeFileLogging() { log4cplus::SharedAppenderPtr fileLogAppender(new log4cplus::FileAppender(storm::settings::debugSettings().getLogfilename())); fileLogAppender->setName("mainFileAppender"); fileLogAppender->setLayout(std::auto_ptr(new log4cplus::PatternLayout("%-5p - %D{%H:%M:%S} (%r ms) - %F:%L: %m%n"))); logger.addAppender(fileLogAppender); } /*! * Gives the current working directory * * @return std::string The path of the current working directory */ std::string getCurrentWorkingDirectory() { char temp[512]; return (GetCurrentDir(temp, 512 - 1) ? std::string(temp) : std::string("")); } /*! * Prints the header including information about the linked libraries. */ void printHeader(const int argc, const char* argv[]) { std::cout << "StoRM" << std::endl; std::cout << "--------" << std::endl << std::endl; // std::cout << storm::utility::StormVersion::longVersionString() << std::endl; #ifdef STORM_HAVE_INTELTBB std::cout << "Linked with Intel Threading Building Blocks v" << TBB_VERSION_MAJOR << "." << TBB_VERSION_MINOR << " (Interface version " << TBB_INTERFACE_VERSION << ")." << std::endl; #endif #ifdef STORM_HAVE_GLPK std::cout << "Linked with GNU Linear Programming Kit v" << GLP_MAJOR_VERSION << "." << GLP_MINOR_VERSION << "." << std::endl; #endif #ifdef STORM_HAVE_GUROBI std::cout << "Linked with Gurobi Optimizer v" << GRB_VERSION_MAJOR << "." << GRB_VERSION_MINOR << "." << GRB_VERSION_TECHNICAL << "." << std::endl; #endif #ifdef STORM_HAVE_Z3 unsigned int z3Major, z3Minor, z3BuildNumber, z3RevisionNumber; Z3_get_version(&z3Major, &z3Minor, &z3BuildNumber, &z3RevisionNumber); std::cout << "Linked with Microsoft Z3 Optimizer v" << z3Major << "." << z3Minor << " Build " << z3BuildNumber << " Rev " << z3RevisionNumber << "." << std::endl; #endif #ifdef STORM_HAVE_MSAT char* msatVersion = msat_get_version(); std::cout << "Linked with " << msatVersion << "." << std::endl; msat_free(msatVersion); #endif #ifdef STORM_HAVE_CUDA int deviceCount = 0; cudaError_t error_id = cudaGetDeviceCount(&deviceCount); if (error_id == cudaSuccess) { std::cout << "Compiled with CUDA support, "; // This function call returns 0 if there are no CUDA capable devices. if (deviceCount == 0) { std::cout<< "but there are no available device(s) that support CUDA." << std::endl; } else { std::cout << "detected " << deviceCount << " CUDA Capable device(s):" << std::endl; } int dev, driverVersion = 0, runtimeVersion = 0; for (dev = 0; dev < deviceCount; ++dev) { cudaSetDevice(dev); cudaDeviceProp deviceProp; cudaGetDeviceProperties(&deviceProp, dev); std::cout << "CUDA Device " << dev << ": \"" << deviceProp.name << "\"" << std::endl; // Console log cudaDriverGetVersion(&driverVersion); cudaRuntimeGetVersion(&runtimeVersion); std::cout << " CUDA Driver Version / Runtime Version " << driverVersion / 1000 << "." << (driverVersion % 100) / 10 << " / " << runtimeVersion / 1000 << "." << (runtimeVersion % 100) / 10 << std::endl; std::cout << " CUDA Capability Major/Minor version number: " << deviceProp.major<<"."<(uLargeInteger.QuadPart) / 10000.0; // 100 ns Resolution to milliseconds uLargeInteger.LowPart = ftUser.dwLowDateTime; uLargeInteger.HighPart = ftUser.dwHighDateTime; double userTime = static_cast(uLargeInteger.QuadPart) / 10000.0; std::cout << "CPU Time: " << std::endl; std::cout << "\tKernel Time: " << std::setprecision(5) << kernelTime << "ms" << std::endl; std::cout << "\tUser Time: " << std::setprecision(5) << userTime << "ms" << std::endl; #endif } /*! * Parses the given command line arguments. * * @param argc The argc argument of main(). * @param argv The argv argument of main(). * @return True iff the program should continue to run after parsing the options. */ bool parseOptions(const int argc, const char* argv[]) { storm::settings::SettingsManager& manager = storm::settings::mutableManager(); try { manager.setFromCommandLine(argc, argv); } catch (storm::exceptions::OptionParserException& e) { manager.printHelp(); throw e; return false; } if (storm::settings::generalSettings().isHelpSet()) { storm::settings::manager().printHelp(storm::settings::generalSettings().getHelpModuleName()); return false; } if (storm::settings::generalSettings().isVersionSet()) { storm::settings::manager().printVersion(); return false; } if (storm::settings::generalSettings().isVerboseSet()) { logger.getAppender("mainConsoleAppender")->setThreshold(log4cplus::INFO_LOG_LEVEL); LOG4CPLUS_INFO(logger, "Enabled verbose mode, log output gets printed to console."); } if (storm::settings::debugSettings().isDebugSet()) { logger.setLogLevel(log4cplus::DEBUG_LOG_LEVEL); logger.getAppender("mainConsoleAppender")->setThreshold(log4cplus::DEBUG_LOG_LEVEL); LOG4CPLUS_INFO(logger, "Enabled very verbose mode, log output gets printed to console."); } if (storm::settings::debugSettings().isTraceSet()) { logger.setLogLevel(log4cplus::TRACE_LOG_LEVEL); logger.getAppender("mainConsoleAppender")->setThreshold(log4cplus::TRACE_LOG_LEVEL); LOG4CPLUS_INFO(logger, "Enabled trace mode, log output gets printed to console."); } if (storm::settings::debugSettings().isLogfileSet()) { initializeFileLogging(); } return true; } template std::shared_ptr> buildExplicitModel(std::string const& transitionsFile, std::string const& labelingFile, boost::optional const& stateRewardsFile = boost::optional(), boost::optional const& transitionRewardsFile = boost::optional()) { return storm::parser::AutoParser::parseModel(transitionsFile, labelingFile, stateRewardsFile ? stateRewardsFile.get() : "", transitionRewardsFile ? transitionRewardsFile.get() : ""); } template std::shared_ptr buildSymbolicModel(storm::prism::Program const& program, boost::optional> const& formula) { std::shared_ptr result(nullptr); storm::settings::modules::GeneralSettings settings = storm::settings::generalSettings(); // Get the string that assigns values to the unknown currently undefined constants in the model. std::string constants = settings.getConstantDefinitionString(); bool buildRewards = false; boost::optional rewardModelName; if (formula || settings.isSymbolicRewardModelNameSet()) { buildRewards = formula.get()->isRewardOperatorFormula() || formula.get()->isRewardPathFormula(); if (settings.isSymbolicRewardModelNameSet()) { rewardModelName = settings.getSymbolicRewardModelName(); } } // Customize and perform model-building. if (settings.getEngine() == storm::settings::modules::GeneralSettings::Engine::Sparse) { typename storm::builder::ExplicitPrismModelBuilder::Options options; if (formula) { options = typename storm::builder::ExplicitPrismModelBuilder::Options(*formula.get()); } options.addConstantDefinitionsFromString(program, settings.getConstantDefinitionString()); options.buildRewards = buildRewards; options.rewardModelName = rewardModelName; // Generate command labels if we are going to build a counterexample later. if (storm::settings::counterexampleGeneratorSettings().isMinimalCommandSetGenerationSet()) { options.buildCommandLabels = true; } result = storm::builder::ExplicitPrismModelBuilder::translateProgram(program, options); } else if (settings.getEngine() == storm::settings::modules::GeneralSettings::Engine::Dd || settings.getEngine() == storm::settings::modules::GeneralSettings::Engine::Hybrid) { typename storm::builder::DdPrismModelBuilder::Options options; if (formula) { options = typename storm::builder::DdPrismModelBuilder::Options(*formula.get()); } options.addConstantDefinitionsFromString(program, settings.getConstantDefinitionString()); options.buildRewards = buildRewards; options.rewardModelName = rewardModelName; result = storm::builder::DdPrismModelBuilder::translateProgram(program, options); } // Then, build the model from the symbolic description. return result; } template std::shared_ptr preprocessModel(std::shared_ptr model, boost::optional> const& formula) { if (storm::settings::generalSettings().isBisimulationSet()) { STORM_LOG_THROW(model->isSparseModel(), storm::exceptions::InvalidSettingsException, "Bisimulation minimization is currently only available for sparse models."); std::shared_ptr> sparseModel = model->template as>(); STORM_LOG_THROW(model->getType() == storm::models::ModelType::Dtmc || model->getType() == storm::models::ModelType::Ctmc, storm::exceptions::InvalidSettingsException, "Bisimulation minimization is currently only available for DTMCs."); std::shared_ptr> dtmc = sparseModel->template as>(); if (dtmc->hasTransitionRewards()) { dtmc->convertTransitionRewardsToStateRewards(); } std::cout << "Performing bisimulation minimization... "; typename storm::storage::DeterministicModelBisimulationDecomposition::Options options; if (formula) { options = typename storm::storage::DeterministicModelBisimulationDecomposition::Options(*sparseModel, *formula.get()); } if (storm::settings::bisimulationSettings().isWeakBisimulationSet()) { options.weak = true; options.bounded = false; } storm::storage::DeterministicModelBisimulationDecomposition bisimulationDecomposition(*dtmc, options); model = bisimulationDecomposition.getQuotient(); std::cout << "done." << std::endl << std::endl; } return model; } template void generateCounterexample(storm::prism::Program const& program, std::shared_ptr> model, std::shared_ptr formula) { if (storm::settings::counterexampleGeneratorSettings().isMinimalCommandSetGenerationSet()) { STORM_LOG_THROW(model->getType() == storm::models::ModelType::Mdp, storm::exceptions::InvalidTypeException, "Minimal command set generation is only available for MDPs."); STORM_LOG_THROW(storm::settings::generalSettings().isSymbolicSet(), storm::exceptions::InvalidSettingsException, "Minimal command set generation is only available for symbolic models."); std::shared_ptr> mdp = model->template as>(); // Determine whether we are required to use the MILP-version or the SAT-version. bool useMILP = storm::settings::counterexampleGeneratorSettings().isUseMilpBasedMinimalCommandSetGenerationSet(); if (useMILP) { storm::counterexamples::MILPMinimalLabelSetGenerator::computeCounterexample(program, *mdp, formula); } else { storm::counterexamples::SMTMinimalCommandSetGenerator::computeCounterexample(program, storm::settings::generalSettings().getConstantDefinitionString(), *mdp, formula); } } else { STORM_LOG_THROW(false, storm::exceptions::InvalidSettingsException, "No suitable counterexample representation selected."); } } #ifdef STORM_HAVE_CARL template<> void generateCounterexample(storm::prism::Program const& program, std::shared_ptr> model, std::shared_ptr formula) { STORM_LOG_THROW(false, storm::exceptions::InvalidSettingsException, "Unable to generate counterexample for parametric model."); } #endif template void verifySparseModel(boost::optional const& program, std::shared_ptr> model, std::shared_ptr formula) { storm::settings::modules::GeneralSettings const& settings = storm::settings::generalSettings(); // If we were requested to generate a counterexample, we now do so. if (settings.isCounterexampleSet()) { STORM_LOG_THROW(program, storm::exceptions::InvalidSettingsException, "Unable to generate counterexample for non-symbolic model."); generateCounterexample(program.get(), model, formula); } else { std::cout << std::endl << "Model checking property: " << *formula << " ..."; std::unique_ptr result; if (model->getType() == storm::models::ModelType::Dtmc) { std::shared_ptr> dtmc = model->template as>(); storm::modelchecker::SparseDtmcPrctlModelChecker modelchecker(*dtmc); if (modelchecker.canHandle(*formula.get())) { result = modelchecker.check(*formula.get()); } else { storm::modelchecker::SparseDtmcEliminationModelChecker modelchecker2(*dtmc); if (modelchecker2.canHandle(*formula.get())) { modelchecker2.check(*formula.get()); } } } else if (model->getType() == storm::models::ModelType::Mdp) { std::shared_ptr> mdp = model->template as>(); #ifdef STORM_HAVE_CUDA if (settings.isCudaSet()) { storm::modelchecker::TopologicalValueIterationMdpPrctlModelChecker modelchecker(*mdp); result = modelchecker.check(*formula.get()); } else { storm::modelchecker::SparseMdpPrctlModelChecker modelchecker(*mdp); result = modelchecker.check(*formula.get()); } #else storm::modelchecker::SparseMdpPrctlModelChecker modelchecker(*mdp); result = modelchecker.check(*formula.get()); #endif } else if (model->getType() == storm::models::ModelType::Ctmc) { std::shared_ptr> ctmc = model->template as>(); storm::modelchecker::SparseCtmcCslModelChecker modelchecker(*ctmc); result = modelchecker.check(*formula.get()); } if (result) { std::cout << " done." << std::endl; std::cout << "Result (initial states): "; result->filter(storm::modelchecker::ExplicitQualitativeCheckResult(model->getInitialStates())); std::cout << *result << std::endl; } else { std::cout << " skipped, because the modelling formalism is currently unsupported." << std::endl; } } } #ifdef STORM_HAVE_CARL template<> void verifySparseModel(boost::optional const& program, std::shared_ptr> model, std::shared_ptr formula) { storm::settings::modules::GeneralSettings const& settings = storm::settings::generalSettings(); STORM_LOG_THROW(model->getType() == storm::models::ModelType::Dtmc, storm::exceptions::InvalidSettingsException, "Currently parametric verification is only available for DTMCs."); std::shared_ptr> dtmc = model->template as>(); std::cout << std::endl << "Model checking property: " << *formula << " ..."; std::unique_ptr result; storm::modelchecker::SparseDtmcEliminationModelChecker modelchecker(*dtmc); if (modelchecker.canHandle(*formula.get())) { result = modelchecker.check(*formula.get()); } else { STORM_LOG_THROW(false, storm::exceptions::InvalidSettingsException, "The parametric engine currently does not support this property."); } if (result) { std::cout << " done." << std::endl; std::cout << "Result (initial states): "; result->filter(storm::modelchecker::ExplicitQualitativeCheckResult(dtmc->getInitialStates())); std::cout << *result << std::endl; } else { std::cout << " skipped, because the modelling formalism is currently unsupported." << std::endl; } } #endif template void verifySymbolicModel(boost::optional const& program, std::shared_ptr> model, std::shared_ptr formula) { storm::settings::modules::GeneralSettings const& settings = storm::settings::generalSettings(); std::cout << std::endl << "Model checking property: " << *formula << " ..."; std::unique_ptr result; if (model->getType() == storm::models::ModelType::Dtmc) { std::shared_ptr> dtmc = model->template as>(); storm::modelchecker::HybridDtmcPrctlModelChecker modelchecker(*dtmc); if (modelchecker.canHandle(*formula.get())) { result = modelchecker.check(*formula.get()); } } else if (model->getType() == storm::models::ModelType::Ctmc) { std::shared_ptr> ctmc = model->template as>(); storm::modelchecker::HybridCtmcCslModelChecker modelchecker(*ctmc); if (modelchecker.canHandle(*formula.get())) { result = modelchecker.check(*formula.get()); } } else { STORM_LOG_THROW(false, storm::exceptions::NotImplementedException, "This functionality is not yet implemented."); } if (result) { std::cout << " done." << std::endl; std::cout << "Result (initial states): "; result->filter(storm::modelchecker::SymbolicQualitativeCheckResult(model->getReachableStates(), model->getInitialStates())); std::cout << *result << std::endl; } else { std::cout << " skipped, because the modelling formalism is currently unsupported." << std::endl; } } template void buildAndCheckSymbolicModel(boost::optional const& program, boost::optional> formula) { // Now we are ready to actually build the model. STORM_LOG_THROW(program, storm::exceptions::InvalidStateException, "Program has not been successfully parsed."); std::shared_ptr model = buildSymbolicModel(program.get(), formula); STORM_LOG_THROW(model != nullptr, storm::exceptions::InvalidStateException, "Model could not be constructed for an unknown reason."); // Preprocess the model if needed. model = preprocessModel(model, formula); // Print some information about the model. model->printModelInformationToStream(std::cout); // Verify the model, if a formula was given. if (formula) { if (model->isSparseModel()) { verifySparseModel(program, model->as>(), formula.get()); } else if (model->isSymbolicModel()) { if (storm::settings::generalSettings().getEngine() == storm::settings::modules::GeneralSettings::Engine::Hybrid) { verifySymbolicModel(program, model->as>(), formula.get()); } else { // Not handled yet. STORM_LOG_THROW(false, storm::exceptions::NotImplementedException, "This functionality is not yet implemented."); } } else { STORM_LOG_THROW(false, storm::exceptions::InvalidSettingsException, "Invalid input model type."); } } } template void buildAndCheckExplicitModel(boost::optional> formula) { storm::settings::modules::GeneralSettings const& settings = storm::settings::generalSettings(); STORM_LOG_THROW(settings.isExplicitSet(), storm::exceptions::InvalidStateException, "Unable to build explicit model without model files."); std::shared_ptr model = buildExplicitModel(settings.getTransitionFilename(), settings.getLabelingFilename(), settings.isStateRewardsSet() ? settings.getStateRewardsFilename() : boost::optional(), settings.isTransitionRewardsSet() ? settings.getTransitionRewardsFilename() : boost::optional()); // Preprocess the model if needed. model = preprocessModel(model, formula); // Print some information about the model. model->printModelInformationToStream(std::cout); // Verify the model, if a formula was given. if (formula) { STORM_LOG_THROW(model->isSparseModel(), storm::exceptions::InvalidStateException, "Expected sparse model."); verifySparseModel(boost::optional(), model->as>(), formula.get()); } } void processOptions() { if (storm::settings::debugSettings().isLogfileSet()) { initializeFileLogging(); } storm::settings::modules::GeneralSettings const& settings = storm::settings::generalSettings(); // If we have to build the model from a symbolic representation, we need to parse the representation first. boost::optional program; if (settings.isSymbolicSet()) { std::string const& programFile = settings.getSymbolicModelFilename(); program = storm::parser::PrismParser::parse(programFile); } // Then proceed to parsing the property (if given), since the model we are building may depend on the property. boost::optional> formula; if (settings.isPropertySet()) { if (program) { storm::parser::FormulaParser formulaParser(program.get().getManager().getSharedPointer()); formula = formulaParser.parseFromString(settings.getProperty()); } else { storm::parser::FormulaParser formulaParser; formula = formulaParser.parseFromString(settings.getProperty()); } } if (settings.isSymbolicSet()) { #ifdef STORM_HAVE_CARL if (settings.isParametricSet()) { buildAndCheckSymbolicModel(program.get(), formula); } else { #endif buildAndCheckSymbolicModel(program.get(), formula); #ifdef STORM_HAVE_CARL } #endif } else if (settings.isExplicitSet()) { buildAndCheckExplicitModel(formula); } else { STORM_LOG_THROW(false, storm::exceptions::InvalidSettingsException, "No input model."); } } } } } #endif