Gitiles
Code Review Sign In
gerrit.opencord.org / quagga / 85136e904861775bdf6fbbbd4f0080f06e749bcb / . / ospfd / ospf_apiserver.h
blob: 9a8ae254e88b02371b8c0c424bda000afcb46601 [file] [log] [blame]
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]1/*
2 * Server side of OSPF API.
3 * Copyright (C) 2001, 2002 Ralph Keller
4 *
5 * This file is part of GNU Zebra.
6 *
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 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Zebra; see the file COPYING. If not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
21 */
22
23#ifndef _OSPF_APISERVER_H
24#define _OSPF_APISERVER_H
25
26/* MTYPE definition is not reflected to "memory.h". */
27#define MTYPE_OSPF_APISERVER MTYPE_TMP
28#define MTYPE_OSPF_APISERVER_MSGFILTER MTYPE_TMP
29
30/* List of opaque types that application registered */
31struct registered_opaque_type
32{
33 u_char lsa_type;
34 u_char opaque_type;
35};
36
37
38/* Server instance for each accepted client connection. */
39struct ospf_apiserver
40{
41 /* Socket connections for synchronous commands and asynchronous
42 notifications */
43 int fd_sync; /* synchronous requests */
44 struct sockaddr_in peer_sync;
45
46 int fd_async; /* asynchronous notifications */
47 struct sockaddr_in peer_async;
48
49 /* List of all opaque types that application registers to use. Using
50 a single connection with the OSPF daemon, multiple
51 <lsa,opaque_type> pairs can be registered. However, each
52 combination can only be registered once by all applications. */
paul87d6f872004-09-24 08:01:38 +0000[diff] [blame]53 struct list *opaque_types; /* of type registered_opaque_type */
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]54
55 /* Temporary storage for LSA instances to be refreshed. */
56 struct ospf_lsdb reserve;
57
58 /* filter for LSA update/delete notifies */
59 struct lsa_filter_type *filter;
60
61 /* Fifo buffers for outgoing messages */
62 struct msg_fifo *out_sync_fifo;
63 struct msg_fifo *out_async_fifo;
64
65 /* Read and write threads */
66 struct thread *t_sync_read;
67#ifdef USE_ASYNC_READ
68 struct thread *t_async_read;
69#endif /* USE_ASYNC_READ */
70 struct thread *t_sync_write;
71 struct thread *t_async_write;
72};
73
74enum event
75{
76 OSPF_APISERVER_ACCEPT,
77 OSPF_APISERVER_SYNC_READ,
78#ifdef USE_ASYNC_READ
79 OSPF_APISERVER_ASYNC_READ,
80#endif /* USE_ASYNC_READ */
81 OSPF_APISERVER_SYNC_WRITE,
82 OSPF_APISERVER_ASYNC_WRITE
83};
84
85/* -----------------------------------------------------------
86 * Followings are functions to manage client connections.
87 * -----------------------------------------------------------
88 */
89
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]90extern unsigned short ospf_apiserver_getport (void);
91extern int ospf_apiserver_init (void);
92extern void ospf_apiserver_term (void);
93extern struct ospf_apiserver *ospf_apiserver_new (int fd_sync, int fd_async);
94extern void ospf_apiserver_free (struct ospf_apiserver *apiserv);
95extern void ospf_apiserver_event (enum event event, int fd,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]96 struct ospf_apiserver *apiserv);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]97extern int ospf_apiserver_serv_sock_family (unsigned short port, int family);
98extern int ospf_apiserver_accept (struct thread *thread);
99extern int ospf_apiserver_read (struct thread *thread);
100extern int ospf_apiserver_sync_write (struct thread *thread);
101extern int ospf_apiserver_async_write (struct thread *thread);
102extern int ospf_apiserver_send_reply (struct ospf_apiserver *apiserv,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]103 u_int32_t seqnr, u_char rc);
104
105/* -----------------------------------------------------------
106 * Followings are message handler functions
107 * -----------------------------------------------------------
108 */
109
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]110extern int ospf_apiserver_lsa9_originator (void *arg);
111extern int ospf_apiserver_lsa10_originator (void *arg);
112extern int ospf_apiserver_lsa11_originator (void *arg);
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]113
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]114extern void ospf_apiserver_clients_notify_all (struct msg *msg);
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]115
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]116extern void ospf_apiserver_clients_notify_ready_type9 (struct ospf_interface *oi);
117extern void ospf_apiserver_clients_notify_ready_type10 (struct ospf_area *area);
118extern void ospf_apiserver_clients_notify_ready_type11 (struct ospf *top);
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]119
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]120extern void ospf_apiserver_clients_notify_new_if (struct ospf_interface *oi);
121extern void ospf_apiserver_clients_notify_del_if (struct ospf_interface *oi);
122extern void ospf_apiserver_clients_notify_ism_change (struct ospf_interface *oi);
123extern void ospf_apiserver_clients_notify_nsm_change (struct ospf_neighbor *nbr);
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]124
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]125extern int ospf_apiserver_is_ready_type9 (struct ospf_interface *oi);
126extern int ospf_apiserver_is_ready_type10 (struct ospf_area *area);
127extern int ospf_apiserver_is_ready_type11 (struct ospf *ospf);
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]128
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]129extern void ospf_apiserver_notify_ready_type9 (struct ospf_apiserver *apiserv);
130extern void ospf_apiserver_notify_ready_type10 (struct ospf_apiserver *apiserv);
131extern void ospf_apiserver_notify_ready_type11 (struct ospf_apiserver *apiserv);
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]132
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]133extern int ospf_apiserver_handle_msg (struct ospf_apiserver *apiserv,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]134 struct msg *msg);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]135extern int ospf_apiserver_handle_register_opaque_type (struct ospf_apiserver
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]136 *apiserv, struct msg *msg);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]137extern int ospf_apiserver_handle_unregister_opaque_type (struct ospf_apiserver
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]138 *apiserv, struct msg *msg);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]139extern int ospf_apiserver_handle_register_event (struct ospf_apiserver *apiserv,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]140 struct msg *msg);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]141extern int ospf_apiserver_handle_originate_request (struct ospf_apiserver *apiserv,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]142 struct msg *msg);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]143extern int ospf_apiserver_handle_delete_request (struct ospf_apiserver *apiserv,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]144 struct msg *msg);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]145extern int ospf_apiserver_handle_sync_lsdb (struct ospf_apiserver *apiserv,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]146 struct msg *msg);
147
148
149/* -----------------------------------------------------------
150 * Followings are functions for LSA origination/deletion
151 * -----------------------------------------------------------
152 */
153
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]154extern int ospf_apiserver_register_opaque_type (struct ospf_apiserver *apiserver,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]155 u_char lsa_type, u_char opaque_type);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]156extern int ospf_apiserver_unregister_opaque_type (struct ospf_apiserver *apiserver,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]157 u_char lsa_type,
158 u_char opaque_type);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]159extern struct ospf_lsa *ospf_apiserver_opaque_lsa_new (struct ospf_area *area,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]160 struct ospf_interface *oi,
161 struct lsa_header *protolsa);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]162extern struct ospf_interface *ospf_apiserver_if_lookup_by_addr (struct in_addr
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]163 address);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]164extern struct ospf_interface *ospf_apiserver_if_lookup_by_ifp (struct interface
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]165 *ifp);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]166extern int ospf_apiserver_originate1 (struct ospf_lsa *lsa);
167extern void ospf_apiserver_flood_opaque_lsa (struct ospf_lsa *lsa);
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]168
169
170/* -----------------------------------------------------------
171 * Followings are callback functions to handle opaque types
172 * -----------------------------------------------------------
173 */
174
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]175extern int ospf_apiserver_new_if (struct interface *ifp);
176extern int ospf_apiserver_del_if (struct interface *ifp);
177extern void ospf_apiserver_ism_change (struct ospf_interface *oi, int old_status);
178extern void ospf_apiserver_nsm_change (struct ospf_neighbor *nbr, int old_status);
179extern void ospf_apiserver_config_write_router (struct vty *vty);
180extern void ospf_apiserver_config_write_if (struct vty *vty, struct interface *ifp);
181extern void ospf_apiserver_show_info (struct vty *vty, struct ospf_lsa *lsa);
182extern int ospf_ospf_apiserver_lsa_originator (void *arg);
183extern void ospf_apiserver_lsa_refresher (struct ospf_lsa *lsa);
184extern void ospf_apiserver_flush_opaque_lsa (struct ospf_apiserver *apiserv,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]185 u_char lsa_type, u_char opaque_type);
186
187/* -----------------------------------------------------------
188 * Followings are hooks when LSAs are updated or deleted
189 * -----------------------------------------------------------
190 */
191
192
193/* Hooks that are invoked from ospf opaque module */
194
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]195extern int ospf_apiserver_lsa_update (struct ospf_lsa *lsa);
196extern int ospf_apiserver_lsa_delete (struct ospf_lsa *lsa);
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]197
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]198extern void ospf_apiserver_clients_lsa_change_notify (u_char msgtype,
paul2d33f152003-03-17 01:10:58 +0000[diff] [blame]199 struct ospf_lsa *lsa);
200
201#endif /* _OSPF_APISERVER_H */