<p>osmith has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/libosmocore/+/24926">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">vty: add "shutdown"<br><br>Call osmo_select_shutdown_request() internally after user runs the<br>new shutdown command.<br><br>Lots of Osmocom applications don't use the osmo_select_shutdown_done()<br>command in their main loop (e.g. OsmoMSC, OsmoHLR, ...) so add a code<br>path for that case.<br><br>Closes: OS#4609<br>Change-Id: I3596a35b0f4a24e49484ec3f24a98e4d4f583e1e<br>---<br>M src/select.c<br>M src/vty/command.c<br>2 files changed, 30 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/26/24926/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/select.c b/src/select.c</span><br><span>index f7eb5ea..843bda4 100644</span><br><span>--- a/src/select.c</span><br><span>+++ b/src/select.c</span><br><span>@@ -73,6 +73,11 @@</span><br><span> static int _osmo_select_shutdown_requested = 0;</span><br><span> /*! See osmo_select_shutdown_request() */</span><br><span> static bool _osmo_select_shutdown_done = false;</span><br><span style="color: hsl(120, 100%, 40%);">+/*! For proper shutdown handling we expect osmo_select_shutdown_done() to be</span><br><span style="color: hsl(120, 100%, 40%);">+ * called in a program's main loop and clean up done afterwards. If the</span><br><span style="color: hsl(120, 100%, 40%);">+ * function never gets called, the VTY command "shutdown" needs to call exit()</span><br><span style="color: hsl(120, 100%, 40%);">+ * instead. */</span><br><span style="color: hsl(120, 100%, 40%);">+bool _osmo_select_shutdown_done_called = false;</span><br><span> </span><br><span> /*! Set up an osmo-fd. Will not register it.</span><br><span> * \param[inout] ofd Osmo FD to be set-up</span><br><span>@@ -661,6 +666,7 @@</span><br><span> /*! Return true after osmo_select_shutdown_requested() was called, and after an osmo_select poll loop found no more</span><br><span> * pending OSMO_FD_WRITE on any registered socket. */</span><br><span> bool osmo_select_shutdown_done() {</span><br><span style="color: hsl(120, 100%, 40%);">+ _osmo_select_shutdown_done_called = true;</span><br><span> return _osmo_select_shutdown_done;</span><br><span> };</span><br><span> </span><br><span>diff --git a/src/vty/command.c b/src/vty/command.c</span><br><span>index e747add..fdc19ed 100644</span><br><span>--- a/src/vty/command.c</span><br><span>+++ b/src/vty/command.c</span><br><span>@@ -45,6 +45,8 @@</span><br><span> #include <osmocom/vty/vty.h></span><br><span> #include <osmocom/vty/command.h></span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/logging.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/select.h></span><br><span> #include <osmocom/core/talloc.h></span><br><span> #include <osmocom/core/utils.h></span><br><span> </span><br><span>@@ -61,6 +63,8 @@</span><br><span> </span><br><span> #define CONFIGFILE_MASK 022</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+extern bool _osmo_select_shutdown_done_called;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> void *tall_vty_cmd_ctx;</span><br><span> </span><br><span> /* When cmd_init() was called, for the "show uptime". */</span><br><span>@@ -3021,6 +3025,25 @@</span><br><span> return CMD_SUCCESS;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+DEFUN(shutdown,</span><br><span style="color: hsl(120, 100%, 40%);">+ shutdown_cmd, "shutdown", "Request a graceful shutdown of the program\n")</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGLOBAL, LOGL_INFO, "Shutdown requested from telnet\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ vty_out(vty, "%s is shutting down. Bye!%s", host.app_info->name, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_select_shutdown_request();</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Call exit() from here if program won't stop on its own */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!_osmo_select_shutdown_done_called) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGLOBAL, LOGL_INFO, "Skipping %s main loop during shutdown\n", host.app_info->name);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ while (!osmo_select_shutdown_done())</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_select_main_ctx(0);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ exit(0);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ return CMD_SUCCESS;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /* Show version. */</span><br><span> DEFUN(show_version,</span><br><span> show_version_cmd, "show version", SHOW_STR "Displays program version\n")</span><br><span>@@ -4392,6 +4415,7 @@</span><br><span> install_lib_element(ENABLE_NODE, &config_disable_cmd);</span><br><span> install_lib_element(ENABLE_NODE, &config_terminal_cmd);</span><br><span> install_lib_element(ENABLE_NODE, ©_runningconfig_startupconfig_cmd);</span><br><span style="color: hsl(120, 100%, 40%);">+ install_lib_element(ENABLE_NODE, &shutdown_cmd);</span><br><span> }</span><br><span> install_lib_element(ENABLE_NODE, &show_startup_config_cmd);</span><br><span> install_lib_element(ENABLE_NODE, &show_version_cmd);</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/libosmocore/+/24926">change 24926</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.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.osmocom.org/c/libosmocore/+/24926"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: libosmocore </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I3596a35b0f4a24e49484ec3f24a98e4d4f583e1e </div>
<div style="display:none"> Gerrit-Change-Number: 24926 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: osmith <osmith@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>