Core: Introduce periodic message type

Author: Adrian Duriska

include/CMakeLists.txt

@@ -14,6 +14,7 @@ set(SUB_HEADERS
     ipfixcol2/message_garbage.h
     ipfixcol2/message_ipfix.h
     ipfixcol2/message_session.h
+    ipfixcol2/message_periodic.h
     ipfixcol2/plugins.h
     ipfixcol2/session.h
     ipfixcol2/utils.h

include/ipfixcol2.h

@@ -60,6 +60,7 @@
 #include <ipfixcol2/message_garbage.h>
 #include <ipfixcol2/message_session.h>
 #include <ipfixcol2/message_ipfix.h>
+#include <ipfixcol2/message_periodic.h>
 
 #include <ipfixcol2/plugins.h>
 #include <ipfixcol2/session.h>

include/ipfixcol2/message.h

@@ -77,6 +77,8 @@ enum ipx_msg_type {
     IPX_MSG_TERMINATE = (1 << 3),
     // An internal configuration message (only for internal usage)
     //IPX_MSG_CONFIG  = (1 << 4)
+    /** A periodic message                                                          */
+    IPX_MSG_PERIODIC = (1 << 5)
 };
 
 /** The data type of the base message                                               */
@@ -107,6 +109,7 @@ ipx_msg_destroy(ipx_msg_t *msg);
 #include <ipfixcol2/message_ipfix.h>
 #include <ipfixcol2/message_garbage.h>
 #include <ipfixcol2/message_session.h>
+#include <ipfixcol2/message_periodic.h>
 
 /**
  * \brief Cast from a base message to a session message
@@ -147,6 +150,19 @@ ipx_msg_base2ipfix(ipx_msg_t *msg)
     return (ipx_msg_ipfix_t *) msg;
 }
 
+/**
+ * \brief Cast base message to periodic message
+ *
+ * \param[in] msg   Pointer to the base message
+ * \return A pointer to a periodic message
+ */
+static inline ipx_msg_periodic_t *
+ipx_msg_base2periodic(ipx_msg_t *msg)
+{
+    assert(ipx_msg_get_type(msg) == IPX_MSG_PERIODIC);
+    return (ipx_msg_periodic_t *) msg;
+}
+
 /**@}*/
 
 #ifdef __cplusplus

include/ipfixcol2/message_periodic.h

@@ -0,0 +1,63 @@
+/**
+ * @file
+ * @author Adrian Duriska <[email protected]>
+ * @brief Periodic message
+ *
+ * Copyright: (C) 2024 CESNET, z.s.p.o.
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+#ifndef IPX_MESSAGE_PERIODIC_H
+#define IPX_MESSAGE_PERIODIC_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <ipfixcol2/message.h>
+
+typedef struct ipx_msg_periodic ipx_msg_periodic_t;
+
+/**
+ * \brief Cast periodic message to base message
+ *
+ * \param[in] msg   Pointer to the periodic message
+ * \return A pointer to a base message
+ */
+static inline ipx_msg_t *
+ipx_msg_periodic2base(ipx_msg_periodic_t *msg)
+{
+    return (ipx_msg_t *) msg;
+}
+
+/**
+ * \brief Get sequence number of periodic message
+ *
+ * \param[in] msg   Pointer to the periodic message
+ * \return Periodic messages sequence number
+ */
+IPX_API uint64_t
+ipx_msg_periodic_get_seq_num(ipx_msg_periodic_t *msg);
+
+/**
+ * \brief Get created time of periodic message
+ *
+ * \param[in] msg   Pointer to the periodic message
+ * \return Periodic messages created time
+ */
+IPX_API struct timespec
+ipx_msg_periodic_get_created(ipx_msg_periodic_t *msg);
+
+/**
+ * \brief Get last intermediate plugin processed time of periodic message
+ *
+ * \param[in] msg   Pointer to the periodic message
+ * \return Periodic messages last intermediate plugin processed time
+ */
+IPX_API struct timespec
+ipx_msg_periodic_get_last_processed(ipx_msg_periodic_t *msg);
+
+#ifdef __cplusplus
+}
+#endif
+#endif

src/core/CMakeLists.txt

