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-2011, 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 block (re)establishment of contact with a neighboring node */
  51
  52 #define WAIT_PEER_DOWN  0x0001  /* wait to see that peer's links are down */
  53 #define WAIT_NAMES_GONE 0x0002  /* wait for peer's publications to be purged */
  54 #define WAIT_NODE_DOWN  0x0004  /* wait until peer node is declared down */
  55
  56 /**
  57  * struct tipc_node - TIPC node structure
  58  * @addr: network address of node
  59  * @lock: spinlock governing access to structure
  60  * @hash: links to adjacent nodes in unsorted hash chain
  61  * @list: links to adjacent nodes in sorted list of cluster's nodes
  62  * @nsub: list of "node down" subscriptions monitoring node
  63  * @active_links: pointers to active links to node
  64  * @links: pointers to all links to node
  65  * @working_links: number of working links to node (both active and standby)
  66  * @block_setup: bit mask of conditions preventing link establishment to node
  67  * @link_cnt: number of links to node
  68  * @permit_changeover: non-zero if node has redundant links to this system
  69  * @signature: node instance identifier
  70  * @bclink: broadcast-related info
  71  *    @supportable: non-zero if node supports TIPC b'cast link capability
  72  *    @supported: non-zero if node supports TIPC b'cast capability
  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_size: number of OOS b'cast messages in deferred queue
  78  *    @deferred_head: oldest OOS b'cast message received from node
  79  *    @deferred_tail: newest OOS b'cast message received from node
  80  *    @defragm: list of partially reassembled b'cast message fragments from node
  81  */
  82
  83 struct tipc_node {
  84         u32 addr;
  85         spinlock_t lock;
  86         struct hlist_node hash;
  87         struct list_head list;
  88         struct list_head nsub;
  89         struct tipc_link *active_links[2];
  90         struct tipc_link *links[MAX_BEARERS];
  91         int link_cnt;
  92         int working_links;
  93         int block_setup;
  94         int permit_changeover;
  95         u32 signature;
  96         struct {
  97                 u8 supportable;
  98                 u8 supported;
  99                 u32 acked;
 100                 u32 last_in;
 101                 u32 last_sent;
 102                 u32 oos_state;
 103                 u32 deferred_size;
 104                 struct sk_buff *deferred_head;
 105                 struct sk_buff *deferred_tail;
 106                 struct sk_buff *defragm;
 107         } bclink;
 108 };
 109
 110 #define NODE_HTABLE_SIZE 512
 111 extern struct list_head tipc_node_list;
 112
 113 /*
 114  * A trivial power-of-two bitmask technique is used for speed, since this
 115  * operation is done for every incoming TIPC packet. The number of hash table
 116  * entries has been chosen so that no hash chain exceeds 8 nodes and will
 117  * usually be much smaller (typically only a single node).
 118  */
 119 static inline unsigned int tipc_hashfn(u32 addr)
 120 {
 121         return addr & (NODE_HTABLE_SIZE - 1);
 122 }
 123
 124 struct tipc_node *tipc_node_find(u32 addr);
 125 struct tipc_node *tipc_node_create(u32 addr);
 126 void tipc_node_delete(struct tipc_node *n_ptr);
 127 void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 128 void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 129 void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 130 void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 131 int tipc_node_active_links(struct tipc_node *n_ptr);
 132 int tipc_node_redundant_links(struct tipc_node *n_ptr);
 133 int tipc_node_is_up(struct tipc_node *n_ptr);
 134 struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
 135 struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
 136
 137 static inline void tipc_node_lock(struct tipc_node *n_ptr)
 138 {
 139         spin_lock_bh(&n_ptr->lock);
 140 }
 141
 142 static inline void tipc_node_unlock(struct tipc_node *n_ptr)
 143 {
 144         spin_unlock_bh(&n_ptr->lock);
 145 }
 146
 147 #endif