Loading...
1/*
2 * net/tipc/name_distr.c: TIPC name distribution code
3 *
4 * Copyright (c) 2000-2006, 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#include "core.h"
38#include "link.h"
39#include "name_distr.h"
40
41#define ITEM_SIZE sizeof(struct distr_item)
42
43/**
44 * struct distr_item - publication info distributed to other nodes
45 * @type: name sequence type
46 * @lower: name sequence lower bound
47 * @upper: name sequence upper bound
48 * @ref: publishing port reference
49 * @key: publication key
50 *
51 * ===> All fields are stored in network byte order. <===
52 *
53 * First 3 fields identify (name or) name sequence being published.
54 * Reference field uniquely identifies port that published name sequence.
55 * Key field uniquely identifies publication, in the event a port has
56 * multiple publications of the same name sequence.
57 *
58 * Note: There is no field that identifies the publishing node because it is
59 * the same for all items contained within a publication message.
60 */
61
62struct distr_item {
63 __be32 type;
64 __be32 lower;
65 __be32 upper;
66 __be32 ref;
67 __be32 key;
68};
69
70/**
71 * List of externally visible publications by this node --
72 * that is, all publications having scope > TIPC_NODE_SCOPE.
73 */
74
75static LIST_HEAD(publ_root);
76static u32 publ_cnt;
77
78/**
79 * publ_to_item - add publication info to a publication message
80 */
81
82static void publ_to_item(struct distr_item *i, struct publication *p)
83{
84 i->type = htonl(p->type);
85 i->lower = htonl(p->lower);
86 i->upper = htonl(p->upper);
87 i->ref = htonl(p->ref);
88 i->key = htonl(p->key);
89}
90
91/**
92 * named_prepare_buf - allocate & initialize a publication message
93 */
94
95static struct sk_buff *named_prepare_buf(u32 type, u32 size, u32 dest)
96{
97 struct sk_buff *buf = tipc_buf_acquire(INT_H_SIZE + size);
98 struct tipc_msg *msg;
99
100 if (buf != NULL) {
101 msg = buf_msg(buf);
102 tipc_msg_init(msg, NAME_DISTRIBUTOR, type, INT_H_SIZE, dest);
103 msg_set_size(msg, INT_H_SIZE + size);
104 }
105 return buf;
106}
107
108static void named_cluster_distribute(struct sk_buff *buf)
109{
110 struct sk_buff *buf_copy;
111 struct tipc_node *n_ptr;
112
113 list_for_each_entry(n_ptr, &tipc_node_list, list) {
114 if (tipc_node_active_links(n_ptr)) {
115 buf_copy = skb_copy(buf, GFP_ATOMIC);
116 if (!buf_copy)
117 break;
118 msg_set_destnode(buf_msg(buf_copy), n_ptr->addr);
119 tipc_link_send(buf_copy, n_ptr->addr, n_ptr->addr);
120 }
121 }
122
123 buf_discard(buf);
124}
125
126/**
127 * tipc_named_publish - tell other nodes about a new publication by this node
128 */
129
130void tipc_named_publish(struct publication *publ)
131{
132 struct sk_buff *buf;
133 struct distr_item *item;
134
135 list_add_tail(&publ->local_list, &publ_root);
136 publ_cnt++;
137
138 buf = named_prepare_buf(PUBLICATION, ITEM_SIZE, 0);
139 if (!buf) {
140 warn("Publication distribution failure\n");
141 return;
142 }
143
144 item = (struct distr_item *)msg_data(buf_msg(buf));
145 publ_to_item(item, publ);
146 named_cluster_distribute(buf);
147}
148
149/**
150 * tipc_named_withdraw - tell other nodes about a withdrawn publication by this node
151 */
152
153void tipc_named_withdraw(struct publication *publ)
154{
155 struct sk_buff *buf;
156 struct distr_item *item;
157
158 list_del(&publ->local_list);
159 publ_cnt--;
160
161 buf = named_prepare_buf(WITHDRAWAL, ITEM_SIZE, 0);
162 if (!buf) {
163 warn("Withdrawal distribution failure\n");
164 return;
165 }
166
167 item = (struct distr_item *)msg_data(buf_msg(buf));
168 publ_to_item(item, publ);
169 named_cluster_distribute(buf);
170}
171
172/**
173 * tipc_named_node_up - tell specified node about all publications by this node
174 */
175
176void tipc_named_node_up(unsigned long node)
177{
178 struct publication *publ;
179 struct distr_item *item = NULL;
180 struct sk_buff *buf = NULL;
181 u32 left = 0;
182 u32 rest;
183 u32 max_item_buf;
184
185 read_lock_bh(&tipc_nametbl_lock);
186 max_item_buf = TIPC_MAX_USER_MSG_SIZE / ITEM_SIZE;
187 max_item_buf *= ITEM_SIZE;
188 rest = publ_cnt * ITEM_SIZE;
189
190 list_for_each_entry(publ, &publ_root, local_list) {
191 if (!buf) {
192 left = (rest <= max_item_buf) ? rest : max_item_buf;
193 rest -= left;
194 buf = named_prepare_buf(PUBLICATION, left, node);
195 if (!buf) {
196 warn("Bulk publication distribution failure\n");
197 goto exit;
198 }
199 item = (struct distr_item *)msg_data(buf_msg(buf));
200 }
201 publ_to_item(item, publ);
202 item++;
203 left -= ITEM_SIZE;
204 if (!left) {
205 msg_set_link_selector(buf_msg(buf), node);
206 tipc_link_send(buf, node, node);
207 buf = NULL;
208 }
209 }
210exit:
211 read_unlock_bh(&tipc_nametbl_lock);
212}
213
214/**
215 * named_purge_publ - remove publication associated with a failed node
216 *
217 * Invoked for each publication issued by a newly failed node.
218 * Removes publication structure from name table & deletes it.
219 * In rare cases the link may have come back up again when this
220 * function is called, and we have two items representing the same
221 * publication. Nudge this item's key to distinguish it from the other.
222 */
223
224static void named_purge_publ(struct publication *publ)
225{
226 struct publication *p;
227
228 write_lock_bh(&tipc_nametbl_lock);
229 publ->key += 1222345;
230 p = tipc_nametbl_remove_publ(publ->type, publ->lower,
231 publ->node, publ->ref, publ->key);
232 if (p)
233 tipc_nodesub_unsubscribe(&p->subscr);
234 write_unlock_bh(&tipc_nametbl_lock);
235
236 if (p != publ) {
237 err("Unable to remove publication from failed node\n"
238 "(type=%u, lower=%u, node=0x%x, ref=%u, key=%u)\n",
239 publ->type, publ->lower, publ->node, publ->ref, publ->key);
240 }
241
242 kfree(p);
243}
244
245/**
246 * tipc_named_recv - process name table update message sent by another node
247 */
248
249void tipc_named_recv(struct sk_buff *buf)
250{
251 struct publication *publ;
252 struct tipc_msg *msg = buf_msg(buf);
253 struct distr_item *item = (struct distr_item *)msg_data(msg);
254 u32 count = msg_data_sz(msg) / ITEM_SIZE;
255
256 write_lock_bh(&tipc_nametbl_lock);
257 while (count--) {
258 if (msg_type(msg) == PUBLICATION) {
259 publ = tipc_nametbl_insert_publ(ntohl(item->type),
260 ntohl(item->lower),
261 ntohl(item->upper),
262 TIPC_CLUSTER_SCOPE,
263 msg_orignode(msg),
264 ntohl(item->ref),
265 ntohl(item->key));
266 if (publ) {
267 tipc_nodesub_subscribe(&publ->subscr,
268 msg_orignode(msg),
269 publ,
270 (net_ev_handler)
271 named_purge_publ);
272 }
273 } else if (msg_type(msg) == WITHDRAWAL) {
274 publ = tipc_nametbl_remove_publ(ntohl(item->type),
275 ntohl(item->lower),
276 msg_orignode(msg),
277 ntohl(item->ref),
278 ntohl(item->key));
279
280 if (publ) {
281 tipc_nodesub_unsubscribe(&publ->subscr);
282 kfree(publ);
283 } else {
284 err("Unable to remove publication by node 0x%x\n"
285 "(type=%u, lower=%u, ref=%u, key=%u)\n",
286 msg_orignode(msg),
287 ntohl(item->type), ntohl(item->lower),
288 ntohl(item->ref), ntohl(item->key));
289 }
290 } else {
291 warn("Unrecognized name table message received\n");
292 }
293 item++;
294 }
295 write_unlock_bh(&tipc_nametbl_lock);
296 buf_discard(buf);
297}
298
299/**
300 * tipc_named_reinit - re-initialize local publication list
301 *
302 * This routine is called whenever TIPC networking is (re)enabled.
303 * All existing publications by this node that have "cluster" or "zone" scope
304 * are updated to reflect the node's current network address.
305 * (If the node's address is unchanged, the update loop terminates immediately.)
306 */
307
308void tipc_named_reinit(void)
309{
310 struct publication *publ;
311
312 write_lock_bh(&tipc_nametbl_lock);
313 list_for_each_entry(publ, &publ_root, local_list) {
314 if (publ->node == tipc_own_addr)
315 break;
316 publ->node = tipc_own_addr;
317 }
318 write_unlock_bh(&tipc_nametbl_lock);
319}
1/*
2 * net/tipc/name_distr.c: TIPC name distribution code
3 *
4 * Copyright (c) 2000-2006, 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#include "core.h"
38#include "link.h"
39#include "name_distr.h"
40
41#define ITEM_SIZE sizeof(struct distr_item)
42
43/**
44 * struct distr_item - publication info distributed to other nodes
45 * @type: name sequence type
46 * @lower: name sequence lower bound
47 * @upper: name sequence upper bound
48 * @ref: publishing port reference
49 * @key: publication key
50 *
51 * ===> All fields are stored in network byte order. <===
52 *
53 * First 3 fields identify (name or) name sequence being published.
54 * Reference field uniquely identifies port that published name sequence.
55 * Key field uniquely identifies publication, in the event a port has
56 * multiple publications of the same name sequence.
57 *
58 * Note: There is no field that identifies the publishing node because it is
59 * the same for all items contained within a publication message.
60 */
61struct distr_item {
62 __be32 type;
63 __be32 lower;
64 __be32 upper;
65 __be32 ref;
66 __be32 key;
67};
68
69/**
70 * struct publ_list - list of publications made by this node
71 * @list: circular list of publications
72 * @list_size: number of entries in list
73 */
74struct publ_list {
75 struct list_head list;
76 u32 size;
77};
78
79static struct publ_list publ_zone = {
80 .list = LIST_HEAD_INIT(publ_zone.list),
81 .size = 0,
82};
83
84static struct publ_list publ_cluster = {
85 .list = LIST_HEAD_INIT(publ_cluster.list),
86 .size = 0,
87};
88
89static struct publ_list publ_node = {
90 .list = LIST_HEAD_INIT(publ_node.list),
91 .size = 0,
92};
93
94static struct publ_list *publ_lists[] = {
95 NULL,
96 &publ_zone, /* publ_lists[TIPC_ZONE_SCOPE] */
97 &publ_cluster, /* publ_lists[TIPC_CLUSTER_SCOPE] */
98 &publ_node /* publ_lists[TIPC_NODE_SCOPE] */
99};
100
101
102/**
103 * publ_to_item - add publication info to a publication message
104 */
105static void publ_to_item(struct distr_item *i, struct publication *p)
106{
107 i->type = htonl(p->type);
108 i->lower = htonl(p->lower);
109 i->upper = htonl(p->upper);
110 i->ref = htonl(p->ref);
111 i->key = htonl(p->key);
112}
113
114/**
115 * named_prepare_buf - allocate & initialize a publication message
116 */
117static struct sk_buff *named_prepare_buf(u32 type, u32 size, u32 dest)
118{
119 struct sk_buff *buf = tipc_buf_acquire(INT_H_SIZE + size);
120 struct tipc_msg *msg;
121
122 if (buf != NULL) {
123 msg = buf_msg(buf);
124 tipc_msg_init(msg, NAME_DISTRIBUTOR, type, INT_H_SIZE, dest);
125 msg_set_size(msg, INT_H_SIZE + size);
126 }
127 return buf;
128}
129
130static void named_cluster_distribute(struct sk_buff *buf)
131{
132 struct sk_buff *buf_copy;
133 struct tipc_node *n_ptr;
134
135 list_for_each_entry(n_ptr, &tipc_node_list, list) {
136 if (tipc_node_active_links(n_ptr)) {
137 buf_copy = skb_copy(buf, GFP_ATOMIC);
138 if (!buf_copy)
139 break;
140 msg_set_destnode(buf_msg(buf_copy), n_ptr->addr);
141 tipc_link_send(buf_copy, n_ptr->addr, n_ptr->addr);
142 }
143 }
144
145 kfree_skb(buf);
146}
147
148/**
149 * tipc_named_publish - tell other nodes about a new publication by this node
150 */
151void tipc_named_publish(struct publication *publ)
152{
153 struct sk_buff *buf;
154 struct distr_item *item;
155
156 list_add_tail(&publ->local_list, &publ_lists[publ->scope]->list);
157 publ_lists[publ->scope]->size++;
158
159 if (publ->scope == TIPC_NODE_SCOPE)
160 return;
161
162 buf = named_prepare_buf(PUBLICATION, ITEM_SIZE, 0);
163 if (!buf) {
164 warn("Publication distribution failure\n");
165 return;
166 }
167
168 item = (struct distr_item *)msg_data(buf_msg(buf));
169 publ_to_item(item, publ);
170 named_cluster_distribute(buf);
171}
172
173/**
174 * tipc_named_withdraw - tell other nodes about a withdrawn publication by this node
175 */
176void tipc_named_withdraw(struct publication *publ)
177{
178 struct sk_buff *buf;
179 struct distr_item *item;
180
181 list_del(&publ->local_list);
182 publ_lists[publ->scope]->size--;
183
184 if (publ->scope == TIPC_NODE_SCOPE)
185 return;
186
187 buf = named_prepare_buf(WITHDRAWAL, ITEM_SIZE, 0);
188 if (!buf) {
189 warn("Withdrawal distribution failure\n");
190 return;
191 }
192
193 item = (struct distr_item *)msg_data(buf_msg(buf));
194 publ_to_item(item, publ);
195 named_cluster_distribute(buf);
196}
197
198/*
199 * named_distribute - prepare name info for bulk distribution to another node
200 */
201static void named_distribute(struct list_head *message_list, u32 node,
202 struct publ_list *pls, u32 max_item_buf)
203{
204 struct publication *publ;
205 struct sk_buff *buf = NULL;
206 struct distr_item *item = NULL;
207 u32 left = 0;
208 u32 rest = pls->size * ITEM_SIZE;
209
210 list_for_each_entry(publ, &pls->list, local_list) {
211 if (!buf) {
212 left = (rest <= max_item_buf) ? rest : max_item_buf;
213 rest -= left;
214 buf = named_prepare_buf(PUBLICATION, left, node);
215 if (!buf) {
216 warn("Bulk publication failure\n");
217 return;
218 }
219 item = (struct distr_item *)msg_data(buf_msg(buf));
220 }
221 publ_to_item(item, publ);
222 item++;
223 left -= ITEM_SIZE;
224 if (!left) {
225 list_add_tail((struct list_head *)buf, message_list);
226 buf = NULL;
227 }
228 }
229}
230
231/**
232 * tipc_named_node_up - tell specified node about all publications by this node
233 */
234void tipc_named_node_up(unsigned long nodearg)
235{
236 struct tipc_node *n_ptr;
237 struct tipc_link *l_ptr;
238 struct list_head message_list;
239 u32 node = (u32)nodearg;
240 u32 max_item_buf = 0;
241
242 /* compute maximum amount of publication data to send per message */
243 read_lock_bh(&tipc_net_lock);
244 n_ptr = tipc_node_find(node);
245 if (n_ptr) {
246 tipc_node_lock(n_ptr);
247 l_ptr = n_ptr->active_links[0];
248 if (l_ptr)
249 max_item_buf = ((l_ptr->max_pkt - INT_H_SIZE) /
250 ITEM_SIZE) * ITEM_SIZE;
251 tipc_node_unlock(n_ptr);
252 }
253 read_unlock_bh(&tipc_net_lock);
254 if (!max_item_buf)
255 return;
256
257 /* create list of publication messages, then send them as a unit */
258 INIT_LIST_HEAD(&message_list);
259
260 read_lock_bh(&tipc_nametbl_lock);
261 named_distribute(&message_list, node, &publ_cluster, max_item_buf);
262 named_distribute(&message_list, node, &publ_zone, max_item_buf);
263 read_unlock_bh(&tipc_nametbl_lock);
264
265 tipc_link_send_names(&message_list, (u32)node);
266}
267
268/**
269 * named_purge_publ - remove publication associated with a failed node
270 *
271 * Invoked for each publication issued by a newly failed node.
272 * Removes publication structure from name table & deletes it.
273 */
274static void named_purge_publ(struct publication *publ)
275{
276 struct publication *p;
277
278 write_lock_bh(&tipc_nametbl_lock);
279 p = tipc_nametbl_remove_publ(publ->type, publ->lower,
280 publ->node, publ->ref, publ->key);
281 if (p)
282 tipc_nodesub_unsubscribe(&p->subscr);
283 write_unlock_bh(&tipc_nametbl_lock);
284
285 if (p != publ) {
286 err("Unable to remove publication from failed node\n"
287 "(type=%u, lower=%u, node=0x%x, ref=%u, key=%u)\n",
288 publ->type, publ->lower, publ->node, publ->ref, publ->key);
289 }
290
291 kfree(p);
292}
293
294/**
295 * tipc_named_recv - process name table update message sent by another node
296 */
297void tipc_named_recv(struct sk_buff *buf)
298{
299 struct publication *publ;
300 struct tipc_msg *msg = buf_msg(buf);
301 struct distr_item *item = (struct distr_item *)msg_data(msg);
302 u32 count = msg_data_sz(msg) / ITEM_SIZE;
303
304 write_lock_bh(&tipc_nametbl_lock);
305 while (count--) {
306 if (msg_type(msg) == PUBLICATION) {
307 publ = tipc_nametbl_insert_publ(ntohl(item->type),
308 ntohl(item->lower),
309 ntohl(item->upper),
310 TIPC_CLUSTER_SCOPE,
311 msg_orignode(msg),
312 ntohl(item->ref),
313 ntohl(item->key));
314 if (publ) {
315 tipc_nodesub_subscribe(&publ->subscr,
316 msg_orignode(msg),
317 publ,
318 (net_ev_handler)
319 named_purge_publ);
320 }
321 } else if (msg_type(msg) == WITHDRAWAL) {
322 publ = tipc_nametbl_remove_publ(ntohl(item->type),
323 ntohl(item->lower),
324 msg_orignode(msg),
325 ntohl(item->ref),
326 ntohl(item->key));
327
328 if (publ) {
329 tipc_nodesub_unsubscribe(&publ->subscr);
330 kfree(publ);
331 } else {
332 err("Unable to remove publication by node 0x%x\n"
333 "(type=%u, lower=%u, ref=%u, key=%u)\n",
334 msg_orignode(msg),
335 ntohl(item->type), ntohl(item->lower),
336 ntohl(item->ref), ntohl(item->key));
337 }
338 } else {
339 warn("Unrecognized name table message received\n");
340 }
341 item++;
342 }
343 write_unlock_bh(&tipc_nametbl_lock);
344 kfree_skb(buf);
345}
346
347/**
348 * tipc_named_reinit - re-initialize local publications
349 *
350 * This routine is called whenever TIPC networking is enabled.
351 * All name table entries published by this node are updated to reflect
352 * the node's new network address.
353 */
354void tipc_named_reinit(void)
355{
356 struct publication *publ;
357 int scope;
358
359 write_lock_bh(&tipc_nametbl_lock);
360
361 for (scope = TIPC_ZONE_SCOPE; scope <= TIPC_NODE_SCOPE; scope++)
362 list_for_each_entry(publ, &publ_lists[scope]->list, local_list)
363 publ->node = tipc_own_addr;
364
365 write_unlock_bh(&tipc_nametbl_lock);
366}