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