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