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 block (re)establishment of contact with a neighboring node */
  51 #define WAIT_PEER_DOWN  0x0001  /* wait to see that peer's links are down */
  52 #define WAIT_NAMES_GONE 0x0002  /* wait for peer's publications to be purged */
  53 #define WAIT_NODE_DOWN  0x0004  /* wait until peer node is declared down */
  54
  55 /**
  56  * struct tipc_node_bclink - TIPC node bclink structure
  57  * @acked: sequence # of last outbound b'cast message acknowledged by node
  58  * @last_in: sequence # of last in-sequence b'cast message received from node
  59  * @last_sent: sequence # of last b'cast message sent by node
  60  * @oos_state: state tracker for handling OOS b'cast messages
  61  * @deferred_size: number of OOS b'cast messages in deferred queue
  62  * @deferred_head: oldest OOS b'cast message received from node
  63  * @deferred_tail: newest OOS b'cast message received from node
  64  * @reasm_head: broadcast reassembly queue head from node
  65  * @reasm_tail: last broadcast fragment received from node
  66  * @recv_permitted: true if node is allowed to receive b'cast messages
  67  */
  68 struct tipc_node_bclink {
  69         u32 acked;
  70         u32 last_in;
  71         u32 last_sent;
  72         u32 oos_state;
  73         u32 deferred_size;
  74         struct sk_buff *deferred_head;
  75         struct sk_buff *deferred_tail;
  76         struct sk_buff *reasm_head;
  77         struct sk_buff *reasm_tail;
  78         bool recv_permitted;
  79 };
  80
  81 /**
  82  * struct tipc_node - TIPC node structure
  83  * @addr: network address of node
  84  * @lock: spinlock governing access to structure
  85  * @hash: links to adjacent nodes in unsorted hash chain
  86  * @active_links: pointers to active links to node
  87  * @links: pointers to all links to node
  88  * @block_setup: bit mask of conditions preventing link establishment to node
  89  * @bclink: broadcast-related info
  90  * @list: links to adjacent nodes in sorted list of cluster's nodes
  91  * @working_links: number of working links to node (both active and standby)
  92  * @link_cnt: number of links to node
  93  * @signature: node instance identifier
  94  * @nsub: list of "node down" subscriptions monitoring node
  95  * @rcu: rcu struct for tipc_node
  96  */
  97 struct tipc_node {
  98         u32 addr;
  99         spinlock_t lock;
 100         struct hlist_node hash;
 101         struct tipc_link *active_links[2];
 102         struct tipc_link *links[MAX_BEARERS];
 103         int block_setup;
 104         struct tipc_node_bclink bclink;
 105         struct list_head list;
 106         int link_cnt;
 107         int working_links;
 108         u32 signature;
 109         struct list_head nsub;
 110         struct rcu_head rcu;
 111 };
 112
 113 extern struct list_head tipc_node_list;
 114
 115 struct tipc_node *tipc_node_find(u32 addr);
 116 struct tipc_node *tipc_node_create(u32 addr);
 117 void tipc_node_stop(void);
 118 void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 119 void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 120 void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 121 void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 122 int tipc_node_active_links(struct tipc_node *n_ptr);
 123 int tipc_node_is_up(struct tipc_node *n_ptr);
 124 struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
 125 struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
 126 int tipc_node_get_linkname(u32 bearer_id, u32 node, char *linkname, size_t len);
 127
 128 static inline void tipc_node_lock(struct tipc_node *n_ptr)
 129 {
 130         spin_lock_bh(&n_ptr->lock);
 131 }
 132
 133 static inline void tipc_node_unlock(struct tipc_node *n_ptr)
 134 {
 135         spin_unlock_bh(&n_ptr->lock);
 136 }
 137
 138 #endif