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"
41 int sysctl_tipc_named_timeout __read_mostly = 2000;
43 struct distr_queue_item {
47 unsigned long expires;
48 struct list_head next;
52 * publ_to_item - add publication info to a publication message
53 * @p: publication info
54 * @i: location of item in the message
56 static void publ_to_item(struct distr_item *i, struct publication *p)
58 i->type = htonl(p->type);
59 i->lower = htonl(p->lower);
60 i->upper = htonl(p->upper);
61 i->port = htonl(p->port);
62 i->key = htonl(p->key);
66 * named_prepare_buf - allocate & initialize a publication message
67 * @net: the associated network namespace
70 * @dest: destination node
72 * The buffer returned is of size INT_H_SIZE + payload size
74 static struct sk_buff *named_prepare_buf(struct net *net, u32 type, u32 size,
77 struct sk_buff *buf = tipc_buf_acquire(INT_H_SIZE + size, GFP_ATOMIC);
78 u32 self = tipc_own_addr(net);
83 tipc_msg_init(self, msg, NAME_DISTRIBUTOR,
84 type, INT_H_SIZE, dest);
85 msg_set_size(msg, INT_H_SIZE + size);
91 * tipc_named_publish - tell other nodes about a new publication by this node
92 * @net: the associated network namespace
93 * @publ: the new publication
95 struct sk_buff *tipc_named_publish(struct net *net, struct publication *publ)
97 struct name_table *nt = tipc_name_table(net);
98 struct distr_item *item;
101 if (publ->scope == TIPC_NODE_SCOPE) {
102 list_add_tail_rcu(&publ->binding_node, &nt->node_scope);
105 write_lock_bh(&nt->cluster_scope_lock);
106 list_add_tail(&publ->binding_node, &nt->cluster_scope);
107 write_unlock_bh(&nt->cluster_scope_lock);
108 skb = named_prepare_buf(net, PUBLICATION, ITEM_SIZE, 0);
110 pr_warn("Publication distribution failure\n");
113 msg_set_named_seqno(buf_msg(skb), nt->snd_nxt++);
114 msg_set_non_legacy(buf_msg(skb));
115 item = (struct distr_item *)msg_data(buf_msg(skb));
116 publ_to_item(item, publ);
121 * tipc_named_withdraw - tell other nodes about a withdrawn publication by this node
122 * @net: the associated network namespace
123 * @publ: the withdrawn publication
125 struct sk_buff *tipc_named_withdraw(struct net *net, struct publication *publ)
127 struct name_table *nt = tipc_name_table(net);
128 struct distr_item *item;
131 write_lock_bh(&nt->cluster_scope_lock);
132 list_del(&publ->binding_node);
133 write_unlock_bh(&nt->cluster_scope_lock);
134 if (publ->scope == TIPC_NODE_SCOPE)
137 skb = named_prepare_buf(net, WITHDRAWAL, ITEM_SIZE, 0);
139 pr_warn("Withdrawal distribution failure\n");
142 msg_set_named_seqno(buf_msg(skb), nt->snd_nxt++);
143 msg_set_non_legacy(buf_msg(skb));
144 item = (struct distr_item *)msg_data(buf_msg(skb));
145 publ_to_item(item, publ);
150 * named_distribute - prepare name info for bulk distribution to another node
151 * @net: the associated network namespace
152 * @list: list of messages (buffers) to be returned from this function
153 * @dnode: node to be updated
154 * @pls: linked list of publication items to be packed into buffer chain
155 * @seqno: sequence number for this message
157 static void named_distribute(struct net *net, struct sk_buff_head *list,
158 u32 dnode, struct list_head *pls, u16 seqno)
160 struct publication *publ;
161 struct sk_buff *skb = NULL;
162 struct distr_item *item = NULL;
163 u32 msg_dsz = ((tipc_node_get_mtu(net, dnode, 0, false) - INT_H_SIZE) /
164 ITEM_SIZE) * ITEM_SIZE;
165 u32 msg_rem = msg_dsz;
166 struct tipc_msg *hdr;
168 list_for_each_entry(publ, pls, binding_node) {
169 /* Prepare next buffer: */
171 skb = named_prepare_buf(net, PUBLICATION, msg_rem,
174 pr_warn("Bulk publication failure\n");
178 msg_set_bc_ack_invalid(hdr, true);
180 msg_set_non_legacy(hdr);
181 item = (struct distr_item *)msg_data(hdr);
184 /* Pack publication into message: */
185 publ_to_item(item, publ);
187 msg_rem -= ITEM_SIZE;
189 /* Append full buffer to list: */
191 __skb_queue_tail(list, skb);
198 msg_set_size(hdr, INT_H_SIZE + (msg_dsz - msg_rem));
199 skb_trim(skb, INT_H_SIZE + (msg_dsz - msg_rem));
200 __skb_queue_tail(list, skb);
202 hdr = buf_msg(skb_peek_tail(list));
203 msg_set_last_bulk(hdr);
204 msg_set_named_seqno(hdr, seqno);
208 * tipc_named_node_up - tell specified node about all publications by this node
209 * @net: the associated network namespace
210 * @dnode: destination node
211 * @capabilities: peer node's capabilities
213 void tipc_named_node_up(struct net *net, u32 dnode, u16 capabilities)
215 struct name_table *nt = tipc_name_table(net);
216 struct tipc_net *tn = tipc_net(net);
217 struct sk_buff_head head;
220 __skb_queue_head_init(&head);
221 spin_lock_bh(&tn->nametbl_lock);
222 if (!(capabilities & TIPC_NAMED_BCAST))
225 spin_unlock_bh(&tn->nametbl_lock);
227 read_lock_bh(&nt->cluster_scope_lock);
228 named_distribute(net, &head, dnode, &nt->cluster_scope, seqno);
229 tipc_node_xmit(net, &head, dnode, 0);
230 read_unlock_bh(&nt->cluster_scope_lock);
234 * tipc_publ_purge - remove publication associated with a failed node
235 * @net: the associated network namespace
236 * @publ: the publication to remove
237 * @addr: failed node's address
239 * Invoked for each publication issued by a newly failed node.
240 * Removes publication structure from name table & deletes it.
242 static void tipc_publ_purge(struct net *net, struct publication *publ, u32 addr)
244 struct tipc_net *tn = tipc_net(net);
245 struct publication *p;
247 spin_lock_bh(&tn->nametbl_lock);
248 p = tipc_nametbl_remove_publ(net, publ->type, publ->lower, publ->upper,
249 publ->node, publ->key);
251 tipc_node_unsubscribe(net, &p->binding_node, addr);
252 spin_unlock_bh(&tn->nametbl_lock);
255 pr_err("Unable to remove publication from failed node\n"
256 " (type=%u, lower=%u, node=0x%x, port=%u, key=%u)\n",
257 publ->type, publ->lower, publ->node, publ->port,
265 void tipc_publ_notify(struct net *net, struct list_head *nsub_list,
266 u32 addr, u16 capabilities)
268 struct name_table *nt = tipc_name_table(net);
269 struct tipc_net *tn = tipc_net(net);
271 struct publication *publ, *tmp;
273 list_for_each_entry_safe(publ, tmp, nsub_list, binding_node)
274 tipc_publ_purge(net, publ, addr);
275 spin_lock_bh(&tn->nametbl_lock);
276 if (!(capabilities & TIPC_NAMED_BCAST))
278 spin_unlock_bh(&tn->nametbl_lock);
282 * tipc_update_nametbl - try to process a nametable update and notify
284 * @net: the associated network namespace
285 * @i: location of item in the message
286 * @node: node address
287 * @dtype: name distributor message type
289 * tipc_nametbl_lock must be held.
290 * Return: the publication item if successful, otherwise NULL.
292 static bool tipc_update_nametbl(struct net *net, struct distr_item *i,
295 struct publication *p = NULL;
296 u32 lower = ntohl(i->lower);
297 u32 upper = ntohl(i->upper);
298 u32 type = ntohl(i->type);
299 u32 port = ntohl(i->port);
300 u32 key = ntohl(i->key);
302 if (dtype == PUBLICATION) {
303 p = tipc_nametbl_insert_publ(net, type, lower, upper,
304 TIPC_CLUSTER_SCOPE, node,
307 tipc_node_subscribe(net, &p->binding_node, node);
310 } else if (dtype == WITHDRAWAL) {
311 p = tipc_nametbl_remove_publ(net, type, lower,
314 tipc_node_unsubscribe(net, &p->binding_node, node);
318 pr_warn_ratelimited("Failed to remove binding %u,%u from %x\n",
321 pr_warn("Unrecognized name table message received\n");
326 static struct sk_buff *tipc_named_dequeue(struct sk_buff_head *namedq,
327 u16 *rcv_nxt, bool *open)
329 struct sk_buff *skb, *tmp;
330 struct tipc_msg *hdr;
333 spin_lock_bh(&namedq->lock);
334 skb_queue_walk_safe(namedq, skb, tmp) {
335 if (unlikely(skb_linearize(skb))) {
336 __skb_unlink(skb, namedq);
341 seqno = msg_named_seqno(hdr);
342 if (msg_is_last_bulk(hdr)) {
347 if (msg_is_bulk(hdr) || msg_is_legacy(hdr)) {
348 __skb_unlink(skb, namedq);
349 spin_unlock_bh(&namedq->lock);
353 if (*open && (*rcv_nxt == seqno)) {
355 __skb_unlink(skb, namedq);
356 spin_unlock_bh(&namedq->lock);
360 if (less(seqno, *rcv_nxt)) {
361 __skb_unlink(skb, namedq);
366 spin_unlock_bh(&namedq->lock);
371 * tipc_named_rcv - process name table update messages sent by another node
372 * @net: the associated network namespace
373 * @namedq: queue to receive from
374 * @rcv_nxt: store last received seqno here
375 * @open: last bulk msg was received (FIXME)
377 void tipc_named_rcv(struct net *net, struct sk_buff_head *namedq,
378 u16 *rcv_nxt, bool *open)
380 struct tipc_net *tn = tipc_net(net);
381 struct distr_item *item;
382 struct tipc_msg *hdr;
386 spin_lock_bh(&tn->nametbl_lock);
387 while ((skb = tipc_named_dequeue(namedq, rcv_nxt, open))) {
389 node = msg_orignode(hdr);
390 item = (struct distr_item *)msg_data(hdr);
391 count = msg_data_sz(hdr) / ITEM_SIZE;
393 tipc_update_nametbl(net, item, node, msg_type(hdr));
398 spin_unlock_bh(&tn->nametbl_lock);
402 * tipc_named_reinit - re-initialize local publications
403 * @net: the associated network namespace
405 * This routine is called whenever TIPC networking is enabled.
406 * All name table entries published by this node are updated to reflect
407 * the node's new network address.
409 void tipc_named_reinit(struct net *net)
411 struct name_table *nt = tipc_name_table(net);
412 struct tipc_net *tn = tipc_net(net);
413 struct publication *publ;
414 u32 self = tipc_own_addr(net);
416 spin_lock_bh(&tn->nametbl_lock);
418 list_for_each_entry_rcu(publ, &nt->node_scope, binding_node)
420 list_for_each_entry_rcu(publ, &nt->cluster_scope, binding_node)
423 spin_unlock_bh(&tn->nametbl_lock);