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