net/tipc/node.h

   1 /*
   2  * net/tipc/node.h: Include file for TIPC node management routines
   3  *
   4  * Copyright (c) 2003-2005, Ericsson Research Canada
   5  * Copyright (c) 2005, Wind River Systems
   6  * Copyright (c) 2005-2006, Ericsson AB
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. Neither the names of the copyright holders nor the names of its
  18  *    contributors may be used to endorse or promote products derived from
  19  *    this software without specific prior written permission.
  20  *
  21  * Alternatively, this software may be distributed under the terms of the
  22  * GNU General Public License ("GPL") version 2 as published by the Free
  23  * Software Foundation.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef _TIPC_NODE_H
  39 #define _TIPC_NODE_H
  40
  41 #include "node_subscr.h"
  42 #include "addr.h"
  43 #include "cluster.h"
  44 #include "bearer.h"
  45
  46 /**
  47  * struct node - TIPC node structure
  48  * @addr: network address of node
  49  * @lock: spinlock governing access to structure
  50  * @owner: pointer to cluster that node belongs to
  51  * @next: pointer to next node in sorted list of cluster's nodes
  52  * @nsub: list of "node down" subscriptions monitoring node
  53  * @active_links: pointers to active links to node
  54  * @links: pointers to all links to node
  55  * @link_cnt: number of links to node
  56  * @permit_changeover: non-zero if node has redundant links to this system
  57  * @routers: bitmap (used for multicluster communication)
  58  * @last_router: (used for multicluster communication)
  59  * @bclink: broadcast-related info
  60  *    @supported: non-zero if node supports TIPC b'cast capability
  61  *    @acked: sequence # of last outbound b'cast message acknowledged by node
  62  *    @last_in: sequence # of last in-sequence b'cast message received from node
  63  *    @gap_after: sequence # of last message not requiring a NAK request
  64  *    @gap_to: sequence # of last message requiring a NAK request
  65  *    @nack_sync: counter that determines when NAK requests should be sent
  66  *    @deferred_head: oldest OOS b'cast message received from node
  67  *    @deferred_tail: newest OOS b'cast message received from node
  68  *    @defragm: list of partially reassembled b'cast message fragments from node
  69  */
  70
  71 struct node {
  72         u32 addr;
  73         spinlock_t lock;
  74         struct cluster *owner;
  75         struct node *next;
  76         struct list_head nsub;
  77         struct link *active_links[2];
  78         struct link *links[MAX_BEARERS];
  79         int link_cnt;
  80         int permit_changeover;
  81         u32 routers[512/32];
  82         int last_router;
  83         struct {
  84                 int supported;
  85                 u32 acked;
  86                 u32 last_in;
  87                 u32 gap_after;
  88                 u32 gap_to;
  89                 u32 nack_sync;
  90                 struct sk_buff *deferred_head;
  91                 struct sk_buff *deferred_tail;
  92                 struct sk_buff *defragm;
  93         } bclink;
  94 };
  95
  96 extern struct node *nodes;
  97 extern u32 tipc_own_tag;
  98
  99 struct node *node_create(u32 addr);
 100 void node_delete(struct node *n_ptr);
 101 struct node *node_attach_link(struct link *l_ptr);
 102 void node_detach_link(struct node *n_ptr, struct link *l_ptr);
 103 void node_link_down(struct node *n_ptr, struct link *l_ptr);
 104 void node_link_up(struct node *n_ptr, struct link *l_ptr);
 105 int node_has_active_links(struct node *n_ptr);
 106 int node_has_redundant_links(struct node *n_ptr);
 107 u32 node_select_router(struct node *n_ptr, u32 ref);
 108 struct node *node_select_next_hop(u32 addr, u32 selector);
 109 int node_is_up(struct node *n_ptr);
 110 void node_add_router(struct node *n_ptr, u32 router);
 111 void node_remove_router(struct node *n_ptr, u32 router);
 112 struct sk_buff *node_get_links(const void *req_tlv_area, int req_tlv_space);
 113 struct sk_buff *node_get_nodes(const void *req_tlv_area, int req_tlv_space);
 114
 115 static inline struct node *node_find(u32 addr)
 116 {
 117         if (likely(in_own_cluster(addr)))
 118                 return local_nodes[tipc_node(addr)];
 119         else if (addr_domain_valid(addr)) {
 120                 struct cluster *c_ptr = cluster_find(addr);
 121
 122                 if (c_ptr)
 123                         return c_ptr->nodes[tipc_node(addr)];
 124         }
 125         return 0;
 126 }
 127
 128 static inline struct node *node_select(u32 addr, u32 selector)
 129 {
 130         if (likely(in_own_cluster(addr)))
 131                 return local_nodes[tipc_node(addr)];
 132         return node_select_next_hop(addr, selector);
 133 }
 134
 135 static inline void node_lock(struct node *n_ptr)
 136 {
 137         spin_lock_bh(&n_ptr->lock);
 138 }
 139
 140 static inline void node_unlock(struct node *n_ptr)
 141 {
 142         spin_unlock_bh(&n_ptr->lock);
 143 }
 144
 145 #endif