xref: /linux/net/tipc/bcast.h (revision 9e9f60108423f18a99c9cc93ef7f23490ecc709b)
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 "netlink.h"
41 
42 #define MAX_NODES 4096
43 #define WSIZE 32
44 #define TIPC_BCLINK_RESET 1
45 
46 /**
47  * struct tipc_node_map - set of node identifiers
48  * @count: # of nodes in set
49  * @map: bitmap of node identifiers that are in the set
50  */
51 struct tipc_node_map {
52 	u32 count;
53 	u32 map[MAX_NODES / WSIZE];
54 };
55 
56 #define PLSIZE 32
57 
58 /**
59  * struct tipc_port_list - set of node local destination ports
60  * @count: # of ports in set (only valid for first entry in list)
61  * @next: pointer to next entry in list
62  * @ports: array of port references
63  */
64 struct tipc_port_list {
65 	int count;
66 	struct tipc_port_list *next;
67 	u32 ports[PLSIZE];
68 };
69 
70 
71 struct tipc_node;
72 
73 extern const char tipc_bclink_name[];
74 
75 /**
76  * tipc_nmap_equal - test for equality of node maps
77  */
78 static inline int tipc_nmap_equal(struct tipc_node_map *nm_a,
79 				  struct tipc_node_map *nm_b)
80 {
81 	return !memcmp(nm_a, nm_b, sizeof(*nm_a));
82 }
83 
84 void tipc_port_list_add(struct tipc_port_list *pl_ptr, u32 port);
85 void tipc_port_list_free(struct tipc_port_list *pl_ptr);
86 
87 int tipc_bclink_init(void);
88 void tipc_bclink_stop(void);
89 void tipc_bclink_set_flags(unsigned int flags);
90 void tipc_bclink_add_node(u32 addr);
91 void tipc_bclink_remove_node(u32 addr);
92 struct tipc_node *tipc_bclink_retransmit_to(void);
93 void tipc_bclink_acknowledge(struct tipc_node *n_ptr, u32 acked);
94 void tipc_bclink_rcv(struct sk_buff *buf);
95 u32  tipc_bclink_get_last_sent(void);
96 u32  tipc_bclink_acks_missing(struct tipc_node *n_ptr);
97 void tipc_bclink_update_link_state(struct tipc_node *n_ptr, u32 last_sent);
98 int  tipc_bclink_stats(char *stats_buf, const u32 buf_size);
99 int  tipc_bclink_reset_stats(void);
100 int  tipc_bclink_set_queue_limits(u32 limit);
101 void tipc_bcbearer_sort(struct tipc_node_map *nm_ptr, u32 node, bool action);
102 uint  tipc_bclink_get_mtu(void);
103 int tipc_bclink_xmit(struct sk_buff_head *list);
104 void tipc_bclink_wakeup_users(void);
105 int tipc_nl_add_bc_link(struct tipc_nl_msg *msg);
106 
107 #endif
108