summaryrefslogtreecommitdiff
path: root/src/maat_plugin.c
blob: c9cdb15d4097a00841f0a1af01eee8a29ead8edb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
/*
**********************************************************************************************
*	File: maat_plugin.c
*   Description: 
*	Authors: Liu WenTan <[email protected]>
*	Date:    2022-10-31
*   Copyright: (c) Since 2022 Geedge Networks, Ltd. All rights reserved.
***********************************************************************************************
*/

#include <assert.h>
#include <errno.h>
#include <limits.h>

#include "log/log.h"
#include "maat_utils.h"
#include "maat_rule.h"
#include "maat_plugin.h"
#include "maat_limits.h"
#include "maat_table.h"
#include "alignment.h"

#define MODULE_PLUGIN	 module_name_str("maat.plugin")

#define IPV4 4
#define IPV6 6

struct plugin_callback_schema {
	maat_start_callback_t *start;
	maat_update_callback_t *update;
	maat_finish_callback_t *finish;
	void *u_para;
};

struct plugin_runtime {
    struct ex_data_runtime *ex_data_rt;
    size_t n_worker_thread;
    struct maat_garbage_bin *ref_garbage_bin;
    struct log_handle *logger;

    long long rule_num;
    long long acc_line_num;
    long long update_err_cnt;
    long long *scan_cnt;
};

enum plugin_key_type {
    PLUGIN_KEY_TYPE_INVALID = 0,
    PLUGIN_KEY_TYPE_POINTER,
    PLUGIN_KEY_TYPE_INTEGER,
    PLUGIN_KEY_TYPE_IP_ADDR
};

#define	MAX_PLUGIN_PER_TABLE 32
struct plugin_schema {
    enum plugin_key_type key_type;
    int key_len;
    int key_column;
    int addr_type_column;
    int rule_tag_column;
    int gc_timeout_s;
    int n_foreign;
    int foreign_columns[MAX_FOREIGN_CLMN_NUM];
    size_t cb_cnt;
    struct plugin_callback_schema cb[MAX_PLUGIN_PER_TABLE];
    struct ex_container_schema container_schema;
    int table_id; //ugly
    struct table_manager *ref_tbl_mgr;
    struct log_handle *logger;
};

static int read_integer_array(char *string, int *array, int size)
{
    int i = 0;
	char *token = NULL, *sub_token = NULL, *saveptr;
	
	for (i = 0, token = string; i < size; token= NULL, i++) {
		sub_token = strtok_r(token, ",", &saveptr);
		if (sub_token == NULL) {
            break;
        }
		
		sscanf(sub_token, "%d", array + i);
	}

	return i;
}

