Modifier, mapper: set limit to templates in mapper

Author: AdamZvara

src/core/modifier.c

@@ -11,6 +11,9 @@
 #include "message_ipfix.h"
 #include "modifier.h"
 
+/* Default number of templates stored in mapper */
+#define MAPPER_MAX_TEMPLATES 20000
+
 ipx_modifier_t *
 ipx_modifier_create(const struct ipx_modifier_field *fields,
     size_t fields_size,
@@ -257,34 +260,29 @@ modifier_ctx_find(ipx_modifier_t *mod, const struct ipx_msg_ctx *msg_ctx)
  * also includes reseting counter of last used template ID.
  *
  * \param[in]  mod      Modifier
- * \param[out] tmgr_gc  Template manager garbage structure
+ * \param[out] tmgr_gc  Generated template garbage
  * \return #IPX_OK on success, if current context is not set garbage is set to NULL
- * \return #IPX_ERR_NOMEM on memory allocation error (garbage is unchanged)
+ * \return #IPX_ERR_NOMEM on memory allocation error (garbage is NULL)
  */
 static int
-modifier_ctx_restart(ipx_modifier_t *mod, ipx_msg_garbage_t **gb_msg)
+modifier_ctx_restart(ipx_modifier_t *mod, fds_tgarbage_t **tmgr_gc)
 {
     if (mod->curr_ctx == NULL) {
-        *gb_msg = NULL;
+        *tmgr_gc = NULL;
         return IPX_OK;
     }
 
     int rc;
-    fds_tgarbage_t *mgr_garbage;
 
     // Clear template manager and get garbage
     fds_tmgr_clear(mod->curr_ctx->mgr);
-    rc = fds_tmgr_garbage_get(mod->curr_ctx->mgr, &mgr_garbage);
+    rc = fds_tmgr_garbage_get(mod->curr_ctx->mgr, tmgr_gc);
     if (rc) {
         // Memory allocation error
+        *tmgr_gc = NULL;
         return rc;
     }
 
-    if (mgr_garbage != NULL) {
-        ipx_msg_garbage_cb cb = (ipx_msg_garbage_cb) &fds_tmgr_garbage_destroy;
-        *gb_msg = ipx_msg_garbage_create(mgr_garbage, cb);
-    }
-
     // Reset ID counter
     mod->curr_ctx->next_id = FDS_IPFIX_SET_MIN_DSET;
 
@@ -901,17 +899,22 @@ mgr_find_template(ipx_modifier_t *mod, struct fds_template *tmplt)
  *
  * \param[in]  mod      Modifier
  * \param[in]  tmplt    Template to store
- * \param[out] garbage  Potential garbage
- * \return
+ * \param[out] garbage  Potential tmgr_gc from manager
+ * \return #IPX_OK on success, #IPX_ERR_DENIED on any error and error message is printed
  */
 static int
-mgr_store_template(ipx_modifier_t *mod, struct fds_template *tmplt, ipx_msg_garbage_t **garbage)
+mgr_store_template(ipx_modifier_t *mod, struct fds_template *tmplt, fds_tgarbage_t **tmgr_gc)
 {
     // Try to create new ID for template
     int rc = template_set_new_id(mod, tmplt);
     if (rc == IPX_ERR_LIMIT) {
         // No more IDs available, restart context
-        modifier_ctx_restart(mod, garbage);
+        if (modifier_ctx_restart(mod, tmgr_gc) != IPX_OK) {
+            MODIFIER_ERROR(mod, "Failed to restart context (%s:%d)", __FILE__, __LINE__);
+            return IPX_ERR_DENIED;
+        }
+        // Templates in mapper are invalid, clear them too
+        ipx_mapper_clear(mod->curr_ctx->mapper);
         // Need to set new ID again
         rc = template_set_new_id(mod, tmplt);
         assert(rc == IPX_OK);
@@ -929,7 +932,7 @@ mgr_store_template(ipx_modifier_t *mod, struct fds_template *tmplt, ipx_msg_garb
             MODIFIER_ERROR(mod, "fds_tmgr_template_add unexpected error (%s:%d)", __FILE__, __LINE__);
             break;
         }
-        return rc;
+        return IPX_ERR_DENIED;
     }
 
     // Set definitions to new fields (preserve == true)
@@ -944,7 +947,7 @@ mgr_store_template(ipx_modifier_t *mod, struct fds_template *tmplt, ipx_msg_garb
             MODIFIER_ERROR(mod, "fds_template_ies_define unexpected error (%s:%d)", __FILE__, __LINE__);
             break;
         }
-        return rc;
+        return IPX_ERR_DENIED;
     }
 
     return IPX_OK;
@@ -964,7 +967,32 @@ mapper_add_template(ipx_modifier_t *mod, const struct fds_template *tmplt, uint1
 }
 
 /**
- * \brief Store template
+ * \brief Auxiliary structure for storing garbage from template_store function
+ * Contains both possible grabages generated by template_store function.
+ */
+struct aux_template_store_garbage {
+    fds_tgarbage_t *mapper_garbage; /**< Garbage from mapper */
+    fds_tgarbage_t *context_garbage;   /**< Garbage from manager */
+};
+
+/**
+ * \brief Auxiliary function to destroy garbage from template_store function
+ *
+ * \param[in] gb Garbage to destroy
+ */
+void
+aux_template_store_garbage_destroy(struct aux_template_store_garbage *gb)
+{
+    if (gb->mapper_garbage) {
+        fds_tmgr_garbage_destroy(gb->mapper_garbage);
+    }
+    if (gb->context_garbage) {
+        fds_tmgr_garbage_destroy(gb->context_garbage);
+    }
+}
+
+/**
+ * \brief Store template in modifier
  *
  * First, try to look for given template in template manager. If template is not
  * found, try to add it to manager. In both cases, add mapping to mapper.
@@ -981,9 +1009,23 @@ mapper_add_template(ipx_modifier_t *mod, const struct fds_template *tmplt, uint1
 static const struct fds_template *
 template_store(ipx_modifier_t *mod, struct fds_template *tmplt, uint16_t original_id, ipx_msg_garbage_t **garbage)
 {
-    // First, try to look in manager for given template
-    struct fds_template *mgr_tmplt = mgr_find_template(mod, tmplt);
     int rc;
+    fds_tgarbage_t *mapper_garbage = NULL;
+    fds_tgarbage_t *context_garbage = NULL;
+
+    // First, check if template mapper is not full
+    if (ipx_mapper_get_tmplt_count(mod->curr_ctx->mapper) >= MAPPER_MAX_TEMPLATES) {
+        // Clear mapper and get garbage from template manager
+        ipx_mapper_clear(mod->curr_ctx->mapper);
+        rc = fds_tmgr_garbage_get(mod->curr_ctx->mgr, &mapper_garbage);
+        if (rc != IPX_OK) {
+            MODIFIER_ERROR(mod, "Failed to get garbage from template manager (%s:%d)", __FILE__, __LINE__);
+            return NULL;
+        }
+    }
+
+    // Try to find template in template manager
+    struct fds_template *mgr_tmplt = mgr_find_template(mod, tmplt);
 
     if (mgr_tmplt) {
         // Template exists in manager, add mapping
@@ -992,14 +1034,30 @@ template_store(ipx_modifier_t *mod, struct fds_template *tmplt, uint16_t origina
     }
 
     // Template not found in manager, try to add it
-    rc = mgr_store_template(mod, tmplt, garbage);
-    if (rc) {
+    rc = mgr_store_template(mod, tmplt, &context_garbage);
+    if (rc != IPX_OK) {
         // Message has been generated
         return NULL;
     }
 
     // Add new mapping
     mapper_add_template(mod, tmplt, original_id);
+
+    // If any garbage was generated, create garbage message from it
+    if (mapper_garbage || context_garbage) {
+        struct aux_template_store_garbage *gb = malloc(sizeof(*gb));
+        if (gb == NULL) {
+            MODIFIER_ERROR(mod, "Memory allocation failed (%s:%d)", __FILE__, __LINE__);
+            return NULL;
+        }
+
+        gb->mapper_garbage = mapper_garbage;
+        gb->context_garbage = context_garbage;
+
+        ipx_msg_garbage_cb cb = (ipx_msg_garbage_cb) &aux_template_store_garbage_destroy;
+        *garbage = ipx_msg_garbage_create(gb, cb);
+    }
+
     return tmplt;
 }
 
@@ -1143,7 +1201,7 @@ ipx_modifier_modify(ipx_modifier_t *mod, const struct fds_drec *rec, ipx_msg_gar
     if (fields_update(new_rec, mod, buffers, filter) != IPX_OK) {
         MODIFIER_ERROR(mod, "Failed to update fields in record (%s:%d)", __FILE__, __LINE__);
         free(new_rec);
-        // Do not free template, as it is stored in modifier
+        // DO NOT free modified template, as it is stored in modifier
         return NULL;
     }
 

src/core/template_mapper.c

@@ -51,6 +51,8 @@ struct mapper_l1_table {
 
 /** \brief Template mapper                                          */
 struct template_mapper {
+    /** Number of templates in mapper                               */
+    size_t template_cnt;
     /** Mapping fields                                              */
     struct mapper_l1_table *l1_table[IPX_MAPPER_L1_RANGE];
 };
@@ -63,7 +65,6 @@ struct template_mapper {
 void
 mapper_field_destroy(struct mapper_field *field)
 {
-    fds_template_destroy((struct fds_template *)field->modified_tmplt);
     free(field);
 }
 
@@ -78,6 +79,34 @@ ipx_mapper_create()
     return map;
 }
 
+void
+ipx_mapper_clear(struct template_mapper *map)
+{
+    for (size_t i = 0; i < IPX_MAPPER_L1_RANGE; i++) {
+        if (map->l1_table[i] == NULL) {
+            continue;
+        }
+
+        for (size_t j = 0; j < IPX_MAPPER_L2_RANGE; j++) {
+            struct mapper_field *field = map->l1_table[i]->l2_table[j].fields;
+
+            while (field != NULL) {
+                struct mapper_field *next = field->next;
+                mapper_field_destroy(field);
+                field = next;
+            }
+            map->l1_table[i]->l2_table[j].fields = NULL;
+        }
+    }
+    map->template_cnt = 0;
+}
+
+size_t
+ipx_mapper_get_tmplt_count(ipx_template_mapper_t *map)
+{
+    return map->template_cnt;
+}
+
 void
 ipx_mapper_destroy(struct template_mapper *map)
 {
@@ -190,13 +219,14 @@ ipx_mapper_add(ipx_template_mapper_t *map, const struct fds_template *modified_t
     }
 
     // Store data from identifier to field
-    new_field->modified_tmplt = fds_template_copy(modified_tmplt);
+    new_field->modified_tmplt = modified_tmplt;
 
     // Store field in mapper
     if (mapper_store_field(map, original_id, new_field) != IPX_OK) {
         mapper_field_destroy(new_field);
         return IPX_ERR_NOMEM;
     }
+    map->template_cnt++;
 
     return IPX_OK;
 }

src/core/template_mapper.h

@@ -19,16 +19,33 @@ typedef struct template_mapper ipx_template_mapper_t;
  *
  * \return Pointer to allocated mapper or NULL on memory allocation error
  */
-IPX_API struct template_mapper *
+IPX_API ipx_template_mapper_t *
 ipx_mapper_create();
 
+/**
+ * \brief Clear template mapper
+ *
+ * \param[in] map Pointer to template mapper
+ */
+IPX_API void
+ipx_mapper_clear(ipx_template_mapper_t *map);
+
+/**
+ * \brief Get number of templates in template mapper
+ *
+ * \param[in] map Pointer to template mapper
+ * \return Number of templates in template mapper
+ */
+IPX_API size_t
+ipx_mapper_get_tmplt_count(ipx_template_mapper_t *map);
+
 /**
  * \brief Destroy template mapper
  *
  * \param[in] map Pointer to template mapper
  */
 IPX_API void
-ipx_mapper_destroy(struct template_mapper *map);
+ipx_mapper_destroy(ipx_template_mapper_t *map);
 
 /**
  * \brief Add new mapping to template mapper