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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
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.
23 #ifndef __ADJ_DELEGATE_T__
24 #define __ADJ_DELEGATE_T__
26 #include <vnet/adj/adj.h>
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.
34 typedef enum adj_delegate_type_t_ {
40 * Stacking of a midchain's nexthop
42 ADJ_DELEGATE_MIDCHAIN,
43 } adj_delegate_type_t;
45 #define ADJ_DELEGATE_LAST (ADJ_DELEGATE_MIDCHAIN)
48 * Adj delegate. This object is attached to the adjacency.
50 typedef struct adj_delegate_t_
53 * The ADJ entry object to which the delagate is attached
55 adj_index_t ad_adj_index;
60 adj_delegate_type_t ad_type;
63 * The index passed by the provider to identify its delegate instance.
64 * As with all things VPP this is a pool index.
70 * Indication that the adjacency has been deleted. The delegate provider should free
73 typedef void (*adj_delegate_adj_deleted_t)(adj_delegate_t *aed);
76 * Format function for the delegate
78 typedef u8 * (*adj_delegate_format_t)(const adj_delegate_t *aed, u8 *s);
81 * An ADJ delegate virtual function table
83 typedef struct adj_delegate_vft_t_ {
84 adj_delegate_format_t adv_format;
85 adj_delegate_adj_deleted_t adv_adj_deleted;
89 * @brief Remove a delegate from an adjacency
91 * @param ai The adjacency to remove the delegate from
92 * @param type The type of delegate being removed
94 extern void adj_delegate_remove(adj_index_t ai,
95 adj_delegate_type_t type);
98 * @brief Add a delegate to an adjacency
100 * @param ai The adjacency to add the delegate to
101 * @param type The type of delegate being added
102 * @param adi The provider's [pool] index of its attached objet
104 extern int adj_delegate_add(ip_adjacency_t *adj,
105 adj_delegate_type_t fdt,
109 * @brief Get a delegate from an adjacency
111 * @param ai The adjacency to get the delegate from
112 * @param type The type of delegate being sought
114 extern adj_delegate_t *adj_delegate_get(const ip_adjacency_t *adj,
115 adj_delegate_type_t type);
118 * @brief Register a VFT for one of the built-in types
120 extern void adj_delegate_register_type(adj_delegate_type_t type,
121 const adj_delegate_vft_t *vft);
124 * @brief create a new delegate type and register a new VFT
126 extern adj_delegate_type_t adj_delegate_register_new_type(
127 const adj_delegate_vft_t *vft);