2 * API message handling module for OSPF daemon and client.
3 * Copyright (C) 2001, 2002 Ralph Keller
4 * Copyright (c) 2022, LabN Consulting, L.L.C.
6 * This file is part of GNU Zebra.
8 * GNU Zebra is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published
10 * by the Free Software Foundation; either version 2, or (at your
11 * option) any later version.
13 * GNU Zebra is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; see the file COPYING; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 /* This file is used both by the OSPFd and client applications to
25 define message formats used for communication. */
33 #define OSPF_API_VERSION 1
35 /* MTYPE definition is not reflected to "memory.h". */
36 #define MTYPE_OSPF_API_MSG MTYPE_TMP
37 #define MTYPE_OSPF_API_FIFO MTYPE_TMP
39 /* Default API server port to accept connection request from client-side. */
40 /* This value could be overridden by "ospfapi" entry in "/etc/services". */
41 #define OSPF_API_SYNC_PORT 2607
43 /* -----------------------------------------------------------
45 * -----------------------------------------------------------
48 /* Message header structure, fields are in network byte order and
49 aligned to four octets. */
51 uint8_t version
; /* OSPF API protocol version */
52 uint8_t msgtype
; /* Type of message */
53 uint16_t msglen
; /* Length of message w/o header */
54 uint32_t msgseq
; /* Sequence number */
57 /* Message representation with header and body */
59 struct msg
*next
; /* to link into fifo */
68 /* Prototypes for generic messages. */
69 extern struct msg
*msg_new(uint8_t msgtype
, void *msgbody
, uint32_t seqnum
,
71 extern struct msg
*msg_dup(struct msg
*msg
);
72 extern void msg_print(struct msg
*msg
); /* XXX debug only */
73 extern void msg_free(struct msg
*msg
);
74 struct msg
*msg_read(int fd
);
75 extern int msg_write(int fd
, struct msg
*msg
);
77 /* For requests, the message sequence number is between MIN_SEQ and
78 MAX_SEQ. For notifications, the sequence number is 0. */
81 #define MAX_SEQ 2147483647
83 extern void msg_set_seq(struct msg
*msg
, uint32_t seqnr
);
84 extern uint32_t msg_get_seq(struct msg
*msg
);
86 /* -----------------------------------------------------------
88 * -----------------------------------------------------------
91 /* Message queue structure. */
99 /* Prototype for message fifo queues. */
100 extern struct msg_fifo
*msg_fifo_new(void);
101 extern void msg_fifo_push(struct msg_fifo
*, struct msg
*msg
);
102 extern struct msg
*msg_fifo_pop(struct msg_fifo
*fifo
);
103 extern struct msg
*msg_fifo_head(struct msg_fifo
*fifo
);
104 extern void msg_fifo_flush(struct msg_fifo
*fifo
);
105 extern void msg_fifo_free(struct msg_fifo
*fifo
);
107 /* -----------------------------------------------------------
108 * Specific message type and format definitions
109 * -----------------------------------------------------------
112 /* Messages to OSPF daemon. */
113 #define MSG_REGISTER_OPAQUETYPE 1
114 #define MSG_UNREGISTER_OPAQUETYPE 2
115 #define MSG_REGISTER_EVENT 3
116 #define MSG_SYNC_LSDB 4
117 #define MSG_ORIGINATE_REQUEST 5
118 #define MSG_DELETE_REQUEST 6
119 #define MSG_SYNC_REACHABLE 7
120 #define MSG_SYNC_ISM 8
121 #define MSG_SYNC_NSM 9
122 #define MSG_SYNC_ROUTER_ID 19
124 /* Messages from OSPF daemon. */
126 #define MSG_READY_NOTIFY 11
127 #define MSG_LSA_UPDATE_NOTIFY 12
128 #define MSG_LSA_DELETE_NOTIFY 13
129 #define MSG_NEW_IF 14
130 #define MSG_DEL_IF 15
131 #define MSG_ISM_CHANGE 16
132 #define MSG_NSM_CHANGE 17
133 #define MSG_REACHABLE_CHANGE 18
134 #define MSG_ROUTER_ID_CHANGE 20
136 struct msg_register_opaque_type
{
139 uint8_t pad
[2]; /* padding */
142 struct msg_unregister_opaque_type
{
145 uint8_t pad
[2]; /* padding */
148 /* Power2 is needed to convert LSA types into bit positions,
149 * see typemask below. Type definition starts at 1, so
150 * Power2[0] is not used. */
153 static const uint16_t Power2
[] = {
154 0, (1 << 0), (1 << 1), (1 << 2), (1 << 3), (1 << 4),
155 (1 << 5), (1 << 6), (1 << 7), (1 << 8), (1 << 9), (1 << 10),
156 (1 << 11), (1 << 12), (1 << 13), (1 << 14), (1 << 15)};
158 struct lsa_filter_type
{
159 uint16_t typemask
; /* bitmask for selecting LSA types (1..16) */
160 uint8_t origin
; /* selects according to origin. */
161 #define NON_SELF_ORIGINATED 0
162 #define SELF_ORIGINATED (OSPF_LSA_SELF)
165 uint8_t num_areas
; /* number of areas in the filter. */
166 /* areas, if any, go here. */
169 struct msg_register_event
{
170 struct lsa_filter_type filter
;
173 struct msg_sync_lsdb
{
174 struct lsa_filter_type filter
;
177 struct msg_originate_request
{
178 /* Used for LSA type 9 otherwise ignored */
179 struct in_addr ifaddr
;
181 /* Used for LSA type 10 otherwise ignored */
182 struct in_addr area_id
;
184 /* LSA header and LSA-specific part */
185 struct lsa_header data
;
188 struct msg_delete_request
{
189 struct in_addr area_id
; /* "0.0.0.0" for AS-external opaque LSAs */
192 uint8_t pad
[2]; /* padding */
198 #define OSPF_API_OK 0
199 #define OSPF_API_NOSUCHINTERFACE (-1)
200 #define OSPF_API_NOSUCHAREA (-2)
201 #define OSPF_API_NOSUCHLSA (-3)
202 #define OSPF_API_ILLEGALLSATYPE (-4)
203 #define OSPF_API_OPAQUETYPEINUSE (-5)
204 #define OSPF_API_OPAQUETYPENOTREGISTERED (-6)
205 #define OSPF_API_NOTREADY (-7)
206 #define OSPF_API_NOMEMORY (-8)
207 #define OSPF_API_ERROR (-9)
208 #define OSPF_API_UNDEF (-10)
209 uint8_t pad
[3]; /* padding to four byte alignment */
212 /* Message to tell client application that it ospf daemon is
213 * ready to accept opaque LSAs for a given interface or area. */
215 struct msg_ready_notify
{
218 uint8_t pad
[2]; /* padding */
219 struct in_addr addr
; /* interface address or area address */
222 /* These messages have a dynamic length depending on the embodied LSA.
223 They are aligned to four octets. msg_lsa_change_notify is used for
224 both LSA update and LSAs delete. */
226 struct msg_lsa_change_notify
{
227 /* Used for LSA type 9 otherwise ignored */
228 struct in_addr ifaddr
;
229 /* Area ID. Not valid for AS-External and Opaque11 LSAs. */
230 struct in_addr area_id
;
231 uint8_t is_self_originated
; /* 1 if self originated. */
233 struct lsa_header data
;
237 struct in_addr ifaddr
; /* interface IP address */
238 struct in_addr area_id
; /* area this interface belongs to */
242 struct in_addr ifaddr
; /* interface IP address */
245 struct msg_ism_change
{
246 struct in_addr ifaddr
; /* interface IP address */
247 struct in_addr area_id
; /* area this interface belongs to */
248 uint8_t status
; /* interface status (up/down) */
249 uint8_t pad
[3]; /* not used */
252 struct msg_nsm_change
{
253 struct in_addr ifaddr
; /* attached interface */
254 struct in_addr nbraddr
; /* Neighbor interface address */
255 struct in_addr router_id
; /* Router ID of neighbor */
256 uint8_t status
; /* NSM status */
260 struct msg_reachable_change
{
263 struct in_addr router_ids
[]; /* add followed by remove */
266 struct msg_router_id_change
{
267 struct in_addr router_id
; /* this systems router id */
270 /* We make use of a union to define a structure that covers all
271 possible API messages. This allows us to find out how much memory
272 needs to be reserved for the largest API message. */
274 struct apimsghdr hdr
;
276 struct msg_register_opaque_type register_opaque_type
;
277 struct msg_register_event register_event
;
278 struct msg_sync_lsdb sync_lsdb
;
279 struct msg_originate_request originate_request
;
280 struct msg_delete_request delete_request
;
281 struct msg_reply reply
;
282 struct msg_ready_notify ready_notify
;
283 struct msg_new_if new_if
;
284 struct msg_del_if del_if
;
285 struct msg_ism_change ism_change
;
286 struct msg_nsm_change nsm_change
;
287 struct msg_lsa_change_notify lsa_change_notify
;
288 struct msg_reachable_change reachable_change
;
289 struct msg_router_id_change router_id_change
;
293 #define OSPF_API_MAX_MSG_SIZE (sizeof(struct apimsg) + OSPF_MAX_LSA_SIZE)
295 /* -----------------------------------------------------------
296 * Prototypes for specific messages
297 * -----------------------------------------------------------
300 /* For debugging only. */
301 extern void api_opaque_lsa_print(struct ospf_lsa
*lsa
);
303 /* Messages sent by client */
304 extern struct msg
*new_msg_register_opaque_type(uint32_t seqnum
, uint8_t ltype
,
306 extern struct msg
*new_msg_register_event(uint32_t seqnum
,
307 struct lsa_filter_type
*filter
);
308 extern struct msg
*new_msg_sync_lsdb(uint32_t seqnum
,
309 struct lsa_filter_type
*filter
);
310 extern struct msg
*new_msg_originate_request(uint32_t seqnum
,
311 struct in_addr ifaddr
,
312 struct in_addr area_id
,
313 struct lsa_header
*data
);
314 extern struct msg
*new_msg_delete_request(uint32_t seqnum
,
315 struct in_addr area_id
,
316 uint8_t lsa_type
, uint8_t opaque_type
,
319 /* Messages sent by OSPF daemon */
320 extern struct msg
*new_msg_reply(uint32_t seqnum
, uint8_t rc
);
322 extern struct msg
*new_msg_ready_notify(uint32_t seqnr
, uint8_t lsa_type
,
324 struct in_addr addr
);
326 extern struct msg
*new_msg_new_if(uint32_t seqnr
, struct in_addr ifaddr
,
327 struct in_addr area
);
329 extern struct msg
*new_msg_del_if(uint32_t seqnr
, struct in_addr ifaddr
);
331 extern struct msg
*new_msg_ism_change(uint32_t seqnr
, struct in_addr ifaddr
,
332 struct in_addr area
, uint8_t status
);
334 extern struct msg
*new_msg_nsm_change(uint32_t seqnr
, struct in_addr ifaddr
,
335 struct in_addr nbraddr
,
336 struct in_addr router_id
, uint8_t status
);
338 /* msgtype is MSG_LSA_UPDATE_NOTIFY or MSG_LSA_DELETE_NOTIFY */
339 extern struct msg
*new_msg_lsa_change_notify(uint8_t msgtype
, uint32_t seqnum
,
340 struct in_addr ifaddr
,
341 struct in_addr area_id
,
342 uint8_t is_self_originated
,
343 struct lsa_header
*data
);
345 extern struct msg
*new_msg_reachable_change(uint32_t seqnum
, uint16_t nadd
,
348 struct in_addr
*remove
);
350 extern struct msg
*new_msg_router_id_change(uint32_t seqnr
,
351 struct in_addr router_id
);
352 /* string printing functions */
353 extern const char *ospf_api_errname(int errcode
);
354 extern const char *ospf_api_typename(int msgtype
);
356 #endif /* _OSPF_API_H */