1/*
2 * net/tipc/node.h: Include file for TIPC node management routines
3 *
4 * Copyright (c) 2000-2006, Ericsson AB
5 * Copyright (c) 2005, 2010-2014, Wind River Systems
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
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.
19 *
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.
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
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_NODE_H
38#define _TIPC_NODE_H
39
40#include "node_subscr.h"
41#include "addr.h"
42#include "net.h"
43#include "bearer.h"
44#include "msg.h"
45
46/*
47 * Out-of-range value for node signature
48 */
49#define INVALID_NODE_SIG 0x10000
50
51/* Flags used to take different actions according to flag type
52 * TIPC_WAIT_PEER_LINKS_DOWN: wait to see that peer's links are down
53 * TIPC_WAIT_OWN_LINKS_DOWN: wait until peer node is declared down
54 * TIPC_NOTIFY_NODE_DOWN: notify node is down
55 * TIPC_NOTIFY_NODE_UP: notify node is up
56 * TIPC_DISTRIBUTE_NAME: publish or withdraw link state name type
57 */
58enum {
59	TIPC_WAIT_PEER_LINKS_DOWN	= (1 << 1),
60	TIPC_WAIT_OWN_LINKS_DOWN	= (1 << 2),
61	TIPC_NOTIFY_NODE_DOWN		= (1 << 3),
62	TIPC_NOTIFY_NODE_UP		= (1 << 4),
63	TIPC_WAKEUP_USERS		= (1 << 5),
64	TIPC_WAKEUP_BCAST_USERS		= (1 << 6),
65	TIPC_NOTIFY_LINK_UP		= (1 << 7),
66	TIPC_NOTIFY_LINK_DOWN		= (1 << 8)
67};
68
69/**
70 * 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
75 * @deferred_size: number of OOS b'cast messages in deferred queue
76 * @deferred_head: oldest OOS b'cast message received from node
77 * @deferred_tail: newest OOS b'cast message received from node
78 * @reasm_buf: broadcast reassembly queue head from node
79 * @recv_permitted: true if node is allowed to receive b'cast messages
80 */
81struct tipc_node_bclink {
82	u32 acked;
83	u32 last_in;
84	u32 last_sent;
85	u32 oos_state;
86	u32 deferred_size;
87	struct sk_buff *deferred_head;
88	struct sk_buff *deferred_tail;
89	struct sk_buff *reasm_buf;
90	bool recv_permitted;
91};
92
93/**
94 * struct tipc_node - TIPC node structure
95 * @addr: network address of node
96 * @lock: spinlock governing access to structure
97 * @hash: links to adjacent nodes in unsorted hash chain
98 * @active_links: pointers to active links to node
99 * @links: pointers to all links to node
100 * @action_flags: bit mask of different types of node actions
101 * @bclink: broadcast-related info
102 * @list: links to adjacent nodes in sorted list of cluster's nodes
103 * @working_links: number of working links to node (both active and standby)
104 * @link_cnt: number of links to node
105 * @signature: node instance identifier
106 * @link_id: local and remote bearer ids of changing link, if any
107 * @nsub: list of "node down" subscriptions monitoring node
108 * @rcu: rcu struct for tipc_node
109 */
110struct tipc_node {
111	u32 addr;
112	spinlock_t lock;
113	struct hlist_node hash;
114	struct tipc_link *active_links[2];
115	u32 act_mtus[2];
116	struct tipc_link *links[MAX_BEARERS];
117	unsigned int action_flags;
118	struct tipc_node_bclink bclink;
119	struct list_head list;
120	int link_cnt;
121	int working_links;
122	u32 signature;
123	u32 link_id;
124	struct list_head nsub;
125	struct sk_buff_head waiting_sks;
126	struct list_head conn_sks;
127	struct rcu_head rcu;
128};
129
130extern struct list_head tipc_node_list;
131
132struct tipc_node *tipc_node_find(u32 addr);
133struct tipc_node *tipc_node_create(u32 addr);
134void tipc_node_stop(void);
135void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
136void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
137void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
138void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
139int tipc_node_active_links(struct tipc_node *n_ptr);
140int tipc_node_is_up(struct tipc_node *n_ptr);
141struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
142struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
143int tipc_node_get_linkname(u32 bearer_id, u32 node, char *linkname, size_t len);
144void tipc_node_unlock(struct tipc_node *node);
145int tipc_node_add_conn(u32 dnode, u32 port, u32 peer_port);
146void tipc_node_remove_conn(u32 dnode, u32 port);
147
148static inline void tipc_node_lock(struct tipc_node *node)
149{
150	spin_lock_bh(&node->lock);
151}
152
153static inline bool tipc_node_blocked(struct tipc_node *node)
154{
155	return (node->action_flags & (TIPC_WAIT_PEER_LINKS_DOWN |
156		TIPC_NOTIFY_NODE_DOWN | TIPC_WAIT_OWN_LINKS_DOWN));
157}
158
159static inline uint tipc_node_get_mtu(u32 addr, u32 selector)
160{
161	struct tipc_node *node;
162	u32 mtu;
163
164	node = tipc_node_find(addr);
165
166	if (likely(node))
167		mtu = node->act_mtus[selector & 1];
168	else
169		mtu = MAX_MSG_SIZE;
170
171	return mtu;
172}
173
174#endif
175