net/tipc/discover.c

   1 /*
   2  * net/tipc/discover.c
   3  *
   4  * Copyright (c) 2003-2006, 2014-2015, Ericsson AB
   5  * Copyright (c) 2005-2006, 2010-2011, Wind River Systems
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  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.
  19  *
  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
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include "core.h"
  38 #include "link.h"
  39 #include "discover.h"
  40
  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
  49
  50 /**
  51  * struct tipc_link_req - information about an ongoing link setup request
  52  * @bearer_id: identity of bearer issuing requests
  53  * @net: network namespace instance
  54  * @dest: destination address for request messages
  55  * @domain: network domain to which links can be established
  56  * @num_nodes: number of nodes currently discovered (i.e. with an active link)
  57  * @lock: spinlock for controlling access to requests
  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  */
  62 struct tipc_link_req {
  63         u32 bearer_id;
  64         struct tipc_media_addr dest;
  65         struct net *net;
  66         u32 domain;
  67         int num_nodes;
  68         spinlock_t lock;
  69         struct sk_buff *buf;
  70         struct timer_list timer;
  71         unsigned long timer_intv;
  72 };
  73
  74 /**
  75  * tipc_disc_init_msg - initialize a link setup message
  76  * @net: the applicable net namespace
  77  * @type: message type (request or response)
  78  * @b_ptr: ptr to bearer issuing message
  79  */
  80 static void tipc_disc_init_msg(struct net *net, struct sk_buff *buf, u32 type,
  81                                struct tipc_bearer *b_ptr)
  82 {
  83         struct tipc_net *tn = net_generic(net, tipc_net_id);
  84         struct tipc_msg *msg;
  85         u32 dest_domain = b_ptr->domain;
  86
  87         msg = buf_msg(buf);
  88         tipc_msg_init(net, msg, LINK_CONFIG, type, INT_H_SIZE, dest_domain);
  89         msg_set_non_seq(msg, 1);
  90         msg_set_node_sig(msg, tn->random);
  91         msg_set_dest_domain(msg, dest_domain);
  92         msg_set_bc_netid(msg, tn->net_id);
  93         b_ptr->media->addr2msg(msg_media_addr(msg), &b_ptr->addr);
  94 }
  95
  96 /**
  97  * disc_dupl_alert - issue node address duplication alert
  98  * @b_ptr: pointer to bearer detecting duplication
  99  * @node_addr: duplicated node address
 100  * @media_addr: media address advertised by duplicated node
 101  */
 102 static void disc_dupl_alert(struct tipc_bearer *b_ptr, u32 node_addr,
 103                             struct tipc_media_addr *media_addr)
 104 {
 105         char node_addr_str[16];
 106         char media_addr_str[64];
 107
 108         tipc_addr_string_fill(node_addr_str, node_addr);
 109         tipc_media_addr_printf(media_addr_str, sizeof(media_addr_str),
 110                                media_addr);
 111         pr_warn("Duplicate %s using %s seen on <%s>\n", node_addr_str,
 112                 media_addr_str, b_ptr->name);
 113 }
 114
 115 /**
 116  * tipc_disc_rcv - handle incoming discovery message (request or response)
 117  * @net: the applicable net namespace
 118  * @buf: buffer containing message
 119  * @bearer: bearer that message arrived on
 120  */
 121 void tipc_disc_rcv(struct net *net, struct sk_buff *buf,
 122                    struct tipc_bearer *bearer)
 123 {
 124         struct tipc_net *tn = net_generic(net, tipc_net_id);
 125         struct tipc_node *node;
 126         struct tipc_link *link;
 127         struct tipc_media_addr maddr;
 128         struct sk_buff *rbuf;
 129         struct tipc_msg *msg = buf_msg(buf);
 130         u32 ddom = msg_dest_domain(msg);
 131         u32 onode = msg_prevnode(msg);
 132         u32 net_id = msg_bc_netid(msg);
 133         u32 mtyp = msg_type(msg);
 134         u32 signature = msg_node_sig(msg);
 135         bool addr_match = false;
 136         bool sign_match = false;
 137         bool link_up = false;
 138         bool accept_addr = false;
 139         bool accept_sign = false;
 140         bool respond = false;
 141
 142         bearer->media->msg2addr(bearer, &maddr, msg_media_addr(msg));
 143         kfree_skb(buf);
 144
 145         /* Ensure message from node is valid and communication is permitted */
 146         if (net_id != tn->net_id)
 147                 return;
 148         if (maddr.broadcast)
 149                 return;
 150         if (!tipc_addr_domain_valid(ddom))
 151                 return;
 152         if (!tipc_addr_node_valid(onode))
 153                 return;
 154
 155         if (in_own_node(net, onode)) {
 156                 if (memcmp(&maddr, &bearer->addr, sizeof(maddr)))
 157                         disc_dupl_alert(bearer, tn->own_addr, &maddr);
 158                 return;
 159         }
 160         if (!tipc_in_scope(ddom, tn->own_addr))
 161                 return;
 162         if (!tipc_in_scope(bearer->domain, onode))
 163                 return;
 164
 165         node = tipc_node_create(net, onode);
 166         if (!node)
 167                 return;
 168         tipc_node_lock(node);
 169         link = node->links[bearer->identity];
 170
 171         /* Prepare to validate requesting node's signature and media address */
 172         sign_match = (signature == node->signature);
 173         addr_match = link && !memcmp(&link->media_addr, &maddr, sizeof(maddr));
 174         link_up = link && tipc_link_is_up(link);
 175
 176
 177         /* These three flags give us eight permutations: */
 178
 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;
 233         }
 234
 235         if (accept_sign)
 236                 node->signature = signature;
 237
 238         if (accept_addr) {
 239                 if (!link)
 240                         link = tipc_link_create(node, bearer, &maddr);
 241                 if (link) {
 242                         memcpy(&link->media_addr, &maddr, sizeof(maddr));
 243                         tipc_link_reset(link);
 244                 } else {
 245                         respond = false;
 246                 }
 247         }
 248
 249         /* Send response, if necessary */
 250         if (respond && (mtyp == DSC_REQ_MSG)) {
 251                 rbuf = tipc_buf_acquire(INT_H_SIZE);
 252                 if (rbuf) {
 253                         tipc_disc_init_msg(net, rbuf, DSC_RESP_MSG, bearer);
 254                         tipc_bearer_send(net, bearer->identity, rbuf, &maddr);
 255                         kfree_skb(rbuf);
 256                 }
 257         }
 258         tipc_node_unlock(node);
 259 }
 260
 261 /**
 262  * disc_update - update frequency of periodic link setup requests
 263  * @req: ptr to link request structure
 264  *
 265  * Reinitiates discovery process if discovery object has no associated nodes
 266  * and is either not currently searching or is searching at a slow rate
 267  */
 268 static void disc_update(struct tipc_link_req *req)
 269 {
 270         if (!req->num_nodes) {
 271                 if ((req->timer_intv == TIPC_LINK_REQ_INACTIVE) ||
 272                     (req->timer_intv > TIPC_LINK_REQ_FAST)) {
 273                         req->timer_intv = TIPC_LINK_REQ_INIT;
 274                         mod_timer(&req->timer, jiffies + req->timer_intv);
 275                 }
 276         }
 277 }
 278
 279 /**
 280  * tipc_disc_add_dest - increment set of discovered nodes
 281  * @req: ptr to link request structure
 282  */
 283 void tipc_disc_add_dest(struct tipc_link_req *req)
 284 {
 285         spin_lock_bh(&req->lock);
 286         req->num_nodes++;
 287         spin_unlock_bh(&req->lock);
 288 }
 289
 290 /**
 291  * tipc_disc_remove_dest - decrement set of discovered nodes
 292  * @req: ptr to link request structure
 293  */
 294 void tipc_disc_remove_dest(struct tipc_link_req *req)
 295 {
 296         spin_lock_bh(&req->lock);
 297         req->num_nodes--;
 298         disc_update(req);
 299         spin_unlock_bh(&req->lock);
 300 }
 301
 302 /**
 303  * disc_timeout - send a periodic link setup request
 304  * @data: ptr to link request structure
 305  *
 306  * Called whenever a link setup request timer associated with a bearer expires.
 307  */
 308 static void disc_timeout(unsigned long data)
 309 {
 310         struct tipc_link_req *req = (struct tipc_link_req *)data;
 311         int max_delay;
 312
 313         spin_lock_bh(&req->lock);
 314
 315         /* Stop searching if only desired node has been found */
 316         if (tipc_node(req->domain) && req->num_nodes) {
 317                 req->timer_intv = TIPC_LINK_REQ_INACTIVE;
 318                 goto exit;
 319         }
 320
 321         /*
 322          * Send discovery message, then update discovery timer
 323          *
 324          * Keep doubling time between requests until limit is reached;
 325          * hold at fast polling rate if don't have any associated nodes,
 326          * otherwise hold at slow polling rate
 327          */
 328         tipc_bearer_send(req->net, req->bearer_id, req->buf, &req->dest);
 329
 330
 331         req->timer_intv *= 2;
 332         if (req->num_nodes)
 333                 max_delay = TIPC_LINK_REQ_SLOW;
 334         else
 335                 max_delay = TIPC_LINK_REQ_FAST;
 336         if (req->timer_intv > max_delay)
 337                 req->timer_intv = max_delay;
 338
 339         mod_timer(&req->timer, jiffies + req->timer_intv);
 340 exit:
 341         spin_unlock_bh(&req->lock);
 342 }
 343
 344 /**
 345  * tipc_disc_create - create object to send periodic link setup requests
 346  * @net: the applicable net namespace
 347  * @b_ptr: ptr to bearer issuing requests
 348  * @dest: destination address for request messages
 349  * @dest_domain: network domain to which links can be established
 350  *
 351  * Returns 0 if successful, otherwise -errno.
 352  */
 353 int tipc_disc_create(struct net *net, struct tipc_bearer *b_ptr,
 354                      struct tipc_media_addr *dest)
 355 {
 356         struct tipc_link_req *req;
 357
 358         req = kmalloc(sizeof(*req), GFP_ATOMIC);
 359         if (!req)
 360                 return -ENOMEM;
 361
 362         req->buf = tipc_buf_acquire(INT_H_SIZE);
 363         if (!req->buf) {
 364                 kfree(req);
 365                 return -ENOMEM;
 366         }
 367
 368         tipc_disc_init_msg(net, req->buf, DSC_REQ_MSG, b_ptr);
 369         memcpy(&req->dest, dest, sizeof(*dest));
 370         req->net = net;
 371         req->bearer_id = b_ptr->identity;
 372         req->domain = b_ptr->domain;
 373         req->num_nodes = 0;
 374         req->timer_intv = TIPC_LINK_REQ_INIT;
 375         spin_lock_init(&req->lock);
 376         setup_timer(&req->timer, disc_timeout, (unsigned long)req);
 377         mod_timer(&req->timer, jiffies + req->timer_intv);
 378         b_ptr->link_req = req;
 379         tipc_bearer_send(net, req->bearer_id, req->buf, &req->dest);
 380         return 0;
 381 }
 382
 383 /**
 384  * tipc_disc_delete - destroy object sending periodic link setup requests
 385  * @req: ptr to link request structure
 386  */
 387 void tipc_disc_delete(struct tipc_link_req *req)
 388 {
 389         del_timer_sync(&req->timer);
 390         kfree_skb(req->buf);
 391         kfree(req);
 392 }
 393
 394 /**
 395  * tipc_disc_reset - reset object to send periodic link setup requests
 396  * @net: the applicable net namespace
 397  * @b_ptr: ptr to bearer issuing requests
 398  * @dest_domain: network domain to which links can be established
 399  */
 400 void tipc_disc_reset(struct net *net, struct tipc_bearer *b_ptr)
 401 {
 402         struct tipc_link_req *req = b_ptr->link_req;
 403
 404         spin_lock_bh(&req->lock);
 405         tipc_disc_init_msg(net, req->buf, DSC_REQ_MSG, b_ptr);
 406         req->net = net;
 407         req->bearer_id = b_ptr->identity;
 408         req->domain = b_ptr->domain;
 409         req->num_nodes = 0;
 410         req->timer_intv = TIPC_LINK_REQ_INIT;
 411         mod_timer(&req->timer, jiffies + req->timer_intv);
 412         tipc_bearer_send(net, req->bearer_id, req->buf, &req->dest);
 413         spin_unlock_bh(&req->lock);
 414 }