564e1f737b7b8abc97699bd9ab2fd25ea21ec783
[olsrd.git] / src / lq_packet.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Thomas Lopatic (thomas@lopatic.de)
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: lq_packet.h,v 1.10 2007/11/16 22:56:54 bernd67 Exp $
40  */
41
42 #ifndef _OLSR_LQ_PACKET_H
43 #define _OLSR_LQ_PACKET_H
44
45 #include "olsr_types.h"
46 #include "packet.h"
47 #include "mantissa.h"
48
49 #define LQ_HELLO_MESSAGE      201
50 #define LQ_TC_MESSAGE         202
51
52 // deserialized OLSR header
53
54 struct olsr_common
55 {
56   olsr_u8_t          type;
57   double             vtime;
58   olsr_u16_t         size;
59   union olsr_ip_addr orig;
60   olsr_u8_t          ttl;
61   olsr_u8_t          hops;
62   olsr_u16_t         seqno;
63 };
64
65 // serialized IPv4 OLSR header
66
67 struct olsr_header_v4
68 {
69   olsr_u8_t  type;
70   olsr_u8_t  vtime;
71   olsr_u16_t size;
72   olsr_u32_t orig;
73   olsr_u8_t  ttl;
74   olsr_u8_t  hops;
75   olsr_u16_t seqno;
76 };
77
78 // serialized IPv6 OLSR header
79
80 struct olsr_header_v6
81 {
82   olsr_u8_t     type;
83   olsr_u8_t     vtime;
84   olsr_u16_t    size;
85   unsigned char orig[16];
86   olsr_u8_t     ttl;
87   olsr_u8_t     hops;
88   olsr_u16_t    seqno;
89 };
90
91 // deserialized LQ_HELLO
92
93 struct lq_hello_neighbor
94 {
95   olsr_u8_t                link_type;
96   olsr_u8_t                neigh_type;
97   double                   link_quality;
98   double                   neigh_link_quality;
99   union olsr_ip_addr       addr;
100   struct lq_hello_neighbor *next;
101 };
102
103 struct lq_hello_message
104 {
105   struct olsr_common       comm;
106   double                   htime;
107   olsr_u8_t                will;
108   struct lq_hello_neighbor *neigh;
109 };
110
111 // serialized LQ_HELLO
112
113 struct lq_hello_info_header
114 {
115   olsr_u8_t  link_code;
116   olsr_u8_t  reserved;
117   olsr_u16_t size;
118 };
119
120 struct lq_hello_header
121 {
122   olsr_u16_t reserved;
123   olsr_u8_t  htime;
124   olsr_u8_t  will;
125 };
126
127 // deserialized LQ_TC
128 struct lq_tc_message
129 {
130   struct olsr_common    comm;
131   union olsr_ip_addr    from;
132   olsr_u16_t            ansn;
133   struct tc_mpr_addr    *neigh;
134 };
135
136 // serialized LQ_TC
137
138 struct lq_tc_header
139 {
140   olsr_u16_t ansn;
141   olsr_u16_t reserved;
142 };
143
144 static INLINE void        pkt_get_u8(const olsr_u8_t **p, olsr_u8_t  *var)         { *var =       *(const olsr_u8_t *)(*p);   *p += sizeof(olsr_u8_t); }
145 static INLINE void       pkt_get_u16(const olsr_u8_t **p, olsr_u16_t *var)         { *var = ntohs(*(const olsr_u16_t *)(*p)); *p += sizeof(olsr_u16_t); }
146 static INLINE void       pkt_get_u32(const olsr_u8_t **p, olsr_u32_t *var)         { *var = ntohl(*(const olsr_u32_t *)(p));  *p += sizeof(olsr_u32_t); }
147 static INLINE void        pkt_get_s8(const olsr_u8_t **p, olsr_8_t  *var)          { *var =       *(const olsr_8_t *)(*p);    *p += sizeof(olsr_8_t); }
148 static INLINE void       pkt_get_s16(const olsr_u8_t **p, olsr_16_t *var)          { *var = ntohs(*(const olsr_16_t *)(*p));  *p += sizeof(olsr_16_t); }
149 static INLINE void       pkt_get_s32(const olsr_u8_t **p, olsr_32_t *var)          { *var = ntohl(*(const olsr_32_t *)(*p));  *p += sizeof(olsr_32_t); }
150 static INLINE void    pkt_get_double(const olsr_u8_t **p, double *var)             { *var = me_to_double(**p);                *p += sizeof(olsr_u8_t); }
151 static INLINE void pkt_get_ipaddress(const olsr_u8_t **p, union olsr_ip_addr *var) { memcpy(var, *p, olsr_cnf->ipsize);       *p += olsr_cnf->ipsize; }
152 static INLINE void        pkt_get_lq(const olsr_u8_t **p, double *var)             { *var = (const double)**p / 255.0;        *p += sizeof(olsr_u8_t); }
153
154 static INLINE void        pkt_ignore_u8(const olsr_u8_t **p) { *p += sizeof(olsr_u8_t); }
155 static INLINE void       pkt_ignore_u16(const olsr_u8_t **p) { *p += sizeof(olsr_u16_t); }
156 static INLINE void       pkt_ignore_u32(const olsr_u8_t **p) { *p += sizeof(olsr_u32_t); }
157 static INLINE void        pkt_ignore_s8(const olsr_u8_t **p) { *p += sizeof(olsr_8_t); }
158 static INLINE void       pkt_ignore_s16(const olsr_u8_t **p) { *p += sizeof(olsr_16_t); }
159 static INLINE void       pkt_ignore_s32(const olsr_u8_t **p) { *p += sizeof(olsr_32_t); }
160 static INLINE void pkt_ignore_ipaddress(const olsr_u8_t **p) { *p += olsr_cnf->ipsize; }
161
162 static INLINE void        pkt_put_u8(olsr_u8_t **p, const olsr_u8_t  var)         { *(olsr_u8_t *)(*p)  = var;        *p += sizeof(olsr_u8_t); }
163 static INLINE void       pkt_put_u16(olsr_u8_t **p, const olsr_u16_t var)         { *(olsr_u16_t *)(*p) = htons(var); *p += sizeof(olsr_u16_t); }
164 static INLINE void       pkt_put_u32(olsr_u8_t **p, const olsr_u32_t var)         { *(olsr_u32_t *)(*p) = htonl(var); *p += sizeof(olsr_u32_t); }
165 static INLINE void        pkt_put_s8(olsr_u8_t **p, const olsr_8_t  var)          { *(olsr_8_t *)(*p)   = var;        *p += sizeof(olsr_8_t); }
166 static INLINE void       pkt_put_s16(olsr_u8_t **p, const olsr_16_t var)          { *(olsr_16_t *)(*p)  = htons(var); *p += sizeof(olsr_16_t); }
167 static INLINE void       pkt_put_s32(olsr_u8_t **p, const olsr_32_t var)          { *(olsr_32_t *)(*p)  = htonl(var); *p += sizeof(olsr_32_t); }
168 static INLINE void    pkt_put_double(olsr_u8_t **p, const double var)             { **p = double_to_me(var);          *p += sizeof(olsr_u8_t); }
169 static INLINE void pkt_put_ipaddress(olsr_u8_t **p, const union olsr_ip_addr var) { memcpy(*p, &var, olsr_cnf->ipsize); *p += olsr_cnf->ipsize; }
170 static INLINE void        pkt_put_lq(olsr_u8_t **p, const double var)             { **p  = var * 255.0;               *p += sizeof(olsr_u8_t); }
171
172 void olsr_output_lq_hello(void *para);
173
174 void olsr_output_lq_tc(void *para);
175
176 void olsr_input_lq_hello(union olsr_message *ser, struct interface *inif,
177                          union olsr_ip_addr *from);
178
179 extern olsr_bool lq_tc_pending;
180
181 #endif