summaryrefslogtreecommitdiffstats
path: root/VNFs/vACL/pipeline/pipeline_acl.h
blob: 93b92c45080a812db71ecd38d9b743228a0e3d83 (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
/*
// Copyright (c) 2017 Intel Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/

#ifndef __INCLUDE_PIPELINE_ACL_H__
#define __INCLUDE_PIPELINE_ACL_H__

/**
 * @file
 * Pipeline ACL FE.
 *
 * Pipeline ACL Front End (FE).
 * Runs on the Master pipeline, responsible for CLI commands.
 *
 */

#include "pipeline.h"
#include "pipeline_acl_be.h"
#include <civetweb.h>
#include <json/json.h>

/* ACL IPV4 and IPV6 enable flags for debugging (Default both on) */
extern int acl_ipv4_enabled;
extern int acl_ipv6_enabled;

/* Number of ACL Rules, default 4 * 1024 */
extern uint32_t acl_n_rules;
/* ACL Rule Table TRIE - 2 (Active, Standby Global table per ipv4, ipv6 */
extern void *acl_rule_table_ipv4_active;
extern void *acl_rule_table_ipv4_standby;
extern void *acl_rule_table_ipv6_active;
extern void *acl_rule_table_ipv6_standby;

#define active_rule_table	0
#define standby_rule_table	1
#define acl_add_command		0
#define acl_delete_command	1
#define IPV6_32BIT_LENGTH	4

void rest_api_acl_init(struct mg_context *ctx, struct app_params *app);

/**
 * Add ACL rule to the ACL rule table.
 * Rules are added standby table.
 * Applyruleset command will activate the change.
 * Both IPv4 and IPv6 rules can be added.
 *
 * @param app
 *  A pointer to the ACL pipeline parameters.
 * @param key
 *  A pointer to the ACL rule to add.
 * @param priority
 *  Priority of the ACL rule.
 * @param port_id
 *  Port ID of the ACL rule.
 * @param action_id
 *  Action ID of the ACL rule. Defined in Action Table.
 *
 * @return
 *  0 on success, negative on error.
 */
int
app_pipeline_acl_add_rule(struct app_params *app,
			  struct pipeline_acl_key *key,
			  uint32_t priority,
			  uint32_t port_id, uint32_t action_id);

/**
 * Delete ACL rule from the ACL rule table.
 * Rules deleted from standby tables.
 * Applyruleset command will activate the change.
 * Both IPv4 and IPv6 rules can be deleted.
 *
 * @param app
 *  A pointer to the ACL pipeline parameters.
 * @param key
 *  A pointer to the ACL rule to delete.
 *
 * @return
 *  0 on success, negative on error.
 */
int
app_pipeline_acl_delete_rule(struct app_params *app,
			     struct pipeline_acl_key *key);

/**
 * Clear all ACL rules from the ACL rule table.
 * Rules cleared from standby tables.
 * Applyruleset command will activate the change.
 * Both IPv4 and IPv6 rules will be cleared.
 *
 * @param app
 *  A pointer to the ACL pipeline parameters.
 *
 * @return
 *  0 on success, negative on error.
 */
int app_pipeline_acl_clearrules(struct app_params *app);

/**
 * Add Action to the Action table.
 * Actions are added standby table.
 * Applyruleset command will activate the change.
 *
 * @param app
 *  A pointer to the ACL pipeline parameters.
 * @param key
 *  A pointer to the Action to add.
 *
 * @return
 *  0 on success, negative on error.
 */
int
app_pipeline_action_add(struct app_params *app,
			struct pipeline_action_key *key);

/**
 * Delete Action from the Action table.
 * Actions are deleted from the standby table.
 * Applyruleset command will activate the change.
 *
 * @param app
 *  A pointer to the ACL pipeline parameters.
 * @param key
 *  A pointer to the Action to delete.
 *
 * @return
 *  0 on success, negative on error.
 */
int
app_pipeline_action_delete(struct app_params *app,
			   struct pipeline_action_key *key);

extern struct pipeline_type pipeline_acl;

#endif