2 * net/tipc/name_distr.c: TIPC name distribution code
4 * Copyright (c) 2000-2006, Ericsson AB
5 * Copyright (c) 2005, 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.
42 #include "name_distr.h"
45 #define DBG_OUTPUT NULL
47 #define ITEM_SIZE sizeof(struct distr_item)
50 * struct distr_item - publication info distributed to other nodes
51 * @type: name sequence type
52 * @lower: name sequence lower bound
53 * @upper: name sequence upper bound
54 * @ref: publishing port reference
55 * @key: publication key
57 * ===> All fields are stored in network byte order. <===
59 * First 3 fields identify (name or) name sequence being published.
60 * Reference field uniquely identifies port that published name sequence.
61 * Key field uniquely identifies publication, in the event a port has
62 * multiple publications of the same name sequence.
64 * Note: There is no field that identifies the publishing node because it is
65 * the same for all items contained within a publication message.
77 * List of externally visible publications by this node --
78 * that is, all publications having scope > TIPC_NODE_SCOPE.
81 static LIST_HEAD(publ_root);
82 static u32 publ_cnt = 0;
85 * publ_to_item - add publication info to a publication message
88 static void publ_to_item(struct distr_item *i, struct publication *p)
90 i->type = htonl(p->type);
91 i->lower = htonl(p->lower);
92 i->upper = htonl(p->upper);
93 i->ref = htonl(p->ref);
94 i->key = htonl(p->key);
95 dbg("publ_to_item: %u, %u, %u\n", p->type, p->lower, p->upper);
99 * named_prepare_buf - allocate & initialize a publication message
102 static struct sk_buff *named_prepare_buf(u32 type, u32 size, u32 dest)
104 struct sk_buff *buf = buf_acquire(LONG_H_SIZE + size);
105 struct tipc_msg *msg;
109 msg_init(msg, NAME_DISTRIBUTOR, type, TIPC_OK,
111 msg_set_size(msg, LONG_H_SIZE + size);
117 * tipc_named_publish - tell other nodes about a new publication by this node
120 void tipc_named_publish(struct publication *publ)
123 struct distr_item *item;
125 list_add_tail(&publ->local_list, &publ_root);
128 buf = named_prepare_buf(PUBLICATION, ITEM_SIZE, 0);
130 warn("Publication distribution failure\n");
134 item = (struct distr_item *)msg_data(buf_msg(buf));
135 publ_to_item(item, publ);
136 dbg("tipc_named_withdraw: broadcasting publish msg\n");
137 tipc_cltr_broadcast(buf);
141 * tipc_named_withdraw - tell other nodes about a withdrawn publication by this node
144 void tipc_named_withdraw(struct publication *publ)
147 struct distr_item *item;
149 list_del(&publ->local_list);
152 buf = named_prepare_buf(WITHDRAWAL, ITEM_SIZE, 0);
154 warn("Withdrawl distribution failure\n");
158 item = (struct distr_item *)msg_data(buf_msg(buf));
159 publ_to_item(item, publ);
160 dbg("tipc_named_withdraw: broadcasting withdraw msg\n");
161 tipc_cltr_broadcast(buf);
165 * tipc_named_node_up - tell specified node about all publications by this node
168 void tipc_named_node_up(unsigned long node)
170 struct publication *publ;
171 struct distr_item *item = NULL;
172 struct sk_buff *buf = NULL;
177 read_lock_bh(&tipc_nametbl_lock);
178 max_item_buf = TIPC_MAX_USER_MSG_SIZE / ITEM_SIZE;
179 max_item_buf *= ITEM_SIZE;
180 rest = publ_cnt * ITEM_SIZE;
182 list_for_each_entry(publ, &publ_root, local_list) {
184 left = (rest <= max_item_buf) ? rest : max_item_buf;
186 buf = named_prepare_buf(PUBLICATION, left, node);
188 warn("Bulk publication distribution failure\n");
191 item = (struct distr_item *)msg_data(buf_msg(buf));
193 publ_to_item(item, publ);
197 msg_set_link_selector(buf_msg(buf), node);
198 dbg("tipc_named_node_up: sending publish msg to "
199 "<%u.%u.%u>\n", tipc_zone(node),
200 tipc_cluster(node), tipc_node(node));
201 tipc_link_send(buf, node, node);
206 read_unlock_bh(&tipc_nametbl_lock);
210 * node_is_down - remove publication associated with a failed node
212 * Invoked for each publication issued by a newly failed node.
213 * Removes publication structure from name table & deletes it.
214 * In rare cases the link may have come back up again when this
215 * function is called, and we have two items representing the same
216 * publication. Nudge this item's key to distinguish it from the other.
217 * (Note: Publication's node subscription is already unsubscribed.)
220 static void node_is_down(struct publication *publ)
222 struct publication *p;
224 write_lock_bh(&tipc_nametbl_lock);
225 dbg("node_is_down: withdrawing %u, %u, %u\n",
226 publ->type, publ->lower, publ->upper);
227 publ->key += 1222345;
228 p = tipc_nametbl_remove_publ(publ->type, publ->lower,
229 publ->node, publ->ref, publ->key);
230 write_unlock_bh(&tipc_nametbl_lock);
233 err("Unable to remove publication from failed node\n"
234 "(type=%u, lower=%u, node=0x%x, ref=%u, key=%u)\n",
235 publ->type, publ->lower, publ->node, publ->ref, publ->key);
244 * tipc_named_recv - process name table update message sent by another node
247 void tipc_named_recv(struct sk_buff *buf)
249 struct publication *publ;
250 struct tipc_msg *msg = buf_msg(buf);
251 struct distr_item *item = (struct distr_item *)msg_data(msg);
252 u32 count = msg_data_sz(msg) / ITEM_SIZE;
254 write_lock_bh(&tipc_nametbl_lock);
256 if (msg_type(msg) == PUBLICATION) {
257 dbg("tipc_named_recv: got publication for %u, %u, %u\n",
258 ntohl(item->type), ntohl(item->lower),
260 publ = tipc_nametbl_insert_publ(ntohl(item->type),
268 tipc_nodesub_subscribe(&publ->subscr,
271 (net_ev_handler)node_is_down);
273 } else if (msg_type(msg) == WITHDRAWAL) {
274 dbg("tipc_named_recv: got withdrawl for %u, %u, %u\n",
275 ntohl(item->type), ntohl(item->lower),
277 publ = tipc_nametbl_remove_publ(ntohl(item->type),
284 tipc_nodesub_unsubscribe(&publ->subscr);
287 err("Unable to remove publication by node 0x%x\n"
288 "(type=%u, lower=%u, ref=%u, key=%u)\n",
290 ntohl(item->type), ntohl(item->lower),
291 ntohl(item->ref), ntohl(item->key));
294 warn("Unrecognized name table message received\n");
298 write_unlock_bh(&tipc_nametbl_lock);
303 * tipc_named_reinit - re-initialize local publication list
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.)
311 void tipc_named_reinit(void)
313 struct publication *publ;
315 write_lock_bh(&tipc_nametbl_lock);
316 list_for_each_entry(publ, &publ_root, local_list) {
317 if (publ->node == tipc_own_addr)
319 publ->node = tipc_own_addr;
321 write_unlock_bh(&tipc_nametbl_lock);