tango-maat/src/maat_ip_plugin.cpp

/*
**********************************************************************************************
*	File: maat_ip_plugin.cpp
*   Description: 
*	Authors: Liu wentan <liuwentan@geedgenetworks.com>
*	Date:    2022-10-31
*   Copyright: (c) 2018-2022 Geedge Networks, Inc. All rights reserved.
***********************************************************************************************
*/

#include <assert.h>

#include "maat_utils.h"
#include "maat_ip_plugin.h"
#include "maat_ex_data.h"
#include "IPMatcher.h"
#include "maat_rule.h"
#include "maat_garbage_collection.h"

#define MODULE_IP_PLUGIN	 module_name_str("maat.ip_plugin")
#define MAX_IP_STR    128

struct ip_plugin_item {
    int item_id;
	int ip_type;
	char start_ip[MAX_IP_STR];
	char end_ip[MAX_IP_STR];
	int rule_tag;
};

struct ip_plugin_schema {
    int item_id_column;
	int ip_type_column;
	int start_ip_column;
	int end_ip_column;
	int rule_tag_column;
	struct ex_data_schema *ex_schema;
    int table_id; //ugly
    struct table_manager *ref_tbl_mgr;

    unsigned long long update_err_cnt;
    unsigned long long unmatch_tag_cnt;
};

struct ip_plugin_runtime {
	struct ip_matcher *ip_matcher;
    struct ex_data_runtime *ex_data_rt;

    uint32_t rule_num;
    uint32_t updating_rule_num;

    struct maat_garbage_bin *ref_garbage_bin;
    struct log_handle *logger;
};

void *ip_plugin_schema_new(cJSON *json, struct table_manager *tbl_mgr, 
                           const char *table_name, struct log_handle *logger)
{
    size_t read_cnt = 0;
    struct ip_plugin_schema *schema = ALLOC(struct ip_plugin_schema, 1);

    cJSON *custom_item = NULL;
    cJSON *item = cJSON_GetObjectItem(json, "table_id");
   if (item != NULL && item->type == cJSON_Number) {
        schema->table_id = item->valueint;
        read_cnt++;
    }

    item = cJSON_GetObjectItem(json, "custom");
    if (NULL == item || item->type != cJSON_Object) {
        log_error(logger, MODULE_IP_PLUGIN, 
                  "table %s has no custom column", table_name);
        goto error;
    }

    custom_item = cJSON_GetObjectItem(item, "item_id");
    if (custom_item != NULL && custom_item->type == cJSON_Number) {
        schema->item_id_column = custom_item->valueint;
        read_cnt++;
    }

    custom_item = cJSON_GetObjectItem(item, "ip_type");
    if (custom_item != NULL && custom_item->type == cJSON_Number) {
        schema->ip_type_column = custom_item->valueint;
        read_cnt++;
    }

    custom_item = cJSON_GetObjectItem(item, "start_ip");
    if (custom_item != NULL && custom_item->type == cJSON_Number) {
        schema->start_ip_column = custom_item->valueint;
        read_cnt++;
    }

    custom_item = cJSON_GetObjectItem(item, "end_ip");
    if (custom_item != NULL && custom_item->type == cJSON_Number) {
        schema->end_ip_column = custom_item->valueint;
        read_cnt++;
    }

    // rule_tag is optional
    custom_item = cJSON_GetObjectItem(item, "rule_tag");
    if (custom_item != NULL && custom_item->type == cJSON_Number) {
        schema->rule_tag_column = custom_item->valueint;
    }

    schema->ref_tbl_mgr = tbl_mgr;

    if (read_cnt < 5) {
        goto error;
    }
    
    return schema;
error:
    FREE(schema);
    return NULL;
}

void ip_plugin_schema_free(void *ip_plugin_schema)
{
    if (NULL == ip_plugin_schema) {
        return;
    }
    struct ip_plugin_schema *schema = (struct ip_plugin_schema *)ip_plugin_schema;
    if (schema->ex_schema != NULL) {
        ex_data_schema_free(schema->ex_schema);
        schema->ex_schema = NULL;
    }

    FREE(schema);
}

struct ex_data_schema *ip_plugin_table_get_ex_data_schema(void *ip_plugin_schema)
{
    if (NULL == ip_plugin_schema) {
        return NULL;
    }

    struct ip_plugin_schema *schema = (struct ip_plugin_schema *)ip_plugin_schema;

