net/tipc/addr.c

   1 /*
   2  * net/tipc/addr.c: TIPC address utility routines
   3  *
   4  * Copyright (c) 2000-2006, Ericsson AB
   5  * Copyright (c) 2004-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 #include "core.h"
  38 #include "addr.h"
  39 #include "zone.h"
  40 #include "cluster.h"
  41
  42 /**
  43  * tipc_addr_domain_valid - validates a network domain address
  44  *
  45  * Accepts <Z.C.N>, <Z.C.0>, <Z.0.0>, and <0.0.0>,
  46  * where Z, C, and N are non-zero and do not exceed the configured limits.
  47  *
  48  * Returns 1 if domain address is valid, otherwise 0
  49  */
  50
  51 int tipc_addr_domain_valid(u32 addr)
  52 {
  53         u32 n = tipc_node(addr);
  54         u32 c = tipc_cluster(addr);
  55         u32 z = tipc_zone(addr);
  56         u32 max_nodes = tipc_max_nodes;
  57
  58         if (is_slave(addr))
  59                 max_nodes = LOWEST_SLAVE + tipc_max_slaves;
  60         if (n > max_nodes)
  61                 return 0;
  62         if (c > tipc_max_clusters)
  63                 return 0;
  64         if (z > tipc_max_zones)
  65                 return 0;
  66
  67         if (n && (!z || !c))
  68                 return 0;
  69         if (c && !z)
  70                 return 0;
  71         return 1;
  72 }
  73
  74 /**
  75  * tipc_addr_node_valid - validates a proposed network address for this node
  76  *
  77  * Accepts <Z.C.N>, where Z, C, and N are non-zero and do not exceed
  78  * the configured limits.
  79  *
  80  * Returns 1 if address can be used, otherwise 0
  81  */
  82
  83 int tipc_addr_node_valid(u32 addr)
  84 {
  85         return tipc_addr_domain_valid(addr) && tipc_node(addr);
  86 }
  87
  88 int tipc_in_scope(u32 domain, u32 addr)
  89 {
  90         if (!domain || (domain == addr))
  91                 return 1;
  92         if (domain == (addr & 0xfffff000u)) /* domain <Z.C.0> */
  93                 return 1;
  94         if (domain == (addr & 0xff000000u)) /* domain <Z.0.0> */
  95                 return 1;
  96         return 0;
  97 }
  98
  99 /**
 100  * tipc_addr_scope - convert message lookup domain to a 2-bit scope value
 101  */
 102
 103 int tipc_addr_scope(u32 domain)
 104 {
 105         if (likely(!domain))
 106                 return TIPC_ZONE_SCOPE;
 107         if (tipc_node(domain))
 108                 return TIPC_NODE_SCOPE;
 109         if (tipc_cluster(domain))
 110                 return TIPC_CLUSTER_SCOPE;
 111         return TIPC_ZONE_SCOPE;
 112 }
 113
 114 char *tipc_addr_string_fill(char *string, u32 addr)
 115 {
 116         snprintf(string, 16, "<%u.%u.%u>",
 117                  tipc_zone(addr), tipc_cluster(addr), tipc_node(addr));
 118         return string;
 119 }