LXR linux/net/tipc/bcast.h

   1/*
   2 * net/tipc/bcast.h: Include file for TIPC broadcast code
   3 *
   4 * Copyright (c) 2003-2006, 2014-2015, Ericsson AB
   5 * Copyright (c) 2005, 2010-2011, Wind River Systems
   6 * All rights reserved.
   7 *
   8 * Redistribution and use in source and binary forms, with or without
   9 * modification, are permitted provided that the following conditions are met:
  10 *
  11 * 1. Redistributions of source code must retain the above copyright
  12 *    notice, this list of conditions and the following disclaimer.
  13 * 2. Redistributions in binary form must reproduce the above copyright
  14 *    notice, this list of conditions and the following disclaimer in the
  15 *    documentation and/or other materials provided with the distribution.
  16 * 3. Neither the names of the copyright holders nor the names of its
  17 *    contributors may be used to endorse or promote products derived from
  18 *    this software without specific prior written permission.
  19 *
  20 * Alternatively, this software may be distributed under the terms of the
  21 * GNU General Public License ("GPL") version 2 as published by the Free
  22 * Software Foundation.
  23 *
  24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34 * POSSIBILITY OF SUCH DAMAGE.
  35 */
  36
  37#ifndef _TIPC_BCAST_H
  38#define _TIPC_BCAST_H
  39
  40#include <linux/tipc_config.h>
  41#include "link.h"
  42#include "node.h"
  43
  44/**
  45 * struct tipc_bcbearer_pair - a pair of bearers used by broadcast link
  46 * @primary: pointer to primary bearer
  47 * @secondary: pointer to secondary bearer
  48 *
  49 * Bearers must have same priority and same set of reachable destinations
  50 * to be paired.
  51 */
  52
  53struct tipc_bcbearer_pair {
  54        struct tipc_bearer *primary;
  55        struct tipc_bearer *secondary;
  56};
  57
  58#define BCBEARER                MAX_BEARERS
  59
  60/**
  61 * struct tipc_bcbearer - bearer used by broadcast link
  62 * @bearer: (non-standard) broadcast bearer structure
  63 * @media: (non-standard) broadcast media structure
  64 * @bpairs: array of bearer pairs
  65 * @bpairs_temp: temporary array of bearer pairs used by tipc_bcbearer_sort()
  66 * @remains: temporary node map used by tipc_bcbearer_send()
  67 * @remains_new: temporary node map used tipc_bcbearer_send()
  68 *
  69 * Note: The fields labelled "temporary" are incorporated into the bearer
  70 * to avoid consuming potentially limited stack space through the use of
  71 * large local variables within multicast routines.  Concurrent access is
  72 * prevented through use of the spinlock "bclink_lock".
  73 */
  74struct tipc_bcbearer {
  75        struct tipc_bearer bearer;
  76        struct tipc_media media;
  77        struct tipc_bcbearer_pair bpairs[MAX_BEARERS];
  78        struct tipc_bcbearer_pair bpairs_temp[TIPC_MAX_LINK_PRI + 1];
  79        struct tipc_node_map remains;
  80        struct tipc_node_map remains_new;
  81};
  82
  83/**
  84 * struct tipc_bclink - link used for broadcast messages
  85 * @lock: spinlock governing access to structure
  86 * @link: (non-standard) broadcast link structure
  87 * @node: (non-standard) node structure representing b'cast link's peer node
  88 * @bcast_nodes: map of broadcast-capable nodes
  89 * @retransmit_to: node that most recently requested a retransmit
  90 *
  91 * Handles sequence numbering, fragmentation, bundling, etc.
  92 */
  93struct tipc_bclink {
  94        spinlock_t lock;
  95        struct tipc_link link;
  96        struct tipc_node node;
  97        struct sk_buff_head arrvq;
  98        struct sk_buff_head inputq;
  99        struct tipc_node_map bcast_nodes;
 100        struct tipc_node *retransmit_to;
 101};
 102
 103struct tipc_node;
 104extern const char tipc_bclink_name[];
 105
 106/**
 107 * tipc_nmap_equal - test for equality of node maps
 108 */
 109static inline int tipc_nmap_equal(struct tipc_node_map *nm_a,
 110                                  struct tipc_node_map *nm_b)
 111{
 112        return !memcmp(nm_a, nm_b, sizeof(*nm_a));
 113}
 114
 115int tipc_bclink_init(struct net *net);
 116void tipc_bclink_stop(struct net *net);
 117void tipc_bclink_add_node(struct net *net, u32 addr);
 118void tipc_bclink_remove_node(struct net *net, u32 addr);
 119struct tipc_node *tipc_bclink_retransmit_to(struct net *tn);
 120void tipc_bclink_acknowledge(struct tipc_node *n_ptr, u32 acked);
 121void tipc_bclink_rcv(struct net *net, struct sk_buff *buf);
 122u32  tipc_bclink_get_last_sent(struct net *net);
 123u32  tipc_bclink_acks_missing(struct tipc_node *n_ptr);
 124void tipc_bclink_update_link_state(struct tipc_node *node,
 125                                   u32 last_sent);
 126int  tipc_bclink_reset_stats(struct net *net);
 127int  tipc_bclink_set_queue_limits(struct net *net, u32 limit);
 128void tipc_bcbearer_sort(struct net *net, struct tipc_node_map *nm_ptr,
 129                        u32 node, bool action);
 130uint  tipc_bclink_get_mtu(void);
 131int tipc_bclink_xmit(struct net *net, struct sk_buff_head *list);
 132void tipc_bclink_wakeup_users(struct net *net);
 133int tipc_nl_add_bc_link(struct net *net, struct tipc_nl_msg *msg);
 134void tipc_bclink_input(struct net *net);
 135
 136#endif
 137