    return schema->ex_schema;
}

int ip_plugin_accept_tag_match(struct ip_plugin_schema *schema, const char *line,
                               struct log_handle *logger)
{
    size_t column_offset = 0;
    size_t column_len = 0;
    size_t n_tag = table_manager_accept_tags_count(schema->ref_tbl_mgr);

    if (schema->rule_tag_column > 0 && n_tag > 0) {
        int ret = get_column_pos(line, schema->rule_tag_column, 
                                 &column_offset, &column_len);
        if (ret < 0) {
            log_error(logger, MODULE_IP_PLUGIN,
                      "ip_plugin table(table_id:%d) has no rule_tag, line:%s",
                      schema->table_id, line);
            schema->update_err_cnt++;
            return TAG_MATCH_ERR;
        }

        if (column_len > 2) {
            char *tag_str = ALLOC(char, column_len + 1);
            memcpy(tag_str, (line + column_offset), column_len);
            ret = table_manager_accept_tags_match(schema->ref_tbl_mgr, tag_str);
            FREE(tag_str);
            if (TAG_MATCH_ERR == ret) {
                log_error(logger, MODULE_IP_PLUGIN,
                          "ip_plugin table(table_id:%d) has invalid tag format, line:%s",
                          schema->table_id, line);
                schema->update_err_cnt++;
                return TAG_MATCH_ERR;
            }

            if (TAG_MATCH_UNMATCHED == ret) {
                schema->unmatch_tag_cnt++;
                return TAG_MATCH_UNMATCHED;
            }
        }
    }

    return TAG_MATCH_MATCHED;
}

struct ip_plugin_item *
ip_plugin_item_new(const char *line, struct ip_plugin_schema *schema,
                   struct log_handle *logger)
{
    int ret = ip_plugin_accept_tag_match(schema, line, logger);
    if (ret == TAG_MATCH_UNMATCHED) {
        return NULL;
    }

    size_t column_offset = 0;
    size_t column_len = 0;
    struct ip_plugin_item *ip_plugin_item = ALLOC(struct ip_plugin_item, 1);
    ret = get_column_pos(line, schema->item_id_column, &column_offset, &column_len);
    if (ret < 0) {
        log_error(logger, MODULE_IP_PLUGIN, 
                  "ip plugin table(table_id:%d) line:%s has no item_id",
                  schema->table_id, line);
        goto error;
    }
    ip_plugin_item->item_id = atoi(line + column_offset);

    ret = get_column_pos(line, schema->ip_type_column, &column_offset, &column_len);
    if (ret < 0) {
        log_error(logger, MODULE_IP_PLUGIN, 
                  "ip plugin table(table_id:%d) line:%s has no ip_type",
                  schema->table_id, line);
        goto error;
    }
    ip_plugin_item->ip_type = atoi(line + column_offset);
    if (ip_plugin_item->ip_type != 4 && ip_plugin_item->ip_type != 6) {
        log_error(logger, MODULE_IP_PLUGIN, 
                  "ip_plugin table(table_id:%d) line:%s ip_type[%d] invalid",
                  schema->table_id, line, ip_plugin_item->ip_type);
        goto error;
    }

    ret = get_column_pos(line, schema->start_ip_column, &column_offset, &column_len);
    if (ret < 0) {
        log_error(logger, MODULE_IP_PLUGIN, 
                  "ip_plugin table(table_id:%d) line:%s has no start_ip",
                  schema->table_id, line);
        goto error;
    }
    strncpy(ip_plugin_item->start_ip, line + column_offset, 
            MIN(column_len, sizeof(ip_plugin_item->start_ip)));
    
    ret = get_column_pos(line, schema->end_ip_column, &column_offset, &column_len);
    if (ret < 0) {
        log_error(logger, MODULE_IP_PLUGIN, 
                  "ip_plugin table(table_id:%d) line:%s has no end_ip",
                  schema->table_id, line);
        goto error;
    }
    strncpy(ip_plugin_item->end_ip, line + column_offset, 
            MIN(column_len, sizeof(ip_plugin_item->end_ip)));

    return ip_plugin_item;
error:
    FREE(ip_plugin_item);
    return NULL;
}

void ip_plugin_item_free(struct ip_plugin_item *item)
{
    FREE(item);
}

