net/tipc/name_distr.c

   1 /*
   2  * net/tipc/name_distr.c: TIPC name distribution code
   3  *
   4  * Copyright (c) 2000-2006, 2014, Ericsson AB
   5  * Copyright (c) 2005, 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 "name_distr.h"
  40
  41 /**
  42  * struct publ_list - list of publications made by this node
  43  * @list: circular list of publications
  44  * @list_size: number of entries in list
  45  */
  46 struct publ_list {
  47         struct list_head list;
  48         u32 size;
  49 };
  50
  51 static struct publ_list publ_zone = {
  52         .list = LIST_HEAD_INIT(publ_zone.list),
  53         .size = 0,
  54 };
  55
  56 static struct publ_list publ_cluster = {
  57         .list = LIST_HEAD_INIT(publ_cluster.list),
  58         .size = 0,
  59 };
  60
  61 static struct publ_list publ_node = {
  62         .list = LIST_HEAD_INIT(publ_node.list),
  63         .size = 0,
  64 };
  65
  66 static struct publ_list *publ_lists[] = {
  67         NULL,
  68         &publ_zone,     /* publ_lists[TIPC_ZONE_SCOPE]          */
  69         &publ_cluster,  /* publ_lists[TIPC_CLUSTER_SCOPE]       */
  70         &publ_node      /* publ_lists[TIPC_NODE_SCOPE]          */
  71 };
  72
  73
  74 int sysctl_tipc_named_timeout __read_mostly = 2000;
  75
  76 /**
  77  * struct tipc_dist_queue - queue holding deferred name table updates
  78  */
  79 static struct list_head tipc_dist_queue = LIST_HEAD_INIT(tipc_dist_queue);
  80
  81 struct distr_queue_item {
  82         struct distr_item i;
  83         u32 dtype;
  84         u32 node;
  85         unsigned long expires;
  86         struct list_head next;
  87 };
  88
  89 /**
  90  * publ_to_item - add publication info to a publication message
  91  */
  92 static void publ_to_item(struct distr_item *i, struct publication *p)
  93 {
  94         i->type = htonl(p->type);
  95         i->lower = htonl(p->lower);
  96         i->upper = htonl(p->upper);
  97         i->ref = htonl(p->ref);
  98         i->key = htonl(p->key);
  99 }
 100
 101 /**
 102  * named_prepare_buf - allocate & initialize a publication message
 103  */
 104 static struct sk_buff *named_prepare_buf(u32 type, u32 size, u32 dest)
 105 {
 106         struct sk_buff *buf = tipc_buf_acquire(INT_H_SIZE + size);
 107         struct tipc_msg *msg;
 108
 109         if (buf != NULL) {
 110                 msg = buf_msg(buf);
 111                 tipc_msg_init(msg, NAME_DISTRIBUTOR, type, INT_H_SIZE, dest);
 112                 msg_set_size(msg, INT_H_SIZE + size);
 113         }
 114         return buf;
 115 }
 116
 117 void named_cluster_distribute(struct sk_buff *skb)
 118 {
 119         struct sk_buff *oskb;
 120         struct tipc_node *node;
 121         u32 dnode;
 122
 123         rcu_read_lock();
 124         list_for_each_entry_rcu(node, &tipc_node_list, list) {
 125                 dnode = node->addr;
 126                 if (in_own_node(dnode))
 127                         continue;
 128                 if (!tipc_node_active_links(node))
 129                         continue;
 130                 oskb = skb_copy(skb, GFP_ATOMIC);
 131                 if (!oskb)
 132                         break;
 133                 msg_set_destnode(buf_msg(oskb), dnode);
 134                 tipc_link_xmit_skb(oskb, dnode, dnode);
 135         }
 136         rcu_read_unlock();
 137
 138         kfree_skb(skb);
 139 }
 140
 141 /**
 142  * tipc_named_publish - tell other nodes about a new publication by this node
 143  */
 144 struct sk_buff *tipc_named_publish(struct publication *publ)
 145 {
 146         struct sk_buff *buf;
 147         struct distr_item *item;
 148
 149         list_add_tail(&publ->local_list, &publ_lists[publ->scope]->list);
 150         publ_lists[publ->scope]->size++;
 151
 152         if (publ->scope == TIPC_NODE_SCOPE)
 153                 return NULL;
 154
 155         buf = named_prepare_buf(PUBLICATION, ITEM_SIZE, 0);
 156         if (!buf) {
 157                 pr_warn("Publication distribution failure\n");
 158                 return NULL;
 159         }
 160
 161         item = (struct distr_item *)msg_data(buf_msg(buf));
 162         publ_to_item(item, publ);
 163         return buf;
 164 }
 165
 166 /**
 167  * tipc_named_withdraw - tell other nodes about a withdrawn publication by this node
 168  */
 169 struct sk_buff *tipc_named_withdraw(struct publication *publ)
 170 {
 171         struct sk_buff *buf;
 172         struct distr_item *item;
 173
 174         list_del(&publ->local_list);
 175         publ_lists[publ->scope]->size--;
 176
 177         if (publ->scope == TIPC_NODE_SCOPE)
 178                 return NULL;
 179
 180         buf = named_prepare_buf(WITHDRAWAL, ITEM_SIZE, 0);
 181         if (!buf) {
 182                 pr_warn("Withdrawal distribution failure\n");
 183                 return NULL;
 184         }
 185
 186         item = (struct distr_item *)msg_data(buf_msg(buf));
 187         publ_to_item(item, publ);
 188         return buf;
 189 }
 190
 191 /**
 192  * named_distribute - prepare name info for bulk distribution to another node
 193  * @list: list of messages (buffers) to be returned from this function
 194  * @dnode: node to be updated
 195  * @pls: linked list of publication items to be packed into buffer chain
 196  */
 197 static void named_distribute(struct sk_buff_head *list, u32 dnode,
 198                              struct publ_list *pls)
 199 {
 200         struct publication *publ;
 201         struct sk_buff *skb = NULL;
 202         struct distr_item *item = NULL;
 203         uint dsz = pls->size * ITEM_SIZE;
 204         uint msg_dsz = (tipc_node_get_mtu(dnode, 0) / ITEM_SIZE) * ITEM_SIZE;
 205         uint rem = dsz;
 206         uint msg_rem = 0;
 207
 208         list_for_each_entry(publ, &pls->list, local_list) {
 209                 /* Prepare next buffer: */
 210                 if (!skb) {
 211                         msg_rem = min_t(uint, rem, msg_dsz);
 212                         rem -= msg_rem;
 213                         skb = named_prepare_buf(PUBLICATION, msg_rem, dnode);
 214                         if (!skb) {
 215                                 pr_warn("Bulk publication failure\n");
 216                                 return;
 217                         }
 218                         item = (struct distr_item *)msg_data(buf_msg(skb));
 219                 }
 220
 221                 /* Pack publication into message: */
 222                 publ_to_item(item, publ);
 223                 item++;
 224                 msg_rem -= ITEM_SIZE;
 225
 226                 /* Append full buffer to list: */
 227                 if (!msg_rem) {
 228                         __skb_queue_tail(list, skb);
 229                         skb = NULL;
 230                 }
 231         }
 232 }
 233
 234 /**
 235  * tipc_named_node_up - tell specified node about all publications by this node
 236  */
 237 void tipc_named_node_up(u32 dnode)
 238 {
 239         struct sk_buff_head head;
 240
 241         __skb_queue_head_init(&head);
 242
 243         read_lock_bh(&tipc_nametbl_lock);
 244         named_distribute(&head, dnode, &publ_cluster);
 245         named_distribute(&head, dnode, &publ_zone);
 246         read_unlock_bh(&tipc_nametbl_lock);
 247
 248         tipc_link_xmit(&head, dnode, dnode);
 249 }
 250
 251 static void tipc_publ_subscribe(struct publication *publ, u32 addr)
 252 {
 253         struct tipc_node *node;
 254
 255         if (in_own_node(addr))
 256                 return;
 257
 258         node = tipc_node_find(addr);
 259         if (!node) {
 260                 pr_warn("Node subscription rejected, unknown node 0x%x\n",
 261                         addr);
 262                 return;
 263         }
 264
 265         tipc_node_lock(node);
 266         list_add_tail(&publ->nodesub_list, &node->publ_list);
 267         tipc_node_unlock(node);
 268 }
 269
 270 static void tipc_publ_unsubscribe(struct publication *publ, u32 addr)
 271 {
 272         struct tipc_node *node;
 273
 274         node = tipc_node_find(addr);
 275         if (!node)
 276                 return;
 277
 278         tipc_node_lock(node);
 279         list_del_init(&publ->nodesub_list);
 280         tipc_node_unlock(node);
 281 }
 282
 283 /**
 284  * tipc_publ_purge - remove publication associated with a failed node
 285  *
 286  * Invoked for each publication issued by a newly failed node.
 287  * Removes publication structure from name table & deletes it.
 288  */
 289 static void tipc_publ_purge(struct publication *publ, u32 addr)
 290 {
 291         struct publication *p;
 292
 293         write_lock_bh(&tipc_nametbl_lock);
 294         p = tipc_nametbl_remove_publ(publ->type, publ->lower,
 295                                      publ->node, publ->ref, publ->key);
 296         if (p)
 297                 tipc_publ_unsubscribe(p, addr);
 298         write_unlock_bh(&tipc_nametbl_lock);
 299
 300         if (p != publ) {
 301                 pr_err("Unable to remove publication from failed node\n"
 302                        " (type=%u, lower=%u, node=0x%x, ref=%u, key=%u)\n",
 303                        publ->type, publ->lower, publ->node, publ->ref,
 304                        publ->key);
 305         }
 306
 307         kfree(p);
 308 }
 309
 310 void tipc_publ_notify(struct list_head *nsub_list, u32 addr)
 311 {
 312         struct publication *publ, *tmp;
 313
 314         list_for_each_entry_safe(publ, tmp, nsub_list, nodesub_list)
 315                 tipc_publ_purge(publ, addr);
 316 }
 317
 318 /**
 319  * tipc_update_nametbl - try to process a nametable update and notify
 320  *                       subscribers
 321  *
 322  * tipc_nametbl_lock must be held.
 323  * Returns the publication item if successful, otherwise NULL.
 324  */
 325 static bool tipc_update_nametbl(struct distr_item *i, u32 node, u32 dtype)
 326 {
 327         struct publication *publ = NULL;
 328
 329         if (dtype == PUBLICATION) {
 330                 publ = tipc_nametbl_insert_publ(ntohl(i->type), ntohl(i->lower),
 331                                                 ntohl(i->upper),
 332                                                 TIPC_CLUSTER_SCOPE, node,
 333                                                 ntohl(i->ref), ntohl(i->key));
 334                 if (publ) {
 335                         tipc_publ_subscribe(publ, node);
 336                         return true;
 337                 }
 338         } else if (dtype == WITHDRAWAL) {
 339                 publ = tipc_nametbl_remove_publ(ntohl(i->type), ntohl(i->lower),
 340                                                 node, ntohl(i->ref),
 341                                                 ntohl(i->key));
 342                 if (publ) {
 343                         tipc_publ_unsubscribe(publ, node);
 344                         kfree(publ);
 345                         return true;
 346                 }
 347         } else {
 348                 pr_warn("Unrecognized name table message received\n");
 349         }
 350         return false;
 351 }
 352
 353 /**
 354  * tipc_named_add_backlog - add a failed name table update to the backlog
 355  *
 356  */
 357 static void tipc_named_add_backlog(struct distr_item *i, u32 type, u32 node)
 358 {
 359         struct distr_queue_item *e;
 360         unsigned long now = get_jiffies_64();
 361
 362         e = kzalloc(sizeof(*e), GFP_ATOMIC);
 363         if (!e)
 364                 return;
 365         e->dtype = type;
 366         e->node = node;
 367         e->expires = now + msecs_to_jiffies(sysctl_tipc_named_timeout);
 368         memcpy(e, i, sizeof(*i));
 369         list_add_tail(&e->next, &tipc_dist_queue);
 370 }
 371
 372 /**
 373  * tipc_named_process_backlog - try to process any pending name table updates
 374  * from the network.
 375  */
 376 void tipc_named_process_backlog(void)
 377 {
 378         struct distr_queue_item *e, *tmp;
 379         char addr[16];
 380         unsigned long now = get_jiffies_64();
 381
 382         list_for_each_entry_safe(e, tmp, &tipc_dist_queue, next) {
 383                 if (time_after(e->expires, now)) {
 384                         if (!tipc_update_nametbl(&e->i, e->node, e->dtype))
 385                                 continue;
 386                 } else {
 387                         tipc_addr_string_fill(addr, e->node);
 388                         pr_warn_ratelimited("Dropping name table update (%d) of {%u, %u, %u} from %s key=%u\n",
 389                                             e->dtype, ntohl(e->i.type),
 390                                             ntohl(e->i.lower),
 391                                             ntohl(e->i.upper),
 392                                             addr, ntohl(e->i.key));
 393                 }
 394                 list_del(&e->next);
 395                 kfree(e);
 396         }
 397 }
 398
 399 /**
 400  * tipc_named_rcv - process name table update message sent by another node
 401  */
 402 void tipc_named_rcv(struct sk_buff *buf)
 403 {
 404         struct tipc_msg *msg = buf_msg(buf);
 405         struct distr_item *item = (struct distr_item *)msg_data(msg);
 406         u32 count = msg_data_sz(msg) / ITEM_SIZE;
 407         u32 node = msg_orignode(msg);
 408
 409         write_lock_bh(&tipc_nametbl_lock);
 410         while (count--) {
 411                 if (!tipc_update_nametbl(item, node, msg_type(msg)))
 412                         tipc_named_add_backlog(item, msg_type(msg), node);
 413                 item++;
 414         }
 415         tipc_named_process_backlog();
 416         write_unlock_bh(&tipc_nametbl_lock);
 417         kfree_skb(buf);
 418 }
 419
 420 /**
 421  * tipc_named_reinit - re-initialize local publications
 422  *
 423  * This routine is called whenever TIPC networking is enabled.
 424  * All name table entries published by this node are updated to reflect
 425  * the node's new network address.
 426  */
 427 void tipc_named_reinit(void)
 428 {
 429         struct publication *publ;
 430         int scope;
 431
 432         write_lock_bh(&tipc_nametbl_lock);
 433
 434         for (scope = TIPC_ZONE_SCOPE; scope <= TIPC_NODE_SCOPE; scope++)
 435                 list_for_each_entry(publ, &publ_lists[scope]->list, local_list)
 436                         publ->node = tipc_own_addr;
 437
 438         write_unlock_bh(&tipc_nametbl_lock);
 439 }