net/tipc/zone.h

   1 /*
   2  * net/tipc/zone.h: Include file for TIPC zone 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_ZONE_H
  38 #define _TIPC_ZONE_H
  39
  40 #include "node_subscr.h"
  41 #include "net.h"
  42
  43
  44 /**
  45  * struct _zone - TIPC zone structure
  46  * @addr: network address of zone
  47  * @clusters: array of pointers to all clusters within zone
  48  * @links: (used for inter-zone communication)
  49  */
  50
  51 struct _zone {
  52         u32 addr;
  53         struct cluster *clusters[2]; /* currently limited to just 1 cluster */
  54         u32 links;
  55 };
  56
  57 struct node *tipc_zone_select_remote_node(struct _zone *z_ptr, u32 addr, u32 ref);
  58 u32 tipc_zone_select_router(struct _zone *z_ptr, u32 addr, u32 ref);
  59 void tipc_zone_remove_as_router(struct _zone *z_ptr, u32 router);
  60 void tipc_zone_send_external_routes(struct _zone *z_ptr, u32 dest);
  61 struct _zone *tipc_zone_create(u32 addr);
  62 void tipc_zone_delete(struct _zone *z_ptr);
  63 void tipc_zone_attach_cluster(struct _zone *z_ptr, struct cluster *c_ptr);
  64 u32 tipc_zone_next_node(u32 addr);
  65
  66 static inline struct _zone *tipc_zone_find(u32 addr)
  67 {
  68         return tipc_net.zones[tipc_zone(addr)];
  69 }
  70
  71 #endif