net/tipc/node.h

   1 /*
   2  * net/tipc/node.h: Include file for TIPC node management routines
   3  *
   4  * Copyright (c) 2000-2006, 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 "node_subscr.h"
  41 #include "addr.h"
  42 #include "net.h"
  43 #include "bearer.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  */
  56 enum {
  57         TIPC_WAIT_PEER_LINKS_DOWN       = (1 << 1),
  58         TIPC_WAIT_OWN_LINKS_DOWN        = (1 << 2),
  59         TIPC_NOTIFY_NODE_DOWN           = (1 << 3),
  60         TIPC_NOTIFY_NODE_UP             = (1 << 4)
  61 };
  62
  63 /**
  64  * struct tipc_node_bclink - TIPC node bclink structure
  65  * @acked: sequence # of last outbound b'cast message acknowledged by node
  66  * @last_in: sequence # of last in-sequence b'cast message received from node
  67  * @last_sent: sequence # of last b'cast message sent by node
  68  * @oos_state: state tracker for handling OOS b'cast messages
  69  * @deferred_size: number of OOS b'cast messages in deferred queue
  70  * @deferred_head: oldest OOS b'cast message received from node
  71  * @deferred_tail: newest OOS b'cast message received from node
  72  * @reasm_buf: broadcast reassembly queue head from node
  73  * @recv_permitted: true if node is allowed to receive b'cast messages
  74  */
  75 struct tipc_node_bclink {
  76         u32 acked;
  77         u32 last_in;
  78         u32 last_sent;
  79         u32 oos_state;
  80         u32 deferred_size;
  81         struct sk_buff *deferred_head;
  82         struct sk_buff *deferred_tail;
  83         struct sk_buff *reasm_buf;
  84         bool recv_permitted;
  85 };
  86
  87 /**
  88  * struct tipc_node - TIPC node structure
  89  * @addr: network address of node
  90  * @lock: spinlock governing access to structure
  91  * @hash: links to adjacent nodes in unsorted hash chain
  92  * @active_links: pointers to active links to node
  93  * @links: pointers to all links to node
  94  * @action_flags: bit mask of different types of node actions
  95  * @bclink: broadcast-related info
  96  * @list: links to adjacent nodes in sorted list of cluster's nodes
  97  * @working_links: number of working links to node (both active and standby)
  98  * @link_cnt: number of links to node
  99  * @signature: node instance identifier
 100  * @nsub: list of "node down" subscriptions monitoring node
 101  * @rcu: rcu struct for tipc_node
 102  */
 103 struct tipc_node {
 104         u32 addr;
 105         spinlock_t lock;
 106         struct hlist_node hash;
 107         struct tipc_link *active_links[2];
 108         struct tipc_link *links[MAX_BEARERS];
 109         unsigned int action_flags;
 110         struct tipc_node_bclink bclink;
 111         struct list_head list;
 112         int link_cnt;
 113         int working_links;
 114         u32 signature;
 115         struct list_head nsub;
 116         struct rcu_head rcu;
 117 };
 118
 119 extern struct list_head tipc_node_list;
 120
 121 struct tipc_node *tipc_node_find(u32 addr);
 122 struct tipc_node *tipc_node_create(u32 addr);
 123 void tipc_node_stop(void);
 124 void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 125 void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 126 void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 127 void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 128 int tipc_node_active_links(struct tipc_node *n_ptr);
 129 int tipc_node_is_up(struct tipc_node *n_ptr);
 130 struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
 131 struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
 132 int tipc_node_get_linkname(u32 bearer_id, u32 node, char *linkname, size_t len);
 133 void tipc_node_unlock(struct tipc_node *node);
 134
 135 static inline void tipc_node_lock(struct tipc_node *node)
 136 {
 137         spin_lock_bh(&node->lock);
 138 }
 139
 140 static inline bool tipc_node_blocked(struct tipc_node *node)
 141 {
 142         return (node->action_flags & (TIPC_WAIT_PEER_LINKS_DOWN |
 143                 TIPC_NOTIFY_NODE_DOWN | TIPC_WAIT_OWN_LINKS_DOWN));
 144 }
 145
 146 #endif