<p>Harald Welte has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/13538">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">WIP: osmo_it_msgq: Osmocom Inter-thread Message Queue<br><br>This implements an inter-thread message queue based on top of<br>osmocom msgb, linked lists, eventfd and pthread mutex.<br><br>Change-Id: I30a7233cb0b51a883ad85c8c4165270b32c4be61<br>---<br>M include/Makefile.am<br>A include/osmocom/core/it_msgq.h<br>M src/Makefile.am<br>A src/it_msgq.c<br>M tests/Makefile.am<br>A tests/it_msgq/it_msgq_test.c<br>A tests/it_msgq/it_msgq_test.ok<br>M tests/testsuite.at<br>8 files changed, 399 insertions(+), 3 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/38/13538/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/Makefile.am b/include/Makefile.am</span><br><span>index 17f7d1c..8b18530 100644</span><br><span>--- a/include/Makefile.am</span><br><span>+++ b/include/Makefile.am</span><br><span>@@ -27,6 +27,7 @@</span><br><span> osmocom/core/gsmtap.h \</span><br><span> osmocom/core/gsmtap_util.h \</span><br><span> osmocom/core/isdnhdlc.h \</span><br><span style="color: hsl(120, 100%, 40%);">+ osmocom/core/it_msgq.h \</span><br><span> osmocom/core/linuxlist.h \</span><br><span> osmocom/core/linuxrbtree.h \</span><br><span> osmocom/core/logging.h \</span><br><span>diff --git a/include/osmocom/core/it_msgq.h b/include/osmocom/core/it_msgq.h</span><br><span>new file mode 100644</span><br><span>index 0000000..8e81a9a</span><br><span>--- /dev/null</span><br><span>+++ b/include/osmocom/core/it_msgq.h</span><br><span>@@ -0,0 +1,43 @@</span><br><span style="color: hsl(120, 100%, 40%);">+#pragma once</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/linuxlist.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/msgb.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/select.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <pthread.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \defgroup it_msgq Inter-ThreadMessage Queue</span><br><span style="color: hsl(120, 100%, 40%);">+ * @{</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file it_msgq.h */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct osmo_it_msgq {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* entry in global list of message queues */</span><br><span style="color: hsl(120, 100%, 40%);">+ struct llist_head entry;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* the actual list of msgb's. HEAD: first in queue; TAIL: last in queue */</span><br><span style="color: hsl(120, 100%, 40%);">+ struct llist_head list;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* A pthread mutex to safeguard accesses to the queue. No rwlock as we always write. */</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_mutex_t mutex;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Current count of messages in the queue */</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int current_length;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* osmo-fd wrapped eventfd */</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_fd event_ofd;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* a user-defined name for this queue */</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *name;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* maximum permitted length of queue */</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int max_length;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* read call-back, called for each de-queued message */</span><br><span style="color: hsl(120, 100%, 40%);">+ void (*read_cb)(struct osmo_it_msgq *q, struct msgb *msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* opaque data pointer passed through to call-back function */</span><br><span style="color: hsl(120, 100%, 40%);">+ void *data;</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%);">+struct osmo_it_msgq *osmo_it_msgq_by_name(const char *name);</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_it_msgq_enqueue(struct osmo_it_msgq *queue, struct msgb *msg);</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *osmo_it_msgq_dequeue(struct osmo_it_msgq *queue);</span><br><span style="color: hsl(120, 100%, 40%);">+struct osmo_it_msgq *osmo_it_msgq_alloc(void *ctx, const char *name, unsigned int max_length,</span><br><span style="color: hsl(120, 100%, 40%);">+ void (*read_cb)(struct osmo_it_msgq *q, struct msgb *msg));</span><br><span style="color: hsl(120, 100%, 40%);">+void osmo_it_msgq_destroy(struct osmo_it_msgq *q);</span><br><span style="color: hsl(120, 100%, 40%);">+void osmo_it_msgq_flush(struct osmo_it_msgq *q);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*! @} */</span><br><span>diff --git a/src/Makefile.am b/src/Makefile.am</span><br><span>index 54e9280..fb2e125 100644</span><br><span>--- a/src/Makefile.am</span><br><span>+++ b/src/Makefile.am</span><br><span>@@ -12,7 +12,7 @@</span><br><span> </span><br><span> lib_LTLIBRARIES = libosmocore.la</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-libosmocore_la_LIBADD = $(BACKTRACE_LIB) $(TALLOC_LIBS) $(LIBRARY_RT)</span><br><span style="color: hsl(120, 100%, 40%);">+libosmocore_la_LIBADD = $(BACKTRACE_LIB) $(TALLOC_LIBS) $(LIBRARY_RT) -lpthread</span><br><span> libosmocore_la_SOURCES = context.c timer.c timer_gettimeofday.c timer_clockgettime.c \</span><br><span> select.c signal.c msgb.c bits.c \</span><br><span> bitvec.c bitcomp.c counter.c fsm.c \</span><br><span>@@ -23,7 +23,7 @@</span><br><span> loggingrb.c crc8gen.c crc16gen.c crc32gen.c crc64gen.c \</span><br><span> macaddr.c stat_item.c stats.c stats_statsd.c prim.c \</span><br><span> conv_acc.c conv_acc_generic.c sercomm.c prbs.c \</span><br><span style="color: hsl(0, 100%, 40%);">- isdnhdlc.c \</span><br><span style="color: hsl(120, 100%, 40%);">+ isdnhdlc.c it_msgq.c \</span><br><span> tdef.c</span><br><span> </span><br><span> if HAVE_SSSE3</span><br><span>diff --git a/src/it_msgq.c b/src/it_msgq.c</span><br><span>new file mode 100644</span><br><span>index 0000000..3086d01</span><br><span>--- /dev/null</span><br><span>+++ b/src/it_msgq.c</span><br><span>@@ -0,0 +1,220 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \file it_msgq.c</span><br><span style="color: hsl(120, 100%, 40%);">+ * Osmocom Inter-Thread message queue implementation */</span><br><span style="color: hsl(120, 100%, 40%);">+/* (C) 2019 by Harald Welte <laforge@gnumonks.org></span><br><span style="color: hsl(120, 100%, 40%);">+ * All Rights Reserved.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * SPDX-License-Identifier: GPL-2.0+</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+ * it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Free Software Foundation; either version 2 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+ * (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+ * but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+ * GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * You should have received a copy of the GNU General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+ * along with this program; if not, write to the Free Software</span><br><span style="color: hsl(120, 100%, 40%);">+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,</span><br><span style="color: hsl(120, 100%, 40%);">+ * MA 02110-1301, USA.</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%);">+/*! \addtogroup it_msgq</span><br><span style="color: hsl(120, 100%, 40%);">+ * @{</span><br><span style="color: hsl(120, 100%, 40%);">+ * Inter-Thread Message Queue.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This implements a general-purpose message queue between threads. It</span><br><span style="color: hsl(120, 100%, 40%);">+ * uses 'struct msgb' as elements in the queue and an eventfd-based notification</span><br><span style="color: hsl(120, 100%, 40%);">+ * mechanism. Hence, it can be used for pretty much anything that can be stored</span><br><span style="color: hsl(120, 100%, 40%);">+ * inside msgbs, including msgb-wrapped osmo_prim.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The idea is that the sending thread simply calls osmo_it_msgq_enqueue().</span><br><span style="color: hsl(120, 100%, 40%);">+ * The receiving thread is woken up from its osmo_select_main() loop by eventfd,</span><br><span style="color: hsl(120, 100%, 40%);">+ * and a general osmo_fd callback function for the eventfd will dequeue each msgb</span><br><span style="color: hsl(120, 100%, 40%);">+ * and call a queue-specific callback function.</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%);">+#include <pthread.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <unistd.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <string.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <errno.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <sys/eventfd.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/linuxlist.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/msgb.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/it_msgq.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int eventfd_increment(int fd, uint64_t inc)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = write(fd, &inc, sizeof(inc));</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc != sizeof(inc))</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</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%);">+/* global (for all threads) list of message queues in a program + associated lock */</span><br><span style="color: hsl(120, 100%, 40%);">+static LLIST_HEAD(msg_queues);</span><br><span style="color: hsl(120, 100%, 40%);">+static pthread_rwlock_t msg_queues_rwlock;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static struct osmo_it_msgq *_osmo_it_msgq_by_name(const char *name)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_it_msgq *q;</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_for_each_entry(q, &msg_queues, entry) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!strcmp(q->name, name))</span><br><span style="color: hsl(120, 100%, 40%);">+ return q;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</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%);">+struct osmo_it_msgq *osmo_it_msgq_by_name(const char *name)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_it_msgq *q;</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_rwlock_rdlock(&msg_queues_rwlock);</span><br><span style="color: hsl(120, 100%, 40%);">+ q = _osmo_it_msgq_by_name(name);</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_rwlock_unlock(&msg_queues_rwlock);</span><br><span style="color: hsl(120, 100%, 40%);">+ return q;</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%);">+/* osmo_fd call-back when eventfd is readable */</span><br><span style="color: hsl(120, 100%, 40%);">+static int osmo_it_msgq_fd_cb(struct osmo_fd *ofd, unsigned int what)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_it_msgq *q = (struct osmo_it_msgq *) ofd->data;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint64_t val;</span><br><span style="color: hsl(120, 100%, 40%);">+ int i, rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!(what & OSMO_FD_READ))</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%);">+ rc = read(ofd->fd, &val, sizeof(val));</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < sizeof(val))</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%);">+ for (i = 0; i < val; i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg = osmo_it_msgq_dequeue(q);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* in case the user might have called osmo_it_msgq_flush() we may</span><br><span style="color: hsl(120, 100%, 40%);">+ * end up in the eventfd-dispatch but witout any messages left in the queue,</span><br><span style="color: hsl(120, 100%, 40%);">+ * otherwise I'd have loved to OSMO_ASSERT(msg) here. */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!msg)</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ q->read_cb(q, msg);</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 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%);">+/*! Allocate a new inter-thread message queue.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] ctx talloc context from which to allocate the queue</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] name human-readable string name of the queue; function creates a copy.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] read_cb call-back function to be called for each de-queued message</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns a newly-allocated inter-thread message queue; NULL in case of error */</span><br><span style="color: hsl(120, 100%, 40%);">+struct osmo_it_msgq *osmo_it_msgq_alloc(void *ctx, const char *name, unsigned int max_length,</span><br><span style="color: hsl(120, 100%, 40%);">+ void (*read_cb)(struct osmo_it_msgq *q, struct msgb *msg))</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_it_msgq *q;</span><br><span style="color: hsl(120, 100%, 40%);">+ int fd;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ q = talloc_zero(ctx, struct osmo_it_msgq);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!q)</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ q->name = talloc_strdup(q, name);</span><br><span style="color: hsl(120, 100%, 40%);">+ q->current_length = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ q->max_length = max_length;</span><br><span style="color: hsl(120, 100%, 40%);">+ q->read_cb = read_cb;</span><br><span style="color: hsl(120, 100%, 40%);">+ INIT_LLIST_HEAD(&q->list);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* create eventfd */</span><br><span style="color: hsl(120, 100%, 40%);">+ fd = eventfd(0, 0);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (fd < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(q);</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</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%);">+ /* initialize BUT NOT REGISTER the osmo_fd. The receiving thread must</span><br><span style="color: hsl(120, 100%, 40%);">+ * take are to select/poll/read/... on ot */</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_fd_setup(&q->event_ofd, fd, OSMO_FD_READ, osmo_it_msgq_fd_cb, q, 0);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* add to global list of queues, checking for duplicate names */</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_rwlock_wrlock(&msg_queues_rwlock);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (_osmo_it_msgq_by_name(q->name)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_rwlock_unlock(&msg_queues_rwlock);</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_fd_close(&q->event_ofd);</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(q);</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_add_tail(&q->entry, &msg_queues);</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_rwlock_unlock(&msg_queues_rwlock);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return q;</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%);">+/*! Flush all messages currently present in queue */</span><br><span style="color: hsl(120, 100%, 40%);">+static void _osmo_it_msgq_flush(struct osmo_it_msgq *q)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg;</span><br><span style="color: hsl(120, 100%, 40%);">+ while ((msg = msgb_dequeue_count(&q->list, &q->current_length))) {</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_free(msg);</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%);">+/*! Flush all messages currently present in queue */</span><br><span style="color: hsl(120, 100%, 40%);">+void osmo_it_msgq_flush(struct osmo_it_msgq *q)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_mutex_lock(&q->mutex);</span><br><span style="color: hsl(120, 100%, 40%);">+ _osmo_it_msgq_flush(q);</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_mutex_unlock(&q->mutex);</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%);">+/*! Destroy a message queue */</span><br><span style="color: hsl(120, 100%, 40%);">+void osmo_it_msgq_destroy(struct osmo_it_msgq *q)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ /* first remove from global list of queues */</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_rwlock_wrlock(&msg_queues_rwlock);</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_del(&q->entry);</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_rwlock_unlock(&msg_queues_rwlock);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* next, close the eventfd */</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_fd_close(&q->event_ofd);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* flush all messages still present */</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_it_msgq_flush(q);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* and finally release memory */</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(q);</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%);">+/*! Thread-safe en-queue to an inter-thread message queue.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] queue Inter-thread queue on which to enqueue</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] msgb Message buffer to enqueue</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 on success; negative on error */</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_it_msgq_enqueue(struct osmo_it_msgq *queue, struct msgb *msg)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_mutex_lock(&queue->mutex);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (queue->current_length+1 > queue->max_length) {</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_mutex_unlock(&queue->mutex);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -ENOSPC;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_enqueue_count(&queue->list, msg, &queue->current_length);</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_mutex_unlock(&queue->mutex);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* increment eventfd counter by one */</span><br><span style="color: hsl(120, 100%, 40%);">+ eventfd_increment(queue->event_ofd.fd, 1);</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%);">+/*! Thread-safe de-queue from an inter-thread message queue.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] queue Inter-thread queue from which to dequeue</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns dequeued message buffer; NULL if none available</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *osmo_it_msgq_dequeue(struct osmo_it_msgq *queue)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_mutex_lock(&queue->mutex);</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = msgb_dequeue_count(&queue->list, &queue->current_length);</span><br><span style="color: hsl(120, 100%, 40%);">+ pthread_mutex_unlock(&queue->mutex);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return msg;</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>diff --git a/tests/Makefile.am b/tests/Makefile.am</span><br><span>index 6aa1279..c51c039 100644</span><br><span>--- a/tests/Makefile.am</span><br><span>+++ b/tests/Makefile.am</span><br><span>@@ -30,7 +30,7 @@</span><br><span> tdef/tdef_test tdef/tdef_vty_test_config_root \</span><br><span> tdef/tdef_vty_test_config_subnode \</span><br><span> tdef/tdef_vty_test_dynamic \</span><br><span style="color: hsl(0, 100%, 40%);">- context/context_test \</span><br><span style="color: hsl(120, 100%, 40%);">+ context/context_test it_msgq/it_msgq_test \</span><br><span> $(NULL)</span><br><span> </span><br><span> if ENABLE_MSGFILE</span><br><span>@@ -240,6 +240,10 @@</span><br><span> context_context_test_SOURCES = context/context_test.c</span><br><span> context_context_test_LDADD = $(LDADD)</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+it_msgq_it_msgq_test_SOURCES = it_msgq/it_msgq_test.c</span><br><span style="color: hsl(120, 100%, 40%);">+it_msgq_it_msgq_test_LDADD = $(LDADD)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> # The `:;' works around a Bash 3.2 bug when the output is not writeable.</span><br><span> $(srcdir)/package.m4: $(top_srcdir)/configure.ac</span><br><span> :;{ \</span><br><span>@@ -309,6 +313,7 @@</span><br><span> tdef/tdef_vty_test_config_subnode.vty \</span><br><span> tdef/tdef_vty_test_dynamic.vty \</span><br><span> context/context_test.ok \</span><br><span style="color: hsl(120, 100%, 40%);">+ it_msgq/it_msgq_test.ok \</span><br><span> $(NULL)</span><br><span> </span><br><span> DISTCLEANFILES = atconfig atlocal conv/gsm0503_test_vectors.c</span><br><span>diff --git a/tests/it_msgq/it_msgq_test.c b/tests/it_msgq/it_msgq_test.c</span><br><span>new file mode 100644</span><br><span>index 0000000..c01b613</span><br><span>--- /dev/null</span><br><span>+++ b/tests/it_msgq/it_msgq_test.c</span><br><span>@@ -0,0 +1,106 @@</span><br><span style="color: hsl(120, 100%, 40%);">+#include <stdio.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <errno.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/it_msgq.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/msgb.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define ENTER_TC printf("\n== Entering test case %s\n", __func__)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void tc_alloc(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_it_msgq *q1, *q2;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ ENTER_TC;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("allocating q1\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ q1 = osmo_it_msgq_alloc(OTC_GLOBAL, "q1", 3, NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(q1);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* ensure that no duplicate allocation for the */</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("attempting duplicate allocation of qa\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ q2 = osmo_it_msgq_alloc(OTC_GLOBAL, "q1", 3, NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(!q2);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* ensure that same name can be re-created after destroying old one */</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_it_msgq_destroy(q1);</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("re-allocating q1\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ q1 = osmo_it_msgq_alloc(OTC_GLOBAL, "q1", 3, NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(q1);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_it_msgq_destroy(q1);</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 void tc_queue_length(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_it_msgq *q1;</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int qlen = 3;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg;</span><br><span style="color: hsl(120, 100%, 40%);">+ int i, rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ ENTER_TC;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("allocating q1\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ q1 = osmo_it_msgq_alloc(OTC_GLOBAL, "q1", qlen, NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(q1);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("adding queue entries up to the limit\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ for (i = 0; i < qlen; i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = msgb_alloc(23, __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_it_msgq_enqueue(q1, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(rc == 0);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("attempting to add more than the limit\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = msgb_alloc(23, __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_it_msgq_enqueue(q1, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(rc == -ENOSPC);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_it_msgq_destroy(q1);</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 g_read_cb_count;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void q_read_cb(struct osmo_it_msgq *q, struct msgb *msg)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ g_read_cb_count++;</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(msg);</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 void tc_eventfd(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_it_msgq *q1;</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int qlen = 30;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg;</span><br><span style="color: hsl(120, 100%, 40%);">+ int i, rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ ENTER_TC;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("allocating q1\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ q1 = osmo_it_msgq_alloc(OTC_GLOBAL, "q1", qlen, q_read_cb);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(q1);</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_fd_register(&q1->event_ofd);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* ensure read-cb isn't called unless we enqueue something */</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_select_main(1);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(g_read_cb_count == 0);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* ensure read-cb is called for each enqueued msg once */</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("adding %u queue entries up to the limit\n", qlen);</span><br><span style="color: hsl(120, 100%, 40%);">+ for (i = 0; i < qlen; i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = msgb_alloc(23, __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_it_msgq_enqueue(q1, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(rc == 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%);">+ osmo_select_main(1);</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%u entries were dequeued\n", qlen);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(g_read_cb_count == qlen);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_it_msgq_destroy(q1);</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%);">+int main(int argc, char **argv)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ tc_alloc();</span><br><span style="color: hsl(120, 100%, 40%);">+ tc_queue_length();</span><br><span style="color: hsl(120, 100%, 40%);">+ tc_eventfd();</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span>diff --git a/tests/it_msgq/it_msgq_test.ok b/tests/it_msgq/it_msgq_test.ok</span><br><span>new file mode 100644</span><br><span>index 0000000..7f102c6</span><br><span>--- /dev/null</span><br><span>+++ b/tests/it_msgq/it_msgq_test.ok</span><br><span>@@ -0,0 +1,15 @@</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+== Entering test case tc_alloc</span><br><span style="color: hsl(120, 100%, 40%);">+allocating q1</span><br><span style="color: hsl(120, 100%, 40%);">+attempting duplicate allocation of qa</span><br><span style="color: hsl(120, 100%, 40%);">+re-allocating q1</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+== Entering test case tc_queue_length</span><br><span style="color: hsl(120, 100%, 40%);">+allocating q1</span><br><span style="color: hsl(120, 100%, 40%);">+adding queue entries up to the limit</span><br><span style="color: hsl(120, 100%, 40%);">+attempting to add more than the limit</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+== Entering test case tc_eventfd</span><br><span style="color: hsl(120, 100%, 40%);">+allocating q1</span><br><span style="color: hsl(120, 100%, 40%);">+adding 30 queue entries up to the limit</span><br><span style="color: hsl(120, 100%, 40%);">+30 entries were dequeued</span><br><span>diff --git a/tests/testsuite.at b/tests/testsuite.at</span><br><span>index f1534e4..2c48485 100644</span><br><span>--- a/tests/testsuite.at</span><br><span>+++ b/tests/testsuite.at</span><br><span>@@ -337,3 +337,9 @@</span><br><span> cat $abs_srcdir/context/context_test.ok > expout</span><br><span> AT_CHECK([$abs_top_builddir/tests/context/context_test], [0], [expout], [ignore])</span><br><span> AT_CLEANUP</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+AT_SETUP([it_msgq])</span><br><span style="color: hsl(120, 100%, 40%);">+AT_KEYWORDS([it_msgq])</span><br><span style="color: hsl(120, 100%, 40%);">+cat $abs_srcdir/it_msgq/it_msgq_test.ok > expout</span><br><span style="color: hsl(120, 100%, 40%);">+AT_CHECK([$abs_top_builddir/tests/it_msgq/it_msgq_test], [0], [expout], [ignore])</span><br><span style="color: hsl(120, 100%, 40%);">+AT_CLEANUP</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/13538">change 13538</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/13538"/><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: I30a7233cb0b51a883ad85c8c4165270b32c4be61 </div>
<div style="display:none"> Gerrit-Change-Number: 13538 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Harald Welte <laforge@gnumonks.org> </div>