2 * Copyright (c) 2019 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 #include <vnet/fib/fib_entry_track.h>
17 #include <vnet/fib/fib_table.h>
18 #include <vnet/fib/fib_entry_delegate.h>
19 #include <vnet/fib/fib_walk.h>
21 static fib_entry_delegate_t *
22 fib_entry_track_delegate_add (u32 fib_index,
23 const fib_prefix_t *prefix)
25 fib_entry_delegate_t *fed;
28 fei = fib_table_entry_special_add(fib_index,
33 fed = fib_entry_delegate_find_or_add(fib_entry_get(fei),
34 FIB_ENTRY_DELEGATE_TRACK);
36 fib_node_init(&fed->fd_track.fedt_node,
37 FIB_NODE_TYPE_ENTRY_TRACK);
39 fed->fd_entry_index = fei;
40 fed->fd_track.fedt_sibling =
41 fib_entry_child_add(fei,
42 FIB_NODE_TYPE_ENTRY_TRACK,
43 fib_entry_delegate_get_index(fed));
49 fib_entry_track (u32 fib_index,
50 const fib_prefix_t *prefix,
51 fib_node_type_t child_type,
55 fib_entry_delegate_t *fed;
58 fei = fib_table_lookup_exact_match(fib_index, prefix);
60 if (INDEX_INVALID == fei ||
61 NULL == (fed = fib_entry_delegate_find(fib_entry_get(fei),
62 FIB_ENTRY_DELEGATE_TRACK)))
64 fed = fib_entry_track_delegate_add(fib_index, prefix);
68 * add this child to the entry's delegate
70 *sibling = fib_node_child_add(FIB_NODE_TYPE_ENTRY_TRACK,
71 fib_entry_delegate_get_index(fed),
75 return (fed->fd_entry_index);
79 fib_entry_untrack (fib_node_index_t fei,
82 fib_entry_delegate_t *fed;
84 fed = fib_entry_delegate_find(fib_entry_get(fei),
85 FIB_ENTRY_DELEGATE_TRACK);
89 fib_node_child_remove(FIB_NODE_TYPE_ENTRY_TRACK,
90 fib_entry_delegate_get_index(fed),
92 /* if this is the last child the delegate will be removed. */
98 fib_entry_track_get_node (fib_node_index_t index)
100 fib_entry_delegate_t *fed;
102 fed = fib_entry_delegate_get(index);
103 return (&fed->fd_track.fedt_node);
106 static fib_entry_delegate_t*
107 fib_entry_delegate_from_fib_node (fib_node_t *node)
109 ASSERT(FIB_NODE_TYPE_ENTRY_TRACK == node->fn_type);
110 return ((fib_entry_delegate_t *) (((char *) node) -
111 STRUCT_OFFSET_OF (fib_entry_delegate_t,
112 fd_track.fedt_node)));
116 fib_entry_track_last_lock_gone (fib_node_t *node)
118 fib_entry_delegate_t *fed;
119 fib_node_index_t fei;
122 fed = fib_entry_delegate_from_fib_node(node);
123 fei = fed->fd_entry_index;
124 sibling = fed->fd_track.fedt_sibling;
127 * the tracker has no more children so it can be removed,
128 * and the FIB entry unsourced.
129 * remove the delegate first, then unlock the fib entry,
130 * since the delegate may be holding the last lock
132 fib_entry_delegate_remove(fib_entry_get(fei),
133 FIB_ENTRY_DELEGATE_TRACK);
134 /* having removed the deletegate the fed object is now toast */
135 fib_entry_child_remove(fei, sibling);
137 fib_table_entry_delete_index(fei, FIB_SOURCE_RR);
140 static fib_node_back_walk_rc_t
141 fib_entry_track_back_walk_notify (fib_node_t *node,
142 fib_node_back_walk_ctx_t *ctx)
144 fib_entry_delegate_t *fed;
146 fed = fib_entry_delegate_from_fib_node(node);
149 * propagate the walk to the delgate's children
152 fib_walk_sync(FIB_NODE_TYPE_ENTRY_TRACK,
153 fib_entry_delegate_get_index(fed),
156 return (FIB_NODE_BACK_WALK_CONTINUE);
160 fib_entry_track_show_memory (void)
165 * The FIB entry tracker's graph node virtual function table
167 static const fib_node_vft_t fib_entry_track_vft = {
168 .fnv_get = fib_entry_track_get_node,
169 .fnv_last_lock = fib_entry_track_last_lock_gone,
170 .fnv_back_walk = fib_entry_track_back_walk_notify,
171 .fnv_mem_show = fib_entry_track_show_memory,
175 fib_entry_track_module_init (void)
177 fib_node_register_type(FIB_NODE_TYPE_ENTRY_TRACK, &fib_entry_track_vft);