net/tipc/bcast.c

   1 /*
   2  * net/tipc/bcast.c: TIPC broadcast code
   3  *
   4  * Copyright (c) 2004-2006, Ericsson AB
   5  * Copyright (c) 2004, Intel Corporation.
   6  * Copyright (c) 2005, 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 "core.h"
  39 #include "msg.h"
  40 #include "dbg.h"
  41 #include "link.h"
  42 #include "net.h"
  43 #include "node.h"
  44 #include "port.h"
  45 #include "addr.h"
  46 #include "node_subscr.h"
  47 #include "name_distr.h"
  48 #include "bearer.h"
  49 #include "name_table.h"
  50 #include "bcast.h"
  51
  52 #define MAX_PKT_DEFAULT_MCAST 1500      /* bcast link max packet size (fixed) */
  53
  54 #define BCLINK_WIN_DEFAULT 20           /* bcast link window size (default) */
  55
  56 #define BCLINK_LOG_BUF_SIZE 0
  57
  58 /*
  59  * Loss rate for incoming broadcast frames; used to test retransmission code.
  60  * Set to N to cause every N'th frame to be discarded; 0 => don't discard any.
  61  */
  62
  63 #define TIPC_BCAST_LOSS_RATE 0
  64
  65 /**
  66  * struct bcbearer_pair - a pair of bearers used by broadcast link
  67  * @primary: pointer to primary bearer
  68  * @secondary: pointer to secondary bearer
  69  *
  70  * Bearers must have same priority and same set of reachable destinations
  71  * to be paired.
  72  */
  73
  74 struct bcbearer_pair {
  75         struct bearer *primary;
  76         struct bearer *secondary;
  77 };
  78
  79 /**
  80  * struct bcbearer - bearer used by broadcast link
  81  * @bearer: (non-standard) broadcast bearer structure
  82  * @media: (non-standard) broadcast media structure
  83  * @bpairs: array of bearer pairs
  84  * @bpairs_temp: temporary array of bearer pairs used by tipc_bcbearer_sort()
  85  * @remains: temporary node map used by tipc_bcbearer_send()
  86  * @remains_new: temporary node map used tipc_bcbearer_send()
  87  *
  88  * Note: The fields labelled "temporary" are incorporated into the bearer
  89  * to avoid consuming potentially limited stack space through the use of
  90  * large local variables within multicast routines.  Concurrent access is
  91  * prevented through use of the spinlock "bc_lock".
  92  */
  93
  94 struct bcbearer {
  95         struct bearer bearer;
  96         struct media media;
  97         struct bcbearer_pair bpairs[MAX_BEARERS];
  98         struct bcbearer_pair bpairs_temp[TIPC_MAX_LINK_PRI + 1];
  99         struct tipc_node_map remains;
 100         struct tipc_node_map remains_new;
 101 };
 102
 103 /**
 104  * struct bclink - link used for broadcast messages
 105  * @link: (non-standard) broadcast link structure
 106  * @node: (non-standard) node structure representing b'cast link's peer node
 107  *
 108  * Handles sequence numbering, fragmentation, bundling, etc.
 109  */
 110
 111 struct bclink {
 112         struct link link;
 113         struct tipc_node node;
 114 };
 115
 116
 117 static struct bcbearer *bcbearer = NULL;
 118 static struct bclink *bclink = NULL;
 119 static struct link *bcl = NULL;
 120 static DEFINE_SPINLOCK(bc_lock);
 121
 122 const char tipc_bclink_name[] = "broadcast-link";
 123
 124
 125 static u32 buf_seqno(struct sk_buff *buf)
 126 {
 127         return msg_seqno(buf_msg(buf));
 128 }
 129
 130 static u32 bcbuf_acks(struct sk_buff *buf)
 131 {
 132         return (u32)(unsigned long)TIPC_SKB_CB(buf)->handle;
 133 }
 134
 135 static void bcbuf_set_acks(struct sk_buff *buf, u32 acks)
 136 {
 137         TIPC_SKB_CB(buf)->handle = (void *)(unsigned long)acks;
 138 }
 139
 140 static void bcbuf_decr_acks(struct sk_buff *buf)
 141 {
 142         bcbuf_set_acks(buf, bcbuf_acks(buf) - 1);
 143 }
 144
 145
 146 static void bclink_set_last_sent(void)
 147 {
 148         if (bcl->next_out)
 149                 bcl->fsm_msg_cnt = mod(buf_seqno(bcl->next_out) - 1);
 150         else
 151                 bcl->fsm_msg_cnt = mod(bcl->next_out_no - 1);
 152 }
 153
 154 u32 tipc_bclink_get_last_sent(void)
 155 {
 156         return bcl->fsm_msg_cnt;
 157 }
 158
 159 /**
 160  * bclink_set_gap - set gap according to contents of current deferred pkt queue
 161  *
 162  * Called with 'node' locked, bc_lock unlocked
 163  */
 164
 165 static void bclink_set_gap(struct tipc_node *n_ptr)
 166 {
 167         struct sk_buff *buf = n_ptr->bclink.deferred_head;
 168
 169         n_ptr->bclink.gap_after = n_ptr->bclink.gap_to =
 170                 mod(n_ptr->bclink.last_in);
 171         if (unlikely(buf != NULL))
 172                 n_ptr->bclink.gap_to = mod(buf_seqno(buf) - 1);
 173 }
 174
 175 /**
 176  * bclink_ack_allowed - test if ACK or NACK message can be sent at this moment
 177  *
 178  * This mechanism endeavours to prevent all nodes in network from trying
 179  * to ACK or NACK at the same time.
 180  *
 181  * Note: TIPC uses a different trigger to distribute ACKs than it does to
 182  *       distribute NACKs, but tries to use the same spacing (divide by 16).
 183  */
 184
 185 static int bclink_ack_allowed(u32 n)
 186 {
 187         return((n % TIPC_MIN_LINK_WIN) == tipc_own_tag);
 188 }
 189
 190
 191 /**
 192  * bclink_retransmit_pkt - retransmit broadcast packets
 193  * @after: sequence number of last packet to *not* retransmit
 194  * @to: sequence number of last packet to retransmit
 195  *
 196  * Called with bc_lock locked
 197  */
 198
 199 static void bclink_retransmit_pkt(u32 after, u32 to)
 200 {
 201         struct sk_buff *buf;
 202
 203         buf = bcl->first_out;
 204         while (buf && less_eq(buf_seqno(buf), after)) {
 205                 buf = buf->next;
 206         }
 207         tipc_link_retransmit(bcl, buf, mod(to - after));
 208 }
 209
 210 /**
 211  * tipc_bclink_acknowledge - handle acknowledgement of broadcast packets
 212  * @n_ptr: node that sent acknowledgement info
 213  * @acked: broadcast sequence # that has been acknowledged
 214  *
 215  * Node is locked, bc_lock unlocked.
 216  */
 217
 218 void tipc_bclink_acknowledge(struct tipc_node *n_ptr, u32 acked)
 219 {
 220         struct sk_buff *crs;
 221         struct sk_buff *next;
 222         unsigned int released = 0;
 223
 224         if (less_eq(acked, n_ptr->bclink.acked))
 225                 return;
 226
 227         spin_lock_bh(&bc_lock);
 228
 229         /* Skip over packets that node has previously acknowledged */
 230
 231         crs = bcl->first_out;
 232         while (crs && less_eq(buf_seqno(crs), n_ptr->bclink.acked)) {
 233                 crs = crs->next;
 234         }
 235
 236         /* Update packets that node is now acknowledging */
 237
 238         while (crs && less_eq(buf_seqno(crs), acked)) {
 239                 next = crs->next;
 240                 bcbuf_decr_acks(crs);
 241                 if (bcbuf_acks(crs) == 0) {
 242                         bcl->first_out = next;
 243                         bcl->out_queue_size--;
 244                         buf_discard(crs);
 245                         released = 1;
 246                 }
 247                 crs = next;
 248         }
 249         n_ptr->bclink.acked = acked;
 250
 251         /* Try resolving broadcast link congestion, if necessary */
 252
 253         if (unlikely(bcl->next_out)) {
 254                 tipc_link_push_queue(bcl);
 255                 bclink_set_last_sent();
 256         }
 257         if (unlikely(released && !list_empty(&bcl->waiting_ports)))
 258                 tipc_link_wakeup_ports(bcl, 0);
 259         spin_unlock_bh(&bc_lock);
 260 }
 261
 262 /**
 263  * bclink_send_ack - unicast an ACK msg
 264  *
 265  * tipc_net_lock and node lock set
 266  */
 267
 268 static void bclink_send_ack(struct tipc_node *n_ptr)
 269 {
 270         struct link *l_ptr = n_ptr->active_links[n_ptr->addr & 1];
 271
 272         if (l_ptr != NULL)
 273                 tipc_link_send_proto_msg(l_ptr, STATE_MSG, 0, 0, 0, 0, 0);
 274 }
 275
 276 /**
 277  * bclink_send_nack- broadcast a NACK msg
 278  *
 279  * tipc_net_lock and node lock set
 280  */
 281
 282 static void bclink_send_nack(struct tipc_node *n_ptr)
 283 {
 284         struct sk_buff *buf;
 285         struct tipc_msg *msg;
 286
 287         if (!less(n_ptr->bclink.gap_after, n_ptr->bclink.gap_to))
 288                 return;
 289
 290         buf = buf_acquire(INT_H_SIZE);
 291         if (buf) {
 292                 msg = buf_msg(buf);
 293                 tipc_msg_init(msg, BCAST_PROTOCOL, STATE_MSG,
 294                          INT_H_SIZE, n_ptr->addr);
 295                 msg_set_mc_netid(msg, tipc_net_id);
 296                 msg_set_bcast_ack(msg, mod(n_ptr->bclink.last_in));
 297                 msg_set_bcgap_after(msg, n_ptr->bclink.gap_after);
 298                 msg_set_bcgap_to(msg, n_ptr->bclink.gap_to);
 299                 msg_set_bcast_tag(msg, tipc_own_tag);
 300
 301                 if (tipc_bearer_send(&bcbearer->bearer, buf, NULL)) {
 302                         bcl->stats.sent_nacks++;
 303                         buf_discard(buf);
 304                 } else {
 305                         tipc_bearer_schedule(bcl->b_ptr, bcl);
 306                         bcl->proto_msg_queue = buf;
 307                         bcl->stats.bearer_congs++;
 308                 }
 309
 310                 /*
 311                  * Ensure we doesn't send another NACK msg to the node
 312                  * until 16 more deferred messages arrive from it
 313                  * (i.e. helps prevent all nodes from NACK'ing at same time)
 314                  */
 315
 316                 n_ptr->bclink.nack_sync = tipc_own_tag;
 317         }
 318 }
 319
 320 /**
 321  * tipc_bclink_check_gap - send a NACK if a sequence gap exists
 322  *
 323  * tipc_net_lock and node lock set
 324  */
 325
 326 void tipc_bclink_check_gap(struct tipc_node *n_ptr, u32 last_sent)
 327 {
 328         if (!n_ptr->bclink.supported ||
 329             less_eq(last_sent, mod(n_ptr->bclink.last_in)))
 330                 return;
 331
 332         bclink_set_gap(n_ptr);
 333         if (n_ptr->bclink.gap_after == n_ptr->bclink.gap_to)
 334                 n_ptr->bclink.gap_to = last_sent;
 335         bclink_send_nack(n_ptr);
 336 }
 337
 338 /**
 339  * tipc_bclink_peek_nack - process a NACK msg meant for another node
 340  *
 341  * Only tipc_net_lock set.
 342  */
 343
 344 static void tipc_bclink_peek_nack(u32 dest, u32 sender_tag, u32 gap_after, u32 gap_to)
 345 {
 346         struct tipc_node *n_ptr = tipc_node_find(dest);
 347         u32 my_after, my_to;
 348
 349         if (unlikely(!n_ptr || !tipc_node_is_up(n_ptr)))
 350                 return;
 351         tipc_node_lock(n_ptr);
 352         /*
 353          * Modify gap to suppress unnecessary NACKs from this node
 354          */
 355         my_after = n_ptr->bclink.gap_after;
 356         my_to = n_ptr->bclink.gap_to;
 357
 358         if (less_eq(gap_after, my_after)) {
 359                 if (less(my_after, gap_to) && less(gap_to, my_to))
 360                         n_ptr->bclink.gap_after = gap_to;
 361                 else if (less_eq(my_to, gap_to))
 362                         n_ptr->bclink.gap_to = n_ptr->bclink.gap_after;
 363         } else if (less_eq(gap_after, my_to)) {
 364                 if (less_eq(my_to, gap_to))
 365                         n_ptr->bclink.gap_to = gap_after;
 366         } else {
 367                 /*
 368                  * Expand gap if missing bufs not in deferred queue:
 369                  */
 370                 struct sk_buff *buf = n_ptr->bclink.deferred_head;
 371                 u32 prev = n_ptr->bclink.gap_to;
 372
 373                 for (; buf; buf = buf->next) {
 374                         u32 seqno = buf_seqno(buf);
 375
 376                         if (mod(seqno - prev) != 1) {
 377                                 buf = NULL;
 378                                 break;
 379                         }
 380                         if (seqno == gap_after)
 381                                 break;
 382                         prev = seqno;
 383                 }
 384                 if (buf == NULL)
 385                         n_ptr->bclink.gap_to = gap_after;
 386         }
 387         /*
 388          * Some nodes may send a complementary NACK now:
 389          */
 390         if (bclink_ack_allowed(sender_tag + 1)) {
 391                 if (n_ptr->bclink.gap_to != n_ptr->bclink.gap_after) {
 392                         bclink_send_nack(n_ptr);
 393                         bclink_set_gap(n_ptr);
 394                 }
 395         }
 396         tipc_node_unlock(n_ptr);
 397 }
 398
 399 /**
 400  * tipc_bclink_send_msg - broadcast a packet to all nodes in cluster
 401  */
 402
 403 int tipc_bclink_send_msg(struct sk_buff *buf)
 404 {
 405         int res;
 406
 407         spin_lock_bh(&bc_lock);
 408
 409         res = tipc_link_send_buf(bcl, buf);
 410         if (unlikely(res == -ELINKCONG))
 411                 buf_discard(buf);
 412         else
 413                 bclink_set_last_sent();
 414
 415         if (bcl->out_queue_size > bcl->stats.max_queue_sz)
 416                 bcl->stats.max_queue_sz = bcl->out_queue_size;
 417         bcl->stats.queue_sz_counts++;
 418         bcl->stats.accu_queue_sz += bcl->out_queue_size;
 419
 420         spin_unlock_bh(&bc_lock);
 421         return res;
 422 }
 423
 424 /**
 425  * tipc_bclink_recv_pkt - receive a broadcast packet, and deliver upwards
 426  *
 427  * tipc_net_lock is read_locked, no other locks set
 428  */
 429
 430 void tipc_bclink_recv_pkt(struct sk_buff *buf)
 431 {
 432 #if (TIPC_BCAST_LOSS_RATE)
 433         static int rx_count = 0;
 434 #endif
 435         struct tipc_msg *msg = buf_msg(buf);
 436         struct tipc_node* node = tipc_node_find(msg_prevnode(msg));
 437         u32 next_in;
 438         u32 seqno;
 439         struct sk_buff *deferred;
 440
 441         msg_dbg(msg, "<BC<<<");
 442
 443         if (unlikely(!node || !tipc_node_is_up(node) || !node->bclink.supported ||
 444                      (msg_mc_netid(msg) != tipc_net_id))) {
 445                 buf_discard(buf);
 446                 return;
 447         }
 448
 449         if (unlikely(msg_user(msg) == BCAST_PROTOCOL)) {
 450                 msg_dbg(msg, "<BCNACK<<<");
 451                 if (msg_destnode(msg) == tipc_own_addr) {
 452                         tipc_node_lock(node);
 453                         tipc_bclink_acknowledge(node, msg_bcast_ack(msg));
 454                         tipc_node_unlock(node);
 455                         spin_lock_bh(&bc_lock);
 456                         bcl->stats.recv_nacks++;
 457                         bcl->owner->next = node;   /* remember requestor */
 458                         bclink_retransmit_pkt(msg_bcgap_after(msg),
 459                                               msg_bcgap_to(msg));
 460                         bcl->owner->next = NULL;
 461                         spin_unlock_bh(&bc_lock);
 462                 } else {
 463                         tipc_bclink_peek_nack(msg_destnode(msg),
 464                                               msg_bcast_tag(msg),
 465                                               msg_bcgap_after(msg),
 466                                               msg_bcgap_to(msg));
 467                 }
 468                 buf_discard(buf);
 469                 return;
 470         }
 471
 472 #if (TIPC_BCAST_LOSS_RATE)
 473         if (++rx_count == TIPC_BCAST_LOSS_RATE) {
 474                 rx_count = 0;
 475                 buf_discard(buf);
 476                 return;
 477         }
 478 #endif
 479
 480         tipc_node_lock(node);
 481 receive:
 482         deferred = node->bclink.deferred_head;
 483         next_in = mod(node->bclink.last_in + 1);
 484         seqno = msg_seqno(msg);
 485
 486         if (likely(seqno == next_in)) {
 487                 bcl->stats.recv_info++;
 488                 node->bclink.last_in++;
 489                 bclink_set_gap(node);
 490                 if (unlikely(bclink_ack_allowed(seqno))) {
 491                         bclink_send_ack(node);
 492                         bcl->stats.sent_acks++;
 493                 }
 494                 if (likely(msg_isdata(msg))) {
 495                         tipc_node_unlock(node);
 496                         tipc_port_recv_mcast(buf, NULL);
 497                 } else if (msg_user(msg) == MSG_BUNDLER) {
 498                         bcl->stats.recv_bundles++;
 499                         bcl->stats.recv_bundled += msg_msgcnt(msg);
 500                         tipc_node_unlock(node);
 501                         tipc_link_recv_bundle(buf);
 502                 } else if (msg_user(msg) == MSG_FRAGMENTER) {
 503                         bcl->stats.recv_fragments++;
 504                         if (tipc_link_recv_fragment(&node->bclink.defragm,
 505                                                     &buf, &msg))
 506                                 bcl->stats.recv_fragmented++;
 507                         tipc_node_unlock(node);
 508                         tipc_net_route_msg(buf);
 509                 } else {
 510                         tipc_node_unlock(node);
 511                         tipc_net_route_msg(buf);
 512                 }
 513                 if (deferred && (buf_seqno(deferred) == mod(next_in + 1))) {
 514                         tipc_node_lock(node);
 515                         buf = deferred;
 516                         msg = buf_msg(buf);
 517                         node->bclink.deferred_head = deferred->next;
 518                         goto receive;
 519                 }
 520                 return;
 521         } else if (less(next_in, seqno)) {
 522                 u32 gap_after = node->bclink.gap_after;
 523                 u32 gap_to = node->bclink.gap_to;
 524
 525                 if (tipc_link_defer_pkt(&node->bclink.deferred_head,
 526                                         &node->bclink.deferred_tail,
 527                                         buf)) {
 528                         node->bclink.nack_sync++;
 529                         bcl->stats.deferred_recv++;
 530                         if (seqno == mod(gap_after + 1))
 531                                 node->bclink.gap_after = seqno;
 532                         else if (less(gap_after, seqno) && less(seqno, gap_to))
 533                                 node->bclink.gap_to = seqno;
 534                 }
 535                 if (bclink_ack_allowed(node->bclink.nack_sync)) {
 536                         if (gap_to != gap_after)
 537                                 bclink_send_nack(node);
 538                         bclink_set_gap(node);
 539                 }
 540         } else {
 541                 bcl->stats.duplicates++;
 542                 buf_discard(buf);
 543         }
 544         tipc_node_unlock(node);
 545 }
 546
 547 u32 tipc_bclink_acks_missing(struct tipc_node *n_ptr)
 548 {
 549         return (n_ptr->bclink.supported &&
 550                 (tipc_bclink_get_last_sent() != n_ptr->bclink.acked));
 551 }
 552
 553
 554 /**
 555  * tipc_bcbearer_send - send a packet through the broadcast pseudo-bearer
 556  *
 557  * Send through as many bearers as necessary to reach all nodes
 558  * that support TIPC multicasting.
 559  *
 560  * Returns 0 if packet sent successfully, non-zero if not
 561  */
 562
 563 static int tipc_bcbearer_send(struct sk_buff *buf,
 564                               struct tipc_bearer *unused1,
 565                               struct tipc_media_addr *unused2)
 566 {
 567         int bp_index;
 568
 569         /* Prepare buffer for broadcasting (if first time trying to send it) */
 570
 571         if (likely(!msg_non_seq(buf_msg(buf)))) {
 572                 struct tipc_msg *msg;
 573
 574                 assert(tipc_cltr_bcast_nodes.count != 0);
 575                 bcbuf_set_acks(buf, tipc_cltr_bcast_nodes.count);
 576                 msg = buf_msg(buf);
 577                 msg_set_non_seq(msg, 1);
 578                 msg_set_mc_netid(msg, tipc_net_id);
 579                 bcl->stats.sent_info++;
 580         }
 581
 582         /* Send buffer over bearers until all targets reached */
 583
 584         bcbearer->remains = tipc_cltr_bcast_nodes;
 585
 586         for (bp_index = 0; bp_index < MAX_BEARERS; bp_index++) {
 587                 struct bearer *p = bcbearer->bpairs[bp_index].primary;
 588                 struct bearer *s = bcbearer->bpairs[bp_index].secondary;
 589
 590                 if (!p)
 591                         break;  /* no more bearers to try */
 592
 593                 tipc_nmap_diff(&bcbearer->remains, &p->nodes, &bcbearer->remains_new);
 594                 if (bcbearer->remains_new.count == bcbearer->remains.count)
 595                         continue;       /* bearer pair doesn't add anything */
 596
 597                 if (p->publ.blocked ||
 598                     p->media->send_msg(buf, &p->publ, &p->media->bcast_addr)) {
 599                         /* unable to send on primary bearer */
 600                         if (!s || s->publ.blocked ||
 601                             s->media->send_msg(buf, &s->publ,
 602                                                &s->media->bcast_addr)) {
 603                                 /* unable to send on either bearer */
 604                                 continue;
 605                         }
 606                 }
 607
 608                 if (s) {
 609                         bcbearer->bpairs[bp_index].primary = s;
 610                         bcbearer->bpairs[bp_index].secondary = p;
 611                 }
 612
 613                 if (bcbearer->remains_new.count == 0)
 614                         return 0;
 615
 616                 bcbearer->remains = bcbearer->remains_new;
 617         }
 618
 619         /*
 620          * Unable to reach all targets (indicate success, since currently
 621          * there isn't code in place to properly block & unblock the
 622          * pseudo-bearer used by the broadcast link)
 623          */
 624
 625         return TIPC_OK;
 626 }
 627
 628 /**
 629  * tipc_bcbearer_sort - create sets of bearer pairs used by broadcast bearer
 630  */
 631
 632 void tipc_bcbearer_sort(void)
 633 {
 634         struct bcbearer_pair *bp_temp = bcbearer->bpairs_temp;
 635         struct bcbearer_pair *bp_curr;
 636         int b_index;
 637         int pri;
 638
 639         spin_lock_bh(&bc_lock);
 640
 641         /* Group bearers by priority (can assume max of two per priority) */
 642
 643         memset(bp_temp, 0, sizeof(bcbearer->bpairs_temp));
 644
 645         for (b_index = 0; b_index < MAX_BEARERS; b_index++) {
 646                 struct bearer *b = &tipc_bearers[b_index];
 647
 648                 if (!b->active || !b->nodes.count)
 649                         continue;
 650
 651                 if (!bp_temp[b->priority].primary)
 652                         bp_temp[b->priority].primary = b;
 653                 else
 654                         bp_temp[b->priority].secondary = b;
 655         }
 656
 657         /* Create array of bearer pairs for broadcasting */
 658
 659         bp_curr = bcbearer->bpairs;
 660         memset(bcbearer->bpairs, 0, sizeof(bcbearer->bpairs));
 661
 662         for (pri = TIPC_MAX_LINK_PRI; pri >= 0; pri--) {
 663
 664                 if (!bp_temp[pri].primary)
 665                         continue;
 666
 667                 bp_curr->primary = bp_temp[pri].primary;
 668
 669                 if (bp_temp[pri].secondary) {
 670                         if (tipc_nmap_equal(&bp_temp[pri].primary->nodes,
 671                                             &bp_temp[pri].secondary->nodes)) {
 672                                 bp_curr->secondary = bp_temp[pri].secondary;
 673                         } else {
 674                                 bp_curr++;
 675                                 bp_curr->primary = bp_temp[pri].secondary;
 676                         }
 677                 }
 678
 679                 bp_curr++;
 680         }
 681
 682         spin_unlock_bh(&bc_lock);
 683 }
 684
 685 /**
 686  * tipc_bcbearer_push - resolve bearer congestion
 687  *
 688  * Forces bclink to push out any unsent packets, until all packets are gone
 689  * or congestion reoccurs.
 690  * No locks set when function called
 691  */
 692
 693 void tipc_bcbearer_push(void)
 694 {
 695         struct bearer *b_ptr;
 696
 697         spin_lock_bh(&bc_lock);
 698         b_ptr = &bcbearer->bearer;
 699         if (b_ptr->publ.blocked) {
 700                 b_ptr->publ.blocked = 0;
 701                 tipc_bearer_lock_push(b_ptr);
 702         }
 703         spin_unlock_bh(&bc_lock);
 704 }
 705
 706
 707 int tipc_bclink_stats(char *buf, const u32 buf_size)
 708 {
 709         struct print_buf pb;
 710
 711         if (!bcl)
 712                 return 0;
 713
 714         tipc_printbuf_init(&pb, buf, buf_size);
 715
 716         spin_lock_bh(&bc_lock);
 717
 718         tipc_printf(&pb, "Link <%s>\n"
 719                          "  Window:%u packets\n",
 720                     bcl->name, bcl->queue_limit[0]);
 721         tipc_printf(&pb, "  RX packets:%u fragments:%u/%u bundles:%u/%u\n",
 722                     bcl->stats.recv_info,
 723                     bcl->stats.recv_fragments,
 724                     bcl->stats.recv_fragmented,
 725                     bcl->stats.recv_bundles,
 726                     bcl->stats.recv_bundled);
 727         tipc_printf(&pb, "  TX packets:%u fragments:%u/%u bundles:%u/%u\n",
 728                     bcl->stats.sent_info,
 729                     bcl->stats.sent_fragments,
 730                     bcl->stats.sent_fragmented,
 731                     bcl->stats.sent_bundles,
 732                     bcl->stats.sent_bundled);
 733         tipc_printf(&pb, "  RX naks:%u defs:%u dups:%u\n",
 734                     bcl->stats.recv_nacks,
 735                     bcl->stats.deferred_recv,
 736                     bcl->stats.duplicates);
 737         tipc_printf(&pb, "  TX naks:%u acks:%u dups:%u\n",
 738                     bcl->stats.sent_nacks,
 739                     bcl->stats.sent_acks,
 740                     bcl->stats.retransmitted);
 741         tipc_printf(&pb, "  Congestion bearer:%u link:%u  Send queue max:%u avg:%u\n",
 742                     bcl->stats.bearer_congs,
 743                     bcl->stats.link_congs,
 744                     bcl->stats.max_queue_sz,
 745                     bcl->stats.queue_sz_counts
 746                     ? (bcl->stats.accu_queue_sz / bcl->stats.queue_sz_counts)
 747                     : 0);
 748
 749         spin_unlock_bh(&bc_lock);
 750         return tipc_printbuf_validate(&pb);
 751 }
 752
 753 int tipc_bclink_reset_stats(void)
 754 {
 755         if (!bcl)
 756                 return -ENOPROTOOPT;
 757
 758         spin_lock_bh(&bc_lock);
 759         memset(&bcl->stats, 0, sizeof(bcl->stats));
 760         spin_unlock_bh(&bc_lock);
 761         return 0;
 762 }
 763
 764 int tipc_bclink_set_queue_limits(u32 limit)
 765 {
 766         if (!bcl)
 767                 return -ENOPROTOOPT;
 768         if ((limit < TIPC_MIN_LINK_WIN) || (limit > TIPC_MAX_LINK_WIN))
 769                 return -EINVAL;
 770
 771         spin_lock_bh(&bc_lock);
 772         tipc_link_set_queue_limits(bcl, limit);
 773         spin_unlock_bh(&bc_lock);
 774         return 0;
 775 }
 776
 777 int tipc_bclink_init(void)
 778 {
 779         bcbearer = kzalloc(sizeof(*bcbearer), GFP_ATOMIC);
 780         bclink = kzalloc(sizeof(*bclink), GFP_ATOMIC);
 781         if (!bcbearer || !bclink) {
 782  nomem:
 783                 warn("Multicast link creation failed, no memory\n");
 784                 kfree(bcbearer);
 785                 bcbearer = NULL;
 786                 kfree(bclink);
 787                 bclink = NULL;
 788                 return -ENOMEM;
 789         }
 790
 791         INIT_LIST_HEAD(&bcbearer->bearer.cong_links);
 792         bcbearer->bearer.media = &bcbearer->media;
 793         bcbearer->media.send_msg = tipc_bcbearer_send;
 794         sprintf(bcbearer->media.name, "tipc-multicast");
 795
 796         bcl = &bclink->link;
 797         INIT_LIST_HEAD(&bcl->waiting_ports);
 798         bcl->next_out_no = 1;
 799         spin_lock_init(&bclink->node.lock);
 800         bcl->owner = &bclink->node;
 801         bcl->max_pkt = MAX_PKT_DEFAULT_MCAST;
 802         tipc_link_set_queue_limits(bcl, BCLINK_WIN_DEFAULT);
 803         bcl->b_ptr = &bcbearer->bearer;
 804         bcl->state = WORKING_WORKING;
 805         strlcpy(bcl->name, tipc_bclink_name, TIPC_MAX_LINK_NAME);
 806
 807         if (BCLINK_LOG_BUF_SIZE) {
 808                 char *pb = kmalloc(BCLINK_LOG_BUF_SIZE, GFP_ATOMIC);
 809
 810                 if (!pb)
 811                         goto nomem;
 812                 tipc_printbuf_init(&bcl->print_buf, pb, BCLINK_LOG_BUF_SIZE);
 813         }
 814
 815         return 0;
 816 }
 817
 818 void tipc_bclink_stop(void)
 819 {
 820         spin_lock_bh(&bc_lock);
 821         if (bcbearer) {
 822                 tipc_link_stop(bcl);
 823                 if (BCLINK_LOG_BUF_SIZE)
 824                         kfree(bcl->print_buf.buf);
 825                 bcl = NULL;
 826                 kfree(bclink);
 827                 bclink = NULL;
 828                 kfree(bcbearer);
 829                 bcbearer = NULL;
 830         }
 831         spin_unlock_bh(&bc_lock);
 832 }
 833
 834
 835 /**
 836  * tipc_nmap_add - add a node to a node map
 837  */
 838
 839 void tipc_nmap_add(struct tipc_node_map *nm_ptr, u32 node)
 840 {
 841         int n = tipc_node(node);
 842         int w = n / WSIZE;
 843         u32 mask = (1 << (n % WSIZE));
 844
 845         if ((nm_ptr->map[w] & mask) == 0) {
 846                 nm_ptr->count++;
 847                 nm_ptr->map[w] |= mask;
 848         }
 849 }
 850
 851 /**
 852  * tipc_nmap_remove - remove a node from a node map
 853  */
 854
 855 void tipc_nmap_remove(struct tipc_node_map *nm_ptr, u32 node)
 856 {
 857         int n = tipc_node(node);
 858         int w = n / WSIZE;
 859         u32 mask = (1 << (n % WSIZE));
 860
 861         if ((nm_ptr->map[w] & mask) != 0) {
 862                 nm_ptr->map[w] &= ~mask;
 863                 nm_ptr->count--;
 864         }
 865 }
 866
 867 /**
 868  * tipc_nmap_diff - find differences between node maps
 869  * @nm_a: input node map A
 870  * @nm_b: input node map B
 871  * @nm_diff: output node map A-B (i.e. nodes of A that are not in B)
 872  */
 873
 874 void tipc_nmap_diff(struct tipc_node_map *nm_a, struct tipc_node_map *nm_b,
 875                                   struct tipc_node_map *nm_diff)
 876 {
 877         int stop = ARRAY_SIZE(nm_a->map);
 878         int w;
 879         int b;
 880         u32 map;
 881
 882         memset(nm_diff, 0, sizeof(*nm_diff));
 883         for (w = 0; w < stop; w++) {
 884                 map = nm_a->map[w] ^ (nm_a->map[w] & nm_b->map[w]);
 885                 nm_diff->map[w] = map;
 886                 if (map != 0) {
 887                         for (b = 0 ; b < WSIZE; b++) {
 888                                 if (map & (1 << b))
 889                                         nm_diff->count++;
 890                         }
 891                 }
 892         }
 893 }
 894
 895 /**
 896  * tipc_port_list_add - add a port to a port list, ensuring no duplicates
 897  */
 898
 899 void tipc_port_list_add(struct port_list *pl_ptr, u32 port)
 900 {
 901         struct port_list *item = pl_ptr;
 902         int i;
 903         int item_sz = PLSIZE;
 904         int cnt = pl_ptr->count;
 905
 906         for (; ; cnt -= item_sz, item = item->next) {
 907                 if (cnt < PLSIZE)
 908                         item_sz = cnt;
 909                 for (i = 0; i < item_sz; i++)
 910                         if (item->ports[i] == port)
 911                                 return;
 912                 if (i < PLSIZE) {
 913                         item->ports[i] = port;
 914                         pl_ptr->count++;
 915                         return;
 916                 }
 917                 if (!item->next) {
 918                         item->next = kmalloc(sizeof(*item), GFP_ATOMIC);
 919                         if (!item->next) {
 920                                 warn("Incomplete multicast delivery, no memory\n");
 921                                 return;
 922                         }
 923                         item->next->next = NULL;
 924                 }
 925         }
 926 }
 927
 928 /**
 929  * tipc_port_list_free - free dynamically created entries in port_list chain
 930  *
 931  */
 932
 933 void tipc_port_list_free(struct port_list *pl_ptr)
 934 {
 935         struct port_list *item;
 936         struct port_list *next;
 937
 938         for (item = pl_ptr->next; item; item = next) {
 939                 next = item->next;
 940                 kfree(item);
 941         }
 942 }
 943