2 * net/tipc/name_distr.c: TIPC name distribution code
4 * Copyright (c) 2000-2006, 2014, Ericsson AB
5 * Copyright (c) 2005, 2010-2011, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
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.
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.
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.
39 #include "name_distr.h"
42 * struct publ_list - list of publications made by this node
43 * @list: circular list of publications
44 * @list_size: number of entries in list
47 struct list_head list;
51 static struct publ_list publ_zone = {
52 .list = LIST_HEAD_INIT(publ_zone.list),
56 static struct publ_list publ_cluster = {
57 .list = LIST_HEAD_INIT(publ_cluster.list),
61 static struct publ_list publ_node = {
62 .list = LIST_HEAD_INIT(publ_node.list),
66 static struct publ_list *publ_lists[] = {
68 &publ_zone, /* publ_lists[TIPC_ZONE_SCOPE] */
69 &publ_cluster, /* publ_lists[TIPC_CLUSTER_SCOPE] */
70 &publ_node /* publ_lists[TIPC_NODE_SCOPE] */
74 int sysctl_tipc_named_timeout __read_mostly = 2000;
77 * struct tipc_dist_queue - queue holding deferred name table updates
79 static struct list_head tipc_dist_queue = LIST_HEAD_INIT(tipc_dist_queue);
81 struct distr_queue_item {
85 unsigned long expires;
86 struct list_head next;
90 * publ_to_item - add publication info to a publication message
92 static void publ_to_item(struct distr_item *i, struct publication *p)
94 i->type = htonl(p->type);
95 i->lower = htonl(p->lower);
96 i->upper = htonl(p->upper);
97 i->ref = htonl(p->ref);
98 i->key = htonl(p->key);
102 * named_prepare_buf - allocate & initialize a publication message
104 static struct sk_buff *named_prepare_buf(u32 type, u32 size, u32 dest)
106 struct sk_buff *buf = tipc_buf_acquire(INT_H_SIZE + size);
107 struct tipc_msg *msg;
111 tipc_msg_init(msg, NAME_DISTRIBUTOR, type, INT_H_SIZE, dest);
112 msg_set_size(msg, INT_H_SIZE + size);
117 void named_cluster_distribute(struct sk_buff *buf)
119 struct sk_buff *obuf;
120 struct tipc_node *node;
124 list_for_each_entry_rcu(node, &tipc_node_list, list) {
126 if (in_own_node(dnode))
128 if (!tipc_node_active_links(node))
130 obuf = skb_copy(buf, GFP_ATOMIC);
133 msg_set_destnode(buf_msg(obuf), dnode);
134 tipc_link_xmit(obuf, dnode, dnode);
142 * tipc_named_publish - tell other nodes about a new publication by this node
144 struct sk_buff *tipc_named_publish(struct publication *publ)
147 struct distr_item *item;
149 list_add_tail(&publ->local_list, &publ_lists[publ->scope]->list);
150 publ_lists[publ->scope]->size++;
152 if (publ->scope == TIPC_NODE_SCOPE)
155 buf = named_prepare_buf(PUBLICATION, ITEM_SIZE, 0);
157 pr_warn("Publication distribution failure\n");
161 item = (struct distr_item *)msg_data(buf_msg(buf));
162 publ_to_item(item, publ);
167 * tipc_named_withdraw - tell other nodes about a withdrawn publication by this node
169 struct sk_buff *tipc_named_withdraw(struct publication *publ)
172 struct distr_item *item;
174 list_del(&publ->local_list);
175 publ_lists[publ->scope]->size--;
177 if (publ->scope == TIPC_NODE_SCOPE)
180 buf = named_prepare_buf(WITHDRAWAL, ITEM_SIZE, 0);
182 pr_warn("Withdrawal distribution failure\n");
186 item = (struct distr_item *)msg_data(buf_msg(buf));
187 publ_to_item(item, publ);
192 * named_distribute - prepare name info for bulk distribution to another node
193 * @msg_list: list of messages (buffers) to be returned from this function
194 * @dnode: node to be updated
195 * @pls: linked list of publication items to be packed into buffer chain
197 static void named_distribute(struct list_head *msg_list, u32 dnode,
198 struct publ_list *pls)
200 struct publication *publ;
201 struct sk_buff *buf = NULL;
202 struct distr_item *item = NULL;
203 uint dsz = pls->size * ITEM_SIZE;
204 uint msg_dsz = (tipc_node_get_mtu(dnode, 0) / ITEM_SIZE) * ITEM_SIZE;
208 list_for_each_entry(publ, &pls->list, local_list) {
209 /* Prepare next buffer: */
211 msg_rem = min_t(uint, rem, msg_dsz);
213 buf = named_prepare_buf(PUBLICATION, msg_rem, dnode);
215 pr_warn("Bulk publication failure\n");
218 item = (struct distr_item *)msg_data(buf_msg(buf));
221 /* Pack publication into message: */
222 publ_to_item(item, publ);
224 msg_rem -= ITEM_SIZE;
226 /* Append full buffer to list: */
228 list_add_tail((struct list_head *)buf, msg_list);
235 * tipc_named_node_up - tell specified node about all publications by this node
237 void tipc_named_node_up(u32 dnode)
240 struct sk_buff *buf_chain;
242 read_lock_bh(&tipc_nametbl_lock);
243 named_distribute(&msg_list, dnode, &publ_cluster);
244 named_distribute(&msg_list, dnode, &publ_zone);
245 read_unlock_bh(&tipc_nametbl_lock);
247 /* Convert circular list to linear list and send: */
248 buf_chain = (struct sk_buff *)msg_list.next;
249 ((struct sk_buff *)msg_list.prev)->next = NULL;
250 tipc_link_xmit(buf_chain, dnode, dnode);
254 * named_purge_publ - remove publication associated with a failed node
256 * Invoked for each publication issued by a newly failed node.
257 * Removes publication structure from name table & deletes it.
259 static void named_purge_publ(struct publication *publ)
261 struct publication *p;
263 write_lock_bh(&tipc_nametbl_lock);
264 p = tipc_nametbl_remove_publ(publ->type, publ->lower,
265 publ->node, publ->ref, publ->key);
267 tipc_nodesub_unsubscribe(&p->subscr);
268 write_unlock_bh(&tipc_nametbl_lock);
271 pr_err("Unable to remove publication from failed node\n"
272 " (type=%u, lower=%u, node=0x%x, ref=%u, key=%u)\n",
273 publ->type, publ->lower, publ->node, publ->ref,
281 * tipc_update_nametbl - try to process a nametable update and notify
284 * tipc_nametbl_lock must be held.
285 * Returns the publication item if successful, otherwise NULL.
287 static bool tipc_update_nametbl(struct distr_item *i, u32 node, u32 dtype)
289 struct publication *publ = NULL;
291 if (dtype == PUBLICATION) {
292 publ = tipc_nametbl_insert_publ(ntohl(i->type), ntohl(i->lower),
294 TIPC_CLUSTER_SCOPE, node,
295 ntohl(i->ref), ntohl(i->key));
297 tipc_nodesub_subscribe(&publ->subscr, node, publ,
302 } else if (dtype == WITHDRAWAL) {
303 publ = tipc_nametbl_remove_publ(ntohl(i->type), ntohl(i->lower),
307 tipc_nodesub_unsubscribe(&publ->subscr);
312 pr_warn("Unrecognized name table message received\n");
318 * tipc_named_add_backlog - add a failed name table update to the backlog
321 static void tipc_named_add_backlog(struct distr_item *i, u32 type, u32 node)
323 struct distr_queue_item *e;
324 unsigned long now = get_jiffies_64();
326 e = kzalloc(sizeof(*e), GFP_ATOMIC);
331 e->expires = now + msecs_to_jiffies(sysctl_tipc_named_timeout);
332 memcpy(e, i, sizeof(*i));
333 list_add_tail(&e->next, &tipc_dist_queue);
337 * tipc_named_process_backlog - try to process any pending name table updates
340 void tipc_named_process_backlog(void)
342 struct distr_queue_item *e, *tmp;
344 unsigned long now = get_jiffies_64();
346 list_for_each_entry_safe(e, tmp, &tipc_dist_queue, next) {
347 if (time_after(e->expires, now)) {
348 if (!tipc_update_nametbl(&e->i, e->node, e->dtype))
351 tipc_addr_string_fill(addr, e->node);
352 pr_warn_ratelimited("Dropping name table update (%d) of {%u, %u, %u} from %s key=%u\n",
353 e->dtype, ntohl(e->i.type),
356 addr, ntohl(e->i.key));
364 * tipc_named_rcv - process name table update message sent by another node
366 void tipc_named_rcv(struct sk_buff *buf)
368 struct tipc_msg *msg = buf_msg(buf);
369 struct distr_item *item = (struct distr_item *)msg_data(msg);
370 u32 count = msg_data_sz(msg) / ITEM_SIZE;
371 u32 node = msg_orignode(msg);
373 write_lock_bh(&tipc_nametbl_lock);
375 if (!tipc_update_nametbl(item, node, msg_type(msg)))
376 tipc_named_add_backlog(item, msg_type(msg), node);
379 tipc_named_process_backlog();
380 write_unlock_bh(&tipc_nametbl_lock);
385 * tipc_named_reinit - re-initialize local publications
387 * This routine is called whenever TIPC networking is enabled.
388 * All name table entries published by this node are updated to reflect
389 * the node's new network address.
391 void tipc_named_reinit(void)
393 struct publication *publ;
396 write_lock_bh(&tipc_nametbl_lock);
398 for (scope = TIPC_ZONE_SCOPE; scope <= TIPC_NODE_SCOPE; scope++)
399 list_for_each_entry(publ, &publ_lists[scope]->list, local_list)
400 publ->node = tipc_own_addr;
402 write_unlock_bh(&tipc_nametbl_lock);