xref: /linux/net/tipc/bcast.h (revision b8bb76713ec50df2f11efee386e16f93d51e1076)
1 /*
2  * net/tipc/bcast.h: Include file for TIPC broadcast code
3  *
4  * Copyright (c) 2003-2006, Ericsson AB
5  * Copyright (c) 2005, 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 #define MAX_NODES 4096
41 #define WSIZE 32
42 
43 /**
44  * struct tipc_node_map - set of node identifiers
45  * @count: # of nodes in set
46  * @map: bitmap of node identifiers that are in the set
47  */
48 
49 struct tipc_node_map {
50 	u32 count;
51 	u32 map[MAX_NODES / WSIZE];
52 };
53 
54 
55 #define PLSIZE 32
56 
57 /**
58  * struct port_list - set of node local destination ports
59  * @count: # of ports in set (only valid for first entry in list)
60  * @next: pointer to next entry in list
61  * @ports: array of port references
62  */
63 
64 struct port_list {
65 	int count;
66 	struct 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 /**
77  * nmap_add - add a node to a node map
78  */
79 
80 static inline void tipc_nmap_add(struct tipc_node_map *nm_ptr, u32 node)
81 {
82 	int n = tipc_node(node);
83 	int w = n / WSIZE;
84 	u32 mask = (1 << (n % WSIZE));
85 
86 	if ((nm_ptr->map[w] & mask) == 0) {
87 		nm_ptr->count++;
88 		nm_ptr->map[w] |= mask;
89 	}
90 }
91 
92 /**
93  * nmap_remove - remove a node from a node map
94  */
95 
96 static inline void tipc_nmap_remove(struct tipc_node_map *nm_ptr, u32 node)
97 {
98 	int n = tipc_node(node);
99 	int w = n / WSIZE;
100 	u32 mask = (1 << (n % WSIZE));
101 
102 	if ((nm_ptr->map[w] & mask) != 0) {
103 		nm_ptr->map[w] &= ~mask;
104 		nm_ptr->count--;
105 	}
106 }
107 
108 /**
109  * nmap_equal - test for equality of node maps
110  */
111 
112 static inline int tipc_nmap_equal(struct tipc_node_map *nm_a, struct tipc_node_map *nm_b)
113 {
114 	return !memcmp(nm_a, nm_b, sizeof(*nm_a));
115 }
116 
117 /**
118  * nmap_diff - find differences between node maps
119  * @nm_a: input node map A
120  * @nm_b: input node map B
121  * @nm_diff: output node map A-B (i.e. nodes of A that are not in B)
122  */
123 
124 static inline void tipc_nmap_diff(struct tipc_node_map *nm_a, struct tipc_node_map *nm_b,
125 				  struct tipc_node_map *nm_diff)
126 {
127 	int stop = ARRAY_SIZE(nm_a->map);
128 	int w;
129 	int b;
130 	u32 map;
131 
132 	memset(nm_diff, 0, sizeof(*nm_diff));
133 	for (w = 0; w < stop; w++) {
134 		map = nm_a->map[w] ^ (nm_a->map[w] & nm_b->map[w]);
135 		nm_diff->map[w] = map;
136 		if (map != 0) {
137 			for (b = 0 ; b < WSIZE; b++) {
138 				if (map & (1 << b))
139 					nm_diff->count++;
140 			}
141 		}
142 	}
143 }
144 
145 /**
146  * port_list_add - add a port to a port list, ensuring no duplicates
147  */
148 
149 static inline void tipc_port_list_add(struct port_list *pl_ptr, u32 port)
150 {
151 	struct port_list *item = pl_ptr;
152 	int i;
153 	int item_sz = PLSIZE;
154 	int cnt = pl_ptr->count;
155 
156 	for (; ; cnt -= item_sz, item = item->next) {
157 		if (cnt < PLSIZE)
158 			item_sz = cnt;
159 		for (i = 0; i < item_sz; i++)
160 			if (item->ports[i] == port)
161 				return;
162 		if (i < PLSIZE) {
163 			item->ports[i] = port;
164 			pl_ptr->count++;
165 			return;
166 		}
167 		if (!item->next) {
168 			item->next = kmalloc(sizeof(*item), GFP_ATOMIC);
169 			if (!item->next) {
170 				warn("Incomplete multicast delivery, no memory\n");
171 				return;
172 			}
173 			item->next->next = NULL;
174 		}
175 	}
176 }
177 
178 /**
179  * port_list_free - free dynamically created entries in port_list chain
180  *
181  * Note: First item is on stack, so it doesn't need to be released
182  */
183 
184 static inline void tipc_port_list_free(struct port_list *pl_ptr)
185 {
186 	struct port_list *item;
187 	struct port_list *next;
188 
189 	for (item = pl_ptr->next; item; item = next) {
190 		next = item->next;
191 		kfree(item);
192 	}
193 }
194 
195 
196 int  tipc_bclink_init(void);
197 void tipc_bclink_stop(void);
198 void tipc_bclink_acknowledge(struct tipc_node *n_ptr, u32 acked);
199 int  tipc_bclink_send_msg(struct sk_buff *buf);
200 void tipc_bclink_recv_pkt(struct sk_buff *buf);
201 u32  tipc_bclink_get_last_sent(void);
202 u32  tipc_bclink_acks_missing(struct tipc_node *n_ptr);
203 void tipc_bclink_check_gap(struct tipc_node *n_ptr, u32 seqno);
204 int  tipc_bclink_stats(char *stats_buf, const u32 buf_size);
205 int  tipc_bclink_reset_stats(void);
206 int  tipc_bclink_set_queue_limits(u32 limit);
207 void tipc_bcbearer_sort(void);
208 void tipc_bcbearer_push(void);
209 
210 #endif
211