GBP: per-group EP retention policy
[vpp.git] / src / plugins / gbp / gbp_learn.h
1 /*
2  * Copyright (c) 2018 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 __GBP_LEARN_H__
17 #define __GBP_LEARN_H__
18
19 #include <plugins/gbp/gbp.h>
20
21 /**
22  * The maximum learning rate per-hashed EP
23  */
24 #define GBP_ENDPOINT_HASH_LEARN_RATE (1e-2)
25
26 typedef enum gbp_learn_mode_t_
27 {
28   GBP_LEARN_MODE_L2,
29   GBP_LEARN_MODE_L3,
30 } gbb_learn_mode_t;
31
32 /**
33  * Grouping of global data for the GBP source EPG classification feature
34  */
35 typedef struct gbp_learn_main_t_
36 {
37   /**
38    * Next nodes for L2 output features
39    */
40   u32 gl_l2_input_feat_next[32];
41
42   /**
43    * logger - VLIB log class
44    */
45   vlib_log_class_t gl_logger;
46
47   /**
48    * throttles for the DP leanring
49    */
50   throttle_t gl_l2_throttle;
51   throttle_t gl_l3_throttle;
52 } gbp_learn_main_t;
53
54 extern gbp_learn_main_t gbp_learn_main;
55
56 extern void gbp_learn_enable (u32 sw_if_index, gbb_learn_mode_t mode);
57 extern void gbp_learn_disable (u32 sw_if_index, gbb_learn_mode_t mode);
58
59 #endif
60
61 /*
62  * fd.io coding-style-patch-verification: ON
63  *
64  * Local Variables:
65  * eval: (c-set-style "gnu")
66  * End:
67  */