net/tipc/cluster.h

   1 /*
   2  * net/tipc/cluster.h: Include file for TIPC cluster management routines
   3  *
   4  * Copyright (c) 2000-2006, Ericsson AB
   5  * Copyright (c) 2005, 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_CLUSTER_H
  38 #define _TIPC_CLUSTER_H
  39
  40 #include "addr.h"
  41 #include "zone.h"
  42
  43 #define LOWEST_SLAVE  2048u
  44
  45 /**
  46  * struct cluster - TIPC cluster structure
  47  * @addr: network address of cluster
  48  * @owner: pointer to zone that cluster belongs to
  49  * @nodes: array of pointers to all nodes within cluster
  50  * @highest_node: id of highest numbered node within cluster
  51  * @highest_slave: (used for secondary node support)
  52  */
  53
  54 struct cluster {
  55         u32 addr;
  56         struct _zone *owner;
  57         struct node **nodes;
  58         u32 highest_node;
  59         u32 highest_slave;
  60 };
  61
  62
  63 extern struct node **tipc_local_nodes;
  64 extern u32 tipc_highest_allowed_slave;
  65 extern struct node_map tipc_cltr_bcast_nodes;
  66
  67 void tipc_cltr_remove_as_router(struct cluster *c_ptr, u32 router);
  68 void tipc_cltr_send_ext_routes(struct cluster *c_ptr, u32 dest);
  69 struct node *tipc_cltr_select_node(struct cluster *c_ptr, u32 selector);
  70 u32 tipc_cltr_select_router(struct cluster *c_ptr, u32 ref);
  71 void tipc_cltr_recv_routing_table(struct sk_buff *buf);
  72 struct cluster *tipc_cltr_create(u32 addr);
  73 void tipc_cltr_delete(struct cluster *c_ptr);
  74 void tipc_cltr_attach_node(struct cluster *c_ptr, struct node *n_ptr);
  75 void tipc_cltr_send_slave_routes(struct cluster *c_ptr, u32 dest);
  76 void tipc_cltr_broadcast(struct sk_buff *buf);
  77 int tipc_cltr_init(void);
  78 u32 tipc_cltr_next_node(struct cluster *c_ptr, u32 addr);
  79 void tipc_cltr_bcast_new_route(struct cluster *c_ptr, u32 dest, u32 lo, u32 hi);
  80 void tipc_cltr_send_local_routes(struct cluster *c_ptr, u32 dest);
  81 void tipc_cltr_bcast_lost_route(struct cluster *c_ptr, u32 dest, u32 lo, u32 hi);
  82
  83 static inline struct cluster *tipc_cltr_find(u32 addr)
  84 {
  85         struct _zone *z_ptr = tipc_zone_find(addr);
  86
  87         if (z_ptr)
  88                 return z_ptr->clusters[1];
  89         return NULL;
  90 }
  91
  92 #endif