<p>Neels Hofmeyr has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/12268">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add to osmo_sock_get_name*() API<br><br>Basically, I am applying code review that I would have given had I not been on<br>vacation when the last osmo_sock_get_name* stuff was merged.<br><br>osmo_sock_get_name2() is so far a static internal function. However, it is<br>nothing like osmo_sock_get_name(), so instead rename it to<br>osmo_sock_get_ip_and_port(). Also make it public API, no need to hide it. I'm<br>adding an "and" in the name to hopefully clarify: "ip_port" vs. "ip_and_port"<br>-- there already are _get_X_ip_port() functions that only return the port<br>string, despite "ip" in the name.<br><br>Add new public osmo_sock_get_name2(), which is like osmo_sock_get_name(),<br>except it uses a static string instead of talloc, and omits the braces. This<br>is most convenient for log statement formats, avoiding dyn allocations.<br><br>Add new osmo_sock_get_name2_buf(), which is like osmo_sock_get_name2() but<br>writes to a caller provided char buffer. Technically this should be called<br>osmo_sock_get_name_buf() without '2', but that would be quite confusing.<br><br>Use osmo_sock_get_name2_buf() in the implementation of osmo_sock_get_name(),<br>but use another (non-static) local string buffer, because adding braces is too<br>complex without talloc_snprintf().<br><br>Rationale:<br><br>I want to improve the logging of socket errors, e.g. change<br><br> DLMGCP ERROR Failed to read: 111/Connection refused (mgcp_client.c:720)<br><br>to<br><br> DLMGCP ERROR Failed to read: r=10.0.99.2:2427<->l=10.0.99.2:2728: 111='Connection refused' (mgcp_client.c:721)<br><br>but it is just not handy to compose logging with the current API:<br><br>- osmo_sock_get_name() requires a talloc_free().<br>- all the others require output buffers.<br>- the only way to conveniently compose a logging string and,<br>- notably, the only trivial way to skip the string composition if the logging<br> level is currently muted, is to have a function that returns a static string:<br> the new osmo_sock_get_name2().<br>- (I think the osmo_sock_get_{local,remote}_* convenience wrappers should never<br> have been added, because they encourage the caller to invoke the same code<br> twice, for IP addr and port, and throw away one half each time.)<br><br>Related: Iae728192f499330d16836d9435648f6b8ed213b6 (osmo-mgw)<br>Change-Id: I8ad89ac447c9c582742e70d082072bdd40a5a398<br>---<br>M include/osmocom/core/socket.h<br>M src/socket.c<br>2 files changed, 49 insertions(+), 17 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/68/12268/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 79a61bb..fd28f21 100644</span><br><span>--- a/include/osmocom/core/socket.h</span><br><span>+++ b/include/osmocom/core/socket.h</span><br><span>@@ -60,6 +60,9 @@</span><br><span> const char *socket_path, unsigned int flags);</span><br><span> </span><br><span> char *osmo_sock_get_name(void *ctx, int fd);</span><br><span style="color: hsl(120, 100%, 40%);">+const char *osmo_sock_get_name2(int fd);</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_sock_get_name2_buf(char *str, size_t str_len, int fd);</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);</span><br><span> int osmo_sock_get_local_ip(int fd, char *host, size_t len);</span><br><span> int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);</span><br><span> int osmo_sock_get_remote_ip(int fd, char *host, size_t len);</span><br><span>diff --git a/src/socket.c b/src/socket.c</span><br><span>index e804ab5..25c5504 100644</span><br><span>--- a/src/socket.c</span><br><span>+++ b/src/socket.c</span><br><span>@@ -697,10 +697,7 @@</span><br><span> return osmo_fd_init_ofd(ofd, osmo_sock_unix_init(type, proto, socket_path, flags));</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! Get the IP and/or port number on socket. This is for internal usage.</span><br><span style="color: hsl(0, 100%, 40%);">- * Convenience wrappers: osmo_sock_get_local_ip(),</span><br><span style="color: hsl(0, 100%, 40%);">- * osmo_sock_get_local_ip_port(), osmo_sock_get_remote_ip(),</span><br><span style="color: hsl(0, 100%, 40%);">- * osmo_sock_get_remote_ip_port() and osmo_sock_get_name()</span><br><span style="color: hsl(120, 100%, 40%);">+/*! Get the IP and/or port number on socket in separate string buffers.</span><br><span> * \param[in] fd file descriptor of socket</span><br><span> * \param[out] ip IP address (will be filled in when not NULL)</span><br><span> * \param[in] ip_len length of the ip buffer</span><br><span>@@ -709,7 +706,7 @@</span><br><span> * \param[in] local (true) or remote (false) name will get looked at</span><br><span> * \returns 0 on success; negative otherwise</span><br><span> */</span><br><span style="color: hsl(0, 100%, 40%);">-static int osmo_sock_get_name2(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local)</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local)</span><br><span> {</span><br><span> struct sockaddr sa;</span><br><span> socklen_t len = sizeof(sa);</span><br><span>@@ -741,7 +738,7 @@</span><br><span> */</span><br><span> int osmo_sock_get_local_ip(int fd, char *ip, size_t len)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- return osmo_sock_get_name2(fd, ip, len, NULL, 0, true);</span><br><span style="color: hsl(120, 100%, 40%);">+ return osmo_sock_get_ip_and_port(fd, ip, len, NULL, 0, true);</span><br><span> }</span><br><span> </span><br><span> /*! Get local port on socket</span><br><span>@@ -752,7 +749,7 @@</span><br><span> */</span><br><span> int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- return osmo_sock_get_name2(fd, NULL, 0, port, len, true);</span><br><span style="color: hsl(120, 100%, 40%);">+ return osmo_sock_get_ip_and_port(fd, NULL, 0, port, len, true);</span><br><span> }</span><br><span> </span><br><span> /*! Get remote IP address on socket</span><br><span>@@ -763,7 +760,7 @@</span><br><span> */</span><br><span> int osmo_sock_get_remote_ip(int fd, char *ip, size_t len)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- return osmo_sock_get_name2(fd, ip, len, NULL, 0, false);</span><br><span style="color: hsl(120, 100%, 40%);">+ return osmo_sock_get_ip_and_port(fd, ip, len, NULL, 0, false);</span><br><span> }</span><br><span> </span><br><span> /*! Get remote port on socket</span><br><span>@@ -774,29 +771,61 @@</span><br><span> */</span><br><span> int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- return osmo_sock_get_name2(fd, NULL, 0, port, len, false);</span><br><span style="color: hsl(120, 100%, 40%);">+ return osmo_sock_get_ip_and_port(fd, NULL, 0, port, len, false);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! Get address/port information on socket in dyn-alloc string</span><br><span style="color: hsl(120, 100%, 40%);">+/*! Get address/port information on socket in dyn-alloc string like "(r=1.2.3.4:5<->l=6.7.8.9:10)".</span><br><span style="color: hsl(120, 100%, 40%);">+ * Usually, it is better to use osmo_sock_get_name2() for a static string buffer or osmo_sock_get_name2_buf() for a</span><br><span style="color: hsl(120, 100%, 40%);">+ * caller provided string buffer, to avoid the dynamic talloc allocation.</span><br><span> * \param[in] ctx talloc context from which to allocate string buffer</span><br><span> * \param[in] fd file descriptor of socket</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns string identifying the connection of this socket</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns string identifying the connection of this socket, talloc'd from ctx.</span><br><span> */</span><br><span> char *osmo_sock_get_name(void *ctx, int fd)</span><br><span> {</span><br><span style="color: hsl(120, 100%, 40%);">+ char str[2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1];</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_sock_get_name2_buf(str, sizeof(str), fd);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc <= 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ return talloc_asprintf(ctx, "(%s)", str);</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%);">+/*! Get address/port information on socket in provided string buffer, like "r=1.2.3.4:5<->l=6.7.8.9:10".</span><br><span style="color: hsl(120, 100%, 40%);">+ * This does not include braces like osmo_sock_get_name().</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[out] str Destination string buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] str_len sizeof(str).</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] fd File descriptor of socket</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return String length as returned by snprintf(), or negative on error.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_sock_get_name2_buf(char *str, size_t str_len, int fd)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span> char hostbuf_l[INET6_ADDRSTRLEN], hostbuf_r[INET6_ADDRSTRLEN];</span><br><span> char portbuf_l[6], portbuf_r[6];</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span> </span><br><span> /* get local */</span><br><span style="color: hsl(0, 100%, 40%);">- if (osmo_sock_get_name2(fd, hostbuf_l, sizeof(hostbuf_l), portbuf_l, sizeof(portbuf_l), true))</span><br><span style="color: hsl(0, 100%, 40%);">- return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ if ((rc = osmo_sock_get_ip_and_port(fd, hostbuf_l, sizeof(hostbuf_l), portbuf_l, sizeof(portbuf_l), true)))</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span> </span><br><span> /* get remote */</span><br><span style="color: hsl(0, 100%, 40%);">- if (!osmo_sock_get_name2(fd, hostbuf_r, sizeof(hostbuf_r), portbuf_r, sizeof(portbuf_r), false))</span><br><span style="color: hsl(0, 100%, 40%);">- return talloc_asprintf(ctx, "(r=%s:%s<->l=%s:%s)", hostbuf_r, portbuf_r, hostbuf_l, portbuf_l);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (osmo_sock_get_ip_and_port(fd, hostbuf_r, sizeof(hostbuf_r), portbuf_r, sizeof(portbuf_r), false) != 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ return snprintf(str, str_len, "r=NULL<->l=%s:%s", hostbuf_l, portbuf_l);</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /* local only: different format */</span><br><span style="color: hsl(0, 100%, 40%);">- return talloc_asprintf(ctx, "(r=NULL<->l=%s:%s)", hostbuf_l, portbuf_l);</span><br><span style="color: hsl(120, 100%, 40%);">+ return snprintf(str, str_len, "r=%s:%s<->l=%s:%s", hostbuf_r, portbuf_r, hostbuf_l, portbuf_l);</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%);">+/*! Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10".</span><br><span style="color: hsl(120, 100%, 40%);">+ * This does not include braces like osmo_sock_get_name().</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] fd File descriptor of socket</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return Static string buffer containing the result.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+const char *osmo_sock_get_name2(int fd)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ /* "r=1.2.3.4:123<->l=5.6.7.8:987" */</span><br><span style="color: hsl(120, 100%, 40%);">+ static char str[2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1];</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_sock_get_name2_buf(str, sizeof(str), fd);</span><br><span style="color: hsl(120, 100%, 40%);">+ return str;</span><br><span> }</span><br><span> </span><br><span> static int sock_get_domain(int fd)</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/12268">change 12268</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/12268"/><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: I8ad89ac447c9c582742e70d082072bdd40a5a398 </div>
<div style="display:none"> Gerrit-Change-Number: 12268 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>