net/tipc/zone.h

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