void *plugin_schema_new(cJSON *json, struct table_manager *tbl_mgr, 
                        const char *table_name, struct log_handle *logger)
{
    struct plugin_schema *schema = ALLOC(struct plugin_schema, 1);

    schema->logger = logger;

    cJSON *custom_item = NULL;
    cJSON *item = cJSON_GetObjectItem(json, "table_id");
    if (NULL == item || item->type != cJSON_Number) {
        log_fatal(logger, MODULE_PLUGIN, 
                  "[%s:%d]plugin table:<%s> schema has no table_id column", 
                  __FUNCTION__, __LINE__, table_name);
        goto error;
    }
    schema->table_id = item->valueint;

    /* custom is optional */
    item = cJSON_GetObjectItem(json, "custom");
    if (item != NULL && item->type == cJSON_Object) {
        custom_item = cJSON_GetObjectItem(item, "key");
        if (NULL == custom_item || custom_item->type != cJSON_Number) {
            log_fatal(logger, MODULE_PLUGIN,
                      "[%s:%d]plugin table:<%s> schema has no key column",
                      __FUNCTION__, __LINE__, table_name);
            goto error;
        }
        schema->key_column = custom_item->valueint;

        custom_item = cJSON_GetObjectItem(item, "key_type");
        if (NULL == custom_item || custom_item->type != cJSON_String) {
            log_fatal(logger, MODULE_PLUGIN,
                      "[%s:%d]plugin table:<%s> schema has no key_type column",
                      __FUNCTION__, __LINE__, table_name);
            goto error;
        }

        if (strcmp(custom_item->valuestring, "pointer") == 0) {
            schema->key_type = PLUGIN_KEY_TYPE_POINTER;
        } else if (strcmp(custom_item->valuestring, "integer") == 0) {
            schema->key_type = PLUGIN_KEY_TYPE_INTEGER;
            custom_item = cJSON_GetObjectItem(item, "key_len");
            if (NULL == custom_item || custom_item->type != cJSON_Number) {
                log_fatal(logger, MODULE_PLUGIN,
                          "[%s:%d]plugin table:<%s> schema integer key must"
                          " have key_len column", __FUNCTION__, __LINE__,
                          table_name);
                goto error;
            }
            schema->key_len = custom_item->valueint;
        } else if (strcmp(custom_item->valuestring, "ip_addr") == 0) {
            schema->key_type = PLUGIN_KEY_TYPE_IP_ADDR;
            custom_item = cJSON_GetObjectItem(item, "addr_type");
            if (NULL == custom_item || custom_item->type != cJSON_Number) {
                log_fatal(logger, MODULE_PLUGIN,
                          "[%s:%d]plugin table:<%s> schema ip_addr key must"
                          " have addr_type column", __FUNCTION__, __LINE__,
                          table_name);
                goto error;
            }
            schema->addr_type_column = custom_item->valueint;
        } else {
            log_fatal(logger, MODULE_PLUGIN,
                      "[%s:%d]plugin table:<%s> schema key_type:%s is illegal, "
                      "just allow {pointer}, {integer}, {ip_addr}",
                      __FUNCTION__, __LINE__, table_name, custom_item->valuestring);
            goto error;
        }

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

        custom_item = cJSON_GetObjectItem(item, "foreign");
        if (custom_item != NULL) {
            if (custom_item->type == cJSON_String) {
                schema->n_foreign = read_integer_array(custom_item->valuestring,
                                                       schema->foreign_columns,
                                                       MAX_FOREIGN_CLMN_NUM);
            } else if (custom_item->type == cJSON_Array) {
                schema->n_foreign = cJSON_GetArraySize(custom_item);
                for (int i = 0; i < schema->n_foreign; i++) {
                    cJSON *foreign_item = cJSON_GetArrayItem(custom_item, i);
                    assert(foreign_item->type == cJSON_Number);
                    schema->foreign_columns[i] = foreign_item->valueint;
                }
            }
        }

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

    schema->ref_tbl_mgr = tbl_mgr;
    return schema;
error:
    FREE(schema);
    return NULL;
}

void plugin_schema_free(void *plugin_schema)
{
    if (NULL == plugin_schema) {
        return;
    }

    FREE(plugin_schema);
}

int plugin_table_add_callback(void *plugin_schema, int table_id,
                              maat_start_callback_t *start,
						      maat_update_callback_t *update,
							  maat_finish_callback_t *finish,
							  void *u_para, struct log_handle *logger)
{
    if (NULL == plugin_schema) {
        return -1;
    }

    struct plugin_schema *schema = (struct plugin_schema *)plugin_schema;
    size_t idx = schema->cb_cnt;

	if (idx == MAX_PLUGIN_PER_TABLE) {
        log_fatal(logger, MODULE_PLUGIN, 
                  "[%s:%d] the plugin number of table_id: %d exceed maxium:%d", 
                  __FUNCTION__, __LINE__, table_id, MAX_PLUGIN_PER_TABLE);
		return -1;
	}

	schema->cb_cnt++;
	schema->cb[idx].start = start;
	schema->cb[idx].update = update;
	schema->cb[idx].finish = finish;
	schema->cb[idx].u_para = u_para;

    return 0;
}

void plugin_table_all_callback_start(struct plugin_schema *plugin_schema,
                                     int update_type)
{
    for (size_t i = 0; i < plugin_schema->cb_cnt; i++) {
        if (plugin_schema->cb[i].start != NULL) {
            plugin_schema->cb[i].start(update_type, plugin_schema->cb[i].u_para);
        }
    }
}

void plugin_table_all_callback_finish(struct plugin_schema *plugin_schema)
{
    for (size_t i = 0; i < plugin_schema->cb_cnt; i++) {
        if (plugin_schema->cb[i].finish != NULL) {
            plugin_schema->cb[i].finish(plugin_schema->cb[i].u_para);
        }
    }
}

int plugin_table_get_foreign_column(struct plugin_schema *plugin_schema, 
                                    int *foreign_columns)
{
    if (NULL == plugin_schema) {
        return -1;
    }

    int n_foreign = plugin_schema->n_foreign;
    for (int i = 0; i < n_foreign; i++) {
        foreign_columns[i] = plugin_schema->foreign_columns[i];
    }

    return n_foreign;
}

int plugin_table_set_ex_container_schema(void *plugin_schema, int table_id,
                                         maat_ex_new_func_t *new_func,
							             maat_ex_free_func_t *free_func,
							             maat_ex_dup_func_t *dup_func,
                                         void (*custom_data_free)(void *),
							             long argl, void *argp)
{
    struct plugin_schema *schema = (struct plugin_schema *)plugin_schema;
    
    if (1 == schema->container_schema.set_flag) {
        log_fatal(schema->logger, MODULE_PLUGIN, 
                  "[%s:%d] plugin table(table_id:%d) ex_container_schema"
                  " has been set, can't set again", __FUNCTION__, __LINE__,
                  table_id);
        return -1;
    }

    schema->container_schema.table_id = table_id;
    schema->container_schema.custom_data_free = custom_data_free;
    schema->container_schema.ex_schema.new_func = new_func;
    schema->container_schema.ex_schema.free_func = free_func;
    schema->container_schema.ex_schema.dup_func = dup_func;
    schema->container_schema.ex_schema.argl = argl;
    schema->container_schema.ex_schema.argp = argp;
    schema->container_schema.set_flag = 1;

    return 0;
}

struct ex_container_schema *
plugin_table_get_ex_container_schema(void *plugin_schema)
{
    struct plugin_schema *schema = (struct plugin_schema *)plugin_schema;

    return &(schema->container_schema);
}

void *plugin_runtime_new(void *plugin_schema, size_t max_thread_num,
                         struct maat_garbage_bin *garbage_bin, 
                         struct log_handle *logger)
{
    if (NULL == plugin_schema) {
        return NULL;
    }

    struct plugin_schema *schema = (struct plugin_schema *)plugin_schema;
    struct plugin_runtime *plugin_rt = ALLOC(struct plugin_runtime, 1);
    
    plugin_rt->ex_data_rt = ex_data_runtime_new(schema->table_id,
                                                schema->gc_timeout_s,
                                                logger);
    if (1 == schema->container_schema.set_flag) {
        ex_data_runtime_set_ex_container_schema(plugin_rt->ex_data_rt,
                                                &(schema->container_schema));
    }

    plugin_rt->n_worker_thread = max_thread_num;
    plugin_rt->ref_garbage_bin = garbage_bin;
    plugin_rt->logger = logger;
    plugin_rt->scan_cnt = alignment_int64_array_alloc(max_thread_num);

    return plugin_rt;
}

void plugin_runtime_free(void *plugin_runtime)
{
    if (NULL == plugin_runtime) {
        return;
    }

    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    if (plugin_rt->ex_data_rt != NULL) {
        ex_data_runtime_free(plugin_rt->ex_data_rt);
        plugin_rt->ex_data_rt = NULL;
    }

    if (plugin_rt->scan_cnt != NULL) {
        alignment_int64_array_free(plugin_rt->scan_cnt);
        plugin_rt->scan_cnt = NULL;
    }

    FREE(plugin_rt);
}

static int plugin_runtime_update_row(struct plugin_runtime *plugin_rt, 
                                     struct plugin_schema *plugin_schema, 
                                     const char *table_name, const char *row, 
                                     const char *key, size_t key_len, int is_valid)
{
    int ret = -1;
    struct ex_container_schema *container_schema = &(plugin_schema->container_schema);

    /* already set plugin_table_schema's ex_data_schema */
    if (1 == container_schema->set_flag) {
        if (is_valid == 0) {
            // delete
            ret = ex_data_runtime_del_ex_container(plugin_rt->ex_data_rt, key, key_len);
            if (ret < 0) {
                return -1;
            }
        } else {
            // add
            void *ex_data = ex_data_runtime_row2ex_data(plugin_rt->ex_data_rt, table_name, 
                                                        row, key, key_len);
            struct ex_container *ex_container = ex_container_new(ex_data, NULL);
            ret = ex_data_runtime_add_ex_container(plugin_rt->ex_data_rt, key, key_len,
                                                   ex_container);
            if (ret < 0) {
                ex_container_free(plugin_rt->ex_data_rt, ex_container);
                return -1;
            }
            plugin_rt->acc_line_num++;
        }
    }

    /* plugin table schema has callback */
    size_t cb_count = plugin_schema->cb_cnt;
    if (cb_count > 0) {
        for (size_t i = 0; i < cb_count; i++) {
            plugin_schema->cb[i].update(plugin_schema->table_id, row,
                                        plugin_schema->cb[i].u_para);
        }
    }
    
    if (0 == container_schema->set_flag) {
        ex_data_runtime_cache_row_put(plugin_rt->ex_data_rt, row);
        plugin_rt->rule_num = ex_data_runtime_cached_row_count(plugin_rt->ex_data_rt);
    }

    return 0;
}

static int plugin_accept_tag_match(struct plugin_schema *schema,
                                   const char *table_name, 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_fatal(logger, MODULE_PLUGIN,
                      "[%s:%d] table: <%s> has no rule_tag(column_seq:%d) "
                      "in table_line:%s", __FUNCTION__, __LINE__, table_name,
                      schema->rule_tag_column, line);
            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_fatal(logger, MODULE_PLUGIN,
                          "[%s:%d] table: <%s> has invalid tag format in table_line:%s",
                          __FUNCTION__, __LINE__, table_name, line);
                return TAG_MATCH_ERR;
            }

            if (TAG_MATCH_UNMATCHED == ret) {
                log_fatal(logger, MODULE_PLUGIN,
                          "[%s:%d] table: <%s> has unmatched tag in table_line:%s",
                          __FUNCTION__, __LINE__, table_name, line);
                return TAG_MATCH_UNMATCHED;
            }
        }
    }

    return TAG_MATCH_MATCHED;
}

