gtphub: add explicit cleanup handles.

Clean up functionality is added for the test suite only, to be able to clean
out all allocations and test against memory leaks.

So far, it was sufficient to expire everything to free a gtphub. In preparation
for the upcoming rate counters, which will need to be freed explicitly, add
gtphub functions to clean up everything.

As added bonus, also close the sockets explicitly -- not really needed upon
program exit, neither by the test suite, but *if* we have a cleanup function,
it should clean up everything properly.

Closing the sockets is however kept separate, for the test suite.
gtphub_start() and gtphub_stop() are for normal use (published in gtphub.h),
and gtphub_init() and gtphub_free() are for the test suite, without sockets.
(gtphub_stop() will probably never be called by anyone, but its existence
completes the picture.)

In gtphub_test.c, have a function to clean up the testing gtphub struct. First,
expire everything by timeout, assert emptiness, then call the cleanup function.
Call from each test in the end.

Sponsored-by: On-Waves ehi

1 files changed, 7 insertions, 0 deletions

diff --git a/openbsc/include/openbsc/gtphub.h b/openbsc/include/openbsc/gtphub.h
index fa63a20cb..b375391dd 100644
--- a/openbsc/include/openbsc/gtphub.h
+++ b/openbsc/include/openbsc/gtphub.h
@@ -200,6 +200,9 @@ void expiring_item_del(struct expiring_item *item);
  * count passed to nr_map_add(). A monotonous clock counter should be used. */
 int expiry_tick(struct expiry *exq, time_t now);
 
+/* Expire all items. */
+void expiry_clear(struct expiry *exq);
+
 
 /* number map */
 
@@ -429,6 +432,10 @@ int gtphub_cfg_read(struct gtphub_cfg *cfg, const char *config_file);
 /* Initialize and start gtphub: bind to ports, run expiry timers. */
 int gtphub_start(struct gtphub *hub, struct gtphub_cfg *cfg);
 
+/* Close all sockets, expire all maps and peers and free all allocations. The
+ * struct is then unusable, unless gtphub_start() is run on it again. */
+void gtphub_stop(struct gtphub *hub);
+
 time_t gtphub_now(void);
 
 /* Remove expired items, empty peers, ... */