int ip_plugin_table_ex_data_schema_flag(struct ip_plugin_schema *ip_plugin_schema)
{
    return 0;
}

int ip_plugin_table_set_ex_data_schema(void *ip_plugin_schema, 
                                       maat_plugin_ex_new_func_t *new_func,
							           maat_plugin_ex_free_func_t *free_func,
							           maat_plugin_ex_dup_func_t *dup_func,
							           long argl, void *argp,
                                       struct log_handle *logger)
{
    if (NULL == ip_plugin_schema) {
        return -1;
    }

    struct ip_plugin_schema *schema = (struct ip_plugin_schema *)ip_plugin_schema;
    if (schema->ex_schema != NULL) {
        assert(0);
        log_error(logger, MODULE_IP_PLUGIN,
                  "Error: %s, EX data schema already registed", __FUNCTION__);
        return -1;
    }

    schema->ex_schema = ex_data_schema_new(new_func, free_func, dup_func, argl, argp);

    return 0;
}

int ip_plugin_runtime_update_row(struct ip_plugin_runtime *rt, struct ip_plugin_schema *schema,
                                  const char *row, char *key, size_t key_len, 
                                  struct ip_plugin_item *ip_plugin_item, int is_valid)
{
    int ret = -1;
    struct ex_data_runtime *ex_data_rt = rt->ex_data_rt;
    int set_flag = ip_plugin_table_ex_data_schema_flag(schema);

    if (1 == set_flag) {
        if (0 == is_valid) {
            //delete
            ret = ex_data_runtime_del_ex_container(ex_data_rt, key, key_len);
            if (ret < 0) {
                return -1;
            }
        } else {
            //add
            void *ex_data = ex_data_runtime_row2ex_data(ex_data_rt, row, key, key_len);
            struct ex_data_container *ex_container = ex_data_container_new(ex_data, (void *)ip_plugin_item);
            ret = ex_data_runtime_add_ex_container(ex_data_rt, key, key_len, ex_container);
            if (ret < 0) {
                return -1;
            }
        }
    } else {
        ex_data_runtime_cache_row_put(ex_data_rt, row);
    }

    return 0;
}

void *ip_plugin_runtime_new(void *ip_plugin_schema, int max_thread_num,
                            struct maat_garbage_bin *garbage_bin,
                            struct log_handle *logger)
{
    if (NULL == ip_plugin_schema) {
        return NULL;
    }

    struct ip_plugin_schema *schema = (struct ip_plugin_schema *)ip_plugin_schema;
    struct ip_plugin_runtime *ip_plugin_rt = ALLOC(struct ip_plugin_runtime, 1);

    ip_plugin_rt->ex_data_rt = ex_data_runtime_new(schema->table_id, 
                                                   ex_data_container_free, logger);
    ip_plugin_rt->ref_garbage_bin = garbage_bin;
    ip_plugin_rt->logger = logger;

    return ip_plugin_rt;
}

void ip_plugin_runtime_free(void *ip_plugin_runtime)
{
    if (NULL == ip_plugin_runtime) {
        return;
    }

    struct ip_plugin_runtime *ip_plugin_rt = (struct ip_plugin_runtime *)ip_plugin_runtime;
    if (ip_plugin_rt->ip_matcher != NULL) {
        ip_matcher_free(ip_plugin_rt->ip_matcher);
        ip_plugin_rt->ip_matcher = NULL;
    }

    if (ip_plugin_rt->ex_data_rt != NULL) {
        ex_data_runtime_free(ip_plugin_rt->ex_data_rt);
        ip_plugin_rt->ex_data_rt = NULL;
    }

    FREE(ip_plugin_rt);
}

void ip_plugin_item_to_ip_rule(struct ip_plugin_item *item, struct ip_rule *rule)
{
    if (4 == item->ip_type) {
        rule->type = IPv4;
        ip_format2range(item->ip_type, IP_FORMAT_RANGE, item->start_ip, item->end_ip,
                        &(rule->ipv4_rule.start_ip), &(rule->ipv4_rule.end_ip));
    } else {
        rule->type = IPv6;
        ip_format2range(item->ip_type, IP_FORMAT_RANGE, item->start_ip, item->end_ip,
                        rule->ipv6_rule.start_ip, rule->ipv6_rule.end_ip);
    }
    
    rule->rule_id = item->item_id;
    rule->user_tag = NULL;
}