static int plugin_table_line_get_key(struct plugin_schema *schema,
                                     const char *table_name, const char *line,
                                     char *dst_key, size_t *dst_key_len,
                                     struct log_handle *logger)
{
    size_t key_offset = 0, key_len = 0;
    
    int ret = get_column_pos(line, schema->key_column, &key_offset, &key_len);
    if (ret < 0) {
        log_fatal(logger, MODULE_PLUGIN,
                  "[%s:%d] plugin table:<%s> has no key(column seq:%d)"
                  " in table_line:%s", __FUNCTION__, __LINE__, table_name,
                  schema->key_column, line);
        return -1;
    }

    if (key_len > MAX_KEYWORDS_STR_LEN) {
        log_fatal(logger, MODULE_PLUGIN,
                  "[%s:%d] plugin table:<%s> key(column seq:%d) length exceed maxium:%d"
                  " in table_line:%s", __FUNCTION__, __LINE__, table_name,
                  schema->key_column, MAX_KEYWORDS_STR_LEN, line); 
        return -1;
    }

    const char *common_key = line + key_offset;
    if (schema->key_type == PLUGIN_KEY_TYPE_POINTER) {
        memcpy(dst_key, common_key, key_len);
        *dst_key_len = key_len;
    } else if (schema->key_type == PLUGIN_KEY_TYPE_INTEGER) {
        if (schema->key_len == sizeof(long long)) {
            long long key_ll = atoll(common_key);
            memcpy(dst_key, (char *)&key_ll, schema->key_len);
        } else {
            int key_int = atoi(common_key);
            memcpy(dst_key, (char *)&key_int, schema->key_len);
        }
        *dst_key_len = schema->key_len;
    } else if (schema->key_type == PLUGIN_KEY_TYPE_IP_ADDR) {
        if (key_len >= INET6_ADDRSTRLEN) {
            log_fatal(logger, MODULE_PLUGIN,
                      "[%s:%d] plugin table:<%s> ip_key too long(illegal) in "
                      "table_line:%s", __FUNCTION__, __LINE__, table_name, line);
            return -1;
        }

        size_t addr_type_offset = 0, addr_type_len = 0;

        ret = get_column_pos(line, schema->addr_type_column, &addr_type_offset,
                             &addr_type_len);
        if (ret < 0) {
            log_fatal(logger, MODULE_PLUGIN,
                      "[%s:%d] plugin table:<%s> has no addr_type(column seq:%d)"
                      " in table_line:%s", __FUNCTION__, __LINE__, table_name,
                      schema->addr_type_column, line);
            return -1;
        }

        char ip_key[INET6_ADDRSTRLEN] = {0};
        //snprintf() write at most (key_len+1) bytes (including the terminating null{'\0}) to ip_key.
        snprintf(ip_key, key_len + 1, "%s", common_key);

        int addr_type = atoi(line + addr_type_offset);
        if (IPV4 == addr_type) {
            uint32_t ipv4_addr;
            ret = inet_pton(AF_INET, ip_key, &ipv4_addr);
            if (ret <= 0) {
                log_fatal(logger, MODULE_PLUGIN,
                          "[%s:%d] plugin table:<%s> ipv4 key(column seq:%d)"
                          " illegal in table_line:%s", __FUNCTION__, __LINE__,
                          table_name, schema->key_column, line);
                return -1;
            }

            memcpy(dst_key, (char *)&ipv4_addr, sizeof(ipv4_addr));
            *dst_key_len = sizeof(ipv4_addr);
        } else if (IPV6 == addr_type) {
            uint8_t ipv6_addr[16];
            ret = inet_pton(AF_INET6, ip_key, ipv6_addr);
            if (ret <= 0) {
                log_fatal(logger, MODULE_PLUGIN,
                          "[%s:%d] plugin table:<%s> ipv6 key(column seq:%d)"
                          " illegal in table_line:%s", __FUNCTION__, __LINE__,
                          table_name, schema->key_column, line);
                return -1;
            }

            memcpy(dst_key, (char *)&ipv6_addr, sizeof(ipv6_addr));
            *dst_key_len = sizeof(ipv6_addr);
        } else {
            log_fatal(logger, MODULE_PLUGIN,
                      "[%s:%d] plugin table:<%s> addr_type:%d illegal, just"
                      " allow{4, 6}, table_line:%s", __FUNCTION__, __LINE__,
                      table_name, addr_type, line);
            return -1;
        }
    }

