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