@@ -41,6 +41,7 @@ set(CORE_SOURCE
     message_garbage.c
     message_ipfix.c
     message_ipfix.h
+    message_periodic.c
     message_session.c
     message_terminate.c
     message_terminate.h

src/core/message_base.c

@@ -67,5 +67,8 @@ ipx_msg_destroy(ipx_msg_t *msg)
     case IPX_MSG_TERMINATE:
         ipx_msg_terminate_destroy(ipx_msg_base2terminate(msg));
         break;
+    case IPX_MSG_PERIODIC:
+        ipx_msg_periodic_destroy(ipx_msg_base2periodic(msg));
+        break;
     }
 }

src/core/message_periodic.c

@@ -0,0 +1,80 @@
+/**
+ * @file
+ * @author Adrian Duriska <[email protected]>
+ * @brief Periodic message
+ *
+ * Copyright: (C) 2024 CESNET, z.s.p.o.
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+#include <stddef.h>
+#include <assert.h>
+#include <sys/time.h>
+
+#include <ipfixcol2.h>
+#include "message_periodic.h"
+
+/**
+ * \brief Structure of a periodic message
+ */
+struct ipx_msg_periodic {
+    struct ipx_msg msg_header;
+    /** Sequential number of the message */
+    uint64_t seq;
+    /** Timestamp, when the message was created */
+    struct timespec created;
+    /** Timestamp, when the message left the last intermediate plugin */
+    struct timespec last_processed;
+};
+
+static_assert(offsetof(struct ipx_msg_periodic, msg_header.type) == 0,
+    "Message header must be the first element of each IPFIXcol message.");
+
+ipx_msg_periodic_t *
+ipx_msg_periodic_create(uint64_t seq)
+{
+    struct ipx_msg_periodic *msg;
+
+    msg = malloc(sizeof(*msg));
+    if (!msg) {
+        return NULL;
+    }
+
+    ipx_msg_header_init(&msg->msg_header, IPX_MSG_PERIODIC);
+    clock_gettime(CLOCK_MONOTONIC, &msg->created);
+    msg->last_processed = msg->created;
+    msg->seq = seq;
+
+    return msg;
+}
+
+void
+ipx_msg_periodic_destroy(ipx_msg_periodic_t *msg)
+{
+    ipx_msg_header_destroy(&msg->msg_header);
+    free(msg);
+}
+
+uint64_t
+ipx_msg_periodic_get_seq_num(ipx_msg_periodic_t *msg)
+{
+    return msg->seq;
+}
+
+struct timespec
+ipx_msg_periodic_get_created(ipx_msg_periodic_t *msg)
+{
+    return msg->created;
+}
+
+struct timespec
+ipx_msg_periodic_get_last_processed(ipx_msg_periodic_t *msg)
+{
+    return msg->last_processed;
+}
+
+void
+ipx_msg_periodic_update_last_processed(ipx_msg_periodic_t *msg)
+{
+    clock_gettime(CLOCK_MONOTONIC, &msg->last_processed);
+}

src/core/message_periodic.h

@@ -0,0 +1,39 @@
+/**
+ * @file
+ * @author Adrian Duriska <[email protected]>
+ * @brief Periodic message
+ *
+ * Copyright: (C) 2024 CESNET, z.s.p.o.
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+#ifndef IPFIXCOL_MESSAGE_PERIODIC_INTERNAL_H
+#define IPFIXCOL_MESSAGE_PERIODIC_INTERNAL_H
+
+#include <ipfixcol2.h>
+#include "message_base.h"
+
+/**
+ * \brief Create a periodic message
+ *
+ * \param[in,out] seq   Pointer to the periodic messages sequence counter
+ * \return On success returns a pointer to the message. Otherwise returns NULL.
+ */
+ipx_msg_periodic_t *
+ipx_msg_periodic_create(uint64_t seq);
+
+/**
+ * \brief Destroy a periodic message
+ *
+ * \param[in] msg   Pointer to the periodic message to be destroyed
+ */
+void
+ipx_msg_periodic_destroy(ipx_msg_periodic_t *msg);
+
+/**
+ * \brief Set last intermediate processed time
+ */
+void
+ipx_msg_periodic_update_last_processed(ipx_msg_periodic_t *msg);
+
+#endif