<p>neels has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/libosmocore/+/26608">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add osmo_sockaddr_to_str_c(), osmo_sockaddr_to_str_buf2()<br><br>To easily log and print a sockaddr using OTC_SELECT, add<br>osmo_sockaddr_to_str_c().<br><br>Implement osmo_sockaddr_to_str_buf2() using osmo_strbuf, so that we can<br>return the chars_needed which osmo_sockaddr_to_str_c() uses.<br><br>From previous osmo_sockaddr_to_str_buf(), call<br>osmo_sockaddr_to_str_buf2() and return NULL if the buf_len was<br>insufficient, to mimick previous behavior. This makes it more<br>consistently returning NULL for insufficient buf_len, as shown in the<br>tweak that is needed in socket_test.c. Before osmo_sockaddr_to_str_buf()<br>would return a truncated port number, now it's all or NULL.<br><br>I will use osmo_sockaddr_to_str_c() in the new osmo-upf implementation.<br><br>Related: SYS#5599<br>Change-Id: I12771bf8a021e6785217b1faad03c09ec1cfef0e<br>---<br>M include/osmocom/core/socket.h<br>M src/socket.c<br>M tests/socket/socket_test.c<br>3 files changed, 59 insertions(+), 39 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/08/26608/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/core/socket.h b/include/osmocom/core/socket.h</span><br><span>index a053391..6d11e6f 100644</span><br><span>--- a/include/osmocom/core/socket.h</span><br><span>+++ b/include/osmocom/core/socket.h</span><br><span>@@ -130,6 +130,8 @@</span><br><span> const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);</span><br><span> char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,</span><br><span> const struct osmo_sockaddr *sockaddr);</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr);</span><br><span style="color: hsl(120, 100%, 40%);">+char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr);</span><br><span> </span><br><span> int osmo_sock_set_dscp(int fd, uint8_t dscp);</span><br><span> int osmo_sock_set_priority(int fd, int prio);</span><br><span>diff --git a/src/socket.c b/src/socket.c</span><br><span>index 1251061..3757539 100644</span><br><span>--- a/src/socket.c</span><br><span>+++ b/src/socket.c</span><br><span>@@ -1775,7 +1775,57 @@</span><br><span> return osmo_sockaddr_to_str_buf(buf, sizeof(buf), sockaddr);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! string-format a given osmo_sockaddr address into a user-supplied buffer</span><br><span style="color: hsl(120, 100%, 40%);">+/*! string-format a given osmo_sockaddr address into a user-supplied buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Same as osmo_sockaddr_to_str_buf() but returns a would-be length in snprintf() style.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] buf user-supplied output buffer</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] buf_len size of the user-supplied output buffer in bytes</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] sockaddr the osmo_sockaddr to print</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return number of characters that would be written if the buffer is large enough, like snprintf().</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_strbuf sb = { .buf = buf, .len = buf_len };</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t port = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!sockaddr) {</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRBUF_PRINTF(sb, "NULL");</span><br><span style="color: hsl(120, 100%, 40%);">+ return sb.chars_needed;</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 (sockaddr->u.sa.sa_family) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case AF_INET:</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_and_uint, &port, &sockaddr->u.sa);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (port)</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRBUF_PRINTF(sb, ":%u", port);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case AF_INET6:</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRBUF_PRINTF(sb, "[");</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_and_uint, &port, &sockaddr->u.sa);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRBUF_PRINTF(sb, "]");</span><br><span style="color: hsl(120, 100%, 40%);">+ if (port)</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRBUF_PRINTF(sb, ":%u", port);</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%);">+ OSMO_STRBUF_PRINTF(sb, "unsupported family %d", sockaddr->u.sa.sa_family);</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%);">+ return sb.chars_needed;</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%);">+/*! string-format a given osmo_sockaddr address into a talloc allocated buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Like osmo_sockaddr_to_str_buf2() but returns a talloc allocated string.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] ctx talloc context to allocate from, e.g. OTC_SELECT.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] sockaddr the osmo_sockaddr to print.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return human readable string.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_NAME_C_IMPL(ctx, 64, "ERROR", osmo_sockaddr_to_str_buf2, sockaddr)</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%);">+/*! string-format a given osmo_sockaddr address into a user-supplied buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Like osmo_sockaddr_to_str_buf2() but returns buf, or NULL if too short.</span><br><span> * \param[in] buf user-supplied output buffer</span><br><span> * \param[in] buf_len size of the user-supplied output buffer in bytes</span><br><span> * \param[in] sockaddr the osmo_sockaddr to print</span><br><span>@@ -1784,43 +1834,9 @@</span><br><span> char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,</span><br><span> const struct osmo_sockaddr *sockaddr)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- uint16_t port = 0;</span><br><span style="color: hsl(0, 100%, 40%);">- size_t written;</span><br><span style="color: hsl(0, 100%, 40%);">- if (buf_len < 5)</span><br><span style="color: hsl(120, 100%, 40%);">+ int chars_needed = osmo_sockaddr_to_str_buf2(buf, buf_len, sockaddr);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (chars_needed >= buf_len)</span><br><span> return NULL;</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- if (!sockaddr)</span><br><span style="color: hsl(0, 100%, 40%);">- return NULL;</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- switch (sockaddr->u.sa.sa_family) {</span><br><span style="color: hsl(0, 100%, 40%);">- case AF_INET:</span><br><span style="color: hsl(0, 100%, 40%);">- written = osmo_sockaddr_to_str_and_uint(buf, buf_len, &port, &sockaddr->u.sa);</span><br><span style="color: hsl(0, 100%, 40%);">- if (written + 1 >= buf_len && port)</span><br><span style="color: hsl(0, 100%, 40%);">- return NULL;</span><br><span style="color: hsl(0, 100%, 40%);">- if (port)</span><br><span style="color: hsl(0, 100%, 40%);">- snprintf(buf + written, buf_len - written, ":%u", port);</span><br><span style="color: hsl(0, 100%, 40%);">- break;</span><br><span style="color: hsl(0, 100%, 40%);">- case AF_INET6:</span><br><span style="color: hsl(0, 100%, 40%);">- buf[0] = '[';</span><br><span style="color: hsl(0, 100%, 40%);">- written = osmo_sockaddr_to_str_and_uint(buf + 1, buf_len - 1, &port, &sockaddr->u.sa);</span><br><span style="color: hsl(0, 100%, 40%);">- if (written + 2 >= buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return NULL;</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- if (written + 3 >= buf_len && port)</span><br><span style="color: hsl(0, 100%, 40%);">- return NULL;</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- if (port)</span><br><span style="color: hsl(0, 100%, 40%);">- snprintf(buf + 1 + written, buf_len - written - 1, "]:%u", port);</span><br><span style="color: hsl(0, 100%, 40%);">- else {</span><br><span style="color: hsl(0, 100%, 40%);">- buf[written + 1] = ']';</span><br><span style="color: hsl(0, 100%, 40%);">- buf[written + 2] = 0;</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">- break;</span><br><span style="color: hsl(0, 100%, 40%);">- default:</span><br><span style="color: hsl(0, 100%, 40%);">- snprintf(buf, buf_len, "unsupported family %d", sockaddr->u.sa.sa_family);</span><br><span style="color: hsl(0, 100%, 40%);">- return buf;</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> return buf;</span><br><span> }</span><br><span> </span><br><span>diff --git a/tests/socket/socket_test.c b/tests/socket/socket_test.c</span><br><span>index eda716a..fe77b92 100644</span><br><span>--- a/tests/socket/socket_test.c</span><br><span>+++ b/tests/socket/socket_test.c</span><br><span>@@ -345,9 +345,11 @@</span><br><span> OSMO_ASSERT(!strncmp("[::1]:42", result, sizeof(buf)));</span><br><span> </span><br><span> memset(&buf[0], 0, sizeof(buf));</span><br><span style="color: hsl(0, 100%, 40%);">- result = osmo_sockaddr_to_str_buf(buf, 8, &localhost6);</span><br><span> printf("Checking osmo_sockaddr_to_str_buf too short IPv6\n");</span><br><span style="color: hsl(0, 100%, 40%);">- OSMO_ASSERT(!strncmp("[::1]:4", result, sizeof(buf)));</span><br><span style="color: hsl(120, 100%, 40%);">+ result = osmo_sockaddr_to_str_buf(buf, 8, &localhost6);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(result == NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_sockaddr_to_str_buf2(buf, 8, &localhost6);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(!strncmp("[::1]:4", buf, sizeof(buf)));</span><br><span> </span><br><span> memset(&buf[0], 0, sizeof(buf));</span><br><span> result = osmo_sockaddr_to_str_buf(buf, 5, &localhost6);</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/libosmocore/+/26608">change 26608</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/+/26608"/><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: I12771bf8a021e6785217b1faad03c09ec1cfef0e </div>
<div style="display:none"> Gerrit-Change-Number: 26608 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: neels <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: lynxis lazus <lynxis@fe80.eu> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>