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