Core: polishing support for Data Record extensions

Author: Lukas955

include/ipfixcol2/plugins.h

@@ -467,38 +467,30 @@ IPX_API int
 ipx_ctx_ext_consumer(ipx_ctx_t *ctx, const char *type, const char *name, ipx_ctx_ext_t **ext);
 
 /**
- * \brief Get size of an extension
+ * \brief Get an extension
+ *
+ * In case of a producer of the extension, it always returns #IPX_OK and fills the pointer and
+ * size. If the producer decides to fill the extension, it also must call ipx_ctx_ext_set_filled().
+ * Otherwise, consumers will not be able to get its content.
  *
- * Information about the extension are not available during ipx_plugin_init().
  * \param[in]  ext  Internal description of the extension
- * \param[out] size Size of the extension
+ * \param[in]  drec Data Record with extensions
+ * \param[out] data Pointer to extension data
+ * \param[out] size Size of the extensions (bytes)
  * \return #IPX_OK on success
- * \return #IPX_ERR_DENIED if the information is not available
+ * \return #IPX_ERR_NOTFOUND if the extension hasn't been filled by its producer
  */
 IPX_API int
-ipx_ctx_ext_size(ipx_ctx_ext_t *ext, size_t *size);
-
-/**
- * \brief Get data of an extension
- *
- * \note
- *   In case of a consumer, the function can return NULL if the extension hasn't been filled
- *   by the producer!
- * \param[in] ext      Internal description of the extension
- * \param[in] ipx_drec Data Record with extensions
- * \return Pointer to the extension or NULL
- */
-IPX_API void *
-ipx_ctx_ext_get(ipx_ctx_ext_t *ext, struct ipx_ipfix_record *ipx_drec);
+ipx_ctx_ext_get(ipx_ctx_ext_t *ext, struct ipx_ipfix_record *drec, void **data, size_t *size);
 
 /**
  * \brief Set the extension of a Data Record as filled (ONLY for the producer of the extension)
  *
- * \param[in] ext      Internal description of the extension
- * \param[in] ipx_drec Data Record with extensions
+ * \param[in] ext  Internal description of the extension
+ * \param[in] drec Data Record with extensions
  */
 IPX_API void
-ipx_ctx_ext_set_filled(ipx_ctx_ext_t *ext, struct ipx_ipfix_record *ipx_drec);
+ipx_ctx_ext_set_filled(ipx_ctx_ext_t *ext, struct ipx_ipfix_record *drec);
 
 /**
  * @}

src/core/configurator/extensions.cpp

@@ -98,7 +98,7 @@ ipx_cfg_extensions::check_dependencies(const std::string &ident, const struct ex
 
     // No producers?
     if (rec.producers.empty()) {
-        throw std::runtime_error("No provider of Data Record extension " + ident + "found. "
+        throw std::runtime_error("No provider of Data Record extension " + ident + " found. "
             "The extension is required by " + name_consumers);
     }
 
@@ -122,7 +122,7 @@ ipx_cfg_extensions::check_dependencies(const std::string &ident, const struct ex
         throw std::runtime_error("Instance '" + producer_rec.name + "', which is a provider "
             "of Data Record extension " + ident + ", is placed in the collector pipeline "
             "after '" + min_cons->name + "' instance, which depends on the extension. "
-            "Please, swap the order of the plugin instances");
+            "Please, swap the order of the plugin instances.");
     }
 }
 
@@ -176,8 +176,8 @@ ipx_cfg_extensions::resolve()
             ext.mask = mask;
 
             // Align the offset to multiple of 8
-            ext.offset += (ext.size % 8U == 0) ? (ext.size) : (((ext.size / 8U) + 1U) * 8U);
-            ext.mask <<= 1U;
+            offset += (ext.size % 8U == 0) ? (ext.size) : (((ext.size / 8U) + 1U) * 8U);
+            mask <<= 1U;
         }
     }
 

src/core/context.c

@@ -719,6 +719,7 @@ ipx_ctx_init(ipx_ctx_t *ctx, const char *params)
     // Try to initialize the plugin
     const char *plugin_name = ctx->plugin_cbs->info->name;
     IPX_CTX_DEBUG(ctx, "Calling instance constructor of the plugin '%s'", plugin_name);
+    ctx->type = plugin_type;
     // Temporarily remove permission to pass messages
     uint32_t permissions_old = ctx->permissions;
     ctx->permissions &= ~(uint32_t) IPX_CP_MSG_PASS;
@@ -732,6 +733,7 @@ ipx_ctx_init(ipx_ctx_t *ctx, const char *params)
     if (rc != IPX_OK) {
         IPX_CTX_ERROR(ctx, "Initialization function of the instance failed!", '\0');
         // Restore default default parameters
+        ctx->type = 0;
         ctx->permissions = 0;
         ctx->cfg_system.msg_mask_selected = 0;
         ctx->cfg_system.msg_mask_allowed = IPX_MSG_IPFIX | IPX_MSG_SESSION;
@@ -746,7 +748,6 @@ ipx_ctx_init(ipx_ctx_t *ctx, const char *params)
         IPX_CTX_WARNING(ctx, "The instance didn't set its private data.", '\0');
     }
 
-    ctx->type = plugin_type;
     ctx->state = IPX_CS_INIT;
     return IPX_OK;
 }

src/core/extension.c

@@ -45,36 +45,26 @@
 #include <string.h>
 
 int
-ipx_ctx_ext_size(ipx_ctx_ext_t *ext, size_t *size)
+ipx_ctx_ext_get(ipx_ctx_ext_t *ext, struct ipx_ipfix_record *drec, void **data, size_t *size)
 {
-    if (!ext->mask) {
-        // Mask is not filled -> initialization hasn't been completed yet
-        return IPX_ERR_DENIED;
+    if (ext->etype == IPX_EXTENSION_CONSUMER && (drec->ext_mask & ext->mask) == 0) {
+        // The extension hasn't been filled by the producer
+        return IPX_ERR_NOTFOUND;
     }
 
+    *data = &drec->ext[ext->offset];
     *size = ext->size;
     return IPX_OK;
 }
 
-void *
-ipx_ctx_ext_get(ipx_ctx_ext_t *ext, struct ipx_ipfix_record *ipx_drec)
-{
-    if (ext->etype == IPX_EXTENSION_CONSUMER && (ipx_drec->ext_mask & ext->mask) == 0) {
-        // The extension hasn't been filled by the producer
-        return NULL;
-    }
-
-    return (ipx_drec->ext + ext->offset);
-}
-
 void
-ipx_ctx_ext_set_filled(ipx_ctx_ext_t *ext, struct ipx_ipfix_record *ipx_drec)
+ipx_ctx_ext_set_filled(ipx_ctx_ext_t *ext, struct ipx_ipfix_record *drec)
 {
     if (ext->etype != IPX_EXTENSION_PRODUCER) {
         return; // Not allowed!
     }
 
-    ipx_drec->ext_mask |= ext->mask;
+    drec->ext_mask |= ext->mask;
 }
 
 int