Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/node.h: Include file for TIPC node management routines | |
c4307285 | 3 | * |
cb1b7280 | 4 | * Copyright (c) 2000-2006, 2014-2015, Ericsson AB |
46651c59 | 5 | * Copyright (c) 2005, 2010-2014, Wind River Systems |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
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. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
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 | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #ifndef _TIPC_NODE_H | |
38 | #define _TIPC_NODE_H | |
39 | ||
8f92df6a AS |
40 | #include "addr.h" |
41 | #include "net.h" | |
b97bf3fd | 42 | #include "bearer.h" |
16e166b8 | 43 | #include "msg.h" |
b97bf3fd | 44 | |
f2f9800d YX |
45 | /* Out-of-range value for node signature */ |
46 | #define INVALID_NODE_SIG 0x10000 | |
47 | ||
36e78a46 JPM |
48 | #define INVALID_BEARER_ID -1 |
49 | ||
1a20cc25 JPM |
50 | /* Node FSM states and events: |
51 | */ | |
52 | enum { | |
53 | SELF_DOWN_PEER_DOWN = 0xdd, | |
54 | SELF_UP_PEER_UP = 0xaa, | |
55 | SELF_DOWN_PEER_LEAVING = 0xd1, | |
56 | SELF_UP_PEER_COMING = 0xac, | |
57 | SELF_COMING_PEER_UP = 0xca, | |
58 | SELF_LEAVING_PEER_DOWN = 0x1d, | |
66996b6c JPM |
59 | NODE_FAILINGOVER = 0xf0, |
60 | NODE_SYNCHING = 0xcc | |
1a20cc25 JPM |
61 | }; |
62 | ||
63 | enum { | |
66996b6c JPM |
64 | SELF_ESTABL_CONTACT_EVT = 0xece, |
65 | SELF_LOST_CONTACT_EVT = 0x1ce, | |
66 | PEER_ESTABL_CONTACT_EVT = 0xfece, | |
67 | PEER_LOST_CONTACT_EVT = 0xf1ce, | |
68 | NODE_FAILOVER_BEGIN_EVT = 0xfbe, | |
69 | NODE_FAILOVER_END_EVT = 0xfee, | |
70 | NODE_SYNCH_BEGIN_EVT = 0xcbe, | |
71 | NODE_SYNCH_END_EVT = 0xcee | |
1a20cc25 JPM |
72 | }; |
73 | ||
aecb9bb8 YX |
74 | /* Flags used to take different actions according to flag type |
75 | * TIPC_WAIT_PEER_LINKS_DOWN: wait to see that peer's links are down | |
76 | * TIPC_WAIT_OWN_LINKS_DOWN: wait until peer node is declared down | |
77 | * TIPC_NOTIFY_NODE_DOWN: notify node is down | |
78 | * TIPC_NOTIFY_NODE_UP: notify node is up | |
7b8613e0 | 79 | * TIPC_DISTRIBUTE_NAME: publish or withdraw link state name type |
10f465c4 YX |
80 | */ |
81 | enum { | |
c637c103 | 82 | TIPC_MSG_EVT = 1, |
aecb9bb8 | 83 | TIPC_NOTIFY_NODE_DOWN = (1 << 3), |
50100a5e | 84 | TIPC_NOTIFY_NODE_UP = (1 << 4), |
c637c103 JPM |
85 | TIPC_WAKEUP_BCAST_USERS = (1 << 5), |
86 | TIPC_NOTIFY_LINK_UP = (1 << 6), | |
87 | TIPC_NOTIFY_LINK_DOWN = (1 << 7), | |
cb1b7280 | 88 | TIPC_NAMED_MSG_EVT = (1 << 8), |
b952b2be YX |
89 | TIPC_BCAST_MSG_EVT = (1 << 9), |
90 | TIPC_BCAST_RESET = (1 << 10) | |
10f465c4 | 91 | }; |
b4b56102 | 92 | |
486f930a YX |
93 | /** |
94 | * struct tipc_node_bclink - TIPC node bclink structure | |
95 | * @acked: sequence # of last outbound b'cast message acknowledged by node | |
96 | * @last_in: sequence # of last in-sequence b'cast message received from node | |
97 | * @last_sent: sequence # of last b'cast message sent by node | |
98 | * @oos_state: state tracker for handling OOS b'cast messages | |
bc6fecd4 | 99 | * @deferred_queue: deferred queue saved OOS b'cast message received from node |
37e22164 | 100 | * @reasm_buf: broadcast reassembly queue head from node |
cb1b7280 | 101 | * @inputq_map: bitmap indicating which inqueues should be kicked |
486f930a YX |
102 | * @recv_permitted: true if node is allowed to receive b'cast messages |
103 | */ | |
104 | struct tipc_node_bclink { | |
105 | u32 acked; | |
106 | u32 last_in; | |
107 | u32 last_sent; | |
108 | u32 oos_state; | |
109 | u32 deferred_size; | |
05dcc5aa | 110 | struct sk_buff_head deferdq; |
37e22164 | 111 | struct sk_buff *reasm_buf; |
d39bbd44 | 112 | struct sk_buff_head namedq; |
486f930a YX |
113 | bool recv_permitted; |
114 | }; | |
115 | ||
9d13ec65 JPM |
116 | struct tipc_link_entry { |
117 | struct tipc_link *link; | |
118 | u32 mtu; | |
d39bbd44 | 119 | struct sk_buff_head inputq; |
d3a43b90 | 120 | struct tipc_media_addr maddr; |
9d13ec65 JPM |
121 | }; |
122 | ||
b97bf3fd | 123 | /** |
6c00055a | 124 | * struct tipc_node - TIPC node structure |
b97bf3fd | 125 | * @addr: network address of node |
8a0f6ebe | 126 | * @ref: reference counter to node object |
b97bf3fd | 127 | * @lock: spinlock governing access to structure |
f2f9800d | 128 | * @net: the applicable net namespace |
672d99e1 | 129 | * @hash: links to adjacent nodes in unsorted hash chain |
c637c103 JPM |
130 | * @inputq: pointer to input queue containing messages for msg event |
131 | * @namedq: pointer to name table input queue with name table messages | |
36e78a46 | 132 | * @active_links: bearer ids of active links, used as index into links[] array |
9d13ec65 | 133 | * @links: array containing references to all links to node |
aecb9bb8 | 134 | * @action_flags: bit mask of different types of node actions |
486f930a YX |
135 | * @bclink: broadcast-related info |
136 | * @list: links to adjacent nodes in sorted list of cluster's nodes | |
137 | * @working_links: number of working links to node (both active and standby) | |
b97bf3fd | 138 | * @link_cnt: number of links to node |
7764d6e8 | 139 | * @capabilities: bitmap, indicating peer node's functional capabilities |
fc0eea69 | 140 | * @signature: node instance identifier |
7b8613e0 | 141 | * @link_id: local and remote bearer ids of changing link, if any |
a8f48af5 | 142 | * @publ_list: list of publications |
6c7a762e | 143 | * @rcu: rcu struct for tipc_node |
b97bf3fd | 144 | */ |
6c00055a | 145 | struct tipc_node { |
b97bf3fd | 146 | u32 addr; |
8a0f6ebe | 147 | struct kref kref; |
b97bf3fd | 148 | spinlock_t lock; |
f2f9800d | 149 | struct net *net; |
672d99e1 | 150 | struct hlist_node hash; |
c637c103 JPM |
151 | struct sk_buff_head *inputq; |
152 | struct sk_buff_head *namedq; | |
36e78a46 | 153 | int active_links[2]; |
9d13ec65 | 154 | struct tipc_link_entry links[MAX_BEARERS]; |
c637c103 | 155 | int action_flags; |
486f930a YX |
156 | struct tipc_node_bclink bclink; |
157 | struct list_head list; | |
1a20cc25 | 158 | int state; |
b97bf3fd | 159 | int link_cnt; |
7764d6e8 JPM |
160 | u16 working_links; |
161 | u16 capabilities; | |
fc0eea69 | 162 | u32 signature; |
7b8613e0 | 163 | u32 link_id; |
a8f48af5 | 164 | struct list_head publ_list; |
02be61a9 | 165 | struct list_head conn_sks; |
8a1577c9 JPM |
166 | unsigned long keepalive_intv; |
167 | struct timer_list timer; | |
6c7a762e | 168 | struct rcu_head rcu; |
b97bf3fd PL |
169 | }; |
170 | ||
f2f9800d | 171 | struct tipc_node *tipc_node_find(struct net *net, u32 addr); |
8a0f6ebe | 172 | void tipc_node_put(struct tipc_node *node); |
f2f9800d YX |
173 | struct tipc_node *tipc_node_create(struct net *net, u32 addr); |
174 | void tipc_node_stop(struct net *net); | |
d3a43b90 JPM |
175 | void tipc_node_check_dest(struct tipc_node *n, struct tipc_bearer *bearer, |
176 | bool *link_up, bool *addr_match, | |
177 | struct tipc_media_addr *maddr); | |
178 | bool tipc_node_update_dest(struct tipc_node *n, struct tipc_bearer *bearer, | |
179 | struct tipc_media_addr *maddr); | |
6144a996 | 180 | void tipc_node_delete_links(struct net *net, int bearer_id); |
a18c4bc3 PG |
181 | void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr); |
182 | void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr); | |
9d13ec65 JPM |
183 | void tipc_node_link_down(struct tipc_node *n_ptr, int bearer_id); |
184 | void tipc_node_link_up(struct tipc_node *n_ptr, int bearer_id); | |
185 | bool tipc_node_is_up(struct tipc_node *n); | |
f2f9800d YX |
186 | int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 node, |
187 | char *linkname, size_t len); | |
9db9fdd1 | 188 | void tipc_node_unlock(struct tipc_node *node); |
af9b028e JPM |
189 | int tipc_node_xmit(struct net *net, struct sk_buff_head *list, u32 dnode, |
190 | int selector); | |
191 | int tipc_node_xmit_skb(struct net *net, struct sk_buff *skb, u32 dest, | |
192 | u32 selector); | |
f2f9800d YX |
193 | int tipc_node_add_conn(struct net *net, u32 dnode, u32 port, u32 peer_port); |
194 | void tipc_node_remove_conn(struct net *net, u32 dnode, u32 port); | |
3e4b6ab5 RA |
195 | int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb); |
196 | ||
9db9fdd1 | 197 | static inline void tipc_node_lock(struct tipc_node *node) |
b97bf3fd | 198 | { |
9db9fdd1 | 199 | spin_lock_bh(&node->lock); |
b97bf3fd PL |
200 | } |
201 | ||
9d13ec65 | 202 | static inline struct tipc_link *node_active_link(struct tipc_node *n, int sel) |
16e166b8 | 203 | { |
36e78a46 JPM |
204 | int bearer_id = n->active_links[sel & 1]; |
205 | ||
206 | if (unlikely(bearer_id == INVALID_BEARER_ID)) | |
207 | return NULL; | |
16e166b8 | 208 | |
36e78a46 | 209 | return n->links[bearer_id].link; |
9d13ec65 | 210 | } |
16e166b8 | 211 | |
36e78a46 | 212 | static inline unsigned int tipc_node_get_mtu(struct net *net, u32 addr, u32 sel) |
9d13ec65 JPM |
213 | { |
214 | struct tipc_node *n; | |
36e78a46 | 215 | int bearer_id; |
9d13ec65 | 216 | unsigned int mtu = MAX_MSG_SIZE; |
16e166b8 | 217 | |
9d13ec65 JPM |
218 | n = tipc_node_find(net, addr); |
219 | if (unlikely(!n)) | |
220 | return mtu; | |
36e78a46 JPM |
221 | |
222 | bearer_id = n->active_links[sel & 1]; | |
223 | if (likely(bearer_id != INVALID_BEARER_ID)) | |
224 | mtu = n->links[bearer_id].mtu; | |
9d13ec65 | 225 | tipc_node_put(n); |
16e166b8 JPM |
226 | return mtu; |
227 | } | |
228 | ||
b97bf3fd | 229 | #endif |