blob: 4bdc12277d33ff8eb382b755dd1323424d9d43a2 [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/bcast.h: Include file for TIPC broadcast code
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Jon Paul Maloy3c724ac2015-02-05 08:36:43 -05004 * Copyright (c) 2003-2006, 2014-2015, Ericsson AB
Allan Stephens01d83ed2011-01-18 13:53:16 -05005 * Copyright (c) 2005, 2010-2011, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_BCAST_H
38#define _TIPC_BCAST_H
39
Ying Xue1da46562015-01-09 15:27:07 +080040#include <linux/tipc_config.h>
41#include "link.h"
42#include "node.h"
Richard Alpe7be57fc2014-11-20 10:29:12 +010043
Ying Xue1da46562015-01-09 15:27:07 +080044/**
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
Jon Paul Maloy3c724ac2015-02-05 08:36:43 -050058#define BCBEARER MAX_BEARERS
59
Ying Xue1da46562015-01-09 15:27:07 +080060/**
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
Ying Xue1da46562015-01-09 15:27:07 +080088 * @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;
Jon Paul Maloycb1b7282015-02-05 08:36:44 -050097 struct sk_buff_head arrvq;
98 struct sk_buff_head inputq;
Ying Xue1da46562015-01-09 15:27:07 +080099 struct tipc_node_map bcast_nodes;
100 struct tipc_node *retransmit_to;
101};
Per Lidenb97bf3f2006-01-02 19:04:38 +0100102
David S. Miller6c000552008-09-02 23:38:32 -0700103struct tipc_node;
Stephen Hemminger4b704d52009-03-18 19:11:29 -0700104extern const char tipc_bclink_name[];
Per Lidenb97bf3f2006-01-02 19:04:38 +0100105
Per Lidenb97bf3f2006-01-02 19:04:38 +0100106/**
Allan Stephensc68ca7b2010-05-11 14:30:12 +0000107 * tipc_nmap_equal - test for equality of node maps
Per Lidenb97bf3f2006-01-02 19:04:38 +0100108 */
Paul Gortmakerae8509c2013-06-17 10:54:47 -0400109static inline int tipc_nmap_equal(struct tipc_node_map *nm_a,
110 struct tipc_node_map *nm_b)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100111{
112 return !memcmp(nm_a, nm_b, sizeof(*nm_a));
113}
114
Ying Xue7f9f95d2015-01-09 15:27:06 +0800115int tipc_bclink_init(struct net *net);
116void tipc_bclink_stop(struct net *net);
Ying Xue1da46562015-01-09 15:27:07 +0800117void 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);
David S. Miller6c000552008-09-02 23:38:32 -0700120void tipc_bclink_acknowledge(struct tipc_node *n_ptr, u32 acked);
Ying Xuec93d3ba2015-01-09 15:27:04 +0800121void tipc_bclink_rcv(struct net *net, struct sk_buff *buf);
Ying Xue1da46562015-01-09 15:27:07 +0800122u32 tipc_bclink_get_last_sent(struct net *net);
David S. Miller6c000552008-09-02 23:38:32 -0700123u32 tipc_bclink_acks_missing(struct tipc_node *n_ptr);
Jon Paul Maloyc5898632015-02-05 08:36:36 -0500124void tipc_bclink_update_link_state(struct tipc_node *node,
Ying Xuec93d3ba2015-01-09 15:27:04 +0800125 u32 last_sent);
Ying Xue1da46562015-01-09 15:27:07 +0800126int tipc_bclink_reset_stats(struct net *net);
127int tipc_bclink_set_queue_limits(struct net *net, u32 limit);
Ying Xue7f9f95d2015-01-09 15:27:06 +0800128void tipc_bcbearer_sort(struct net *net, struct tipc_node_map *nm_ptr,
129 u32 node, bool action);
Jon Paul Maloy078bec82014-07-16 20:41:00 -0400130uint tipc_bclink_get_mtu(void);
Ying Xuef2f98002015-01-09 15:27:05 +0800131int tipc_bclink_xmit(struct net *net, struct sk_buff_head *list);
132void tipc_bclink_wakeup_users(struct net *net);
Ying Xue1da46562015-01-09 15:27:07 +0800133int tipc_nl_add_bc_link(struct net *net, struct tipc_nl_msg *msg);
Jon Paul Maloycb1b7282015-02-05 08:36:44 -0500134void tipc_bclink_input(struct net *net);
Richard Alpe7be57fc2014-11-20 10:29:12 +0100135
Per Lidenb97bf3f2006-01-02 19:04:38 +0100136#endif