blob: 5a834cf142c8432fc4b5d65ab9ada044b342f438 [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/node.h: Include file for TIPC node management routines
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Jon Paul Maloycb1b7282015-02-05 08:36:44 -05004 * Copyright (c) 2000-2006, 2014-2015, Ericsson AB
Ying Xue46651c52014-03-27 12:54:36 +08005 * Copyright (c) 2005, 2010-2014, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_NODE_H
38#define _TIPC_NODE_H
39
Allan Stephens8f92df62010-12-31 18:59:19 +000040#include "addr.h"
41#include "net.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010042#include "bearer.h"
Jon Paul Maloy16e166b2014-06-25 20:41:33 -050043#include "msg.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010044
Ying Xuef2f98002015-01-09 15:27:05 +080045/* Out-of-range value for node signature */
46#define INVALID_NODE_SIG 0x10000
47
Ying Xueaecb9bb2014-05-08 08:54:39 +080048/* Flags used to take different actions according to flag type
49 * TIPC_WAIT_PEER_LINKS_DOWN: wait to see that peer's links are down
50 * TIPC_WAIT_OWN_LINKS_DOWN: wait until peer node is declared down
51 * TIPC_NOTIFY_NODE_DOWN: notify node is down
52 * TIPC_NOTIFY_NODE_UP: notify node is up
Ying Xue7b8613e2014-10-20 14:44:25 +080053 * TIPC_DISTRIBUTE_NAME: publish or withdraw link state name type
Ying Xue10f465c2014-05-05 08:56:11 +080054 */
55enum {
Jon Paul Maloyc637c102015-02-05 08:36:41 -050056 TIPC_MSG_EVT = 1,
Ying Xueaecb9bb2014-05-08 08:54:39 +080057 TIPC_WAIT_PEER_LINKS_DOWN = (1 << 1),
58 TIPC_WAIT_OWN_LINKS_DOWN = (1 << 2),
59 TIPC_NOTIFY_NODE_DOWN = (1 << 3),
Jon Paul Maloy50100a52014-08-22 18:09:07 -040060 TIPC_NOTIFY_NODE_UP = (1 << 4),
Jon Paul Maloyc637c102015-02-05 08:36:41 -050061 TIPC_WAKEUP_BCAST_USERS = (1 << 5),
62 TIPC_NOTIFY_LINK_UP = (1 << 6),
63 TIPC_NOTIFY_LINK_DOWN = (1 << 7),
Jon Paul Maloycb1b7282015-02-05 08:36:44 -050064 TIPC_NAMED_MSG_EVT = (1 << 8),
Ying Xueb952b2b2015-03-26 18:10:23 +080065 TIPC_BCAST_MSG_EVT = (1 << 9),
66 TIPC_BCAST_RESET = (1 << 10)
Ying Xue10f465c2014-05-05 08:56:11 +080067};
Allan Stephensb4b56102011-05-27 11:00:51 -040068
Per Lidenb97bf3f2006-01-02 19:04:38 +010069/**
Ying Xue486f9302014-05-05 08:56:10 +080070 * struct tipc_node_bclink - TIPC node bclink structure
71 * @acked: sequence # of last outbound b'cast message acknowledged by node
72 * @last_in: sequence # of last in-sequence b'cast message received from node
73 * @last_sent: sequence # of last b'cast message sent by node
74 * @oos_state: state tracker for handling OOS b'cast messages
Ying Xuebc6fecd2014-11-26 11:41:53 +080075 * @deferred_queue: deferred queue saved OOS b'cast message received from node
Jon Paul Maloy37e22162014-05-14 05:39:12 -040076 * @reasm_buf: broadcast reassembly queue head from node
Jon Paul Maloycb1b7282015-02-05 08:36:44 -050077 * @inputq_map: bitmap indicating which inqueues should be kicked
Ying Xue486f9302014-05-05 08:56:10 +080078 * @recv_permitted: true if node is allowed to receive b'cast messages
79 */
80struct tipc_node_bclink {
81 u32 acked;
82 u32 last_in;
83 u32 last_sent;
84 u32 oos_state;
85 u32 deferred_size;
Jon Paul Maloy05dcc5a2015-03-13 16:08:10 -040086 struct sk_buff_head deferdq;
Jon Paul Maloy37e22162014-05-14 05:39:12 -040087 struct sk_buff *reasm_buf;
Jon Paul Maloycb1b7282015-02-05 08:36:44 -050088 int inputq_map;
Ying Xue486f9302014-05-05 08:56:10 +080089 bool recv_permitted;
90};
91
92/**
David S. Miller6c000552008-09-02 23:38:32 -070093 * struct tipc_node - TIPC node structure
Per Lidenb97bf3f2006-01-02 19:04:38 +010094 * @addr: network address of node
Ying Xue8a0f6eb2015-03-26 18:10:24 +080095 * @ref: reference counter to node object
Per Lidenb97bf3f2006-01-02 19:04:38 +010096 * @lock: spinlock governing access to structure
Ying Xuef2f98002015-01-09 15:27:05 +080097 * @net: the applicable net namespace
Allan Stephens672d99e2011-02-25 18:42:52 -050098 * @hash: links to adjacent nodes in unsorted hash chain
Jon Paul Maloyc637c102015-02-05 08:36:41 -050099 * @inputq: pointer to input queue containing messages for msg event
100 * @namedq: pointer to name table input queue with name table messages
101 * @curr_link: the link holding the node lock, if any
Per Lidenb97bf3f2006-01-02 19:04:38 +0100102 * @active_links: pointers to active links to node
103 * @links: pointers to all links to node
Ying Xueaecb9bb2014-05-08 08:54:39 +0800104 * @action_flags: bit mask of different types of node actions
Ying Xue486f9302014-05-05 08:56:10 +0800105 * @bclink: broadcast-related info
106 * @list: links to adjacent nodes in sorted list of cluster's nodes
107 * @working_links: number of working links to node (both active and standby)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100108 * @link_cnt: number of links to node
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400109 * @capabilities: bitmap, indicating peer node's functional capabilities
Allan Stephensfc0eea62011-10-28 16:26:41 -0400110 * @signature: node instance identifier
Ying Xue7b8613e2014-10-20 14:44:25 +0800111 * @link_id: local and remote bearer ids of changing link, if any
Ying Xuea8f48af2014-11-26 11:41:45 +0800112 * @publ_list: list of publications
Ying Xue6c7a7622014-03-27 12:54:37 +0800113 * @rcu: rcu struct for tipc_node
Per Lidenb97bf3f2006-01-02 19:04:38 +0100114 */
David S. Miller6c000552008-09-02 23:38:32 -0700115struct tipc_node {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100116 u32 addr;
Ying Xue8a0f6eb2015-03-26 18:10:24 +0800117 struct kref kref;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100118 spinlock_t lock;
Ying Xuef2f98002015-01-09 15:27:05 +0800119 struct net *net;
Allan Stephens672d99e2011-02-25 18:42:52 -0500120 struct hlist_node hash;
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500121 struct sk_buff_head *inputq;
122 struct sk_buff_head *namedq;
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500123 struct tipc_link *active_links[2];
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500124 u32 act_mtus[2];
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500125 struct tipc_link *links[MAX_BEARERS];
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500126 int action_flags;
Ying Xue486f9302014-05-05 08:56:10 +0800127 struct tipc_node_bclink bclink;
128 struct list_head list;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100129 int link_cnt;
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400130 u16 working_links;
131 u16 capabilities;
Allan Stephensfc0eea62011-10-28 16:26:41 -0400132 u32 signature;
Ying Xue7b8613e2014-10-20 14:44:25 +0800133 u32 link_id;
Ying Xuea8f48af2014-11-26 11:41:45 +0800134 struct list_head publ_list;
Jon Paul Maloy02be61a2014-08-22 18:09:08 -0400135 struct list_head conn_sks;
Ying Xue6c7a7622014-03-27 12:54:37 +0800136 struct rcu_head rcu;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100137};
138
Ying Xuef2f98002015-01-09 15:27:05 +0800139struct tipc_node *tipc_node_find(struct net *net, u32 addr);
Ying Xue8a0f6eb2015-03-26 18:10:24 +0800140void tipc_node_put(struct tipc_node *node);
Ying Xuef2f98002015-01-09 15:27:05 +0800141struct tipc_node *tipc_node_create(struct net *net, u32 addr);
142void tipc_node_stop(struct net *net);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500143void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
144void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
145void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
146void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
Paul Gortmaker8f19afb2011-02-28 11:36:21 -0400147int tipc_node_active_links(struct tipc_node *n_ptr);
David S. Miller6c000552008-09-02 23:38:32 -0700148int tipc_node_is_up(struct tipc_node *n_ptr);
Ying Xuef2f98002015-01-09 15:27:05 +0800149int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 node,
150 char *linkname, size_t len);
Ying Xue9db9fdd2014-05-05 08:56:12 +0800151void tipc_node_unlock(struct tipc_node *node);
Ying Xuef2f98002015-01-09 15:27:05 +0800152int tipc_node_add_conn(struct net *net, u32 dnode, u32 port, u32 peer_port);
153void tipc_node_remove_conn(struct net *net, u32 dnode, u32 port);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100154
Richard Alpe3e4b6ab2014-11-20 10:29:17 +0100155int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb);
156
Ying Xue9db9fdd2014-05-05 08:56:12 +0800157static inline void tipc_node_lock(struct tipc_node *node)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100158{
Ying Xue9db9fdd2014-05-05 08:56:12 +0800159 spin_lock_bh(&node->lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100160}
161
Ying Xue10f465c2014-05-05 08:56:11 +0800162static inline bool tipc_node_blocked(struct tipc_node *node)
163{
Ying Xueaecb9bb2014-05-08 08:54:39 +0800164 return (node->action_flags & (TIPC_WAIT_PEER_LINKS_DOWN |
165 TIPC_NOTIFY_NODE_DOWN | TIPC_WAIT_OWN_LINKS_DOWN));
Ying Xue10f465c2014-05-05 08:56:11 +0800166}
167
Ying Xuef2f98002015-01-09 15:27:05 +0800168static inline uint tipc_node_get_mtu(struct net *net, u32 addr, u32 selector)
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500169{
170 struct tipc_node *node;
171 u32 mtu;
172
Ying Xuef2f98002015-01-09 15:27:05 +0800173 node = tipc_node_find(net, addr);
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500174
Ying Xue8a0f6eb2015-03-26 18:10:24 +0800175 if (likely(node)) {
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500176 mtu = node->act_mtus[selector & 1];
Ying Xue8a0f6eb2015-03-26 18:10:24 +0800177 tipc_node_put(node);
178 } else {
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500179 mtu = MAX_MSG_SIZE;
Ying Xue8a0f6eb2015-03-26 18:10:24 +0800180 }
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500181
182 return mtu;
183}
184
Per Lidenb97bf3f2006-01-02 19:04:38 +0100185#endif