net/tipc/bcast.h

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