session: add rule tags
[vpp.git] / src / vnet / session / session_rules_table.h
1 /*
2  * Copyright (c) 2017 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #ifndef SRC_VNET_SESSION_SESSION_RULES_TABLE_H_
17 #define SRC_VNET_SESSION_SESSION_RULES_TABLE_H_
18
19 #include <vnet/vnet.h>
20 #include <vnet/fib/fib.h>
21 #include <vnet/session/transport.h>
22 #include <vnet/session/mma_16.h>
23 #include <vnet/session/mma_40.h>
24
25 /* *INDENT-OFF* */
26 typedef CLIB_PACKED (struct
27 {
28   union
29     {
30       struct
31         {
32           ip4_address_t rmt_ip;
33           ip4_address_t lcl_ip;
34           u16 rmt_port;
35           u16 lcl_port;
36         };
37       u64 as_u64[2];
38     };
39 }) session_mask_or_match_4_t;
40
41 typedef CLIB_PACKED (struct
42 {
43   union
44     {
45       struct
46         {
47           ip6_address_t rmt_ip;
48           ip6_address_t lcl_ip;
49           u16 rmt_port;
50           u16 lcl_port;
51         };
52       u64 as_u64[5];
53     };
54 }) session_mask_or_match_6_t;
55 /* *INDENT-ON* */
56
57 #define SESSION_RULE_TAG_MAX_LEN 64
58 #define SESSION_RULES_TABLE_ACTION_DROP (((u32)~0) - 1)
59 #define SESSION_RULES_TABLE_INVALID_INDEX MMA_TABLE_INVALID_INDEX
60
61 typedef struct _session_rules_table_add_del_args
62 {
63   fib_prefix_t lcl;
64   fib_prefix_t rmt;
65   u16 lcl_port;
66   u16 rmt_port;
67   u32 action_index;
68   u8 *tag;
69   u8 is_add;
70 } session_rule_table_add_del_args_t;
71
72 typedef struct _rule_tag
73 {
74   u8 *tag;
75 } session_rule_tag_t;
76
77 typedef struct _session_rules_table_t
78 {
79   /**
80    * Per fib proto session rules tables
81    */
82   mma_rules_table_16_t session_rules_tables_16;
83   mma_rules_table_40_t session_rules_tables_40;
84   /**
85    * Hash table that maps tags to rules
86    */
87   uword *rules_by_tag;
88   /**
89    * Pool of rules tags
90    */
91   session_rule_tag_t *rule_tags;
92   /**
93    * Hash table that maps rule indices to tags
94    */
95   uword *tags_by_rules;
96 } session_rules_table_t;
97
98 u32 session_rules_table_lookup4 (session_rules_table_t * srt,
99                                  ip4_address_t * lcl_ip,
100                                  ip4_address_t * rmt_ip, u16 lcl_port,
101                                  u16 rmt_port);
102 u32 session_rules_table_lookup6 (session_rules_table_t * srt,
103                                  ip6_address_t * lcl_ip,
104                                  ip6_address_t * rmt_ip, u16 lcl_port,
105                                  u16 rmt_port);
106 void session_rules_table_cli_dump (vlib_main_t * vm,
107                                    session_rules_table_t * srt, u8 fib_proto);
108 void session_rules_table_show_rule (vlib_main_t * vm,
109                                     session_rules_table_t * srt,
110                                     ip46_address_t * lcl_ip, u16 lcl_port,
111                                     ip46_address_t * rmt_ip, u16 rmt_port,
112                                     u8 is_ip4);
113 clib_error_t *session_rules_table_add_del (session_rules_table_t * srt,
114                                            session_rule_table_add_del_args_t *
115                                            args);
116 u8 *session_rules_table_rule_tag (session_rules_table_t * srt, u32 ri,
117                                   u8 is_ip4);
118 void session_rules_table_init (session_rules_table_t * srt);
119 #endif /* SRC_VNET_SESSION_SESSION_RULES_TABLE_H_ */
120 /*
121  * fd.io coding-style-patch-verification: ON
122  *
123  * Local Variables:
124  * eval: (c-set-style "gnu")
125  * End:
126  */