]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - net/tipc/node.h
tipc: move received discovery data evaluation inside node.c
[mirror_ubuntu-zesty-kernel.git] / net / tipc / node.h
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
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 "addr.h"
41 #include "net.h"
42 #include "bearer.h"
43 #include "msg.h"
44
45 /* Out-of-range value for node signature */
46 #define INVALID_NODE_SIG 0x10000
47
48 #define INVALID_BEARER_ID -1
49
50 /* Flags used to take different actions according to flag type
51 * TIPC_NOTIFY_NODE_DOWN: notify node is down
52 * TIPC_NOTIFY_NODE_UP: notify node is up
53 * TIPC_DISTRIBUTE_NAME: publish or withdraw link state name type
54 */
55 enum {
56 TIPC_MSG_EVT = 1,
57 TIPC_NOTIFY_NODE_DOWN = (1 << 3),
58 TIPC_NOTIFY_NODE_UP = (1 << 4),
59 TIPC_WAKEUP_BCAST_USERS = (1 << 5),
60 TIPC_NOTIFY_LINK_UP = (1 << 6),
61 TIPC_NOTIFY_LINK_DOWN = (1 << 7),
62 TIPC_NAMED_MSG_EVT = (1 << 8),
63 TIPC_BCAST_MSG_EVT = (1 << 9),
64 TIPC_BCAST_RESET = (1 << 10)
65 };
66
67 /**
68 * struct tipc_node_bclink - TIPC node bclink structure
69 * @acked: sequence # of last outbound b'cast message acknowledged by node
70 * @last_in: sequence # of last in-sequence b'cast message received from node
71 * @last_sent: sequence # of last b'cast message sent by node
72 * @oos_state: state tracker for handling OOS b'cast messages
73 * @deferred_queue: deferred queue saved OOS b'cast message received from node
74 * @reasm_buf: broadcast reassembly queue head from node
75 * @inputq_map: bitmap indicating which inqueues should be kicked
76 * @recv_permitted: true if node is allowed to receive b'cast messages
77 */
78 struct tipc_node_bclink {
79 u32 acked;
80 u32 last_in;
81 u32 last_sent;
82 u32 oos_state;
83 u32 deferred_size;
84 struct sk_buff_head deferdq;
85 struct sk_buff *reasm_buf;
86 struct sk_buff_head namedq;
87 bool recv_permitted;
88 };
89
90 struct tipc_link_entry {
91 struct tipc_link *link;
92 u32 mtu;
93 struct sk_buff_head inputq;
94 struct tipc_media_addr maddr;
95 };
96
97 /**
98 * struct tipc_node - TIPC node structure
99 * @addr: network address of node
100 * @ref: reference counter to node object
101 * @lock: spinlock governing access to structure
102 * @net: the applicable net namespace
103 * @hash: links to adjacent nodes in unsorted hash chain
104 * @inputq: pointer to input queue containing messages for msg event
105 * @namedq: pointer to name table input queue with name table messages
106 * @active_links: bearer ids of active links, used as index into links[] array
107 * @links: array containing references to all links to node
108 * @action_flags: bit mask of different types of node actions
109 * @bclink: broadcast-related info
110 * @state: connectivity state vs peer node
111 * @sync_point: sequence number where synch/failover is finished
112 * @list: links to adjacent nodes in sorted list of cluster's nodes
113 * @working_links: number of working links to node (both active and standby)
114 * @link_cnt: number of links to node
115 * @capabilities: bitmap, indicating peer node's functional capabilities
116 * @signature: node instance identifier
117 * @link_id: local and remote bearer ids of changing link, if any
118 * @publ_list: list of publications
119 * @rcu: rcu struct for tipc_node
120 */
121 struct tipc_node {
122 u32 addr;
123 struct kref kref;
124 spinlock_t lock;
125 struct net *net;
126 struct hlist_node hash;
127 struct sk_buff_head *inputq;
128 struct sk_buff_head *namedq;
129 int active_links[2];
130 struct tipc_link_entry links[MAX_BEARERS];
131 int action_flags;
132 struct tipc_node_bclink bclink;
133 struct list_head list;
134 int state;
135 u16 sync_point;
136 int link_cnt;
137 u16 working_links;
138 u16 capabilities;
139 u32 signature;
140 u32 link_id;
141 struct list_head publ_list;
142 struct list_head conn_sks;
143 unsigned long keepalive_intv;
144 struct timer_list timer;
145 struct rcu_head rcu;
146 };
147
148 struct tipc_node *tipc_node_find(struct net *net, u32 addr);
149 void tipc_node_put(struct tipc_node *node);
150 void tipc_node_stop(struct net *net);
151 void tipc_node_check_dest(struct net *net, u32 onode,
152 struct tipc_bearer *bearer,
153 u16 capabilities, u32 signature,
154 struct tipc_media_addr *maddr,
155 bool *respond, bool *dupl_addr);
156 void tipc_node_delete_links(struct net *net, int bearer_id);
157 void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
158 void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
159 bool tipc_node_is_up(struct tipc_node *n);
160 int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 node,
161 char *linkname, size_t len);
162 void tipc_node_unlock(struct tipc_node *node);
163 int tipc_node_xmit(struct net *net, struct sk_buff_head *list, u32 dnode,
164 int selector);
165 int tipc_node_xmit_skb(struct net *net, struct sk_buff *skb, u32 dest,
166 u32 selector);
167 int tipc_node_add_conn(struct net *net, u32 dnode, u32 port, u32 peer_port);
168 void tipc_node_remove_conn(struct net *net, u32 dnode, u32 port);
169 int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb);
170
171 static inline void tipc_node_lock(struct tipc_node *node)
172 {
173 spin_lock_bh(&node->lock);
174 }
175
176 static inline struct tipc_link *node_active_link(struct tipc_node *n, int sel)
177 {
178 int bearer_id = n->active_links[sel & 1];
179
180 if (unlikely(bearer_id == INVALID_BEARER_ID))
181 return NULL;
182
183 return n->links[bearer_id].link;
184 }
185
186 static inline unsigned int tipc_node_get_mtu(struct net *net, u32 addr, u32 sel)
187 {
188 struct tipc_node *n;
189 int bearer_id;
190 unsigned int mtu = MAX_MSG_SIZE;
191
192 n = tipc_node_find(net, addr);
193 if (unlikely(!n))
194 return mtu;
195
196 bearer_id = n->active_links[sel & 1];
197 if (likely(bearer_id != INVALID_BEARER_ID))
198 mtu = n->links[bearer_id].mtu;
199 tipc_node_put(n);
200 return mtu;
201 }
202
203 #endif