X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/666a812d1b3ee4568f2beb317dfcd08d99055697..d50a590cfb08f9f45bab9fd355eed8dbdcf765ea:/src/simgrid/sg_config.cpp diff --git a/src/simgrid/sg_config.cpp b/src/simgrid/sg_config.cpp index 70affbfd4f..29ed3104fb 100644 --- a/src/simgrid/sg_config.cpp +++ b/src/simgrid/sg_config.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2009-2019. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -18,6 +18,21 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf, "About the configuration of SimGrid"); +static simgrid::config::Flag cfg_continue_after_help + {"help-nostop", "Do not stop the execution when --help is found", false}; + +/** @brief Allow other libraries to react to the --help flag, too + * + * When finding --help on the command line, simgrid usually stops right after displaying its help message. + * If you are writing a library using simgrid, you may want to display your own help message before everything stops. + * If so, just call this function before having simgrid parsing the command line, and you will be given the control + * even if the user is asking for help. + */ +void sg_config_continue_after_help() +{ + cfg_continue_after_help = true; +} + /* 0: beginning of time (config cannot be changed yet) * 1: initialized: cfg_set created (config can now be changed) * 2: configured: command line parsed and config part of platform file was @@ -26,29 +41,28 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf, "About the configuration of S */ int _sg_cfg_init_status = 0; -/* instruct the upper layer (simix or simdag) to exit as soon as possible */ -int _sg_cfg_exit_asap = 0; - -#define sg_cfg_exit_early() do { _sg_cfg_exit_asap = 1; return; } while (0) - /* Parse the command line, looking for options */ static void sg_config_cmd_line(int *argc, char **argv) { - int shall_exit = 0; + bool shall_exit = false; int i; int j; + bool parse_args = true; // Stop parsing the parameters once we found '--' for (j = i = 1; i < *argc; i++) { - if (not strncmp(argv[i], "--cfg=", strlen("--cfg="))) { + if (not strcmp("--", argv[i])) { + parse_args = false; + // Remove that '--' from the arguments + } else if (parse_args && not strncmp(argv[i], "--cfg=", strlen("--cfg="))) { char *opt = strchr(argv[i], '='); opt++; simgrid::config::set_parse(opt); XBT_DEBUG("Did apply '%s' as config setting", opt); - } else if (not strcmp(argv[i], "--version")) { - printf("%s\n", SIMGRID_VERSION_STRING); - shall_exit = 1; - } else if (not strcmp(argv[i], "--cfg-help") || not strcmp(argv[i], "--help")) { + } else if (parse_args && not strcmp(argv[i], "--version")) { + sg_version(); + shall_exit = true; + } else if (parse_args && (not strcmp(argv[i], "--cfg-help") || not strcmp(argv[i], "--help"))) { printf("Description of the configuration accepted by this simulator:\n"); simgrid::config::help(); printf( @@ -65,28 +79,27 @@ static void sg_config_cmd_line(int *argc, char **argv) " --version to get SimGrid version information.\n" "\n" ); - shall_exit = 1; - } else if (not strcmp(argv[i], "--help-aliases")) { + shall_exit = not cfg_continue_after_help; + argv[j++] = argv[i]; // Preserve the --help in argv just in case someone else wants to see it + } else if (parse_args && not strcmp(argv[i], "--help-aliases")) { printf("Here is a list of all deprecated option names, with their replacement.\n"); simgrid::config::show_aliases(); printf("Please consider using the recent names\n"); - shall_exit = 1; - } else if (not strcmp(argv[i], "--help-models")) { + shall_exit = true; + } else if (parse_args && not strcmp(argv[i], "--help-models")) { model_help("host", surf_host_model_description); printf("\n"); model_help("CPU", surf_cpu_model_description); printf("\n"); model_help("network", surf_network_model_description); printf("\nLong description of all optimization levels accepted by the models of this simulator:\n"); - for (int k = 0; surf_optimization_mode_description[k].name; k++) - printf(" %s: %s\n", - surf_optimization_mode_description[k].name, - surf_optimization_mode_description[k].description); + for (auto const& item : surf_optimization_mode_description) + printf(" %s: %s\n", item.name, item.description); printf("Both network and CPU models have 'Lazy' as default optimization level\n\n"); - shall_exit = 1; - } else if (not strcmp(argv[i], "--help-tracing")) { - TRACE_help (1); - shall_exit = 1; + shall_exit = true; + } else if (parse_args && not strcmp(argv[i], "--help-tracing")) { + TRACE_help(); + shall_exit = true; } else { argv[j++] = argv[i]; } @@ -96,7 +109,7 @@ static void sg_config_cmd_line(int *argc, char **argv) *argc = j; } if (shall_exit) - sg_cfg_exit_early(); + exit(0); } /* callback of the plugin variable */ @@ -108,12 +121,12 @@ static void _sg_cfg_cb__plugin(const std::string& value) return; if (value == "help") { - model_help("plugin", surf_plugin_description); - sg_cfg_exit_early(); + model_help("plugin", *surf_plugin_description); + exit(0); } - int plugin_id = find_model_description(surf_plugin_description, value); - surf_plugin_description[plugin_id].model_init_preparse(); + int plugin_id = find_model_description(*surf_plugin_description, value); + (*surf_plugin_description)[plugin_id].model_init_preparse(); } /* callback of the host/model variable */ @@ -123,7 +136,7 @@ static void _sg_cfg_cb__host_model(const std::string& value) if (value == "help") { model_help("host", surf_host_model_description); - sg_cfg_exit_early(); + exit(0); } /* Make sure that the model exists */ @@ -137,7 +150,7 @@ static void _sg_cfg_cb__cpu_model(const std::string& value) if (value == "help") { model_help("CPU", surf_cpu_model_description); - sg_cfg_exit_early(); + exit(0); } /* New Module missing */ @@ -151,7 +164,7 @@ static void _sg_cfg_cb__optimization_mode(const std::string& value) if (value == "help") { model_help("optimization", surf_optimization_mode_description); - sg_cfg_exit_early(); + exit(0); } /* New Module missing */ @@ -165,7 +178,7 @@ static void _sg_cfg_cb__storage_mode(const std::string& value) if (value == "help") { model_help("storage", surf_storage_model_description); - sg_cfg_exit_early(); + exit(0); } find_model_description(surf_storage_model_description, value); @@ -178,7 +191,7 @@ static void _sg_cfg_cb__network_model(const std::string& value) if (value == "help") { model_help("network", surf_network_model_description); - sg_cfg_exit_early(); + exit(0); } /* New Module missing */ @@ -200,28 +213,24 @@ static void _sg_cfg_cb_contexts_parallel_mode(const std::string& mode_name) } /* build description line with possible values */ -static void describe_model(char *result,int resultsize, - const s_surf_model_description_t model_description[], - const char *name, - const char *description) +static void declare_model_flag(const std::string& name, const std::string& value, + const std::function& callback, + const std::vector& model_description, const std::string& type, + const std::string& descr) { - result[0] = '\0'; - char *p = result; - p += snprintf(result,resultsize-1, "%s. Possible values: %s", description, - model_description[0].name ? model_description[0].name : "n/a"); - for (int i = 1; model_description[i].name; i++) - p += snprintf(p,resultsize-(p-result)-1, ", %s", model_description[i].name); - p += snprintf(p,resultsize-(p-result)-1, ".\n (use 'help' as a value to see the long description of each %s)", name); - - xbt_assert(p(name, description, value, callback); } /* create the config set, register what should be and parse the command line*/ void sg_config_init(int *argc, char **argv) { - const int descsize = 1024; - char description[descsize]; - /* Create the configuration support */ if (_sg_cfg_init_status != 0) { /* Only create stuff if not already inited */ XBT_WARN("Call to sg_config_init() after initialization ignored"); @@ -229,24 +238,22 @@ void sg_config_init(int *argc, char **argv) } /* Plugins configuration */ - describe_model(description, descsize, surf_plugin_description, "plugin", "The plugins"); - simgrid::config::declare_flag("plugin", description, "", &_sg_cfg_cb__plugin); + declare_model_flag("plugin", "", &_sg_cfg_cb__plugin, *surf_plugin_description, "plugin", "The plugins"); - describe_model(description, descsize, surf_cpu_model_description, "model", "The model to use for the CPU"); - simgrid::config::declare_flag("cpu/model", description, "Cas01", &_sg_cfg_cb__cpu_model); + declare_model_flag("cpu/model", "Cas01", &_sg_cfg_cb__cpu_model, surf_cpu_model_description, "model", + "The model to use for the CPU"); - describe_model(description, descsize, surf_storage_model_description, "model", "The model to use for the storage"); - simgrid::config::declare_flag("storage/model", description, "default", &_sg_cfg_cb__storage_mode); + declare_model_flag("storage/model", "default", &_sg_cfg_cb__storage_mode, surf_storage_model_description, "model", + "The model to use for the storage"); - describe_model(description, descsize, surf_network_model_description, "model", "The model to use for the network"); - simgrid::config::declare_flag("network/model", description, "LV08", &_sg_cfg_cb__network_model); + declare_model_flag("network/model", "LV08", &_sg_cfg_cb__network_model, surf_network_model_description, "model", + "The model to use for the network"); - describe_model(description, descsize, surf_optimization_mode_description, "optimization mode", - "The optimization modes to use for the network"); - simgrid::config::declare_flag("network/optim", description, "Lazy", &_sg_cfg_cb__optimization_mode); + declare_model_flag("network/optim", "Lazy", &_sg_cfg_cb__optimization_mode, surf_optimization_mode_description, + "optimization mode", "The optimization modes to use for the network"); - describe_model(description, descsize, surf_host_model_description, "model", "The model to use for the host"); - simgrid::config::declare_flag("host/model", description, "default", &_sg_cfg_cb__host_model); + declare_model_flag("host/model", "default", &_sg_cfg_cb__host_model, surf_host_model_description, "model", + "The model to use for the host"); simgrid::config::bind_flag(sg_surf_precision, "surf/precision", "Numerical precision used when updating simulation times (in seconds)"); @@ -295,8 +302,8 @@ void sg_config_init(int *argc, char **argv) extern bool _sg_do_verbose_exit; simgrid::config::bind_flag(_sg_do_verbose_exit, "verbose-exit", "Activate the \"do nothing\" mode in Ctrl-C"); - simgrid::config::declare_flag("contexts/stack-size", "Stack size of contexts in KiB", 8 * 1024, - [](int value) { smx_context_stack_size = value * 1024; }); + simgrid::config::declare_flag("contexts/stack-size", "Stack size of contexts in KiB (not with threads)", + 8 * 1024, [](int value) { smx_context_stack_size = value * 1024; }); simgrid::config::alias("contexts/stack-size", {"contexts/stack_size"}); /* guard size for contexts stacks in memory pages */ @@ -320,7 +327,7 @@ void sg_config_init(int *argc, char **argv) /* synchronization mode for parallel user contexts */ #if HAVE_FUTEX_H std::string default_synchro_mode = "futex"; -#else //No futex on mac and posix is unimplememted yet +#else // No futex on mac and posix is unimplemented yet std::string default_synchro_mode = "busy_wait"; #endif simgrid::config::declare_flag("contexts/synchro", "Synchronization mode to use when running contexts in " @@ -401,6 +408,9 @@ void sg_config_init(int *argc, char **argv) default_privatization); simgrid::config::alias("smpi/privatization", {"smpi/privatize_global_variables", "smpi/privatize-global-variables"}); + simgrid::config::declare_flag( + "smpi/privatize-libs", "Add libraries (; separated) to privatize (libgfortran for example). You need to provide the full names of the files (libgfortran.so.4), or its full path", ""); + simgrid::config::declare_flag("smpi/grow-injected-times", "Whether we want to make the injected time in MPI_Iprobe and MPI_Test grow, to " "allow faster simulation. This can make simulation less precise, though.", @@ -441,12 +451,6 @@ void sg_config_init(int *argc, char **argv) simgrid::config::declare_flag("smpi/reduce", "Which collective to use for reduce", ""); #endif // HAVE_SMPI - /* Storage */ - - sg_storage_max_file_descriptors = 1024; - simgrid::config::bind_flag(sg_storage_max_file_descriptors, "storage/max_file_descriptors", - "Maximum number of concurrently opened files per host. Default is 1024"); - /* Others */ simgrid::config::declare_flag( @@ -468,9 +472,6 @@ void sg_config_init(int *argc, char **argv) void sg_config_finalize() { - if (not _sg_cfg_init_status) - return; /* Not initialized yet. Nothing to do */ - simgrid::config::finalize(); _sg_cfg_init_status = 0; }