]> git.proxmox.com Git - mirror_frr.git/blame - ospfd/ospf_api.h
Merge pull request #5793 from ton31337/fix/formatting_show_bgp_summary_failed
[mirror_frr.git] / ospfd / ospf_api.h
CommitLineData
2d33f157 1/*
2 * API message handling module for OSPF daemon and client.
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
23/* This file is used both by the OSPFd and client applications to
24 define message formats used for communication. */
25
26#ifndef _OSPF_API_H
27#define _OSPF_API_H
28
29#define OSPF_API_VERSION 1
30
31/* MTYPE definition is not reflected to "memory.h". */
32#define MTYPE_OSPF_API_MSG MTYPE_TMP
33#define MTYPE_OSPF_API_FIFO MTYPE_TMP
34
35/* Default API server port to accept connection request from client-side. */
36/* This value could be overridden by "ospfapi" entry in "/etc/services". */
37#define OSPF_API_SYNC_PORT 2607
38
39/* -----------------------------------------------------------
d62a17ae 40 * Generic messages
2d33f157 41 * -----------------------------------------------------------
42 */
43
44/* Message header structure, fields are in network byte order and
45 aligned to four octets. */
d62a17ae 46struct apimsghdr {
d7c0a89a
QY
47 uint8_t version; /* OSPF API protocol version */
48 uint8_t msgtype; /* Type of message */
49 uint16_t msglen; /* Length of message w/o header */
50 uint32_t msgseq; /* Sequence number */
2d33f157 51};
52
53/* Message representation with header and body */
d62a17ae 54struct msg {
55 struct msg *next; /* to link into fifo */
2d33f157 56
d62a17ae 57 /* Message header */
58 struct apimsghdr hdr;
2d33f157 59
d62a17ae 60 /* Message body */
61 struct stream *s;
2d33f157 62};
63
64/* Prototypes for generic messages. */
d7c0a89a
QY
65extern struct msg *msg_new(uint8_t msgtype, void *msgbody, uint32_t seqnum,
66 uint16_t msglen);
d62a17ae 67extern struct msg *msg_dup(struct msg *msg);
68extern void msg_print(struct msg *msg); /* XXX debug only */
69extern void msg_free(struct msg *msg);
70struct msg *msg_read(int fd);
71extern int msg_write(int fd, struct msg *msg);
2d33f157 72
73/* For requests, the message sequence number is between MIN_SEQ and
74 MAX_SEQ. For notifications, the sequence number is 0. */
75
76#define MIN_SEQ 1
77#define MAX_SEQ 2147483647
78
d7c0a89a
QY
79extern void msg_set_seq(struct msg *msg, uint32_t seqnr);
80extern uint32_t msg_get_seq(struct msg *msg);
2d33f157 81
82/* -----------------------------------------------------------
83 * Message fifo queues
84 * -----------------------------------------------------------
85 */
86
87/* Message queue structure. */
d62a17ae 88struct msg_fifo {
89 unsigned long count;
2d33f157 90
d62a17ae 91 struct msg *head;
92 struct msg *tail;
2d33f157 93};
94
95/* Prototype for message fifo queues. */
d62a17ae 96extern struct msg_fifo *msg_fifo_new(void);
97extern void msg_fifo_push(struct msg_fifo *, struct msg *msg);
98extern struct msg *msg_fifo_pop(struct msg_fifo *fifo);
99extern struct msg *msg_fifo_head(struct msg_fifo *fifo);
100extern void msg_fifo_flush(struct msg_fifo *fifo);
101extern void msg_fifo_free(struct msg_fifo *fifo);
2d33f157 102
103/* -----------------------------------------------------------
104 * Specific message type and format definitions
105 * -----------------------------------------------------------
106 */
107
108/* Messages to OSPF daemon. */
109#define MSG_REGISTER_OPAQUETYPE 1
110#define MSG_UNREGISTER_OPAQUETYPE 2
111#define MSG_REGISTER_EVENT 3
112#define MSG_SYNC_LSDB 4
113#define MSG_ORIGINATE_REQUEST 5
114#define MSG_DELETE_REQUEST 6
115
116/* Messages from OSPF daemon. */
117#define MSG_REPLY 10
118#define MSG_READY_NOTIFY 11
119#define MSG_LSA_UPDATE_NOTIFY 12
120#define MSG_LSA_DELETE_NOTIFY 13
121#define MSG_NEW_IF 14
122#define MSG_DEL_IF 15
123#define MSG_ISM_CHANGE 16
124#define MSG_NSM_CHANGE 17
125
d62a17ae 126struct msg_register_opaque_type {
d7c0a89a
QY
127 uint8_t lsatype;
128 uint8_t opaquetype;
129 uint8_t pad[2]; /* padding */
2d33f157 130};
131
d62a17ae 132struct msg_unregister_opaque_type {
d7c0a89a
QY
133 uint8_t lsatype;
134 uint8_t opaquetype;
135 uint8_t pad[2]; /* padding */
2d33f157 136};
137
138/* Power2 is needed to convert LSA types into bit positions,
139 * see typemask below. Type definition starts at 1, so
140 * Power2[0] is not used. */
141
142
d7c0a89a 143static const uint16_t Power2[] = {
d62a17ae 144 0, (1 << 0), (1 << 1), (1 << 2), (1 << 3), (1 << 4),
145 (1 << 5), (1 << 6), (1 << 7), (1 << 8), (1 << 9), (1 << 10),
146 (1 << 11), (1 << 12), (1 << 13), (1 << 14), (1 << 15)};
2d33f157 147
d62a17ae 148struct lsa_filter_type {
d7c0a89a
QY
149 uint16_t typemask; /* bitmask for selecting LSA types (1..16) */
150 uint8_t origin; /* selects according to origin. */
2d33f157 151#define NON_SELF_ORIGINATED 0
152#define SELF_ORIGINATED (OSPF_LSA_SELF)
153#define ANY_ORIGIN 2
154
d7c0a89a
QY
155 uint8_t num_areas; /* number of areas in the filter. */
156 /* areas, if any, go here. */
2d33f157 157};
158
d62a17ae 159struct msg_register_event {
160 struct lsa_filter_type filter;
2d33f157 161};
162
d62a17ae 163struct msg_sync_lsdb {
164 struct lsa_filter_type filter;
2d33f157 165};
166
d62a17ae 167struct msg_originate_request {
168 /* Used for LSA type 9 otherwise ignored */
169 struct in_addr ifaddr;
2d33f157 170
d62a17ae 171 /* Used for LSA type 10 otherwise ignored */
172 struct in_addr area_id;
2d33f157 173
d62a17ae 174 /* LSA header and LSA-specific part */
175 struct lsa_header data;
2d33f157 176};
177
d62a17ae 178struct msg_delete_request {
179 struct in_addr area_id; /* "0.0.0.0" for AS-external opaque LSAs */
d7c0a89a
QY
180 uint8_t lsa_type;
181 uint8_t opaque_type;
182 uint8_t pad[2]; /* padding */
183 uint32_t opaque_id;
2d33f157 184};
185
d62a17ae 186struct msg_reply {
187 signed char errcode;
2d33f157 188#define OSPF_API_OK 0
189#define OSPF_API_NOSUCHINTERFACE (-1)
190#define OSPF_API_NOSUCHAREA (-2)
191#define OSPF_API_NOSUCHLSA (-3)
192#define OSPF_API_ILLEGALLSATYPE (-4)
193#define OSPF_API_OPAQUETYPEINUSE (-5)
194#define OSPF_API_OPAQUETYPENOTREGISTERED (-6)
195#define OSPF_API_NOTREADY (-7)
196#define OSPF_API_NOMEMORY (-8)
197#define OSPF_API_ERROR (-9)
198#define OSPF_API_UNDEF (-10)
d7c0a89a 199 uint8_t pad[3]; /* padding to four byte alignment */
2d33f157 200};
201
d62a17ae 202/* Message to tell client application that it ospf daemon is
2d33f157 203 * ready to accept opaque LSAs for a given interface or area. */
204
d62a17ae 205struct msg_ready_notify {
d7c0a89a
QY
206 uint8_t lsa_type;
207 uint8_t opaque_type;
208 uint8_t pad[2]; /* padding */
d62a17ae 209 struct in_addr addr; /* interface address or area address */
2d33f157 210};
211
212/* These messages have a dynamic length depending on the embodied LSA.
213 They are aligned to four octets. msg_lsa_change_notify is used for
214 both LSA update and LSAs delete. */
215
d62a17ae 216struct msg_lsa_change_notify {
217 /* Used for LSA type 9 otherwise ignored */
218 struct in_addr ifaddr;
219 /* Area ID. Not valid for AS-External and Opaque11 LSAs. */
220 struct in_addr area_id;
d7c0a89a
QY
221 uint8_t is_self_originated; /* 1 if self originated. */
222 uint8_t pad[3];
d62a17ae 223 struct lsa_header data;
2d33f157 224};
225
d62a17ae 226struct msg_new_if {
227 struct in_addr ifaddr; /* interface IP address */
228 struct in_addr area_id; /* area this interface belongs to */
2d33f157 229};
230
d62a17ae 231struct msg_del_if {
232 struct in_addr ifaddr; /* interface IP address */
2d33f157 233};
234
d62a17ae 235struct msg_ism_change {
236 struct in_addr ifaddr; /* interface IP address */
237 struct in_addr area_id; /* area this interface belongs to */
d7c0a89a
QY
238 uint8_t status; /* interface status (up/down) */
239 uint8_t pad[3]; /* not used */
2d33f157 240};
241
d62a17ae 242struct msg_nsm_change {
243 struct in_addr ifaddr; /* attached interface */
244 struct in_addr nbraddr; /* Neighbor interface address */
245 struct in_addr router_id; /* Router ID of neighbor */
d7c0a89a
QY
246 uint8_t status; /* NSM status */
247 uint8_t pad[3];
2d33f157 248};
249
250/* We make use of a union to define a structure that covers all
251 possible API messages. This allows us to find out how much memory
252 needs to be reserved for the largest API message. */
d62a17ae 253struct apimsg {
254 struct apimsghdr hdr;
255 union {
256 struct msg_register_opaque_type register_opaque_type;
257 struct msg_register_event register_event;
258 struct msg_sync_lsdb sync_lsdb;
259 struct msg_originate_request originate_request;
260 struct msg_delete_request delete_request;
261 struct msg_reply reply;
262 struct msg_ready_notify ready_notify;
263 struct msg_new_if new_if;
264 struct msg_del_if del_if;
265 struct msg_ism_change ism_change;
266 struct msg_nsm_change nsm_change;
267 struct msg_lsa_change_notify lsa_change_notify;
268 } u;
2d33f157 269};
270
271#define OSPF_API_MAX_MSG_SIZE (sizeof(struct apimsg) + OSPF_MAX_LSA_SIZE)
272
273/* -----------------------------------------------------------
274 * Prototypes for specific messages
275 * -----------------------------------------------------------
276 */
277
278/* For debugging only. */
d62a17ae 279extern void api_opaque_lsa_print(struct lsa_header *data);
2d33f157 280
281/* Messages sent by client */
d7c0a89a
QY
282extern struct msg *new_msg_register_opaque_type(uint32_t seqnum, uint8_t ltype,
283 uint8_t otype);
284extern struct msg *new_msg_register_event(uint32_t seqnum,
d62a17ae 285 struct lsa_filter_type *filter);
d7c0a89a 286extern struct msg *new_msg_sync_lsdb(uint32_t seqnum,
d62a17ae 287 struct lsa_filter_type *filter);
d7c0a89a 288extern struct msg *new_msg_originate_request(uint32_t seqnum,
d62a17ae 289 struct in_addr ifaddr,
290 struct in_addr area_id,
291 struct lsa_header *data);
d7c0a89a 292extern struct msg *new_msg_delete_request(uint32_t seqnum,
d62a17ae 293 struct in_addr area_id,
d7c0a89a
QY
294 uint8_t lsa_type, uint8_t opaque_type,
295 uint32_t opaque_id);
2d33f157 296
297/* Messages sent by OSPF daemon */
d7c0a89a 298extern struct msg *new_msg_reply(uint32_t seqnum, uint8_t rc);
2d33f157 299
d7c0a89a
QY
300extern struct msg *new_msg_ready_notify(uint32_t seqnr, uint8_t lsa_type,
301 uint8_t opaque_type,
d62a17ae 302 struct in_addr addr);
2d33f157 303
d7c0a89a 304extern struct msg *new_msg_new_if(uint32_t seqnr, struct in_addr ifaddr,
d62a17ae 305 struct in_addr area);
2d33f157 306
d7c0a89a 307extern struct msg *new_msg_del_if(uint32_t seqnr, struct in_addr ifaddr);
2d33f157 308
d7c0a89a
QY
309extern struct msg *new_msg_ism_change(uint32_t seqnr, struct in_addr ifaddr,
310 struct in_addr area, uint8_t status);
2d33f157 311
d7c0a89a 312extern struct msg *new_msg_nsm_change(uint32_t seqnr, struct in_addr ifaddr,
d62a17ae 313 struct in_addr nbraddr,
d7c0a89a 314 struct in_addr router_id, uint8_t status);
2d33f157 315
316/* msgtype is MSG_LSA_UPDATE_NOTIFY or MSG_LSA_DELETE_NOTIFY */
d7c0a89a 317extern struct msg *new_msg_lsa_change_notify(uint8_t msgtype, uint32_t seqnum,
d62a17ae 318 struct in_addr ifaddr,
319 struct in_addr area_id,
d7c0a89a 320 uint8_t is_self_originated,
d62a17ae 321 struct lsa_header *data);
2d33f157 322
323/* string printing functions */
d62a17ae 324extern const char *ospf_api_errname(int errcode);
325extern const char *ospf_api_typename(int msgtype);
2d33f157 326
327#endif /* _OSPF_API_H */