    return 0;
}

int plugin_runtime_update(void *plugin_runtime, void *plugin_schema, 
                          const char *table_name, const char *line, 
                          int valid_column)
{
    if (NULL == plugin_runtime || NULL == plugin_schema ||
        NULL == line) {
        return -1;
    }

    struct plugin_schema *schema = (struct plugin_schema *)plugin_schema;
    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    int is_valid = get_column_value(line, valid_column);
    if (is_valid < 0) {
        log_fatal(plugin_rt->logger, MODULE_PLUGIN,
                  "[%s:%d] plugin table:<%s> has no is_valid(column seq:%d)"
                  " in table_line:%s", __FUNCTION__, __LINE__, table_name,
                  valid_column, line);
        plugin_rt->update_err_cnt++;
        return -1;
    }

    int ret = plugin_accept_tag_match(schema, table_name, line, plugin_rt->logger);
    if (ret == TAG_MATCH_UNMATCHED) {
        plugin_rt->update_err_cnt++;
        return -1;
    }

    char key[MAX_KEYWORDS_STR_LEN + 1] = {0};
    size_t key_len = 0;
    ret = plugin_table_line_get_key(schema, table_name, line, key, &key_len,
                                    plugin_rt->logger);
    if (ret < 0) {
        plugin_rt->update_err_cnt++;
        return -1;
    }

    ret = plugin_runtime_update_row(plugin_rt, schema, table_name, line, 
                                    key, key_len, is_valid);
    if (ret < 0) {
        plugin_rt->update_err_cnt++;
        return -1;
    }

    log_debug(plugin_rt->logger, MODULE_PLUGIN,
              "plugin table:<%s> update one line, key:%s, key_len:%zu, is_valid:%d",
              table_name, key, key_len, is_valid);

    return 0;
}

