1 /* 2 * net/tipc/node.h: Include file for TIPC node management routines 3 * 4 * Copyright (c) 2000-2006, 2014, 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 /* 46 * Out-of-range value for node signature 47 */ 48 #define INVALID_NODE_SIG 0x10000 49 50 /* Flags used to take different actions according to flag type 51 * TIPC_WAIT_PEER_LINKS_DOWN: wait to see that peer's links are down 52 * TIPC_WAIT_OWN_LINKS_DOWN: wait until peer node is declared down 53 * TIPC_NOTIFY_NODE_DOWN: notify node is down 54 * TIPC_NOTIFY_NODE_UP: notify node is up 55 * TIPC_DISTRIBUTE_NAME: publish or withdraw link state name type 56 */ 57 enum { 58 TIPC_WAIT_PEER_LINKS_DOWN = (1 << 1), 59 TIPC_WAIT_OWN_LINKS_DOWN = (1 << 2), 60 TIPC_NOTIFY_NODE_DOWN = (1 << 3), 61 TIPC_NOTIFY_NODE_UP = (1 << 4), 62 TIPC_WAKEUP_USERS = (1 << 5), 63 TIPC_WAKEUP_BCAST_USERS = (1 << 6), 64 TIPC_NOTIFY_LINK_UP = (1 << 7), 65 TIPC_NOTIFY_LINK_DOWN = (1 << 8) 66 }; 67 68 /** 69 * struct tipc_node_bclink - TIPC node bclink structure 70 * @acked: sequence # of last outbound b'cast message acknowledged by node 71 * @last_in: sequence # of last in-sequence b'cast message received from node 72 * @last_sent: sequence # of last b'cast message sent by node 73 * @oos_state: state tracker for handling OOS b'cast messages 74 * @deferred_queue: deferred queue saved OOS b'cast message received from node 75 * @reasm_buf: broadcast reassembly queue head from node 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 deferred_queue; 85 struct sk_buff *reasm_buf; 86 bool recv_permitted; 87 }; 88 89 /** 90 * struct tipc_node - TIPC node structure 91 * @addr: network address of node 92 * @lock: spinlock governing access to structure 93 * @hash: links to adjacent nodes in unsorted hash chain 94 * @active_links: pointers to active links to node 95 * @links: pointers to all links to node 96 * @action_flags: bit mask of different types of node actions 97 * @bclink: broadcast-related info 98 * @list: links to adjacent nodes in sorted list of cluster's nodes 99 * @working_links: number of working links to node (both active and standby) 100 * @link_cnt: number of links to node 101 * @signature: node instance identifier 102 * @link_id: local and remote bearer ids of changing link, if any 103 * @publ_list: list of publications 104 * @rcu: rcu struct for tipc_node 105 */ 106 struct tipc_node { 107 u32 addr; 108 spinlock_t lock; 109 struct hlist_node hash; 110 struct tipc_link *active_links[2]; 111 u32 act_mtus[2]; 112 struct tipc_link *links[MAX_BEARERS]; 113 unsigned int action_flags; 114 struct tipc_node_bclink bclink; 115 struct list_head list; 116 int link_cnt; 117 int working_links; 118 u32 signature; 119 u32 link_id; 120 struct list_head publ_list; 121 struct sk_buff_head waiting_sks; 122 struct list_head conn_sks; 123 struct rcu_head rcu; 124 }; 125 126 extern struct list_head tipc_node_list; 127 128 struct tipc_node *tipc_node_find(u32 addr); 129 struct tipc_node *tipc_node_create(u32 addr); 130 void tipc_node_stop(void); 131 void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr); 132 void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr); 133 void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr); 134 void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr); 135 int tipc_node_active_links(struct tipc_node *n_ptr); 136 int tipc_node_is_up(struct tipc_node *n_ptr); 137 struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space); 138 struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space); 139 int tipc_node_get_linkname(u32 bearer_id, u32 node, char *linkname, size_t len); 140 void tipc_node_unlock(struct tipc_node *node); 141 int tipc_node_add_conn(u32 dnode, u32 port, u32 peer_port); 142 void tipc_node_remove_conn(u32 dnode, u32 port); 143 144 int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb); 145 146 static inline void tipc_node_lock(struct tipc_node *node) 147 { 148 spin_lock_bh(&node->lock); 149 } 150 151 static inline bool tipc_node_blocked(struct tipc_node *node) 152 { 153 return (node->action_flags & (TIPC_WAIT_PEER_LINKS_DOWN | 154 TIPC_NOTIFY_NODE_DOWN | TIPC_WAIT_OWN_LINKS_DOWN)); 155 } 156 157 static inline uint tipc_node_get_mtu(u32 addr, u32 selector) 158 { 159 struct tipc_node *node; 160 u32 mtu; 161 162 node = tipc_node_find(addr); 163 164 if (likely(node)) 165 mtu = node->act_mtus[selector & 1]; 166 else 167 mtu = MAX_MSG_SIZE; 168 169 return mtu; 170 } 171 172 #endif 173