This plugin now includes datatypes directly from olsrd source
[olsrd.git] / lib / dot_draw / src / olsrd_plugin.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  * $Id: olsrd_plugin.h,v 1.13 2005/02/19 17:51:10 kattemat Exp $
40  */
41
42 /*
43  * Dynamic linked library for the olsr.org olsr daemon
44  */
45
46 #ifndef _OLSRD_PLUGIN_DEFS
47 #define _OLSRD_PLUGIN_DEFS
48
49
50 #include <sys/socket.h>
51 #include <netinet/in.h>
52 #include <arpa/inet.h>
53 #include <sys/time.h>
54 #include <time.h>
55 #include <math.h>
56
57 #include "olsr_plugin_io.h"
58
59 #include "olsr_protocol.h"
60 #include "neighbor_table.h"
61 #include "two_hop_neighbor_table.h"
62 #include "tc_set.h"
63 /* hna_netmask (declared in packet.h) */
64 union hna_netmask
65 {
66   olsr_u32_t v4;
67   olsr_u16_t v6;
68 };
69 #include "hna_set.h"
70 #include "mid_set.h"
71 #include "link_set.h"
72
73 /*****************************************************************************
74  *                               Plugin data                                 *
75  *                       ALTER THIS TO YOUR OWN NEED                         *
76  *****************************************************************************/
77
78 #define PLUGIN_NAME    "OLSRD dot draw plugin"
79 #define PLUGIN_VERSION "0.3"
80 #define PLUGIN_AUTHOR   "Andreas T√łnnesen"
81 #define MOD_DESC PLUGIN_NAME " " PLUGIN_VERSION " by " PLUGIN_AUTHOR
82 #define PLUGIN_INTERFACE_VERSION 2
83
84 struct in_addr ipc_accept_ip;
85 int ipc_port;
86
87 /* The lists */
88
89 struct neighbor_entry *neighbortable;
90 struct neighbor_2_entry *two_hop_neighbortable;
91 struct tc_entry *tc_table;
92 struct hna_entry *hna_set;
93 struct link_entry *link_set;
94
95 /* Buffer for olsr_ip_to_string */
96
97 char ipv6_buf[100]; /* buffer for IPv6 inet_htop */
98
99
100 /****************************************************************************
101  *                Function pointers to functions in olsrd                   *
102  *              These allow direct access to olsrd functions                *
103  ****************************************************************************/
104
105 /* The multi-purpose funtion. All other functions are fetched trough this */
106 int (*olsr_plugin_io)(int, void *, size_t);
107
108 /* Register a "process changes" function */
109 int (*register_pcf)(int (*)(int, int, int));
110
111 /* Add a socket to the main olsrd select loop */
112 void (*add_olsr_socket)(int, void(*)(int));
113
114 /* Remove a socket from the main olsrd select loop */
115 int (*remove_olsr_socket)(int, void(*)(int));
116
117 /* get the link status to a neighbor */
118 int (*check_neighbor_link)(union olsr_ip_addr *);
119
120 /* olsrd printf wrapper */
121 int (*olsr_printf)(int, char *, ...);
122
123 /* olsrd malloc wrapper */
124 void *(*olsr_malloc)(size_t, const char *);
125
126
127 /****************************************************************************
128  *                             Data from olsrd                              *
129  *           NOTE THAT POINTERS POINT TO THE DATA USED BY OLSRD!            *
130  *               NEVER ALTER DATA POINTED TO BY THESE POINTERS              * 
131  *                   UNLESS YOU KNOW WHAT YOU ARE DOING!!!                  *
132  ****************************************************************************/
133
134 /* These two are set automatically by olsrd at load time */
135 int                ipversion;  /* IPversion in use */
136 union olsr_ip_addr *main_addr; /* Main address */
137
138
139 size_t             ipsize;     /* Size of the ipadresses used */
140
141 /****************************************************************************
142  *                Functions that the plugin MUST provide                    *
143  ****************************************************************************/
144
145
146 /* Initialization function */
147 int
148 olsr_plugin_init(void);
149
150 /* IPC initialization function */
151 int
152 plugin_ipc_init(void);
153
154 int
155 register_olsr_param(char *, char *);
156
157 /* Destructor function */
158 void
159 olsr_plugin_exit(void);
160
161 /* Mulitpurpose funtion */
162 int
163 plugin_io(int, void *, size_t);
164
165 int 
166 get_plugin_interface_version(void);
167
168 #endif