]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - net/tipc/discover.c
Merge tag 'printk-for-5.13' of git://git.kernel.org/pub/scm/linux/kernel/git/printk...
[mirror_ubuntu-jammy-kernel.git] / net / tipc / discover.c
CommitLineData
b97bf3fd
PL
1/*
2 * net/tipc/discover.c
c4307285 3 *
25b0b9c4 4 * Copyright (c) 2003-2006, 2014-2018, 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 41/* min delay during bearer start up */
b39e465e 42#define TIPC_DISC_INIT msecs_to_jiffies(125)
2f55c437 43/* max delay if bearer has no links */
b39e465e 44#define TIPC_DISC_FAST msecs_to_jiffies(1000)
2f55c437 45/* max delay if bearer has links */
b39e465e 46#define TIPC_DISC_SLOW msecs_to_jiffies(60000)
2f55c437 47/* indicates no timer in use */
b39e465e 48#define TIPC_DISC_INACTIVE 0xffffffff
b97bf3fd 49
b97bf3fd 50/**
b39e465e 51 * struct tipc_discoverer - 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
b39e465e 58 * @skb: request message to be (repeatedly) sent
b97bf3fd
PL
59 * @timer: timer governing period between requests
60 * @timer_intv: current interval between requests (in ms)
61 */
b39e465e 62struct tipc_discoverer {
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;
b39e465e 69 struct sk_buff *skb;
b97bf3fd 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
5fcb7d47 77 * @skb: buffer containing message
d8141208 78 * @mtyp: message type (request or response)
1a90632d 79 * @b: ptr to bearer issuing message
b97bf3fd 80 */
b39e465e 81static void tipc_disc_init_msg(struct net *net, struct sk_buff *skb,
25b0b9c4 82 u32 mtyp, struct tipc_bearer *b)
b97bf3fd 83{
b39e465e 84 struct tipc_net *tn = tipc_net(net);
1a90632d 85 u32 dest_domain = b->domain;
b39e465e 86 struct tipc_msg *hdr;
b97bf3fd 87
b39e465e 88 hdr = buf_msg(skb);
25b0b9c4 89 tipc_msg_init(tn->trial_addr, hdr, LINK_CONFIG, mtyp,
948fa2d1 90 MAX_H_SIZE, dest_domain);
25b0b9c4 91 msg_set_size(hdr, MAX_H_SIZE + NODE_ID_LEN);
b39e465e
JM
92 msg_set_non_seq(hdr, 1);
93 msg_set_node_sig(hdr, tn->random);
94 msg_set_node_capabilities(hdr, TIPC_NODE_CAPABILITIES);
95 msg_set_dest_domain(hdr, dest_domain);
96 msg_set_bc_netid(hdr, tn->net_id);
97 b->media->addr2msg(msg_media_addr(hdr), &b->addr);
f73b1281 98 msg_set_peer_net_hash(hdr, tipc_net_hash_mixes(net, tn->random));
25b0b9c4 99 msg_set_node_id(hdr, tipc_own_id(net));
b39e465e
JM
100}
101
25b0b9c4
JM
102static void tipc_disc_msg_xmit(struct net *net, u32 mtyp, u32 dst,
103 u32 src, u32 sugg_addr,
b39e465e
JM
104 struct tipc_media_addr *maddr,
105 struct tipc_bearer *b)
106{
25b0b9c4 107 struct tipc_msg *hdr;
b39e465e
JM
108 struct sk_buff *skb;
109
25b0b9c4 110 skb = tipc_buf_acquire(MAX_H_SIZE + NODE_ID_LEN, GFP_ATOMIC);
b39e465e
JM
111 if (!skb)
112 return;
25b0b9c4 113 hdr = buf_msg(skb);
b39e465e 114 tipc_disc_init_msg(net, skb, mtyp, b);
25b0b9c4
JM
115 msg_set_sugg_node_addr(hdr, sugg_addr);
116 msg_set_dest_domain(hdr, dst);
b39e465e 117 tipc_bearer_xmit_skb(net, b->identity, skb, maddr);
b97bf3fd
PL
118}
119
e91ed0bc
AS
120/**
121 * disc_dupl_alert - issue node address duplication alert
1a90632d 122 * @b: pointer to bearer detecting duplication
e91ed0bc
AS
123 * @node_addr: duplicated node address
124 * @media_addr: media address advertised by duplicated node
125 */
1a90632d 126static void disc_dupl_alert(struct tipc_bearer *b, u32 node_addr,
e91ed0bc
AS
127 struct tipc_media_addr *media_addr)
128{
e91ed0bc 129 char media_addr_str[64];
e91ed0bc 130
dc1aed37
EH
131 tipc_media_addr_printf(media_addr_str, sizeof(media_addr_str),
132 media_addr);
d50ccc2d 133 pr_warn("Duplicate %x using %s seen on <%s>\n", node_addr,
1a90632d 134 media_addr_str, b->name);
e91ed0bc
AS
135}
136
25b0b9c4 137/* tipc_disc_addr_trial(): - handle an address uniqueness trial from peer
e415577f
JM
138 * Returns true if message should be dropped by caller, i.e., if it is a
139 * trial message or we are inside trial period. Otherwise false.
25b0b9c4 140 */
da18ab32 141static bool tipc_disc_addr_trial_msg(struct tipc_discoverer *d,
142 struct tipc_media_addr *maddr,
143 struct tipc_bearer *b,
144 u32 dst, u32 src,
145 u32 sugg_addr,
146 u8 *peer_id,
147 int mtyp)
25b0b9c4
JM
148{
149 struct net *net = d->net;
150 struct tipc_net *tn = tipc_net(net);
151 bool trial = time_before(jiffies, tn->addr_trial_end);
152 u32 self = tipc_own_addr(net);
153
154 if (mtyp == DSC_TRIAL_FAIL_MSG) {
155 if (!trial)
156 return true;
157
158 /* Ignore if somebody else already gave new suggestion */
159 if (dst != tn->trial_addr)
160 return true;
161
162 /* Otherwise update trial address and restart trial period */
163 tn->trial_addr = sugg_addr;
164 msg_set_prevnode(buf_msg(d->skb), sugg_addr);
165 tn->addr_trial_end = jiffies + msecs_to_jiffies(1000);
166 return true;
167 }
168
169 /* Apply trial address if we just left trial period */
170 if (!trial && !self) {
adba75be
JM
171 tipc_sched_net_finalize(net, tn->trial_addr);
172 msg_set_prevnode(buf_msg(d->skb), tn->trial_addr);
25b0b9c4
JM
173 msg_set_type(buf_msg(d->skb), DSC_REQ_MSG);
174 }
175
e415577f 176 /* Accept regular link requests/responses only after trial period */
25b0b9c4 177 if (mtyp != DSC_TRIAL_MSG)
e415577f 178 return trial;
25b0b9c4
JM
179
180 sugg_addr = tipc_node_try_addr(net, peer_id, src);
181 if (sugg_addr)
182 tipc_disc_msg_xmit(net, DSC_TRIAL_FAIL_MSG, src,
183 self, sugg_addr, maddr, b);
184 return true;
185}
186
b97bf3fd 187/**
c82910e2 188 * tipc_disc_rcv - handle incoming discovery message (request or response)
b39e465e
JM
189 * @net: applicable net namespace
190 * @skb: buffer containing message
191 * @b: bearer that message arrived on
b97bf3fd 192 */
cf148816 193void tipc_disc_rcv(struct net *net, struct sk_buff *skb,
b39e465e 194 struct tipc_bearer *b)
b97bf3fd 195{
b39e465e 196 struct tipc_net *tn = tipc_net(net);
cf148816 197 struct tipc_msg *hdr = buf_msg(skb);
31e4ccc9 198 u32 pnet_hash = msg_peer_net_hash(hdr);
b39e465e 199 u16 caps = msg_node_capabilities(hdr);
b89afb11 200 bool legacy = tn->legacy_addr_format;
25b0b9c4 201 u32 sugg = msg_sugg_node_addr(hdr);
b39e465e 202 u32 signature = msg_node_sig(hdr);
25b0b9c4 203 u8 peer_id[NODE_ID_LEN] = {0,};
b39e465e 204 u32 dst = msg_dest_domain(hdr);
cf148816 205 u32 net_id = msg_bc_netid(hdr);
b39e465e
JM
206 struct tipc_media_addr maddr;
207 u32 src = msg_prevnode(hdr);
cf148816 208 u32 mtyp = msg_type(hdr);
cf148816 209 bool dupl_addr = false;
b39e465e 210 bool respond = false;
25b0b9c4 211 u32 self;
e9942923 212 int err;
b97bf3fd 213
25b0b9c4
JM
214 skb_linearize(skb);
215 hdr = buf_msg(skb);
216
217 if (caps & TIPC_NODE_ID128)
218 memcpy(peer_id, msg_node_id(hdr), NODE_ID_LEN);
219 else
220 sprintf(peer_id, "%x", src);
221
b39e465e 222 err = b->media->msg2addr(b, &maddr, msg_media_addr(hdr));
cf148816 223 kfree_skb(skb);
b39e465e
JM
224 if (err || maddr.broadcast) {
225 pr_warn_ratelimited("Rcv corrupt discovery message\n");
e9942923 226 return;
b39e465e
JM
227 }
228 /* Ignore discovery messages from own node */
229 if (!memcmp(&maddr, &b->addr, sizeof(maddr)))
b97bf3fd 230 return;
b39e465e 231 if (net_id != tn->net_id)
d6d4577a 232 return;
25b0b9c4
JM
233 if (tipc_disc_addr_trial_msg(b->disc, &maddr, b, dst,
234 src, sugg, peer_id, mtyp))
235 return;
236 self = tipc_own_addr(net);
237
238 /* Message from somebody using this node's address */
b39e465e
JM
239 if (in_own_node(net, src)) {
240 disc_dupl_alert(b, self, &maddr);
b97bf3fd 241 return;
e91ed0bc 242 }
b89afb11
JM
243 if (!tipc_in_scope(legacy, dst, self))
244 return;
245 if (!tipc_in_scope(legacy, b->domain, src))
246 return;
31e4ccc9
TL
247 tipc_node_check_dest(net, src, peer_id, b, caps, signature, pnet_hash,
248 &maddr, &respond, &dupl_addr);
cf148816 249 if (dupl_addr)
b39e465e
JM
250 disc_dupl_alert(b, src, &maddr);
251 if (!respond)
252 return;
253 if (mtyp != DSC_REQ_MSG)
254 return;
25b0b9c4 255 tipc_disc_msg_xmit(net, DSC_RESP_MSG, src, self, 0, &maddr, b);
b97bf3fd
PL
256}
257
b39e465e 258/* tipc_disc_add_dest - increment set of discovered nodes
b97bf3fd 259 */
b39e465e 260void tipc_disc_add_dest(struct tipc_discoverer *d)
b97bf3fd 261{
b39e465e
JM
262 spin_lock_bh(&d->lock);
263 d->num_nodes++;
264 spin_unlock_bh(&d->lock);
c4307285 265}
b97bf3fd 266
b39e465e 267/* tipc_disc_remove_dest - decrement set of discovered nodes
1209966c 268 */
b39e465e 269void tipc_disc_remove_dest(struct tipc_discoverer *d)
1209966c 270{
b39e465e 271 int intv, num;
1209966c 272
b39e465e
JM
273 spin_lock_bh(&d->lock);
274 d->num_nodes--;
275 num = d->num_nodes;
276 intv = d->timer_intv;
277 if (!num && (intv == TIPC_DISC_INACTIVE || intv > TIPC_DISC_FAST)) {
278 d->timer_intv = TIPC_DISC_INIT;
279 mod_timer(&d->timer, jiffies + d->timer_intv);
280 }
281 spin_unlock_bh(&d->lock);
1209966c
AS
282}
283
b39e465e 284/* tipc_disc_timeout - send a periodic link setup request
b97bf3fd 285 * Called whenever a link setup request timer associated with a bearer expires.
b39e465e
JM
286 * - Keep doubling time between sent request until limit is reached;
287 * - Hold at fast polling rate if we don't have any associated nodes
288 * - Otherwise hold at slow polling rate
b97bf3fd 289 */
b39e465e 290static void tipc_disc_timeout(struct timer_list *t)
b97bf3fd 291{
b39e465e 292 struct tipc_discoverer *d = from_timer(d, t, timer);
25b0b9c4 293 struct tipc_net *tn = tipc_net(d->net);
b39e465e
JM
294 struct tipc_media_addr maddr;
295 struct sk_buff *skb = NULL;
25b0b9c4 296 struct net *net = d->net;
b39e465e 297 u32 bearer_id;
972a77fb 298
b39e465e 299 spin_lock_bh(&d->lock);
b97bf3fd 300
972a77fb 301 /* Stop searching if only desired node has been found */
b39e465e
JM
302 if (tipc_node(d->domain) && d->num_nodes) {
303 d->timer_intv = TIPC_DISC_INACTIVE;
972a77fb 304 goto exit;
b97bf3fd 305 }
25b0b9c4 306
adba75be
JM
307 /* Did we just leave trial period ? */
308 if (!time_before(jiffies, tn->addr_trial_end) && !tipc_own_addr(net)) {
309 mod_timer(&d->timer, jiffies + TIPC_DISC_INIT);
310 spin_unlock_bh(&d->lock);
311 tipc_sched_net_finalize(net, tn->trial_addr);
312 return;
25b0b9c4
JM
313 }
314
b39e465e 315 /* Adjust timeout interval according to discovery phase */
25b0b9c4
JM
316 if (time_before(jiffies, tn->addr_trial_end)) {
317 d->timer_intv = TIPC_DISC_INIT;
318 } else {
319 d->timer_intv *= 2;
320 if (d->num_nodes && d->timer_intv > TIPC_DISC_SLOW)
321 d->timer_intv = TIPC_DISC_SLOW;
322 else if (!d->num_nodes && d->timer_intv > TIPC_DISC_FAST)
323 d->timer_intv = TIPC_DISC_FAST;
adba75be
JM
324 msg_set_type(buf_msg(d->skb), DSC_REQ_MSG);
325 msg_set_prevnode(buf_msg(d->skb), tn->trial_addr);
25b0b9c4
JM
326 }
327
b39e465e
JM
328 mod_timer(&d->timer, jiffies + d->timer_intv);
329 memcpy(&maddr, &d->dest, sizeof(maddr));
330 skb = skb_clone(d->skb, GFP_ATOMIC);
b39e465e 331 bearer_id = d->bearer_id;
972a77fb 332exit:
b39e465e
JM
333 spin_unlock_bh(&d->lock);
334 if (skb)
335 tipc_bearer_xmit_skb(net, bearer_id, skb, &maddr);
b97bf3fd
PL
336}
337
338/**
3a777ff8 339 * tipc_disc_create - create object to send periodic link setup requests
c93d3baa 340 * @net: the applicable net namespace
1a90632d 341 * @b: ptr to bearer issuing requests
b97bf3fd 342 * @dest: destination address for request messages
d8141208 343 * @skb: pointer to created frame
c4307285 344 *
637b77fd 345 * Return: 0 if successful, otherwise -errno.
b97bf3fd 346 */
1a90632d 347int tipc_disc_create(struct net *net, struct tipc_bearer *b,
4e801fa1 348 struct tipc_media_addr *dest, struct sk_buff **skb)
b97bf3fd 349{
25b0b9c4 350 struct tipc_net *tn = tipc_net(net);
b39e465e 351 struct tipc_discoverer *d;
b97bf3fd 352
b39e465e
JM
353 d = kmalloc(sizeof(*d), GFP_ATOMIC);
354 if (!d)
3a777ff8 355 return -ENOMEM;
25b0b9c4 356 d->skb = tipc_buf_acquire(MAX_H_SIZE + NODE_ID_LEN, GFP_ATOMIC);
b39e465e
JM
357 if (!d->skb) {
358 kfree(d);
a8b9b96e 359 return -ENOMEM;
22e7987a 360 }
b39e465e 361 tipc_disc_init_msg(net, d->skb, DSC_REQ_MSG, b);
25b0b9c4
JM
362
363 /* Do we need an address trial period first ? */
364 if (!tipc_own_addr(net)) {
365 tn->addr_trial_end = jiffies + msecs_to_jiffies(1000);
366 msg_set_type(buf_msg(d->skb), DSC_TRIAL_MSG);
367 }
b39e465e
JM
368 memcpy(&d->dest, dest, sizeof(*dest));
369 d->net = net;
370 d->bearer_id = b->identity;
371 d->domain = b->domain;
372 d->num_nodes = 0;
373 d->timer_intv = TIPC_DISC_INIT;
374 spin_lock_init(&d->lock);
375 timer_setup(&d->timer, tipc_disc_timeout, 0);
376 mod_timer(&d->timer, jiffies + d->timer_intv);
377 b->disc = d;
378 *skb = skb_clone(d->skb, GFP_ATOMIC);
3a777ff8
AS
379 return 0;
380}
381
382/**
383 * tipc_disc_delete - destroy object sending periodic link setup requests
5fcb7d47 384 * @d: ptr to link dest structure
3a777ff8 385 */
b39e465e 386void tipc_disc_delete(struct tipc_discoverer *d)
3a777ff8 387{
b39e465e
JM
388 del_timer_sync(&d->timer);
389 kfree_skb(d->skb);
390 kfree(d);
c4307285 391}
a8b9b96e
YX
392
393/**
394 * tipc_disc_reset - reset object to send periodic link setup requests
c93d3baa 395 * @net: the applicable net namespace
1a90632d 396 * @b: ptr to bearer issuing requests
a8b9b96e 397 */
1a90632d 398void tipc_disc_reset(struct net *net, struct tipc_bearer *b)
a8b9b96e 399{
b39e465e
JM
400 struct tipc_discoverer *d = b->disc;
401 struct tipc_media_addr maddr;
60852d67 402 struct sk_buff *skb;
a8b9b96e 403
b39e465e
JM
404 spin_lock_bh(&d->lock);
405 tipc_disc_init_msg(net, d->skb, DSC_REQ_MSG, b);
406 d->net = net;
407 d->bearer_id = b->identity;
408 d->domain = b->domain;
409 d->num_nodes = 0;
410 d->timer_intv = TIPC_DISC_INIT;
411 memcpy(&maddr, &d->dest, sizeof(maddr));
412 mod_timer(&d->timer, jiffies + d->timer_intv);
413 skb = skb_clone(d->skb, GFP_ATOMIC);
414 spin_unlock_bh(&d->lock);
60852d67 415 if (skb)
b39e465e 416 tipc_bearer_xmit_skb(net, b->identity, skb, &maddr);
a8b9b96e 417}