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