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/ip_types_api.h>
20 #include <vnet/ethernet/ethernet_types_api.h>
22 #include <vnet/ip-neighbor/ip_neighbor.api_enum.h>
23 #include <vnet/ip-neighbor/ip_neighbor.api_types.h>
25 #include <vlibmemory/api.h>
28 * Database of registered watchers
29 * The key for a watcher is {type, sw_if_index, addreess}
30 * interface=~0 / address=all-zeros imples any.
32 typedef struct ip_neighbor_watch_db_t_
35 } ip_neighbor_watch_db_t;
37 static ip_neighbor_watch_db_t ipnw_db;
40 ip_neighbor_event_process (vlib_main_t * vm,
41 vlib_node_runtime_t * rt, vlib_frame_t * f)
43 ip_neighbor_event_t *ipne, *ipnes = NULL;
44 uword event_type = ~0;
48 vlib_process_wait_for_event (vm);
50 ipnes = vlib_process_get_event_data (vm, &event_type);
55 vec_foreach (ipne, ipnes) ip_neighbor_handle_event (ipne);
63 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",
78 want_ip_neighbor_events_reaper (u32 client_index)
80 ip_neighbor_key_t *key, *empty_keys = NULL;
81 ip_neighbor_watcher_t *watchers;
85 /* walk the entire IP neighbour DB and removes the client's registrations */
87 mhash_foreach(key, v, &ipnw_db.ipnwdb_hash,
89 watchers = (ip_neighbor_watcher_t*) *v;
91 vec_foreach_index_backwards (pos, watchers) {
92 if (watchers[pos].ipw_client == client_index)
93 vec_del1(watchers, pos);
96 if (vec_len(watchers) == 0)
97 vec_add1 (empty_keys, *key);
101 vec_foreach (key, empty_keys)
102 mhash_unset (&ipnw_db.ipnwdb_hash, key, NULL);
103 vec_free (empty_keys);
107 VL_MSG_API_REAPER_FUNCTION (want_ip_neighbor_events_reaper);
110 ip_neighbor_watch_cmp (const ip_neighbor_watcher_t * w1,
111 const ip_neighbor_watcher_t * w2)
113 return (0 == clib_memcmp (w1, w2, sizeof(*w1)));
117 ip_neighbor_watch (const ip46_address_t * ip,
120 const ip_neighbor_watcher_t * watch)
122 ip_neighbor_key_t key = {
124 .ipnk_sw_if_index = (sw_if_index == 0 ? ~0 : sw_if_index),
127 ip_neighbor_watcher_t *ipws = NULL;
130 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
134 ipws = (ip_neighbor_watcher_t*) p[0];
136 if (~0 != vec_search_with_function (ipws, watch,
137 ip_neighbor_watch_cmp))
142 vec_add1 (ipws, *watch);
144 mhash_set (&ipnw_db.ipnwdb_hash, &key, (uword) ipws, NULL);
148 ip_neighbor_unwatch (const ip46_address_t * ip,
151 const ip_neighbor_watcher_t * watch)
153 ip_neighbor_key_t key = {
155 .ipnk_sw_if_index = (sw_if_index == 0 ? ~0 : sw_if_index),
158 ip_neighbor_watcher_t *ipws = NULL;
162 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
167 ipws = (ip_neighbor_watcher_t*) p[0];
169 pos = vec_search_with_function (ipws, watch, ip_neighbor_watch_cmp);
174 vec_del1 (ipws, pos);
176 if (vec_len(ipws) == 0)
177 mhash_unset (&ipnw_db.ipnwdb_hash, &key, NULL);
181 ip_neighbor_signal (ip_neighbor_watcher_t *watchers, index_t ipni)
183 ip_neighbor_watcher_t *watcher;
185 vec_foreach (watcher, watchers) {
186 ip_neighbor_event_t *ipne;
188 ipne = vlib_process_signal_event_data (vlib_get_main(),
189 ip_neighbor_event_process_node.index,
190 0, 1, sizeof(*ipne));
191 ipne->ipne_watch = *watcher;
192 ipne->ipne_index = ipni;
197 ip_neighbor_publish (index_t ipni)
199 const ip_neighbor_t *ipn;
200 ip_neighbor_key_t key;
203 ipn = ip_neighbor_get (ipni);
205 clib_memcpy (&key, ipn->ipn_key, sizeof (key));
207 /* Search the DB from longest to shortest key */
208 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
211 ip_neighbor_signal ((ip_neighbor_watcher_t*) p[0], ipni);
214 ip46_address_reset (&key.ipnk_ip);
215 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
218 ip_neighbor_signal ((ip_neighbor_watcher_t*) p[0], ipni);
221 key.ipnk_sw_if_index = ~0;
222 p = mhash_get (&ipnw_db.ipnwdb_hash, &key);
225 ip_neighbor_signal ((ip_neighbor_watcher_t*) p[0], ipni);
229 static clib_error_t *
230 ip_neighbor_watchers_show (vlib_main_t * vm,
231 unformat_input_t * input,
232 vlib_cli_command_t * cmd)
234 ip_neighbor_watcher_t *watchers, *watcher;
235 ip_neighbor_key_t *key;
239 mhash_foreach(key, v, &ipnw_db.ipnwdb_hash,
241 watchers = (ip_neighbor_watcher_t*) *v;
243 ASSERT(vec_len(watchers));
244 vlib_cli_output (vm, "Key: %U", format_ip_neighbor_key, key);
246 vec_foreach (watcher, watchers)
247 vlib_cli_output (vm, " %U", format_ip_neighbor_watcher, watcher);
254 VLIB_CLI_COMMAND (show_ip_neighbor_watchers_cmd_node, static) = {
255 .path = "show ip neighbor-watcher",
256 .function = ip_neighbor_watchers_show,
257 .short_help = "show ip neighbors-watcher",
261 static clib_error_t *
262 ip_neighbor_watch_init (vlib_main_t * vm)
264 mhash_init (&ipnw_db.ipnwdb_hash,
265 sizeof (ip_neighbor_watcher_t *), sizeof (ip_neighbor_key_t));
270 VLIB_INIT_FUNCTION (ip_neighbor_watch_init) =
272 .runs_after = VLIB_INITS("ip_neighbor_init"),
278 * fd.io coding-style-patch-verification: ON
281 * eval: (c-set-style "gnu")