net/tipc/name_distr.c

   1 /*
   2  * net/tipc/name_distr.c: TIPC name distribution code
   3  *
   4  * Copyright (c) 2000-2006, 2014-2019, Ericsson AB
   5  * Copyright (c) 2005, 2010-2011, Wind River Systems
   6  * Copyright (c) 2020-2021, Red Hat Inc
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. Neither the names of the copyright holders nor the names of its
  18  *    contributors may be used to endorse or promote products derived from
  19  *    this software without specific prior written permission.
  20  *
  21  * Alternatively, this software may be distributed under the terms of the
  22  * GNU General Public License ("GPL") version 2 as published by the Free
  23  * Software Foundation.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #include "core.h"
  39 #include "link.h"
  40 #include "name_distr.h"
  41
  42 int sysctl_tipc_named_timeout __read_mostly = 2000;
  43
  44 struct distr_queue_item {
  45         struct distr_item i;
  46         u32 dtype;
  47         u32 node;
  48         unsigned long expires;
  49         struct list_head next;
  50 };
  51
  52 /**
  53  * publ_to_item - add publication info to a publication message
  54  * @p: publication info
  55  * @i: location of item in the message
  56  */
  57 static void publ_to_item(struct distr_item *i, struct publication *p)
  58 {
  59         i->type = htonl(p->sr.type);
  60         i->lower = htonl(p->sr.lower);
  61         i->upper = htonl(p->sr.upper);
  62         i->port = htonl(p->sk.ref);
  63         i->key = htonl(p->key);
  64 }
  65
  66 /**
  67  * named_prepare_buf - allocate & initialize a publication message
  68  * @net: the associated network namespace
  69  * @type: message type
  70  * @size: payload size
  71  * @dest: destination node
  72  *
  73  * The buffer returned is of size INT_H_SIZE + payload size
  74  */
  75 static struct sk_buff *named_prepare_buf(struct net *net, u32 type, u32 size,
  76                                          u32 dest)
  77 {
  78         struct sk_buff *buf = tipc_buf_acquire(INT_H_SIZE + size, GFP_ATOMIC);
  79         u32 self = tipc_own_addr(net);
  80         struct tipc_msg *msg;
  81
  82         if (buf != NULL) {
  83                 msg = buf_msg(buf);
  84                 tipc_msg_init(self, msg, NAME_DISTRIBUTOR,
  85                               type, INT_H_SIZE, dest);
  86                 msg_set_size(msg, INT_H_SIZE + size);
  87         }
  88         return buf;
  89 }
  90
  91 /**
  92  * tipc_named_publish - tell other nodes about a new publication by this node
  93  * @net: the associated network namespace
  94  * @p: the new publication
  95  */
  96 struct sk_buff *tipc_named_publish(struct net *net, struct publication *p)
  97 {
  98         struct name_table *nt = tipc_name_table(net);
  99         struct distr_item *item;
 100         struct sk_buff *skb;
 101
 102         if (p->scope == TIPC_NODE_SCOPE) {
 103                 list_add_tail_rcu(&p->binding_node, &nt->node_scope);
 104                 return NULL;
 105         }
 106         write_lock_bh(&nt->cluster_scope_lock);
 107         list_add_tail(&p->binding_node, &nt->cluster_scope);
 108         write_unlock_bh(&nt->cluster_scope_lock);
 109         skb = named_prepare_buf(net, PUBLICATION, ITEM_SIZE, 0);
 110         if (!skb) {
 111                 pr_warn("Publication distribution failure\n");
 112                 return NULL;
 113         }
 114         msg_set_named_seqno(buf_msg(skb), nt->snd_nxt++);
 115         msg_set_non_legacy(buf_msg(skb));
 116         item = (struct distr_item *)msg_data(buf_msg(skb));
 117         publ_to_item(item, p);
 118         return skb;
 119 }
 120
 121 /**
 122  * tipc_named_withdraw - tell other nodes about a withdrawn publication by this node
 123  * @net: the associated network namespace
 124  * @p: the withdrawn publication
 125  */
 126 struct sk_buff *tipc_named_withdraw(struct net *net, struct publication *p)
 127 {
 128         struct name_table *nt = tipc_name_table(net);
 129         struct distr_item *item;
 130         struct sk_buff *skb;
 131
 132         write_lock_bh(&nt->cluster_scope_lock);
 133         list_del(&p->binding_node);
 134         write_unlock_bh(&nt->cluster_scope_lock);
 135         if (p->scope == TIPC_NODE_SCOPE)
 136                 return NULL;
 137
 138         skb = named_prepare_buf(net, WITHDRAWAL, ITEM_SIZE, 0);
 139         if (!skb) {
 140                 pr_warn("Withdrawal distribution failure\n");
 141                 return NULL;
 142         }
 143         msg_set_named_seqno(buf_msg(skb), nt->snd_nxt++);
 144         msg_set_non_legacy(buf_msg(skb));
 145         item = (struct distr_item *)msg_data(buf_msg(skb));
 146         publ_to_item(item, p);
 147         return skb;
 148 }
 149
 150 /**
 151  * named_distribute - prepare name info for bulk distribution to another node
 152  * @net: the associated network namespace
 153  * @list: list of messages (buffers) to be returned from this function
 154  * @dnode: node to be updated
 155  * @pls: linked list of publication items to be packed into buffer chain
 156  * @seqno: sequence number for this message
 157  */
 158 static void named_distribute(struct net *net, struct sk_buff_head *list,
 159                              u32 dnode, struct list_head *pls, u16 seqno)
 160 {
 161         struct publication *publ;
 162         struct sk_buff *skb = NULL;
 163         struct distr_item *item = NULL;
 164         u32 msg_dsz = ((tipc_node_get_mtu(net, dnode, 0, false) - INT_H_SIZE) /
 165                         ITEM_SIZE) * ITEM_SIZE;
 166         u32 msg_rem = msg_dsz;
 167         struct tipc_msg *hdr;
 168
 169         list_for_each_entry(publ, pls, binding_node) {
 170                 /* Prepare next buffer: */
 171                 if (!skb) {
 172                         skb = named_prepare_buf(net, PUBLICATION, msg_rem,
 173                                                 dnode);
 174                         if (!skb) {
 175                                 pr_warn("Bulk publication failure\n");
 176                                 return;
 177                         }
 178                         hdr = buf_msg(skb);
 179                         msg_set_bc_ack_invalid(hdr, true);
 180                         msg_set_bulk(hdr);
 181                         msg_set_non_legacy(hdr);
 182                         item = (struct distr_item *)msg_data(hdr);
 183                 }
 184
 185                 /* Pack publication into message: */
 186                 publ_to_item(item, publ);
 187                 item++;
 188                 msg_rem -= ITEM_SIZE;
 189
 190                 /* Append full buffer to list: */
 191                 if (!msg_rem) {
 192                         __skb_queue_tail(list, skb);
 193                         skb = NULL;
 194                         msg_rem = msg_dsz;
 195                 }
 196         }
 197         if (skb) {
 198                 hdr = buf_msg(skb);
 199                 msg_set_size(hdr, INT_H_SIZE + (msg_dsz - msg_rem));
 200                 skb_trim(skb, INT_H_SIZE + (msg_dsz - msg_rem));
 201                 __skb_queue_tail(list, skb);
 202         }
 203         hdr = buf_msg(skb_peek_tail(list));
 204         msg_set_last_bulk(hdr);
 205         msg_set_named_seqno(hdr, seqno);
 206 }
 207
 208 /**
 209  * tipc_named_node_up - tell specified node about all publications by this node
 210  * @net: the associated network namespace
 211  * @dnode: destination node
 212  * @capabilities: peer node's capabilities
 213  */
 214 void tipc_named_node_up(struct net *net, u32 dnode, u16 capabilities)
 215 {
 216         struct name_table *nt = tipc_name_table(net);
 217         struct tipc_net *tn = tipc_net(net);
 218         struct sk_buff_head head;
 219         u16 seqno;
 220
 221         __skb_queue_head_init(&head);
 222         spin_lock_bh(&tn->nametbl_lock);
 223         if (!(capabilities & TIPC_NAMED_BCAST))
 224                 nt->rc_dests++;
 225         seqno = nt->snd_nxt;
 226         spin_unlock_bh(&tn->nametbl_lock);
 227
 228         read_lock_bh(&nt->cluster_scope_lock);
 229         named_distribute(net, &head, dnode, &nt->cluster_scope, seqno);
 230         tipc_node_xmit(net, &head, dnode, 0);
 231         read_unlock_bh(&nt->cluster_scope_lock);
 232 }
 233
 234 /**
 235  * tipc_publ_purge - remove publication associated with a failed node
 236  * @net: the associated network namespace
 237  * @p: the publication to remove
 238  * @addr: failed node's address
 239  *
 240  * Invoked for each publication issued by a newly failed node.
 241  * Removes publication structure from name table & deletes it.
 242  */
 243 static void tipc_publ_purge(struct net *net, struct publication *p, u32 addr)
 244 {
 245         struct tipc_net *tn = tipc_net(net);
 246         struct publication *_p;
 247
 248         spin_lock_bh(&tn->nametbl_lock);
 249         _p = tipc_nametbl_remove_publ(net, p->sr.type, p->sr.lower,
 250                                       p->sr.upper, p->sk.node, p->key);
 251         if (_p)
 252                 tipc_node_unsubscribe(net, &_p->binding_node, addr);
 253         spin_unlock_bh(&tn->nametbl_lock);
 254
 255         if (_p != p) {
 256                 pr_err("Unable to remove publication from failed node\n"
 257                        " (type=%u, lower=%u, node=0x%x, port=%u, key=%u)\n",
 258                        p->sr.type, p->sr.lower, p->sk.node, p->sk.ref, p->key);
 259         }
 260
 261         if (_p)
 262                 kfree_rcu(_p, rcu);
 263 }
 264
 265 void tipc_publ_notify(struct net *net, struct list_head *nsub_list,
 266                       u32 addr, u16 capabilities)
 267 {
 268         struct name_table *nt = tipc_name_table(net);
 269         struct tipc_net *tn = tipc_net(net);
 270
 271         struct publication *publ, *tmp;
 272
 273         list_for_each_entry_safe(publ, tmp, nsub_list, binding_node)
 274                 tipc_publ_purge(net, publ, addr);
 275         spin_lock_bh(&tn->nametbl_lock);
 276         if (!(capabilities & TIPC_NAMED_BCAST))
 277                 nt->rc_dests--;
 278         spin_unlock_bh(&tn->nametbl_lock);
 279 }
 280
 281 /**
 282  * tipc_update_nametbl - try to process a nametable update and notify
 283  *                       subscribers
 284  * @net: the associated network namespace
 285  * @i: location of item in the message
 286  * @node: node address
 287  * @dtype: name distributor message type
 288  *
 289  * tipc_nametbl_lock must be held.
 290  * Return: the publication item if successful, otherwise NULL.
 291  */
 292 static bool tipc_update_nametbl(struct net *net, struct distr_item *i,
 293                                 u32 node, u32 dtype)
 294 {
 295         struct publication *p = NULL;
 296         u32 lower = ntohl(i->lower);
 297         u32 upper = ntohl(i->upper);
 298         u32 type = ntohl(i->type);
 299         u32 port = ntohl(i->port);
 300         u32 key = ntohl(i->key);
 301
 302         if (dtype == PUBLICATION) {
 303                 p = tipc_nametbl_insert_publ(net, type, lower, upper,
 304                                              TIPC_CLUSTER_SCOPE, node,
 305                                              port, key);
 306                 if (p) {
 307                         tipc_node_subscribe(net, &p->binding_node, node);
 308                         return true;
 309                 }
 310         } else if (dtype == WITHDRAWAL) {
 311                 p = tipc_nametbl_remove_publ(net, type, lower,
 312                                              upper, node, key);
 313                 if (p) {
 314                         tipc_node_unsubscribe(net, &p->binding_node, node);
 315                         kfree_rcu(p, rcu);
 316                         return true;
 317                 }
 318                 pr_warn_ratelimited("Failed to remove binding %u,%u from %x\n",
 319                                     type, lower, node);
 320         } else {
 321                 pr_warn("Unrecognized name table message received\n");
 322         }
 323         return false;
 324 }
 325
 326 static struct sk_buff *tipc_named_dequeue(struct sk_buff_head *namedq,
 327                                           u16 *rcv_nxt, bool *open)
 328 {
 329         struct sk_buff *skb, *tmp;
 330         struct tipc_msg *hdr;
 331         u16 seqno;
 332
 333         spin_lock_bh(&namedq->lock);
 334         skb_queue_walk_safe(namedq, skb, tmp) {
 335                 if (unlikely(skb_linearize(skb))) {
 336                         __skb_unlink(skb, namedq);
 337                         kfree_skb(skb);
 338                         continue;
 339                 }
 340                 hdr = buf_msg(skb);
 341                 seqno = msg_named_seqno(hdr);
 342                 if (msg_is_last_bulk(hdr)) {
 343                         *rcv_nxt = seqno;
 344                         *open = true;
 345                 }
 346
 347                 if (msg_is_bulk(hdr) || msg_is_legacy(hdr)) {
 348                         __skb_unlink(skb, namedq);
 349                         spin_unlock_bh(&namedq->lock);
 350                         return skb;
 351                 }
 352
 353                 if (*open && (*rcv_nxt == seqno)) {
 354                         (*rcv_nxt)++;
 355                         __skb_unlink(skb, namedq);
 356                         spin_unlock_bh(&namedq->lock);
 357                         return skb;
 358                 }
 359
 360                 if (less(seqno, *rcv_nxt)) {
 361                         __skb_unlink(skb, namedq);
 362                         kfree_skb(skb);
 363                         continue;
 364                 }
 365         }
 366         spin_unlock_bh(&namedq->lock);
 367         return NULL;
 368 }
 369
 370 /**
 371  * tipc_named_rcv - process name table update messages sent by another node
 372  * @net: the associated network namespace
 373  * @namedq: queue to receive from
 374  * @rcv_nxt: store last received seqno here
 375  * @open: last bulk msg was received (FIXME)
 376  */
 377 void tipc_named_rcv(struct net *net, struct sk_buff_head *namedq,
 378                     u16 *rcv_nxt, bool *open)
 379 {
 380         struct tipc_net *tn = tipc_net(net);
 381         struct distr_item *item;
 382         struct tipc_msg *hdr;
 383         struct sk_buff *skb;
 384         u32 count, node;
 385
 386         spin_lock_bh(&tn->nametbl_lock);
 387         while ((skb = tipc_named_dequeue(namedq, rcv_nxt, open))) {
 388                 hdr = buf_msg(skb);
 389                 node = msg_orignode(hdr);
 390                 item = (struct distr_item *)msg_data(hdr);
 391                 count = msg_data_sz(hdr) / ITEM_SIZE;
 392                 while (count--) {
 393                         tipc_update_nametbl(net, item, node, msg_type(hdr));
 394                         item++;
 395                 }
 396                 kfree_skb(skb);
 397         }
 398         spin_unlock_bh(&tn->nametbl_lock);
 399 }
 400
 401 /**
 402  * tipc_named_reinit - re-initialize local publications
 403  * @net: the associated network namespace
 404  *
 405  * This routine is called whenever TIPC networking is enabled.
 406  * All name table entries published by this node are updated to reflect
 407  * the node's new network address.
 408  */
 409 void tipc_named_reinit(struct net *net)
 410 {
 411         struct name_table *nt = tipc_name_table(net);
 412         struct tipc_net *tn = tipc_net(net);
 413         struct publication *p;
 414         u32 self = tipc_own_addr(net);
 415
 416         spin_lock_bh(&tn->nametbl_lock);
 417
 418         list_for_each_entry_rcu(p, &nt->node_scope, binding_node)
 419                 p->sk.node = self;
 420         list_for_each_entry_rcu(p, &nt->cluster_scope, binding_node)
 421                 p->sk.node = self;
 422         nt->rc_dests = 0;
 423         spin_unlock_bh(&tn->nametbl_lock);
 424 }