int plugin_runtime_commit(void *plugin_runtime, const char *table_name,
                          long long maat_rt_version)
{
    if (NULL == plugin_runtime) {
        return -1;
    }

    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    struct ex_data_runtime *ex_data_rt = plugin_rt->ex_data_rt;
    if (NULL == ex_data_rt) {
        return -1;
    }

    int updating_flag = ex_data_runtime_is_updating(ex_data_rt);
    if (0 == updating_flag) {
        return 0;
    }

    ex_data_runtime_commit(ex_data_rt);
    
    plugin_rt->rule_num = ex_data_runtime_ex_container_count(ex_data_rt);
    
    log_info(plugin_rt->logger, MODULE_PLUGIN,
             "table[%s] commit %zu plugin rules, version:%lld", 
             table_name, plugin_rt->rule_num, maat_rt_version);

    return 0;
}

long long plugin_runtime_rule_count(void *plugin_runtime)
{
    if (NULL == plugin_runtime) {
        return 0;
    }
    
    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    return plugin_rt->rule_num;
}

long long plugin_runtime_update_err_count(void *plugin_runtime)
{
    if (NULL == plugin_runtime) {
        return 0;
    }
    
    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    return plugin_rt->update_err_cnt;
}

struct ex_data_runtime *plugin_runtime_get_ex_data_rt(void *plugin_runtime)
{
    if (NULL == plugin_runtime) {
        return NULL;
    }

    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    return plugin_rt->ex_data_rt;
}

