]>
git.proxmox.com Git - mirror_frr.git/blob - ospfclient/ospf_apiclient.c
2 * Client side of OSPF API.
3 * Copyright (C) 2001, 2002, 2003 Ralph Keller
5 * This file is part of GNU Zebra.
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.
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.
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
24 #include <lib/version.h>
38 /* work around gcc bug 69981, disable MTYPEs in libospf */
39 #define _QUAGGA_OSPF_MEMORY_H
41 #include "ospfd/ospfd.h"
42 #include "ospfd/ospf_interface.h"
43 #include "ospfd/ospf_asbr.h"
44 #include "ospfd/ospf_lsa.h"
45 #include "ospfd/ospf_opaque.h"
46 #include "ospfd/ospf_lsdb.h"
47 #include "ospfd/ospf_neighbor.h"
48 #include "ospfd/ospf_dump.h"
49 #include "ospfd/ospf_zebra.h"
50 #include "ospfd/ospf_api.h"
52 #include "ospf_apiclient.h"
54 /* *sigh* ... can't find a better way to hammer this into automake */
55 #include "ospfd/ospf_dump_api.c"
56 #include "ospfd/ospf_api.c"
58 DEFINE_MGROUP(OSPFCLIENT
, "libospfapiclient")
59 DEFINE_MTYPE_STATIC(OSPFCLIENT
, OSPF_APICLIENT
, "OSPF-API client")
61 /* Backlog for listen */
64 /* -----------------------------------------------------------
65 * Forward declarations
66 * -----------------------------------------------------------
69 void ospf_apiclient_handle_reply(struct ospf_apiclient
*oclient
,
71 void ospf_apiclient_handle_update_notify(struct ospf_apiclient
*oclient
,
73 void ospf_apiclient_handle_delete_notify(struct ospf_apiclient
*oclient
,
76 /* -----------------------------------------------------------
78 * -----------------------------------------------------------
81 static unsigned short ospf_apiclient_getport(void)
83 struct servent
*sp
= getservbyname("ospfapi", "tcp");
85 return sp
? ntohs(sp
->s_port
) : OSPF_API_SYNC_PORT
;
88 /* -----------------------------------------------------------
89 * Followings are functions for connection management
90 * -----------------------------------------------------------
93 struct ospf_apiclient
*ospf_apiclient_connect(char *host
, int syncport
)
95 struct sockaddr_in myaddr_sync
;
96 struct sockaddr_in myaddr_async
;
97 struct sockaddr_in peeraddr
;
99 struct ospf_apiclient
*new;
101 unsigned int peeraddrlen
;
102 int async_server_sock
;
107 /* There are two connections between the client and the server.
108 First the client opens a connection for synchronous requests/replies
109 to the server. The server will accept this connection and
110 as a reaction open a reverse connection channel for
111 asynchronous messages. */
113 async_server_sock
= socket(AF_INET
, SOCK_STREAM
, 0);
114 if (async_server_sock
< 0) {
116 "ospf_apiclient_connect: creating async socket failed\n");
120 /* Prepare socket for asynchronous messages */
121 /* Initialize async address structure */
122 memset(&myaddr_async
, 0, sizeof(struct sockaddr_in
));
123 myaddr_async
.sin_family
= AF_INET
;
124 myaddr_async
.sin_addr
.s_addr
= htonl(INADDR_ANY
);
125 myaddr_async
.sin_port
= htons(syncport
+ 1);
126 size
= sizeof(struct sockaddr_in
);
127 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
128 myaddr_async
.sin_len
= size
;
129 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
131 /* This is a server socket, reuse addr and port */
132 ret
= setsockopt(async_server_sock
, SOL_SOCKET
, SO_REUSEADDR
,
133 (void *)&on
, sizeof(on
));
136 "ospf_apiclient_connect: SO_REUSEADDR failed\n");
137 close(async_server_sock
);
142 ret
= setsockopt(async_server_sock
, SOL_SOCKET
, SO_REUSEPORT
,
143 (void *)&on
, sizeof(on
));
146 "ospf_apiclient_connect: SO_REUSEPORT failed\n");
147 close(async_server_sock
);
150 #endif /* SO_REUSEPORT */
152 /* Bind socket to address structure */
153 ret
= bind(async_server_sock
, (struct sockaddr
*)&myaddr_async
, size
);
156 "ospf_apiclient_connect: bind async socket failed\n");
157 close(async_server_sock
);
161 /* Wait for reverse channel connection establishment from server */
162 ret
= listen(async_server_sock
, BACKLOG
);
164 fprintf(stderr
, "ospf_apiclient_connect: listen: %s\n",
165 safe_strerror(errno
));
166 close(async_server_sock
);
170 /* Make connection for synchronous requests and connect to server */
171 /* Resolve address of server */
172 hp
= gethostbyname(host
);
174 fprintf(stderr
, "ospf_apiclient_connect: no such host %s\n",
176 close(async_server_sock
);
180 fd1
= socket(AF_INET
, SOCK_STREAM
, 0);
182 close(async_server_sock
);
184 "ospf_apiclient_connect: creating sync socket failed\n");
189 /* Reuse addr and port */
190 ret
= setsockopt(fd1
, SOL_SOCKET
, SO_REUSEADDR
, (void *)&on
,
194 "ospf_apiclient_connect: SO_REUSEADDR failed\n");
196 close(async_server_sock
);
201 ret
= setsockopt(fd1
, SOL_SOCKET
, SO_REUSEPORT
, (void *)&on
,
205 "ospf_apiclient_connect: SO_REUSEPORT failed\n");
207 close(async_server_sock
);
210 #endif /* SO_REUSEPORT */
213 /* Bind sync socket to address structure. This is needed since we
214 want the sync port number on a fixed port number. The reverse
215 async channel will be at this port+1 */
217 memset(&myaddr_sync
, 0, sizeof(struct sockaddr_in
));
218 myaddr_sync
.sin_family
= AF_INET
;
219 myaddr_sync
.sin_port
= htons(syncport
);
220 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
221 myaddr_sync
.sin_len
= sizeof(struct sockaddr_in
);
222 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
224 ret
= bind(fd1
, (struct sockaddr
*)&myaddr_sync
, size
);
227 "ospf_apiclient_connect: bind sync socket failed\n");
229 close(async_server_sock
);
233 /* Prepare address structure for connect */
234 memcpy(&myaddr_sync
.sin_addr
, hp
->h_addr
, hp
->h_length
);
235 myaddr_sync
.sin_family
= AF_INET
;
236 myaddr_sync
.sin_port
= htons(ospf_apiclient_getport());
237 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
238 myaddr_sync
.sin_len
= sizeof(struct sockaddr_in
);
239 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
241 /* Now establish synchronous channel with OSPF daemon */
242 ret
= connect(fd1
, (struct sockaddr
*)&myaddr_sync
,
243 sizeof(struct sockaddr_in
));
246 "ospf_apiclient_connect: sync connect failed\n");
247 close(async_server_sock
);
252 /* Accept reverse connection */
253 peeraddrlen
= sizeof(struct sockaddr_in
);
254 memset(&peeraddr
, 0, peeraddrlen
);
256 fd2
= accept(async_server_sock
, (struct sockaddr
*)&peeraddr
,
260 "ospf_apiclient_connect: accept async failed\n");
261 close(async_server_sock
);
267 /* Server socket is not needed anymore since we are not accepting more
269 close(async_server_sock
);
271 /* Create new client-side instance */
272 new = XCALLOC(MTYPE_OSPF_APICLIENT
, sizeof(struct ospf_apiclient
));
274 /* Initialize socket descriptors for sync and async channels */
281 int ospf_apiclient_close(struct ospf_apiclient
*oclient
)
284 if (oclient
->fd_sync
>= 0) {
285 close(oclient
->fd_sync
);
288 if (oclient
->fd_async
>= 0) {
289 close(oclient
->fd_async
);
292 /* Free client structure */
293 XFREE(MTYPE_OSPF_APICLIENT
, oclient
);
297 /* -----------------------------------------------------------
298 * Followings are functions to send a request to OSPFd
299 * -----------------------------------------------------------
302 /* Send synchronous request, wait for reply */
303 static int ospf_apiclient_send_request(struct ospf_apiclient
*oclient
,
307 struct msg_reply
*msgreply
;
310 /* NB: Given "msg" is freed inside this function. */
312 /* Remember the sequence number of the request */
313 reqseq
= ntohl(msg
->hdr
.msgseq
);
315 /* Write message to OSPFd */
316 rc
= msg_write(oclient
->fd_sync
, msg
);
323 /* Wait for reply */ /* NB: New "msg" is allocated by "msg_read()". */
324 msg
= msg_read(oclient
->fd_sync
);
328 assert(msg
->hdr
.msgtype
== MSG_REPLY
);
329 assert(ntohl(msg
->hdr
.msgseq
) == reqseq
);
331 msgreply
= (struct msg_reply
*)STREAM_DATA(msg
->s
);
332 rc
= msgreply
->errcode
;
339 /* -----------------------------------------------------------
341 * -----------------------------------------------------------
344 static uint32_t ospf_apiclient_get_seqnr(void)
346 static uint32_t seqnr
= MIN_SEQ
;
350 /* Increment sequence number */
351 if (seqnr
< MAX_SEQ
) {
359 /* -----------------------------------------------------------
360 * API to access OSPF daemon by client applications.
361 * -----------------------------------------------------------
365 * Synchronous request to register opaque type.
367 int ospf_apiclient_register_opaque_type(struct ospf_apiclient
*cl
,
368 uint8_t ltype
, uint8_t otype
)
373 /* just put 1 as a sequence number. */
374 msg
= new_msg_register_opaque_type(ospf_apiclient_get_seqnr(), ltype
,
377 fprintf(stderr
, "new_msg_register_opaque_type failed\n");
381 rc
= ospf_apiclient_send_request(cl
, msg
);
386 * Synchronous request to synchronize with OSPF's LSDB.
387 * Two steps required: register_event in order to get
388 * dynamic updates and LSDB_Sync.
390 int ospf_apiclient_sync_lsdb(struct ospf_apiclient
*oclient
)
394 struct lsa_filter_type filter
;
396 filter
.typemask
= 0xFFFF; /* all LSAs */
397 filter
.origin
= ANY_ORIGIN
;
398 filter
.num_areas
= 0; /* all Areas. */
400 msg
= new_msg_register_event(ospf_apiclient_get_seqnr(), &filter
);
402 fprintf(stderr
, "new_msg_register_event failed\n");
405 rc
= ospf_apiclient_send_request(oclient
, msg
);
410 msg
= new_msg_sync_lsdb(ospf_apiclient_get_seqnr(), &filter
);
412 fprintf(stderr
, "new_msg_sync_lsdb failed\n");
415 rc
= ospf_apiclient_send_request(oclient
, msg
);
422 * Synchronous request to originate or update an LSA.
425 int ospf_apiclient_lsa_originate(struct ospf_apiclient
*oclient
,
426 struct in_addr ifaddr
, struct in_addr area_id
,
427 uint8_t lsa_type
, uint8_t opaque_type
,
428 uint32_t opaque_id
, void *opaquedata
,
433 uint8_t buf
[OSPF_MAX_LSA_SIZE
];
434 struct lsa_header
*lsah
;
438 /* We can only originate opaque LSAs */
439 if (!IS_OPAQUE_LSA(lsa_type
)) {
440 fprintf(stderr
, "Cannot originate non-opaque LSA type %d\n",
442 return OSPF_API_ILLEGALLSATYPE
;
445 /* Make a new LSA from parameters */
446 lsah
= (struct lsa_header
*)buf
;
449 lsah
->type
= lsa_type
;
451 tmp
= SET_OPAQUE_LSID(opaque_type
, opaque_id
);
452 lsah
->id
.s_addr
= htonl(tmp
);
453 lsah
->adv_router
.s_addr
= 0;
456 lsah
->length
= htons(sizeof(struct lsa_header
) + opaquelen
);
458 memcpy(((uint8_t *)lsah
) + sizeof(struct lsa_header
), opaquedata
,
461 msg
= new_msg_originate_request(ospf_apiclient_get_seqnr(), ifaddr
,
464 fprintf(stderr
, "new_msg_originate_request failed\n");
465 return OSPF_API_NOMEMORY
;
468 rc
= ospf_apiclient_send_request(oclient
, msg
);
472 int ospf_apiclient_lsa_delete(struct ospf_apiclient
*oclient
,
473 struct in_addr area_id
, uint8_t lsa_type
,
474 uint8_t opaque_type
, uint32_t opaque_id
)
479 /* Only opaque LSA can be deleted */
480 if (!IS_OPAQUE_LSA(lsa_type
)) {
481 fprintf(stderr
, "Cannot delete non-opaque LSA type %d\n",
483 return OSPF_API_ILLEGALLSATYPE
;
486 /* opaque_id is in host byte order and will be converted
487 * to network byte order by new_msg_delete_request */
488 msg
= new_msg_delete_request(ospf_apiclient_get_seqnr(), area_id
,
489 lsa_type
, opaque_type
, opaque_id
);
491 rc
= ospf_apiclient_send_request(oclient
, msg
);
495 /* -----------------------------------------------------------
496 * Followings are handlers for messages from OSPF daemon
497 * -----------------------------------------------------------
500 static void ospf_apiclient_handle_ready(struct ospf_apiclient
*oclient
,
503 struct msg_ready_notify
*r
;
504 r
= (struct msg_ready_notify
*)STREAM_DATA(msg
->s
);
506 /* Invoke registered callback function. */
507 if (oclient
->ready_notify
) {
508 (oclient
->ready_notify
)(r
->lsa_type
, r
->opaque_type
, r
->addr
);
512 static void ospf_apiclient_handle_new_if(struct ospf_apiclient
*oclient
,
515 struct msg_new_if
*n
;
516 n
= (struct msg_new_if
*)STREAM_DATA(msg
->s
);
518 /* Invoke registered callback function. */
519 if (oclient
->new_if
) {
520 (oclient
->new_if
)(n
->ifaddr
, n
->area_id
);
524 static void ospf_apiclient_handle_del_if(struct ospf_apiclient
*oclient
,
527 struct msg_del_if
*d
;
528 d
= (struct msg_del_if
*)STREAM_DATA(msg
->s
);
530 /* Invoke registered callback function. */
531 if (oclient
->del_if
) {
532 (oclient
->del_if
)(d
->ifaddr
);
536 static void ospf_apiclient_handle_ism_change(struct ospf_apiclient
*oclient
,
539 struct msg_ism_change
*m
;
540 m
= (struct msg_ism_change
*)STREAM_DATA(msg
->s
);
542 /* Invoke registered callback function. */
543 if (oclient
->ism_change
) {
544 (oclient
->ism_change
)(m
->ifaddr
, m
->area_id
, m
->status
);
548 static void ospf_apiclient_handle_nsm_change(struct ospf_apiclient
*oclient
,
551 struct msg_nsm_change
*m
;
552 m
= (struct msg_nsm_change
*)STREAM_DATA(msg
->s
);
554 /* Invoke registered callback function. */
555 if (oclient
->nsm_change
) {
556 (oclient
->nsm_change
)(m
->ifaddr
, m
->nbraddr
, m
->router_id
,
561 static void ospf_apiclient_handle_lsa_update(struct ospf_apiclient
*oclient
,
564 struct msg_lsa_change_notify
*cn
;
565 struct lsa_header
*lsa
;
568 cn
= (struct msg_lsa_change_notify
*)STREAM_DATA(msg
->s
);
570 /* Extract LSA from message */
571 lsalen
= ntohs(cn
->data
.length
);
572 lsa
= XMALLOC(MTYPE_OSPF_APICLIENT
, lsalen
);
574 fprintf(stderr
, "LSA update: Cannot allocate memory for LSA\n");
577 memcpy(lsa
, &(cn
->data
), lsalen
);
579 /* Invoke registered update callback function */
580 if (oclient
->update_notify
) {
581 (oclient
->update_notify
)(cn
->ifaddr
, cn
->area_id
,
582 cn
->is_self_originated
, lsa
);
585 /* free memory allocated by ospf apiclient library */
586 XFREE(MTYPE_OSPF_APICLIENT
, lsa
);
589 static void ospf_apiclient_handle_lsa_delete(struct ospf_apiclient
*oclient
,
592 struct msg_lsa_change_notify
*cn
;
593 struct lsa_header
*lsa
;
596 cn
= (struct msg_lsa_change_notify
*)STREAM_DATA(msg
->s
);
598 /* Extract LSA from message */
599 lsalen
= ntohs(cn
->data
.length
);
600 lsa
= XMALLOC(MTYPE_OSPF_APICLIENT
, lsalen
);
602 fprintf(stderr
, "LSA delete: Cannot allocate memory for LSA\n");
605 memcpy(lsa
, &(cn
->data
), lsalen
);
607 /* Invoke registered update callback function */
608 if (oclient
->delete_notify
) {
609 (oclient
->delete_notify
)(cn
->ifaddr
, cn
->area_id
,
610 cn
->is_self_originated
, lsa
);
613 /* free memory allocated by ospf apiclient library */
614 XFREE(MTYPE_OSPF_APICLIENT
, lsa
);
617 static void ospf_apiclient_msghandle(struct ospf_apiclient
*oclient
,
620 /* Call message handler function. */
621 switch (msg
->hdr
.msgtype
) {
622 case MSG_READY_NOTIFY
:
623 ospf_apiclient_handle_ready(oclient
, msg
);
626 ospf_apiclient_handle_new_if(oclient
, msg
);
629 ospf_apiclient_handle_del_if(oclient
, msg
);
632 ospf_apiclient_handle_ism_change(oclient
, msg
);
635 ospf_apiclient_handle_nsm_change(oclient
, msg
);
637 case MSG_LSA_UPDATE_NOTIFY
:
638 ospf_apiclient_handle_lsa_update(oclient
, msg
);
640 case MSG_LSA_DELETE_NOTIFY
:
641 ospf_apiclient_handle_lsa_delete(oclient
, msg
);
645 "ospf_apiclient_read: Unknown message type: %d\n",
651 /* -----------------------------------------------------------
652 * Callback handler registration
653 * -----------------------------------------------------------
656 void ospf_apiclient_register_callback(
657 struct ospf_apiclient
*oclient
,
658 void (*ready_notify
)(uint8_t lsa_type
, uint8_t opaque_type
,
659 struct in_addr addr
),
660 void (*new_if
)(struct in_addr ifaddr
, struct in_addr area_id
),
661 void (*del_if
)(struct in_addr ifaddr
),
662 void (*ism_change
)(struct in_addr ifaddr
, struct in_addr area_id
,
664 void (*nsm_change
)(struct in_addr ifaddr
, struct in_addr nbraddr
,
665 struct in_addr router_id
, uint8_t status
),
666 void (*update_notify
)(struct in_addr ifaddr
, struct in_addr area_id
,
667 uint8_t self_origin
, struct lsa_header
*lsa
),
668 void (*delete_notify
)(struct in_addr ifaddr
, struct in_addr area_id
,
669 uint8_t self_origin
, struct lsa_header
*lsa
))
672 assert(update_notify
);
674 /* Register callback function */
675 oclient
->ready_notify
= ready_notify
;
676 oclient
->new_if
= new_if
;
677 oclient
->del_if
= del_if
;
678 oclient
->ism_change
= ism_change
;
679 oclient
->nsm_change
= nsm_change
;
680 oclient
->update_notify
= update_notify
;
681 oclient
->delete_notify
= delete_notify
;
684 /* -----------------------------------------------------------
685 * Asynchronous message handling
686 * -----------------------------------------------------------
689 int ospf_apiclient_handle_async(struct ospf_apiclient
*oclient
)
694 msg
= msg_read(oclient
->fd_async
);
697 /* Connection broke down */
702 ospf_apiclient_msghandle(oclient
, msg
);
704 /* Don't forget to free this message */