2 * ip_neighboor_watch.c; IP neighbor watching
4 * Copyright (c) 2019 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vnet/ip-neighbor/ip_neighbor.h>
19 #include <vnet/ip-neighbor/ip_neighbor_watch.h>
20 #include <vnet/ip/ip_types_api.h>
21 #include <vnet/ethernet/ethernet_types_api.h>
23 #include <vnet/ip-neighbor/ip_neighbor.api_enum.h>
24 #include <vnet/ip-neighbor/ip_neighbor.api_types.h>
26 #include <vlibmemory/api.h>
29 * Database of registered watchers
30 * The key for a watcher is {type, sw_if_index, addreess}
31 * interface=~0 / address=all-zeros imples any.
33 typedef struct ip_neighbor_watch_db_t_
36 } ip_neighbor_watch_db_t;
38 static ip_neighbor_watch_db_t ipnw_db;
41 ip_neighbor_event_process (vlib_main_t * vm,
42 vlib_node_runtime_t * rt, vlib_frame_t * f)
44 ip_neighbor_event_t *ipne, *ipnes = NULL;
45 uword event_type = ~0;
49 vlib_process_wait_for_event (vm);
51 ipnes = vlib_process_get_event_data (vm, &event_type);
56 vec_foreach (ipne, ipnes) ip_neighbor_handle_event (ipne);
64 vec_reset_length (ipnes);
69 VLIB_REGISTER_NODE (ip_neighbor_event_process_node) = {
70 .function = ip_neighbor_event_process,
71 .type = VLIB_NODE_TYPE_PROCESS,
72 .name = "ip-neighbor-event",
77 want_ip_neighbor_events_reaper (u32 client_index)
79 ip_neighbor_key_t *key, *empty_keys = NULL;
80 ip_neighbor_watcher_t *watchers;
84 /* walk the entire IP neighbour DB and removes the client's registrations */
85 mhash_foreach(key, v, &ipnw_db.ipnwdb_hash,
87 watchers = (ip_neighbor_watcher_t*) *v;
89 vec_foreach_index_backwards (pos, watchers) {
90 if (watchers[pos].ipw_client == client_index)
91 vec_del1(watchers, pos);
94 if (vec_len(watchers) == 0)
95 vec_add1 (empty_keys, *key);
98 vec_foreach (key, empty_keys)
99 mhash_unset (&ipnw_db.ipnwdb_hash, key, NULL);
100 vec_free (empty_keys);
104 VL_MSG_API_REAPER_FUNCTION (want_ip_neighbor_events_reaper);
107 ip_neighbor_watch_cmp (const ip_neighbor_watcher_t * w1,
108 const ip_neighbor_watcher_t * w2)
110 return (0 == clib_memcmp (w1, w2, sizeof(*w1)));
114 ip_neighbor_watch (const ip_address_t * ip,
116 const ip_neighbor_watcher_t * watch)
118 ip_neighbor_key_t key = {
120 .ipnk_sw_if_index = (sw_if_index == 0 ? ~0 : sw_if_index),
122 ip_neighbor_watcher_t *ipws = NULL;
125 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
129 ipws = (ip_neighbor_watcher_t*) p[0];
131 if (~0 != vec_search_with_function (ipws, watch,
132 ip_neighbor_watch_cmp))
137 vec_add1 (ipws, *watch);
139 mhash_set (&ipnw_db.ipnwdb_hash, &key, (uword) ipws, NULL);
143 ip_neighbor_unwatch (const ip_address_t * ip,
145 const ip_neighbor_watcher_t * watch)
147 ip_neighbor_key_t key = {
149 .ipnk_sw_if_index = (sw_if_index == 0 ? ~0 : sw_if_index),
151 ip_neighbor_watcher_t *ipws = NULL;
155 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
160 ipws = (ip_neighbor_watcher_t*) p[0];
162 pos = vec_search_with_function (ipws, watch, ip_neighbor_watch_cmp);
167 vec_del1 (ipws, pos);
169 if (vec_len(ipws) == 0)
170 mhash_unset (&ipnw_db.ipnwdb_hash, &key, NULL);
174 ip_neighbor_signal (ip_neighbor_watcher_t *watchers,
176 ip_neighbor_event_flags_t flags)
178 ip_neighbor_watcher_t *watcher;
180 vec_foreach (watcher, watchers) {
181 ip_neighbor_event_t *ipne;
183 ipne = vlib_process_signal_event_data (vlib_get_main(),
184 ip_neighbor_event_process_node.index,
185 0, 1, sizeof(*ipne));
186 ipne->ipne_watch = *watcher;
187 ipne->ipne_flags = flags;
188 ip_neighbor_clone(ip_neighbor_get(ipni), &ipne->ipne_nbr);
193 ip_neighbor_publish (index_t ipni,
194 ip_neighbor_event_flags_t flags)
196 const ip_neighbor_t *ipn;
197 ip_neighbor_key_t key;
200 ipn = ip_neighbor_get (ipni);
202 clib_memcpy (&key, ipn->ipn_key, sizeof (key));
204 /* Search the DB from longest to shortest key */
205 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
208 ip_neighbor_signal ((ip_neighbor_watcher_t*) p[0], ipni, flags);
211 ip_address_reset (&key.ipnk_ip);
212 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
215 ip_neighbor_signal ((ip_neighbor_watcher_t*) p[0], ipni, flags);
218 key.ipnk_sw_if_index = ~0;
219 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
222 ip_neighbor_signal ((ip_neighbor_watcher_t*) p[0], ipni, flags);
226 static clib_error_t *
227 ip_neighbor_watchers_show (vlib_main_t * vm,
228 unformat_input_t * input,
229 vlib_cli_command_t * cmd)
231 ip_neighbor_watcher_t *watchers, *watcher;
232 ip_neighbor_key_t *key;
235 mhash_foreach(key, v, &ipnw_db.ipnwdb_hash,
237 watchers = (ip_neighbor_watcher_t*) *v;
239 ASSERT(vec_len(watchers));
240 vlib_cli_output (vm, "Key: %U", format_ip_neighbor_key, key);
242 vec_foreach (watcher, watchers)
243 vlib_cli_output (vm, " %U", format_ip_neighbor_watcher, watcher);
248 VLIB_CLI_COMMAND (show_ip_neighbor_watchers_cmd_node, static) = {
249 .path = "show ip neighbor-watcher",
250 .function = ip_neighbor_watchers_show,
251 .short_help = "show ip neighbors-watcher",
254 static clib_error_t *
255 ip_neighbor_watch_init (vlib_main_t * vm)
257 mhash_init (&ipnw_db.ipnwdb_hash,
258 sizeof (ip_neighbor_watcher_t *), sizeof (ip_neighbor_key_t));
262 VLIB_INIT_FUNCTION (ip_neighbor_watch_init) =
264 .runs_after = VLIB_INITS("ip_neighbor_init"),
269 * fd.io coding-style-patch-verification: ON
272 * eval: (c-set-style "gnu")