]>
Commit | Line | Data |
---|---|---|
2d33f157 | 1 | /* |
2 | * Server side of OSPF API. | |
3 | * Copyright (C) 2001, 2002 Ralph Keller | |
4 | * | |
5 | * This file is part of GNU Zebra. | |
896014f4 | 6 | * |
2d33f157 | 7 | * GNU Zebra is free software; you can redistribute it and/or modify |
8 | * it under the terms of the GNU General Public License as published | |
9 | * by the Free Software Foundation; either version 2, or (at your | |
10 | * option) any later version. | |
11 | * | |
12 | * GNU Zebra is distributed in the hope that it will be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | * General Public License for more details. | |
16 | * | |
896014f4 DL |
17 | * You should have received a copy of the GNU General Public License along |
18 | * with this program; see the file COPYING; if not, write to the Free Software | |
19 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
2d33f157 | 20 | */ |
21 | ||
22 | #include <zebra.h> | |
23 | ||
24 | #ifdef SUPPORT_OSPF_API | |
2d33f157 | 25 | |
26 | #include "linklist.h" | |
27 | #include "prefix.h" | |
28 | #include "if.h" | |
29 | #include "table.h" | |
30 | #include "memory.h" | |
31 | #include "command.h" | |
32 | #include "vty.h" | |
33 | #include "stream.h" | |
34 | #include "log.h" | |
35 | #include "thread.h" | |
36 | #include "hash.h" | |
d62a17ae | 37 | #include "sockunion.h" /* for inet_aton() */ |
2d33f157 | 38 | #include "buffer.h" |
39 | ||
40 | #include <sys/types.h> | |
41 | ||
d62a17ae | 42 | #include "ospfd/ospfd.h" /* for "struct thread_master" */ |
2d33f157 | 43 | #include "ospfd/ospf_interface.h" |
44 | #include "ospfd/ospf_ism.h" | |
45 | #include "ospfd/ospf_asbr.h" | |
46 | #include "ospfd/ospf_lsa.h" | |
47 | #include "ospfd/ospf_lsdb.h" | |
48 | #include "ospfd/ospf_neighbor.h" | |
49 | #include "ospfd/ospf_nsm.h" | |
50 | #include "ospfd/ospf_flood.h" | |
51 | #include "ospfd/ospf_packet.h" | |
52 | #include "ospfd/ospf_spf.h" | |
53 | #include "ospfd/ospf_dump.h" | |
54 | #include "ospfd/ospf_route.h" | |
55 | #include "ospfd/ospf_ase.h" | |
56 | #include "ospfd/ospf_zebra.h" | |
57 | ||
58 | #include "ospfd/ospf_api.h" | |
59 | #include "ospfd/ospf_apiserver.h" | |
60 | ||
61 | /* This is an implementation of an API to the OSPF daemon that allows | |
62 | * external applications to access the OSPF daemon through socket | |
63 | * connections. The application can use this API to inject its own | |
64 | * opaque LSAs and flood them to other OSPF daemons. Other OSPF | |
65 | * daemons then receive these LSAs and inform applications through the | |
66 | * API by sending a corresponding message. The application can also | |
67 | * register to receive all LSA types (in addition to opaque types) and | |
68 | * use this information to reconstruct the OSPF's LSDB. The OSPF | |
69 | * daemon supports multiple applications concurrently. */ | |
70 | ||
71 | /* List of all active connections. */ | |
87d6f87a | 72 | struct list *apiserver_list; |
2d33f157 | 73 | |
74 | /* ----------------------------------------------------------- | |
75 | * Functions to lookup interfaces | |
76 | * ----------------------------------------------------------- | |
77 | */ | |
78 | ||
d62a17ae | 79 | struct ospf_interface *ospf_apiserver_if_lookup_by_addr(struct in_addr address) |
2d33f157 | 80 | { |
d62a17ae | 81 | struct listnode *node, *nnode; |
82 | struct ospf_interface *oi; | |
b5a8894d | 83 | struct ospf *ospf = NULL; |
99b7c5d6 | 84 | |
b5a8894d CS |
85 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
86 | if (!ospf) | |
d62a17ae | 87 | return NULL; |
2d33f157 | 88 | |
d62a17ae | 89 | for (ALL_LIST_ELEMENTS(ospf->oiflist, node, nnode, oi)) |
90 | if (oi->type != OSPF_IFTYPE_VIRTUALLINK) | |
91 | if (IPV4_ADDR_SAME(&address, &oi->address->u.prefix4)) | |
92 | return oi; | |
87d6f87a | 93 | |
d62a17ae | 94 | return NULL; |
2d33f157 | 95 | } |
96 | ||
d62a17ae | 97 | struct ospf_interface *ospf_apiserver_if_lookup_by_ifp(struct interface *ifp) |
2d33f157 | 98 | { |
d62a17ae | 99 | struct listnode *node, *nnode; |
100 | struct ospf_interface *oi; | |
b5a8894d | 101 | struct ospf *ospf = NULL; |
99b7c5d6 | 102 | |
b5a8894d CS |
103 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
104 | if (!ospf) | |
d62a17ae | 105 | return NULL; |
2d33f157 | 106 | |
d62a17ae | 107 | for (ALL_LIST_ELEMENTS(ospf->oiflist, node, nnode, oi)) |
108 | if (oi->ifp == ifp) | |
109 | return oi; | |
87d6f87a | 110 | |
d62a17ae | 111 | return NULL; |
2d33f157 | 112 | } |
113 | ||
114 | /* ----------------------------------------------------------- | |
115 | * Initialization | |
116 | * ----------------------------------------------------------- | |
117 | */ | |
118 | ||
d62a17ae | 119 | unsigned short ospf_apiserver_getport(void) |
2d33f157 | 120 | { |
d62a17ae | 121 | struct servent *sp = getservbyname("ospfapi", "tcp"); |
2d33f157 | 122 | |
d62a17ae | 123 | return sp ? ntohs(sp->s_port) : OSPF_API_SYNC_PORT; |
2d33f157 | 124 | } |
125 | ||
126 | /* Initialize OSPF API module. Invoked from ospf_opaque_init() */ | |
d62a17ae | 127 | int ospf_apiserver_init(void) |
2d33f157 | 128 | { |
d62a17ae | 129 | int fd; |
130 | int rc = -1; | |
131 | ||
132 | /* Create new socket for synchronous messages. */ | |
133 | fd = ospf_apiserver_serv_sock_family(ospf_apiserver_getport(), AF_INET); | |
134 | ||
135 | if (fd < 0) | |
136 | goto out; | |
137 | ||
138 | /* Schedule new thread that handles accepted connections. */ | |
139 | ospf_apiserver_event(OSPF_APISERVER_ACCEPT, fd, NULL); | |
140 | ||
141 | /* Initialize list that keeps track of all connections. */ | |
142 | apiserver_list = list_new(); | |
143 | ||
144 | /* Register opaque-independent call back functions. These functions | |
145 | are invoked on ISM, NSM changes and LSA update and LSA deletes */ | |
146 | rc = ospf_register_opaque_functab( | |
147 | 0 /* all LSAs */, 0 /* all opaque types */, | |
148 | ospf_apiserver_new_if, ospf_apiserver_del_if, | |
149 | ospf_apiserver_ism_change, ospf_apiserver_nsm_change, NULL, | |
150 | NULL, NULL, NULL, /* ospf_apiserver_show_info */ | |
151 | NULL, /* originator_func */ | |
152 | NULL, /* ospf_apiserver_lsa_refresher */ | |
153 | ospf_apiserver_lsa_update, ospf_apiserver_lsa_delete); | |
154 | if (rc != 0) { | |
155 | zlog_warn( | |
156 | "ospf_apiserver_init: Failed to register opaque type [0/0]"); | |
157 | } | |
158 | ||
159 | rc = 0; | |
2d33f157 | 160 | |
161 | out: | |
d62a17ae | 162 | return rc; |
2d33f157 | 163 | } |
164 | ||
165 | /* Terminate OSPF API module. */ | |
d62a17ae | 166 | void ospf_apiserver_term(void) |
2d33f157 | 167 | { |
d62a17ae | 168 | struct ospf_apiserver *apiserv; |
169 | ||
170 | /* Unregister wildcard [0/0] type */ | |
171 | ospf_delete_opaque_functab(0 /* all LSAs */, 0 /* all opaque types */); | |
172 | ||
173 | /* | |
174 | * Free all client instances. ospf_apiserver_free removes the node | |
175 | * from the list, so we examine the head of the list anew each time. | |
176 | */ | |
177 | while (apiserver_list | |
178 | && (apiserv = listgetdata(listhead(apiserver_list))) != NULL) | |
179 | ospf_apiserver_free(apiserv); | |
180 | ||
181 | /* Free client list itself */ | |
182 | if (apiserver_list) | |
affe9e99 | 183 | list_delete_and_null(&apiserver_list); |
d62a17ae | 184 | |
185 | /* Free wildcard list */ | |
186 | /* XXX */ | |
2d33f157 | 187 | } |
188 | ||
d7c0a89a QY |
189 | static struct ospf_apiserver *lookup_apiserver(uint8_t lsa_type, |
190 | uint8_t opaque_type) | |
2d33f157 | 191 | { |
d62a17ae | 192 | struct listnode *n1, *n2; |
193 | struct registered_opaque_type *r; | |
194 | struct ospf_apiserver *apiserv, *found = NULL; | |
195 | ||
196 | /* XXX: this approaches O(n**2) */ | |
197 | for (ALL_LIST_ELEMENTS_RO(apiserver_list, n1, apiserv)) { | |
198 | for (ALL_LIST_ELEMENTS_RO(apiserv->opaque_types, n2, r)) | |
199 | if (r->lsa_type == lsa_type | |
200 | && r->opaque_type == opaque_type) { | |
201 | found = apiserv; | |
202 | goto out; | |
203 | } | |
204 | } | |
2d33f157 | 205 | out: |
d62a17ae | 206 | return found; |
2d33f157 | 207 | } |
208 | ||
d62a17ae | 209 | static struct ospf_apiserver *lookup_apiserver_by_lsa(struct ospf_lsa *lsa) |
2d33f157 | 210 | { |
d62a17ae | 211 | struct lsa_header *lsah = lsa->data; |
212 | struct ospf_apiserver *found = NULL; | |
213 | ||
214 | if (IS_OPAQUE_LSA(lsah->type)) { | |
215 | found = lookup_apiserver( | |
216 | lsah->type, GET_OPAQUE_TYPE(ntohl(lsah->id.s_addr))); | |
217 | } | |
218 | return found; | |
2d33f157 | 219 | } |
220 | ||
221 | /* ----------------------------------------------------------- | |
222 | * Followings are functions to manage client connections. | |
223 | * ----------------------------------------------------------- | |
224 | */ | |
d62a17ae | 225 | static int ospf_apiserver_new_lsa_hook(struct ospf_lsa *lsa) |
2d33f157 | 226 | { |
d62a17ae | 227 | if (IS_DEBUG_OSPF_EVENT) |
228 | zlog_debug("API: Put LSA(%p)[%s] into reserve, total=%ld", | |
229 | (void *)lsa, dump_lsa_key(lsa), lsa->lsdb->total); | |
230 | return 0; | |
2d33f157 | 231 | } |
232 | ||
d62a17ae | 233 | static int ospf_apiserver_del_lsa_hook(struct ospf_lsa *lsa) |
2d33f157 | 234 | { |
d62a17ae | 235 | if (IS_DEBUG_OSPF_EVENT) |
236 | zlog_debug("API: Get LSA(%p)[%s] from reserve, total=%ld", | |
237 | (void *)lsa, dump_lsa_key(lsa), lsa->lsdb->total); | |
238 | return 0; | |
2d33f157 | 239 | } |
240 | ||
241 | /* Allocate new connection structure. */ | |
d62a17ae | 242 | struct ospf_apiserver *ospf_apiserver_new(int fd_sync, int fd_async) |
2d33f157 | 243 | { |
d62a17ae | 244 | struct ospf_apiserver *new = |
245 | XMALLOC(MTYPE_OSPF_APISERVER, sizeof(struct ospf_apiserver)); | |
2d33f157 | 246 | |
d62a17ae | 247 | new->filter = XMALLOC(MTYPE_OSPF_APISERVER_MSGFILTER, |
248 | sizeof(struct lsa_filter_type)); | |
2d33f157 | 249 | |
d62a17ae | 250 | new->fd_sync = fd_sync; |
251 | new->fd_async = fd_async; | |
2d33f157 | 252 | |
d62a17ae | 253 | /* list of registered opaque types that application uses */ |
254 | new->opaque_types = list_new(); | |
2d33f157 | 255 | |
d62a17ae | 256 | /* Initialize temporary strage for LSA instances to be refreshed. */ |
257 | memset(&new->reserve, 0, sizeof(struct ospf_lsdb)); | |
258 | ospf_lsdb_init(&new->reserve); | |
2d33f157 | 259 | |
d62a17ae | 260 | new->reserve.new_lsa_hook = ospf_apiserver_new_lsa_hook; /* debug */ |
261 | new->reserve.del_lsa_hook = ospf_apiserver_del_lsa_hook; /* debug */ | |
2d33f157 | 262 | |
d62a17ae | 263 | new->out_sync_fifo = msg_fifo_new(); |
264 | new->out_async_fifo = msg_fifo_new(); | |
265 | new->t_sync_read = NULL; | |
2d33f157 | 266 | #ifdef USE_ASYNC_READ |
d62a17ae | 267 | new->t_async_read = NULL; |
2d33f157 | 268 | #endif /* USE_ASYNC_READ */ |
d62a17ae | 269 | new->t_sync_write = NULL; |
270 | new->t_async_write = NULL; | |
2d33f157 | 271 | |
d62a17ae | 272 | new->filter->typemask = 0; /* filter all LSAs */ |
273 | new->filter->origin = ANY_ORIGIN; | |
274 | new->filter->num_areas = 0; | |
2d33f157 | 275 | |
d62a17ae | 276 | return new; |
2d33f157 | 277 | } |
278 | ||
d62a17ae | 279 | void ospf_apiserver_event(enum event event, int fd, |
280 | struct ospf_apiserver *apiserv) | |
2d33f157 | 281 | { |
d62a17ae | 282 | switch (event) { |
283 | case OSPF_APISERVER_ACCEPT: | |
284 | (void)thread_add_read(master, ospf_apiserver_accept, apiserv, | |
285 | fd, NULL); | |
286 | break; | |
287 | case OSPF_APISERVER_SYNC_READ: | |
288 | apiserv->t_sync_read = NULL; | |
289 | thread_add_read(master, ospf_apiserver_read, apiserv, fd, | |
290 | &apiserv->t_sync_read); | |
291 | break; | |
2d33f157 | 292 | #ifdef USE_ASYNC_READ |
d62a17ae | 293 | case OSPF_APISERVER_ASYNC_READ: |
294 | apiserv->t_async_read = NULL; | |
295 | thread_add_read(master, ospf_apiserver_read, apiserv, fd, | |
296 | &apiserv->t_async_read); | |
297 | break; | |
2d33f157 | 298 | #endif /* USE_ASYNC_READ */ |
d62a17ae | 299 | case OSPF_APISERVER_SYNC_WRITE: |
300 | thread_add_write(master, ospf_apiserver_sync_write, apiserv, fd, | |
301 | &apiserv->t_sync_write); | |
302 | break; | |
303 | case OSPF_APISERVER_ASYNC_WRITE: | |
304 | thread_add_write(master, ospf_apiserver_async_write, apiserv, | |
305 | fd, &apiserv->t_async_write); | |
306 | break; | |
307 | } | |
2d33f157 | 308 | } |
309 | ||
310 | /* Free instance. First unregister all opaque types used by | |
d62a17ae | 311 | application, flush opaque LSAs injected by application |
2d33f157 | 312 | from network and close connection. */ |
d62a17ae | 313 | void ospf_apiserver_free(struct ospf_apiserver *apiserv) |
2d33f157 | 314 | { |
d62a17ae | 315 | struct listnode *node; |
2d33f157 | 316 | |
d62a17ae | 317 | /* Cancel read and write threads. */ |
318 | if (apiserv->t_sync_read) { | |
319 | thread_cancel(apiserv->t_sync_read); | |
320 | } | |
2d33f157 | 321 | #ifdef USE_ASYNC_READ |
d62a17ae | 322 | if (apiserv->t_async_read) { |
323 | thread_cancel(apiserv->t_async_read); | |
324 | } | |
2d33f157 | 325 | #endif /* USE_ASYNC_READ */ |
d62a17ae | 326 | if (apiserv->t_sync_write) { |
327 | thread_cancel(apiserv->t_sync_write); | |
328 | } | |
2d33f157 | 329 | |
d62a17ae | 330 | if (apiserv->t_async_write) { |
331 | thread_cancel(apiserv->t_async_write); | |
332 | } | |
2d33f157 | 333 | |
d62a17ae | 334 | /* Unregister all opaque types that application registered |
335 | and flush opaque LSAs if still in LSDB. */ | |
2d33f157 | 336 | |
d62a17ae | 337 | while ((node = listhead(apiserv->opaque_types)) != NULL) { |
338 | struct registered_opaque_type *regtype = listgetdata(node); | |
2d33f157 | 339 | |
d62a17ae | 340 | ospf_apiserver_unregister_opaque_type( |
341 | apiserv, regtype->lsa_type, regtype->opaque_type); | |
342 | } | |
2d33f157 | 343 | |
d62a17ae | 344 | /* Close connections to OSPFd. */ |
345 | if (apiserv->fd_sync > 0) { | |
346 | close(apiserv->fd_sync); | |
347 | } | |
2d33f157 | 348 | |
d62a17ae | 349 | if (apiserv->fd_async > 0) { |
350 | close(apiserv->fd_async); | |
351 | } | |
2d33f157 | 352 | |
d62a17ae | 353 | /* Free fifos */ |
354 | msg_fifo_free(apiserv->out_sync_fifo); | |
355 | msg_fifo_free(apiserv->out_async_fifo); | |
2d33f157 | 356 | |
d62a17ae | 357 | /* Clear temporary strage for LSA instances to be refreshed. */ |
358 | ospf_lsdb_delete_all(&apiserv->reserve); | |
359 | ospf_lsdb_cleanup(&apiserv->reserve); | |
2d33f157 | 360 | |
d62a17ae | 361 | /* Remove from the list of active clients. */ |
362 | listnode_delete(apiserver_list, apiserv); | |
2d33f157 | 363 | |
d62a17ae | 364 | if (IS_DEBUG_OSPF_EVENT) |
365 | zlog_debug("API: Delete apiserv(%p), total#(%d)", | |
366 | (void *)apiserv, apiserver_list->count); | |
2d33f157 | 367 | |
d62a17ae | 368 | /* And free instance. */ |
369 | XFREE(MTYPE_OSPF_APISERVER, apiserv); | |
2d33f157 | 370 | } |
371 | ||
d62a17ae | 372 | int ospf_apiserver_read(struct thread *thread) |
2d33f157 | 373 | { |
d62a17ae | 374 | struct ospf_apiserver *apiserv; |
375 | struct msg *msg; | |
376 | int fd; | |
377 | int rc = -1; | |
378 | enum event event; | |
379 | ||
380 | apiserv = THREAD_ARG(thread); | |
381 | fd = THREAD_FD(thread); | |
382 | ||
383 | if (fd == apiserv->fd_sync) { | |
384 | event = OSPF_APISERVER_SYNC_READ; | |
385 | apiserv->t_sync_read = NULL; | |
386 | ||
387 | if (IS_DEBUG_OSPF_EVENT) | |
388 | zlog_debug("API: ospf_apiserver_read: Peer: %s/%u", | |
389 | inet_ntoa(apiserv->peer_sync.sin_addr), | |
390 | ntohs(apiserv->peer_sync.sin_port)); | |
391 | } | |
2d33f157 | 392 | #ifdef USE_ASYNC_READ |
d62a17ae | 393 | else if (fd == apiserv->fd_async) { |
394 | event = OSPF_APISERVER_ASYNC_READ; | |
395 | apiserv->t_async_read = NULL; | |
396 | ||
397 | if (IS_DEBUG_OSPF_EVENT) | |
398 | zlog_debug("API: ospf_apiserver_read: Peer: %s/%u", | |
399 | inet_ntoa(apiserv->peer_async.sin_addr), | |
400 | ntohs(apiserv->peer_async.sin_port)); | |
401 | } | |
2d33f157 | 402 | #endif /* USE_ASYNC_READ */ |
d62a17ae | 403 | else { |
404 | zlog_warn("ospf_apiserver_read: Unknown fd(%d)", fd); | |
405 | ospf_apiserver_free(apiserv); | |
406 | goto out; | |
407 | } | |
2d33f157 | 408 | |
d62a17ae | 409 | /* Read message from fd. */ |
410 | msg = msg_read(fd); | |
411 | if (msg == NULL) { | |
412 | zlog_warn( | |
413 | "ospf_apiserver_read: read failed on fd=%d, closing connection", | |
414 | fd); | |
2d33f157 | 415 | |
d62a17ae | 416 | /* Perform cleanup. */ |
417 | ospf_apiserver_free(apiserv); | |
418 | goto out; | |
419 | } | |
2d33f157 | 420 | |
d62a17ae | 421 | if (IS_DEBUG_OSPF_EVENT) |
422 | msg_print(msg); | |
2d33f157 | 423 | |
d62a17ae | 424 | /* Dispatch to corresponding message handler. */ |
425 | rc = ospf_apiserver_handle_msg(apiserv, msg); | |
2d33f157 | 426 | |
d62a17ae | 427 | /* Prepare for next message, add read thread. */ |
428 | ospf_apiserver_event(event, fd, apiserv); | |
2d33f157 | 429 | |
d62a17ae | 430 | msg_free(msg); |
2d33f157 | 431 | |
432 | out: | |
d62a17ae | 433 | return rc; |
2d33f157 | 434 | } |
435 | ||
d62a17ae | 436 | int ospf_apiserver_sync_write(struct thread *thread) |
2d33f157 | 437 | { |
d62a17ae | 438 | struct ospf_apiserver *apiserv; |
439 | struct msg *msg; | |
440 | int fd; | |
441 | int rc = -1; | |
442 | ||
443 | apiserv = THREAD_ARG(thread); | |
444 | assert(apiserv); | |
445 | fd = THREAD_FD(thread); | |
446 | ||
447 | apiserv->t_sync_write = NULL; | |
448 | ||
449 | /* Sanity check */ | |
450 | if (fd != apiserv->fd_sync) { | |
451 | zlog_warn("ospf_apiserver_sync_write: Unknown fd=%d", fd); | |
452 | goto out; | |
453 | } | |
454 | ||
455 | if (IS_DEBUG_OSPF_EVENT) | |
456 | zlog_debug("API: ospf_apiserver_sync_write: Peer: %s/%u", | |
457 | inet_ntoa(apiserv->peer_sync.sin_addr), | |
458 | ntohs(apiserv->peer_sync.sin_port)); | |
459 | ||
460 | /* Check whether there is really a message in the fifo. */ | |
461 | msg = msg_fifo_pop(apiserv->out_sync_fifo); | |
462 | if (!msg) { | |
463 | zlog_warn( | |
464 | "API: ospf_apiserver_sync_write: No message in Sync-FIFO?"); | |
465 | return 0; | |
466 | } | |
467 | ||
468 | if (IS_DEBUG_OSPF_EVENT) | |
469 | msg_print(msg); | |
470 | ||
471 | rc = msg_write(fd, msg); | |
472 | ||
473 | /* Once a message is dequeued, it should be freed anyway. */ | |
474 | msg_free(msg); | |
475 | ||
476 | if (rc < 0) { | |
477 | zlog_warn("ospf_apiserver_sync_write: write failed on fd=%d", | |
478 | fd); | |
479 | goto out; | |
480 | } | |
481 | ||
482 | ||
483 | /* If more messages are in sync message fifo, schedule write thread. */ | |
484 | if (msg_fifo_head(apiserv->out_sync_fifo)) { | |
485 | ospf_apiserver_event(OSPF_APISERVER_SYNC_WRITE, | |
486 | apiserv->fd_sync, apiserv); | |
487 | } | |
488 | ||
489 | out: | |
490 | ||
491 | if (rc < 0) { | |
492 | /* Perform cleanup and disconnect with peer */ | |
493 | ospf_apiserver_free(apiserv); | |
494 | } | |
495 | ||
496 | return rc; | |
2d33f157 | 497 | } |
498 | ||
499 | ||
d62a17ae | 500 | int ospf_apiserver_async_write(struct thread *thread) |
2d33f157 | 501 | { |
d62a17ae | 502 | struct ospf_apiserver *apiserv; |
503 | struct msg *msg; | |
504 | int fd; | |
505 | int rc = -1; | |
506 | ||
507 | apiserv = THREAD_ARG(thread); | |
508 | assert(apiserv); | |
509 | fd = THREAD_FD(thread); | |
510 | ||
511 | apiserv->t_async_write = NULL; | |
512 | ||
513 | /* Sanity check */ | |
514 | if (fd != apiserv->fd_async) { | |
515 | zlog_warn("ospf_apiserver_async_write: Unknown fd=%d", fd); | |
516 | goto out; | |
517 | } | |
518 | ||
519 | if (IS_DEBUG_OSPF_EVENT) | |
520 | zlog_debug("API: ospf_apiserver_async_write: Peer: %s/%u", | |
521 | inet_ntoa(apiserv->peer_async.sin_addr), | |
522 | ntohs(apiserv->peer_async.sin_port)); | |
523 | ||
524 | /* Check whether there is really a message in the fifo. */ | |
525 | msg = msg_fifo_pop(apiserv->out_async_fifo); | |
526 | if (!msg) { | |
527 | zlog_warn( | |
528 | "API: ospf_apiserver_async_write: No message in Async-FIFO?"); | |
529 | return 0; | |
530 | } | |
531 | ||
532 | if (IS_DEBUG_OSPF_EVENT) | |
533 | msg_print(msg); | |
534 | ||
535 | rc = msg_write(fd, msg); | |
536 | ||
537 | /* Once a message is dequeued, it should be freed anyway. */ | |
538 | msg_free(msg); | |
539 | ||
540 | if (rc < 0) { | |
541 | zlog_warn("ospf_apiserver_async_write: write failed on fd=%d", | |
542 | fd); | |
543 | goto out; | |
544 | } | |
545 | ||
546 | ||
547 | /* If more messages are in async message fifo, schedule write thread. */ | |
548 | if (msg_fifo_head(apiserv->out_async_fifo)) { | |
549 | ospf_apiserver_event(OSPF_APISERVER_ASYNC_WRITE, | |
550 | apiserv->fd_async, apiserv); | |
551 | } | |
552 | ||
553 | out: | |
554 | ||
555 | if (rc < 0) { | |
556 | /* Perform cleanup and disconnect with peer */ | |
557 | ospf_apiserver_free(apiserv); | |
558 | } | |
559 | ||
560 | return rc; | |
2d33f157 | 561 | } |
562 | ||
563 | ||
d62a17ae | 564 | int ospf_apiserver_serv_sock_family(unsigned short port, int family) |
2d33f157 | 565 | { |
d62a17ae | 566 | union sockunion su; |
567 | int accept_sock; | |
568 | int rc; | |
569 | ||
570 | memset(&su, 0, sizeof(union sockunion)); | |
571 | su.sa.sa_family = family; | |
572 | ||
573 | /* Make new socket */ | |
574 | accept_sock = sockunion_stream_socket(&su); | |
575 | if (accept_sock < 0) | |
576 | return accept_sock; | |
577 | ||
578 | /* This is a server, so reuse address and port */ | |
579 | sockopt_reuseaddr(accept_sock); | |
580 | sockopt_reuseport(accept_sock); | |
581 | ||
582 | /* Bind socket to address and given port. */ | |
583 | rc = sockunion_bind(accept_sock, &su, port, NULL); | |
584 | if (rc < 0) { | |
585 | close(accept_sock); /* Close socket */ | |
586 | return rc; | |
587 | } | |
588 | ||
589 | /* Listen socket under queue length 3. */ | |
590 | rc = listen(accept_sock, 3); | |
591 | if (rc < 0) { | |
592 | zlog_warn("ospf_apiserver_serv_sock_family: listen: %s", | |
593 | safe_strerror(errno)); | |
594 | close(accept_sock); /* Close socket */ | |
595 | return rc; | |
596 | } | |
597 | return accept_sock; | |
2d33f157 | 598 | } |
599 | ||
600 | ||
601 | /* Accept connection request from external applications. For each | |
602 | accepted connection allocate own connection instance. */ | |
d62a17ae | 603 | int ospf_apiserver_accept(struct thread *thread) |
2d33f157 | 604 | { |
d62a17ae | 605 | int accept_sock; |
606 | int new_sync_sock; | |
607 | int new_async_sock; | |
608 | union sockunion su; | |
609 | struct ospf_apiserver *apiserv; | |
610 | struct sockaddr_in peer_async; | |
611 | struct sockaddr_in peer_sync; | |
612 | unsigned int peerlen; | |
613 | int ret; | |
614 | ||
615 | /* THREAD_ARG (thread) is NULL */ | |
616 | accept_sock = THREAD_FD(thread); | |
617 | ||
618 | /* Keep hearing on socket for further connections. */ | |
619 | ospf_apiserver_event(OSPF_APISERVER_ACCEPT, accept_sock, NULL); | |
620 | ||
621 | memset(&su, 0, sizeof(union sockunion)); | |
622 | /* Accept connection for synchronous messages */ | |
623 | new_sync_sock = sockunion_accept(accept_sock, &su); | |
624 | if (new_sync_sock < 0) { | |
625 | zlog_warn("ospf_apiserver_accept: accept: %s", | |
626 | safe_strerror(errno)); | |
627 | return -1; | |
628 | } | |
629 | ||
630 | /* Get port address and port number of peer to make reverse connection. | |
631 | The reverse channel uses the port number of the peer port+1. */ | |
632 | ||
633 | memset(&peer_sync, 0, sizeof(struct sockaddr_in)); | |
634 | peerlen = sizeof(struct sockaddr_in); | |
635 | ||
636 | ret = getpeername(new_sync_sock, (struct sockaddr *)&peer_sync, | |
637 | &peerlen); | |
638 | if (ret < 0) { | |
639 | zlog_warn("ospf_apiserver_accept: getpeername: %s", | |
640 | safe_strerror(errno)); | |
641 | close(new_sync_sock); | |
642 | return -1; | |
643 | } | |
644 | ||
645 | if (IS_DEBUG_OSPF_EVENT) | |
646 | zlog_debug("API: ospf_apiserver_accept: New peer: %s/%u", | |
647 | inet_ntoa(peer_sync.sin_addr), | |
648 | ntohs(peer_sync.sin_port)); | |
649 | ||
650 | /* Create new socket for asynchronous messages. */ | |
651 | peer_async = peer_sync; | |
652 | peer_async.sin_port = htons(ntohs(peer_sync.sin_port) + 1); | |
653 | ||
654 | /* Check if remote port number to make reverse connection is valid one. | |
655 | */ | |
656 | if (ntohs(peer_async.sin_port) == ospf_apiserver_getport()) { | |
657 | zlog_warn( | |
658 | "API: ospf_apiserver_accept: Peer(%s/%u): Invalid async port number?", | |
659 | inet_ntoa(peer_async.sin_addr), | |
660 | ntohs(peer_async.sin_port)); | |
661 | close(new_sync_sock); | |
662 | return -1; | |
663 | } | |
664 | ||
665 | new_async_sock = socket(AF_INET, SOCK_STREAM, 0); | |
666 | if (new_async_sock < 0) { | |
667 | zlog_warn("ospf_apiserver_accept: socket: %s", | |
668 | safe_strerror(errno)); | |
669 | close(new_sync_sock); | |
670 | return -1; | |
671 | } | |
672 | ||
673 | ret = connect(new_async_sock, (struct sockaddr *)&peer_async, | |
674 | sizeof(struct sockaddr_in)); | |
675 | ||
676 | if (ret < 0) { | |
677 | zlog_warn("ospf_apiserver_accept: connect: %s", | |
678 | safe_strerror(errno)); | |
679 | close(new_sync_sock); | |
680 | close(new_async_sock); | |
681 | return -1; | |
682 | } | |
2d33f157 | 683 | |
684 | #ifdef USE_ASYNC_READ | |
d62a17ae | 685 | #else /* USE_ASYNC_READ */ |
686 | /* Make the asynchronous channel write-only. */ | |
687 | ret = shutdown(new_async_sock, SHUT_RD); | |
688 | if (ret < 0) { | |
689 | zlog_warn("ospf_apiserver_accept: shutdown: %s", | |
690 | safe_strerror(errno)); | |
691 | close(new_sync_sock); | |
692 | close(new_async_sock); | |
693 | return -1; | |
694 | } | |
2d33f157 | 695 | #endif /* USE_ASYNC_READ */ |
696 | ||
d62a17ae | 697 | /* Allocate new server-side connection structure */ |
698 | apiserv = ospf_apiserver_new(new_sync_sock, new_async_sock); | |
2d33f157 | 699 | |
d62a17ae | 700 | /* Add to active connection list */ |
701 | listnode_add(apiserver_list, apiserv); | |
702 | apiserv->peer_sync = peer_sync; | |
703 | apiserv->peer_async = peer_async; | |
2d33f157 | 704 | |
d62a17ae | 705 | /* And add read threads for new connection */ |
706 | ospf_apiserver_event(OSPF_APISERVER_SYNC_READ, new_sync_sock, apiserv); | |
2d33f157 | 707 | #ifdef USE_ASYNC_READ |
d62a17ae | 708 | ospf_apiserver_event(OSPF_APISERVER_ASYNC_READ, new_async_sock, |
709 | apiserv); | |
2d33f157 | 710 | #endif /* USE_ASYNC_READ */ |
711 | ||
d62a17ae | 712 | if (IS_DEBUG_OSPF_EVENT) |
713 | zlog_debug("API: New apiserv(%p), total#(%d)", (void *)apiserv, | |
714 | apiserver_list->count); | |
2d33f157 | 715 | |
d62a17ae | 716 | return 0; |
2d33f157 | 717 | } |
718 | ||
719 | ||
720 | /* ----------------------------------------------------------- | |
721 | * Send reply with return code to client application | |
722 | * ----------------------------------------------------------- | |
723 | */ | |
724 | ||
d62a17ae | 725 | static int ospf_apiserver_send_msg(struct ospf_apiserver *apiserv, |
726 | struct msg *msg) | |
2d33f157 | 727 | { |
d62a17ae | 728 | struct msg_fifo *fifo; |
729 | struct msg *msg2; | |
730 | enum event event; | |
731 | int fd; | |
732 | ||
733 | switch (msg->hdr.msgtype) { | |
734 | case MSG_REPLY: | |
735 | fifo = apiserv->out_sync_fifo; | |
736 | fd = apiserv->fd_sync; | |
737 | event = OSPF_APISERVER_SYNC_WRITE; | |
738 | break; | |
739 | case MSG_READY_NOTIFY: | |
740 | case MSG_LSA_UPDATE_NOTIFY: | |
741 | case MSG_LSA_DELETE_NOTIFY: | |
742 | case MSG_NEW_IF: | |
743 | case MSG_DEL_IF: | |
744 | case MSG_ISM_CHANGE: | |
745 | case MSG_NSM_CHANGE: | |
746 | fifo = apiserv->out_async_fifo; | |
747 | fd = apiserv->fd_async; | |
748 | event = OSPF_APISERVER_ASYNC_WRITE; | |
749 | break; | |
750 | default: | |
751 | zlog_warn("ospf_apiserver_send_msg: Unknown message type %d", | |
752 | msg->hdr.msgtype); | |
753 | return -1; | |
754 | } | |
755 | ||
756 | /* Make a copy of the message and put in the fifo. Once the fifo | |
757 | gets drained by the write thread, the message will be freed. */ | |
758 | /* NB: Given "msg" is untouched in this function. */ | |
759 | msg2 = msg_dup(msg); | |
760 | ||
761 | /* Enqueue message into corresponding fifo queue */ | |
762 | msg_fifo_push(fifo, msg2); | |
763 | ||
764 | /* Schedule write thread */ | |
765 | ospf_apiserver_event(event, fd, apiserv); | |
766 | return 0; | |
2d33f157 | 767 | } |
768 | ||
d7c0a89a QY |
769 | int ospf_apiserver_send_reply(struct ospf_apiserver *apiserv, uint32_t seqnr, |
770 | uint8_t rc) | |
2d33f157 | 771 | { |
d62a17ae | 772 | struct msg *msg = new_msg_reply(seqnr, rc); |
773 | int ret; | |
2d33f157 | 774 | |
d62a17ae | 775 | if (!msg) { |
776 | zlog_warn("ospf_apiserver_send_reply: msg_new failed"); | |
2d33f157 | 777 | #ifdef NOTYET |
d62a17ae | 778 | /* Cannot allocate new message. What should we do? */ |
779 | ospf_apiserver_free(apiserv); | |
2d33f157 | 780 | #endif |
d62a17ae | 781 | return -1; |
782 | } | |
2d33f157 | 783 | |
d62a17ae | 784 | ret = ospf_apiserver_send_msg(apiserv, msg); |
785 | msg_free(msg); | |
786 | return ret; | |
2d33f157 | 787 | } |
788 | ||
789 | ||
790 | /* ----------------------------------------------------------- | |
791 | * Generic message dispatching handler function | |
792 | * ----------------------------------------------------------- | |
793 | */ | |
794 | ||
d62a17ae | 795 | int ospf_apiserver_handle_msg(struct ospf_apiserver *apiserv, struct msg *msg) |
2d33f157 | 796 | { |
d62a17ae | 797 | int rc; |
798 | ||
799 | /* Call corresponding message handler function. */ | |
800 | switch (msg->hdr.msgtype) { | |
801 | case MSG_REGISTER_OPAQUETYPE: | |
802 | rc = ospf_apiserver_handle_register_opaque_type(apiserv, msg); | |
803 | break; | |
804 | case MSG_UNREGISTER_OPAQUETYPE: | |
805 | rc = ospf_apiserver_handle_unregister_opaque_type(apiserv, msg); | |
806 | break; | |
807 | case MSG_REGISTER_EVENT: | |
808 | rc = ospf_apiserver_handle_register_event(apiserv, msg); | |
809 | break; | |
810 | case MSG_SYNC_LSDB: | |
811 | rc = ospf_apiserver_handle_sync_lsdb(apiserv, msg); | |
812 | break; | |
813 | case MSG_ORIGINATE_REQUEST: | |
814 | rc = ospf_apiserver_handle_originate_request(apiserv, msg); | |
815 | break; | |
816 | case MSG_DELETE_REQUEST: | |
817 | rc = ospf_apiserver_handle_delete_request(apiserv, msg); | |
818 | break; | |
819 | default: | |
820 | zlog_warn("ospf_apiserver_handle_msg: Unknown message type: %d", | |
821 | msg->hdr.msgtype); | |
822 | rc = -1; | |
823 | } | |
824 | return rc; | |
2d33f157 | 825 | } |
826 | ||
827 | ||
828 | /* ----------------------------------------------------------- | |
829 | * Following are functions for opaque type registration | |
830 | * ----------------------------------------------------------- | |
831 | */ | |
832 | ||
d62a17ae | 833 | int ospf_apiserver_register_opaque_type(struct ospf_apiserver *apiserv, |
d7c0a89a | 834 | uint8_t lsa_type, uint8_t opaque_type) |
2d33f157 | 835 | { |
d62a17ae | 836 | struct registered_opaque_type *regtype; |
837 | int (*originator_func)(void *arg); | |
838 | int rc; | |
839 | ||
840 | switch (lsa_type) { | |
841 | case OSPF_OPAQUE_LINK_LSA: | |
842 | originator_func = ospf_apiserver_lsa9_originator; | |
843 | break; | |
844 | case OSPF_OPAQUE_AREA_LSA: | |
845 | originator_func = ospf_apiserver_lsa10_originator; | |
846 | break; | |
847 | case OSPF_OPAQUE_AS_LSA: | |
848 | originator_func = ospf_apiserver_lsa11_originator; | |
849 | break; | |
850 | default: | |
851 | zlog_warn("ospf_apiserver_register_opaque_type: lsa_type(%d)", | |
852 | lsa_type); | |
853 | return OSPF_API_ILLEGALLSATYPE; | |
854 | } | |
855 | ||
856 | ||
857 | /* Register opaque function table */ | |
858 | /* NB: Duplicated registration will be detected inside the function. */ | |
859 | rc = ospf_register_opaque_functab( | |
860 | lsa_type, opaque_type, NULL, /* ospf_apiserver_new_if */ | |
861 | NULL, /* ospf_apiserver_del_if */ | |
862 | NULL, /* ospf_apiserver_ism_change */ | |
863 | NULL, /* ospf_apiserver_nsm_change */ | |
864 | NULL, NULL, NULL, ospf_apiserver_show_info, originator_func, | |
865 | ospf_apiserver_lsa_refresher, | |
866 | NULL, /* ospf_apiserver_lsa_update */ | |
867 | NULL /* ospf_apiserver_lsa_delete */); | |
868 | ||
869 | if (rc != 0) { | |
870 | zlog_warn("Failed to register opaque type [%d/%d]", lsa_type, | |
871 | opaque_type); | |
872 | return OSPF_API_OPAQUETYPEINUSE; | |
873 | } | |
874 | ||
875 | /* Remember the opaque type that application registers so when | |
876 | connection shuts down, we can flush all LSAs of this opaque | |
877 | type. */ | |
878 | ||
879 | regtype = XCALLOC(MTYPE_OSPF_APISERVER, | |
880 | sizeof(struct registered_opaque_type)); | |
881 | regtype->lsa_type = lsa_type; | |
882 | regtype->opaque_type = opaque_type; | |
883 | ||
884 | /* Add to list of registered opaque types */ | |
885 | listnode_add(apiserv->opaque_types, regtype); | |
886 | ||
887 | if (IS_DEBUG_OSPF_EVENT) | |
888 | zlog_debug( | |
889 | "API: Add LSA-type(%d)/Opaque-type(%d) into" | |
890 | " apiserv(%p), total#(%d)", | |
891 | lsa_type, opaque_type, (void *)apiserv, | |
892 | listcount(apiserv->opaque_types)); | |
893 | ||
894 | return 0; | |
2d33f157 | 895 | } |
896 | ||
d62a17ae | 897 | int ospf_apiserver_unregister_opaque_type(struct ospf_apiserver *apiserv, |
d7c0a89a | 898 | uint8_t lsa_type, uint8_t opaque_type) |
2d33f157 | 899 | { |
d62a17ae | 900 | struct listnode *node, *nnode; |
901 | struct registered_opaque_type *regtype; | |
2d33f157 | 902 | |
d62a17ae | 903 | for (ALL_LIST_ELEMENTS(apiserv->opaque_types, node, nnode, regtype)) { |
904 | /* Check if we really registered this opaque type */ | |
905 | if (regtype->lsa_type == lsa_type | |
906 | && regtype->opaque_type == opaque_type) { | |
2d33f157 | 907 | |
d62a17ae | 908 | /* Yes, we registered this opaque type. Flush |
909 | all existing opaque LSAs of this type */ | |
2d33f157 | 910 | |
d62a17ae | 911 | ospf_apiserver_flush_opaque_lsa(apiserv, lsa_type, |
912 | opaque_type); | |
913 | ospf_delete_opaque_functab(lsa_type, opaque_type); | |
2d33f157 | 914 | |
d62a17ae | 915 | /* Remove from list of registered opaque types */ |
916 | listnode_delete(apiserv->opaque_types, regtype); | |
2d33f157 | 917 | |
d62a17ae | 918 | if (IS_DEBUG_OSPF_EVENT) |
919 | zlog_debug( | |
920 | "API: Del LSA-type(%d)/Opaque-type(%d)" | |
921 | " from apiserv(%p), total#(%d)", | |
922 | lsa_type, opaque_type, (void *)apiserv, | |
923 | listcount(apiserv->opaque_types)); | |
2d33f157 | 924 | |
d62a17ae | 925 | return 0; |
926 | } | |
2d33f157 | 927 | } |
2d33f157 | 928 | |
d62a17ae | 929 | /* Opaque type is not registered */ |
930 | zlog_warn("Failed to unregister opaque type [%d/%d]", lsa_type, | |
931 | opaque_type); | |
932 | return OSPF_API_OPAQUETYPENOTREGISTERED; | |
2d33f157 | 933 | } |
934 | ||
935 | ||
d62a17ae | 936 | static int apiserver_is_opaque_type_registered(struct ospf_apiserver *apiserv, |
d7c0a89a QY |
937 | uint8_t lsa_type, |
938 | uint8_t opaque_type) | |
2d33f157 | 939 | { |
d62a17ae | 940 | struct listnode *node, *nnode; |
941 | struct registered_opaque_type *regtype; | |
942 | ||
943 | /* XXX: how many types are there? if few, why not just a bitmap? */ | |
944 | for (ALL_LIST_ELEMENTS(apiserv->opaque_types, node, nnode, regtype)) { | |
945 | /* Check if we really registered this opaque type */ | |
946 | if (regtype->lsa_type == lsa_type | |
947 | && regtype->opaque_type == opaque_type) { | |
948 | /* Yes registered */ | |
949 | return 1; | |
950 | } | |
951 | } | |
952 | /* Not registered */ | |
953 | return 0; | |
2d33f157 | 954 | } |
955 | ||
d62a17ae | 956 | int ospf_apiserver_handle_register_opaque_type(struct ospf_apiserver *apiserv, |
957 | struct msg *msg) | |
2d33f157 | 958 | { |
d62a17ae | 959 | struct msg_register_opaque_type *rmsg; |
d7c0a89a QY |
960 | uint8_t lsa_type; |
961 | uint8_t opaque_type; | |
d62a17ae | 962 | int rc = 0; |
963 | ||
964 | /* Extract parameters from register opaque type message */ | |
965 | rmsg = (struct msg_register_opaque_type *)STREAM_DATA(msg->s); | |
966 | ||
967 | lsa_type = rmsg->lsatype; | |
968 | opaque_type = rmsg->opaquetype; | |
969 | ||
970 | rc = ospf_apiserver_register_opaque_type(apiserv, lsa_type, | |
971 | opaque_type); | |
972 | ||
973 | /* Send a reply back to client including return code */ | |
974 | rc = ospf_apiserver_send_reply(apiserv, ntohl(msg->hdr.msgseq), rc); | |
975 | if (rc < 0) | |
976 | goto out; | |
977 | ||
978 | /* Now inform application about opaque types that are ready */ | |
979 | switch (lsa_type) { | |
980 | case OSPF_OPAQUE_LINK_LSA: | |
981 | ospf_apiserver_notify_ready_type9(apiserv); | |
982 | break; | |
983 | case OSPF_OPAQUE_AREA_LSA: | |
984 | ospf_apiserver_notify_ready_type10(apiserv); | |
985 | break; | |
986 | case OSPF_OPAQUE_AS_LSA: | |
987 | ospf_apiserver_notify_ready_type11(apiserv); | |
988 | break; | |
989 | } | |
2d33f157 | 990 | out: |
d62a17ae | 991 | return rc; |
2d33f157 | 992 | } |
993 | ||
994 | ||
995 | /* Notify specific client about all opaque types 9 that are ready. */ | |
d62a17ae | 996 | void ospf_apiserver_notify_ready_type9(struct ospf_apiserver *apiserv) |
2d33f157 | 997 | { |
d62a17ae | 998 | struct listnode *node, *nnode; |
999 | struct listnode *node2, *nnode2; | |
1000 | struct ospf *ospf; | |
1001 | struct ospf_interface *oi; | |
1002 | struct registered_opaque_type *r; | |
1003 | ||
b5a8894d | 1004 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1005 | |
1006 | for (ALL_LIST_ELEMENTS(ospf->oiflist, node, nnode, oi)) { | |
1007 | /* Check if this interface is indeed ready for type 9 */ | |
1008 | if (!ospf_apiserver_is_ready_type9(oi)) | |
1009 | continue; | |
1010 | ||
1011 | /* Check for registered opaque type 9 types */ | |
1012 | /* XXX: loop-de-loop - optimise me */ | |
1013 | for (ALL_LIST_ELEMENTS(apiserv->opaque_types, node2, nnode2, | |
1014 | r)) { | |
1015 | struct msg *msg; | |
1016 | ||
1017 | if (r->lsa_type == OSPF_OPAQUE_LINK_LSA) { | |
1018 | ||
1019 | /* Yes, this opaque type is ready */ | |
1020 | msg = new_msg_ready_notify( | |
1021 | 0, OSPF_OPAQUE_LINK_LSA, r->opaque_type, | |
1022 | oi->address->u.prefix4); | |
1023 | if (!msg) { | |
1024 | zlog_warn( | |
1025 | "apiserver_notify_ready_type9: msg_new failed"); | |
2d33f157 | 1026 | #ifdef NOTYET |
d62a17ae | 1027 | /* Cannot allocate new message. What |
1028 | * should we do? */ | |
1029 | ospf_apiserver_free(apiserv); | |
2d33f157 | 1030 | #endif |
d62a17ae | 1031 | goto out; |
1032 | } | |
1033 | ospf_apiserver_send_msg(apiserv, msg); | |
1034 | msg_free(msg); | |
1035 | } | |
2d33f157 | 1036 | } |
2d33f157 | 1037 | } |
2d33f157 | 1038 | |
1039 | out: | |
d62a17ae | 1040 | return; |
2d33f157 | 1041 | } |
1042 | ||
1043 | ||
1044 | /* Notify specific client about all opaque types 10 that are ready. */ | |
d62a17ae | 1045 | void ospf_apiserver_notify_ready_type10(struct ospf_apiserver *apiserv) |
2d33f157 | 1046 | { |
d62a17ae | 1047 | struct listnode *node, *nnode; |
1048 | struct listnode *node2, *nnode2; | |
1049 | struct ospf *ospf; | |
1050 | struct ospf_area *area; | |
1051 | ||
b5a8894d | 1052 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1053 | |
1054 | for (ALL_LIST_ELEMENTS(ospf->areas, node, nnode, area)) { | |
1055 | struct registered_opaque_type *r; | |
1056 | ||
1057 | if (!ospf_apiserver_is_ready_type10(area)) { | |
1058 | continue; | |
1059 | } | |
1060 | ||
1061 | /* Check for registered opaque type 10 types */ | |
1062 | /* XXX: loop in loop - optimise me */ | |
1063 | for (ALL_LIST_ELEMENTS(apiserv->opaque_types, node2, nnode2, | |
1064 | r)) { | |
1065 | struct msg *msg; | |
1066 | ||
1067 | if (r->lsa_type == OSPF_OPAQUE_AREA_LSA) { | |
1068 | /* Yes, this opaque type is ready */ | |
1069 | msg = new_msg_ready_notify( | |
1070 | 0, OSPF_OPAQUE_AREA_LSA, r->opaque_type, | |
1071 | area->area_id); | |
1072 | if (!msg) { | |
1073 | zlog_warn( | |
1074 | "apiserver_notify_ready_type10: msg_new failed"); | |
2d33f157 | 1075 | #ifdef NOTYET |
d62a17ae | 1076 | /* Cannot allocate new message. What |
1077 | * should we do? */ | |
1078 | ospf_apiserver_free(apiserv); | |
2d33f157 | 1079 | #endif |
d62a17ae | 1080 | goto out; |
1081 | } | |
1082 | ospf_apiserver_send_msg(apiserv, msg); | |
1083 | msg_free(msg); | |
1084 | } | |
2d33f157 | 1085 | } |
2d33f157 | 1086 | } |
2d33f157 | 1087 | |
1088 | out: | |
d62a17ae | 1089 | return; |
2d33f157 | 1090 | } |
1091 | ||
1092 | /* Notify specific client about all opaque types 11 that are ready */ | |
d62a17ae | 1093 | void ospf_apiserver_notify_ready_type11(struct ospf_apiserver *apiserv) |
2d33f157 | 1094 | { |
d62a17ae | 1095 | struct listnode *node, *nnode; |
1096 | struct ospf *ospf; | |
1097 | struct registered_opaque_type *r; | |
1098 | ||
b5a8894d | 1099 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1100 | |
1101 | /* Can type 11 be originated? */ | |
1102 | if (!ospf_apiserver_is_ready_type11(ospf)) | |
1103 | goto out; | |
1104 | ||
1105 | /* Check for registered opaque type 11 types */ | |
1106 | for (ALL_LIST_ELEMENTS(apiserv->opaque_types, node, nnode, r)) { | |
1107 | struct msg *msg; | |
1108 | struct in_addr noarea_id = {.s_addr = 0L}; | |
1109 | ||
1110 | if (r->lsa_type == OSPF_OPAQUE_AS_LSA) { | |
1111 | /* Yes, this opaque type is ready */ | |
1112 | msg = new_msg_ready_notify(0, OSPF_OPAQUE_AS_LSA, | |
1113 | r->opaque_type, noarea_id); | |
1114 | ||
1115 | if (!msg) { | |
1116 | zlog_warn( | |
1117 | "apiserver_notify_ready_type11: msg_new failed"); | |
2d33f157 | 1118 | #ifdef NOTYET |
d62a17ae | 1119 | /* Cannot allocate new message. What should we |
1120 | * do? */ | |
1121 | ospf_apiserver_free(apiserv); | |
2d33f157 | 1122 | #endif |
d62a17ae | 1123 | goto out; |
1124 | } | |
1125 | ospf_apiserver_send_msg(apiserv, msg); | |
1126 | msg_free(msg); | |
1127 | } | |
2d33f157 | 1128 | } |
2d33f157 | 1129 | |
1130 | out: | |
d62a17ae | 1131 | return; |
2d33f157 | 1132 | } |
1133 | ||
d62a17ae | 1134 | int ospf_apiserver_handle_unregister_opaque_type(struct ospf_apiserver *apiserv, |
1135 | struct msg *msg) | |
2d33f157 | 1136 | { |
d62a17ae | 1137 | struct msg_unregister_opaque_type *umsg; |
d7c0a89a QY |
1138 | uint8_t ltype; |
1139 | uint8_t otype; | |
d62a17ae | 1140 | int rc = 0; |
2d33f157 | 1141 | |
d62a17ae | 1142 | /* Extract parameters from unregister opaque type message */ |
1143 | umsg = (struct msg_unregister_opaque_type *)STREAM_DATA(msg->s); | |
2d33f157 | 1144 | |
d62a17ae | 1145 | ltype = umsg->lsatype; |
1146 | otype = umsg->opaquetype; | |
2d33f157 | 1147 | |
d62a17ae | 1148 | rc = ospf_apiserver_unregister_opaque_type(apiserv, ltype, otype); |
2d33f157 | 1149 | |
d62a17ae | 1150 | /* Send a reply back to client including return code */ |
1151 | rc = ospf_apiserver_send_reply(apiserv, ntohl(msg->hdr.msgseq), rc); | |
2d33f157 | 1152 | |
d62a17ae | 1153 | return rc; |
2d33f157 | 1154 | } |
1155 | ||
1156 | ||
1157 | /* ----------------------------------------------------------- | |
1158 | * Following are functions for event (filter) registration. | |
1159 | * ----------------------------------------------------------- | |
1160 | */ | |
d62a17ae | 1161 | int ospf_apiserver_handle_register_event(struct ospf_apiserver *apiserv, |
1162 | struct msg *msg) | |
2d33f157 | 1163 | { |
d62a17ae | 1164 | struct msg_register_event *rmsg; |
1165 | int rc; | |
d7c0a89a | 1166 | uint32_t seqnum; |
d62a17ae | 1167 | |
1168 | rmsg = (struct msg_register_event *)STREAM_DATA(msg->s); | |
1169 | ||
1170 | /* Get request sequence number */ | |
1171 | seqnum = msg_get_seq(msg); | |
1172 | ||
1173 | /* Free existing filter in apiserv. */ | |
1174 | XFREE(MTYPE_OSPF_APISERVER_MSGFILTER, apiserv->filter); | |
1175 | /* Alloc new space for filter. */ | |
1176 | ||
1177 | apiserv->filter = | |
1178 | XMALLOC(MTYPE_OSPF_APISERVER_MSGFILTER, ntohs(msg->hdr.msglen)); | |
1179 | if (apiserv->filter) { | |
1180 | /* copy it over. */ | |
1181 | memcpy(apiserv->filter, &rmsg->filter, ntohs(msg->hdr.msglen)); | |
1182 | rc = OSPF_API_OK; | |
1183 | } else { | |
1184 | rc = OSPF_API_NOMEMORY; | |
1185 | } | |
1186 | /* Send a reply back to client with return code */ | |
1187 | rc = ospf_apiserver_send_reply(apiserv, seqnum, rc); | |
1188 | return rc; | |
2d33f157 | 1189 | } |
1190 | ||
1191 | ||
1192 | /* ----------------------------------------------------------- | |
1193 | * Followings are functions for LSDB synchronization. | |
1194 | * ----------------------------------------------------------- | |
1195 | */ | |
1196 | ||
d62a17ae | 1197 | static int apiserver_sync_callback(struct ospf_lsa *lsa, void *p_arg, |
1198 | int int_arg) | |
2d33f157 | 1199 | { |
d62a17ae | 1200 | struct ospf_apiserver *apiserv; |
1201 | int seqnum; | |
1202 | struct msg *msg; | |
1203 | struct param_t { | |
1204 | struct ospf_apiserver *apiserv; | |
1205 | struct lsa_filter_type *filter; | |
1206 | } * param; | |
1207 | int rc = -1; | |
1208 | ||
1209 | /* Sanity check */ | |
1210 | assert(lsa->data); | |
1211 | assert(p_arg); | |
1212 | ||
1213 | param = (struct param_t *)p_arg; | |
1214 | apiserv = param->apiserv; | |
d7c0a89a | 1215 | seqnum = (uint32_t)int_arg; |
d62a17ae | 1216 | |
1217 | /* Check origin in filter. */ | |
1218 | if ((param->filter->origin == ANY_ORIGIN) | |
1219 | || (param->filter->origin == (lsa->flags & OSPF_LSA_SELF))) { | |
1220 | ||
1221 | /* Default area for AS-External and Opaque11 LSAs */ | |
1222 | struct in_addr area_id = {.s_addr = 0L}; | |
1223 | ||
1224 | /* Default interface for non Opaque9 LSAs */ | |
1225 | struct in_addr ifaddr = {.s_addr = 0L}; | |
1226 | ||
1227 | if (lsa->area) { | |
1228 | area_id = lsa->area->area_id; | |
1229 | } | |
1230 | if (lsa->data->type == OSPF_OPAQUE_LINK_LSA) { | |
1231 | ifaddr = lsa->oi->address->u.prefix4; | |
1232 | } | |
1233 | ||
1234 | msg = new_msg_lsa_change_notify( | |
1235 | MSG_LSA_UPDATE_NOTIFY, seqnum, ifaddr, area_id, | |
1236 | lsa->flags & OSPF_LSA_SELF, lsa->data); | |
1237 | if (!msg) { | |
1238 | zlog_warn( | |
1239 | "apiserver_sync_callback: new_msg_update failed"); | |
2d33f157 | 1240 | #ifdef NOTYET |
9d303b37 DL |
1241 | /* Cannot allocate new message. What should we do? */ |
1242 | /* ospf_apiserver_free (apiserv);*/ /* Do nothing | |
1243 | here XXX | |
1244 | */ | |
2d33f157 | 1245 | #endif |
d62a17ae | 1246 | goto out; |
1247 | } | |
2d33f157 | 1248 | |
d62a17ae | 1249 | /* Send LSA */ |
1250 | ospf_apiserver_send_msg(apiserv, msg); | |
1251 | msg_free(msg); | |
1252 | } | |
1253 | rc = 0; | |
2d33f157 | 1254 | |
1255 | out: | |
d62a17ae | 1256 | return rc; |
2d33f157 | 1257 | } |
1258 | ||
d62a17ae | 1259 | int ospf_apiserver_handle_sync_lsdb(struct ospf_apiserver *apiserv, |
1260 | struct msg *msg) | |
2d33f157 | 1261 | { |
d62a17ae | 1262 | struct listnode *node, *nnode; |
d7c0a89a | 1263 | uint32_t seqnum; |
d62a17ae | 1264 | int rc = 0; |
1265 | struct msg_sync_lsdb *smsg; | |
1266 | struct ospf_apiserver_param_t { | |
1267 | struct ospf_apiserver *apiserv; | |
1268 | struct lsa_filter_type *filter; | |
1269 | } param; | |
d7c0a89a | 1270 | uint16_t mask; |
d62a17ae | 1271 | struct route_node *rn; |
1272 | struct ospf_lsa *lsa; | |
1273 | struct ospf *ospf; | |
1274 | struct ospf_area *area; | |
1275 | ||
b5a8894d | 1276 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1277 | |
1278 | /* Get request sequence number */ | |
1279 | seqnum = msg_get_seq(msg); | |
1280 | /* Set sync msg. */ | |
1281 | smsg = (struct msg_sync_lsdb *)STREAM_DATA(msg->s); | |
1282 | ||
1283 | /* Set parameter struct. */ | |
1284 | param.apiserv = apiserv; | |
1285 | param.filter = &smsg->filter; | |
1286 | ||
1287 | /* Remember mask. */ | |
1288 | mask = ntohs(smsg->filter.typemask); | |
1289 | ||
1290 | /* Iterate over all areas. */ | |
1291 | for (ALL_LIST_ELEMENTS(ospf->areas, node, nnode, area)) { | |
1292 | int i; | |
d7c0a89a | 1293 | uint32_t *area_id = NULL; |
d62a17ae | 1294 | |
1295 | /* Compare area_id with area_ids in sync request. */ | |
1296 | if ((i = smsg->filter.num_areas) > 0) { | |
1297 | /* Let area_id point to the list of area IDs, | |
1298 | * which is at the end of smsg->filter. */ | |
d7c0a89a | 1299 | area_id = (uint32_t *)(&smsg->filter + 1); |
d62a17ae | 1300 | while (i) { |
1301 | if (*area_id == area->area_id.s_addr) { | |
1302 | break; | |
1303 | } | |
1304 | i--; | |
1305 | area_id++; | |
1306 | } | |
1307 | } else { | |
1308 | i = 1; | |
1309 | } | |
1310 | ||
1311 | /* If area was found, then i>0 here. */ | |
1312 | if (i) { | |
1313 | /* Check msg type. */ | |
1314 | if (mask & Power2[OSPF_ROUTER_LSA]) | |
996c9314 | 1315 | LSDB_LOOP (ROUTER_LSDB(area), rn, lsa) |
044506e7 DS |
1316 | apiserver_sync_callback( |
1317 | lsa, (void *)¶m, seqnum); | |
d62a17ae | 1318 | if (mask & Power2[OSPF_NETWORK_LSA]) |
996c9314 | 1319 | LSDB_LOOP (NETWORK_LSDB(area), rn, lsa) |
044506e7 DS |
1320 | apiserver_sync_callback( |
1321 | lsa, (void *)¶m, seqnum); | |
d62a17ae | 1322 | if (mask & Power2[OSPF_SUMMARY_LSA]) |
996c9314 | 1323 | LSDB_LOOP (SUMMARY_LSDB(area), rn, lsa) |
044506e7 DS |
1324 | apiserver_sync_callback( |
1325 | lsa, (void *)¶m, seqnum); | |
d62a17ae | 1326 | if (mask & Power2[OSPF_ASBR_SUMMARY_LSA]) |
996c9314 | 1327 | LSDB_LOOP (ASBR_SUMMARY_LSDB(area), rn, lsa) |
044506e7 DS |
1328 | apiserver_sync_callback( |
1329 | lsa, (void *)¶m, seqnum); | |
d62a17ae | 1330 | if (mask & Power2[OSPF_OPAQUE_LINK_LSA]) |
996c9314 | 1331 | LSDB_LOOP (OPAQUE_LINK_LSDB(area), rn, lsa) |
044506e7 DS |
1332 | apiserver_sync_callback( |
1333 | lsa, (void *)¶m, seqnum); | |
d62a17ae | 1334 | if (mask & Power2[OSPF_OPAQUE_AREA_LSA]) |
996c9314 | 1335 | LSDB_LOOP (OPAQUE_AREA_LSDB(area), rn, lsa) |
044506e7 DS |
1336 | apiserver_sync_callback( |
1337 | lsa, (void *)¶m, seqnum); | |
2d33f157 | 1338 | } |
d62a17ae | 1339 | } |
1340 | ||
1341 | /* For AS-external LSAs */ | |
1342 | if (ospf->lsdb) { | |
1343 | if (mask & Power2[OSPF_AS_EXTERNAL_LSA]) | |
996c9314 | 1344 | LSDB_LOOP (EXTERNAL_LSDB(ospf), rn, lsa) |
044506e7 DS |
1345 | apiserver_sync_callback(lsa, (void *)¶m, |
1346 | seqnum); | |
d62a17ae | 1347 | } |
1348 | ||
1349 | /* For AS-external opaque LSAs */ | |
1350 | if (ospf->lsdb) { | |
1351 | if (mask & Power2[OSPF_OPAQUE_AS_LSA]) | |
996c9314 | 1352 | LSDB_LOOP (OPAQUE_AS_LSDB(ospf), rn, lsa) |
044506e7 DS |
1353 | apiserver_sync_callback(lsa, (void *)¶m, |
1354 | seqnum); | |
d62a17ae | 1355 | } |
1356 | ||
1357 | /* Send a reply back to client with return code */ | |
1358 | rc = ospf_apiserver_send_reply(apiserv, seqnum, rc); | |
1359 | return rc; | |
2d33f157 | 1360 | } |
1361 | ||
1362 | ||
1363 | /* ----------------------------------------------------------- | |
1364 | * Followings are functions to originate or update LSA | |
1365 | * from an application. | |
1366 | * ----------------------------------------------------------- | |
1367 | */ | |
1368 | ||
1369 | /* Create a new internal opaque LSA by taking prototype and filling in | |
1370 | missing fields such as age, sequence number, advertising router, | |
1371 | checksum and so on. The interface parameter is used for type 9 | |
1372 | LSAs, area parameter for type 10. Type 11 LSAs do neither need area | |
1373 | nor interface. */ | |
1374 | ||
d62a17ae | 1375 | struct ospf_lsa *ospf_apiserver_opaque_lsa_new(struct ospf_area *area, |
1376 | struct ospf_interface *oi, | |
1377 | struct lsa_header *protolsa) | |
2d33f157 | 1378 | { |
d62a17ae | 1379 | struct stream *s; |
1380 | struct lsa_header *newlsa; | |
1381 | struct ospf_lsa *new = NULL; | |
d7c0a89a QY |
1382 | uint8_t options = 0x0; |
1383 | uint16_t length; | |
d62a17ae | 1384 | |
1385 | struct ospf *ospf; | |
1386 | ||
c0f3f7cd | 1387 | if (oi && oi->ospf) |
0d31e63e CS |
1388 | ospf = oi->ospf; |
1389 | else | |
1390 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); | |
1391 | ||
d62a17ae | 1392 | assert(ospf); |
1393 | ||
1394 | /* Create a stream for internal opaque LSA */ | |
1395 | if ((s = stream_new(OSPF_MAX_LSA_SIZE)) == NULL) { | |
1396 | zlog_warn("ospf_apiserver_opaque_lsa_new: stream_new failed"); | |
1397 | return NULL; | |
1398 | } | |
1399 | ||
1400 | newlsa = (struct lsa_header *)STREAM_DATA(s); | |
1401 | ||
1402 | /* XXX If this is a link-local LSA or an AS-external LSA, how do we | |
1403 | have to set options? */ | |
1404 | ||
1405 | if (area) { | |
1406 | options = LSA_OPTIONS_GET(area); | |
1407 | options |= LSA_OPTIONS_NSSA_GET(area); | |
1408 | } | |
1409 | ||
1410 | options |= OSPF_OPTION_O; /* Don't forget to set option bit */ | |
1411 | ||
1412 | if (IS_DEBUG_OSPF(lsa, LSA_GENERATE)) { | |
1413 | zlog_debug("LSA[Type%d:%s]: Creating an Opaque-LSA instance", | |
1414 | protolsa->type, inet_ntoa(protolsa->id)); | |
1415 | } | |
1416 | ||
1417 | /* Set opaque-LSA header fields. */ | |
1418 | lsa_header_set(s, options, protolsa->type, protolsa->id, | |
1419 | ospf->router_id); | |
1420 | ||
1421 | /* Set opaque-LSA body fields. */ | |
d7c0a89a | 1422 | stream_put(s, ((uint8_t *)protolsa) + sizeof(struct lsa_header), |
d62a17ae | 1423 | ntohs(protolsa->length) - sizeof(struct lsa_header)); |
1424 | ||
1425 | /* Determine length of LSA. */ | |
1426 | length = stream_get_endp(s); | |
1427 | newlsa->length = htons(length); | |
1428 | ||
1429 | /* Create OSPF LSA. */ | |
1430 | if ((new = ospf_lsa_new()) == NULL) { | |
1431 | zlog_warn("ospf_apiserver_opaque_lsa_new: ospf_lsa_new() ?"); | |
1432 | stream_free(s); | |
1433 | return NULL; | |
1434 | } | |
1435 | ||
1436 | if ((new->data = ospf_lsa_data_new(length)) == NULL) { | |
1437 | zlog_warn( | |
1438 | "ospf_apiserver_opaque_lsa_new: ospf_lsa_data_new() ?"); | |
1439 | ospf_lsa_unlock(&new); | |
1440 | stream_free(s); | |
1441 | return NULL; | |
1442 | } | |
1443 | ||
1444 | new->area = area; | |
1445 | new->oi = oi; | |
0d31e63e | 1446 | new->vrf_id = ospf->vrf_id; |
d62a17ae | 1447 | |
1448 | SET_FLAG(new->flags, OSPF_LSA_SELF); | |
1449 | memcpy(new->data, newlsa, length); | |
1450 | stream_free(s); | |
1451 | ||
1452 | return new; | |
2d33f157 | 1453 | } |
1454 | ||
1455 | ||
d62a17ae | 1456 | int ospf_apiserver_is_ready_type9(struct ospf_interface *oi) |
2d33f157 | 1457 | { |
d62a17ae | 1458 | /* Type 9 opaque LSA can be originated if there is at least one |
1459 | active opaque-capable neighbor attached to the outgoing | |
1460 | interface. */ | |
2d33f157 | 1461 | |
d62a17ae | 1462 | return (ospf_nbr_count_opaque_capable(oi) > 0); |
2d33f157 | 1463 | } |
1464 | ||
d62a17ae | 1465 | int ospf_apiserver_is_ready_type10(struct ospf_area *area) |
2d33f157 | 1466 | { |
d62a17ae | 1467 | /* Type 10 opaque LSA can be originated if there is at least one |
1468 | interface belonging to the area that has an active opaque-capable | |
1469 | neighbor. */ | |
1470 | struct listnode *node, *nnode; | |
1471 | struct ospf_interface *oi; | |
1472 | ||
1473 | for (ALL_LIST_ELEMENTS(area->oiflist, node, nnode, oi)) | |
1474 | /* Is there an active neighbor attached to this interface? */ | |
1475 | if (ospf_apiserver_is_ready_type9(oi)) | |
1476 | return 1; | |
1477 | ||
1478 | /* No active neighbor in area */ | |
1479 | return 0; | |
2d33f157 | 1480 | } |
1481 | ||
d62a17ae | 1482 | int ospf_apiserver_is_ready_type11(struct ospf *ospf) |
2d33f157 | 1483 | { |
d62a17ae | 1484 | /* Type 11 opaque LSA can be originated if there is at least one |
1485 | interface | |
1486 | that has an active opaque-capable neighbor. */ | |
1487 | struct listnode *node, *nnode; | |
1488 | struct ospf_interface *oi; | |
1489 | ||
1490 | for (ALL_LIST_ELEMENTS(ospf->oiflist, node, nnode, oi)) | |
1491 | /* Is there an active neighbor attached to this interface? */ | |
1492 | if (ospf_apiserver_is_ready_type9(oi)) | |
1493 | return 1; | |
1494 | ||
1495 | /* No active neighbor at all */ | |
1496 | return 0; | |
2d33f157 | 1497 | } |
1498 | ||
1499 | ||
d62a17ae | 1500 | int ospf_apiserver_handle_originate_request(struct ospf_apiserver *apiserv, |
1501 | struct msg *msg) | |
2d33f157 | 1502 | { |
d62a17ae | 1503 | struct msg_originate_request *omsg; |
1504 | struct lsa_header *data; | |
1505 | struct ospf_lsa *new; | |
1506 | struct ospf_lsa *old; | |
1507 | struct ospf_area *area = NULL; | |
1508 | struct ospf_interface *oi = NULL; | |
1509 | struct ospf_lsdb *lsdb = NULL; | |
1510 | struct ospf *ospf; | |
1511 | int lsa_type, opaque_type; | |
1512 | int ready = 0; | |
1513 | int rc = 0; | |
1514 | ||
b5a8894d | 1515 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1516 | |
1517 | /* Extract opaque LSA data from message */ | |
1518 | omsg = (struct msg_originate_request *)STREAM_DATA(msg->s); | |
1519 | data = &omsg->data; | |
1520 | ||
1521 | /* Determine interface for type9 or area for type10 LSAs. */ | |
1522 | switch (data->type) { | |
1523 | case OSPF_OPAQUE_LINK_LSA: | |
1524 | oi = ospf_apiserver_if_lookup_by_addr(omsg->ifaddr); | |
1525 | if (!oi) { | |
1526 | zlog_warn("apiserver_originate: unknown interface %s", | |
1527 | inet_ntoa(omsg->ifaddr)); | |
1528 | rc = OSPF_API_NOSUCHINTERFACE; | |
1529 | goto out; | |
1530 | } | |
1531 | area = oi->area; | |
1532 | lsdb = area->lsdb; | |
1533 | break; | |
1534 | case OSPF_OPAQUE_AREA_LSA: | |
1535 | area = ospf_area_lookup_by_area_id(ospf, omsg->area_id); | |
1536 | if (!area) { | |
1537 | zlog_warn("apiserver_originate: unknown area %s", | |
1538 | inet_ntoa(omsg->area_id)); | |
1539 | rc = OSPF_API_NOSUCHAREA; | |
1540 | goto out; | |
1541 | } | |
1542 | lsdb = area->lsdb; | |
1543 | break; | |
1544 | case OSPF_OPAQUE_AS_LSA: | |
1545 | lsdb = ospf->lsdb; | |
1546 | break; | |
1547 | default: | |
1548 | /* We can only handle opaque types here */ | |
1549 | zlog_warn( | |
1550 | "apiserver_originate: Cannot originate non-opaque LSA type %d", | |
1551 | data->type); | |
1552 | rc = OSPF_API_ILLEGALLSATYPE; | |
1553 | goto out; | |
1554 | } | |
1555 | ||
1556 | /* Check if we registered this opaque type */ | |
1557 | lsa_type = data->type; | |
1558 | opaque_type = GET_OPAQUE_TYPE(ntohl(data->id.s_addr)); | |
1559 | ||
1560 | if (!apiserver_is_opaque_type_registered(apiserv, lsa_type, | |
1561 | opaque_type)) { | |
1562 | zlog_warn( | |
1563 | "apiserver_originate: LSA-type(%d)/Opaque-type(%d): Not registered", | |
1564 | lsa_type, opaque_type); | |
1565 | rc = OSPF_API_OPAQUETYPENOTREGISTERED; | |
1566 | goto out; | |
1567 | } | |
1568 | ||
1569 | /* Make sure that the neighbors are ready before we can originate */ | |
1570 | switch (data->type) { | |
1571 | case OSPF_OPAQUE_LINK_LSA: | |
1572 | ready = ospf_apiserver_is_ready_type9(oi); | |
1573 | break; | |
1574 | case OSPF_OPAQUE_AREA_LSA: | |
1575 | ready = ospf_apiserver_is_ready_type10(area); | |
1576 | break; | |
1577 | case OSPF_OPAQUE_AS_LSA: | |
1578 | ready = ospf_apiserver_is_ready_type11(ospf); | |
1579 | break; | |
1580 | default: | |
1581 | break; | |
1582 | } | |
1583 | ||
1584 | if (!ready) { | |
1585 | zlog_warn("Neighbors not ready to originate type %d", | |
1586 | data->type); | |
1587 | rc = OSPF_API_NOTREADY; | |
1588 | goto out; | |
1589 | } | |
1590 | ||
1591 | /* Create OSPF's internal opaque LSA representation */ | |
1592 | new = ospf_apiserver_opaque_lsa_new(area, oi, data); | |
1593 | if (!new) { | |
1594 | rc = OSPF_API_NOMEMORY; /* XXX */ | |
1595 | goto out; | |
1596 | } | |
1597 | ||
1598 | /* Determine if LSA is new or an update for an existing one. */ | |
1599 | old = ospf_lsdb_lookup(lsdb, new); | |
1600 | ||
1601 | if (!old) { | |
1602 | /* New LSA install in LSDB. */ | |
1603 | rc = ospf_apiserver_originate1(new); | |
1604 | } else { | |
1605 | /* | |
1606 | * Keep the new LSA instance in the "waiting place" until the | |
1607 | * next | |
1608 | * refresh timing. If several LSA update requests for the same | |
1609 | * LSID | |
1610 | * have issued by peer, the last one takes effect. | |
1611 | */ | |
1612 | new->lsdb = &apiserv->reserve; | |
1613 | ospf_lsdb_add(&apiserv->reserve, new); | |
1614 | ||
1615 | /* Kick the scheduler function. */ | |
1616 | ospf_opaque_lsa_refresh_schedule(old); | |
1617 | } | |
2d33f157 | 1618 | |
1619 | out: | |
1620 | ||
d62a17ae | 1621 | /* Send a reply back to client with return code */ |
1622 | rc = ospf_apiserver_send_reply(apiserv, ntohl(msg->hdr.msgseq), rc); | |
1623 | return rc; | |
2d33f157 | 1624 | } |
1625 | ||
1626 | ||
1627 | /* ----------------------------------------------------------- | |
d62a17ae | 1628 | * Flood an LSA within its flooding scope. |
2d33f157 | 1629 | * ----------------------------------------------------------- |
1630 | */ | |
1631 | ||
1632 | /* XXX We can probably use ospf_flood_through instead of this function | |
d62a17ae | 1633 | but then we need the neighbor parameter. If we set nbr to |
2d33f157 | 1634 | NULL then ospf_flood_through crashes due to dereferencing NULL. */ |
1635 | ||
d62a17ae | 1636 | void ospf_apiserver_flood_opaque_lsa(struct ospf_lsa *lsa) |
2d33f157 | 1637 | { |
d62a17ae | 1638 | assert(lsa); |
1639 | ||
1640 | switch (lsa->data->type) { | |
1641 | case OSPF_OPAQUE_LINK_LSA: | |
1642 | /* Increment counters? XXX */ | |
1643 | ||
1644 | /* Flood LSA through local network. */ | |
1645 | ospf_flood_through_area(lsa->area, NULL /*nbr */, lsa); | |
1646 | break; | |
1647 | case OSPF_OPAQUE_AREA_LSA: | |
1648 | /* Update LSA origination count. */ | |
1649 | assert(lsa->area); | |
1650 | lsa->area->ospf->lsa_originate_count++; | |
1651 | ||
1652 | /* Flood LSA through area. */ | |
1653 | ospf_flood_through_area(lsa->area, NULL /*nbr */, lsa); | |
1654 | break; | |
1655 | case OSPF_OPAQUE_AS_LSA: { | |
1656 | struct ospf *ospf; | |
1657 | ||
b5a8894d | 1658 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1659 | assert(ospf); |
1660 | ||
1661 | /* Increment counters? XXX */ | |
1662 | ||
1663 | /* Flood LSA through AS. */ | |
1664 | ospf_flood_through_as(ospf, NULL /*nbr */, lsa); | |
1665 | break; | |
1666 | } | |
1667 | } | |
2d33f157 | 1668 | } |
1669 | ||
d62a17ae | 1670 | int ospf_apiserver_originate1(struct ospf_lsa *lsa) |
2d33f157 | 1671 | { |
d62a17ae | 1672 | struct ospf *ospf; |
99b7c5d6 | 1673 | |
b5a8894d | 1674 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1675 | assert(ospf); |
99b7c5d6 | 1676 | |
d62a17ae | 1677 | /* Install this LSA into LSDB. */ |
1678 | if (ospf_lsa_install(ospf, lsa->oi, lsa) == NULL) { | |
1679 | zlog_warn("ospf_apiserver_originate1: ospf_lsa_install failed"); | |
1680 | return -1; | |
1681 | } | |
2d33f157 | 1682 | |
d62a17ae | 1683 | /* Flood LSA within scope */ |
2d33f157 | 1684 | |
1685 | #ifdef NOTYET | |
d62a17ae | 1686 | /* |
1687 | * NB: Modified version of "ospf_flood_though ()" accepts NULL "inbr" | |
1688 | * parameter, and thus it does not cause SIGSEGV error. | |
1689 | */ | |
1690 | ospf_flood_through(NULL /*nbr */, lsa); | |
1691 | #else /* NOTYET */ | |
1692 | ||
1693 | ospf_apiserver_flood_opaque_lsa(lsa); | |
2d33f157 | 1694 | #endif /* NOTYET */ |
1695 | ||
d62a17ae | 1696 | return 0; |
2d33f157 | 1697 | } |
1698 | ||
1699 | ||
1700 | /* Opaque LSAs of type 9 on a specific interface can now be | |
1701 | originated. Tell clients that registered type 9. */ | |
d62a17ae | 1702 | int ospf_apiserver_lsa9_originator(void *arg) |
2d33f157 | 1703 | { |
d62a17ae | 1704 | struct ospf_interface *oi; |
2d33f157 | 1705 | |
d62a17ae | 1706 | oi = (struct ospf_interface *)arg; |
1707 | if (listcount(apiserver_list) > 0) { | |
1708 | ospf_apiserver_clients_notify_ready_type9(oi); | |
1709 | } | |
1710 | return 0; | |
2d33f157 | 1711 | } |
1712 | ||
d62a17ae | 1713 | int ospf_apiserver_lsa10_originator(void *arg) |
2d33f157 | 1714 | { |
d62a17ae | 1715 | struct ospf_area *area; |
2d33f157 | 1716 | |
d62a17ae | 1717 | area = (struct ospf_area *)arg; |
1718 | if (listcount(apiserver_list) > 0) { | |
1719 | ospf_apiserver_clients_notify_ready_type10(area); | |
1720 | } | |
1721 | return 0; | |
2d33f157 | 1722 | } |
1723 | ||
d62a17ae | 1724 | int ospf_apiserver_lsa11_originator(void *arg) |
2d33f157 | 1725 | { |
d62a17ae | 1726 | struct ospf *ospf; |
2d33f157 | 1727 | |
d62a17ae | 1728 | ospf = (struct ospf *)arg; |
1729 | if (listcount(apiserver_list) > 0) { | |
1730 | ospf_apiserver_clients_notify_ready_type11(ospf); | |
1731 | } | |
1732 | return 0; | |
2d33f157 | 1733 | } |
1734 | ||
1735 | ||
1736 | /* Periodically refresh opaque LSAs so that they do not expire in | |
1737 | other routers. */ | |
d62a17ae | 1738 | struct ospf_lsa *ospf_apiserver_lsa_refresher(struct ospf_lsa *lsa) |
2d33f157 | 1739 | { |
d62a17ae | 1740 | struct ospf_apiserver *apiserv; |
1741 | struct ospf_lsa *new = NULL; | |
1742 | struct ospf *ospf; | |
1743 | ||
b5a8894d | 1744 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1745 | assert(ospf); |
1746 | ||
1747 | apiserv = lookup_apiserver_by_lsa(lsa); | |
1748 | if (!apiserv) { | |
1749 | zlog_warn( | |
1750 | "ospf_apiserver_lsa_refresher: LSA[%s]: No apiserver?", | |
1751 | dump_lsa_key(lsa)); | |
1752 | lsa->data->ls_age = | |
1753 | htons(OSPF_LSA_MAXAGE); /* Flush it anyway. */ | |
1754 | } | |
1755 | ||
1756 | if (IS_LSA_MAXAGE(lsa)) { | |
1757 | ospf_opaque_lsa_flush_schedule(lsa); | |
1758 | goto out; | |
1759 | } | |
1760 | ||
1761 | /* Check if updated version of LSA instance has already prepared. */ | |
1762 | new = ospf_lsdb_lookup(&apiserv->reserve, lsa); | |
1763 | if (!new) { | |
1764 | /* This is a periodic refresh, driven by core OSPF mechanism. */ | |
1765 | new = ospf_apiserver_opaque_lsa_new(lsa->area, lsa->oi, | |
1766 | lsa->data); | |
1767 | if (!new) { | |
1768 | zlog_warn( | |
1769 | "ospf_apiserver_lsa_refresher: Cannot create a new LSA?"); | |
1770 | goto out; | |
1771 | } | |
1772 | } else { | |
1773 | /* This is a forcible refresh, requested by OSPF-API client. */ | |
1774 | ospf_lsdb_delete(&apiserv->reserve, new); | |
1775 | new->lsdb = NULL; | |
1776 | } | |
1777 | ||
1778 | /* Increment sequence number */ | |
1779 | new->data->ls_seqnum = lsa_seqnum_increment(lsa); | |
1780 | ||
1781 | /* New LSA is in same area. */ | |
1782 | new->area = lsa->area; | |
1783 | SET_FLAG(new->flags, OSPF_LSA_SELF); | |
1784 | ||
1785 | /* Install LSA into LSDB. */ | |
1786 | if (ospf_lsa_install(ospf, new->oi, new) == NULL) { | |
1787 | zlog_warn( | |
1788 | "ospf_apiserver_lsa_refresher: ospf_lsa_install failed"); | |
1789 | ospf_lsa_unlock(&new); | |
1790 | goto out; | |
1791 | } | |
1792 | ||
1793 | /* Flood updated LSA through interface, area or AS */ | |
2d33f157 | 1794 | |
1795 | #ifdef NOTYET | |
d62a17ae | 1796 | ospf_flood_through(NULL /*nbr */, new); |
2d33f157 | 1797 | #endif /* NOTYET */ |
d62a17ae | 1798 | ospf_apiserver_flood_opaque_lsa(new); |
2d33f157 | 1799 | |
d62a17ae | 1800 | /* Debug logging. */ |
1801 | if (IS_DEBUG_OSPF(lsa, LSA_GENERATE)) { | |
1802 | zlog_debug("LSA[Type%d:%s]: Refresh Opaque LSA", | |
1803 | new->data->type, inet_ntoa(new->data->id)); | |
1804 | ospf_lsa_header_dump(new->data); | |
1805 | } | |
2d33f157 | 1806 | |
1807 | out: | |
d62a17ae | 1808 | return new; |
2d33f157 | 1809 | } |
1810 | ||
1811 | ||
1812 | /* ----------------------------------------------------------- | |
1813 | * Followings are functions to delete LSAs | |
1814 | * ----------------------------------------------------------- | |
1815 | */ | |
1816 | ||
d62a17ae | 1817 | int ospf_apiserver_handle_delete_request(struct ospf_apiserver *apiserv, |
1818 | struct msg *msg) | |
2d33f157 | 1819 | { |
d62a17ae | 1820 | struct msg_delete_request *dmsg; |
1821 | struct ospf_lsa *old; | |
1822 | struct ospf_area *area = NULL; | |
1823 | struct in_addr id; | |
1824 | int lsa_type, opaque_type; | |
1825 | int rc = 0; | |
1826 | struct ospf *ospf; | |
1827 | ||
b5a8894d | 1828 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1829 | assert(ospf); |
1830 | ||
1831 | /* Extract opaque LSA from message */ | |
1832 | dmsg = (struct msg_delete_request *)STREAM_DATA(msg->s); | |
1833 | ||
1834 | /* Lookup area for link-local and area-local opaque LSAs */ | |
1835 | switch (dmsg->lsa_type) { | |
1836 | case OSPF_OPAQUE_LINK_LSA: | |
1837 | case OSPF_OPAQUE_AREA_LSA: | |
1838 | area = ospf_area_lookup_by_area_id(ospf, dmsg->area_id); | |
1839 | if (!area) { | |
1840 | zlog_warn("ospf_apiserver_lsa_delete: unknown area %s", | |
1841 | inet_ntoa(dmsg->area_id)); | |
1842 | rc = OSPF_API_NOSUCHAREA; | |
1843 | goto out; | |
1844 | } | |
1845 | break; | |
1846 | case OSPF_OPAQUE_AS_LSA: | |
1847 | /* AS-external opaque LSAs have no designated area */ | |
1848 | area = NULL; | |
1849 | break; | |
1850 | default: | |
1851 | zlog_warn( | |
1852 | "ospf_apiserver_lsa_delete: Cannot delete non-opaque LSA type %d", | |
1853 | dmsg->lsa_type); | |
1854 | rc = OSPF_API_ILLEGALLSATYPE; | |
1855 | goto out; | |
1856 | } | |
1857 | ||
1858 | /* Check if we registered this opaque type */ | |
1859 | lsa_type = dmsg->lsa_type; | |
1860 | opaque_type = dmsg->opaque_type; | |
1861 | ||
1862 | if (!apiserver_is_opaque_type_registered(apiserv, lsa_type, | |
1863 | opaque_type)) { | |
1864 | zlog_warn( | |
1865 | "ospf_apiserver_lsa_delete: LSA-type(%d)/Opaque-type(%d): Not registered", | |
1866 | lsa_type, opaque_type); | |
1867 | rc = OSPF_API_OPAQUETYPENOTREGISTERED; | |
1868 | goto out; | |
1869 | } | |
1870 | ||
1871 | /* opaque_id is in network byte order */ | |
1872 | id.s_addr = htonl( | |
1873 | SET_OPAQUE_LSID(dmsg->opaque_type, ntohl(dmsg->opaque_id))); | |
1874 | ||
1875 | /* | |
1876 | * Even if the target LSA has once scheduled to flush, it remains in | |
1877 | * the LSDB until it is finally handled by the maxage remover thread. | |
1878 | * Therefore, the lookup function below may return non-NULL result. | |
1879 | */ | |
b5a8894d | 1880 | old = ospf_lsa_lookup(ospf, area, dmsg->lsa_type, id, ospf->router_id); |
d62a17ae | 1881 | if (!old) { |
1882 | zlog_warn( | |
1883 | "ospf_apiserver_lsa_delete: LSA[Type%d:%s] not in LSDB", | |
1884 | dmsg->lsa_type, inet_ntoa(id)); | |
1885 | rc = OSPF_API_NOSUCHLSA; | |
1886 | goto out; | |
1887 | } | |
1888 | ||
1889 | /* Schedule flushing of LSA from LSDB */ | |
1890 | /* NB: Multiple scheduling will produce a warning message, but harmless. | |
1891 | */ | |
1892 | ospf_opaque_lsa_flush_schedule(old); | |
2d33f157 | 1893 | |
1894 | out: | |
1895 | ||
d62a17ae | 1896 | /* Send reply back to client including return code */ |
1897 | rc = ospf_apiserver_send_reply(apiserv, ntohl(msg->hdr.msgseq), rc); | |
1898 | return rc; | |
2d33f157 | 1899 | } |
1900 | ||
1901 | /* Flush self-originated opaque LSA */ | |
d62a17ae | 1902 | static int apiserver_flush_opaque_type_callback(struct ospf_lsa *lsa, |
1903 | void *p_arg, int int_arg) | |
2d33f157 | 1904 | { |
d62a17ae | 1905 | struct param_t { |
1906 | struct ospf_apiserver *apiserv; | |
d7c0a89a QY |
1907 | uint8_t lsa_type; |
1908 | uint8_t opaque_type; | |
d62a17ae | 1909 | } * param; |
1910 | ||
1911 | /* Sanity check */ | |
1912 | assert(lsa->data); | |
1913 | assert(p_arg); | |
1914 | param = (struct param_t *)p_arg; | |
1915 | ||
1916 | /* If LSA matches type and opaque type then delete it */ | |
1917 | if (IS_LSA_SELF(lsa) && lsa->data->type == param->lsa_type | |
1918 | && GET_OPAQUE_TYPE(ntohl(lsa->data->id.s_addr)) | |
1919 | == param->opaque_type) { | |
1920 | ospf_opaque_lsa_flush_schedule(lsa); | |
1921 | } | |
1922 | return 0; | |
2d33f157 | 1923 | } |
1924 | ||
1925 | /* Delete self-originated opaque LSAs of a given opaque type. This | |
1926 | function is called when an application unregisters a given opaque | |
1927 | type or a connection to an application closes and all those opaque | |
1928 | LSAs need to be flushed the LSDB. */ | |
d62a17ae | 1929 | void ospf_apiserver_flush_opaque_lsa(struct ospf_apiserver *apiserv, |
d7c0a89a | 1930 | uint8_t lsa_type, uint8_t opaque_type) |
2d33f157 | 1931 | { |
d62a17ae | 1932 | struct param_t { |
1933 | struct ospf_apiserver *apiserv; | |
d7c0a89a QY |
1934 | uint8_t lsa_type; |
1935 | uint8_t opaque_type; | |
d62a17ae | 1936 | } param; |
1937 | struct listnode *node, *nnode; | |
1938 | struct ospf *ospf; | |
1939 | struct ospf_area *area; | |
1940 | ||
b5a8894d | 1941 | ospf = ospf_lookup_by_vrf_id(VRF_DEFAULT); |
d62a17ae | 1942 | assert(ospf); |
1943 | ||
1944 | /* Set parameter struct. */ | |
1945 | param.apiserv = apiserv; | |
1946 | param.lsa_type = lsa_type; | |
1947 | param.opaque_type = opaque_type; | |
1948 | ||
1949 | switch (lsa_type) { | |
1950 | struct route_node *rn; | |
1951 | struct ospf_lsa *lsa; | |
1952 | ||
1953 | case OSPF_OPAQUE_LINK_LSA: | |
1954 | for (ALL_LIST_ELEMENTS(ospf->areas, node, nnode, area)) | |
996c9314 | 1955 | LSDB_LOOP (OPAQUE_LINK_LSDB(area), rn, lsa) |
044506e7 DS |
1956 | apiserver_flush_opaque_type_callback( |
1957 | lsa, (void *)¶m, 0); | |
d62a17ae | 1958 | break; |
1959 | case OSPF_OPAQUE_AREA_LSA: | |
1960 | for (ALL_LIST_ELEMENTS(ospf->areas, node, nnode, area)) | |
996c9314 | 1961 | LSDB_LOOP (OPAQUE_AREA_LSDB(area), rn, lsa) |
044506e7 DS |
1962 | apiserver_flush_opaque_type_callback( |
1963 | lsa, (void *)¶m, 0); | |
d62a17ae | 1964 | break; |
1965 | case OSPF_OPAQUE_AS_LSA: | |
996c9314 | 1966 | LSDB_LOOP (OPAQUE_LINK_LSDB(ospf), rn, lsa) |
044506e7 DS |
1967 | apiserver_flush_opaque_type_callback(lsa, |
1968 | (void *)¶m, 0); | |
d62a17ae | 1969 | break; |
1970 | default: | |
1971 | break; | |
1972 | } | |
1973 | return; | |
2d33f157 | 1974 | } |
1975 | ||
1976 | ||
1977 | /* ----------------------------------------------------------- | |
d62a17ae | 1978 | * Followings are callback functions to handle opaque types |
2d33f157 | 1979 | * ----------------------------------------------------------- |
1980 | */ | |
1981 | ||
d62a17ae | 1982 | int ospf_apiserver_new_if(struct interface *ifp) |
2d33f157 | 1983 | { |
d62a17ae | 1984 | struct ospf_interface *oi; |
1985 | ||
1986 | /* For some strange reason it seems possible that we are invoked | |
1987 | with an interface that has no name. This seems to happen during | |
1988 | initialization. Return if this happens */ | |
1989 | ||
1990 | if (ifp->name[0] == '\0') { | |
1991 | /* interface has empty name */ | |
1992 | zlog_warn("ospf_apiserver_new_if: interface has no name?"); | |
1993 | return 0; | |
1994 | } | |
1995 | ||
1996 | /* zlog_warn for debugging */ | |
1997 | zlog_warn("ospf_apiserver_new_if"); | |
1998 | zlog_warn("ifp name=%s status=%d index=%d", ifp->name, ifp->status, | |
1999 | ifp->ifindex); | |
2000 | ||
2001 | if (ifp->name[0] == '\0') { | |
2002 | /* interface has empty name */ | |
2003 | zlog_warn("ospf_apiserver_new_if: interface has no name?"); | |
2004 | return 0; | |
2005 | } | |
2006 | ||
2007 | oi = ospf_apiserver_if_lookup_by_ifp(ifp); | |
2008 | ||
2009 | if (!oi) { | |
2010 | /* This interface is known to Zebra but not to OSPF daemon yet. | |
2011 | */ | |
2012 | zlog_warn( | |
2013 | "ospf_apiserver_new_if: interface %s not known to OSPFd?", | |
2014 | ifp->name); | |
2015 | return 0; | |
2016 | } | |
2017 | ||
2018 | assert(oi); | |
2019 | ||
2020 | /* New interface added to OSPF, tell clients about it */ | |
2021 | if (listcount(apiserver_list) > 0) { | |
2022 | ospf_apiserver_clients_notify_new_if(oi); | |
2023 | } | |
2024 | return 0; | |
2d33f157 | 2025 | } |
2026 | ||
d62a17ae | 2027 | int ospf_apiserver_del_if(struct interface *ifp) |
2d33f157 | 2028 | { |
d62a17ae | 2029 | struct ospf_interface *oi; |
2030 | ||
2031 | /* zlog_warn for debugging */ | |
2032 | zlog_warn("ospf_apiserver_del_if"); | |
2033 | zlog_warn("ifp name=%s status=%d index=%d\n", ifp->name, ifp->status, | |
2034 | ifp->ifindex); | |
2035 | ||
2036 | oi = ospf_apiserver_if_lookup_by_ifp(ifp); | |
2037 | ||
2038 | if (!oi) { | |
2039 | /* This interface is known to Zebra but not to OSPF daemon | |
2040 | anymore. No need to tell clients about it */ | |
2041 | return 0; | |
2042 | } | |
2043 | ||
2044 | /* Interface deleted, tell clients about it */ | |
2045 | if (listcount(apiserver_list) > 0) { | |
2046 | ospf_apiserver_clients_notify_del_if(oi); | |
2047 | } | |
2048 | return 0; | |
2d33f157 | 2049 | } |
2050 | ||
d62a17ae | 2051 | void ospf_apiserver_ism_change(struct ospf_interface *oi, int old_state) |
2d33f157 | 2052 | { |
d62a17ae | 2053 | /* Tell clients about interface change */ |
2d33f157 | 2054 | |
d62a17ae | 2055 | /* zlog_warn for debugging */ |
2056 | zlog_warn("ospf_apiserver_ism_change"); | |
2057 | if (listcount(apiserver_list) > 0) { | |
2058 | ospf_apiserver_clients_notify_ism_change(oi); | |
2059 | } | |
2d33f157 | 2060 | |
d62a17ae | 2061 | zlog_warn("oi->ifp->name=%s", oi->ifp->name); |
2062 | zlog_warn("old_state=%d", old_state); | |
2063 | zlog_warn("oi->state=%d", oi->state); | |
2d33f157 | 2064 | } |
2065 | ||
d62a17ae | 2066 | void ospf_apiserver_nsm_change(struct ospf_neighbor *nbr, int old_status) |
2d33f157 | 2067 | { |
d62a17ae | 2068 | /* Neighbor status changed, tell clients about it */ |
2069 | zlog_warn("ospf_apiserver_nsm_change"); | |
2070 | if (listcount(apiserver_list) > 0) { | |
2071 | ospf_apiserver_clients_notify_nsm_change(nbr); | |
2072 | } | |
2d33f157 | 2073 | } |
2074 | ||
d62a17ae | 2075 | void ospf_apiserver_show_info(struct vty *vty, struct ospf_lsa *lsa) |
2d33f157 | 2076 | { |
d62a17ae | 2077 | struct opaque_lsa { |
2078 | struct lsa_header header; | |
d7c0a89a | 2079 | uint8_t data[1]; /* opaque data have variable length. This is |
d62a17ae | 2080 | start |
2081 | address */ | |
2082 | }; | |
2083 | struct opaque_lsa *olsa; | |
2084 | int opaquelen; | |
2085 | ||
2086 | olsa = (struct opaque_lsa *)lsa->data; | |
2087 | ||
2088 | if (VALID_OPAQUE_INFO_LEN(lsa->data)) | |
2089 | opaquelen = ntohs(lsa->data->length) - OSPF_LSA_HEADER_SIZE; | |
2090 | else | |
2091 | opaquelen = 0; | |
2092 | ||
2093 | /* Output information about opaque LSAs */ | |
2094 | if (vty != NULL) { | |
2095 | int i; | |
2096 | vty_out(vty, | |
2097 | " Added using OSPF API: %u octets of opaque data %s\n", | |
2098 | opaquelen, | |
2099 | VALID_OPAQUE_INFO_LEN(lsa->data) ? "" | |
2100 | : "(Invalid length?)"); | |
2101 | vty_out(vty, " Opaque data: "); | |
2102 | ||
2103 | for (i = 0; i < opaquelen; i++) { | |
2104 | vty_out(vty, "0x%x ", olsa->data[i]); | |
2105 | } | |
2106 | vty_out(vty, "\n"); | |
2107 | } else { | |
2108 | int i; | |
2109 | zlog_debug( | |
2110 | " Added using OSPF API: %u octets of opaque data %s", | |
2111 | opaquelen, | |
2112 | VALID_OPAQUE_INFO_LEN(lsa->data) ? "" | |
2113 | : "(Invalid length?)"); | |
2114 | zlog_debug(" Opaque data: "); | |
2115 | ||
2116 | for (i = 0; i < opaquelen; i++) { | |
2117 | zlog_debug("0x%x ", olsa->data[i]); | |
2118 | } | |
2119 | zlog_debug("\n"); | |
2120 | } | |
2121 | return; | |
2d33f157 | 2122 | } |
2123 | ||
2124 | /* ----------------------------------------------------------- | |
2125 | * Followings are functions to notify clients about events | |
2126 | * ----------------------------------------------------------- | |
2127 | */ | |
2128 | ||
2129 | /* Send a message to all clients. This is useful for messages | |
2130 | that need to be notified to all clients (such as interface | |
2131 | changes) */ | |
2132 | ||
d62a17ae | 2133 | void ospf_apiserver_clients_notify_all(struct msg *msg) |
2d33f157 | 2134 | { |
d62a17ae | 2135 | struct listnode *node, *nnode; |
2136 | struct ospf_apiserver *apiserv; | |
2d33f157 | 2137 | |
d62a17ae | 2138 | /* Send message to all clients */ |
2139 | for (ALL_LIST_ELEMENTS(apiserver_list, node, nnode, apiserv)) | |
2140 | ospf_apiserver_send_msg(apiserv, msg); | |
2d33f157 | 2141 | } |
2142 | ||
2143 | /* An interface is now ready to accept opaque LSAs. Notify all | |
2144 | clients that registered to use this opaque type */ | |
d62a17ae | 2145 | void ospf_apiserver_clients_notify_ready_type9(struct ospf_interface *oi) |
2d33f157 | 2146 | { |
d62a17ae | 2147 | struct listnode *node, *nnode; |
2148 | struct msg *msg; | |
2149 | struct ospf_apiserver *apiserv; | |
2150 | ||
2151 | assert(oi); | |
2152 | if (!oi->address) { | |
2153 | zlog_warn("Interface has no address?"); | |
2154 | return; | |
2155 | } | |
2156 | ||
2157 | if (!ospf_apiserver_is_ready_type9(oi)) { | |
2158 | zlog_warn("Interface not ready for type 9?"); | |
2159 | return; | |
2160 | } | |
2161 | ||
2162 | for (ALL_LIST_ELEMENTS(apiserver_list, node, nnode, apiserv)) { | |
2163 | struct listnode *node2, *nnode2; | |
2164 | struct registered_opaque_type *r; | |
2165 | ||
2166 | for (ALL_LIST_ELEMENTS(apiserv->opaque_types, node2, nnode2, | |
2167 | r)) { | |
2168 | if (r->lsa_type == OSPF_OPAQUE_LINK_LSA) { | |
2169 | msg = new_msg_ready_notify( | |
2170 | 0, OSPF_OPAQUE_LINK_LSA, r->opaque_type, | |
2171 | oi->address->u.prefix4); | |
2172 | if (!msg) { | |
2173 | zlog_warn( | |
2174 | "ospf_apiserver_clients_notify_ready_type9: new_msg_ready_notify failed"); | |
2d33f157 | 2175 | #ifdef NOTYET |
d62a17ae | 2176 | /* Cannot allocate new message. What |
2177 | * should we do? */ | |
2178 | ospf_apiserver_free(apiserv); | |
2d33f157 | 2179 | #endif |
d62a17ae | 2180 | goto out; |
2181 | } | |
2d33f157 | 2182 | |
d62a17ae | 2183 | ospf_apiserver_send_msg(apiserv, msg); |
2184 | msg_free(msg); | |
2185 | } | |
2186 | } | |
2d33f157 | 2187 | } |
2d33f157 | 2188 | |
2189 | out: | |
d62a17ae | 2190 | return; |
2d33f157 | 2191 | } |
2192 | ||
d62a17ae | 2193 | void ospf_apiserver_clients_notify_ready_type10(struct ospf_area *area) |
2d33f157 | 2194 | { |
d62a17ae | 2195 | struct listnode *node, *nnode; |
2196 | struct msg *msg; | |
2197 | struct ospf_apiserver *apiserv; | |
2198 | ||
2199 | assert(area); | |
2200 | ||
2201 | if (!ospf_apiserver_is_ready_type10(area)) { | |
2202 | zlog_warn("Area not ready for type 10?"); | |
2203 | return; | |
2204 | } | |
2205 | ||
2206 | for (ALL_LIST_ELEMENTS(apiserver_list, node, nnode, apiserv)) { | |
2207 | struct listnode *node2, *nnode2; | |
2208 | struct registered_opaque_type *r; | |
2209 | ||
2210 | for (ALL_LIST_ELEMENTS(apiserv->opaque_types, node2, nnode2, | |
2211 | r)) { | |
2212 | if (r->lsa_type == OSPF_OPAQUE_AREA_LSA) { | |
2213 | msg = new_msg_ready_notify( | |
2214 | 0, OSPF_OPAQUE_AREA_LSA, r->opaque_type, | |
2215 | area->area_id); | |
2216 | if (!msg) { | |
2217 | zlog_warn( | |
2218 | "ospf_apiserver_clients_notify_ready_type10: new_msg_ready_nofity failed"); | |
2d33f157 | 2219 | #ifdef NOTYET |
d62a17ae | 2220 | /* Cannot allocate new message. What |
2221 | * should we do? */ | |
2222 | ospf_apiserver_free(apiserv); | |
2d33f157 | 2223 | #endif |
d62a17ae | 2224 | goto out; |
2225 | } | |
2d33f157 | 2226 | |
d62a17ae | 2227 | ospf_apiserver_send_msg(apiserv, msg); |
2228 | msg_free(msg); | |
2229 | } | |
2230 | } | |
2d33f157 | 2231 | } |
2d33f157 | 2232 | |
2233 | out: | |
d62a17ae | 2234 | return; |
2d33f157 | 2235 | } |
2236 | ||
2237 | ||
d62a17ae | 2238 | void ospf_apiserver_clients_notify_ready_type11(struct ospf *top) |
2d33f157 | 2239 | { |
d62a17ae | 2240 | struct listnode *node, *nnode; |
2241 | struct msg *msg; | |
2242 | struct in_addr id_null = {.s_addr = 0L}; | |
2243 | struct ospf_apiserver *apiserv; | |
2244 | ||
2245 | assert(top); | |
2246 | ||
2247 | if (!ospf_apiserver_is_ready_type11(top)) { | |
2248 | zlog_warn("AS not ready for type 11?"); | |
2249 | return; | |
2250 | } | |
2251 | ||
2252 | for (ALL_LIST_ELEMENTS(apiserver_list, node, nnode, apiserv)) { | |
2253 | struct listnode *node2, *nnode2; | |
2254 | struct registered_opaque_type *r; | |
2255 | ||
2256 | for (ALL_LIST_ELEMENTS(apiserv->opaque_types, node2, nnode2, | |
2257 | r)) { | |
2258 | if (r->lsa_type == OSPF_OPAQUE_AS_LSA) { | |
2259 | msg = new_msg_ready_notify( | |
2260 | 0, OSPF_OPAQUE_AS_LSA, r->opaque_type, | |
2261 | id_null); | |
2262 | if (!msg) { | |
2263 | zlog_warn( | |
2264 | "ospf_apiserver_clients_notify_ready_type11: new_msg_ready_notify failed"); | |
2d33f157 | 2265 | #ifdef NOTYET |
d62a17ae | 2266 | /* Cannot allocate new message. What |
2267 | * should we do? */ | |
2268 | ospf_apiserver_free(apiserv); | |
2d33f157 | 2269 | #endif |
d62a17ae | 2270 | goto out; |
2271 | } | |
2d33f157 | 2272 | |
d62a17ae | 2273 | ospf_apiserver_send_msg(apiserv, msg); |
2274 | msg_free(msg); | |
2275 | } | |
2276 | } | |
2d33f157 | 2277 | } |
2d33f157 | 2278 | |
2279 | out: | |
d62a17ae | 2280 | return; |
2d33f157 | 2281 | } |
2282 | ||
d62a17ae | 2283 | void ospf_apiserver_clients_notify_new_if(struct ospf_interface *oi) |
2d33f157 | 2284 | { |
d62a17ae | 2285 | struct msg *msg; |
2286 | ||
2287 | msg = new_msg_new_if(0, oi->address->u.prefix4, oi->area->area_id); | |
2288 | if (msg != NULL) { | |
2289 | ospf_apiserver_clients_notify_all(msg); | |
2290 | msg_free(msg); | |
2291 | } | |
2d33f157 | 2292 | } |
2293 | ||
d62a17ae | 2294 | void ospf_apiserver_clients_notify_del_if(struct ospf_interface *oi) |
2d33f157 | 2295 | { |
d62a17ae | 2296 | struct msg *msg; |
2297 | ||
2298 | msg = new_msg_del_if(0, oi->address->u.prefix4); | |
2299 | if (msg != NULL) { | |
2300 | ospf_apiserver_clients_notify_all(msg); | |
2301 | msg_free(msg); | |
2302 | } | |
2d33f157 | 2303 | } |
2304 | ||
d62a17ae | 2305 | void ospf_apiserver_clients_notify_ism_change(struct ospf_interface *oi) |
2d33f157 | 2306 | { |
d62a17ae | 2307 | struct msg *msg; |
2308 | struct in_addr ifaddr = {.s_addr = 0L}; | |
2309 | struct in_addr area_id = {.s_addr = 0L}; | |
2310 | ||
2311 | assert(oi); | |
2312 | assert(oi->ifp); | |
2313 | ||
2314 | if (oi->address) { | |
2315 | ifaddr = oi->address->u.prefix4; | |
2316 | } | |
2317 | if (oi->area) { | |
2318 | area_id = oi->area->area_id; | |
2319 | } | |
2320 | ||
2321 | msg = new_msg_ism_change(0, ifaddr, area_id, oi->state); | |
2322 | if (!msg) { | |
2323 | zlog_warn( | |
2324 | "apiserver_clients_notify_ism_change: msg_new failed"); | |
2325 | return; | |
2326 | } | |
2327 | ||
2328 | ospf_apiserver_clients_notify_all(msg); | |
2329 | msg_free(msg); | |
2d33f157 | 2330 | } |
2331 | ||
d62a17ae | 2332 | void ospf_apiserver_clients_notify_nsm_change(struct ospf_neighbor *nbr) |
2d33f157 | 2333 | { |
d62a17ae | 2334 | struct msg *msg; |
2335 | struct in_addr ifaddr = {.s_addr = 0L}; | |
7295876a | 2336 | struct in_addr nbraddr; |
2d33f157 | 2337 | |
d62a17ae | 2338 | assert(nbr); |
2d33f157 | 2339 | |
d62a17ae | 2340 | if (nbr->oi) { |
2341 | ifaddr = nbr->oi->address->u.prefix4; | |
2342 | } | |
2d33f157 | 2343 | |
d62a17ae | 2344 | nbraddr = nbr->address.u.prefix4; |
2d33f157 | 2345 | |
d62a17ae | 2346 | msg = new_msg_nsm_change(0, ifaddr, nbraddr, nbr->router_id, |
2347 | nbr->state); | |
2348 | if (!msg) { | |
2349 | zlog_warn( | |
2350 | "apiserver_clients_notify_nsm_change: msg_new failed"); | |
2351 | return; | |
2352 | } | |
2d33f157 | 2353 | |
d62a17ae | 2354 | ospf_apiserver_clients_notify_all(msg); |
2355 | msg_free(msg); | |
2d33f157 | 2356 | } |
2357 | ||
d7c0a89a | 2358 | static void apiserver_clients_lsa_change_notify(uint8_t msgtype, |
d62a17ae | 2359 | struct ospf_lsa *lsa) |
2d33f157 | 2360 | { |
d62a17ae | 2361 | struct msg *msg; |
2362 | struct listnode *node, *nnode; | |
2363 | struct ospf_apiserver *apiserv; | |
2364 | ||
2365 | /* Default area for AS-External and Opaque11 LSAs */ | |
2366 | struct in_addr area_id = {.s_addr = 0L}; | |
2367 | ||
2368 | /* Default interface for non Opaque9 LSAs */ | |
2369 | struct in_addr ifaddr = {.s_addr = 0L}; | |
2370 | ||
2371 | if (lsa->area) { | |
2372 | area_id = lsa->area->area_id; | |
2373 | } | |
2374 | if (lsa->data->type == OSPF_OPAQUE_LINK_LSA) { | |
2375 | assert(lsa->oi); | |
2376 | ifaddr = lsa->oi->address->u.prefix4; | |
2377 | } | |
2378 | ||
2379 | /* Prepare message that can be sent to clients that have a matching | |
2380 | filter */ | |
2381 | msg = new_msg_lsa_change_notify(msgtype, 0L, /* no sequence number */ | |
2382 | ifaddr, area_id, | |
2383 | lsa->flags & OSPF_LSA_SELF, lsa->data); | |
2384 | if (!msg) { | |
2385 | zlog_warn( | |
2386 | "apiserver_clients_lsa_change_notify: msg_new failed"); | |
2387 | return; | |
2388 | } | |
2389 | ||
2390 | /* Now send message to all clients with a matching filter */ | |
2391 | for (ALL_LIST_ELEMENTS(apiserver_list, node, nnode, apiserv)) { | |
2392 | struct lsa_filter_type *filter; | |
d7c0a89a QY |
2393 | uint16_t mask; |
2394 | uint32_t *area; | |
d62a17ae | 2395 | int i; |
2396 | ||
2397 | /* Check filter for this client. */ | |
2398 | filter = apiserv->filter; | |
2399 | ||
2400 | /* Check area IDs in case of non AS-E LSAs. | |
2401 | * If filter has areas (num_areas > 0), | |
2402 | * then one of the areas must match the area ID of this LSA. */ | |
2403 | ||
2404 | i = filter->num_areas; | |
2405 | if ((lsa->data->type == OSPF_AS_EXTERNAL_LSA) | |
2406 | || (lsa->data->type == OSPF_OPAQUE_AS_LSA)) { | |
2407 | i = 0; | |
2d33f157 | 2408 | } |
d62a17ae | 2409 | |
2410 | if (i > 0) { | |
d7c0a89a | 2411 | area = (uint32_t *)(filter + 1); |
d62a17ae | 2412 | while (i) { |
2413 | if (*area == area_id.s_addr) { | |
2414 | break; | |
2415 | } | |
2416 | i--; | |
2417 | area++; | |
2418 | } | |
2419 | } else { | |
2420 | i = 1; | |
2421 | } | |
2422 | ||
2423 | if (i > 0) { | |
2424 | /* Area match. Check LSA type. */ | |
2425 | mask = ntohs(filter->typemask); | |
2426 | ||
2427 | if (mask & Power2[lsa->data->type]) { | |
2428 | /* Type also matches. Check origin. */ | |
2429 | if ((filter->origin == ANY_ORIGIN) | |
2430 | || (filter->origin == IS_LSA_SELF(lsa))) { | |
2431 | ospf_apiserver_send_msg(apiserv, msg); | |
2432 | } | |
2433 | } | |
2d33f157 | 2434 | } |
2d33f157 | 2435 | } |
d62a17ae | 2436 | /* Free message since it is not used anymore */ |
2437 | msg_free(msg); | |
2d33f157 | 2438 | } |
2439 | ||
2440 | ||
2441 | /* ------------------------------------------------------------- | |
2442 | * Followings are hooks invoked when LSAs are updated or deleted | |
2443 | * ------------------------------------------------------------- | |
2444 | */ | |
2445 | ||
2446 | ||
d7c0a89a | 2447 | static int apiserver_notify_clients_lsa(uint8_t msgtype, struct ospf_lsa *lsa) |
2d33f157 | 2448 | { |
d62a17ae | 2449 | struct msg *msg; |
2450 | /* default area for AS-External and Opaque11 LSAs */ | |
2451 | struct in_addr area_id = {.s_addr = 0L}; | |
2452 | ||
2453 | /* default interface for non Opaque9 LSAs */ | |
2454 | struct in_addr ifaddr = {.s_addr = 0L}; | |
2455 | ||
2456 | /* Only notify this update if the LSA's age is smaller than | |
2457 | MAXAGE. Otherwise clients would see LSA updates with max age just | |
2458 | before they are deleted from the LSDB. LSA delete messages have | |
2459 | MAXAGE too but should not be filtered. */ | |
2460 | if (IS_LSA_MAXAGE(lsa) && (msgtype == MSG_LSA_UPDATE_NOTIFY)) { | |
2461 | return 0; | |
2462 | } | |
2463 | ||
2464 | if (lsa->area) { | |
2465 | area_id = lsa->area->area_id; | |
2466 | } | |
2467 | if (lsa->data->type == OSPF_OPAQUE_LINK_LSA) { | |
2468 | ifaddr = lsa->oi->address->u.prefix4; | |
2469 | } | |
2470 | msg = new_msg_lsa_change_notify(msgtype, 0L, /* no sequence number */ | |
2471 | ifaddr, area_id, | |
2472 | lsa->flags & OSPF_LSA_SELF, lsa->data); | |
2473 | if (!msg) { | |
2474 | zlog_warn("notify_clients_lsa: msg_new failed"); | |
2475 | return -1; | |
2476 | } | |
2477 | /* Notify all clients that new LSA is added/updated */ | |
2478 | apiserver_clients_lsa_change_notify(msgtype, lsa); | |
2479 | ||
2480 | /* Clients made their own copies of msg so we can free msg here */ | |
2481 | msg_free(msg); | |
2482 | ||
2483 | return 0; | |
2d33f157 | 2484 | } |
2485 | ||
d62a17ae | 2486 | int ospf_apiserver_lsa_update(struct ospf_lsa *lsa) |
2d33f157 | 2487 | { |
d62a17ae | 2488 | return apiserver_notify_clients_lsa(MSG_LSA_UPDATE_NOTIFY, lsa); |
2d33f157 | 2489 | } |
2490 | ||
d62a17ae | 2491 | int ospf_apiserver_lsa_delete(struct ospf_lsa *lsa) |
2d33f157 | 2492 | { |
d62a17ae | 2493 | return apiserver_notify_clients_lsa(MSG_LSA_DELETE_NOTIFY, lsa); |
2d33f157 | 2494 | } |
2495 | ||
2496 | #endif /* SUPPORT_OSPF_API */ |