<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/9277">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Jenkins Builder: Verified
Harald Welte: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">introduce vty_out_rate_ctr_group_fmt() function<br><br>This new function can be used to print a rate counter group according<br>to a format string. The intention is to generalize and replace manual<br>printing of counters as implemented for the 'show statistics' VTY<br>command of osmo-bsc.<br><br>Related: OS#3245<br>Related: osmo-bsc commit 71d524c059c5a5c90e7cb77d8a2134c1c68b9cde (g#9217)<br><br>Change-Id: Idb3ec12494ff6a3a05efcc8818e78d1baa6546bd<br>---<br>M include/osmocom/vty/misc.h<br>M src/vty/utils.c<br>2 files changed, 138 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/vty/misc.h b/include/osmocom/vty/misc.h</span><br><span>index 335558d..2ad9650 100644</span><br><span>--- a/include/osmocom/vty/misc.h</span><br><span>+++ b/include/osmocom/vty/misc.h</span><br><span>@@ -14,6 +14,8 @@</span><br><span> </span><br><span> void vty_out_rate_ctr_group(struct vty *vty, const char *prefix,</span><br><span> struct rate_ctr_group *ctrg);</span><br><span style="color: hsl(120, 100%, 40%);">+void vty_out_rate_ctr_group_fmt(struct vty *vty, const char *fmt,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct rate_ctr_group *ctrg);</span><br><span> </span><br><span> void vty_out_stat_item_group(struct vty *vty, const char *prefix,</span><br><span> struct osmo_stat_item_group *statg);</span><br><span>diff --git a/src/vty/utils.c b/src/vty/utils.c</span><br><span>index 8cd0b35..4d37093 100644</span><br><span>--- a/src/vty/utils.c</span><br><span>+++ b/src/vty/utils.c</span><br><span>@@ -84,6 +84,142 @@</span><br><span> rate_ctr_for_each_counter(ctrg, rate_ctr_handler, &vctx);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+static char *</span><br><span style="color: hsl(120, 100%, 40%);">+pad_append_str(char *s, const char *a, int minwidth)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ s = talloc_asprintf_append(s, "%*s", minwidth, a);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(s);</span><br><span style="color: hsl(120, 100%, 40%);">+ return s;</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%);">+static char *</span><br><span style="color: hsl(120, 100%, 40%);">+pad_append_ctr(char *s, uint64_t ctr, int minwidth, void *ctx)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ s = talloc_asprintf_append(s, "%*" PRIu64, minwidth, ctr);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(s);</span><br><span style="color: hsl(120, 100%, 40%);">+ return s;</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%);">+static int rate_ctr_handler_fmt(</span><br><span style="color: hsl(120, 100%, 40%);">+ struct rate_ctr_group *ctrg, struct rate_ctr *ctr,</span><br><span style="color: hsl(120, 100%, 40%);">+ const struct rate_ctr_desc *desc, void *vctx_)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct vty_out_context *vctx = vctx_;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct vty *vty = vctx->vty;</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *fmt = vctx->prefix;</span><br><span style="color: hsl(120, 100%, 40%);">+ char *s = talloc_strdup(vty, "");</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(s);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ while (*fmt) {</span><br><span style="color: hsl(120, 100%, 40%);">+ int ch, minwidth = 0, sign = 1;</span><br><span style="color: hsl(120, 100%, 40%);">+ char *p = strchr(fmt, '%');</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (p == NULL) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* No further % directives in format string. Copy rest verbatim and exit. */</span><br><span style="color: hsl(120, 100%, 40%);">+ s = talloc_strdup_append_buffer(s, fmt);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(s);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ ptrdiff_t len;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(p >= fmt);</span><br><span style="color: hsl(120, 100%, 40%);">+ len = p - fmt;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (len) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Copy bytes verbatim until next '%' byte. */</span><br><span style="color: hsl(120, 100%, 40%);">+ s = talloc_strndup_append_buffer(s, fmt, len);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(s);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ fmt = (const char *)(p + 1); /* skip past '%' */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (*fmt == '\0')</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</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%);">+ ch = *fmt++;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (ch == '-' && isdigit(*fmt)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ sign = -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ ch = *fmt++;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ while (isdigit(ch) && *fmt != '\0') {</span><br><span style="color: hsl(120, 100%, 40%);">+ minwidth *= 10;</span><br><span style="color: hsl(120, 100%, 40%);">+ minwidth += (ch - '0');</span><br><span style="color: hsl(120, 100%, 40%);">+ ch = *fmt++;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ minwidth *= sign;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (ch) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case '%':</span><br><span style="color: hsl(120, 100%, 40%);">+ s = talloc_asprintf_append(s, "%c", ch);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(s);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case 'd':</span><br><span style="color: hsl(120, 100%, 40%);">+ s = pad_append_str(s, desc->description, minwidth);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case 'n':</span><br><span style="color: hsl(120, 100%, 40%);">+ s = pad_append_str(s, desc->name, minwidth);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case 'c':</span><br><span style="color: hsl(120, 100%, 40%);">+ s = pad_append_ctr(s, ctr->current, minwidth, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case 'p':</span><br><span style="color: hsl(120, 100%, 40%);">+ s = pad_append_ctr(s, ctr->previous, minwidth, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case 'S':</span><br><span style="color: hsl(120, 100%, 40%);">+ s = pad_append_ctr(s, ctr->intv[RATE_CTR_INTV_SEC].rate, minwidth, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case 'M':</span><br><span style="color: hsl(120, 100%, 40%);">+ s = pad_append_ctr(s, ctr->intv[RATE_CTR_INTV_MIN].rate, minwidth, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case 'H':</span><br><span style="color: hsl(120, 100%, 40%);">+ s = pad_append_ctr(s, ctr->intv[RATE_CTR_INTV_HOUR].rate, minwidth, vty);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case 'D':</span><br><span style="color: hsl(120, 100%, 40%);">+ s = pad_append_ctr(s, ctr->intv[RATE_CTR_INTV_DAY].rate, minwidth, vty);</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%);">+ break;</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%);">+ vty_out(vty, "%s%s", s, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(s);</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%);">+/*! print a rate counter group to given VTY, formatting the line for each counter according to a format string.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The following format string directives are supported:</span><br><span style="color: hsl(120, 100%, 40%);">+ * - %d: The description of the counter</span><br><span style="color: hsl(120, 100%, 40%);">+ * - %n: The name of the counter</span><br><span style="color: hsl(120, 100%, 40%);">+ * - %c: The current value of the counter</span><br><span style="color: hsl(120, 100%, 40%);">+ * - %p: The previous value of the counter</span><br><span style="color: hsl(120, 100%, 40%);">+ * - %S: The interval of the counter in seconds</span><br><span style="color: hsl(120, 100%, 40%);">+ * - %M: The interval of the counter in minutes</span><br><span style="color: hsl(120, 100%, 40%);">+ * - %H: The interval of the counter in hours</span><br><span style="color: hsl(120, 100%, 40%);">+ * - %D: The interval of the counter in days</span><br><span style="color: hsl(120, 100%, 40%);">+ * - %%: Print a literal %.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * An optional number between % and the letter in a format directive may be used to set a minimum field width.</span><br><span style="color: hsl(120, 100%, 40%);">+ * If the expanded format directive is smaller than this width (according to strlen()) the string will be</span><br><span style="color: hsl(120, 100%, 40%);">+ * left-padded (if the number is positive) or right-padded (if the number is negative) with spaces.</span><br><span style="color: hsl(120, 100%, 40%);">+ * For example, "%25n" prints the counter name left-padded up to a minimum width of 25 columns.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * VTY_NEWLINE will be appended to the format string when it is printed.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] vty The VTY to which it should be printed</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] ctrg Rate counter group to be printed</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] fmt A format which may contain the above directives.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+void vty_out_rate_ctr_group_fmt(struct vty *vty, const char *fmt,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct rate_ctr_group *ctrg)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct vty_out_context vctx = {vty, fmt};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ vty_out(vty, "%s:%s", ctrg->desc->group_description, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rate_ctr_for_each_counter(ctrg, rate_ctr_handler_fmt, &vctx);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> static int rate_ctr_group_handler(struct rate_ctr_group *ctrg, void *vctx_)</span><br><span> {</span><br><span> struct vty_out_context *vctx = vctx_;</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/9277">change 9277</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/9277"/><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: merged </div>
<div style="display:none"> Gerrit-Change-Id: Idb3ec12494ff6a3a05efcc8818e78d1baa6546bd </div>
<div style="display:none"> Gerrit-Change-Number: 9277 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Stefan Sperling <ssperling@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>