2 * API message handling module for OSPF daemon and client.
3 * Copyright (C) 2001, 2002 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 #ifdef SUPPORT_OSPF_API
37 #include "sockunion.h" /* for inet_aton() */
41 #include "ospfd/ospfd.h"
42 #include "ospfd/ospf_interface.h"
43 #include "ospfd/ospf_ism.h"
44 #include "ospfd/ospf_asbr.h"
45 #include "ospfd/ospf_lsa.h"
46 #include "ospfd/ospf_lsdb.h"
47 #include "ospfd/ospf_neighbor.h"
48 #include "ospfd/ospf_nsm.h"
49 #include "ospfd/ospf_flood.h"
50 #include "ospfd/ospf_packet.h"
51 #include "ospfd/ospf_spf.h"
52 #include "ospfd/ospf_dump.h"
53 #include "ospfd/ospf_route.h"
54 #include "ospfd/ospf_ase.h"
55 #include "ospfd/ospf_zebra.h"
57 #include "ospfd/ospf_api.h"
60 /* For debugging only, will be removed */
61 void api_opaque_lsa_print(struct lsa_header
*data
)
64 struct lsa_header header
;
68 struct opaque_lsa
*olsa
;
72 ospf_lsa_header_dump(data
);
74 olsa
= (struct opaque_lsa
*)data
;
76 opaquelen
= ntohs(data
->length
) - OSPF_LSA_HEADER_SIZE
;
77 zlog_debug("apiserver_lsa_print: opaquelen=%d", opaquelen
);
79 for (i
= 0; i
< opaquelen
; i
++) {
80 zlog_debug("0x%x ", olsa
->mydata
[i
]);
85 /* -----------------------------------------------------------
87 * -----------------------------------------------------------
90 struct msg
*msg_new(uint8_t msgtype
, void *msgbody
, uint32_t seqnum
,
95 new = XCALLOC(MTYPE_OSPF_API_MSG
, sizeof(struct msg
));
97 new->hdr
.version
= OSPF_API_VERSION
;
98 new->hdr
.msgtype
= msgtype
;
99 new->hdr
.msglen
= htons(msglen
);
100 new->hdr
.msgseq
= htonl(seqnum
);
102 new->s
= stream_new(msglen
);
104 stream_put(new->s
, msgbody
, msglen
);
110 /* Duplicate a message by copying content. */
111 struct msg
*msg_dup(struct msg
*msg
)
117 new = msg_new(msg
->hdr
.msgtype
, STREAM_DATA(msg
->s
),
118 ntohl(msg
->hdr
.msgseq
), ntohs(msg
->hdr
.msglen
));
123 /* XXX only for testing, will be removed */
130 const char *ospf_api_typename(int msgtype
)
132 struct nametab NameTab
[] = {
134 MSG_REGISTER_OPAQUETYPE
, "Register opaque-type",
137 MSG_UNREGISTER_OPAQUETYPE
, "Unregister opaque-type",
140 MSG_REGISTER_EVENT
, "Register event",
143 MSG_SYNC_LSDB
, "Sync LSDB",
146 MSG_ORIGINATE_REQUEST
, "Originate request",
149 MSG_DELETE_REQUEST
, "Delete request",
155 MSG_READY_NOTIFY
, "Ready notify",
158 MSG_LSA_UPDATE_NOTIFY
, "LSA update notify",
161 MSG_LSA_DELETE_NOTIFY
, "LSA delete notify",
164 MSG_NEW_IF
, "New interface",
167 MSG_DEL_IF
, "Del interface",
170 MSG_ISM_CHANGE
, "ISM change",
173 MSG_NSM_CHANGE
, "NSM change",
177 int i
, n
= array_size(NameTab
);
178 const char *name
= NULL
;
180 for (i
= 0; i
< n
; i
++) {
181 if (NameTab
[i
].value
== msgtype
) {
182 name
= NameTab
[i
].name
;
187 return name
? name
: "?";
190 const char *ospf_api_errname(int errcode
)
192 struct nametab NameTab
[] = {
197 OSPF_API_NOSUCHINTERFACE
, "No such interface",
200 OSPF_API_NOSUCHAREA
, "No such area",
203 OSPF_API_NOSUCHLSA
, "No such LSA",
206 OSPF_API_ILLEGALLSATYPE
, "Illegal LSA type",
209 OSPF_API_OPAQUETYPEINUSE
, "Opaque type in use",
212 OSPF_API_OPAQUETYPENOTREGISTERED
,
213 "Opaque type not registered",
216 OSPF_API_NOTREADY
, "Not ready",
219 OSPF_API_NOMEMORY
, "No memory",
222 OSPF_API_ERROR
, "Other error",
225 OSPF_API_UNDEF
, "Undefined",
229 int i
, n
= array_size(NameTab
);
230 const char *name
= NULL
;
232 for (i
= 0; i
< n
; i
++) {
233 if (NameTab
[i
].value
== errcode
) {
234 name
= NameTab
[i
].name
;
239 return name
? name
: "?";
242 void msg_print(struct msg
*msg
)
245 zlog_debug("msg_print msg=NULL!");
249 /* API message common header part. */
250 zlog_debug("API-msg [%s]: type(%d),len(%d),seq(%lu),data(%p),size(%zd)",
251 ospf_api_typename(msg
->hdr
.msgtype
), msg
->hdr
.msgtype
,
252 ntohs(msg
->hdr
.msglen
),
253 (unsigned long)ntohl(msg
->hdr
.msgseq
), STREAM_DATA(msg
->s
),
254 STREAM_SIZE(msg
->s
));
259 void msg_free(struct msg
*msg
)
264 XFREE(MTYPE_OSPF_API_MSG
, msg
);
268 /* Set sequence number of message */
269 void msg_set_seq(struct msg
*msg
, uint32_t seqnr
)
272 msg
->hdr
.msgseq
= htonl(seqnr
);
275 /* Get sequence number of message */
276 uint32_t msg_get_seq(struct msg
*msg
)
279 return ntohl(msg
->hdr
.msgseq
);
282 /* -----------------------------------------------------------
283 * Message fifo queues
284 * -----------------------------------------------------------
287 struct msg_fifo
*msg_fifo_new(void)
289 return XCALLOC(MTYPE_OSPF_API_FIFO
, sizeof(struct msg_fifo
));
292 /* Add new message to fifo. */
293 void msg_fifo_push(struct msg_fifo
*fifo
, struct msg
*msg
)
296 fifo
->tail
->next
= msg
;
305 /* Remove first message from fifo. */
306 struct msg
*msg_fifo_pop(struct msg_fifo
*fifo
)
312 fifo
->head
= msg
->next
;
314 if (fifo
->head
== NULL
)
322 /* Return first fifo entry but do not remove it. */
323 struct msg
*msg_fifo_head(struct msg_fifo
*fifo
)
328 /* Flush message fifo. */
329 void msg_fifo_flush(struct msg_fifo
*fifo
)
334 for (op
= fifo
->head
; op
; op
= next
) {
339 fifo
->head
= fifo
->tail
= NULL
;
343 /* Free API message fifo. */
344 void msg_fifo_free(struct msg_fifo
*fifo
)
346 msg_fifo_flush(fifo
);
348 XFREE(MTYPE_OSPF_API_FIFO
, fifo
);
351 struct msg
*msg_read(int fd
)
354 struct apimsghdr hdr
;
355 uint8_t buf
[OSPF_API_MAX_MSG_SIZE
];
359 /* Read message header */
360 rlen
= readn(fd
, (uint8_t *)&hdr
, sizeof(struct apimsghdr
));
363 zlog_warn("msg_read: readn %s", safe_strerror(errno
));
365 } else if (rlen
== 0) {
366 zlog_warn("msg_read: Connection closed by peer");
368 } else if (rlen
!= sizeof(struct apimsghdr
)) {
369 zlog_warn("msg_read: Cannot read message header!");
373 /* Check version of API protocol */
374 if (hdr
.version
!= OSPF_API_VERSION
) {
375 zlog_warn("msg_read: OSPF API protocol version mismatch");
379 /* Determine body length. */
380 bodylen
= ntohs(hdr
.msglen
);
383 /* Read message body */
384 rlen
= readn(fd
, buf
, bodylen
);
386 zlog_warn("msg_read: readn %s", safe_strerror(errno
));
388 } else if (rlen
== 0) {
389 zlog_warn("msg_read: Connection closed by peer");
391 } else if (rlen
!= bodylen
) {
392 zlog_warn("msg_read: Cannot read message body!");
397 /* Allocate new message */
398 msg
= msg_new(hdr
.msgtype
, buf
, ntohl(hdr
.msgseq
), ntohs(hdr
.msglen
));
403 int msg_write(int fd
, struct msg
*msg
)
405 uint8_t buf
[OSPF_API_MAX_MSG_SIZE
];
412 /* Length of message including header */
413 l
= sizeof(struct apimsghdr
) + ntohs(msg
->hdr
.msglen
);
415 /* Make contiguous memory buffer for message */
416 memcpy(buf
, &msg
->hdr
, sizeof(struct apimsghdr
));
417 memcpy(buf
+ sizeof(struct apimsghdr
), STREAM_DATA(msg
->s
),
418 ntohs(msg
->hdr
.msglen
));
420 wlen
= writen(fd
, buf
, l
);
422 zlog_warn("msg_write: writen %s", safe_strerror(errno
));
424 } else if (wlen
== 0) {
425 zlog_warn("msg_write: Connection closed by peer");
427 } else if (wlen
!= l
) {
428 zlog_warn("msg_write: Cannot write API message");
434 /* -----------------------------------------------------------
436 * -----------------------------------------------------------
439 struct msg
*new_msg_register_opaque_type(uint32_t seqnum
, uint8_t ltype
,
442 struct msg_register_opaque_type rmsg
;
444 rmsg
.lsatype
= ltype
;
445 rmsg
.opaquetype
= otype
;
446 memset(&rmsg
.pad
, 0, sizeof(rmsg
.pad
));
448 return msg_new(MSG_REGISTER_OPAQUETYPE
, &rmsg
, seqnum
,
449 sizeof(struct msg_register_opaque_type
));
452 struct msg
*new_msg_register_event(uint32_t seqnum
,
453 struct lsa_filter_type
*filter
)
455 uint8_t buf
[OSPF_API_MAX_MSG_SIZE
];
456 struct msg_register_event
*emsg
;
459 emsg
= (struct msg_register_event
*)buf
;
460 len
= sizeof(struct msg_register_event
)
461 + filter
->num_areas
* sizeof(struct in_addr
);
462 emsg
->filter
.typemask
= htons(filter
->typemask
);
463 emsg
->filter
.origin
= filter
->origin
;
464 emsg
->filter
.num_areas
= filter
->num_areas
;
465 if (len
> sizeof(buf
))
467 /* API broken - missing memcpy to fill data */
468 return msg_new(MSG_REGISTER_EVENT
, emsg
, seqnum
, len
);
471 struct msg
*new_msg_sync_lsdb(uint32_t seqnum
, struct lsa_filter_type
*filter
)
473 uint8_t buf
[OSPF_API_MAX_MSG_SIZE
];
474 struct msg_sync_lsdb
*smsg
;
477 smsg
= (struct msg_sync_lsdb
*)buf
;
478 len
= sizeof(struct msg_sync_lsdb
)
479 + filter
->num_areas
* sizeof(struct in_addr
);
480 smsg
->filter
.typemask
= htons(filter
->typemask
);
481 smsg
->filter
.origin
= filter
->origin
;
482 smsg
->filter
.num_areas
= filter
->num_areas
;
483 if (len
> sizeof(buf
))
485 /* API broken - missing memcpy to fill data */
486 return msg_new(MSG_SYNC_LSDB
, smsg
, seqnum
, len
);
490 struct msg
*new_msg_originate_request(uint32_t seqnum
, struct in_addr ifaddr
,
491 struct in_addr area_id
,
492 struct lsa_header
*data
)
494 struct msg_originate_request
*omsg
;
495 unsigned int omsglen
;
496 char buf
[OSPF_API_MAX_MSG_SIZE
];
497 size_t off_data
= offsetof(struct msg_originate_request
, data
);
498 size_t data_maxs
= sizeof(buf
) - off_data
;
499 struct lsa_header
*omsg_data
= (struct lsa_header
*)&buf
[off_data
];
501 omsg
= (struct msg_originate_request
*)buf
;
502 omsg
->ifaddr
= ifaddr
;
503 omsg
->area_id
= area_id
;
505 omsglen
= ntohs(data
->length
);
506 if (omsglen
> data_maxs
)
508 memcpy(omsg_data
, data
, omsglen
);
509 omsglen
+= sizeof(struct msg_originate_request
)
510 - sizeof(struct lsa_header
);
512 return msg_new(MSG_ORIGINATE_REQUEST
, omsg
, seqnum
, omsglen
);
515 struct msg
*new_msg_delete_request(uint32_t seqnum
, struct in_addr area_id
,
516 uint8_t lsa_type
, uint8_t opaque_type
,
519 struct msg_delete_request dmsg
;
520 dmsg
.area_id
= area_id
;
521 dmsg
.lsa_type
= lsa_type
;
522 dmsg
.opaque_type
= opaque_type
;
523 dmsg
.opaque_id
= htonl(opaque_id
);
524 memset(&dmsg
.pad
, 0, sizeof(dmsg
.pad
));
526 return msg_new(MSG_DELETE_REQUEST
, &dmsg
, seqnum
,
527 sizeof(struct msg_delete_request
));
531 struct msg
*new_msg_reply(uint32_t seqnr
, uint8_t rc
)
534 struct msg_reply rmsg
;
536 /* Set return code */
538 memset(&rmsg
.pad
, 0, sizeof(rmsg
.pad
));
540 msg
= msg_new(MSG_REPLY
, &rmsg
, seqnr
, sizeof(struct msg_reply
));
545 struct msg
*new_msg_ready_notify(uint32_t seqnr
, uint8_t lsa_type
,
546 uint8_t opaque_type
, struct in_addr addr
)
548 struct msg_ready_notify rmsg
;
550 rmsg
.lsa_type
= lsa_type
;
551 rmsg
.opaque_type
= opaque_type
;
552 memset(&rmsg
.pad
, 0, sizeof(rmsg
.pad
));
555 return msg_new(MSG_READY_NOTIFY
, &rmsg
, seqnr
,
556 sizeof(struct msg_ready_notify
));
559 struct msg
*new_msg_new_if(uint32_t seqnr
, struct in_addr ifaddr
,
560 struct in_addr area_id
)
562 struct msg_new_if nmsg
;
564 nmsg
.ifaddr
= ifaddr
;
565 nmsg
.area_id
= area_id
;
567 return msg_new(MSG_NEW_IF
, &nmsg
, seqnr
, sizeof(struct msg_new_if
));
570 struct msg
*new_msg_del_if(uint32_t seqnr
, struct in_addr ifaddr
)
572 struct msg_del_if dmsg
;
574 dmsg
.ifaddr
= ifaddr
;
576 return msg_new(MSG_DEL_IF
, &dmsg
, seqnr
, sizeof(struct msg_del_if
));
579 struct msg
*new_msg_ism_change(uint32_t seqnr
, struct in_addr ifaddr
,
580 struct in_addr area_id
, uint8_t status
)
582 struct msg_ism_change imsg
;
584 imsg
.ifaddr
= ifaddr
;
585 imsg
.area_id
= area_id
;
586 imsg
.status
= status
;
587 memset(&imsg
.pad
, 0, sizeof(imsg
.pad
));
589 return msg_new(MSG_ISM_CHANGE
, &imsg
, seqnr
,
590 sizeof(struct msg_ism_change
));
593 struct msg
*new_msg_nsm_change(uint32_t seqnr
, struct in_addr ifaddr
,
594 struct in_addr nbraddr
, struct in_addr router_id
,
597 struct msg_nsm_change nmsg
;
599 nmsg
.ifaddr
= ifaddr
;
600 nmsg
.nbraddr
= nbraddr
;
601 nmsg
.router_id
= router_id
;
602 nmsg
.status
= status
;
603 memset(&nmsg
.pad
, 0, sizeof(nmsg
.pad
));
605 return msg_new(MSG_NSM_CHANGE
, &nmsg
, seqnr
,
606 sizeof(struct msg_nsm_change
));
609 struct msg
*new_msg_lsa_change_notify(uint8_t msgtype
, uint32_t seqnum
,
610 struct in_addr ifaddr
,
611 struct in_addr area_id
,
612 uint8_t is_self_originated
,
613 struct lsa_header
*data
)
615 uint8_t buf
[OSPF_API_MAX_MSG_SIZE
];
616 struct msg_lsa_change_notify
*nmsg
;
618 size_t off_data
= offsetof(struct msg_lsa_change_notify
, data
);
619 size_t data_maxs
= sizeof(buf
) - off_data
;
620 struct lsa_header
*nmsg_data
= (struct lsa_header
*)&buf
[off_data
];
624 nmsg
= (struct msg_lsa_change_notify
*)buf
;
625 nmsg
->ifaddr
= ifaddr
;
626 nmsg
->area_id
= area_id
;
627 nmsg
->is_self_originated
= is_self_originated
;
628 memset(&nmsg
->pad
, 0, sizeof(nmsg
->pad
));
630 len
= ntohs(data
->length
);
633 memcpy(nmsg_data
, data
, len
);
634 len
+= sizeof(struct msg_lsa_change_notify
) - sizeof(struct lsa_header
);
636 return msg_new(msgtype
, nmsg
, seqnum
, len
);
639 #endif /* SUPPORT_OSPF_API */