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 /* 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 53 * TIPC_DISTRIBUTE_NAME: publish or withdraw link state name type 54 */ 55 enum { 56 TIPC_MSG_EVT = 1, 57 TIPC_WAIT_PEER_LINKS_DOWN = (1 << 1), 58 TIPC_WAIT_OWN_LINKS_DOWN = (1 << 2), 59 TIPC_NOTIFY_NODE_DOWN = (1 << 3), 60 TIPC_NOTIFY_NODE_UP = (1 << 4), 61 TIPC_WAKEUP_BCAST_USERS = (1 << 5), 62 TIPC_NOTIFY_LINK_UP = (1 << 6), 63 TIPC_NOTIFY_LINK_DOWN = (1 << 7), 64 TIPC_NAMED_MSG_EVT = (1 << 8), 65 TIPC_BCAST_MSG_EVT = (1 << 9), 66 TIPC_BCAST_RESET = (1 << 10) 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_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 * @recv_permitted: true if node is allowed to receive b'cast messages 79 */ 80 struct tipc_node_bclink { 81 u32 acked; 82 u32 last_in; 83 u32 last_sent; 84 u32 oos_state; 85 u32 deferred_size; 86 struct sk_buff_head deferdq; 87 struct sk_buff *reasm_buf; 88 int inputq_map; 89 bool recv_permitted; 90 }; 91 92 /** 93 * struct tipc_node - TIPC node structure 94 * @addr: network address of node 95 * @ref: reference counter to node object 96 * @lock: spinlock governing access to structure 97 * @net: the applicable net namespace 98 * @hash: links to adjacent nodes in unsorted hash chain 99 * @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 102 * @active_links: pointers to active links to node 103 * @links: pointers to all links to node 104 * @action_flags: bit mask of different types of node actions 105 * @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) 108 * @link_cnt: number of links to node 109 * @capabilities: bitmap, indicating peer node's functional capabilities 110 * @signature: node instance identifier 111 * @link_id: local and remote bearer ids of changing link, if any 112 * @publ_list: list of publications 113 * @rcu: rcu struct for tipc_node 114 */ 115 struct tipc_node { 116 u32 addr; 117 struct kref kref; 118 spinlock_t lock; 119 struct net *net; 120 struct hlist_node hash; 121 struct sk_buff_head *inputq; 122 struct sk_buff_head *namedq; 123 struct tipc_link *active_links[2]; 124 u32 act_mtus[2]; 125 struct tipc_link *links[MAX_BEARERS]; 126 int action_flags; 127 struct tipc_node_bclink bclink; 128 struct list_head list; 129 int link_cnt; 130 u16 working_links; 131 u16 capabilities; 132 u32 signature; 133 u32 link_id; 134 struct list_head publ_list; 135 struct list_head conn_sks; 136 struct rcu_head rcu; 137 }; 138 139 struct tipc_node *tipc_node_find(struct net *net, u32 addr); 140 void tipc_node_put(struct tipc_node *node); 141 struct tipc_node *tipc_node_create(struct net *net, u32 addr); 142 void tipc_node_stop(struct net *net); 143 void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr); 144 void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr); 145 void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr); 146 void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr); 147 int tipc_node_active_links(struct tipc_node *n_ptr); 148 int tipc_node_is_up(struct tipc_node *n_ptr); 149 int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 node, 150 char *linkname, size_t len); 151 void tipc_node_unlock(struct tipc_node *node); 152 int tipc_node_add_conn(struct net *net, u32 dnode, u32 port, u32 peer_port); 153 void tipc_node_remove_conn(struct net *net, u32 dnode, u32 port); 154 155 int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb); 156 157 static inline void tipc_node_lock(struct tipc_node *node) 158 { 159 spin_lock_bh(&node->lock); 160 } 161 162 static inline bool tipc_node_blocked(struct tipc_node *node) 163 { 164 return (node->action_flags & (TIPC_WAIT_PEER_LINKS_DOWN | 165 TIPC_NOTIFY_NODE_DOWN | TIPC_WAIT_OWN_LINKS_DOWN)); 166 } 167 168 static inline uint tipc_node_get_mtu(struct net *net, u32 addr, u32 selector) 169 { 170 struct tipc_node *node; 171 u32 mtu; 172 173 node = tipc_node_find(net, addr); 174 175 if (likely(node)) { 176 mtu = node->act_mtus[selector & 1]; 177 tipc_node_put(node); 178 } else { 179 mtu = MAX_MSG_SIZE; 180 } 181 182 return mtu; 183 } 184 185 #endif 186