<p>Corey Farrell has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.asterisk.org/10377">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">RFC: Add support for disabled modules.<br><br>Change-Id: Ic44810ca6ce3deca30bceeb4eaa306d94f6b90e8<br>---<br>M include/asterisk/module.h<br>M main/loader.c<br>M res/res_statsd.c<br>3 files changed, 121 insertions(+), 18 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/77/10377/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/asterisk/module.h b/include/asterisk/module.h</span><br><span>index 08b4c43..4c3c68a 100644</span><br><span>--- a/include/asterisk/module.h</span><br><span>+++ b/include/asterisk/module.h</span><br><span>@@ -66,11 +66,49 @@</span><br><span> };</span><br><span> </span><br><span> enum ast_module_load_result {</span><br><span style="color: hsl(0, 100%, 40%);">- AST_MODULE_LOAD_SUCCESS = 0, /*!< Module loaded and configured */</span><br><span style="color: hsl(0, 100%, 40%);">- AST_MODULE_LOAD_DECLINE = 1, /*!< Module is not configured */</span><br><span style="color: hsl(0, 100%, 40%);">- AST_MODULE_LOAD_SKIP = 2, /*!< Module was skipped for some reason (For loader.c use only. Should never be returned by modules)*/</span><br><span style="color: hsl(0, 100%, 40%);">- AST_MODULE_LOAD_PRIORITY = 3, /*!< Module is not loaded yet, but is added to priority list */</span><br><span style="color: hsl(0, 100%, 40%);">- AST_MODULE_LOAD_FAILURE = -1, /*!< Module could not be loaded properly */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Module is loaded and configured. */</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_MODULE_LOAD_SUCCESS = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Module has failed to load, may be in an inconsistent state.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This value is used when a module fails to start but does not risk</span><br><span style="color: hsl(120, 100%, 40%);">+ * system-wide stability. Declined modules will prevent other any</span><br><span style="color: hsl(120, 100%, 40%);">+ * dependent module from starting.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_MODULE_LOAD_DECLINE = 1,</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! \internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Module was skipped for some reason.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \note For loader.c use only. Should never be returned by modules.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_MODULE_LOAD_SKIP = 2,</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! \internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Module is not loaded yet, but is added to priority list.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \note For loader.c use only. Should never be returned by modules.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_MODULE_LOAD_PRIORITY = 3,</span><br><span style="color: hsl(120, 100%, 40%);">+ /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Module load is successful but disabled.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Returning this value has the same effect as calling</span><br><span style="color: hsl(120, 100%, 40%);">+ * ast_module_set_disabled(1) then returning AST_MODULE_LOAD_SUCCESS.</span><br><span style="color: hsl(120, 100%, 40%);">+ * It is important that a module not unload if returning LOAD_DISABLED.</span><br><span style="color: hsl(120, 100%, 40%);">+ * load_module will not be called again. It is expected that a disabled</span><br><span style="color: hsl(120, 100%, 40%);">+ * module can be enabled by modifying and reload the module's configuration.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * See \ref ast_module_set_disabled</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_MODULE_LOAD_DISABLED = 4,</span><br><span style="color: hsl(120, 100%, 40%);">+ /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Module could not be loaded properly.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This return should only be returned by modules for unrecoverable</span><br><span style="color: hsl(120, 100%, 40%);">+ * failures that cause the whole system to become unstable. In almost</span><br><span style="color: hsl(120, 100%, 40%);">+ * all cases \ref AST_MODULE_LOAD_DECLINE or \ref AST_MODULE_LOAD_DISABLED</span><br><span style="color: hsl(120, 100%, 40%);">+ * should be used instead.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_MODULE_LOAD_FAILURE = -1,</span><br><span> };</span><br><span> </span><br><span> /*!</span><br><span>@@ -136,6 +174,25 @@</span><br><span> int ast_unload_resource(const char *resource_name, enum ast_module_unload_mode);</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Flag a module as disabled.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param mod Module to flag</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param disabled Zero to clear the flag, non-zero to set.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 0 Module was not previously disabled</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 1 Module was previously disabled</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int ast_module_set_disabled(struct ast_module *mod, int disabled);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Retrieve the status of a module.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param mod Module to check.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns A string representing the current status of \a mod.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+const char *ast_module_status(const struct ast_module *mod);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span> * \brief Reload asterisk modules.</span><br><span> * \param name the name of the module to reload</span><br><span> *</span><br><span>diff --git a/main/loader.c b/main/loader.c</span><br><span>index eb345b5..8291a7c 100644</span><br><span>--- a/main/loader.c</span><br><span>+++ b/main/loader.c</span><br><span>@@ -177,6 +177,8 @@</span><br><span> unsigned int running:1;</span><br><span> /*! The module has declined to start. */</span><br><span> unsigned int declined:1;</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! This module is disabled. */</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int disabled:1;</span><br><span> /*! This module is being held open until it's time to shutdown. */</span><br><span> unsigned int keepuntilshutdown:1;</span><br><span> /*! The module is built-in. */</span><br><span>@@ -1048,8 +1050,9 @@</span><br><span> }</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- if (!error)</span><br><span style="color: hsl(0, 100%, 40%);">- mod->flags.running = mod->flags.declined = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!error) {</span><br><span style="color: hsl(120, 100%, 40%);">+ mod->flags.running = mod->flags.declined = mod->flags.disabled = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> </span><br><span> AST_DLLIST_UNLOCK(&module_list);</span><br><span> </span><br><span>@@ -1326,6 +1329,27 @@</span><br><span> publish_load_message_type("Reload", S_OR(name, "All"), res_buffer);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+int ast_module_set_disabled(struct ast_module *mod, int disabled)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ int oldValue;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Ensure all non-zero is always 1 for matching against previous value. */</span><br><span style="color: hsl(120, 100%, 40%);">+ disabled = disabled ? 1 : 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_mutex_lock(&reloadlock);</span><br><span style="color: hsl(120, 100%, 40%);">+ oldValue = mod->flags.disabled;</span><br><span style="color: hsl(120, 100%, 40%);">+ mod->flags.disabled = disabled;</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_mutex_unlock(&reloadlock);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (disabled != oldValue) {</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(LOG_NOTICE, "%s %s.\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_module_name(mod),</span><br><span style="color: hsl(120, 100%, 40%);">+ disabled ? "disabled" : "enabled");</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return oldValue;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> enum ast_module_reload_result ast_module_reload(const char *name)</span><br><span> {</span><br><span> struct ast_module *cur;</span><br><span>@@ -1473,9 +1497,17 @@</span><br><span> if (!ast_fully_booted) {</span><br><span> ast_verb(1, "Loading %s.\n", mod->resource);</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* This should normally be a NOOP unless a previous attempted</span><br><span style="color: hsl(120, 100%, 40%);">+ * load set disabled but then returned AST_MODULE_LOAD_DECLINE. */</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_module_set_disabled(mod, 0);</span><br><span> res = mod->info->load();</span><br><span> </span><br><span> switch (res) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case AST_MODULE_LOAD_DISABLED:</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_module_set_disabled(mod, 1);</span><br><span style="color: hsl(120, 100%, 40%);">+ res = AST_MODULE_LOAD_SUCCESS;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* fall-through */</span><br><span> case AST_MODULE_LOAD_SUCCESS:</span><br><span> if (!ast_fully_booted) {</span><br><span> ast_verb(2, "%s => (%s)\n", mod->resource, term_color(tmp, mod->info->description, COLOR_BROWN, COLOR_BLACK, sizeof(tmp)));</span><br><span>@@ -1782,11 +1814,12 @@</span><br><span> lres = load_resource(order->resource, !lasttry, &module_priorities, order->required, order->preload);</span><br><span> ast_debug(3, "PASS %d: %-46s %d\n", attempt, order->resource, lres);</span><br><span> switch (lres) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case AST_MODULE_LOAD_DISABLED:</span><br><span> case AST_MODULE_LOAD_SUCCESS:</span><br><span> case AST_MODULE_LOAD_SKIP:</span><br><span style="color: hsl(0, 100%, 40%);">- /* We're supplying module_priorities so SUCCESS isn't possible but we</span><br><span style="color: hsl(0, 100%, 40%);">- * still have to test for it. SKIP is only used when we try to start a</span><br><span style="color: hsl(0, 100%, 40%);">- * module that is missing dependencies. */</span><br><span style="color: hsl(120, 100%, 40%);">+ /* We're supplying module_priorities so SUCCESS and DISABLED aren't</span><br><span style="color: hsl(120, 100%, 40%);">+ * possible but we still have to test for them. SKIP is only used</span><br><span style="color: hsl(120, 100%, 40%);">+ * when we try to start a module that is missing dependencies. */</span><br><span> break;</span><br><span> case AST_MODULE_LOAD_DECLINE:</span><br><span> break;</span><br><span>@@ -2073,6 +2106,19 @@</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+const char *ast_module_status(const struct ast_module *mod)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ if (mod->flags.running) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return mod->flags.disabled ? "Disabled" : "Running";</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (mod->flags.declined) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return "Run Declined";</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return "Not Running";</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> int ast_update_module_list(int (*modentry)(const char *module, const char *description,</span><br><span> int usecnt, const char *status, const char *like,</span><br><span> enum ast_module_support_level support_level),</span><br><span>@@ -2090,7 +2136,7 @@</span><br><span> struct ast_module *cur = AST_VECTOR_GET(&alpha_module_list, idx);</span><br><span> </span><br><span> total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount,</span><br><span style="color: hsl(0, 100%, 40%);">- cur->flags.running ? "Running" : "Not Running", like, cur->info->support_level);</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_module_status(cur), like, cur->info->support_level);</span><br><span> }</span><br><span> }</span><br><span> </span><br><span>@@ -2118,7 +2164,7 @@</span><br><span> struct ast_module *cur = AST_VECTOR_GET(&alpha_module_list, idx);</span><br><span> </span><br><span> total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount,</span><br><span style="color: hsl(0, 100%, 40%);">- cur->flags.running? "Running" : "Not Running", like, cur->info->support_level, data);</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_module_status(cur), like, cur->info->support_level, data);</span><br><span> }</span><br><span> }</span><br><span> </span><br><span>@@ -2147,7 +2193,7 @@</span><br><span> struct ast_module *cur = AST_VECTOR_GET(&alpha_module_list, idx);</span><br><span> </span><br><span> conditions_met += modentry(cur->resource, cur->info->description, cur->usecount,</span><br><span style="color: hsl(0, 100%, 40%);">- cur->flags.running? "Running" : "Not Running", like, cur->info->support_level, data,</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_module_status(cur), like, cur->info->support_level, data,</span><br><span> condition);</span><br><span> }</span><br><span> }</span><br><span>diff --git a/res/res_statsd.c b/res/res_statsd.c</span><br><span>index 3e08152..c83a278 100644</span><br><span>--- a/res/res_statsd.c</span><br><span>+++ b/res/res_statsd.c</span><br><span>@@ -271,7 +271,7 @@</span><br><span> CONFIG_INFO_STANDARD(cfg_info, confs, conf_alloc,</span><br><span> .files = ACO_FILES(&conf_file));</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \brief Helper function to check if module is enabled. */</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Helper function to check if module should be enabled. */</span><br><span> static char is_enabled(void)</span><br><span> {</span><br><span> RAII_VAR(struct conf *, cfg, ao2_global_obj_ref(confs), ao2_cleanup);</span><br><span>@@ -303,6 +303,7 @@</span><br><span> ast_debug(3, " statsd server = %s.\n", server);</span><br><span> ast_debug(3, " add newline = %s\n", AST_YESNO(cfg->global->add_newline));</span><br><span> ast_debug(3, " prefix = %s\n", cfg->global->prefix);</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_module_set_disabled(AST_MODULE_SELF, 0);</span><br><span> </span><br><span> return 0;</span><br><span> }</span><br><span>@@ -314,6 +315,7 @@</span><br><span> close(socket_fd);</span><br><span> socket_fd = -1;</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_module_set_disabled(AST_MODULE_SELF, 1);</span><br><span> }</span><br><span> </span><br><span> static int load_module(void)</span><br><span>@@ -340,8 +342,7 @@</span><br><span> CHARFLDSET(struct conf_global_options, prefix));</span><br><span> </span><br><span> if (aco_process_config(&cfg_info, 0)) {</span><br><span style="color: hsl(0, 100%, 40%);">- aco_info_destroy(&cfg_info);</span><br><span style="color: hsl(0, 100%, 40%);">- return AST_MODULE_LOAD_DECLINE;</span><br><span style="color: hsl(120, 100%, 40%);">+ return AST_MODULE_LOAD_DISABLED;</span><br><span> }</span><br><span> </span><br><span> if (!is_enabled()) {</span><br><span>@@ -349,8 +350,7 @@</span><br><span> }</span><br><span> </span><br><span> if (statsd_init() != 0) {</span><br><span style="color: hsl(0, 100%, 40%);">- aco_info_destroy(&cfg_info);</span><br><span style="color: hsl(0, 100%, 40%);">- return AST_MODULE_LOAD_DECLINE;</span><br><span style="color: hsl(120, 100%, 40%);">+ return AST_MODULE_LOAD_DISABLED;</span><br><span> }</span><br><span> </span><br><span> return AST_MODULE_LOAD_SUCCESS;</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/10377">change 10377</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/10377"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: Ic44810ca6ce3deca30bceeb4eaa306d94f6b90e8 </div>
<div style="display:none"> Gerrit-Change-Number: 10377 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Corey Farrell <git@cfware.com> </div>