net/tipc/discover.c

   1 /*
   2  * net/tipc/discover.c
   3  *
   4  * Copyright (c) 2003-2006, 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 #define TIPC_LINK_REQ_INIT      125     /* min delay during bearer start up */
  42 #define TIPC_LINK_REQ_FAST      1000    /* max delay if bearer has no links */
  43 #define TIPC_LINK_REQ_SLOW      60000   /* max delay if bearer has links */
  44 #define TIPC_LINK_REQ_INACTIVE  0xffffffff /* indicates no timer in use */
  45
  46
  47 /**
  48  * struct tipc_link_req - information about an ongoing link setup request
  49  * @bearer_id: identity of bearer issuing requests
  50  * @dest: destination address for request messages
  51  * @domain: network domain to which links can be established
  52  * @num_nodes: number of nodes currently discovered (i.e. with an active link)
  53  * @lock: spinlock for controlling access to requests
  54  * @buf: request message to be (repeatedly) sent
  55  * @timer: timer governing period between requests
  56  * @timer_intv: current interval between requests (in ms)
  57  */
  58 struct tipc_link_req {
  59         u32 bearer_id;
  60         struct tipc_media_addr dest;
  61         u32 domain;
  62         int num_nodes;
  63         spinlock_t lock;
  64         struct sk_buff *buf;
  65         struct timer_list timer;
  66         unsigned int timer_intv;
  67 };
  68
  69 /**
  70  * tipc_disc_init_msg - initialize a link setup message
  71  * @type: message type (request or response)
  72  * @b_ptr: ptr to bearer issuing message
  73  */
  74 static void tipc_disc_init_msg(struct sk_buff *buf, u32 type,
  75                                struct tipc_bearer *b_ptr)
  76 {
  77         struct tipc_msg *msg;
  78         u32 dest_domain = b_ptr->domain;
  79
  80         msg = buf_msg(buf);
  81         tipc_msg_init(msg, LINK_CONFIG, type, INT_H_SIZE, dest_domain);
  82         msg_set_non_seq(msg, 1);
  83         msg_set_node_sig(msg, tipc_random);
  84         msg_set_dest_domain(msg, dest_domain);
  85         msg_set_bc_netid(msg, tipc_net_id);
  86         b_ptr->media->addr2msg(&b_ptr->addr, msg_media_addr(msg));
  87 }
  88
  89 /**
  90  * disc_dupl_alert - issue node address duplication alert
  91  * @b_ptr: pointer to bearer detecting duplication
  92  * @node_addr: duplicated node address
  93  * @media_addr: media address advertised by duplicated node
  94  */
  95 static void disc_dupl_alert(struct tipc_bearer *b_ptr, u32 node_addr,
  96                             struct tipc_media_addr *media_addr)
  97 {
  98         char node_addr_str[16];
  99         char media_addr_str[64];
 100
 101         tipc_addr_string_fill(node_addr_str, node_addr);
 102         tipc_media_addr_printf(media_addr_str, sizeof(media_addr_str),
 103                                media_addr);
 104         pr_warn("Duplicate %s using %s seen on <%s>\n", node_addr_str,
 105                 media_addr_str, b_ptr->name);
 106 }
 107
 108 /**
 109  * tipc_disc_rcv - handle incoming link setup message (request or response)
 110  * @buf: buffer containing message
 111  * @b_ptr: bearer that message arrived on
 112  */
 113 void tipc_disc_rcv(struct sk_buff *buf, struct tipc_bearer *b_ptr)
 114 {
 115         struct tipc_node *n_ptr;
 116         struct tipc_link *link;
 117         struct tipc_media_addr media_addr;
 118         struct sk_buff *rbuf;
 119         struct tipc_msg *msg = buf_msg(buf);
 120         u32 dest = msg_dest_domain(msg);
 121         u32 orig = msg_prevnode(msg);
 122         u32 net_id = msg_bc_netid(msg);
 123         u32 type = msg_type(msg);
 124         u32 signature = msg_node_sig(msg);
 125         int addr_mismatch;
 126         int link_fully_up;
 127
 128         media_addr.broadcast = 1;
 129         b_ptr->media->msg2addr(b_ptr, &media_addr, msg_media_addr(msg));
 130         kfree_skb(buf);
 131
 132         /* Ensure message from node is valid and communication is permitted */
 133         if (net_id != tipc_net_id)
 134                 return;
 135         if (media_addr.broadcast)
 136                 return;
 137         if (!tipc_addr_domain_valid(dest))
 138                 return;
 139         if (!tipc_addr_node_valid(orig))
 140                 return;
 141         if (orig == tipc_own_addr) {
 142                 if (memcmp(&media_addr, &b_ptr->addr, sizeof(media_addr)))
 143                         disc_dupl_alert(b_ptr, tipc_own_addr, &media_addr);
 144                 return;
 145         }
 146         if (!tipc_in_scope(dest, tipc_own_addr))
 147                 return;
 148         if (!tipc_in_scope(b_ptr->domain, orig))
 149                 return;
 150
 151         /* Locate structure corresponding to requesting node */
 152         n_ptr = tipc_node_find(orig);
 153         if (!n_ptr) {
 154                 n_ptr = tipc_node_create(orig);
 155                 if (!n_ptr)
 156                         return;
 157         }
 158         tipc_node_lock(n_ptr);
 159
 160         /* Prepare to validate requesting node's signature and media address */
 161         link = n_ptr->links[b_ptr->identity];
 162         addr_mismatch = (link != NULL) &&
 163                 memcmp(&link->media_addr, &media_addr, sizeof(media_addr));
 164
 165         /*
 166          * Ensure discovery message's signature is correct
 167          *
 168          * If signature is incorrect and there is no working link to the node,
 169          * accept the new signature but invalidate all existing links to the
 170          * node so they won't re-activate without a new discovery message.
 171          *
 172          * If signature is incorrect and the requested link to the node is
 173          * working, accept the new signature. (This is an instance of delayed
 174          * rediscovery, where a link endpoint was able to re-establish contact
 175          * with its peer endpoint on a node that rebooted before receiving a
 176          * discovery message from that node.)
 177          *
 178          * If signature is incorrect and there is a working link to the node
 179          * that is not the requested link, reject the request (must be from
 180          * a duplicate node).
 181          */
 182         if (signature != n_ptr->signature) {
 183                 if (n_ptr->working_links == 0) {
 184                         struct tipc_link *curr_link;
 185                         int i;
 186
 187                         for (i = 0; i < MAX_BEARERS; i++) {
 188                                 curr_link = n_ptr->links[i];
 189                                 if (curr_link) {
 190                                         memset(&curr_link->media_addr, 0,
 191                                                sizeof(media_addr));
 192                                         tipc_link_reset(curr_link);
 193                                 }
 194                         }
 195                         addr_mismatch = (link != NULL);
 196                 } else if (tipc_link_is_up(link) && !addr_mismatch) {
 197                         /* delayed rediscovery */
 198                 } else {
 199                         disc_dupl_alert(b_ptr, orig, &media_addr);
 200                         tipc_node_unlock(n_ptr);
 201                         return;
 202                 }
 203                 n_ptr->signature = signature;
 204         }
 205
 206         /*
 207          * Ensure requesting node's media address is correct
 208          *
 209          * If media address doesn't match and the link is working, reject the
 210          * request (must be from a duplicate node).
 211          *
 212          * If media address doesn't match and the link is not working, accept
 213          * the new media address and reset the link to ensure it starts up
 214          * cleanly.
 215          */
 216         if (addr_mismatch) {
 217                 if (tipc_link_is_up(link)) {
 218                         disc_dupl_alert(b_ptr, orig, &media_addr);
 219                         tipc_node_unlock(n_ptr);
 220                         return;
 221                 } else {
 222                         memcpy(&link->media_addr, &media_addr,
 223                                sizeof(media_addr));
 224                         tipc_link_reset(link);
 225                 }
 226         }
 227
 228         /* Create a link endpoint for this bearer, if necessary */
 229         if (!link) {
 230                 link = tipc_link_create(n_ptr, b_ptr, &media_addr);
 231                 if (!link) {
 232                         tipc_node_unlock(n_ptr);
 233                         return;
 234                 }
 235         }
 236
 237         /* Accept discovery message & send response, if necessary */
 238         link_fully_up = link_working_working(link);
 239
 240         if ((type == DSC_REQ_MSG) && !link_fully_up) {
 241                 rbuf = tipc_buf_acquire(INT_H_SIZE);
 242                 if (rbuf) {
 243                         tipc_disc_init_msg(rbuf, DSC_RESP_MSG, b_ptr);
 244                         tipc_bearer_send(b_ptr->identity, rbuf, &media_addr);
 245                         kfree_skb(rbuf);
 246                 }
 247         }
 248
 249         tipc_node_unlock(n_ptr);
 250 }
 251
 252 /**
 253  * disc_update - update frequency of periodic link setup requests
 254  * @req: ptr to link request structure
 255  *
 256  * Reinitiates discovery process if discovery object has no associated nodes
 257  * and is either not currently searching or is searching at a slow rate
 258  */
 259 static void disc_update(struct tipc_link_req *req)
 260 {
 261         if (!req->num_nodes) {
 262                 if ((req->timer_intv == TIPC_LINK_REQ_INACTIVE) ||
 263                     (req->timer_intv > TIPC_LINK_REQ_FAST)) {
 264                         req->timer_intv = TIPC_LINK_REQ_INIT;
 265                         k_start_timer(&req->timer, req->timer_intv);
 266                 }
 267         }
 268 }
 269
 270 /**
 271  * tipc_disc_add_dest - increment set of discovered nodes
 272  * @req: ptr to link request structure
 273  */
 274 void tipc_disc_add_dest(struct tipc_link_req *req)
 275 {
 276         spin_lock_bh(&req->lock);
 277         req->num_nodes++;
 278         spin_unlock_bh(&req->lock);
 279 }
 280
 281 /**
 282  * tipc_disc_remove_dest - decrement set of discovered nodes
 283  * @req: ptr to link request structure
 284  */
 285 void tipc_disc_remove_dest(struct tipc_link_req *req)
 286 {
 287         spin_lock_bh(&req->lock);
 288         req->num_nodes--;
 289         disc_update(req);
 290         spin_unlock_bh(&req->lock);
 291 }
 292
 293 /**
 294  * disc_timeout - send a periodic link setup request
 295  * @req: ptr to link request structure
 296  *
 297  * Called whenever a link setup request timer associated with a bearer expires.
 298  */
 299 static void disc_timeout(struct tipc_link_req *req)
 300 {
 301         int max_delay;
 302
 303         spin_lock_bh(&req->lock);
 304
 305         /* Stop searching if only desired node has been found */
 306         if (tipc_node(req->domain) && req->num_nodes) {
 307                 req->timer_intv = TIPC_LINK_REQ_INACTIVE;
 308                 goto exit;
 309         }
 310
 311         /*
 312          * Send discovery message, then update discovery timer
 313          *
 314          * Keep doubling time between requests until limit is reached;
 315          * hold at fast polling rate if don't have any associated nodes,
 316          * otherwise hold at slow polling rate
 317          */
 318         tipc_bearer_send(req->bearer_id, req->buf, &req->dest);
 319
 320
 321         req->timer_intv *= 2;
 322         if (req->num_nodes)
 323                 max_delay = TIPC_LINK_REQ_SLOW;
 324         else
 325                 max_delay = TIPC_LINK_REQ_FAST;
 326         if (req->timer_intv > max_delay)
 327                 req->timer_intv = max_delay;
 328
 329         k_start_timer(&req->timer, req->timer_intv);
 330 exit:
 331         spin_unlock_bh(&req->lock);
 332 }
 333
 334 /**
 335  * tipc_disc_create - create object to send periodic link setup requests
 336  * @b_ptr: ptr to bearer issuing requests
 337  * @dest: destination address for request messages
 338  * @dest_domain: network domain to which links can be established
 339  *
 340  * Returns 0 if successful, otherwise -errno.
 341  */
 342 int tipc_disc_create(struct tipc_bearer *b_ptr, struct tipc_media_addr *dest)
 343 {
 344         struct tipc_link_req *req;
 345
 346         req = kmalloc(sizeof(*req), GFP_ATOMIC);
 347         if (!req)
 348                 return -ENOMEM;
 349
 350         req->buf = tipc_buf_acquire(INT_H_SIZE);
 351         if (!req->buf) {
 352                 kfree(req);
 353                 return -ENOMEM;
 354         }
 355
 356         tipc_disc_init_msg(req->buf, DSC_REQ_MSG, b_ptr);
 357         memcpy(&req->dest, dest, sizeof(*dest));
 358         req->bearer_id = b_ptr->identity;
 359         req->domain = b_ptr->domain;
 360         req->num_nodes = 0;
 361         req->timer_intv = TIPC_LINK_REQ_INIT;
 362         spin_lock_init(&req->lock);
 363         k_init_timer(&req->timer, (Handler)disc_timeout, (unsigned long)req);
 364         k_start_timer(&req->timer, req->timer_intv);
 365         b_ptr->link_req = req;
 366         tipc_bearer_send(req->bearer_id, req->buf, &req->dest);
 367         return 0;
 368 }
 369
 370 /**
 371  * tipc_disc_delete - destroy object sending periodic link setup requests
 372  * @req: ptr to link request structure
 373  */
 374 void tipc_disc_delete(struct tipc_link_req *req)
 375 {
 376         k_cancel_timer(&req->timer);
 377         k_term_timer(&req->timer);
 378         kfree_skb(req->buf);
 379         kfree(req);
 380 }
 381
 382 /**
 383  * tipc_disc_reset - reset object to send periodic link setup requests
 384  * @b_ptr: ptr to bearer issuing requests
 385  * @dest_domain: network domain to which links can be established
 386  */
 387 void tipc_disc_reset(struct tipc_bearer *b_ptr)
 388 {
 389         struct tipc_link_req *req = b_ptr->link_req;
 390
 391         spin_lock_bh(&req->lock);
 392         tipc_disc_init_msg(req->buf, DSC_REQ_MSG, b_ptr);
 393         req->bearer_id = b_ptr->identity;
 394         req->domain = b_ptr->domain;
 395         req->num_nodes = 0;
 396         req->timer_intv = TIPC_LINK_REQ_INIT;
 397         k_start_timer(&req->timer, req->timer_intv);
 398         tipc_bearer_send(req->bearer_id, req->buf, &req->dest);
 399         spin_unlock_bh(&req->lock);
 400 }