size_t plugin_runtime_cached_row_count(void *plugin_runtime)
{
    if (NULL == plugin_runtime) {
        return 0;
    }

    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    if (NULL == plugin_rt->ex_data_rt) {
        return 0;
    }

    return ex_data_runtime_cached_row_count(plugin_rt->ex_data_rt);
}

const char *plugin_runtime_cached_row_get(void *plugin_runtime, size_t index)
{
    if (NULL == plugin_runtime) {
        return NULL;
    }

    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    if (NULL == plugin_rt->ex_data_rt) {
        return NULL;
    }

    return ex_data_runtime_cached_row_get(plugin_rt->ex_data_rt, index);
}

void *plugin_runtime_get_ex_data(void *plugin_runtime, void *plugin_schema,
                                 const char *key, size_t key_len)
{
    if (NULL == plugin_runtime || NULL == plugin_schema) {
        return NULL;
    }

    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    struct plugin_schema *schema = (struct plugin_schema *)plugin_schema;
    if (schema->key_type == PLUGIN_KEY_TYPE_INTEGER &&
        schema->key_len != key_len) {
        return NULL;
    }
    
    return ex_data_runtime_get_ex_data_by_key(plugin_rt->ex_data_rt, key, key_len);    
}

void plugin_runtime_scan_inc(void *plugin_runtime, int thread_id)
{
    if (NULL == plugin_runtime || thread_id < 0) {
        return;
    }

    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    alignment_int64_array_add(plugin_rt->scan_cnt, thread_id, 1);
}

long long plugin_runtime_scan_count(void *plugin_runtime)
{
    if (NULL == plugin_runtime) {
        return 0;
    }

    struct plugin_runtime *plugin_rt = (struct plugin_runtime *)plugin_runtime;
    long long sum = alignment_int64_array_sum(plugin_rt->scan_cnt,
                                              plugin_rt->n_worker_thread);
    alignment_int64_array_reset(plugin_rt->scan_cnt, plugin_rt->n_worker_thread);

    return sum;
}