Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/discover.c | |
c4307285 | 3 | * |
b45db71b | 4 | * Copyright (c) 2003-2006, 2014-2015, Ericsson AB |
2d627b92 | 5 | * Copyright (c) 2005-2006, 2010-2011, Wind River Systems |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
11 | * 1. Redistributions of source code must retain the above copyright |
12 | * notice, this list of conditions and the following disclaimer. | |
13 | * 2. Redistributions in binary form must reproduce the above copyright | |
14 | * notice, this list of conditions and the following disclaimer in the | |
15 | * documentation and/or other materials provided with the distribution. | |
16 | * 3. Neither the names of the copyright holders nor the names of its | |
17 | * contributors may be used to endorse or promote products derived from | |
18 | * this software without specific prior written permission. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
20 | * Alternatively, this software may be distributed under the terms of the |
21 | * GNU General Public License ("GPL") version 2 as published by the Free | |
22 | * Software Foundation. | |
23 | * | |
24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
27 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | |
28 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
29 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
30 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
31 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
32 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
33 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #include "core.h" | |
d3a43b90 | 38 | #include "node.h" |
b97bf3fd | 39 | #include "discover.h" |
b97bf3fd | 40 | |
2f55c437 YX |
41 | /* min delay during bearer start up */ |
42 | #define TIPC_LINK_REQ_INIT msecs_to_jiffies(125) | |
43 | /* max delay if bearer has no links */ | |
44 | #define TIPC_LINK_REQ_FAST msecs_to_jiffies(1000) | |
45 | /* max delay if bearer has links */ | |
46 | #define TIPC_LINK_REQ_SLOW msecs_to_jiffies(60000) | |
47 | /* indicates no timer in use */ | |
48 | #define TIPC_LINK_REQ_INACTIVE 0xffffffff | |
b97bf3fd | 49 | |
b97bf3fd | 50 | /** |
a18c4bc3 | 51 | * struct tipc_link_req - information about an ongoing link setup request |
7a2f7d18 | 52 | * @bearer_id: identity of bearer issuing requests |
7f9f95d9 | 53 | * @net: network namespace instance |
b97bf3fd | 54 | * @dest: destination address for request messages |
7a2f7d18 | 55 | * @domain: network domain to which links can be established |
1209966c | 56 | * @num_nodes: number of nodes currently discovered (i.e. with an active link) |
f9a2c80b | 57 | * @lock: spinlock for controlling access to requests |
b97bf3fd PL |
58 | * @buf: request message to be (repeatedly) sent |
59 | * @timer: timer governing period between requests | |
60 | * @timer_intv: current interval between requests (in ms) | |
61 | */ | |
a18c4bc3 | 62 | struct tipc_link_req { |
7a2f7d18 | 63 | u32 bearer_id; |
b97bf3fd | 64 | struct tipc_media_addr dest; |
7f9f95d9 | 65 | struct net *net; |
7a2f7d18 | 66 | u32 domain; |
1209966c | 67 | int num_nodes; |
f9a2c80b | 68 | spinlock_t lock; |
b97bf3fd PL |
69 | struct sk_buff *buf; |
70 | struct timer_list timer; | |
2f55c437 | 71 | unsigned long timer_intv; |
b97bf3fd PL |
72 | }; |
73 | ||
c4307285 | 74 | /** |
4323add6 | 75 | * tipc_disc_init_msg - initialize a link setup message |
c93d3baa | 76 | * @net: the applicable net namespace |
b97bf3fd | 77 | * @type: message type (request or response) |
b97bf3fd PL |
78 | * @b_ptr: ptr to bearer issuing message |
79 | */ | |
c93d3baa | 80 | static void tipc_disc_init_msg(struct net *net, struct sk_buff *buf, u32 type, |
a8b9b96e | 81 | struct tipc_bearer *b_ptr) |
b97bf3fd | 82 | { |
c93d3baa | 83 | struct tipc_net *tn = net_generic(net, tipc_net_id); |
b97bf3fd | 84 | struct tipc_msg *msg; |
16470111 | 85 | u32 dest_domain = b_ptr->domain; |
b97bf3fd | 86 | |
a8b9b96e | 87 | msg = buf_msg(buf); |
c5898636 | 88 | tipc_msg_init(tn->own_addr, msg, LINK_CONFIG, type, |
948fa2d1 | 89 | MAX_H_SIZE, dest_domain); |
a8b9b96e | 90 | msg_set_non_seq(msg, 1); |
bafa29e3 | 91 | msg_set_node_sig(msg, tn->random); |
7764d6e8 | 92 | msg_set_node_capabilities(msg, 0); |
a8b9b96e | 93 | msg_set_dest_domain(msg, dest_domain); |
c93d3baa | 94 | msg_set_bc_netid(msg, tn->net_id); |
38504c28 | 95 | b_ptr->media->addr2msg(msg_media_addr(msg), &b_ptr->addr); |
b97bf3fd PL |
96 | } |
97 | ||
e91ed0bc AS |
98 | /** |
99 | * disc_dupl_alert - issue node address duplication alert | |
100 | * @b_ptr: pointer to bearer detecting duplication | |
101 | * @node_addr: duplicated node address | |
102 | * @media_addr: media address advertised by duplicated node | |
103 | */ | |
2d627b92 | 104 | static void disc_dupl_alert(struct tipc_bearer *b_ptr, u32 node_addr, |
e91ed0bc AS |
105 | struct tipc_media_addr *media_addr) |
106 | { | |
107 | char node_addr_str[16]; | |
108 | char media_addr_str[64]; | |
e91ed0bc | 109 | |
c68ca7b7 | 110 | tipc_addr_string_fill(node_addr_str, node_addr); |
dc1aed37 EH |
111 | tipc_media_addr_printf(media_addr_str, sizeof(media_addr_str), |
112 | media_addr); | |
2cf8aa19 EH |
113 | pr_warn("Duplicate %s using %s seen on <%s>\n", node_addr_str, |
114 | media_addr_str, b_ptr->name); | |
e91ed0bc AS |
115 | } |
116 | ||
b97bf3fd | 117 | /** |
c82910e2 | 118 | * tipc_disc_rcv - handle incoming discovery message (request or response) |
c93d3baa | 119 | * @net: the applicable net namespace |
b97bf3fd | 120 | * @buf: buffer containing message |
c82910e2 | 121 | * @bearer: bearer that message arrived on |
b97bf3fd | 122 | */ |
c93d3baa YX |
123 | void tipc_disc_rcv(struct net *net, struct sk_buff *buf, |
124 | struct tipc_bearer *bearer) | |
b97bf3fd | 125 | { |
c93d3baa | 126 | struct tipc_net *tn = net_generic(net, tipc_net_id); |
c82910e2 | 127 | struct tipc_node *node; |
c82910e2 | 128 | struct tipc_media_addr maddr; |
a728750e | 129 | struct sk_buff *rbuf; |
b97bf3fd | 130 | struct tipc_msg *msg = buf_msg(buf); |
c82910e2 JPM |
131 | u32 ddom = msg_dest_domain(msg); |
132 | u32 onode = msg_prevnode(msg); | |
b97bf3fd | 133 | u32 net_id = msg_bc_netid(msg); |
c82910e2 | 134 | u32 mtyp = msg_type(msg); |
fc0eea69 | 135 | u32 signature = msg_node_sig(msg); |
7764d6e8 | 136 | u16 caps = msg_node_capabilities(msg); |
c82910e2 JPM |
137 | bool addr_match = false; |
138 | bool sign_match = false; | |
139 | bool link_up = false; | |
140 | bool accept_addr = false; | |
141 | bool accept_sign = false; | |
142 | bool respond = false; | |
b97bf3fd | 143 | |
c82910e2 | 144 | bearer->media->msg2addr(bearer, &maddr, msg_media_addr(msg)); |
5f6d9123 | 145 | kfree_skb(buf); |
b97bf3fd | 146 | |
97878a40 | 147 | /* Ensure message from node is valid and communication is permitted */ |
c93d3baa | 148 | if (net_id != tn->net_id) |
b97bf3fd | 149 | return; |
c82910e2 | 150 | if (maddr.broadcast) |
d6d4577a | 151 | return; |
c82910e2 | 152 | if (!tipc_addr_domain_valid(ddom)) |
b97bf3fd | 153 | return; |
c82910e2 | 154 | if (!tipc_addr_node_valid(onode)) |
b97bf3fd | 155 | return; |
c82910e2 | 156 | |
34747539 | 157 | if (in_own_node(net, onode)) { |
c82910e2 | 158 | if (memcmp(&maddr, &bearer->addr, sizeof(maddr))) |
34747539 | 159 | disc_dupl_alert(bearer, tn->own_addr, &maddr); |
b97bf3fd | 160 | return; |
e91ed0bc | 161 | } |
34747539 | 162 | if (!tipc_in_scope(ddom, tn->own_addr)) |
b97bf3fd | 163 | return; |
c82910e2 | 164 | if (!tipc_in_scope(bearer->domain, onode)) |
a728750e | 165 | return; |
5a68d5ee | 166 | |
b45db71b | 167 | node = tipc_node_create(net, onode); |
c82910e2 JPM |
168 | if (!node) |
169 | return; | |
c82910e2 | 170 | tipc_node_lock(node); |
7764d6e8 | 171 | node->capabilities = caps; |
a728750e | 172 | |
97878a40 | 173 | /* Prepare to validate requesting node's signature and media address */ |
c82910e2 | 174 | sign_match = (signature == node->signature); |
d3a43b90 | 175 | tipc_node_check_dest(node, bearer, &link_up, &addr_match, &maddr); |
97878a40 | 176 | |
c82910e2 | 177 | /* These three flags give us eight permutations: */ |
a728750e | 178 | |
c82910e2 JPM |
179 | if (sign_match && addr_match && link_up) { |
180 | /* All is fine. Do nothing. */ | |
181 | } else if (sign_match && addr_match && !link_up) { | |
182 | /* Respond. The link will come up in due time */ | |
183 | respond = true; | |
184 | } else if (sign_match && !addr_match && link_up) { | |
185 | /* Peer has changed i/f address without rebooting. | |
186 | * If so, the link will reset soon, and the next | |
187 | * discovery will be accepted. So we can ignore it. | |
188 | * It may also be an cloned or malicious peer having | |
189 | * chosen the same node address and signature as an | |
190 | * existing one. | |
191 | * Ignore requests until the link goes down, if ever. | |
192 | */ | |
193 | disc_dupl_alert(bearer, onode, &maddr); | |
194 | } else if (sign_match && !addr_match && !link_up) { | |
195 | /* Peer link has changed i/f address without rebooting. | |
196 | * It may also be a cloned or malicious peer; we can't | |
197 | * distinguish between the two. | |
198 | * The signature is correct, so we must accept. | |
199 | */ | |
200 | accept_addr = true; | |
201 | respond = true; | |
202 | } else if (!sign_match && addr_match && link_up) { | |
203 | /* Peer node rebooted. Two possibilities: | |
204 | * - Delayed re-discovery; this link endpoint has already | |
205 | * reset and re-established contact with the peer, before | |
206 | * receiving a discovery message from that node. | |
207 | * (The peer happened to receive one from this node first). | |
208 | * - The peer came back so fast that our side has not | |
209 | * discovered it yet. Probing from this side will soon | |
210 | * reset the link, since there can be no working link | |
211 | * endpoint at the peer end, and the link will re-establish. | |
212 | * Accept the signature, since it comes from a known peer. | |
213 | */ | |
214 | accept_sign = true; | |
215 | } else if (!sign_match && addr_match && !link_up) { | |
216 | /* The peer node has rebooted. | |
217 | * Accept signature, since it is a known peer. | |
218 | */ | |
219 | accept_sign = true; | |
220 | respond = true; | |
221 | } else if (!sign_match && !addr_match && link_up) { | |
222 | /* Peer rebooted with new address, or a new/duplicate peer. | |
223 | * Ignore until the link goes down, if ever. | |
224 | */ | |
225 | disc_dupl_alert(bearer, onode, &maddr); | |
226 | } else if (!sign_match && !addr_match && !link_up) { | |
227 | /* Peer rebooted with new address, or it is a new peer. | |
228 | * Accept signature and address. | |
229 | */ | |
230 | accept_sign = true; | |
231 | accept_addr = true; | |
232 | respond = true; | |
97878a40 AS |
233 | } |
234 | ||
c82910e2 JPM |
235 | if (accept_sign) |
236 | node->signature = signature; | |
237 | ||
d3a43b90 JPM |
238 | if (accept_addr && !tipc_node_update_dest(node, bearer, &maddr)) |
239 | respond = false; | |
a728750e | 240 | |
c82910e2 JPM |
241 | /* Send response, if necessary */ |
242 | if (respond && (mtyp == DSC_REQ_MSG)) { | |
948fa2d1 | 243 | rbuf = tipc_buf_acquire(MAX_H_SIZE); |
fa2bae2d | 244 | if (rbuf) { |
c93d3baa | 245 | tipc_disc_init_msg(net, rbuf, DSC_RESP_MSG, bearer); |
7f9f95d9 | 246 | tipc_bearer_send(net, bearer->identity, rbuf, &maddr); |
5f6d9123 | 247 | kfree_skb(rbuf); |
fa2bae2d | 248 | } |
b97bf3fd | 249 | } |
c82910e2 | 250 | tipc_node_unlock(node); |
8a0f6ebe | 251 | tipc_node_put(node); |
b97bf3fd PL |
252 | } |
253 | ||
b97bf3fd | 254 | /** |
1209966c | 255 | * disc_update - update frequency of periodic link setup requests |
b97bf3fd | 256 | * @req: ptr to link request structure |
972a77fb AS |
257 | * |
258 | * Reinitiates discovery process if discovery object has no associated nodes | |
259 | * and is either not currently searching or is searching at a slow rate | |
b97bf3fd | 260 | */ |
a18c4bc3 | 261 | static void disc_update(struct tipc_link_req *req) |
b97bf3fd | 262 | { |
972a77fb AS |
263 | if (!req->num_nodes) { |
264 | if ((req->timer_intv == TIPC_LINK_REQ_INACTIVE) || | |
265 | (req->timer_intv > TIPC_LINK_REQ_FAST)) { | |
266 | req->timer_intv = TIPC_LINK_REQ_INIT; | |
2f55c437 | 267 | mod_timer(&req->timer, jiffies + req->timer_intv); |
b97bf3fd | 268 | } |
b97bf3fd | 269 | } |
c4307285 | 270 | } |
b97bf3fd | 271 | |
1209966c AS |
272 | /** |
273 | * tipc_disc_add_dest - increment set of discovered nodes | |
274 | * @req: ptr to link request structure | |
275 | */ | |
a18c4bc3 | 276 | void tipc_disc_add_dest(struct tipc_link_req *req) |
1209966c | 277 | { |
f9a2c80b | 278 | spin_lock_bh(&req->lock); |
1209966c | 279 | req->num_nodes++; |
f9a2c80b | 280 | spin_unlock_bh(&req->lock); |
1209966c AS |
281 | } |
282 | ||
283 | /** | |
284 | * tipc_disc_remove_dest - decrement set of discovered nodes | |
285 | * @req: ptr to link request structure | |
286 | */ | |
a18c4bc3 | 287 | void tipc_disc_remove_dest(struct tipc_link_req *req) |
1209966c | 288 | { |
f9a2c80b | 289 | spin_lock_bh(&req->lock); |
1209966c AS |
290 | req->num_nodes--; |
291 | disc_update(req); | |
f9a2c80b | 292 | spin_unlock_bh(&req->lock); |
1209966c AS |
293 | } |
294 | ||
b97bf3fd PL |
295 | /** |
296 | * disc_timeout - send a periodic link setup request | |
2f55c437 | 297 | * @data: ptr to link request structure |
c4307285 | 298 | * |
b97bf3fd PL |
299 | * Called whenever a link setup request timer associated with a bearer expires. |
300 | */ | |
2f55c437 | 301 | static void disc_timeout(unsigned long data) |
b97bf3fd | 302 | { |
2f55c437 | 303 | struct tipc_link_req *req = (struct tipc_link_req *)data; |
972a77fb AS |
304 | int max_delay; |
305 | ||
f9a2c80b | 306 | spin_lock_bh(&req->lock); |
b97bf3fd | 307 | |
972a77fb | 308 | /* Stop searching if only desired node has been found */ |
7a2f7d18 | 309 | if (tipc_node(req->domain) && req->num_nodes) { |
972a77fb AS |
310 | req->timer_intv = TIPC_LINK_REQ_INACTIVE; |
311 | goto exit; | |
b97bf3fd | 312 | } |
b97bf3fd | 313 | |
972a77fb AS |
314 | /* |
315 | * Send discovery message, then update discovery timer | |
316 | * | |
317 | * Keep doubling time between requests until limit is reached; | |
318 | * hold at fast polling rate if don't have any associated nodes, | |
319 | * otherwise hold at slow polling rate | |
320 | */ | |
7f9f95d9 | 321 | tipc_bearer_send(req->net, req->bearer_id, req->buf, &req->dest); |
512137ee | 322 | |
972a77fb AS |
323 | |
324 | req->timer_intv *= 2; | |
325 | if (req->num_nodes) | |
326 | max_delay = TIPC_LINK_REQ_SLOW; | |
327 | else | |
328 | max_delay = TIPC_LINK_REQ_FAST; | |
329 | if (req->timer_intv > max_delay) | |
330 | req->timer_intv = max_delay; | |
331 | ||
2f55c437 | 332 | mod_timer(&req->timer, jiffies + req->timer_intv); |
972a77fb | 333 | exit: |
f9a2c80b | 334 | spin_unlock_bh(&req->lock); |
b97bf3fd PL |
335 | } |
336 | ||
337 | /** | |
3a777ff8 | 338 | * tipc_disc_create - create object to send periodic link setup requests |
c93d3baa | 339 | * @net: the applicable net namespace |
b97bf3fd PL |
340 | * @b_ptr: ptr to bearer issuing requests |
341 | * @dest: destination address for request messages | |
66e019a6 | 342 | * @dest_domain: network domain to which links can be established |
c4307285 | 343 | * |
3a777ff8 | 344 | * Returns 0 if successful, otherwise -errno. |
b97bf3fd | 345 | */ |
c93d3baa YX |
346 | int tipc_disc_create(struct net *net, struct tipc_bearer *b_ptr, |
347 | struct tipc_media_addr *dest) | |
b97bf3fd | 348 | { |
a18c4bc3 | 349 | struct tipc_link_req *req; |
b97bf3fd | 350 | |
9df3f3d2 | 351 | req = kmalloc(sizeof(*req), GFP_ATOMIC); |
b97bf3fd | 352 | if (!req) |
3a777ff8 | 353 | return -ENOMEM; |
948fa2d1 | 354 | req->buf = tipc_buf_acquire(MAX_H_SIZE); |
22e7987a YX |
355 | if (!req->buf) { |
356 | kfree(req); | |
a8b9b96e | 357 | return -ENOMEM; |
22e7987a | 358 | } |
b97bf3fd | 359 | |
c93d3baa | 360 | tipc_disc_init_msg(net, req->buf, DSC_REQ_MSG, b_ptr); |
b97bf3fd | 361 | memcpy(&req->dest, dest, sizeof(*dest)); |
7f9f95d9 | 362 | req->net = net; |
7a2f7d18 YX |
363 | req->bearer_id = b_ptr->identity; |
364 | req->domain = b_ptr->domain; | |
1209966c | 365 | req->num_nodes = 0; |
b97bf3fd | 366 | req->timer_intv = TIPC_LINK_REQ_INIT; |
f9a2c80b | 367 | spin_lock_init(&req->lock); |
2f55c437 YX |
368 | setup_timer(&req->timer, disc_timeout, (unsigned long)req); |
369 | mod_timer(&req->timer, jiffies + req->timer_intv); | |
3a777ff8 | 370 | b_ptr->link_req = req; |
7f9f95d9 | 371 | tipc_bearer_send(net, req->bearer_id, req->buf, &req->dest); |
3a777ff8 AS |
372 | return 0; |
373 | } | |
374 | ||
375 | /** | |
376 | * tipc_disc_delete - destroy object sending periodic link setup requests | |
377 | * @req: ptr to link request structure | |
378 | */ | |
a18c4bc3 | 379 | void tipc_disc_delete(struct tipc_link_req *req) |
3a777ff8 | 380 | { |
2f55c437 | 381 | del_timer_sync(&req->timer); |
5f6d9123 | 382 | kfree_skb(req->buf); |
3a777ff8 | 383 | kfree(req); |
c4307285 | 384 | } |
a8b9b96e YX |
385 | |
386 | /** | |
387 | * tipc_disc_reset - reset object to send periodic link setup requests | |
c93d3baa | 388 | * @net: the applicable net namespace |
a8b9b96e YX |
389 | * @b_ptr: ptr to bearer issuing requests |
390 | * @dest_domain: network domain to which links can be established | |
391 | */ | |
c93d3baa | 392 | void tipc_disc_reset(struct net *net, struct tipc_bearer *b_ptr) |
a8b9b96e YX |
393 | { |
394 | struct tipc_link_req *req = b_ptr->link_req; | |
395 | ||
396 | spin_lock_bh(&req->lock); | |
c93d3baa | 397 | tipc_disc_init_msg(net, req->buf, DSC_REQ_MSG, b_ptr); |
7f9f95d9 | 398 | req->net = net; |
a8b9b96e YX |
399 | req->bearer_id = b_ptr->identity; |
400 | req->domain = b_ptr->domain; | |
401 | req->num_nodes = 0; | |
402 | req->timer_intv = TIPC_LINK_REQ_INIT; | |
2f55c437 | 403 | mod_timer(&req->timer, jiffies + req->timer_intv); |
7f9f95d9 | 404 | tipc_bearer_send(net, req->bearer_id, req->buf, &req->dest); |
a8b9b96e YX |
405 | spin_unlock_bh(&req->lock); |
406 | } |