Moved include to src, updated store_destroy routine

Author: codepr

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 2.8)
 
 project(sol)
-set (VERSION 0.18.3)
+set (VERSION 0.18.5)
 set (CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 OPTION(DEBUG "add debug flags" OFF)
@@ -11,7 +11,6 @@ find_package(OpenSSL REQUIRED)
 
 set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR})
 
-include_directories(include)
 file(GLOB SOURCES src/*.c)
 file(GLOB TEST src/hashtable.c src/bst.c src/config.c src/list.c src/trie.c
     src/util.c src/iterator.c src/logging.c src/memory.c tests/*.c)
@@ -20,7 +19,7 @@ set(AUTHOR "Andrea Giacomo Baldan")
 set(LICENSE "BSD2 license")
 
 # Executable
-add_executable(sol ${SOURCES} include/uthash.h include/ref.h)
+add_executable(sol ${SOURCES})
 add_executable(sol_test ${TEST})
 
 if (DEBUG)

src/config.h

@@ -1,6 +1,6 @@
 /* BSD 2-Clause License
  *
- * Copyright (c) 2019, Andrea Giacomo Baldan All rights reserved.
+ * Copyright (c) 2020, Andrea Giacomo Baldan All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -63,7 +63,7 @@
 
 // Default parameters
 
-#define VERSION                     "0.18.3"
+#define VERSION                     "0.18.5"
 #define DEFAULT_SOCKET_FAMILY       INET
 #define DEFAULT_LOG_LEVEL           DEBUG
 #define DEFAULT_CONF_PATH           "/etc/sol/sol.conf"

include/ref.h renamed to src/ref.h

@@ -248,55 +248,55 @@ static void publish_stats(struct ev_ctx *ctx, void *data) {
         }
     };
 
-    publish_message(&p, topic_store_get(server.store, (char *) p.publish.topic));
+    publish_message(&p, topic_store_get(server.store, sys_topics[2].name));
 
     // $SOL/broker/uptime/sol
     p.publish.topiclen = sys_topics[3].len;
     p.publish.topic = (unsigned char *) sys_topics[3].name;
     p.publish.payloadlen = strlen(sutime);
     p.publish.payload = (unsigned char *) &sutime;
 
-    publish_message(&p, topic_store_get(server.store, (char *) p.publish.topic));
+    publish_message(&p, topic_store_get(server.store, sys_topics[3].name));
 
     // $SOL/broker/clients/connected
     p.publish.topiclen = sys_topics[4].len;
     p.publish.topic = (unsigned char *) sys_topics[4].name;
     p.publish.payloadlen = strlen(cclients);
     p.publish.payload = (unsigned char *) &cclients;
 
-    publish_message(&p, topic_store_get(server.store, (char *) p.publish.topic));
+    publish_message(&p, topic_store_get(server.store, sys_topics[4].name));
 
     // $SOL/broker/bytes/sent
     p.publish.topiclen = sys_topics[6].len;
     p.publish.topic = (unsigned char *) sys_topics[6].name;
     p.publish.payloadlen = strlen(bsent);
     p.publish.payload = (unsigned char *) &bsent;
 
-    publish_message(&p, topic_store_get(server.store, (char *) p.publish.topic));
+    publish_message(&p, topic_store_get(server.store, sys_topics[6].name));
 
     // $SOL/broker/messages/sent
     p.publish.topiclen = sys_topics[8].len;
     p.publish.topic = (unsigned char *) sys_topics[8].name;
     p.publish.payloadlen = strlen(msent);
     p.publish.payload = (unsigned char *) &msent;
 
-    publish_message(&p, topic_store_get(server.store, (char *) p.publish.topic));
+    publish_message(&p, topic_store_get(server.store, sys_topics[8].name));
 
     // $SOL/broker/messages/received
     p.publish.topiclen = sys_topics[9].len;
     p.publish.topic = (unsigned char *) sys_topics[9].name;
     p.publish.payloadlen = strlen(mrecv);
     p.publish.payload = (unsigned char *) &mrecv;
 
-    publish_message(&p, topic_store_get(server.store, (char *) p.publish.topic));
+    publish_message(&p, topic_store_get(server.store, sys_topics[9].name));
 
     // $SOL/broker/memory/used
     p.publish.topiclen = sys_topics[10].len;
     p.publish.topic = (unsigned char *) sys_topics[10].name;
     p.publish.payloadlen = strlen(mem);
     p.publish.payload = (unsigned char *) &mem;
 
-    publish_message(&p, topic_store_get(server.store, (char *) p.publish.topic));
+    publish_message(&p, topic_store_get(server.store, sys_topics[10].name));
 }
 
 /*
@@ -982,6 +982,7 @@ int start_server(const char *addr, const char *port) {
 
     close(sfd);
     AUTH_DESTROY(server.authentications);
+    topic_store_destroy(server.store);
 
     /* Destroy SSL context, if any present */
     if (conf->tls == true) {

src/server.c

@@ -88,7 +88,7 @@ struct topic {
  */
 struct topic_store {
     // The main topics Trie structure
-    Trie topics;
+    Trie *topics;
     // A list of wildcards subscriptions, as it's not possible to know in
     // advance what topics will match some wildcard subscriptions
     List *wildcards;
@@ -238,35 +238,121 @@ extern pthread_mutex_t mutex;
 struct server;
 
 bool is_subscribed(const struct topic *, const struct client_session *);
+
 struct subscriber *subscriber_new(struct topic *,
                                   struct client_session *, unsigned char);
+
 struct subscriber *subscriber_clone(const struct subscriber *);
-struct subscriber *topic_add_subscriber(struct topic *,
-                                        struct client_session *, unsigned char);
 
+/*
+ * Initialize a struct topic pointer by setting its name, subscribers and
+ * retained_msg are set to NULL.
+ * The function expects a non-null pointer and can't fail, if a null topic
+ * is passed, the function return prematurely.
+ */
 void topic_init(struct topic *, const char *);
+
+/*
+ * Allocate a new topic struct on the heap, initialize it then return a pointer
+ * to it. The function can fail as a memory allocation is requested, if it
+ * fails the program execution graceful crash.
+ */
 struct topic *topic_new(const char *);
+
+/*
+ * Deallocate the topic name, retained_msg and all its subscribers
+ */
+void topic_destroy(struct topic *);
+
+/*
+ * Allocate a new subscriber struct on the heap referring to the passed in
+ * topic, client_session and QoS, then add it to the topic map.
+ * The function can fail as a memory allocation is requested, if it fails the
+ * program execution graceful crash.
+ */
+struct subscriber *topic_add_subscriber(struct topic *,
+                                        struct client_session *, unsigned char);
+
+/*
+ * Remove a subscriber from the topic, the subscriber to be removed refers to
+ * the client_id belonging to the client pointer passed in.
+ * The subscriber deletion is really a reference count subtraction, DECREF
+ * macro takes care of the counter, if it reaches 0 it de-allocates the memory
+ * reserved to the struct subscriber.
+ * The function can't fail.
+ */
 void topic_del_subscriber(struct topic *, struct client *);
+
+/*
+ * Allocate a new store structure on the heap and return it after its
+ * initialization, also allocating a new list on the heap to keep track of
+ * wildcard topics.
+ * The function may gracefully crash as the memory allocation may fail.
+ */
 struct topic_store *topic_store_new(void);
-/* Find a topic by name and return it */
+
+/*
+ * Deallocate heap memory for the list and every wildcard item stored into,
+ * also the store is deallocated
+ */
+void topic_store_destroy(struct topic_store *);
+
+/*
+ * Return a topic associated to a topic name from the store, returns NULL if no
+ * topic is found.
+ */
 struct topic *topic_store_get(const struct topic_store *, const char *);
-/* Get or create a new topic if it doesn't exists */
+
+/*
+ * Return a topic associated to a topic name from the store, if no topic is
+ * insert it into the store before returning it. Like topic_store_get but
+ * cannot return NULL.
+ * The function may fail as in case of no topic found it tries to allocate
+ * space on the heap for the new inserted topic.
+ */
 struct topic *topic_store_get_or_put(struct topic_store *, const char *);
+
+/*
+ * Check if the store contains a topic by name key
+ */
 bool topic_store_contains(const struct topic_store *, const char *);
+
+/*
+ * Insert a topic into the store or update it if already present
+ */
 void topic_store_put(struct topic_store *, struct topic *);
+
+/*
+ * Remove a topic into the store
+ */
 void topic_store_del(struct topic_store *, const char *);
+
+/*
+ * Add a wildcard topic to the topic_store struct, does not check if it already
+ * exists
+ */
 void topic_store_add_wildcard(struct topic_store *, struct subscription *);
+
+/*
+ * Remove a wildcard by id key from the topic_store struct
+ */
 void topic_store_remove_wildcard(struct topic_store *, char *);
+
+/*
+ * Run a function to each node of the topic_store trie holding the topic
+ * entries
+ */
 void topic_store_map(struct topic_store *, const char *,
                      void (*fn)(struct trie_node *, void *), void *);
+
+/*
+ * Check if the wildcards list of the topic_store is empty
+ */
 bool topic_store_wildcards_empty(const struct topic_store *);
 
 #define topic_store_wildcards_foreach(item, store)  \
     list_foreach(item, store->wildcards)
 
-/* unsigned next_free_mid(struct client_session *); */
-/* void session_init(struct client_session *, const char *); */
-/* struct client_session *client_session_alloc(const char *); */
-
 #define has_inflight(session) ((session)->inflights > 0)
+
 #define inflight_msg_clear(msg) DECREF((msg)->packet, struct mqtt_packet)

src/sol_internal.h

@@ -28,20 +28,59 @@
 #include "memory.h"
 #include "sol_internal.h"
 
+/*
+ * Initialize a struct topic pointer by setting its name, subscribers and
+ * retained_msg are set to NULL.
+ * The function expects a non-null pointer and can't fail, if a null topic
+ * is passed, the function return prematurely.
+ */
 void topic_init(struct topic *t, const char *name) {
+    if (!t)
+        return;
     t->name = name;
     t->subscribers = NULL;
     t->retained_msg = NULL;
 }
 
+/*
+ * Allocate a new topic struct on the heap, initialize it then return a pointer
+ * to it. The function can fail as a memory allocation is requested, if it
+ * fails the program execution graceful crash.
+ */
 struct topic *topic_new(const char *name) {
-    if (!name)
-        return NULL;
     struct topic *t = try_alloc(sizeof(*t));
     topic_init(t, name);
     return t;
 }
 
+/*
+ * Deallocate the topic name, retained_msg and all its subscribers
+ */
+void topic_destroy(struct topic *t) {
+    if (!t)
+        return;
+    free_memory((void *) t->name);
+    free_memory(t->retained_msg);
+    if (!t->subscribers) {
+        free_memory(t);
+        return;
+    }
+    struct subscriber *sub, *dummy;
+    HASH_ITER(hh, t->subscribers, sub, dummy) {
+        if (!sub)
+            continue;
+        HASH_DEL(t->subscribers, sub);
+        free_memory(sub);
+    }
+    free_memory(t);
+}
+
+/*
+ * Allocate a new subscriber struct on the heap referring to the passed in
+ * topic, client_session and QoS, then add it to the topic map.
+ * The function can fail as a memory allocation is requested, if it fails the
+ * program execution graceful crash.
+ */
 struct subscriber *topic_add_subscriber(struct topic *t,
                                         struct client_session *s,
                                         unsigned char qos) {
@@ -52,6 +91,14 @@ struct subscriber *topic_add_subscriber(struct topic *t,
     return sub;
 }
 
+/*
+ * Remove a subscriber from the topic, the subscriber to be removed refers to
+ * the client_id belonging to the client pointer passed in.
+ * The subscriber deletion is really a reference count subtraction, DECREF
+ * macro takes care of the counter, if it reaches 0 it de-allocates the memory
+ * reserved to the struct subscriber.
+ * The function can't fail.
+ */
 void topic_del_subscriber(struct topic *t, struct client *c) {
     struct subscriber *sub = NULL;
     HASH_FIND_STR(t->subscribers, c->client_id, sub);