<p>Omar Ramadan has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/12814">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">VTY: add command show asciidoc ctrl<br><br>Builds on the asciidoc VTY feature to list out all of the registered CTRL<br>commands for a particular project. This will help with documentation generation<br>efforts, and serve as a quick way to know which CTRL parameters are registered<br><br>CTRL command access mode indicator<br><br>Adds an explicit access mode enum type, ctrl_cmd_mode to ctrl_cmd_element<br>which provides a programatic way to detect whether a CTRL command is RO/WO/RW<br>Also associates the access mode with the "show asciidoc ctrl" VTY command<br><br>Change-Id: I16f59bfca72a7dd9c268bc64499b26d82a2115d2<br>---<br>M include/osmocom/ctrl/control_cmd.h<br>M src/ctrl/control_cmd.c<br>M src/ctrl/control_vty.c<br>3 files changed, 122 insertions(+), 7 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/14/12814/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/ctrl/control_cmd.h b/include/osmocom/ctrl/control_cmd.h</span><br><span>index 276a7de..045bc2c 100644</span><br><span>--- a/include/osmocom/ctrl/control_cmd.h</span><br><span>+++ b/include/osmocom/ctrl/control_cmd.h</span><br><span>@@ -38,6 +38,13 @@</span><br><span> CTRL_TYPE_ERROR</span><br><span> };</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Ctrl command modes (RO, WO, RW) */</span><br><span style="color: hsl(120, 100%, 40%);">+enum ctrl_cmd_mode {</span><br><span style="color: hsl(120, 100%, 40%);">+ CTRL_MODE_RO,</span><br><span style="color: hsl(120, 100%, 40%);">+ CTRL_MODE_WO,</span><br><span style="color: hsl(120, 100%, 40%);">+ CTRL_MODE_RW</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! human-readable string names for \ref ctrl_type */</span><br><span> extern const struct value_string ctrl_type_vals[];</span><br><span> </span><br><span>@@ -96,6 +103,8 @@</span><br><span> /*! textual name/id of the CTRL command */</span><br><span> const char *name;</span><br><span> struct ctrl_cmd_struct strcmd;</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! read/write mode of the CTRL command */</span><br><span style="color: hsl(120, 100%, 40%);">+ enum ctrl_cmd_mode mode;</span><br><span> /*! call-back function implementing the SET operation */</span><br><span> int (*set)(struct ctrl_cmd *cmd, void *data);</span><br><span> /*! call-back function implementing the GET operation */</span><br><span>@@ -125,6 +134,8 @@</span><br><span> int ctrl_cmd_install(enum ctrl_node_type node, struct ctrl_cmd_element *cmd);</span><br><span> int ctrl_cmd_send(struct osmo_wqueue *queue, struct ctrl_cmd *cmd);</span><br><span> int ctrl_cmd_send_to_all(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd);</span><br><span style="color: hsl(120, 100%, 40%);">+int ctrl_cmds_for_each(int (*handle_ctrl_cmd)(struct ctrl_cmd_element *, void *),</span><br><span style="color: hsl(120, 100%, 40%);">+ enum ctrl_node_type node, void *data);</span><br><span> struct ctrl_cmd *ctrl_cmd_parse3(void *ctx, struct msgb *msg, bool *parse_failed);</span><br><span> struct ctrl_cmd *ctrl_cmd_parse2(void *ctx, struct msgb *msg);</span><br><span> struct ctrl_cmd *ctrl_cmd_parse(void *ctx, struct msgb *msg);</span><br><span>@@ -136,10 +147,12 @@</span><br><span> /*! Helper to generate static struct ctrl_cmd_element</span><br><span> * \param[in] cmdname symbol name of the command related functions/structures</span><br><span> * \param[in] cmdstr string name exposed on CTRL</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] cmdmode access mode of CTRL command</span><br><span> * \param[in] verify_name full symbol name of verification function */</span><br><span style="color: hsl(0, 100%, 40%);">-#define CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_name) \</span><br><span style="color: hsl(120, 100%, 40%);">+#define CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, cmdmode, verify_name) \</span><br><span> static struct ctrl_cmd_element cmd_##cmdname = { \</span><br><span> .name = cmdstr, \</span><br><span style="color: hsl(120, 100%, 40%);">+ .mode = cmdmode, \</span><br><span> .get = &get_##cmdname, \</span><br><span> .set = &set_##cmdname, \</span><br><span> .verify = verify_name, \</span><br><span>@@ -200,7 +213,7 @@</span><br><span> CTRL_HELPER_GET_INT(cmdname, dtype, element) \</span><br><span> CTRL_HELPER_SET_INT(cmdname, dtype, element) \</span><br><span> CTRL_HELPER_VERIFY_RANGE(cmdname, min, max) \</span><br><span style="color: hsl(0, 100%, 40%);">-CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname)</span><br><span style="color: hsl(120, 100%, 40%);">+CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, CTRL_MODE_RW, verify_##cmdname)</span><br><span> </span><br><span> /*! Helper to generate static GET function for string</span><br><span> * \param[in] cmdname symbol name of the command related function</span><br><span>@@ -240,7 +253,7 @@</span><br><span> #define CTRL_CMD_DEFINE_STRING(cmdname, cmdstr, dtype, element) \</span><br><span> CTRL_HELPER_GET_STRING(cmdname, dtype, element) \</span><br><span> CTRL_HELPER_SET_STRING(cmdname, dtype, element) \</span><br><span style="color: hsl(0, 100%, 40%);">-CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, NULL)</span><br><span style="color: hsl(120, 100%, 40%);">+CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, CTRL_MODE_RW, NULL)</span><br><span> </span><br><span> /*! Declare a read-write attribute. Declares get, set, verify.</span><br><span> * \param[in] cmdname symbol name of the command related functions/structures</span><br><span>@@ -249,7 +262,7 @@</span><br><span> static int get_##cmdname(struct ctrl_cmd *cmd, void *data); \</span><br><span> static int set_##cmdname(struct ctrl_cmd *cmd, void *data); \</span><br><span> static int verify_##cmdname(struct ctrl_cmd *cmd, const char *value, void *data); \</span><br><span style="color: hsl(0, 100%, 40%);">-CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname)</span><br><span style="color: hsl(120, 100%, 40%);">+CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, CTRL_MODE_RW, verify_##cmdname)</span><br><span> </span><br><span> /*! Define a read-only attribute. Declares get, implements set+verify</span><br><span> * \param[in] cmdname symbol name of the command related functions/structures</span><br><span>@@ -266,7 +279,7 @@</span><br><span> cmd->reply = "Read Only attribute"; \</span><br><span> return 1; \</span><br><span> } \</span><br><span style="color: hsl(0, 100%, 40%);">-CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname)</span><br><span style="color: hsl(120, 100%, 40%);">+CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, CTRL_MODE_RO, verify_##cmdname)</span><br><span> </span><br><span> /*! Define a write-only attribute. Declares set+verify, implements read call-back</span><br><span> * \param[in] cmdname symbol name of the command related functions/structures</span><br><span>@@ -279,7 +292,7 @@</span><br><span> return CTRL_CMD_ERROR; \</span><br><span> } \</span><br><span> static int verify_##cmdname(struct ctrl_cmd *cmd, const char *val, void *data); \</span><br><span style="color: hsl(0, 100%, 40%);">-CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname)</span><br><span style="color: hsl(120, 100%, 40%);">+CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, CTRL_MODE_WO, verify_##cmdname)</span><br><span> </span><br><span> /*! Define a write-only attribute without verify. Declares set, implements read+verify</span><br><span> * \param[in] cmdname symbol name of the command related functions/structures</span><br><span>@@ -295,6 +308,6 @@</span><br><span> { \</span><br><span> return 0; \</span><br><span> } \</span><br><span style="color: hsl(0, 100%, 40%);">-CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname)</span><br><span style="color: hsl(120, 100%, 40%);">+CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, CTRL_MODE_WO, verify_##cmdname)</span><br><span> </span><br><span> struct gsm_network;</span><br><span>diff --git a/src/ctrl/control_cmd.c b/src/ctrl/control_cmd.c</span><br><span>index 33496bd..31144ee 100644</span><br><span>--- a/src/ctrl/control_cmd.c</span><br><span>+++ b/src/ctrl/control_cmd.c</span><br><span>@@ -58,6 +58,32 @@</span><br><span> /* Functions from libosmocom */</span><br><span> extern vector cmd_make_descvec(const char *string, const char *descstr);</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Iterate over all control commands; call \a handle_ctrl_cmd call-back for each.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] handle_ctrl_cmd Call-back to be called for each control command; aborts if rc < 0</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] node CTRL node type from which to iterate</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] data Opaque data passed through to \a handle_ctrl_cmd function</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 if all \a handle_ctrl_cmd calls successful; negative on error */</span><br><span style="color: hsl(120, 100%, 40%);">+int ctrl_cmds_for_each(int (*handle_ctrl_cmd)(struct ctrl_cmd_element *, void *),</span><br><span style="color: hsl(120, 100%, 40%);">+ enum ctrl_node_type node, void *data)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ int index;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ctrl_cmd_element *cmd_el;</span><br><span style="color: hsl(120, 100%, 40%);">+ vector cmds_vec;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if ((cmds_vec = vector_lookup_ensure(ctrl_node_vec, node))) {</span><br><span style="color: hsl(120, 100%, 40%);">+ for (index = 0; index < vector_active(cmds_vec); index++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if ((cmd_el = vector_slot(cmds_vec, index))) {</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = handle_ctrl_cmd(cmd_el, data);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</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%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /* Get the ctrl_cmd_element that matches this command */</span><br><span> static struct ctrl_cmd_element *ctrl_cmd_get_element_match(vector vline, vector node)</span><br><span> {</span><br><span>@@ -143,6 +169,8 @@</span><br><span> ret = cmd_el->get(command, data);</span><br><span> goto out;</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> out:</span><br><span> if (ret == CTRL_CMD_REPLY) {</span><br><span> if (command->type == CTRL_TYPE_SET) {</span><br><span>diff --git a/src/ctrl/control_vty.c b/src/ctrl/control_vty.c</span><br><span>index ef98889..c0a1ebb 100644</span><br><span>--- a/src/ctrl/control_vty.c</span><br><span>+++ b/src/ctrl/control_vty.c</span><br><span>@@ -26,8 +26,12 @@</span><br><span> #include <stdlib.h></span><br><span> #include <osmocom/core/talloc.h></span><br><span> #include <osmocom/ctrl/control_vty.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/ctrl/control_cmd.h></span><br><span> #include <osmocom/vty/command.h></span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/* containing version info */</span><br><span style="color: hsl(120, 100%, 40%);">+extern struct host host;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> static void *ctrl_vty_ctx = NULL;</span><br><span> static const char *ctrl_vty_bind_addr = NULL;</span><br><span> </span><br><span>@@ -66,6 +70,75 @@</span><br><span> return CMD_SUCCESS;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+static int asciidoc_handle_ctrl_cmd(struct ctrl_cmd_element *cmd_el, void *sctx_)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct vty *vty = sctx_;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ctrl_cmd_struct *cmd_desc = &cmd_el->strcmd;</span><br><span style="color: hsl(120, 100%, 40%);">+ char *name = osmo_asciidoc_escape(cmd_el->name);</span><br><span style="color: hsl(120, 100%, 40%);">+ char *word, *mode;</span><br><span style="color: hsl(120, 100%, 40%);">+ int i;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* | name | commands | mode | */</span><br><span style="color: hsl(120, 100%, 40%);">+ vty_out(vty, "| %s |", name);</span><br><span style="color: hsl(120, 100%, 40%);">+ for (i=0; i < cmd_desc->nr_commands; i++){</span><br><span style="color: hsl(120, 100%, 40%);">+ word = osmo_asciidoc_escape(cmd_desc->command[i]);</span><br><span style="color: hsl(120, 100%, 40%);">+ vty_out(vty, " %s", word);</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(word);</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%);">+ switch(cmd_el->mode){</span><br><span style="color: hsl(120, 100%, 40%);">+ case CTRL_MODE_RO:</span><br><span style="color: hsl(120, 100%, 40%);">+ mode = "RO";</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case CTRL_MODE_WO:</span><br><span style="color: hsl(120, 100%, 40%);">+ mode = "WO";</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case CTRL_MODE_RW:</span><br><span style="color: hsl(120, 100%, 40%);">+ mode = "RW";</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ default:</span><br><span style="color: hsl(120, 100%, 40%);">+ mode = "";</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ vty_out(vty, " | %s |%s", mode, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(name);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</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%);">+DEFUN(show_ctrl_asciidoc_table,</span><br><span style="color: hsl(120, 100%, 40%);">+ show_ctrl_asciidoc_table_cmd,</span><br><span style="color: hsl(120, 100%, 40%);">+"show asciidoc ctrl",</span><br><span style="color: hsl(120, 100%, 40%);">+SHOW_STR "Asciidoc generation\n" "Generate table of all registered ctrl configurations\n")</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "// autogenerated by show asciidoc crtl%s", VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "These configurations and their description based on %s %s (%s).%s%s",</span><br><span style="color: hsl(120, 100%, 40%);">+host.app_info->name,</span><br><span style="color: hsl(120, 100%, 40%);">+host.app_info->version,</span><br><span style="color: hsl(120, 100%, 40%);">+host.app_info->name ? host.app_info->name : "", VTY_NEWLINE, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+/* 2x VTY_NEWLINE are intentional otherwise it would interpret the first table header</span><br><span style="color: hsl(120, 100%, 40%);">+ * as usual text*/</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "=== Root commands%s%s", VTY_NEWLINE, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "// generating tables for CTRL_NODE_ROOT%s", VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+ctrl_cmds_for_each(asciidoc_handle_ctrl_cmd, CTRL_NODE_ROOT, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "=== BTS commands (net.btsN.) %s%s", VTY_NEWLINE, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "// generating tables for CTRL_NODE_BTS%s", VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+ctrl_cmds_for_each(asciidoc_handle_ctrl_cmd, CTRL_NODE_BTS, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "=== TRX commands (net.btsN.trxM.) %s%s", VTY_NEWLINE, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "// generating tables for CTRL_NODE_TRX%s", VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+ctrl_cmds_for_each(asciidoc_handle_ctrl_cmd, CTRL_NODE_TRX, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "=== Timeslot commands (net.btsN.trxM.tsI.) %s%s", VTY_NEWLINE, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "// generating tables for CTRL_NODE_TS%s", VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+ctrl_cmds_for_each(asciidoc_handle_ctrl_cmd, CTRL_NODE_TS, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "=== FSM commands (description) %s%s", VTY_NEWLINE, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "// generating tables for CTRL_NODE_FSM%s", VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+ctrl_cmds_for_each(asciidoc_handle_ctrl_cmd, CTRL_NODE_FSM, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "=== FSM commands (instance) %s%s", VTY_NEWLINE, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+vty_out(vty, "// generating tables for CTRL_NODE_FSM_INST%s", VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+ctrl_cmds_for_each(asciidoc_handle_ctrl_cmd, CTRL_NODE_FSM_INST, vty);</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> static int config_write_ctrl(struct vty *vty)</span><br><span> {</span><br><span> /* So far there's only one element. Omit the entire section if the bind</span><br><span>@@ -86,6 +159,7 @@</span><br><span> install_node(&ctrl_node, config_write_ctrl);</span><br><span> </span><br><span> install_element(L_CTRL_NODE, &cfg_ctrl_bind_addr_cmd);</span><br><span style="color: hsl(120, 100%, 40%);">+ install_element_ve(&show_ctrl_asciidoc_table_cmd);</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/12814">change 12814</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/12814"/><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-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I16f59bfca72a7dd9c268bc64499b26d82a2115d2 </div>
<div style="display:none"> Gerrit-Change-Number: 12814 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Omar Ramadan <omar.ramadan93@gmail.com> </div>