vppinfra: increase max bihash arena size to 512GB
[vpp.git] / src / vnet / adj / adj_delegate.h
1 /*
2  * Copyright (c) 2016 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  * A Delagate is a means to implement the Delagation design pattern;
17  * the extension of an object's functionality through the composition of,
18  * and delgation to, other objects.
19  * These 'other' objects are delegates. Delagates are thus attached to
20  * ADJ objects to extend their functionality.
21  */
22
23 #ifndef __ADJ_DELEGATE_T__
24 #define __ADJ_DELEGATE_T__
25
26 #include <vnet/adj/adj.h>
27
28 /**
29  * Built-in delegate types.
30  * When adding new types, if your code is within the vnet subsystem, then add a
31  * new  type here. If not then use the adj_delegate_register_new_type API to
32  * register a new type.
33  */
34 typedef enum adj_delegate_type_t_ {
35     /**
36      * BFD session state
37      */
38     ADJ_DELEGATE_BFD,
39 } adj_delegate_type_t;
40
41 /**
42  * Adj delegate. This object is attached to the adjacency.
43  */
44 typedef struct adj_delegate_t_
45 {
46     /**
47      * The ADJ entry object to which the delagate is attached
48      */
49     adj_index_t ad_adj_index;
50
51     /**
52      * The delagate type
53      */
54     adj_delegate_type_t ad_type;
55
56     /**
57      * The index passed by the provider to identify its delegate instance.
58      * As with all things VPP this is a pool index.
59      */
60     index_t ad_index;
61 } adj_delegate_t;
62
63 /**
64  * Indication that the adjacency has been deleted. The delegate provider should free
65  * the delegate.
66  */
67 typedef void (*adj_delegate_adj_deleted_t)(adj_delegate_t *aed);
68
69 /**
70  * Format function for the delegate
71  */
72 typedef u8 * (*adj_delegate_format_t)(const adj_delegate_t *aed, u8 *s);
73
74 /**
75  * An ADJ delegate virtual function table
76  */
77 typedef struct adj_delegate_vft_t_ {
78     adj_delegate_format_t adv_format;
79     adj_delegate_adj_deleted_t adv_adj_deleted;
80 } adj_delegate_vft_t;
81
82 /**
83  * @brief Remove a delegate from an adjacency
84  *
85  * @param ai The adjacency to remove the delegate from
86  * @param type The type of delegate being removed
87  */
88 extern void adj_delegate_remove(adj_index_t ai,
89                                 adj_delegate_type_t type);
90
91 /**
92  * @brief Add a delegate to an adjacency
93  *
94  * @param ai The adjacency to add the delegate to
95  * @param type The type of delegate being added
96  * @param adi The provider's [pool] index of its attached objet
97  */
98 extern int adj_delegate_add(ip_adjacency_t *adj,
99                             adj_delegate_type_t fdt,
100                             index_t adi);
101
102 /**
103  * @brief Get a delegate from an adjacency
104  *
105  * @param ai The adjacency to get the delegate from
106  * @param type The type of delegate being sought
107  */
108 extern adj_delegate_t *adj_delegate_get(const ip_adjacency_t *adj,
109                                         adj_delegate_type_t type);
110
111 /**
112  * @brief Register a VFT for one of the built-in types
113  */
114 extern void adj_delegate_register_type(adj_delegate_type_t type,
115                                        const adj_delegate_vft_t *vft);
116
117 /**
118  * @brief create a new delegate type and register a new VFT
119  */
120 extern adj_delegate_type_t adj_delegate_register_new_type(
121     const adj_delegate_vft_t *vft);
122
123 #endif