node.h 7.14 KB
Newer Older
Per Liden's avatar
Per Liden committed
1
2
/*
 * net/tipc/node.h: Include file for TIPC node management routines
3
 *
4
 * Copyright (c) 2000-2006, 2014-2015, Ericsson AB
5
 * Copyright (c) 2005, 2010-2014, Wind River Systems
Per Liden's avatar
Per Liden committed
6
7
 * All rights reserved.
 *
Per Liden's avatar
Per Liden committed
8
 * Redistribution and use in source and binary forms, with or without
Per Liden's avatar
Per Liden committed
9
10
 * modification, are permitted provided that the following conditions are met:
 *
Per Liden's avatar
Per Liden committed
11
12
13
14
15
16
17
18
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
Per Liden's avatar
Per Liden committed
19
 *
Per Liden's avatar
Per Liden committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Per Liden's avatar
Per Liden committed
34
35
36
37
38
39
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _TIPC_NODE_H
#define _TIPC_NODE_H

40
41
#include "addr.h"
#include "net.h"
Per Liden's avatar
Per Liden committed
42
#include "bearer.h"
43
#include "msg.h"
Per Liden's avatar
Per Liden committed
44

45
46
47
/* Out-of-range value for node signature */
#define INVALID_NODE_SIG	0x10000

48
49
50
51
52
/* Flags used to take different actions according to flag type
 * TIPC_WAIT_PEER_LINKS_DOWN: wait to see that peer's links are down
 * TIPC_WAIT_OWN_LINKS_DOWN: wait until peer node is declared down
 * TIPC_NOTIFY_NODE_DOWN: notify node is down
 * TIPC_NOTIFY_NODE_UP: notify node is up
Ying Xue's avatar
Ying Xue committed
53
 * TIPC_DISTRIBUTE_NAME: publish or withdraw link state name type
54
55
 */
enum {
56
	TIPC_MSG_EVT                    = 1,
57
58
59
	TIPC_WAIT_PEER_LINKS_DOWN	= (1 << 1),
	TIPC_WAIT_OWN_LINKS_DOWN	= (1 << 2),
	TIPC_NOTIFY_NODE_DOWN		= (1 << 3),
60
	TIPC_NOTIFY_NODE_UP		= (1 << 4),
61
62
63
	TIPC_WAKEUP_BCAST_USERS		= (1 << 5),
	TIPC_NOTIFY_LINK_UP		= (1 << 6),
	TIPC_NOTIFY_LINK_DOWN		= (1 << 7),
64
	TIPC_NAMED_MSG_EVT		= (1 << 8),
65
66
	TIPC_BCAST_MSG_EVT		= (1 << 9),
	TIPC_BCAST_RESET		= (1 << 10)
67
};
68

69
70
71
72
73
74
/**
 * struct tipc_node_bclink - TIPC node bclink structure
 * @acked: sequence # of last outbound b'cast message acknowledged by node
 * @last_in: sequence # of last in-sequence b'cast message received from node
 * @last_sent: sequence # of last b'cast message sent by node
 * @oos_state: state tracker for handling OOS b'cast messages
75
 * @deferred_queue: deferred queue saved OOS b'cast message received from node
76
 * @reasm_buf: broadcast reassembly queue head from node
77
 * @inputq_map: bitmap indicating which inqueues should be kicked
78
79
80
81
82
83
84
85
 * @recv_permitted: true if node is allowed to receive b'cast messages
 */
struct tipc_node_bclink {
	u32 acked;
	u32 last_in;
	u32 last_sent;
	u32 oos_state;
	u32 deferred_size;
Jon Paul Maloy's avatar
Jon Paul Maloy committed
86
	struct sk_buff_head deferdq;
87
	struct sk_buff *reasm_buf;
88
	int inputq_map;
89
90
91
	bool recv_permitted;
};

92
93
94
struct tipc_link_entry {
	struct tipc_link *link;
	u32 mtu;
95
	struct tipc_media_addr maddr;
96
97
};

