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