int ip_plugin_runtime_update(void *ip_plugin_runtime, void *ip_plugin_schema, 
                             const char *line, int valid_column)
{
    if (NULL == ip_plugin_runtime || NULL == ip_plugin_schema || 
        NULL == line) {
        return -1;
    }

    struct ip_plugin_item *ip_plugin_item = NULL;
    struct ip_plugin_schema *schema = (struct ip_plugin_schema *)ip_plugin_schema;
    struct ip_plugin_runtime *ip_plugin_rt = (struct ip_plugin_runtime *)ip_plugin_runtime;
    int item_id = get_column_value(line, schema->item_id_column);
    int is_valid = get_column_value(line, valid_column);
    if (is_valid < 0) {
        return -1;
    }

    if (schema->ex_schema != NULL) {
        if (1 == is_valid) {
            // add
            ip_plugin_item = ip_plugin_item_new(line, schema, ip_plugin_rt->logger);
            if (NULL == ip_plugin_item) {
                return -1;
            }
        }

        char *key = (char *)&item_id;
        int ret = ip_plugin_runtime_update_row(ip_plugin_rt, schema, line, key,
                                               sizeof(int), ip_plugin_item, is_valid);
        if (ret < 0) {
            if (ip_plugin_item != NULL) {
                FREE(ip_plugin_item);
            }
            return -1;
        } else {
            if (0 == is_valid) {
                ip_plugin_rt->rule_num--;
            } else {
                ip_plugin_rt->rule_num++;
            }
        }
    } else {
        //ex_schema not set
        ex_data_runtime_cache_row_put(ip_plugin_rt->ex_data_rt, line);
        ip_plugin_rt->rule_num = ex_data_runtime_cached_row_count(ip_plugin_rt->ex_data_rt);
    }

    return 0;
}

int ip_plugin_runtime_commit(void *ip_plugin_runtime, const char *table_name)
{
    if (NULL == ip_plugin_runtime) {
        return -1;
    }

    int ret = 0;
    struct ex_data_container **ex_container = NULL;
    struct ip_plugin_runtime *ip_plugin_rt = (struct ip_plugin_runtime *)ip_plugin_runtime;
    struct ex_data_runtime *ex_data_rt = ip_plugin_rt->ex_data_rt;

    size_t rule_cnt = ex_data_runtime_list_updating_ex_container(ex_data_rt, &ex_container);
    if (0 == rule_cnt) {
        FREE(ex_container);
        return 0;
    }
    
    struct ip_rule *rules = ALLOC(struct ip_rule, rule_cnt);

    for (size_t i = 0; i < rule_cnt; i++) {
        struct ip_plugin_item *item = (struct ip_plugin_item *)ex_container[i]->custom_data;
        ip_plugin_item_to_ip_rule(item, &rules[i]);
    }

    struct ip_matcher *new_ip_matcher = NULL;
    struct ip_matcher *old_ip_matcher = NULL;
    size_t mem_used = 0;

    if (rule_cnt > 0) {
         log_info(ip_plugin_rt->logger, MODULE_IP_PLUGIN, 
                 "table[%s] committing %zu ip_plugin rules for rebuilding ip_matcher engine", 
                 table_name, rule_cnt);
        new_ip_matcher = ip_matcher_new(rules, rule_cnt, &mem_used);
        if (NULL == new_ip_matcher) {
            log_error(ip_plugin_rt->logger, MODULE_IP_PLUGIN, 
                      "table[%s] rebuild ip_matcher engine failed when update %zu ip_plugin rules", 
                      table_name, rule_cnt);
            ret = -1;
        }
    }

    old_ip_matcher = ip_plugin_rt->ip_matcher;
    ip_plugin_rt->ip_matcher = new_ip_matcher;
    maat_garbage_bagging(ip_plugin_rt->ref_garbage_bin, old_ip_matcher, 
                        (void (*)(void*))ip_matcher_free);
    ex_data_runtime_commit(ex_data_rt);

    FREE(rules);
    FREE(ex_container);

    return ret;
}

struct ex_data_runtime *ip_plugin_runtime_get_ex_data_rt(void *ip_plugin_runtime)
{
    if (NULL == ip_plugin_runtime) {
        return NULL;
    }

    struct ip_plugin_runtime *ip_plugin_rt = (struct ip_plugin_runtime *)ip_plugin_runtime;

    return ip_plugin_rt->ex_data_rt;
}