Per Liden's avatar
Per Liden committed
98
/**
99
 * struct tipc_node - TIPC node structure
Per Liden's avatar
Per Liden committed
100
 * @addr: network address of node
101
 * @ref: reference counter to node object
Per Liden's avatar
Per Liden committed
102
 * @lock: spinlock governing access to structure
103
 * @net: the applicable net namespace
104
 * @hash: links to adjacent nodes in unsorted hash chain
105
106
 * @inputq: pointer to input queue containing messages for msg event
 * @namedq: pointer to name table input queue with name table messages
107
108
 * @active_links: pointer into links[] array, identifying which links are active
 * @links: array containing references to all links to node
109
 * @action_flags: bit mask of different types of node actions
110
111
112
 * @bclink: broadcast-related info
 * @list: links to adjacent nodes in sorted list of cluster's nodes
 * @working_links: number of working links to node (both active and standby)
Per Liden's avatar
Per Liden committed
113
 * @link_cnt: number of links to node
114
 * @capabilities: bitmap, indicating peer node's functional capabilities
115
 * @signature: node instance identifier
Ying Xue's avatar
Ying Xue committed
116
 * @link_id: local and remote bearer ids of changing link, if any
117
 * @publ_list: list of publications
118
 * @rcu: rcu struct for tipc_node
Per Liden's avatar
Per Liden committed
119
 */
120
struct tipc_node {
Per Liden's avatar
Per Liden committed
121
	u32 addr;
122
	struct kref kref;
Per Liden's avatar
Per Liden committed
123
	spinlock_t lock;
124
	struct net *net;
125
	struct hlist_node hash;
126
127
	struct sk_buff_head *inputq;
	struct sk_buff_head *namedq;
128
129
	struct tipc_link_entry *active_links[2];
	struct tipc_link_entry links[MAX_BEARERS];
130
	int action_flags;
131
132
	struct tipc_node_bclink bclink;
	struct list_head list;
Per Liden's avatar
Per Liden committed
133
	int link_cnt;
134
135
	u16 working_links;
	u16 capabilities;
136
	u32 signature;
Ying Xue's avatar
Ying Xue committed
137
	u32 link_id;
138
	struct list_head publ_list;
139
	struct list_head conn_sks;
140
	struct rcu_head rcu;
Per Liden's avatar
Per Liden committed
141
142
};

143
struct tipc_node *tipc_node_find(struct net *net, u32 addr);
144
void tipc_node_put(struct tipc_node *node);
145
146
struct tipc_node *tipc_node_create(struct net *net, u32 addr);
void tipc_node_stop(struct net *net);
147
148
149
150
151
void tipc_node_check_dest(struct tipc_node *n, struct tipc_bearer *bearer,
			  bool *link_up, bool *addr_match,
			  struct tipc_media_addr *maddr);
bool tipc_node_update_dest(struct tipc_node *n, struct tipc_bearer *bearer,
			   struct tipc_media_addr *maddr);
152
153
void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
154
155
156
void tipc_node_link_down(struct tipc_node *n_ptr, int bearer_id);
void tipc_node_link_up(struct tipc_node *n_ptr, int bearer_id);
bool tipc_node_is_up(struct tipc_node *n);
157
158
int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 node,
			   char *linkname, size_t len);
159
void tipc_node_unlock(struct tipc_node *node);
160
161
int tipc_node_add_conn(struct net *net, u32 dnode, u32 port, u32 peer_port);
void tipc_node_remove_conn(struct net *net, u32 dnode, u32 port);
Per Liden's avatar
Per Liden committed
162

163
164
int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb);

165
static inline void tipc_node_lock(struct tipc_node *node)
Per Liden's avatar
Per Liden committed
166
{
167
	spin_lock_bh(&node->lock);
Per Liden's avatar
Per Liden committed
168
169
}

170
171
static inline bool tipc_node_blocked(struct tipc_node *node)
{
172
173
	return (node->action_flags & (TIPC_WAIT_PEER_LINKS_DOWN |
		TIPC_NOTIFY_NODE_DOWN | TIPC_WAIT_OWN_LINKS_DOWN));
174
175
}

176
static inline struct tipc_link *node_active_link(struct tipc_node *n, int sel)
177
{
178
	struct tipc_link_entry *le = n->active_links[sel & 1];
179

180
181
182
183
	if (likely(le))
		return le->link;
	return NULL;
}
184

185
186
187
188
189
static inline uint tipc_node_get_mtu(struct net *net, u32 addr, u32 selector)
{
	struct tipc_node *n;
	struct tipc_link_entry *le;
	unsigned int mtu = MAX_MSG_SIZE;
190

191
192
193
194
195
196
197
	n = tipc_node_find(net, addr);
	if (unlikely(!n))
		return mtu;
	le = n->active_links[selector & 1];
	if (likely(le))
		mtu = le->mtu;
	tipc_node_put(n);
198
199
200
	return mtu;
}

Per Liden's avatar
Per Liden committed
201
#endif