net/tipc/bcast.c

   1 /*
   2  * net/tipc/bcast.c: TIPC broadcast code
   3  *
   4  * Copyright (c) 2004-2006, 2014-2015, Ericsson AB
   5  * Copyright (c) 2004, Intel Corporation.
   6  * Copyright (c) 2005, 2010-2011, Wind River Systems
   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 <linux/tipc_config.h>
  39 #include "socket.h"
  40 #include "msg.h"
  41 #include "bcast.h"
  42 #include "name_distr.h"
  43 #include "link.h"
  44 #include "node.h"
  45
  46 #define MAX_PKT_DEFAULT_MCAST   1500    /* bcast link max packet size (fixed) */
  47 #define BCLINK_WIN_DEFAULT      50      /* bcast link window size (default) */
  48 #define BCLINK_WIN_MIN          32      /* bcast minimum link window size */
  49
  50 const char tipc_bclink_name[] = "broadcast-link";
  51
  52 /**
  53  * struct tipc_bcbearer_pair - a pair of bearers used by broadcast link
  54  * @primary: pointer to primary bearer
  55  * @secondary: pointer to secondary bearer
  56  *
  57  * Bearers must have same priority and same set of reachable destinations
  58  * to be paired.
  59  */
  60
  61 struct tipc_bcbearer_pair {
  62         struct tipc_bearer *primary;
  63         struct tipc_bearer *secondary;
  64 };
  65
  66 #define BCBEARER                MAX_BEARERS
  67
  68 /**
  69  * struct tipc_bcbearer - bearer used by broadcast link
  70  * @bearer: (non-standard) broadcast bearer structure
  71  * @media: (non-standard) broadcast media structure
  72  * @bpairs: array of bearer pairs
  73  * @bpairs_temp: temporary array of bearer pairs used by tipc_bcbearer_sort()
  74  * @remains: temporary node map used by tipc_bcbearer_send()
  75  * @remains_new: temporary node map used tipc_bcbearer_send()
  76  *
  77  * Note: The fields labelled "temporary" are incorporated into the bearer
  78  * to avoid consuming potentially limited stack space through the use of
  79  * large local variables within multicast routines.  Concurrent access is
  80  * prevented through use of the spinlock "bcast_lock".
  81  */
  82 struct tipc_bcbearer {
  83         struct tipc_bearer bearer;
  84         struct tipc_media media;
  85         struct tipc_bcbearer_pair bpairs[MAX_BEARERS];
  86         struct tipc_bcbearer_pair bpairs_temp[TIPC_MAX_LINK_PRI + 1];
  87         struct tipc_node_map remains;
  88         struct tipc_node_map remains_new;
  89 };
  90
  91 /**
  92  * struct tipc_bc_base - link used for broadcast messages
  93  * @link: (non-standard) broadcast link structure
  94  * @node: (non-standard) node structure representing b'cast link's peer node
  95  * @bcast_nodes: map of broadcast-capable nodes
  96  * @retransmit_to: node that most recently requested a retransmit
  97  *
  98  * Handles sequence numbering, fragmentation, bundling, etc.
  99  */
 100 struct tipc_bc_base {
 101         struct tipc_link link;
 102         struct tipc_node node;
 103         struct sk_buff_head arrvq;
 104         struct sk_buff_head inputq;
 105         struct tipc_node_map bcast_nodes;
 106         struct tipc_node *retransmit_to;
 107 };
 108
 109 /**
 110  * tipc_nmap_equal - test for equality of node maps
 111  */
 112 static int tipc_nmap_equal(struct tipc_node_map *nm_a,
 113                            struct tipc_node_map *nm_b)
 114 {
 115         return !memcmp(nm_a, nm_b, sizeof(*nm_a));
 116 }
 117
 118 static void tipc_nmap_diff(struct tipc_node_map *nm_a,
 119                            struct tipc_node_map *nm_b,
 120                            struct tipc_node_map *nm_diff);
 121 static void tipc_nmap_add(struct tipc_node_map *nm_ptr, u32 node);
 122 static void tipc_nmap_remove(struct tipc_node_map *nm_ptr, u32 node);
 123 static void tipc_bclink_lock(struct net *net)
 124 {
 125         tipc_bcast_lock(net);
 126 }
 127
 128 static void tipc_bclink_unlock(struct net *net)
 129 {
 130         tipc_bcast_unlock(net);
 131 }
 132
 133 void tipc_bclink_input(struct net *net)
 134 {
 135         struct tipc_net *tn = net_generic(net, tipc_net_id);
 136
 137         tipc_sk_mcast_rcv(net, &tn->bcbase->arrvq, &tn->bcbase->inputq);
 138 }
 139
 140 uint  tipc_bcast_get_mtu(void)
 141 {
 142         return MAX_PKT_DEFAULT_MCAST;
 143 }
 144
 145 static u32 bcbuf_acks(struct sk_buff *buf)
 146 {
 147         return (u32)(unsigned long)TIPC_SKB_CB(buf)->handle;
 148 }
 149
 150 static void bcbuf_set_acks(struct sk_buff *buf, u32 acks)
 151 {
 152         TIPC_SKB_CB(buf)->handle = (void *)(unsigned long)acks;
 153 }
 154
 155 static void bcbuf_decr_acks(struct sk_buff *buf)
 156 {
 157         bcbuf_set_acks(buf, bcbuf_acks(buf) - 1);
 158 }
 159
 160 void tipc_bclink_add_node(struct net *net, u32 addr)
 161 {
 162         struct tipc_net *tn = net_generic(net, tipc_net_id);
 163
 164         tipc_bclink_lock(net);
 165         tipc_nmap_add(&tn->bcbase->bcast_nodes, addr);
 166         tipc_bclink_unlock(net);
 167 }
 168
 169 void tipc_bclink_remove_node(struct net *net, u32 addr)
 170 {
 171         struct tipc_net *tn = net_generic(net, tipc_net_id);
 172
 173         tipc_bclink_lock(net);
 174         tipc_nmap_remove(&tn->bcbase->bcast_nodes, addr);
 175
 176         /* Last node? => reset backlog queue */
 177         if (!tn->bcbase->bcast_nodes.count)
 178                 tipc_link_purge_backlog(&tn->bcbase->link);
 179
 180         tipc_bclink_unlock(net);
 181 }
 182
 183 static void bclink_set_last_sent(struct net *net)
 184 {
 185         struct tipc_net *tn = net_generic(net, tipc_net_id);
 186         struct tipc_link *bcl = tn->bcl;
 187
 188         bcl->silent_intv_cnt = mod(bcl->snd_nxt - 1);
 189 }
 190
 191 u32 tipc_bclink_get_last_sent(struct net *net)
 192 {
 193         struct tipc_net *tn = net_generic(net, tipc_net_id);
 194
 195         return tn->bcl->silent_intv_cnt;
 196 }
 197
 198 static void bclink_update_last_sent(struct tipc_node *node, u32 seqno)
 199 {
 200         node->bclink.last_sent = less_eq(node->bclink.last_sent, seqno) ?
 201                                                 seqno : node->bclink.last_sent;
 202 }
 203
 204 /**
 205  * tipc_bclink_retransmit_to - get most recent node to request retransmission
 206  *
 207  * Called with bclink_lock locked
 208  */
 209 struct tipc_node *tipc_bclink_retransmit_to(struct net *net)
 210 {
 211         struct tipc_net *tn = net_generic(net, tipc_net_id);
 212
 213         return tn->bcbase->retransmit_to;
 214 }
 215
 216 /**
 217  * bclink_retransmit_pkt - retransmit broadcast packets
 218  * @after: sequence number of last packet to *not* retransmit
 219  * @to: sequence number of last packet to retransmit
 220  *
 221  * Called with bclink_lock locked
 222  */
 223 static void bclink_retransmit_pkt(struct tipc_net *tn, u32 after, u32 to)
 224 {
 225         struct sk_buff *skb;
 226         struct tipc_link *bcl = tn->bcl;
 227
 228         skb_queue_walk(&bcl->transmq, skb) {
 229                 if (more(buf_seqno(skb), after)) {
 230                         tipc_link_retransmit(bcl, skb, mod(to - after));
 231                         break;
 232                 }
 233         }
 234 }
 235
 236 /**
 237  * bclink_prepare_wakeup - prepare users for wakeup after congestion
 238  * @bcl: broadcast link
 239  * @resultq: queue for users which can be woken up
 240  * Move a number of waiting users, as permitted by available space in
 241  * the send queue, from link wait queue to specified queue for wakeup
 242  */
 243 static void bclink_prepare_wakeup(struct tipc_link *bcl, struct sk_buff_head *resultq)
 244 {
 245         int pnd[TIPC_SYSTEM_IMPORTANCE + 1] = {0,};
 246         int imp, lim;
 247         struct sk_buff *skb, *tmp;
 248
 249         skb_queue_walk_safe(&bcl->wakeupq, skb, tmp) {
 250                 imp = TIPC_SKB_CB(skb)->chain_imp;
 251                 lim = bcl->window + bcl->backlog[imp].limit;
 252                 pnd[imp] += TIPC_SKB_CB(skb)->chain_sz;
 253                 if ((pnd[imp] + bcl->backlog[imp].len) >= lim)
 254                         continue;
 255                 skb_unlink(skb, &bcl->wakeupq);
 256                 skb_queue_tail(resultq, skb);
 257         }
 258 }
 259
 260 /**
 261  * tipc_bclink_wakeup_users - wake up pending users
 262  *
 263  * Called with no locks taken
 264  */
 265 void tipc_bclink_wakeup_users(struct net *net)
 266 {
 267         struct tipc_net *tn = net_generic(net, tipc_net_id);
 268         struct tipc_link *bcl = tn->bcl;
 269         struct sk_buff_head resultq;
 270
 271         skb_queue_head_init(&resultq);
 272         bclink_prepare_wakeup(bcl, &resultq);
 273         tipc_sk_rcv(net, &resultq);
 274 }
 275
 276 /**
 277  * tipc_bclink_acknowledge - handle acknowledgement of broadcast packets
 278  * @n_ptr: node that sent acknowledgement info
 279  * @acked: broadcast sequence # that has been acknowledged
 280  *
 281  * Node is locked, bclink_lock unlocked.
 282  */
 283 void tipc_bclink_acknowledge(struct tipc_node *n_ptr, u32 acked)
 284 {
 285         struct sk_buff *skb, *tmp;
 286         unsigned int released = 0;
 287         struct net *net = n_ptr->net;
 288         struct tipc_net *tn = net_generic(net, tipc_net_id);
 289
 290         if (unlikely(!n_ptr->bclink.recv_permitted))
 291                 return;
 292
 293         tipc_bclink_lock(net);
 294
 295         /* Bail out if tx queue is empty (no clean up is required) */
 296         skb = skb_peek(&tn->bcl->transmq);
 297         if (!skb)
 298                 goto exit;
 299
 300         /* Determine which messages need to be acknowledged */
 301         if (acked == INVALID_LINK_SEQ) {
 302                 /*
 303                  * Contact with specified node has been lost, so need to
 304                  * acknowledge sent messages only (if other nodes still exist)
 305                  * or both sent and unsent messages (otherwise)
 306                  */
 307                 if (tn->bcbase->bcast_nodes.count)
 308                         acked = tn->bcl->silent_intv_cnt;
 309                 else
 310                         acked = tn->bcl->snd_nxt;
 311         } else {
 312                 /*
 313                  * Bail out if specified sequence number does not correspond
 314                  * to a message that has been sent and not yet acknowledged
 315                  */
 316                 if (less(acked, buf_seqno(skb)) ||
 317                     less(tn->bcl->silent_intv_cnt, acked) ||
 318                     less_eq(acked, n_ptr->bclink.acked))
 319                         goto exit;
 320         }
 321
 322         /* Skip over packets that node has previously acknowledged */
 323         skb_queue_walk(&tn->bcl->transmq, skb) {
 324                 if (more(buf_seqno(skb), n_ptr->bclink.acked))
 325                         break;
 326         }
 327
 328         /* Update packets that node is now acknowledging */
 329         skb_queue_walk_from_safe(&tn->bcl->transmq, skb, tmp) {
 330                 if (more(buf_seqno(skb), acked))
 331                         break;
 332                 bcbuf_decr_acks(skb);
 333                 bclink_set_last_sent(net);
 334                 if (bcbuf_acks(skb) == 0) {
 335                         __skb_unlink(skb, &tn->bcl->transmq);
 336                         kfree_skb(skb);
 337                         released = 1;
 338                 }
 339         }
 340         n_ptr->bclink.acked = acked;
 341
 342         /* Try resolving broadcast link congestion, if necessary */
 343         if (unlikely(skb_peek(&tn->bcl->backlogq))) {
 344                 tipc_link_push_packets(tn->bcl);
 345                 bclink_set_last_sent(net);
 346         }
 347         if (unlikely(released && !skb_queue_empty(&tn->bcl->wakeupq)))
 348                 n_ptr->action_flags |= TIPC_WAKEUP_BCAST_USERS;
 349 exit:
 350         tipc_bclink_unlock(net);
 351 }
 352
 353 /**
 354  * tipc_bclink_update_link_state - update broadcast link state
 355  *
 356  * RCU and node lock set
 357  */
 358 void tipc_bclink_update_link_state(struct tipc_node *n_ptr,
 359                                    u32 last_sent)
 360 {
 361         struct sk_buff *buf;
 362         struct net *net = n_ptr->net;
 363         struct tipc_net *tn = net_generic(net, tipc_net_id);
 364
 365         /* Ignore "stale" link state info */
 366         if (less_eq(last_sent, n_ptr->bclink.last_in))
 367                 return;
 368
 369         /* Update link synchronization state; quit if in sync */
 370         bclink_update_last_sent(n_ptr, last_sent);
 371
 372         if (n_ptr->bclink.last_sent == n_ptr->bclink.last_in)
 373                 return;
 374
 375         /* Update out-of-sync state; quit if loss is still unconfirmed */
 376         if ((++n_ptr->bclink.oos_state) == 1) {
 377                 if (n_ptr->bclink.deferred_size < (TIPC_MIN_LINK_WIN / 2))
 378                         return;
 379                 n_ptr->bclink.oos_state++;
 380         }
 381
 382         /* Don't NACK if one has been recently sent (or seen) */
 383         if (n_ptr->bclink.oos_state & 0x1)
 384                 return;
 385
 386         /* Send NACK */
 387         buf = tipc_buf_acquire(INT_H_SIZE);
 388         if (buf) {
 389                 struct tipc_msg *msg = buf_msg(buf);
 390                 struct sk_buff *skb = skb_peek(&n_ptr->bclink.deferdq);
 391                 u32 to = skb ? buf_seqno(skb) - 1 : n_ptr->bclink.last_sent;
 392
 393                 tipc_msg_init(tn->own_addr, msg, BCAST_PROTOCOL, STATE_MSG,
 394                               INT_H_SIZE, n_ptr->addr);
 395                 msg_set_non_seq(msg, 1);
 396                 msg_set_mc_netid(msg, tn->net_id);
 397                 msg_set_bcast_ack(msg, n_ptr->bclink.last_in);
 398                 msg_set_bcgap_after(msg, n_ptr->bclink.last_in);
 399                 msg_set_bcgap_to(msg, to);
 400
 401                 tipc_bclink_lock(net);
 402                 tipc_bearer_send(net, MAX_BEARERS, buf, NULL);
 403                 tn->bcl->stats.sent_nacks++;
 404                 tipc_bclink_unlock(net);
 405                 kfree_skb(buf);
 406
 407                 n_ptr->bclink.oos_state++;
 408         }
 409 }
 410
 411 void tipc_bclink_sync_state(struct tipc_node *n, struct tipc_msg *hdr)
 412 {
 413         u16 last = msg_last_bcast(hdr);
 414         int mtyp = msg_type(hdr);
 415
 416         if (unlikely(msg_user(hdr) != LINK_PROTOCOL))
 417                 return;
 418         if (mtyp == STATE_MSG) {
 419                 tipc_bclink_update_link_state(n, last);
 420                 return;
 421         }
 422         /* Compatibility: older nodes don't know BCAST_PROTOCOL synchronization,
 423          * and transfer synch info in LINK_PROTOCOL messages.
 424          */
 425         if (tipc_node_is_up(n))
 426                 return;
 427         if ((mtyp != RESET_MSG) && (mtyp != ACTIVATE_MSG))
 428                 return;
 429         n->bclink.last_sent = last;
 430         n->bclink.last_in = last;
 431         n->bclink.oos_state = 0;
 432 }
 433
 434 /**
 435  * bclink_peek_nack - monitor retransmission requests sent by other nodes
 436  *
 437  * Delay any upcoming NACK by this node if another node has already
 438  * requested the first message this node is going to ask for.
 439  */
 440 static void bclink_peek_nack(struct net *net, struct tipc_msg *msg)
 441 {
 442         struct tipc_node *n_ptr = tipc_node_find(net, msg_destnode(msg));
 443
 444         if (unlikely(!n_ptr))
 445                 return;
 446
 447         tipc_node_lock(n_ptr);
 448         if (n_ptr->bclink.recv_permitted &&
 449             (n_ptr->bclink.last_in != n_ptr->bclink.last_sent) &&
 450             (n_ptr->bclink.last_in == msg_bcgap_after(msg)))
 451                 n_ptr->bclink.oos_state = 2;
 452         tipc_node_unlock(n_ptr);
 453         tipc_node_put(n_ptr);
 454 }
 455
 456 /* tipc_bcast_xmit - deliver buffer chain to all nodes in cluster
 457  *                    and to identified node local sockets
 458  * @net: the applicable net namespace
 459  * @list: chain of buffers containing message
 460  * Consumes the buffer chain, except when returning -ELINKCONG
 461  * Returns 0 if success, otherwise errno: -ELINKCONG,-EHOSTUNREACH,-EMSGSIZE
 462  */
 463 int tipc_bcast_xmit(struct net *net, struct sk_buff_head *list)
 464 {
 465         struct tipc_net *tn = net_generic(net, tipc_net_id);
 466         struct tipc_link *bcl = tn->bcl;
 467         struct tipc_bc_base *bclink = tn->bcbase;
 468         int rc = 0;
 469         int bc = 0;
 470         struct sk_buff *skb;
 471         struct sk_buff_head arrvq;
 472         struct sk_buff_head inputq;
 473
 474         /* Prepare clone of message for local node */
 475         skb = tipc_msg_reassemble(list);
 476         if (unlikely(!skb))
 477                 return -EHOSTUNREACH;
 478
 479         /* Broadcast to all nodes */
 480         if (likely(bclink)) {
 481                 tipc_bclink_lock(net);
 482                 if (likely(bclink->bcast_nodes.count)) {
 483                         rc = __tipc_link_xmit(net, bcl, list);
 484                         if (likely(!rc)) {
 485                                 u32 len = skb_queue_len(&bcl->transmq);
 486
 487                                 bclink_set_last_sent(net);
 488                                 bcl->stats.queue_sz_counts++;
 489                                 bcl->stats.accu_queue_sz += len;
 490                         }
 491                         bc = 1;
 492                 }
 493                 tipc_bclink_unlock(net);
 494         }
 495
 496         if (unlikely(!bc))
 497                 __skb_queue_purge(list);
 498
 499         if (unlikely(rc)) {
 500                 kfree_skb(skb);
 501                 return rc;
 502         }
 503         /* Deliver message clone */
 504         __skb_queue_head_init(&arrvq);
 505         skb_queue_head_init(&inputq);
 506         __skb_queue_tail(&arrvq, skb);
 507         tipc_sk_mcast_rcv(net, &arrvq, &inputq);
 508         return rc;
 509 }
 510
 511 /**
 512  * bclink_accept_pkt - accept an incoming, in-sequence broadcast packet
 513  *
 514  * Called with both sending node's lock and bclink_lock taken.
 515  */
 516 static void bclink_accept_pkt(struct tipc_node *node, u32 seqno)
 517 {
 518         struct tipc_net *tn = net_generic(node->net, tipc_net_id);
 519
 520         bclink_update_last_sent(node, seqno);
 521         node->bclink.last_in = seqno;
 522         node->bclink.oos_state = 0;
 523         tn->bcl->stats.recv_info++;
 524
 525         /*
 526          * Unicast an ACK periodically, ensuring that
 527          * all nodes in the cluster don't ACK at the same time
 528          */
 529         if (((seqno - tn->own_addr) % TIPC_MIN_LINK_WIN) == 0) {
 530                 tipc_link_proto_xmit(node_active_link(node, node->addr),
 531                                      STATE_MSG, 0, 0, 0, 0);
 532                 tn->bcl->stats.sent_acks++;
 533         }
 534 }
 535
 536 /**
 537  * tipc_bclink_rcv - receive a broadcast packet, and deliver upwards
 538  *
 539  * RCU is locked, no other locks set
 540  */
 541 void tipc_bclink_rcv(struct net *net, struct sk_buff *buf)
 542 {
 543         struct tipc_net *tn = net_generic(net, tipc_net_id);
 544         struct tipc_link *bcl = tn->bcl;
 545         struct tipc_msg *msg = buf_msg(buf);
 546         struct tipc_node *node;
 547         u32 next_in;
 548         u32 seqno;
 549         int deferred = 0;
 550         int pos = 0;
 551         struct sk_buff *iskb;
 552         struct sk_buff_head *arrvq, *inputq;
 553
 554         /* Screen out unwanted broadcast messages */
 555         if (msg_mc_netid(msg) != tn->net_id)
 556                 goto exit;
 557
 558         node = tipc_node_find(net, msg_prevnode(msg));
 559         if (unlikely(!node))
 560                 goto exit;
 561
 562         tipc_node_lock(node);
 563         if (unlikely(!node->bclink.recv_permitted))
 564                 goto unlock;
 565
 566         /* Handle broadcast protocol message */
 567         if (unlikely(msg_user(msg) == BCAST_PROTOCOL)) {
 568                 if (msg_type(msg) != STATE_MSG)
 569                         goto unlock;
 570                 if (msg_destnode(msg) == tn->own_addr) {
 571                         tipc_bclink_acknowledge(node, msg_bcast_ack(msg));
 572                         tipc_bclink_lock(net);
 573                         bcl->stats.recv_nacks++;
 574                         tn->bcbase->retransmit_to = node;
 575                         bclink_retransmit_pkt(tn, msg_bcgap_after(msg),
 576                                               msg_bcgap_to(msg));
 577                         tipc_bclink_unlock(net);
 578                         tipc_node_unlock(node);
 579                 } else {
 580                         tipc_node_unlock(node);
 581                         bclink_peek_nack(net, msg);
 582                 }
 583                 tipc_node_put(node);
 584                 goto exit;
 585         }
 586
 587         /* Handle in-sequence broadcast message */
 588         seqno = msg_seqno(msg);
 589         next_in = mod(node->bclink.last_in + 1);
 590         arrvq = &tn->bcbase->arrvq;
 591         inputq = &tn->bcbase->inputq;
 592
 593         if (likely(seqno == next_in)) {
 594 receive:
 595                 /* Deliver message to destination */
 596                 if (likely(msg_isdata(msg))) {
 597                         tipc_bclink_lock(net);
 598                         bclink_accept_pkt(node, seqno);
 599                         spin_lock_bh(&inputq->lock);
 600                         __skb_queue_tail(arrvq, buf);
 601                         spin_unlock_bh(&inputq->lock);
 602                         node->action_flags |= TIPC_BCAST_MSG_EVT;
 603                         tipc_bclink_unlock(net);
 604                         tipc_node_unlock(node);
 605                 } else if (msg_user(msg) == MSG_BUNDLER) {
 606                         tipc_bclink_lock(net);
 607                         bclink_accept_pkt(node, seqno);
 608                         bcl->stats.recv_bundles++;
 609                         bcl->stats.recv_bundled += msg_msgcnt(msg);
 610                         pos = 0;
 611                         while (tipc_msg_extract(buf, &iskb, &pos)) {
 612                                 spin_lock_bh(&inputq->lock);
 613                                 __skb_queue_tail(arrvq, iskb);
 614                                 spin_unlock_bh(&inputq->lock);
 615                         }
 616                         node->action_flags |= TIPC_BCAST_MSG_EVT;
 617                         tipc_bclink_unlock(net);
 618                         tipc_node_unlock(node);
 619                 } else if (msg_user(msg) == MSG_FRAGMENTER) {
 620                         tipc_bclink_lock(net);
 621                         bclink_accept_pkt(node, seqno);
 622                         tipc_buf_append(&node->bclink.reasm_buf, &buf);
 623                         if (unlikely(!buf && !node->bclink.reasm_buf)) {
 624                                 tipc_bclink_unlock(net);
 625                                 goto unlock;
 626                         }
 627                         bcl->stats.recv_fragments++;
 628                         if (buf) {
 629                                 bcl->stats.recv_fragmented++;
 630                                 msg = buf_msg(buf);
 631                                 tipc_bclink_unlock(net);
 632                                 goto receive;
 633                         }
 634                         tipc_bclink_unlock(net);
 635                         tipc_node_unlock(node);
 636                 } else {
 637                         tipc_bclink_lock(net);
 638                         bclink_accept_pkt(node, seqno);
 639                         tipc_bclink_unlock(net);
 640                         tipc_node_unlock(node);
 641                         kfree_skb(buf);
 642                 }
 643                 buf = NULL;
 644
 645                 /* Determine new synchronization state */
 646                 tipc_node_lock(node);
 647                 if (unlikely(!tipc_node_is_up(node)))
 648                         goto unlock;
 649
 650                 if (node->bclink.last_in == node->bclink.last_sent)
 651                         goto unlock;
 652
 653                 if (skb_queue_empty(&node->bclink.deferdq)) {
 654                         node->bclink.oos_state = 1;
 655                         goto unlock;
 656                 }
 657
 658                 msg = buf_msg(skb_peek(&node->bclink.deferdq));
 659                 seqno = msg_seqno(msg);
 660                 next_in = mod(next_in + 1);
 661                 if (seqno != next_in)
 662                         goto unlock;
 663
 664                 /* Take in-sequence message from deferred queue & deliver it */
 665                 buf = __skb_dequeue(&node->bclink.deferdq);
 666                 goto receive;
 667         }
 668
 669         /* Handle out-of-sequence broadcast message */
 670         if (less(next_in, seqno)) {
 671                 deferred = tipc_link_defer_pkt(&node->bclink.deferdq,
 672                                                buf);
 673                 bclink_update_last_sent(node, seqno);
 674                 buf = NULL;
 675         }
 676
 677         tipc_bclink_lock(net);
 678
 679         if (deferred)
 680                 bcl->stats.deferred_recv++;
 681         else
 682                 bcl->stats.duplicates++;
 683
 684         tipc_bclink_unlock(net);
 685
 686 unlock:
 687         tipc_node_unlock(node);
 688         tipc_node_put(node);
 689 exit:
 690         kfree_skb(buf);
 691 }
 692
 693 u32 tipc_bclink_acks_missing(struct tipc_node *n_ptr)
 694 {
 695         return (n_ptr->bclink.recv_permitted &&
 696                 (tipc_bclink_get_last_sent(n_ptr->net) != n_ptr->bclink.acked));
 697 }
 698
 699
 700 /**
 701  * tipc_bcbearer_send - send a packet through the broadcast pseudo-bearer
 702  *
 703  * Send packet over as many bearers as necessary to reach all nodes
 704  * that have joined the broadcast link.
 705  *
 706  * Returns 0 (packet sent successfully) under all circumstances,
 707  * since the broadcast link's pseudo-bearer never blocks
 708  */
 709 static int tipc_bcbearer_send(struct net *net, struct sk_buff *buf,
 710                               struct tipc_bearer *unused1,
 711                               struct tipc_media_addr *unused2)
 712 {
 713         int bp_index;
 714         struct tipc_msg *msg = buf_msg(buf);
 715         struct tipc_net *tn = net_generic(net, tipc_net_id);
 716         struct tipc_bcbearer *bcbearer = tn->bcbearer;
 717         struct tipc_bc_base *bclink = tn->bcbase;
 718
 719         /* Prepare broadcast link message for reliable transmission,
 720          * if first time trying to send it;
 721          * preparation is skipped for broadcast link protocol messages
 722          * since they are sent in an unreliable manner and don't need it
 723          */
 724         if (likely(!msg_non_seq(buf_msg(buf)))) {
 725                 bcbuf_set_acks(buf, bclink->bcast_nodes.count);
 726                 msg_set_non_seq(msg, 1);
 727                 msg_set_mc_netid(msg, tn->net_id);
 728                 tn->bcl->stats.sent_info++;
 729                 if (WARN_ON(!bclink->bcast_nodes.count)) {
 730                         dump_stack();
 731                         return 0;
 732                 }
 733         }
 734
 735         /* Send buffer over bearers until all targets reached */
 736         bcbearer->remains = bclink->bcast_nodes;
 737
 738         for (bp_index = 0; bp_index < MAX_BEARERS; bp_index++) {
 739                 struct tipc_bearer *p = bcbearer->bpairs[bp_index].primary;
 740                 struct tipc_bearer *s = bcbearer->bpairs[bp_index].secondary;
 741                 struct tipc_bearer *bp[2] = {p, s};
 742                 struct tipc_bearer *b = bp[msg_link_selector(msg)];
 743                 struct sk_buff *tbuf;
 744
 745                 if (!p)
 746                         break; /* No more bearers to try */
 747                 if (!b)
 748                         b = p;
 749                 tipc_nmap_diff(&bcbearer->remains, &b->nodes,
 750                                &bcbearer->remains_new);
 751                 if (bcbearer->remains_new.count == bcbearer->remains.count)
 752                         continue; /* Nothing added by bearer pair */
 753
 754                 if (bp_index == 0) {
 755                         /* Use original buffer for first bearer */
 756                         tipc_bearer_send(net, b->identity, buf, &b->bcast_addr);
 757                 } else {
 758                         /* Avoid concurrent buffer access */
 759                         tbuf = pskb_copy_for_clone(buf, GFP_ATOMIC);
 760                         if (!tbuf)
 761                                 break;
 762                         tipc_bearer_send(net, b->identity, tbuf,
 763                                          &b->bcast_addr);
 764                         kfree_skb(tbuf); /* Bearer keeps a clone */
 765                 }
 766                 if (bcbearer->remains_new.count == 0)
 767                         break; /* All targets reached */
 768
 769                 bcbearer->remains = bcbearer->remains_new;
 770         }
 771
 772         return 0;
 773 }
 774
 775 /**
 776  * tipc_bcbearer_sort - create sets of bearer pairs used by broadcast bearer
 777  */
 778 void tipc_bcbearer_sort(struct net *net, struct tipc_node_map *nm_ptr,
 779                         u32 node, bool action)
 780 {
 781         struct tipc_net *tn = net_generic(net, tipc_net_id);
 782         struct tipc_bcbearer *bcbearer = tn->bcbearer;
 783         struct tipc_bcbearer_pair *bp_temp = bcbearer->bpairs_temp;
 784         struct tipc_bcbearer_pair *bp_curr;
 785         struct tipc_bearer *b;
 786         int b_index;
 787         int pri;
 788
 789         tipc_bclink_lock(net);
 790
 791         if (action)
 792                 tipc_nmap_add(nm_ptr, node);
 793         else
 794                 tipc_nmap_remove(nm_ptr, node);
 795
 796         /* Group bearers by priority (can assume max of two per priority) */
 797         memset(bp_temp, 0, sizeof(bcbearer->bpairs_temp));
 798
 799         rcu_read_lock();
 800         for (b_index = 0; b_index < MAX_BEARERS; b_index++) {
 801                 b = rcu_dereference_rtnl(tn->bearer_list[b_index]);
 802                 if (!b || !b->nodes.count)
 803                         continue;
 804
 805                 if (!bp_temp[b->priority].primary)
 806                         bp_temp[b->priority].primary = b;
 807                 else
 808                         bp_temp[b->priority].secondary = b;
 809         }
 810         rcu_read_unlock();
 811
 812         /* Create array of bearer pairs for broadcasting */
 813         bp_curr = bcbearer->bpairs;
 814         memset(bcbearer->bpairs, 0, sizeof(bcbearer->bpairs));
 815
 816         for (pri = TIPC_MAX_LINK_PRI; pri >= 0; pri--) {
 817
 818                 if (!bp_temp[pri].primary)
 819                         continue;
 820
 821                 bp_curr->primary = bp_temp[pri].primary;
 822
 823                 if (bp_temp[pri].secondary) {
 824                         if (tipc_nmap_equal(&bp_temp[pri].primary->nodes,
 825                                             &bp_temp[pri].secondary->nodes)) {
 826                                 bp_curr->secondary = bp_temp[pri].secondary;
 827                         } else {
 828                                 bp_curr++;
 829                                 bp_curr->primary = bp_temp[pri].secondary;
 830                         }
 831                 }
 832
 833                 bp_curr++;
 834         }
 835
 836         tipc_bclink_unlock(net);
 837 }
 838
 839 static int __tipc_nl_add_bc_link_stat(struct sk_buff *skb,
 840                                       struct tipc_stats *stats)
 841 {
 842         int i;
 843         struct nlattr *nest;
 844
 845         struct nla_map {
 846                 __u32 key;
 847                 __u32 val;
 848         };
 849
 850         struct nla_map map[] = {
 851                 {TIPC_NLA_STATS_RX_INFO, stats->recv_info},
 852                 {TIPC_NLA_STATS_RX_FRAGMENTS, stats->recv_fragments},
 853                 {TIPC_NLA_STATS_RX_FRAGMENTED, stats->recv_fragmented},
 854                 {TIPC_NLA_STATS_RX_BUNDLES, stats->recv_bundles},
 855                 {TIPC_NLA_STATS_RX_BUNDLED, stats->recv_bundled},
 856                 {TIPC_NLA_STATS_TX_INFO, stats->sent_info},
 857                 {TIPC_NLA_STATS_TX_FRAGMENTS, stats->sent_fragments},
 858                 {TIPC_NLA_STATS_TX_FRAGMENTED, stats->sent_fragmented},
 859                 {TIPC_NLA_STATS_TX_BUNDLES, stats->sent_bundles},
 860                 {TIPC_NLA_STATS_TX_BUNDLED, stats->sent_bundled},
 861                 {TIPC_NLA_STATS_RX_NACKS, stats->recv_nacks},
 862                 {TIPC_NLA_STATS_RX_DEFERRED, stats->deferred_recv},
 863                 {TIPC_NLA_STATS_TX_NACKS, stats->sent_nacks},
 864                 {TIPC_NLA_STATS_TX_ACKS, stats->sent_acks},
 865                 {TIPC_NLA_STATS_RETRANSMITTED, stats->retransmitted},
 866                 {TIPC_NLA_STATS_DUPLICATES, stats->duplicates},
 867                 {TIPC_NLA_STATS_LINK_CONGS, stats->link_congs},
 868                 {TIPC_NLA_STATS_MAX_QUEUE, stats->max_queue_sz},
 869                 {TIPC_NLA_STATS_AVG_QUEUE, stats->queue_sz_counts ?
 870                         (stats->accu_queue_sz / stats->queue_sz_counts) : 0}
 871         };
 872
 873         nest = nla_nest_start(skb, TIPC_NLA_LINK_STATS);
 874         if (!nest)
 875                 return -EMSGSIZE;
 876
 877         for (i = 0; i <  ARRAY_SIZE(map); i++)
 878                 if (nla_put_u32(skb, map[i].key, map[i].val))
 879                         goto msg_full;
 880
 881         nla_nest_end(skb, nest);
 882
 883         return 0;
 884 msg_full:
 885         nla_nest_cancel(skb, nest);
 886
 887         return -EMSGSIZE;
 888 }
 889
 890 int tipc_nl_add_bc_link(struct net *net, struct tipc_nl_msg *msg)
 891 {
 892         int err;
 893         void *hdr;
 894         struct nlattr *attrs;
 895         struct nlattr *prop;
 896         struct tipc_net *tn = net_generic(net, tipc_net_id);
 897         struct tipc_link *bcl = tn->bcl;
 898
 899         if (!bcl)
 900                 return 0;
 901
 902         tipc_bclink_lock(net);
 903
 904         hdr = genlmsg_put(msg->skb, msg->portid, msg->seq, &tipc_genl_family,
 905                           NLM_F_MULTI, TIPC_NL_LINK_GET);
 906         if (!hdr)
 907                 return -EMSGSIZE;
 908
 909         attrs = nla_nest_start(msg->skb, TIPC_NLA_LINK);
 910         if (!attrs)
 911                 goto msg_full;
 912
 913         /* The broadcast link is always up */
 914         if (nla_put_flag(msg->skb, TIPC_NLA_LINK_UP))
 915                 goto attr_msg_full;
 916
 917         if (nla_put_flag(msg->skb, TIPC_NLA_LINK_BROADCAST))
 918                 goto attr_msg_full;
 919         if (nla_put_string(msg->skb, TIPC_NLA_LINK_NAME, bcl->name))
 920                 goto attr_msg_full;
 921         if (nla_put_u32(msg->skb, TIPC_NLA_LINK_RX, bcl->rcv_nxt))
 922                 goto attr_msg_full;
 923         if (nla_put_u32(msg->skb, TIPC_NLA_LINK_TX, bcl->snd_nxt))
 924                 goto attr_msg_full;
 925
 926         prop = nla_nest_start(msg->skb, TIPC_NLA_LINK_PROP);
 927         if (!prop)
 928                 goto attr_msg_full;
 929         if (nla_put_u32(msg->skb, TIPC_NLA_PROP_WIN, bcl->window))
 930                 goto prop_msg_full;
 931         nla_nest_end(msg->skb, prop);
 932
 933         err = __tipc_nl_add_bc_link_stat(msg->skb, &bcl->stats);
 934         if (err)
 935                 goto attr_msg_full;
 936
 937         tipc_bclink_unlock(net);
 938         nla_nest_end(msg->skb, attrs);
 939         genlmsg_end(msg->skb, hdr);
 940
 941         return 0;
 942
 943 prop_msg_full:
 944         nla_nest_cancel(msg->skb, prop);
 945 attr_msg_full:
 946         nla_nest_cancel(msg->skb, attrs);
 947 msg_full:
 948         tipc_bclink_unlock(net);
 949         genlmsg_cancel(msg->skb, hdr);
 950
 951         return -EMSGSIZE;
 952 }
 953
 954 int tipc_bclink_reset_stats(struct net *net)
 955 {
 956         struct tipc_net *tn = net_generic(net, tipc_net_id);
 957         struct tipc_link *bcl = tn->bcl;
 958
 959         if (!bcl)
 960                 return -ENOPROTOOPT;
 961
 962         tipc_bclink_lock(net);
 963         memset(&bcl->stats, 0, sizeof(bcl->stats));
 964         tipc_bclink_unlock(net);
 965         return 0;
 966 }
 967
 968 int tipc_bclink_set_queue_limits(struct net *net, u32 limit)
 969 {
 970         struct tipc_net *tn = net_generic(net, tipc_net_id);
 971         struct tipc_link *bcl = tn->bcl;
 972
 973         if (!bcl)
 974                 return -ENOPROTOOPT;
 975         if (limit < BCLINK_WIN_MIN)
 976                 limit = BCLINK_WIN_MIN;
 977         if (limit > TIPC_MAX_LINK_WIN)
 978                 return -EINVAL;
 979         tipc_bclink_lock(net);
 980         tipc_link_set_queue_limits(bcl, limit);
 981         tipc_bclink_unlock(net);
 982         return 0;
 983 }
 984
 985 int tipc_nl_bc_link_set(struct net *net, struct nlattr *attrs[])
 986 {
 987         int err;
 988         u32 win;
 989         struct nlattr *props[TIPC_NLA_PROP_MAX + 1];
 990
 991         if (!attrs[TIPC_NLA_LINK_PROP])
 992                 return -EINVAL;
 993
 994         err = tipc_nl_parse_link_prop(attrs[TIPC_NLA_LINK_PROP], props);
 995         if (err)
 996                 return err;
 997
 998         if (!props[TIPC_NLA_PROP_WIN])
 999                 return -EOPNOTSUPP;
1000
1001         win = nla_get_u32(props[TIPC_NLA_PROP_WIN]);
1002
1003         return tipc_bclink_set_queue_limits(net, win);
1004 }
1005
1006 int tipc_bcast_init(struct net *net)
1007 {
1008         struct tipc_net *tn = net_generic(net, tipc_net_id);
1009         struct tipc_bcbearer *bcbearer;
1010         struct tipc_bc_base *bclink;
1011         struct tipc_link *bcl;
1012
1013         bcbearer = kzalloc(sizeof(*bcbearer), GFP_ATOMIC);
1014         if (!bcbearer)
1015                 return -ENOMEM;
1016
1017         bclink = kzalloc(sizeof(*bclink), GFP_ATOMIC);
1018         if (!bclink) {
1019                 kfree(bcbearer);
1020                 return -ENOMEM;
1021         }
1022
1023         bcl = &bclink->link;
1024         bcbearer->bearer.media = &bcbearer->media;
1025         bcbearer->media.send_msg = tipc_bcbearer_send;
1026         sprintf(bcbearer->media.name, "tipc-broadcast");
1027
1028         spin_lock_init(&tipc_net(net)->bclock);
1029         __skb_queue_head_init(&bcl->transmq);
1030         __skb_queue_head_init(&bcl->backlogq);
1031         __skb_queue_head_init(&bcl->deferdq);
1032         skb_queue_head_init(&bcl->wakeupq);
1033         bcl->snd_nxt = 1;
1034         spin_lock_init(&bclink->node.lock);
1035         __skb_queue_head_init(&bclink->arrvq);
1036         skb_queue_head_init(&bclink->inputq);
1037         bcl->owner = &bclink->node;
1038         bcl->owner->net = net;
1039         bcl->mtu = MAX_PKT_DEFAULT_MCAST;
1040         tipc_link_set_queue_limits(bcl, BCLINK_WIN_DEFAULT);
1041         bcl->bearer_id = MAX_BEARERS;
1042         rcu_assign_pointer(tn->bearer_list[MAX_BEARERS], &bcbearer->bearer);
1043         bcl->pmsg = (struct tipc_msg *)&bcl->proto_msg;
1044         msg_set_prevnode(bcl->pmsg, tn->own_addr);
1045         strlcpy(bcl->name, tipc_bclink_name, TIPC_MAX_LINK_NAME);
1046         tn->bcbearer = bcbearer;
1047         tn->bcbase = bclink;
1048         tn->bcl = bcl;
1049         return 0;
1050 }
1051
1052 void tipc_bcast_stop(struct net *net)
1053 {
1054         struct tipc_net *tn = net_generic(net, tipc_net_id);
1055
1056         tipc_bclink_lock(net);
1057         tipc_link_purge_queues(tn->bcl);
1058         tipc_bclink_unlock(net);
1059
1060         RCU_INIT_POINTER(tn->bearer_list[BCBEARER], NULL);
1061         synchronize_net();
1062         kfree(tn->bcbearer);
1063         kfree(tn->bcbase);
1064 }
1065
1066 /**
1067  * tipc_nmap_add - add a node to a node map
1068  */
1069 static void tipc_nmap_add(struct tipc_node_map *nm_ptr, u32 node)
1070 {
1071         int n = tipc_node(node);
1072         int w = n / WSIZE;
1073         u32 mask = (1 << (n % WSIZE));
1074
1075         if ((nm_ptr->map[w] & mask) == 0) {
1076                 nm_ptr->count++;
1077                 nm_ptr->map[w] |= mask;
1078         }
1079 }
1080
1081 /**
1082  * tipc_nmap_remove - remove a node from a node map
1083  */
1084 static void tipc_nmap_remove(struct tipc_node_map *nm_ptr, u32 node)
1085 {
1086         int n = tipc_node(node);
1087         int w = n / WSIZE;
1088         u32 mask = (1 << (n % WSIZE));
1089
1090         if ((nm_ptr->map[w] & mask) != 0) {
1091                 nm_ptr->map[w] &= ~mask;
1092                 nm_ptr->count--;
1093         }
1094 }
1095
1096 /**
1097  * tipc_nmap_diff - find differences between node maps
1098  * @nm_a: input node map A
1099  * @nm_b: input node map B
1100  * @nm_diff: output node map A-B (i.e. nodes of A that are not in B)
1101  */
1102 static void tipc_nmap_diff(struct tipc_node_map *nm_a,
1103                            struct tipc_node_map *nm_b,
1104                            struct tipc_node_map *nm_diff)
1105 {
1106         int stop = ARRAY_SIZE(nm_a->map);
1107         int w;
1108         int b;
1109         u32 map;
1110
1111         memset(nm_diff, 0, sizeof(*nm_diff));
1112         for (w = 0; w < stop; w++) {
1113                 map = nm_a->map[w] ^ (nm_a->map[w] & nm_b->map[w]);
1114                 nm_diff->map[w] = map;
1115                 if (map != 0) {
1116                         for (b = 0 ; b < WSIZE; b++) {
1117                                 if (map & (1 << b))
1118                                         nm_diff->count++;
1119                         }
1120                 }
1121         }
1122 }