Implement lid_length mechanism into DLEP
[oonf.git] / src-plugins / generic / dlep / ext_lid / lid.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, the olsr.org team - see HISTORY file
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  */
41
42 /**
43  * @file
44  */
45
46 #include "common/autobuf.h"
47 #include "common/avl.h"
48 #include "common/common_types.h"
49 #include "subsystems/oonf_timer.h"
50
51 #include "dlep/dlep_extension.h"
52 #include "dlep/dlep_iana.h"
53 #include "dlep/dlep_reader.h"
54 #include "dlep/dlep_writer.h"
55
56 #include "dlep/ext_lid/lid.h"
57
58 static void _cb_session_deactivate(struct dlep_session *session);
59 static int _write_lid_only(struct dlep_extension *ext, struct dlep_session *session, const struct oonf_layer2_neigh_key *neigh);
60 static int _write_session_init_ack(struct dlep_extension *ext, struct dlep_session *session, const struct oonf_layer2_neigh_key *neigh);
61 static enum dlep_parser_error _process_session_init_ack(struct dlep_extension *ext, struct dlep_session *session);
62
63 /* session initialization ack */
64 static const uint16_t _session_initack_tlvs[] = {
65   DLEP_LID_LENGTH_TLV,
66 };
67
68 /* destination up */
69 static const uint16_t _dst_up_tlvs[] = {
70   DLEP_LID_TLV,
71 };
72 static const uint16_t _dst_up_mandatory[] = {
73   DLEP_LID_TLV,
74 };
75
76 /* destination up ack */
77 static const uint16_t _dst_up_ack_tlvs[] = {
78   DLEP_LID_TLV,
79 };
80 static const uint16_t _dst_up_ack_mandatory[] = {
81   DLEP_LID_TLV,
82 };
83
84 /* destination down */
85 static const uint16_t _dst_down_tlvs[] = {
86   DLEP_LID_TLV,
87 };
88 static const uint16_t _dst_down_mandatory[] = {
89   DLEP_LID_TLV,
90 };
91
92 /* destination down ack */
93 static const uint16_t _dst_down_ack_tlvs[] = {
94   DLEP_LID_TLV,
95 };
96 static const uint16_t _dst_down_ack_mandatory[] = {
97   DLEP_LID_TLV,
98 };
99
100 /* destination update */
101 static const uint16_t _dst_update_tlvs[] = {
102   DLEP_LID_TLV,
103 };
104 static const uint16_t _dst_update_mandatory[] = {
105   DLEP_MAC_ADDRESS_TLV,
106 };
107
108 /* link characteristics request */
109 static const uint16_t _linkchar_req_tlvs[] = {
110   DLEP_LID_TLV,
111 };
112 static const uint16_t _linkchar_req_mandatory[] = {
113   DLEP_LID_TLV,
114 };
115
116 /* link characteristics ack */
117 static const uint16_t _linkchar_ack_tlvs[] = {
118   DLEP_LID_TLV,
119 };
120 static const uint16_t _linkchar_ack_mandatory[] = {
121   DLEP_LID_TLV,
122 };
123
124 /* supported signals of this extension, parsing the LID TLV is done by dlep_extension */
125 static struct dlep_extension_signal _signals[] = {
126   {
127     .id = DLEP_SESSION_INITIALIZATION_ACK,
128     .supported_tlvs = _session_initack_tlvs,
129     .supported_tlv_count = ARRAYSIZE(_session_initack_tlvs),
130     .process_radio = _process_session_init_ack,
131     .add_router_tlvs = _write_session_init_ack,
132   },
133   {
134     .id = DLEP_DESTINATION_UP,
135     .supported_tlvs = _dst_up_tlvs,
136     .supported_tlv_count = ARRAYSIZE(_dst_up_tlvs),
137     .mandatory_tlvs = _dst_up_mandatory,
138     .mandatory_tlv_count = ARRAYSIZE(_dst_up_mandatory),
139     .add_radio_tlvs = _write_lid_only,
140   },
141   {
142     .id = DLEP_DESTINATION_UP_ACK,
143     .supported_tlvs = _dst_up_ack_tlvs,
144     .supported_tlv_count = ARRAYSIZE(_dst_up_ack_tlvs),
145     .mandatory_tlvs = _dst_up_ack_mandatory,
146     .mandatory_tlv_count = ARRAYSIZE(_dst_up_ack_mandatory),
147     .add_router_tlvs = _write_lid_only,
148   },
149   {
150     .id = DLEP_DESTINATION_DOWN,
151     .supported_tlvs = _dst_down_tlvs,
152     .supported_tlv_count = ARRAYSIZE(_dst_down_tlvs),
153     .mandatory_tlvs = _dst_down_mandatory,
154     .mandatory_tlv_count = ARRAYSIZE(_dst_down_mandatory),
155     .add_radio_tlvs = _write_lid_only,
156   },
157   {
158     .id = DLEP_DESTINATION_DOWN_ACK,
159     .supported_tlvs = _dst_down_ack_tlvs,
160     .supported_tlv_count = ARRAYSIZE(_dst_down_ack_tlvs),
161     .mandatory_tlvs = _dst_down_ack_mandatory,
162     .mandatory_tlv_count = ARRAYSIZE(_dst_down_ack_mandatory),
163     .add_router_tlvs = _write_lid_only,
164   },
165   {
166     .id = DLEP_DESTINATION_UPDATE,
167     .supported_tlvs = _dst_update_tlvs,
168     .supported_tlv_count = ARRAYSIZE(_dst_update_tlvs),
169     .mandatory_tlvs = _dst_update_mandatory,
170     .mandatory_tlv_count = ARRAYSIZE(_dst_update_mandatory),
171     .add_radio_tlvs = _write_lid_only,
172   },
173   {
174     .id = DLEP_LINK_CHARACTERISTICS_REQUEST,
175     .supported_tlvs = _linkchar_req_tlvs,
176     .supported_tlv_count = ARRAYSIZE(_linkchar_req_tlvs),
177     .mandatory_tlvs = _linkchar_req_mandatory,
178     .mandatory_tlv_count = ARRAYSIZE(_linkchar_req_mandatory),
179     .add_router_tlvs = _write_lid_only,
180   },
181   {
182     .id = DLEP_LINK_CHARACTERISTICS_ACK,
183     .supported_tlvs = _linkchar_ack_tlvs,
184     .supported_tlv_count = ARRAYSIZE(_linkchar_ack_tlvs),
185     .mandatory_tlvs = _linkchar_ack_mandatory,
186     .mandatory_tlv_count = ARRAYSIZE(_linkchar_ack_mandatory),
187     .add_radio_tlvs = _write_lid_only,
188   },
189 };
190
191 /* supported TLVs of this extension */
192 static struct dlep_extension_tlv _tlvs[] = {
193   { DLEP_LID_TLV, 1, OONF_LAYER2_MAX_LINK_ID },
194 };
195
196 /* DLEP base extension, radio side */
197 static struct dlep_extension _lid = {
198   .id = DLEP_EXTENSION_LINK_ID,
199   .name = "linkid",
200
201   .signals = _signals,
202   .signal_count = ARRAYSIZE(_signals),
203   .tlvs = _tlvs,
204   .tlv_count = ARRAYSIZE(_tlvs),
205
206   .cb_session_deactivate_radio = _cb_session_deactivate,
207   .cb_session_deactivate_router = _cb_session_deactivate,
208 };
209
210 /**
211  * Get link-id DLEP extension
212  * @return this extension
213  */
214 struct dlep_extension *
215 dlep_lid_init(void) {
216   dlep_extension_add(&_lid);
217   return &_lid;
218 }
219
220 static void
221 _cb_session_deactivate(struct dlep_session *session) {
222   session->cfg.lid_length = 0;
223 }
224
225 /**
226  * Write the link-id TLV into the DLEP message
227  * @param ext (this) dlep extension
228  * @param session dlep session
229  * @param neigh layer2 neighbor key to write into TLV
230  * @return -1 if an error happened, 0 otherwise
231  */
232 static int
233 _write_lid_only(
234   struct dlep_extension *ext __attribute__((unused)), struct dlep_session *session, const struct oonf_layer2_neigh_key *neigh) {
235   return dlep_writer_add_lid_tlv(&session->writer, neigh);
236 }
237
238 static int
239 _write_session_init_ack(struct dlep_extension *ext __attribute__((unused)), struct dlep_session *session,
240                         const struct oonf_layer2_neigh_key *neigh __attribute__((unused))) {
241   if (session->cfg.lid_length == 0 || session->cfg.lid_length == DLEP_DEFAULT_LID_LENGTH) {
242     return 0;
243   }
244
245   return dlep_writer_add_lid_length_tlv(&session->writer, session->cfg.lid_length);
246 }
247
248 static enum dlep_parser_error
249 _process_session_init_ack(struct dlep_extension *ext __attribute__((unused)), struct dlep_session *session) {
250   uint16_t length;
251
252   if (dlep_reader_lid_length_tlv(&length, session, NULL)) {
253     return DLEP_NEW_PARSER_OKAY;
254   }
255
256   if (length > OONF_LAYER2_MAX_LINK_ID) {
257     dlep_session_generate_signal_status(session, DLEP_SESSION_TERMINATION, NULL, DLEP_STATUS_REQUEST_DENIED,
258         "Cannot handle link-id length this large");
259     return DLEP_NEW_PARSER_TERMINDATED;
260   }
261   return DLEP_NEW_PARSER_OKAY;
262 }