2 * net/tipc/node.c: TIPC node management routines
4 * Copyright (c) 2000-2006, 2012-2015, Ericsson AB
5 * Copyright (c) 2005-2006, 2010-2014, 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.
40 #include "name_distr.h"
44 static void node_lost_contact(struct tipc_node *n_ptr);
45 static void node_established_contact(struct tipc_node *n_ptr);
46 static void tipc_node_delete(struct tipc_node *node);
48 struct tipc_sock_conn {
52 struct list_head list;
55 static const struct nla_policy tipc_nl_node_policy[TIPC_NLA_NODE_MAX + 1] = {
56 [TIPC_NLA_NODE_UNSPEC] = { .type = NLA_UNSPEC },
57 [TIPC_NLA_NODE_ADDR] = { .type = NLA_U32 },
58 [TIPC_NLA_NODE_UP] = { .type = NLA_FLAG }
62 * A trivial power-of-two bitmask technique is used for speed, since this
63 * operation is done for every incoming TIPC packet. The number of hash table
64 * entries has been chosen so that no hash chain exceeds 8 nodes and will
65 * usually be much smaller (typically only a single node).
67 static unsigned int tipc_hashfn(u32 addr)
69 return addr & (NODE_HTABLE_SIZE - 1);
72 static void tipc_node_kref_release(struct kref *kref)
74 struct tipc_node *node = container_of(kref, struct tipc_node, kref);
76 tipc_node_delete(node);
79 void tipc_node_put(struct tipc_node *node)
81 kref_put(&node->kref, tipc_node_kref_release);
84 static void tipc_node_get(struct tipc_node *node)
86 kref_get(&node->kref);
90 * tipc_node_find - locate specified node object, if it exists
92 struct tipc_node *tipc_node_find(struct net *net, u32 addr)
94 struct tipc_net *tn = net_generic(net, tipc_net_id);
95 struct tipc_node *node;
97 if (unlikely(!in_own_cluster_exact(net, addr)))
101 hlist_for_each_entry_rcu(node, &tn->node_htable[tipc_hashfn(addr)],
103 if (node->addr == addr) {
113 struct tipc_node *tipc_node_create(struct net *net, u32 addr)
115 struct tipc_net *tn = net_generic(net, tipc_net_id);
116 struct tipc_node *n_ptr, *temp_node;
118 spin_lock_bh(&tn->node_list_lock);
119 n_ptr = tipc_node_find(net, addr);
122 n_ptr = kzalloc(sizeof(*n_ptr), GFP_ATOMIC);
124 pr_warn("Node creation failed, no memory\n");
129 kref_init(&n_ptr->kref);
130 spin_lock_init(&n_ptr->lock);
131 INIT_HLIST_NODE(&n_ptr->hash);
132 INIT_LIST_HEAD(&n_ptr->list);
133 INIT_LIST_HEAD(&n_ptr->publ_list);
134 INIT_LIST_HEAD(&n_ptr->conn_sks);
135 skb_queue_head_init(&n_ptr->bclink.namedq);
136 __skb_queue_head_init(&n_ptr->bclink.deferdq);
137 hlist_add_head_rcu(&n_ptr->hash, &tn->node_htable[tipc_hashfn(addr)]);
138 list_for_each_entry_rcu(temp_node, &tn->node_list, list) {
139 if (n_ptr->addr < temp_node->addr)
142 list_add_tail_rcu(&n_ptr->list, &temp_node->list);
143 n_ptr->action_flags = TIPC_WAIT_PEER_LINKS_DOWN;
144 n_ptr->signature = INVALID_NODE_SIG;
145 tipc_node_get(n_ptr);
147 spin_unlock_bh(&tn->node_list_lock);
151 static void tipc_node_delete(struct tipc_node *node)
153 list_del_rcu(&node->list);
154 hlist_del_rcu(&node->hash);
155 kfree_rcu(node, rcu);
158 void tipc_node_stop(struct net *net)
160 struct tipc_net *tn = net_generic(net, tipc_net_id);
161 struct tipc_node *node, *t_node;
163 spin_lock_bh(&tn->node_list_lock);
164 list_for_each_entry_safe(node, t_node, &tn->node_list, list)
166 spin_unlock_bh(&tn->node_list_lock);
169 int tipc_node_add_conn(struct net *net, u32 dnode, u32 port, u32 peer_port)
171 struct tipc_node *node;
172 struct tipc_sock_conn *conn;
175 if (in_own_node(net, dnode))
178 node = tipc_node_find(net, dnode);
180 pr_warn("Connecting sock to node 0x%x failed\n", dnode);
181 return -EHOSTUNREACH;
183 conn = kmalloc(sizeof(*conn), GFP_ATOMIC);
188 conn->peer_node = dnode;
190 conn->peer_port = peer_port;
192 tipc_node_lock(node);
193 list_add_tail(&conn->list, &node->conn_sks);
194 tipc_node_unlock(node);
200 void tipc_node_remove_conn(struct net *net, u32 dnode, u32 port)
202 struct tipc_node *node;
203 struct tipc_sock_conn *conn, *safe;
205 if (in_own_node(net, dnode))
208 node = tipc_node_find(net, dnode);
212 tipc_node_lock(node);
213 list_for_each_entry_safe(conn, safe, &node->conn_sks, list) {
214 if (port != conn->port)
216 list_del(&conn->list);
219 tipc_node_unlock(node);
224 * tipc_node_link_up - handle addition of link
226 * Link becomes active (alone or shared) or standby, depending on its priority.
228 void tipc_node_link_up(struct tipc_node *n, int bearer_id)
230 struct tipc_link_entry **actv = &n->active_links[0];
231 struct tipc_link_entry *le = &n->links[bearer_id];
232 struct tipc_link *l = le->link;
234 /* Leave room for tunnel header when returning 'mtu' to users: */
235 n->links[bearer_id].mtu = l->mtu - INT_H_SIZE;
238 n->action_flags |= TIPC_NOTIFY_LINK_UP;
239 n->link_id = l->peer_bearer_id << 16 | l->bearer_id;
241 pr_debug("Established link <%s> on network plane %c\n",
242 l->name, l->net_plane);
244 /* No active links ? => take both active slots */
248 node_established_contact(n);
251 if (l->priority < actv[0]->link->priority) {
252 pr_debug("New link <%s> becomes standby\n", l->name);
255 tipc_link_dup_queue_xmit(actv[0]->link, l);
257 /* Take one active slot if applicable */
258 if (l->priority == actv[0]->link->priority) {
262 /* Higher prio than current active? => take both active slots */
263 pr_debug("Old l <%s> becomes standby\n", actv[0]->link->name);
264 if (actv[1] != actv[0])
265 pr_debug("Old link <%s> now standby\n", actv[1]->link->name);
271 * node_select_active_links - select which working links should be active
273 static void node_select_active_links(struct tipc_node *n)
275 struct tipc_link_entry **actv = &n->active_links[0];
282 for (b = 0; b < MAX_BEARERS; b++) {
283 l = n->links[b].link;
284 if (!l || !tipc_link_is_up(l) || (l->priority < highest))
286 if (l->priority > highest) {
287 highest = l->priority;
288 actv[0] = &n->links[b];
289 actv[1] = &n->links[b];
292 actv[1] = &n->links[b];
297 * tipc_node_link_down - handle loss of link
299 void tipc_node_link_down(struct tipc_node *n, int bearer_id)
301 struct tipc_link_entry **actv = &n->active_links[0];
302 struct tipc_link_entry *le = &n->links[bearer_id];
303 struct tipc_link *l = le->link;
306 n->action_flags |= TIPC_NOTIFY_LINK_DOWN;
307 n->link_id = l->peer_bearer_id << 16 | l->bearer_id;
309 if (!tipc_link_is_active(l)) {
310 pr_debug("Lost standby link <%s> on network plane %c\n",
311 l->name, l->net_plane);
314 pr_debug("Lost link <%s> on network plane %c\n",
315 l->name, l->net_plane);
317 /* Resdistribute active slots if applicable */
323 /* Last link of this priority? => select other ones if available */
325 node_select_active_links(n);
327 if (tipc_node_is_up(n))
328 tipc_link_failover_send_queue(l);
330 node_lost_contact(n);
333 bool tipc_node_is_up(struct tipc_node *n)
335 return n->active_links[0];
338 void tipc_node_check_dest(struct tipc_node *n, struct tipc_bearer *b,
339 bool *link_up, bool *addr_match,
340 struct tipc_media_addr *maddr)
342 struct tipc_link *l = n->links[b->identity].link;
343 struct tipc_media_addr *curr = &n->links[b->identity].maddr;
345 *link_up = l && tipc_link_is_up(l);
346 *addr_match = l && !memcmp(curr, maddr, sizeof(*maddr));
349 bool tipc_node_update_dest(struct tipc_node *n, struct tipc_bearer *b,
350 struct tipc_media_addr *maddr)
352 struct tipc_link *l = n->links[b->identity].link;
353 struct tipc_media_addr *curr = &n->links[b->identity].maddr;
354 struct sk_buff_head *inputq = &n->links[b->identity].inputq;
357 l = tipc_link_create(n, b, maddr, inputq, &n->bclink.namedq);
360 memcpy(&l->media_addr, maddr, sizeof(*maddr));
361 memcpy(curr, maddr, sizeof(*maddr));
366 void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr)
368 n_ptr->links[l_ptr->bearer_id].link = l_ptr;
372 void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr)
376 for (i = 0; i < MAX_BEARERS; i++) {
377 if (l_ptr != n_ptr->links[i].link)
379 n_ptr->links[i].link = NULL;
384 static void node_established_contact(struct tipc_node *n_ptr)
386 n_ptr->action_flags |= TIPC_NOTIFY_NODE_UP;
387 n_ptr->bclink.oos_state = 0;
388 n_ptr->bclink.acked = tipc_bclink_get_last_sent(n_ptr->net);
389 tipc_bclink_add_node(n_ptr->net, n_ptr->addr);
392 static void node_lost_contact(struct tipc_node *n_ptr)
394 char addr_string[16];
395 struct tipc_sock_conn *conn, *safe;
396 struct list_head *conns = &n_ptr->conn_sks;
398 struct tipc_net *tn = net_generic(n_ptr->net, tipc_net_id);
401 pr_debug("Lost contact with %s\n",
402 tipc_addr_string_fill(addr_string, n_ptr->addr));
404 /* Flush broadcast link info associated with lost node */
405 if (n_ptr->bclink.recv_permitted) {
406 __skb_queue_purge(&n_ptr->bclink.deferdq);
408 if (n_ptr->bclink.reasm_buf) {
409 kfree_skb(n_ptr->bclink.reasm_buf);
410 n_ptr->bclink.reasm_buf = NULL;
413 tipc_bclink_remove_node(n_ptr->net, n_ptr->addr);
414 tipc_bclink_acknowledge(n_ptr, INVALID_LINK_SEQ);
416 n_ptr->bclink.recv_permitted = false;
419 /* Abort any ongoing link failover */
420 for (i = 0; i < MAX_BEARERS; i++) {
421 struct tipc_link *l_ptr = n_ptr->links[i].link;
424 l_ptr->flags &= ~LINK_FAILINGOVER;
425 l_ptr->failover_checkpt = 0;
426 l_ptr->failover_pkts = 0;
427 kfree_skb(l_ptr->failover_skb);
428 l_ptr->failover_skb = NULL;
429 tipc_link_reset_fragments(l_ptr);
432 n_ptr->action_flags &= ~TIPC_WAIT_OWN_LINKS_DOWN;
434 /* Prevent re-contact with node until cleanup is done */
435 n_ptr->action_flags |= TIPC_WAIT_PEER_LINKS_DOWN;
437 /* Notify publications from this node */
438 n_ptr->action_flags |= TIPC_NOTIFY_NODE_DOWN;
440 /* Notify sockets connected to node */
441 list_for_each_entry_safe(conn, safe, conns, list) {
442 skb = tipc_msg_create(TIPC_CRITICAL_IMPORTANCE, TIPC_CONN_MSG,
443 SHORT_H_SIZE, 0, tn->own_addr,
444 conn->peer_node, conn->port,
445 conn->peer_port, TIPC_ERR_NO_NODE);
447 skb_queue_tail(n_ptr->inputq, skb);
448 n_ptr->action_flags |= TIPC_MSG_EVT;
450 list_del(&conn->list);
456 * tipc_node_get_linkname - get the name of a link
458 * @bearer_id: id of the bearer
459 * @node: peer node address
460 * @linkname: link name output buffer
462 * Returns 0 on success
464 int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 addr,
465 char *linkname, size_t len)
467 struct tipc_link *link;
469 struct tipc_node *node = tipc_node_find(net, addr);
474 if (bearer_id >= MAX_BEARERS)
477 tipc_node_lock(node);
478 link = node->links[bearer_id].link;
480 strncpy(linkname, link->name, len);
484 tipc_node_unlock(node);
489 void tipc_node_unlock(struct tipc_node *node)
491 struct net *net = node->net;
493 u32 flags = node->action_flags;
495 struct list_head *publ_list;
496 struct sk_buff_head *inputq = node->inputq;
497 struct sk_buff_head *namedq;
499 if (likely(!flags || (flags == TIPC_MSG_EVT))) {
500 node->action_flags = 0;
501 spin_unlock_bh(&node->lock);
502 if (flags == TIPC_MSG_EVT)
503 tipc_sk_rcv(net, inputq);
508 link_id = node->link_id;
509 namedq = node->namedq;
510 publ_list = &node->publ_list;
512 node->action_flags &= ~(TIPC_MSG_EVT |
513 TIPC_NOTIFY_NODE_DOWN | TIPC_NOTIFY_NODE_UP |
514 TIPC_NOTIFY_LINK_DOWN | TIPC_NOTIFY_LINK_UP |
515 TIPC_WAKEUP_BCAST_USERS | TIPC_BCAST_MSG_EVT |
516 TIPC_NAMED_MSG_EVT | TIPC_BCAST_RESET);
518 spin_unlock_bh(&node->lock);
520 if (flags & TIPC_NOTIFY_NODE_DOWN)
521 tipc_publ_notify(net, publ_list, addr);
523 if (flags & TIPC_WAKEUP_BCAST_USERS)
524 tipc_bclink_wakeup_users(net);
526 if (flags & TIPC_NOTIFY_NODE_UP)
527 tipc_named_node_up(net, addr);
529 if (flags & TIPC_NOTIFY_LINK_UP)
530 tipc_nametbl_publish(net, TIPC_LINK_STATE, addr, addr,
531 TIPC_NODE_SCOPE, link_id, addr);
533 if (flags & TIPC_NOTIFY_LINK_DOWN)
534 tipc_nametbl_withdraw(net, TIPC_LINK_STATE, addr,
537 if (flags & TIPC_MSG_EVT)
538 tipc_sk_rcv(net, inputq);
540 if (flags & TIPC_NAMED_MSG_EVT)
541 tipc_named_rcv(net, namedq);
543 if (flags & TIPC_BCAST_MSG_EVT)
544 tipc_bclink_input(net);
546 if (flags & TIPC_BCAST_RESET)
547 tipc_link_reset_all(node);
550 /* Caller should hold node lock for the passed node */
551 static int __tipc_nl_add_node(struct tipc_nl_msg *msg, struct tipc_node *node)
554 struct nlattr *attrs;
556 hdr = genlmsg_put(msg->skb, msg->portid, msg->seq, &tipc_genl_family,
557 NLM_F_MULTI, TIPC_NL_NODE_GET);
561 attrs = nla_nest_start(msg->skb, TIPC_NLA_NODE);
565 if (nla_put_u32(msg->skb, TIPC_NLA_NODE_ADDR, node->addr))
567 if (tipc_node_is_up(node))
568 if (nla_put_flag(msg->skb, TIPC_NLA_NODE_UP))
571 nla_nest_end(msg->skb, attrs);
572 genlmsg_end(msg->skb, hdr);
577 nla_nest_cancel(msg->skb, attrs);
579 genlmsg_cancel(msg->skb, hdr);
584 int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb)
587 struct net *net = sock_net(skb->sk);
588 struct tipc_net *tn = net_generic(net, tipc_net_id);
589 int done = cb->args[0];
590 int last_addr = cb->args[1];
591 struct tipc_node *node;
592 struct tipc_nl_msg msg;
598 msg.portid = NETLINK_CB(cb->skb).portid;
599 msg.seq = cb->nlh->nlmsg_seq;
603 node = tipc_node_find(net, last_addr);
606 /* We never set seq or call nl_dump_check_consistent()
607 * this means that setting prev_seq here will cause the
608 * consistence check to fail in the netlink callback
609 * handler. Resulting in the NLMSG_DONE message having
610 * the NLM_F_DUMP_INTR flag set if the node state
611 * changed while we released the lock.
619 list_for_each_entry_rcu(node, &tn->node_list, list) {
621 if (node->addr == last_addr)
627 tipc_node_lock(node);
628 err = __tipc_nl_add_node(&msg, node);
630 last_addr = node->addr;
631 tipc_node_unlock(node);
635 tipc_node_unlock(node);
640 cb->args[1] = last_addr;